aom: encoder: configure timebase
[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 #ifndef VLC_COMMON_H
28 # define VLC_COMMON_H 1
29
30 /**
31  * \defgroup vlc VLC plug-in programming interface
32  * \file
33  * \ingroup vlc
34  * This file is a collection of common definitions and types
35  */
36
37 /*****************************************************************************
38  * Required vlc headers
39  *****************************************************************************/
40 #include "vlc_config.h"
41
42 /*****************************************************************************
43  * Required system headers
44  *****************************************************************************/
45 #include <stdlib.h>
46 #include <stdarg.h>
47
48 #include <string.h>
49 #include <stdio.h>
50 #include <inttypes.h>
51 #include <stddef.h>
52
53 #ifndef __cplusplus
54 # include <stdbool.h>
55 #endif
56
57 /**
58  * \defgroup cext C programming language extensions
59  * \ingroup vlc
60  *
61  * This section defines a number of macros and inline functions extending the
62  * C language. Most extensions are implemented by GCC and LLVM/Clang, and have
63  * unoptimized fallbacks for other C11/C++11 conforming compilers.
64  * @{
65  */
66 #ifdef __GNUC__
67 # define VLC_GCC_VERSION(maj,min) \
68     ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
69 #else
70 /** GCC version check */
71 # define VLC_GCC_VERSION(maj,min) (0)
72 #endif
73
74 /* Try to fix format strings for all versions of mingw and mingw64 */
75 #if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
76  #undef PRId64
77  #define PRId64 "lld"
78  #undef PRIi64
79  #define PRIi64 "lli"
80  #undef PRIu64
81  #define PRIu64 "llu"
82  #undef PRIo64
83  #define PRIo64 "llo"
84  #undef PRIx64
85  #define PRIx64 "llx"
86  #define snprintf __mingw_snprintf
87  #define vsnprintf __mingw_vsnprintf
88  #define swprintf _snwprintf
89 #endif
90
91 /* Function attributes for compiler warnings */
92 #ifdef __GNUC__
93 # define VLC_DEPRECATED __attribute__((deprecated))
94 # if VLC_GCC_VERSION(6,0)
95 #  define VLC_DEPRECATED_ENUM __attribute__((deprecated))
96 # else
97 #  define VLC_DEPRECATED_ENUM
98 # endif
99
100 # if defined( _WIN32 ) && !defined( __clang__ )
101 #  define VLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
102 # else
103 #  define VLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
104 # endif
105 # define VLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
106 # define VLC_MALLOC __attribute__ ((malloc))
107 # define VLC_USED __attribute__ ((warn_unused_result))
108
109 #else
110 /**
111  * Deprecated functions or compound members annotation
112  *
113  * Use this macro in front of a function declaration or compound member
114  * within a compound type declaration.
115  * The compiler may emit a warning every time the function or member is used.
116  *
117  * Use \ref VLC_DEPRECATED_ENUM instead for enumeration members.
118  */
119 # define VLC_DEPRECATED
120
121 /**
122  * Deprecated enum member annotation
123  *
124  * Use this macro after an enumerated type member declaration.
125  * The compiler may emit a warning every time the enumeration member is used.
126  *
127  * See also \ref VLC_DEPRECATED.
128  */
129 # define VLC_DEPRECATED_ENUM
130
131 /**
132  * String format function annotation
133  *
134  * Use this macro after a function prototype/declaration if the function
135  * expects a standard C format string. This helps compiler diagnostics.
136  *
137  * @param x the position (starting from 1) of the format string argument
138  * @param y the first position (also starting from 1) of the variable arguments
139  *          following the format string (usually but not always \p x+1).
140  */
141 # define VLC_FORMAT(x,y)
142
143 /**
144  * Format string translation function annotation
145  *
146  * Use this macro after a function prototype/declaration if the function
147  * expects a format string as input and returns another format string as output
148  * to another function.
149  *
150  * This is primarily intended for localization functions such as gettext().
151  */
152 # define VLC_FORMAT_ARG(x)
153
154 /**
155  * Heap allocated result function annotation
156  *
157  * Use this macro to annotate a function that returns a pointer to memory that
158  * cannot alias any other valid pointer.
159  *
160  * This is primarily used for functions that return a pointer to heap-allocated
161  * memory, but it can be used for other applicable purposes.
162  *
163  * \warning Do not use this annotation if the returned pointer can in any way
164  * alias a valid pointer at the time the function exits. This could lead to
165  * very weird memory corruption bugs.
166  */
167 # define VLC_MALLOC
168
169 /**
170  * Used result function annotation
171  *
172  * Use this macro to annotate a function whose result must be used.
173  *
174  * There are several cases where this is useful:
175  * - If a function has no side effects (or no useful side effects), such that
176  *   the only useful purpose of calling said function is to obtain its
177  *   return value.
178  * - If ignoring the function return value would lead to a resource leak
179  *   (including but not limited to a memory leak).
180  * - If a function cannot be used correctly without checking its return value.
181  *   For instance, if the function can fail at any time.
182  *
183  * The compiler may warn if the return value of a function call is ignored.
184  */
185 # define VLC_USED
186 #endif
187
188 #ifdef __ELF__
189 # define VLC_WEAK __attribute__((weak))
190 #else
191 /**
192  * Weak symbol annotation
193  *
194  * Use this macro before an external identifier \b definition to mark it as a
195  * weak symbol. A weak symbol can be overriden by another symbol of the same
196  * name at the link time.
197  */
198 # define VLC_WEAK
199 #endif
200
201 /* Branch prediction */
202 #if defined (__GNUC__) || defined (__clang__)
203 # define likely(p)     __builtin_expect(!!(p), 1)
204 # define unlikely(p)   __builtin_expect(!!(p), 0)
205 # define unreachable() __builtin_unreachable()
206 #else
207 /**
208  * Predicted true condition
209  *
210  * This macro indicates that the condition is expected most often true.
211  * The compiler may optimize the code assuming that this condition is usually
212  * met.
213  */
214 # define likely(p)     (!!(p))
215
216 /**
217  * Predicted false condition
218  *
219  * This macro indicates that the condition is expected most often false.
220  * The compiler may optimize the code assuming that this condition is rarely
221  * met.
222  */
223 # define unlikely(p)   (!!(p))
224
225 /**
226  * Impossible branch
227  *
228  * This macro indicates that the branch cannot be reached at run-time, and
229  * represents undefined behaviour.
230  * The compiler may optimize the code assuming that the call flow will never
231  * logically reach the point where this macro is expanded.
232  *
233  * See also \ref vlc_assert_unreachable.
234  */
235 # define unreachable() ((void)0)
236 #endif
237
238 /**
239  * Impossible branch assertion
240  *
241  * This macro asserts that the branch cannot be reached at run-time.
242  *
243  * If the branch is reached in a debug build, it will trigger an assertion
244  * failure and abnormal program termination.
245  *
246  * If the branch is reached in a non-debug build, this macro is equivalent to
247  * \ref unreachable and the behaviour is undefined.
248  */
249 #define vlc_assert_unreachable() (vlc_assert(!"unreachable"), unreachable())
250
251 /**
252  * Run-time assertion
253  *
254  * This macro performs a run-time assertion if C assertions are enabled
255  * and the following preprocessor symbol is defined:
256  * @verbatim __LIBVLC__ @endverbatim
257  * That restriction ensures that assertions in public header files are not
258  * unwittingly <i>leaked</i> to externally-compiled plug-ins
259  * including those header files.
260  *
261  * Within the LibVLC code base, this is exactly the same as assert(), which can
262  * and probably should be used directly instead.
263  */
264 #ifdef __LIBVLC__
265 # define vlc_assert(pred) assert(pred)
266 #else
267 # define vlc_assert(pred) ((void)0)
268 #endif
269
270 /* Linkage */
271 #ifdef __cplusplus
272 # define VLC_EXTERN extern "C"
273 #else
274 # define VLC_EXTERN
275 #endif
276
277 #if defined (_WIN32) && defined (DLL_EXPORT)
278 # define VLC_EXPORT __declspec(dllexport)
279 #elif defined (__GNUC__)
280 # define VLC_EXPORT __attribute__((visibility("default")))
281 #else
282 # define VLC_EXPORT
283 #endif
284
285 /**
286  * Exported API call annotation
287  *
288  * This macro is placed before a function declaration to indicate that the
289  * function is an API call of the LibVLC plugin API.
290  */
291 #define VLC_API VLC_EXTERN VLC_EXPORT
292
293 /** @} */
294
295 /*****************************************************************************
296  * Basic types definitions
297  *****************************************************************************/
298 /**
299  * The vlc_fourcc_t type.
300  *
301  * See http://www.webartz.com/fourcc/ for a very detailed list.
302  */
303 typedef uint32_t vlc_fourcc_t;
304
305 #ifdef WORDS_BIGENDIAN
306 #   define VLC_FOURCC( a, b, c, d ) \
307         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
308            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
309 #   define VLC_TWOCC( a, b ) \
310         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
311
312 #else
313 #   define VLC_FOURCC( a, b, c, d ) \
314         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
315            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
316 #   define VLC_TWOCC( a, b ) \
317         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
318
319 #endif
320
321 /**
322  * Translate a vlc_fourcc into its string representation. This function
323  * assumes there is enough room in psz_fourcc to store 4 characters in.
324  *
325  * \param fcc a vlc_fourcc_t
326  * \param psz_fourcc string to store string representation of vlc_fourcc in
327  */
328 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
329 {
330     memcpy( psz_fourcc, &fcc, 4 );
331 }
332
333 /*****************************************************************************
334  * Classes declaration
335  *****************************************************************************/
336
337 /* Internal types */
338 typedef struct vlc_object_t vlc_object_t;
339 typedef struct libvlc_int_t libvlc_int_t;
340 typedef struct date_t date_t;
341
342 /* Playlist */
343
344 typedef struct playlist_t playlist_t;
345 typedef struct playlist_item_t playlist_item_t;
346 typedef struct services_discovery_t services_discovery_t;
347 typedef struct vlc_renderer_discovery_t vlc_renderer_discovery_t;
348 typedef struct vlc_renderer_item_t vlc_renderer_item_t;
349
350 /* Modules */
351 typedef struct module_t module_t;
352 typedef struct module_config_t module_config_t;
353
354 typedef struct config_category_t config_category_t;
355
356 /* Input */
357 typedef struct input_thread_t input_thread_t;
358 typedef struct input_item_t input_item_t;
359 typedef struct input_item_node_t input_item_node_t;
360 typedef struct stream_t     stream_t;
361 typedef struct stream_t demux_t;
362 typedef struct es_out_t     es_out_t;
363 typedef struct es_out_id_t  es_out_id_t;
364 typedef struct seekpoint_t seekpoint_t;
365 typedef struct info_t info_t;
366 typedef struct info_category_t info_category_t;
367 typedef struct input_attachment_t input_attachment_t;
368
369 /* Format */
370 typedef struct audio_format_t audio_format_t;
371 typedef struct video_format_t video_format_t;
372 typedef struct subs_format_t subs_format_t;
373 typedef struct es_format_t es_format_t;
374 typedef struct video_palette_t video_palette_t;
375 typedef struct vlc_es_id_t vlc_es_id_t;
376
377 /* Audio */
378 typedef struct audio_output audio_output_t;
379 typedef audio_format_t audio_sample_format_t;
380
381 /* Video */
382 typedef struct vout_thread_t vout_thread_t;
383 typedef struct vlc_viewpoint_t vlc_viewpoint_t;
384
385 typedef video_format_t video_frame_format_t;
386 typedef struct picture_t picture_t;
387
388 /* Subpictures */
389 typedef struct spu_t spu_t;
390 typedef struct subpicture_t subpicture_t;
391 typedef struct subpicture_region_t subpicture_region_t;
392
393 typedef struct image_handler_t image_handler_t;
394
395 /* Stream output */
396 typedef struct sout_instance_t sout_instance_t;
397
398 typedef struct sout_input_t sout_input_t;
399 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
400
401 typedef struct sout_access_out_t sout_access_out_t;
402
403 typedef struct sout_mux_t sout_mux_t;
404
405 typedef struct sout_stream_t    sout_stream_t;
406
407 typedef struct config_chain_t       config_chain_t;
408 typedef struct session_descriptor_t session_descriptor_t;
409
410 /* Decoders */
411 typedef struct decoder_t         decoder_t;
412 typedef struct decoder_synchro_t decoder_synchro_t;
413
414 /* Encoders */
415 typedef struct encoder_t      encoder_t;
416
417 /* Filters */
418 typedef struct filter_t filter_t;
419
420 /* Network */
421 typedef struct vlc_url_t vlc_url_t;
422
423 /* Misc */
424 typedef struct iso639_lang_t iso639_lang_t;
425
426 /* block */
427 typedef struct block_t      block_t;
428 typedef struct block_fifo_t block_fifo_t;
429
430 /* Hashing */
431 typedef struct md5_s md5_t;
432
433 /* XML */
434 typedef struct xml_t xml_t;
435 typedef struct xml_reader_t xml_reader_t;
436
437 /* vod server */
438 typedef struct vod_t     vod_t;
439 typedef struct vod_media_t vod_media_t;
440
441 /* VLM */
442 typedef struct vlm_t         vlm_t;
443 typedef struct vlm_message_t vlm_message_t;
444
445 /* misc */
446 typedef struct vlc_meta_t    vlc_meta_t;
447 typedef struct input_stats_t input_stats_t;
448 typedef struct addon_entry_t addon_entry_t;
449
450 /* Update */
451 typedef struct update_t update_t;
452
453 /**
454  * VLC value structure
455  */
456 typedef union
457 {
458     int64_t         i_int;
459     bool            b_bool;
460     float           f_float;
461     char *          psz_string;
462     void *          p_address;
463     struct { int32_t x; int32_t y; } coords;
464
465 } vlc_value_t;
466
467 /*****************************************************************************
468  * Error values (shouldn't be exposed)
469  *****************************************************************************/
470 #define VLC_SUCCESS        (-0) /**< No error */
471 #define VLC_EGENERIC       (-1) /**< Unspecified error */
472 #define VLC_ENOMEM         (-2) /**< Not enough memory */
473 #define VLC_ETIMEOUT       (-3) /**< Timeout */
474 #define VLC_ENOMOD         (-4) /**< Module not found */
475 #define VLC_ENOOBJ         (-5) /**< Object not found */
476 #define VLC_ENOVAR         (-6) /**< Variable not found */
477 #define VLC_EBADVAR        (-7) /**< Bad variable value */
478 #define VLC_ENOITEM        (-8) /**< Item not found */
479
480 /*****************************************************************************
481  * Variable callbacks: called when the value is modified
482  *****************************************************************************/
483 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
484                                    char const *,            /* variable name */
485                                    vlc_value_t,                 /* old value */
486                                    vlc_value_t,                 /* new value */
487                                    void * );                /* callback data */
488
489 /*****************************************************************************
490  * List callbacks: called when elements are added/removed from the list
491  *****************************************************************************/
492 typedef int ( * vlc_list_callback_t ) ( vlc_object_t *,      /* variable's object */
493                                         char const *,            /* variable name */
494                                         int,                  /* VLC_VAR_* action */
495                                         vlc_value_t *,      /* new/deleted value  */
496                                         void *);                 /* callback data */
497
498 /*****************************************************************************
499  * OS-specific headers and thread types
500  *****************************************************************************/
501 #if defined( _WIN32 )
502 #   include <malloc.h>
503 #   ifndef PATH_MAX
504 #       define PATH_MAX MAX_PATH
505 #   endif
506 #   include <windows.h>
507 #endif
508
509 #ifdef __APPLE__
510 #include <sys/syslimits.h>
511 #include <AvailabilityMacros.h>
512 #endif
513
514 #ifdef __OS2__
515 #   define OS2EMX_PLAIN_CHAR
516 #   define INCL_BASE
517 #   define INCL_PM
518 #   include <os2safe.h>
519 #   include <os2.h>
520 #endif
521
522 #include "vlc_tick.h"
523 #include "vlc_threads.h"
524
525 /**
526  * \defgroup intops Integer operations
527  * \ingroup cext
528  *
529  * Common integer functions.
530  * @{
531  */
532 /* __MAX and __MIN: self explanatory */
533 #ifndef __MAX
534 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
535 #endif
536 #ifndef __MIN
537 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
538 #endif
539
540 /* clip v in [min, max] */
541 #define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
542
543 /** Greatest common divisor */
544 VLC_USED
545 static inline int64_t GCD ( int64_t a, int64_t b )
546 {
547     while( b )
548     {
549         int64_t c = a % b;
550         a = b;
551         b = c;
552     }
553     return a;
554 }
555
556 /* function imported from libavutil/common.h */
557 VLC_USED
558 static inline uint8_t clip_uint8_vlc( int32_t a )
559 {
560     if( a&(~255) ) return (-a)>>31;
561     else           return a;
562 }
563
564 /**
565  * \defgroup bitops Bit operations
566  * @{
567  */
568
569 #define VLC_INT_FUNC(basename) \
570         VLC_INT_FUNC_TYPE(basename, unsigned, ) \
571         VLC_INT_FUNC_TYPE(basename, unsigned long, l) \
572         VLC_INT_FUNC_TYPE(basename, unsigned long long, ll)
573
574 #if defined (__GNUC__) || defined (__clang__)
575 # define VLC_INT_FUNC_TYPE(basename,type,suffix) \
576 VLC_USED static inline int vlc_##basename##suffix(type x) \
577 { \
578     return __builtin_##basename##suffix(x); \
579 }
580
581 VLC_INT_FUNC(clz)
582 #else
583 VLC_USED static inline int vlc_clzll(unsigned long long x)
584 {
585     int i = sizeof (x) * 8;
586
587     while (x)
588     {
589         x >>= 1;
590         i--;
591     }
592     return i;
593 }
594
595 VLC_USED static inline int vlc_clzl(unsigned long x)
596 {
597     return vlc_clzll(x) - ((sizeof (long long) - sizeof (long)) * 8);
598 }
599
600 VLC_USED static inline int vlc_clz(unsigned x)
601 {
602     return vlc_clzll(x) - ((sizeof (long long) - sizeof (int)) * 8);
603 }
604
605 VLC_USED static inline int vlc_ctz_generic(unsigned long long x)
606 {
607     unsigned i = sizeof (x) * 8;
608
609     while (x)
610     {
611         x <<= 1;
612         i--;
613     }
614     return i;
615 }
616
617 VLC_USED static inline int vlc_parity_generic(unsigned long long x)
618 {
619     for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
620         x ^= x >> i;
621     return x & 1;
622 }
623
624 VLC_USED static inline int vlc_popcount_generic(unsigned long long x)
625 {
626     int count = 0;
627     while (x)
628     {
629         count += x & 1;
630         x = x >> 1;
631     }
632     return count;
633 }
634
635 # define VLC_INT_FUNC_TYPE(basename,type,suffix) \
636 VLC_USED static inline int vlc_##basename##suffix(type x) \
637 { \
638     return vlc_##basename##_generic(x); \
639 }
640 #endif
641
642 VLC_INT_FUNC(ctz)
643 VLC_INT_FUNC(parity)
644 VLC_INT_FUNC(popcount)
645
646 #ifndef __cplusplus
647 # define VLC_INT_GENERIC(func,x) \
648     _Generic((x), \
649         unsigned char:      func(x), \
650           signed char:      func(x), \
651         unsigned short:     func(x), \
652           signed short:     func(x), \
653         unsigned int:       func(x), \
654           signed int:       func(x), \
655         unsigned long:      func##l(x), \
656           signed long:      func##l(x), \
657         unsigned long long: func##ll(x), \
658           signed long long: func##ll(x))
659
660 /**
661  * Count leading zeroes
662  *
663  * This function counts the number of consecutive zero (clear) bits
664  * down from the highest order bit in an unsigned integer.
665  *
666  * \param x a non-zero integer
667  * \note This macro assumes that CHAR_BIT equals 8.
668  * \warning By definition, the result depends on the (width of the) type of x.
669  * \return The number of leading zero bits in x.
670  */
671 # define clz(x) \
672     _Generic((x), \
673         unsigned char: (vlc_clz(x) - (sizeof (unsigned) - 1) * 8), \
674         unsigned short: (vlc_clz(x) \
675         - (sizeof (unsigned) - sizeof (unsigned short)) * 8), \
676         unsigned: vlc_clz(x), \
677         unsigned long: vlc_clzl(x), \
678         unsigned long long: vlc_clzll(x))
679
680 /**
681  * Count trailing zeroes
682  *
683  * This function counts the number of consecutive zero bits
684  * up from the lowest order bit in an unsigned integer.
685  *
686  * \param x a non-zero integer
687  * \note This function assumes that CHAR_BIT equals 8.
688  * \return The number of trailing zero bits in x.
689  */
690 # define ctz(x) VLC_INT_GENERIC(vlc_ctz, x)
691
692 /**
693  * Parity
694  *
695  * This function determines the parity of an integer.
696  * \retval 0 if x has an even number of set bits.
697  * \retval 1 if x has an odd number of set bits.
698  */
699 # define parity(x) VLC_INT_GENERIC(vlc_parity, x)
700
701 /**
702  * Bit weight / population count
703  *
704  * This function counts the number of non-zero bits in an integer.
705  *
706  * \return The count of non-zero bits.
707  */
708 # define vlc_popcount(x) \
709     _Generic((x), \
710         signed char:  vlc_popcount((unsigned char)(x)), \
711         signed short: vlc_popcount((unsigned short)(x)), \
712         default: VLC_INT_GENERIC(vlc_popcount ,x))
713 #else
714 VLC_USED static inline int vlc_popcount(unsigned char x)
715 {
716     return vlc_popcount((unsigned)x);
717 }
718
719 VLC_USED static inline int vlc_popcount(unsigned short x)
720 {
721     return vlc_popcount((unsigned)x);
722 }
723
724 VLC_USED static inline int vlc_popcount(unsigned long x)
725 {
726     return vlc_popcountl(x);
727 }
728
729 VLC_USED static inline int vlc_popcount(unsigned long long x)
730 {
731     return vlc_popcountll(x);
732 }
733 #endif
734
735 /** Byte swap (16 bits) */
736 VLC_USED
737 static inline uint16_t vlc_bswap16(uint16_t x)
738 {
739     return (x << 8) | (x >> 8);
740 }
741
742 /** Byte swap (32 bits) */
743 VLC_USED
744 static inline uint32_t vlc_bswap32(uint32_t x)
745 {
746 #if defined (__GNUC__) || defined(__clang__)
747     return __builtin_bswap32 (x);
748 #else
749     return ((x & 0x000000FF) << 24)
750          | ((x & 0x0000FF00) <<  8)
751          | ((x & 0x00FF0000) >>  8)
752          | ((x & 0xFF000000) >> 24);
753 #endif
754 }
755
756 /** Byte swap (64 bits) */
757 VLC_USED
758 static inline uint64_t vlc_bswap64(uint64_t x)
759 {
760 #if defined (__GNUC__) || defined(__clang__)
761     return __builtin_bswap64 (x);
762 #elif !defined (__cplusplus)
763     return ((x & 0x00000000000000FF) << 56)
764          | ((x & 0x000000000000FF00) << 40)
765          | ((x & 0x0000000000FF0000) << 24)
766          | ((x & 0x00000000FF000000) <<  8)
767          | ((x & 0x000000FF00000000) >>  8)
768          | ((x & 0x0000FF0000000000) >> 24)
769          | ((x & 0x00FF000000000000) >> 40)
770          | ((x & 0xFF00000000000000) >> 56);
771 #else
772     return ((x & 0x00000000000000FFULL) << 56)
773          | ((x & 0x000000000000FF00ULL) << 40)
774          | ((x & 0x0000000000FF0000ULL) << 24)
775          | ((x & 0x00000000FF000000ULL) <<  8)
776          | ((x & 0x000000FF00000000ULL) >>  8)
777          | ((x & 0x0000FF0000000000ULL) >> 24)
778          | ((x & 0x00FF000000000000ULL) >> 40)
779          | ((x & 0xFF00000000000000ULL) >> 56);
780 #endif
781 }
782 /** @} */
783
784 /**
785  * \defgroup overflow Overflowing arithmetic
786  * @{
787  */
788 static inline bool uadd_overflow(unsigned a, unsigned b, unsigned *res)
789 {
790 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
791      return __builtin_uadd_overflow(a, b, res);
792 #else
793      *res = a + b;
794      return (a + b) < a;
795 #endif
796 }
797
798 static inline bool uaddl_overflow(unsigned long a, unsigned long b,
799                                   unsigned long *res)
800 {
801 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
802      return __builtin_uaddl_overflow(a, b, res);
803 #else
804      *res = a + b;
805      return (a + b) < a;
806 #endif
807 }
808
809 static inline bool uaddll_overflow(unsigned long long a, unsigned long long b,
810                                    unsigned long long *res)
811 {
812 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
813      return __builtin_uaddll_overflow(a, b, res);
814 #else
815      *res = a + b;
816      return (a + b) < a;
817 #endif
818 }
819
820 #ifndef __cplusplus
821 /**
822  * Overflowing addition
823  *
824  * Converts \p a and \p b to the type of \p *r.
825  * Then computes the sum of both conversions while checking for overflow.
826  * Finally stores the result in \p *r.
827  *
828  * \param a an integer
829  * \param b an integer
830  * \param r a pointer to an integer [OUT]
831  * \retval false The sum did not overflow.
832  * \retval true The sum overflowed.
833  */
834 # define add_overflow(a,b,r) \
835     _Generic(*(r), \
836         unsigned: uadd_overflow(a, b, (unsigned *)(r)), \
837         unsigned long: uaddl_overflow(a, b, (unsigned long *)(r)), \
838         unsigned long long: uaddll_overflow(a, b, (unsigned long long *)(r)))
839 #else
840 static inline bool add_overflow(unsigned a, unsigned b, unsigned *res)
841 {
842     return uadd_overflow(a, b, res);
843 }
844
845 static inline bool add_overflow(unsigned long a, unsigned long b,
846                                 unsigned long *res)
847 {
848     return uaddl_overflow(a, b, res);
849 }
850
851 static inline bool add_overflow(unsigned long long a, unsigned long long b,
852                                 unsigned long long *res)
853 {
854     return uaddll_overflow(a, b, res);
855 }
856 #endif
857
858 #if !(VLC_GCC_VERSION(5,0) || defined(__clang__))
859 # include <limits.h>
860 #endif
861
862 static inline bool umul_overflow(unsigned a, unsigned b, unsigned *res)
863 {
864 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
865      return __builtin_umul_overflow(a, b, res);
866 #else
867      *res = a * b;
868      return b > 0 && a > (UINT_MAX / b);
869 #endif
870 }
871
872 static inline bool umull_overflow(unsigned long a, unsigned long b,
873                                   unsigned long *res)
874 {
875 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
876      return __builtin_umull_overflow(a, b, res);
877 #else
878      *res = a * b;
879      return b > 0 && a > (ULONG_MAX / b);
880 #endif
881 }
882
883 static inline bool umulll_overflow(unsigned long long a, unsigned long long b,
884                                    unsigned long long *res)
885 {
886 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
887      return __builtin_umulll_overflow(a, b, res);
888 #else
889      *res = a * b;
890      return b > 0 && a > (ULLONG_MAX / b);
891 #endif
892 }
893
894 #ifndef __cplusplus
895 /**
896  * Overflowing multiplication
897  *
898  * Converts \p a and \p b to the type of \p *r.
899  * Then computes the product of both conversions while checking for overflow.
900  * Finally stores the result in \p *r.
901  *
902  * \param a an integer
903  * \param b an integer
904  * \param r a pointer to an integer [OUT]
905  * \retval false The product did not overflow.
906  * \retval true The product overflowed.
907  */
908 #define mul_overflow(a,b,r) \
909     _Generic(*(r), \
910         unsigned: umul_overflow(a, b, (unsigned *)(r)), \
911         unsigned long: umull_overflow(a, b, (unsigned long *)(r)), \
912         unsigned long long: umulll_overflow(a, b, (unsigned long long *)(r)))
913 #else
914 static inline bool mul_overflow(unsigned a, unsigned b, unsigned *res)
915 {
916     return umul_overflow(a, b, res);
917 }
918
919 static inline bool mul_overflow(unsigned long a, unsigned long b,
920                                 unsigned long *res)
921 {
922     return umull_overflow(a, b, res);
923 }
924
925 static inline bool mul_overflow(unsigned long long a, unsigned long long b,
926                                 unsigned long long *res)
927 {
928     return umulll_overflow(a, b, res);
929 }
930 #endif
931 /** @} */
932 /** @} */
933
934 /* Free and set set the variable to NULL */
935 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
936
937 #define EMPTY_STR(str) (!str || !*str)
938
939 VLC_API char const * vlc_error( int ) VLC_USED;
940
941 #include <vlc_arrays.h>
942
943 /* MSB (big endian)/LSB (little endian) conversions - network order is always
944  * MSB, and should be used for both network communications and files. */
945
946 #ifdef WORDS_BIGENDIAN
947 # define hton16(i) ((uint16_t)(i))
948 # define hton32(i) ((uint32_t)(i))
949 # define hton64(i) ((uint64_t)(i))
950 #else
951 # define hton16(i) vlc_bswap16(i)
952 # define hton32(i) vlc_bswap32(i)
953 # define hton64(i) vlc_bswap64(i)
954 #endif
955 #define ntoh16(i) hton16(i)
956 #define ntoh32(i) hton32(i)
957 #define ntoh64(i) hton64(i)
958
959 /** Reads 16 bits in network byte order */
960 VLC_USED
961 static inline uint16_t U16_AT (const void *p)
962 {
963     uint16_t x;
964
965     memcpy (&x, p, sizeof (x));
966     return ntoh16 (x);
967 }
968
969 /** Reads 32 bits in network byte order */
970 VLC_USED
971 static inline uint32_t U32_AT (const void *p)
972 {
973     uint32_t x;
974
975     memcpy (&x, p, sizeof (x));
976     return ntoh32 (x);
977 }
978
979 /** Reads 64 bits in network byte order */
980 VLC_USED
981 static inline uint64_t U64_AT (const void *p)
982 {
983     uint64_t x;
984
985     memcpy (&x, p, sizeof (x));
986     return ntoh64 (x);
987 }
988
989 #define GetWBE(p)  U16_AT(p)
990 #define GetDWBE(p) U32_AT(p)
991 #define GetQWBE(p) U64_AT(p)
992
993 /** Reads 16 bits in little-endian order */
994 VLC_USED
995 static inline uint16_t GetWLE (const void *p)
996 {
997     uint16_t x;
998
999     memcpy (&x, p, sizeof (x));
1000 #ifdef WORDS_BIGENDIAN
1001     x = vlc_bswap16 (x);
1002 #endif
1003     return x;
1004 }
1005
1006 /** Reads 32 bits in little-endian order */
1007 VLC_USED
1008 static inline uint32_t GetDWLE (const void *p)
1009 {
1010     uint32_t x;
1011
1012     memcpy (&x, p, sizeof (x));
1013 #ifdef WORDS_BIGENDIAN
1014     x = vlc_bswap32 (x);
1015 #endif
1016     return x;
1017 }
1018
1019 /** Reads 64 bits in little-endian order */
1020 VLC_USED
1021 static inline uint64_t GetQWLE (const void *p)
1022 {
1023     uint64_t x;
1024
1025     memcpy (&x, p, sizeof (x));
1026 #ifdef WORDS_BIGENDIAN
1027     x = vlc_bswap64 (x);
1028 #endif
1029     return x;
1030 }
1031
1032 /** Writes 16 bits in network byte order */
1033 static inline void SetWBE (void *p, uint16_t w)
1034 {
1035     w = hton16 (w);
1036     memcpy (p, &w, sizeof (w));
1037 }
1038
1039 /** Writes 32 bits in network byte order */
1040 static inline void SetDWBE (void *p, uint32_t dw)
1041 {
1042     dw = hton32 (dw);
1043     memcpy (p, &dw, sizeof (dw));
1044 }
1045
1046 /** Writes 64 bits in network byte order */
1047 static inline void SetQWBE (void *p, uint64_t qw)
1048 {
1049     qw = hton64 (qw);
1050     memcpy (p, &qw, sizeof (qw));
1051 }
1052
1053 /** Writes 16 bits in little endian order */
1054 static inline void SetWLE (void *p, uint16_t w)
1055 {
1056 #ifdef WORDS_BIGENDIAN
1057     w = vlc_bswap16 (w);
1058 #endif
1059     memcpy (p, &w, sizeof (w));
1060 }
1061
1062 /** Writes 32 bits in little endian order */
1063 static inline void SetDWLE (void *p, uint32_t dw)
1064 {
1065 #ifdef WORDS_BIGENDIAN
1066     dw = vlc_bswap32 (dw);
1067 #endif
1068     memcpy (p, &dw, sizeof (dw));
1069 }
1070
1071 /** Writes 64 bits in little endian order */
1072 static inline void SetQWLE (void *p, uint64_t qw)
1073 {
1074 #ifdef WORDS_BIGENDIAN
1075     qw = vlc_bswap64 (qw);
1076 #endif
1077     memcpy (p, &qw, sizeof (qw));
1078 }
1079
1080 /* */
1081 #define VLC_UNUSED(x) (void)(x)
1082
1083 /* Stuff defined in src/extras/libc.c */
1084
1085 #if defined(_WIN32)
1086 /* several type definitions */
1087 #   if defined( __MINGW32__ )
1088 #       if !defined( _OFF_T_ )
1089             typedef long long _off_t;
1090             typedef _off_t off_t;
1091 #           define _OFF_T_
1092 #       else
1093 #           ifdef off_t
1094 #               undef off_t
1095 #           endif
1096 #           define off_t long long
1097 #       endif
1098 #   endif
1099
1100 #   ifndef O_NONBLOCK
1101 #       define O_NONBLOCK 0
1102 #   endif
1103
1104 #   include <tchar.h>
1105 #endif /* _WIN32 */
1106
1107 typedef struct {
1108     unsigned num, den;
1109 } vlc_rational_t;
1110
1111 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
1112
1113 #define container_of(ptr, type, member) \
1114     ((type *)(((char *)(ptr)) - offsetof(type, member)))
1115
1116 VLC_USED VLC_MALLOC
1117 static inline void *vlc_alloc(size_t count, size_t size)
1118 {
1119     return mul_overflow(count, size, &size) ? NULL : malloc(size);
1120 }
1121
1122 /*****************************************************************************
1123  * I18n stuff
1124  *****************************************************************************/
1125 VLC_API const char *vlc_gettext(const char *msgid) VLC_FORMAT_ARG(1);
1126 VLC_API const char *vlc_ngettext(const char *s, const char *p, unsigned long n)
1127 VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
1128
1129 #define vlc_pgettext( ctx, id ) \
1130         vlc_pgettext_aux( ctx "\004" id, id )
1131
1132 VLC_FORMAT_ARG(2)
1133 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
1134 {
1135     const char *tr = vlc_gettext( ctx );
1136     return (tr == ctx) ? id : tr;
1137 }
1138
1139 /*****************************************************************************
1140  * Loosy memory allocation functions. Do not use in new code.
1141  *****************************************************************************/
1142 static inline void *xmalloc(size_t len)
1143 {
1144     void *ptr = malloc(len);
1145     if (unlikely(ptr == NULL && len > 0))
1146         abort();
1147     return ptr;
1148 }
1149
1150 static inline void *xrealloc(void *ptr, size_t len)
1151 {
1152     void *nptr = realloc(ptr, len);
1153     if (unlikely(nptr == NULL && len > 0))
1154         abort();
1155     return nptr;
1156 }
1157
1158 static inline char *xstrdup (const char *str)
1159 {
1160     char *ptr = strdup (str);
1161     if (unlikely(ptr == NULL))
1162         abort ();
1163     return ptr;
1164 }
1165
1166 /*****************************************************************************
1167  * libvlc features
1168  *****************************************************************************/
1169 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
1170 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
1171 VLC_API const char * VLC_Compiler( void ) VLC_USED;
1172
1173 /*****************************************************************************
1174  * Additional vlc stuff
1175  *****************************************************************************/
1176 #include "vlc_messages.h"
1177 #include "vlc_objects.h"
1178 #include "vlc_variables.h"
1179 #include "vlc_configuration.h"
1180
1181 #if defined( _WIN32 ) || defined( __OS2__ )
1182 #   define DIR_SEP_CHAR '\\'
1183 #   define DIR_SEP "\\"
1184 #   define PATH_SEP_CHAR ';'
1185 #   define PATH_SEP ";"
1186 #else
1187 #   define DIR_SEP_CHAR '/'
1188 #   define DIR_SEP "/"
1189 #   define PATH_SEP_CHAR ':'
1190 #   define PATH_SEP ":"
1191 #endif
1192
1193 #define LICENSE_MSG \
1194   _("This program comes with NO WARRANTY, to the extent permitted by " \
1195     "law.\nYou may redistribute it under the terms of the GNU General " \
1196     "Public License;\nsee the file named COPYING for details.\n" \
1197     "Written by the VideoLAN team; see the AUTHORS file.\n")
1198
1199 #endif /* !VLC_COMMON_H */