macosx: FIXME for ModuleListConfigControl's resetValues
[vlc.git] / include / vlc_common.h
1 /*****************************************************************************
2  * vlc_common.h: common definitions
3  * Collection of useful common types and macros definitions
4  *****************************************************************************
5  * Copyright (C) 1998-2011 VLC authors and VideoLAN
6  *
7  * Authors: Samuel Hocevar <sam@via.ecp.fr>
8  *          Vincent Seguin <seguin@via.ecp.fr>
9  *          Gildas Bazin <gbazin@videolan.org>
10  *          RĂ©mi Denis-Courmont
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU Lesser General Public License as published by
14  * the Free Software Foundation; either version 2.1 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /**
28  * \file
29  * This file is a collection of common definitions and types
30  */
31
32 #ifndef VLC_COMMON_H
33 # define VLC_COMMON_H 1
34
35 /*****************************************************************************
36  * Required vlc headers
37  *****************************************************************************/
38 #include "vlc_config.h"
39
40 /*****************************************************************************
41  * Required system headers
42  *****************************************************************************/
43 #include <stdlib.h>
44 #include <stdarg.h>
45
46 #include <string.h>
47 #include <stdio.h>
48 #include <inttypes.h>
49 #include <stddef.h>
50 #include <limits.h>
51
52 #ifndef __cplusplus
53 # include <stdbool.h>
54 #endif
55
56 /*****************************************************************************
57  * Compilers definitions
58  *****************************************************************************/
59 /* Helper for GCC version checks */
60 #ifdef __GNUC__
61 # define VLC_GCC_VERSION(maj,min) \
62     ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
63 #else
64 # define VLC_GCC_VERSION(maj,min) (0)
65 #endif
66
67 /* Try to fix format strings for all versions of mingw and mingw64 */
68 #if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
69  #undef PRId64
70  #define PRId64 "lld"
71  #undef PRIi64
72  #define PRIi64 "lli"
73  #undef PRIu64
74  #define PRIu64 "llu"
75  #undef PRIo64
76  #define PRIo64 "llo"
77  #undef PRIx64
78  #define PRIx64 "llx"
79  #define snprintf __mingw_snprintf
80  #define vsnprintf __mingw_vsnprintf
81  #define swprintf _snwprintf
82 #endif
83
84 /* Function attributes for compiler warnings */
85 #ifdef __GNUC__
86 # define VLC_DEPRECATED __attribute__((deprecated))
87 # if VLC_GCC_VERSION(6,0)
88 #  define VLC_DEPRECATED_ENUM __attribute__((deprecated))
89 # else
90 #  define VLC_DEPRECATED_ENUM
91 # endif
92
93 # if defined( _WIN32 )
94 #  define VLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
95 # else
96 #  define VLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
97 # endif
98 # define VLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
99 # define VLC_MALLOC __attribute__ ((malloc))
100 # define VLC_USED __attribute__ ((warn_unused_result))
101
102 #else
103 # define VLC_DEPRECATED
104 # define VLC_DEPRECATED_ENUM
105 # define VLC_FORMAT(x,y)
106 # define VLC_FORMAT_ARG(x)
107 # define VLC_MALLOC
108 # define VLC_USED
109 #endif
110
111
112 /* Branch prediction */
113 #ifdef __GNUC__
114 # define likely(p)     __builtin_expect(!!(p), 1)
115 # define unlikely(p)   __builtin_expect(!!(p), 0)
116 # define unreachable() __builtin_unreachable()
117 #else
118 # define likely(p)     (!!(p))
119 # define unlikely(p)   (!!(p))
120 # define unreachable() ((void)0)
121 #endif
122
123 #define vlc_assert_unreachable() (assert(!"unreachable"), unreachable())
124
125 /* Linkage */
126 #ifdef __cplusplus
127 # define VLC_EXTERN extern "C"
128 #else
129 # define VLC_EXTERN
130 #endif
131
132 #if defined (_WIN32) && defined (DLL_EXPORT)
133 # define VLC_EXPORT __declspec(dllexport)
134 #elif defined (__GNUC__)
135 # define VLC_EXPORT __attribute__((visibility("default")))
136 #else
137 # define VLC_EXPORT
138 #endif
139
140 #define VLC_API VLC_EXTERN VLC_EXPORT
141
142
143 /*****************************************************************************
144  * Basic types definitions
145  *****************************************************************************/
146 /**
147  * High precision date or time interval
148  *
149  * Store a high precision date or time interval. The maximum precision is the
150  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
151  * time interval is then 292271 years, which should be long enough for any
152  * video). Dates are stored as microseconds since a common date (usually the
153  * epoch). Note that date and time intervals can be manipulated using regular
154  * arithmetic operators, and that no special functions are required.
155  */
156 typedef int64_t mtime_t;
157
158 /**
159  * The vlc_fourcc_t type.
160  *
161  * See http://www.webartz.com/fourcc/ for a very detailed list.
162  */
163 typedef uint32_t vlc_fourcc_t;
164
165 #ifdef WORDS_BIGENDIAN
166 #   define VLC_FOURCC( a, b, c, d ) \
167         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
168            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
169 #   define VLC_TWOCC( a, b ) \
170         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
171
172 #else
173 #   define VLC_FOURCC( a, b, c, d ) \
174         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
175            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
176 #   define VLC_TWOCC( a, b ) \
177         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
178
179 #endif
180
181 /**
182  * Translate a vlc_fourcc into its string representation. This function
183  * assumes there is enough room in psz_fourcc to store 4 characters in.
184  *
185  * \param fcc a vlc_fourcc_t
186  * \param psz_fourcc string to store string representation of vlc_fourcc in
187  */
188 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
189 {
190     memcpy( psz_fourcc, &fcc, 4 );
191 }
192
193 /*****************************************************************************
194  * Classes declaration
195  *****************************************************************************/
196
197 /* Internal types */
198 typedef struct vlc_list_t vlc_list_t;
199 typedef struct vlc_object_t vlc_object_t;
200 typedef struct libvlc_int_t libvlc_int_t;
201 typedef struct date_t date_t;
202
203 /* Playlist */
204
205 typedef struct playlist_t playlist_t;
206 typedef struct playlist_item_t playlist_item_t;
207 typedef struct services_discovery_t services_discovery_t;
208 typedef struct services_discovery_sys_t services_discovery_sys_t;
209 typedef struct vlc_renderer_discovery_t vlc_renderer_discovery_t;
210 typedef struct vlc_renderer_item_t vlc_renderer_item_t;
211
212 /* Modules */
213 typedef struct module_t module_t;
214 typedef struct module_config_t module_config_t;
215
216 typedef struct config_category_t config_category_t;
217
218 /* Input */
219 typedef struct input_thread_t input_thread_t;
220 typedef struct input_item_t input_item_t;
221 typedef struct input_item_node_t input_item_node_t;
222 typedef struct access_sys_t access_sys_t;
223 typedef struct stream_t     stream_t;
224 typedef struct stream_sys_t stream_sys_t;
225 typedef struct demux_t  demux_t;
226 typedef struct demux_sys_t demux_sys_t;
227 typedef struct es_out_t     es_out_t;
228 typedef struct es_out_id_t  es_out_id_t;
229 typedef struct es_out_sys_t es_out_sys_t;
230 typedef struct seekpoint_t seekpoint_t;
231 typedef struct info_t info_t;
232 typedef struct info_category_t info_category_t;
233 typedef struct input_attachment_t input_attachment_t;
234
235 /* Format */
236 typedef struct audio_format_t audio_format_t;
237 typedef struct video_format_t video_format_t;
238 typedef struct subs_format_t subs_format_t;
239 typedef struct es_format_t es_format_t;
240 typedef struct video_palette_t video_palette_t;
241
242 /* Audio */
243 typedef struct audio_output audio_output_t;
244 typedef struct aout_sys_t aout_sys_t;
245 typedef audio_format_t audio_sample_format_t;
246
247 /* Video */
248 typedef struct vout_thread_t vout_thread_t;
249 typedef struct vlc_viewpoint_t vlc_viewpoint_t;
250
251 typedef video_format_t video_frame_format_t;
252 typedef struct picture_t picture_t;
253 typedef struct picture_sys_t picture_sys_t;
254
255 /* Subpictures */
256 typedef struct spu_t spu_t;
257 typedef struct subpicture_t subpicture_t;
258 typedef struct subpicture_region_t subpicture_region_t;
259
260 typedef struct image_handler_t image_handler_t;
261
262 /* Stream output */
263 typedef struct sout_instance_t sout_instance_t;
264
265 typedef struct sout_input_t sout_input_t;
266 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
267
268 typedef struct sout_access_out_t sout_access_out_t;
269 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
270
271 typedef struct sout_mux_t sout_mux_t;
272 typedef struct sout_mux_sys_t sout_mux_sys_t;
273
274 typedef struct sout_stream_t    sout_stream_t;
275 typedef struct sout_stream_sys_t sout_stream_sys_t;
276
277 typedef struct config_chain_t       config_chain_t;
278 typedef struct session_descriptor_t session_descriptor_t;
279
280 /* Decoders */
281 typedef struct decoder_t         decoder_t;
282 typedef struct decoder_sys_t     decoder_sys_t;
283 typedef struct decoder_synchro_t decoder_synchro_t;
284
285 /* Encoders */
286 typedef struct encoder_t      encoder_t;
287 typedef struct encoder_sys_t  encoder_sys_t;
288
289 /* Filters */
290 typedef struct filter_t filter_t;
291 typedef struct filter_sys_t filter_sys_t;
292
293 /* Network */
294 typedef struct vlc_url_t vlc_url_t;
295
296 /* Misc */
297 typedef struct iso639_lang_t iso639_lang_t;
298
299 /* block */
300 typedef struct block_t      block_t;
301 typedef struct block_fifo_t block_fifo_t;
302
303 /* Hashing */
304 typedef struct md5_s md5_t;
305
306 /* XML */
307 typedef struct xml_t xml_t;
308 typedef struct xml_sys_t xml_sys_t;
309 typedef struct xml_reader_t xml_reader_t;
310 typedef struct xml_reader_sys_t xml_reader_sys_t;
311
312 /* vod server */
313 typedef struct vod_t     vod_t;
314 typedef struct vod_sys_t vod_sys_t;
315 typedef struct vod_media_t vod_media_t;
316
317 /* VLM */
318 typedef struct vlm_t         vlm_t;
319 typedef struct vlm_message_t vlm_message_t;
320
321 /* misc */
322 typedef struct vlc_meta_t    vlc_meta_t;
323 typedef struct input_stats_t input_stats_t;
324 typedef struct addon_entry_t addon_entry_t;
325
326 /* Update */
327 typedef struct update_t update_t;
328
329 /**
330  * VLC value structure
331  */
332 typedef union
333 {
334     int64_t         i_int;
335     bool            b_bool;
336     float           f_float;
337     char *          psz_string;
338     void *          p_address;
339     vlc_list_t *    p_list;
340     struct { int32_t x; int32_t y; } coords;
341
342 } vlc_value_t;
343
344 /**
345  * VLC list structure
346  */
347 struct vlc_list_t
348 {
349     int          i_type;
350     int          i_count;
351     vlc_value_t *p_values;
352 };
353
354 /*****************************************************************************
355  * Error values (shouldn't be exposed)
356  *****************************************************************************/
357 #define VLC_SUCCESS        (-0) /**< No error */
358 #define VLC_EGENERIC       (-1) /**< Unspecified error */
359 #define VLC_ENOMEM         (-2) /**< Not enough memory */
360 #define VLC_ETIMEOUT       (-3) /**< Timeout */
361 #define VLC_ENOMOD         (-4) /**< Module not found */
362 #define VLC_ENOOBJ         (-5) /**< Object not found */
363 #define VLC_ENOVAR         (-6) /**< Variable not found */
364 #define VLC_EBADVAR        (-7) /**< Bad variable value */
365 #define VLC_ENOITEM        (-8) /**< Item not found */
366
367 /*****************************************************************************
368  * Variable callbacks: called when the value is modified
369  *****************************************************************************/
370 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
371                                    char const *,            /* variable name */
372                                    vlc_value_t,                 /* old value */
373                                    vlc_value_t,                 /* new value */
374                                    void * );                /* callback data */
375
376 /*****************************************************************************
377  * List callbacks: called when elements are added/removed from the list
378  *****************************************************************************/
379 typedef int ( * vlc_list_callback_t ) ( vlc_object_t *,      /* variable's object */
380                                         char const *,            /* variable name */
381                                         int,                  /* VLC_VAR_* action */
382                                         vlc_value_t *,      /* new/deleted value  */
383                                         void *);                 /* callback data */
384
385 /*****************************************************************************
386  * OS-specific headers and thread types
387  *****************************************************************************/
388 #if defined( _WIN32 )
389 #   include <malloc.h>
390 #   ifndef PATH_MAX
391 #       define PATH_MAX MAX_PATH
392 #   endif
393 #   include <windows.h>
394 #endif
395
396 #ifdef __APPLE__
397 #include <sys/syslimits.h>
398 #include <AvailabilityMacros.h>
399 #endif
400
401 #ifdef __OS2__
402 #   define OS2EMX_PLAIN_CHAR
403 #   define INCL_BASE
404 #   define INCL_PM
405 #   include <os2safe.h>
406 #   include <os2.h>
407 #endif
408
409 #include "vlc_mtime.h"
410 #include "vlc_threads.h"
411
412 /**
413  * Common structure members
414  *****************************************************************************/
415
416 /**
417  * VLC object common members
418  *
419  * Common public properties for all VLC objects.
420  * Object also have private properties maintained by the core, see
421  * \ref vlc_object_internals_t
422  */
423 struct vlc_common_members
424 {
425     /** Object type name
426      *
427      * A constant string identifying the type of the object (for logging)
428      */
429     const char *object_type;
430
431     /** Log messages header
432      *
433      * Human-readable header for log messages. This is not thread-safe and
434      * only used by VLM and Lua interfaces.
435      */
436     char *header;
437
438     int  flags;
439
440     /** Module probe flag
441      *
442      * A boolean during module probing when the probe is "forced".
443      * See \ref module_need().
444      */
445     bool force;
446
447     /** LibVLC instance
448      *
449      * Root VLC object of the objects tree that this object belongs in.
450      */
451     libvlc_int_t *libvlc;
452
453     /** Parent object
454      *
455      * The parent VLC object in the objects tree. For the root (the LibVLC
456      * instance) object, this is NULL.
457      */
458     vlc_object_t *parent;
459 };
460
461 /**
462  * Backward compatibility macro
463  */
464 #define VLC_COMMON_MEMBERS struct vlc_common_members obj;
465
466 /**
467  * Type-safe vlc_object_t cast
468  *
469  * This macro attempts to cast a pointer to a compound type to a
470  * \ref vlc_object_t pointer in a type-safe manner.
471  * It checks if the compound type actually starts with an embedded
472  * \ref vlc_object_t structure.
473  */
474 #if !defined(__cplusplus)
475 # define VLC_OBJECT(x) \
476     _Generic((x)->obj, \
477         struct vlc_common_members: (vlc_object_t *)(&(x)->obj), \
478         const struct vlc_common_members: (const vlc_object_t *)(&(x)->obj) \
479     )
480 #else
481 # define VLC_OBJECT( x ) ((vlc_object_t *)&(x)->obj)
482 #endif
483
484 /*****************************************************************************
485  * Macros and inline functions
486  *****************************************************************************/
487
488 /* __MAX and __MIN: self explanatory */
489 #ifndef __MAX
490 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
491 #endif
492 #ifndef __MIN
493 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
494 #endif
495
496 /* clip v in [min, max] */
497 #define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
498
499 VLC_USED
500 static inline int64_t GCD ( int64_t a, int64_t b )
501 {
502     while( b )
503     {
504         int64_t c = a % b;
505         a = b;
506         b = c;
507     }
508     return a;
509 }
510
511 /* function imported from libavutil/common.h */
512 VLC_USED
513 static inline uint8_t clip_uint8_vlc( int32_t a )
514 {
515     if( a&(~255) ) return (-a)>>31;
516     else           return a;
517 }
518
519 /** Count leading zeroes */
520 VLC_USED
521 static inline unsigned (clz)(unsigned x)
522 {
523 #ifdef __GNUC__
524     return __builtin_clz (x);
525 #else
526     unsigned i = sizeof (x) * 8;
527
528     while (x)
529     {
530         x >>= 1;
531         i--;
532     }
533     return i;
534 #endif
535 }
536
537 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
538 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
539 /* XXX: this assumes that int is 32-bits or more */
540 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
541
542 /** Count trailing zeroes */
543 VLC_USED
544 static inline unsigned (ctz)(unsigned x)
545 {
546 #ifdef __GNUC__
547     return __builtin_ctz (x);
548 #else
549     unsigned i = sizeof (x) * 8;
550
551     while (x)
552     {
553         x <<= 1;
554         i--;
555     }
556     return i;
557 #endif
558 }
559
560 /** Bit weight */
561 VLC_USED
562 static inline unsigned (popcount)(unsigned x)
563 {
564 #ifdef __GNUC__
565     return __builtin_popcount (x);
566 #else
567     unsigned count = 0;
568     while (x)
569     {
570         count += x & 1;
571         x = x >> 1;
572     }
573     return count;
574 #endif
575 }
576
577 /** Bit weight of long long */
578 VLC_USED
579 static inline int (popcountll)(unsigned long long x)
580 {
581 #ifdef __GNUC__
582     return __builtin_popcountll(x);
583 #else
584     int count = 0;
585     while (x)
586     {
587         count += x & 1;
588         x = x >> 1;
589     }
590     return count;
591 #endif
592 }
593
594 VLC_USED
595 static inline unsigned (parity)(unsigned x)
596 {
597 #ifdef __GNUC__
598     return __builtin_parity (x);
599 #else
600     for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
601         x ^= x >> i;
602     return x & 1;
603 #endif
604 }
605
606 /** Byte swap (16 bits) */
607 VLC_USED
608 static inline uint16_t (bswap16)(uint16_t x)
609 {
610     return (x << 8) | (x >> 8);
611 }
612
613 /** Byte swap (32 bits) */
614 VLC_USED
615 static inline uint32_t (bswap32)(uint32_t x)
616 {
617 #if defined (__GNUC__) || defined(__clang__)
618     return __builtin_bswap32 (x);
619 #else
620     return ((x & 0x000000FF) << 24)
621          | ((x & 0x0000FF00) <<  8)
622          | ((x & 0x00FF0000) >>  8)
623          | ((x & 0xFF000000) >> 24);
624 #endif
625 }
626
627 /** Byte swap (64 bits) */
628 VLC_USED
629 static inline uint64_t (bswap64)(uint64_t x)
630 {
631 #if defined (__GNUC__) || defined(__clang__)
632     return __builtin_bswap64 (x);
633 #elif !defined (__cplusplus)
634     return ((x & 0x00000000000000FF) << 56)
635          | ((x & 0x000000000000FF00) << 40)
636          | ((x & 0x0000000000FF0000) << 24)
637          | ((x & 0x00000000FF000000) <<  8)
638          | ((x & 0x000000FF00000000) >>  8)
639          | ((x & 0x0000FF0000000000) >> 24)
640          | ((x & 0x00FF000000000000) >> 40)
641          | ((x & 0xFF00000000000000) >> 56);
642 #else
643     return ((x & 0x00000000000000FFULL) << 56)
644          | ((x & 0x000000000000FF00ULL) << 40)
645          | ((x & 0x0000000000FF0000ULL) << 24)
646          | ((x & 0x00000000FF000000ULL) <<  8)
647          | ((x & 0x000000FF00000000ULL) >>  8)
648          | ((x & 0x0000FF0000000000ULL) >> 24)
649          | ((x & 0x00FF000000000000ULL) >> 40)
650          | ((x & 0xFF00000000000000ULL) >> 56);
651 #endif
652 }
653
654 /* Integer overflow */
655 static inline bool uadd_overflow(unsigned a, unsigned b, unsigned *res)
656 {
657 #if defined(__GNUC__) || defined(__clang__)
658      return __builtin_uadd_overflow(a, b, res);
659 #else
660      *res = a + b;
661      return (a + b) < a;
662 #endif
663 }
664
665 static inline bool uaddl_overflow(unsigned long a, unsigned long b,
666                                   unsigned long *res)
667 {
668 #if defined(__GNUC__) || defined(__clang__)
669      return __builtin_uaddl_overflow(a, b, res);
670 #else
671      *res = a + b;
672      return (a + b) < a;
673 #endif
674 }
675
676 static inline bool uaddll_overflow(unsigned long long a, unsigned long long b,
677                                    unsigned long long *res)
678 {
679 #if defined(__GNUC__) || defined(__clang__)
680      return __builtin_uaddll_overflow(a, b, res);
681 #else
682      *res = a + b;
683      return (a + b) < a;
684 #endif
685 }
686
687 #ifndef __cplusplus
688 # define add_overflow(a,b,r) \
689     _Generic(*(r), \
690         unsigned: uadd_overflow(a, b, (unsigned *)(r)), \
691         unsigned long: uaddl_overflow(a, b, (unsigned long *)(r)), \
692         unsigned long long: uaddll_overflow(a, b, (unsigned long long *)(r)))
693 #else
694 static inline bool add_overflow(unsigned a, unsigned b, unsigned *res)
695 {
696     return uadd_overflow(a, b, res);
697 }
698
699 static inline bool add_overflow(unsigned long a, unsigned long b,
700                                 unsigned long *res)
701 {
702     return uaddl_overflow(a, b, res);
703 }
704
705 static inline bool add_overflow(unsigned long long a, unsigned long long b,
706                                 unsigned long long *res)
707 {
708     return uaddll_overflow(a, b, res);
709 }
710 #endif
711
712 static inline bool umul_overflow(unsigned a, unsigned b, unsigned *res)
713 {
714 #if defined(__GNUC__) || defined(__clang__)
715      return __builtin_umul_overflow(a, b, res);
716 #else
717      *res = a * b;
718      return b > 0 && a > (UINT_MAX / b);
719 #endif
720 }
721
722 static inline bool umull_overflow(unsigned long a, unsigned long b,
723                                   unsigned long *res)
724 {
725 #if defined(__GNUC__) || defined(__clang__)
726      return __builtin_umull_overflow(a, b, res);
727 #else
728      *res = a * b;
729      return b > 0 && a > (ULONG_MAX / b);
730 #endif
731 }
732
733 static inline bool umulll_overflow(unsigned long long a, unsigned long long b,
734                                    unsigned long long *res)
735 {
736 #if defined(__GNUC__) || defined(__clang__)
737      return __builtin_umulll_overflow(a, b, res);
738 #else
739      *res = a * b;
740      return b > 0 && a > (ULLONG_MAX / b);
741 #endif
742 }
743
744 #ifndef __cplusplus
745 #define mul_overflow(a,b,r) \
746     _Generic(*(r), \
747         unsigned: umul_overflow(a, b, (unsigned *)(r)), \
748         unsigned long: umull_overflow(a, b, (unsigned long *)(r)), \
749         unsigned long long: umulll_overflow(a, b, (unsigned long long *)(r)))
750 #else
751 static inline bool mul_overflow(unsigned a, unsigned b, unsigned *res)
752 {
753     return umul_overflow(a, b, res);
754 }
755
756 static inline bool mul_overflow(unsigned long a, unsigned long b,
757                                 unsigned long *res)
758 {
759     return umull_overflow(a, b, res);
760 }
761
762 static inline bool mul_overflow(unsigned long long a, unsigned long long b,
763                                 unsigned long long *res)
764 {
765     return umulll_overflow(a, b, res);
766 }
767 #endif
768
769 /* Free and set set the variable to NULL */
770 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
771
772 #define EMPTY_STR(str) (!str || !*str)
773
774 VLC_API char const * vlc_error( int ) VLC_USED;
775
776 #include <vlc_arrays.h>
777
778 /* MSB (big endian)/LSB (little endian) conversions - network order is always
779  * MSB, and should be used for both network communications and files. */
780
781 #ifdef WORDS_BIGENDIAN
782 # define hton16(i) ((uint16_t)(i))
783 # define hton32(i) ((uint32_t)(i))
784 # define hton64(i) ((uint64_t)(i))
785 #else
786 # define hton16(i) bswap16(i)
787 # define hton32(i) bswap32(i)
788 # define hton64(i) bswap64(i)
789 #endif
790 #define ntoh16(i) hton16(i)
791 #define ntoh32(i) hton32(i)
792 #define ntoh64(i) hton64(i)
793
794 /** Reads 16 bits in network byte order */
795 VLC_USED
796 static inline uint16_t U16_AT (const void *p)
797 {
798     uint16_t x;
799
800     memcpy (&x, p, sizeof (x));
801     return ntoh16 (x);
802 }
803
804 /** Reads 32 bits in network byte order */
805 VLC_USED
806 static inline uint32_t U32_AT (const void *p)
807 {
808     uint32_t x;
809
810     memcpy (&x, p, sizeof (x));
811     return ntoh32 (x);
812 }
813
814 /** Reads 64 bits in network byte order */
815 VLC_USED
816 static inline uint64_t U64_AT (const void *p)
817 {
818     uint64_t x;
819
820     memcpy (&x, p, sizeof (x));
821     return ntoh64 (x);
822 }
823
824 #define GetWBE(p)  U16_AT(p)
825 #define GetDWBE(p) U32_AT(p)
826 #define GetQWBE(p) U64_AT(p)
827
828 /** Reads 16 bits in little-endian order */
829 VLC_USED
830 static inline uint16_t GetWLE (const void *p)
831 {
832     uint16_t x;
833
834     memcpy (&x, p, sizeof (x));
835 #ifdef WORDS_BIGENDIAN
836     x = bswap16 (x);
837 #endif
838     return x;
839 }
840
841 /** Reads 32 bits in little-endian order */
842 VLC_USED
843 static inline uint32_t GetDWLE (const void *p)
844 {
845     uint32_t x;
846
847     memcpy (&x, p, sizeof (x));
848 #ifdef WORDS_BIGENDIAN
849     x = bswap32 (x);
850 #endif
851     return x;
852 }
853
854 /** Reads 64 bits in little-endian order */
855 VLC_USED
856 static inline uint64_t GetQWLE (const void *p)
857 {
858     uint64_t x;
859
860     memcpy (&x, p, sizeof (x));
861 #ifdef WORDS_BIGENDIAN
862     x = bswap64 (x);
863 #endif
864     return x;
865 }
866
867 /** Writes 16 bits in network byte order */
868 static inline void SetWBE (void *p, uint16_t w)
869 {
870     w = hton16 (w);
871     memcpy (p, &w, sizeof (w));
872 }
873
874 /** Writes 32 bits in network byte order */
875 static inline void SetDWBE (void *p, uint32_t dw)
876 {
877     dw = hton32 (dw);
878     memcpy (p, &dw, sizeof (dw));
879 }
880
881 /** Writes 64 bits in network byte order */
882 static inline void SetQWBE (void *p, uint64_t qw)
883 {
884     qw = hton64 (qw);
885     memcpy (p, &qw, sizeof (qw));
886 }
887
888 /** Writes 16 bits in little endian order */
889 static inline void SetWLE (void *p, uint16_t w)
890 {
891 #ifdef WORDS_BIGENDIAN
892     w = bswap16 (w);
893 #endif
894     memcpy (p, &w, sizeof (w));
895 }
896
897 /** Writes 32 bits in little endian order */
898 static inline void SetDWLE (void *p, uint32_t dw)
899 {
900 #ifdef WORDS_BIGENDIAN
901     dw = bswap32 (dw);
902 #endif
903     memcpy (p, &dw, sizeof (dw));
904 }
905
906 /** Writes 64 bits in little endian order */
907 static inline void SetQWLE (void *p, uint64_t qw)
908 {
909 #ifdef WORDS_BIGENDIAN
910     qw = bswap64 (qw);
911 #endif
912     memcpy (p, &qw, sizeof (qw));
913 }
914
915 /* */
916 #define VLC_UNUSED(x) (void)(x)
917
918 /* Stuff defined in src/extras/libc.c */
919
920 #if defined(_WIN32)
921 /* several type definitions */
922 #   if defined( __MINGW32__ )
923 #       if !defined( _OFF_T_ )
924             typedef long long _off_t;
925             typedef _off_t off_t;
926 #           define _OFF_T_
927 #       else
928 #           ifdef off_t
929 #               undef off_t
930 #           endif
931 #           define off_t long long
932 #       endif
933 #   endif
934
935 #   ifndef O_NONBLOCK
936 #       define O_NONBLOCK 0
937 #   endif
938
939 #   include <tchar.h>
940 #endif /* _WIN32 */
941
942 typedef struct {
943     unsigned num, den;
944 } vlc_rational_t;
945
946 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
947
948 #define container_of(ptr, type, member) \
949     ((type *)(((char *)(ptr)) - offsetof(type, member)))
950
951 VLC_USED VLC_MALLOC
952 static inline void *vlc_alloc(size_t count, size_t size)
953 {
954     return mul_overflow(count, size, &size) ? NULL : malloc(size);
955 }
956
957 /*****************************************************************************
958  * I18n stuff
959  *****************************************************************************/
960 VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
961 VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
962
963 #define vlc_pgettext( ctx, id ) \
964         vlc_pgettext_aux( ctx "\004" id, id )
965
966 VLC_FORMAT_ARG(2)
967 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
968 {
969     const char *tr = vlc_gettext( ctx );
970     return (tr == ctx) ? id : tr;
971 }
972
973 /*****************************************************************************
974  * Loosy memory allocation functions. Do not use in new code.
975  *****************************************************************************/
976 static inline void *xmalloc(size_t len)
977 {
978     void *ptr = malloc(len);
979     if (unlikely(ptr == NULL && len > 0))
980         abort();
981     return ptr;
982 }
983
984 static inline void *xrealloc(void *ptr, size_t len)
985 {
986     void *nptr = realloc(ptr, len);
987     if (unlikely(nptr == NULL && len > 0))
988         abort();
989     return nptr;
990 }
991
992 static inline void *xcalloc(size_t n, size_t size)
993 {
994     void *ptr = calloc(n, size);
995     if (unlikely(ptr == NULL && (n > 0 || size > 0)))
996         abort ();
997     return ptr;
998 }
999
1000 static inline char *xstrdup (const char *str)
1001 {
1002     char *ptr = strdup (str);
1003     if (unlikely(ptr == NULL))
1004         abort ();
1005     return ptr;
1006 }
1007
1008 /*****************************************************************************
1009  * libvlc features
1010  *****************************************************************************/
1011 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
1012 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
1013 VLC_API const char * VLC_Compiler( void ) VLC_USED;
1014
1015 /*****************************************************************************
1016  * Additional vlc stuff
1017  *****************************************************************************/
1018 #include "vlc_messages.h"
1019 #include "vlc_objects.h"
1020 #include "vlc_variables.h"
1021 #include "vlc_main.h"
1022 #include "vlc_configuration.h"
1023
1024 #if defined( _WIN32 ) || defined( __OS2__ )
1025 #   define DIR_SEP_CHAR '\\'
1026 #   define DIR_SEP "\\"
1027 #   define PATH_SEP_CHAR ';'
1028 #   define PATH_SEP ";"
1029 #else
1030 #   define DIR_SEP_CHAR '/'
1031 #   define DIR_SEP "/"
1032 #   define PATH_SEP_CHAR ':'
1033 #   define PATH_SEP ":"
1034 #endif
1035
1036 #define LICENSE_MSG \
1037   _("This program comes with NO WARRANTY, to the extent permitted by " \
1038     "law.\nYou may redistribute it under the terms of the GNU General " \
1039     "Public License;\nsee the file named COPYING for details.\n" \
1040     "Written by the VideoLAN team; see the AUTHORS file.\n")
1041
1042 #endif /* !VLC_COMMON_H */