demux: adaptive: case-insensitive compare of scheme
[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 )
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() (assert(!"unreachable"), unreachable())
250
251 /* Linkage */
252 #ifdef __cplusplus
253 # define VLC_EXTERN extern "C"
254 #else
255 # define VLC_EXTERN
256 #endif
257
258 #if defined (_WIN32) && defined (DLL_EXPORT)
259 # define VLC_EXPORT __declspec(dllexport)
260 #elif defined (__GNUC__)
261 # define VLC_EXPORT __attribute__((visibility("default")))
262 #else
263 # define VLC_EXPORT
264 #endif
265
266 /**
267  * Exported API call annotation
268  *
269  * This macro is placed before a function declaration to indicate that the
270  * function is an API call of the LibVLC plugin API.
271  */
272 #define VLC_API VLC_EXTERN VLC_EXPORT
273
274 /** @} */
275
276 /*****************************************************************************
277  * Basic types definitions
278  *****************************************************************************/
279 /**
280  * High precision date or time interval
281  *
282  * Store a high precision date or time interval. The maximum precision is the
283  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
284  * time interval is then 292271 years, which should be long enough for any
285  * video). Dates are stored as microseconds since a common date (usually the
286  * epoch). Note that date and time intervals can be manipulated using regular
287  * arithmetic operators, and that no special functions are required.
288  */
289 typedef int64_t mtime_t;
290
291 /**
292  * The vlc_fourcc_t type.
293  *
294  * See http://www.webartz.com/fourcc/ for a very detailed list.
295  */
296 typedef uint32_t vlc_fourcc_t;
297
298 #ifdef WORDS_BIGENDIAN
299 #   define VLC_FOURCC( a, b, c, d ) \
300         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
301            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
302 #   define VLC_TWOCC( a, b ) \
303         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
304
305 #else
306 #   define VLC_FOURCC( a, b, c, d ) \
307         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
308            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
309 #   define VLC_TWOCC( a, b ) \
310         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
311
312 #endif
313
314 /**
315  * Translate a vlc_fourcc into its string representation. This function
316  * assumes there is enough room in psz_fourcc to store 4 characters in.
317  *
318  * \param fcc a vlc_fourcc_t
319  * \param psz_fourcc string to store string representation of vlc_fourcc in
320  */
321 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
322 {
323     memcpy( psz_fourcc, &fcc, 4 );
324 }
325
326 /*****************************************************************************
327  * Classes declaration
328  *****************************************************************************/
329
330 /* Internal types */
331 typedef struct vlc_list_t vlc_list_t;
332 typedef struct vlc_object_t vlc_object_t;
333 typedef struct libvlc_int_t libvlc_int_t;
334 typedef struct date_t date_t;
335
336 /* Playlist */
337
338 typedef struct playlist_t playlist_t;
339 typedef struct playlist_item_t playlist_item_t;
340 typedef struct services_discovery_t services_discovery_t;
341 typedef struct services_discovery_sys_t services_discovery_sys_t;
342 typedef struct vlc_renderer_discovery_t vlc_renderer_discovery_t;
343 typedef struct vlc_renderer_item_t vlc_renderer_item_t;
344
345 /* Modules */
346 typedef struct module_t module_t;
347 typedef struct module_config_t module_config_t;
348
349 typedef struct config_category_t config_category_t;
350
351 /* Input */
352 typedef struct input_thread_t input_thread_t;
353 typedef struct input_item_t input_item_t;
354 typedef struct input_item_node_t input_item_node_t;
355 typedef struct access_sys_t access_sys_t;
356 typedef struct stream_t     stream_t;
357 typedef struct stream_sys_t stream_sys_t;
358 typedef struct demux_t  demux_t;
359 typedef struct demux_sys_t demux_sys_t;
360 typedef struct es_out_t     es_out_t;
361 typedef struct es_out_id_t  es_out_id_t;
362 typedef struct es_out_sys_t es_out_sys_t;
363 typedef struct seekpoint_t seekpoint_t;
364 typedef struct info_t info_t;
365 typedef struct info_category_t info_category_t;
366 typedef struct input_attachment_t input_attachment_t;
367
368 /* Format */
369 typedef struct audio_format_t audio_format_t;
370 typedef struct video_format_t video_format_t;
371 typedef struct subs_format_t subs_format_t;
372 typedef struct es_format_t es_format_t;
373 typedef struct video_palette_t video_palette_t;
374
375 /* Audio */
376 typedef struct audio_output audio_output_t;
377 typedef struct aout_sys_t aout_sys_t;
378 typedef audio_format_t audio_sample_format_t;
379
380 /* Video */
381 typedef struct vout_thread_t vout_thread_t;
382 typedef struct vlc_viewpoint_t vlc_viewpoint_t;
383
384 typedef video_format_t video_frame_format_t;
385 typedef struct picture_t picture_t;
386 typedef struct picture_sys_t picture_sys_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 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
403
404 typedef struct sout_mux_t sout_mux_t;
405 typedef struct sout_mux_sys_t sout_mux_sys_t;
406
407 typedef struct sout_stream_t    sout_stream_t;
408 typedef struct sout_stream_sys_t sout_stream_sys_t;
409
410 typedef struct config_chain_t       config_chain_t;
411 typedef struct session_descriptor_t session_descriptor_t;
412
413 /* Decoders */
414 typedef struct decoder_t         decoder_t;
415 typedef struct decoder_sys_t     decoder_sys_t;
416 typedef struct decoder_synchro_t decoder_synchro_t;
417
418 /* Encoders */
419 typedef struct encoder_t      encoder_t;
420 typedef struct encoder_sys_t  encoder_sys_t;
421
422 /* Filters */
423 typedef struct filter_t filter_t;
424 typedef struct filter_sys_t filter_sys_t;
425
426 /* Network */
427 typedef struct vlc_url_t vlc_url_t;
428
429 /* Misc */
430 typedef struct iso639_lang_t iso639_lang_t;
431
432 /* block */
433 typedef struct block_t      block_t;
434 typedef struct block_fifo_t block_fifo_t;
435
436 /* Hashing */
437 typedef struct md5_s md5_t;
438
439 /* XML */
440 typedef struct xml_t xml_t;
441 typedef struct xml_sys_t xml_sys_t;
442 typedef struct xml_reader_t xml_reader_t;
443 typedef struct xml_reader_sys_t xml_reader_sys_t;
444
445 /* vod server */
446 typedef struct vod_t     vod_t;
447 typedef struct vod_sys_t vod_sys_t;
448 typedef struct vod_media_t vod_media_t;
449
450 /* VLM */
451 typedef struct vlm_t         vlm_t;
452 typedef struct vlm_message_t vlm_message_t;
453
454 /* misc */
455 typedef struct vlc_meta_t    vlc_meta_t;
456 typedef struct input_stats_t input_stats_t;
457 typedef struct addon_entry_t addon_entry_t;
458
459 /* Update */
460 typedef struct update_t update_t;
461
462 /**
463  * VLC value structure
464  */
465 typedef union
466 {
467     int64_t         i_int;
468     bool            b_bool;
469     float           f_float;
470     char *          psz_string;
471     void *          p_address;
472     vlc_list_t *    p_list;
473     struct { int32_t x; int32_t y; } coords;
474
475 } vlc_value_t;
476
477 /**
478  * VLC list structure
479  */
480 struct vlc_list_t
481 {
482     int          i_type;
483     int          i_count;
484     vlc_value_t *p_values;
485 };
486
487 /*****************************************************************************
488  * Error values (shouldn't be exposed)
489  *****************************************************************************/
490 #define VLC_SUCCESS        (-0) /**< No error */
491 #define VLC_EGENERIC       (-1) /**< Unspecified error */
492 #define VLC_ENOMEM         (-2) /**< Not enough memory */
493 #define VLC_ETIMEOUT       (-3) /**< Timeout */
494 #define VLC_ENOMOD         (-4) /**< Module not found */
495 #define VLC_ENOOBJ         (-5) /**< Object not found */
496 #define VLC_ENOVAR         (-6) /**< Variable not found */
497 #define VLC_EBADVAR        (-7) /**< Bad variable value */
498 #define VLC_ENOITEM        (-8) /**< Item not found */
499
500 /*****************************************************************************
501  * Variable callbacks: called when the value is modified
502  *****************************************************************************/
503 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
504                                    char const *,            /* variable name */
505                                    vlc_value_t,                 /* old value */
506                                    vlc_value_t,                 /* new value */
507                                    void * );                /* callback data */
508
509 /*****************************************************************************
510  * List callbacks: called when elements are added/removed from the list
511  *****************************************************************************/
512 typedef int ( * vlc_list_callback_t ) ( vlc_object_t *,      /* variable's object */
513                                         char const *,            /* variable name */
514                                         int,                  /* VLC_VAR_* action */
515                                         vlc_value_t *,      /* new/deleted value  */
516                                         void *);                 /* callback data */
517
518 /*****************************************************************************
519  * OS-specific headers and thread types
520  *****************************************************************************/
521 #if defined( _WIN32 )
522 #   include <malloc.h>
523 #   ifndef PATH_MAX
524 #       define PATH_MAX MAX_PATH
525 #   endif
526 #   include <windows.h>
527 #endif
528
529 #ifdef __APPLE__
530 #include <sys/syslimits.h>
531 #include <AvailabilityMacros.h>
532 #endif
533
534 #ifdef __OS2__
535 #   define OS2EMX_PLAIN_CHAR
536 #   define INCL_BASE
537 #   define INCL_PM
538 #   include <os2safe.h>
539 #   include <os2.h>
540 #endif
541
542 #include "vlc_mtime.h"
543 #include "vlc_threads.h"
544
545 /**
546  * \defgroup intops Integer operations
547  * \ingroup cext
548  *
549  * Common integer functions.
550  * @{
551  */
552 /* __MAX and __MIN: self explanatory */
553 #ifndef __MAX
554 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
555 #endif
556 #ifndef __MIN
557 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
558 #endif
559
560 /* clip v in [min, max] */
561 #define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
562
563 /** Greatest common divisor */
564 VLC_USED
565 static inline int64_t GCD ( int64_t a, int64_t b )
566 {
567     while( b )
568     {
569         int64_t c = a % b;
570         a = b;
571         b = c;
572     }
573     return a;
574 }
575
576 /* function imported from libavutil/common.h */
577 VLC_USED
578 static inline uint8_t clip_uint8_vlc( int32_t a )
579 {
580     if( a&(~255) ) return (-a)>>31;
581     else           return a;
582 }
583
584 /**
585  * \defgroup bitops Bit operations
586  * @{
587  */
588 #if defined (__GNUC__) || defined (__clang__)
589 # ifndef __cplusplus
590 #  define clz(x) \
591     _Generic((x), \
592         unsigned char: (__builtin_clz(x) \
593                 - (sizeof (unsigned) - 1) * 8), \
594         unsigned short: (__builtin_clz(x) \
595                 - (sizeof (unsigned) - sizeof (unsigned short)) * 8), \
596         unsigned: __builtin_clz(x), \
597         unsigned long: __builtin_clzl(x), \
598         unsigned long long: __builtin_clzll(x))
599
600 #  define ctz(x) \
601     _Generic((x), \
602         unsigned char: __builtin_ctz(x), \
603         unsigned short: __builtin_ctz(x), \
604         unsigned: __builtin_ctz(x), \
605         unsigned long: __builtin_ctzl(x), \
606         unsigned long long: __builtin_ctzll(x))
607
608 #  define popcount(x) \
609     _Generic((x), \
610         unsigned char:      __builtin_popcount(x), \
611           signed char:      __builtin_popcount((unsigned char)(x)), \
612         unsigned short:     __builtin_popcount(x), \
613           signed short:     __builtin_popcount((unsigned short)(x)), \
614         unsigned int:       __builtin_popcount(x), \
615           signed int:       __builtin_popcount(x), \
616         unsigned long:      __builtin_popcountl(x), \
617           signed long:      __builtin_popcountl(x), \
618         unsigned long long: __builtin_popcountll(x), \
619           signed long long: __builtin_popcountll(x))
620
621 #  define parity(x) \
622     _Generic((x), \
623         unsigned char: __builtin_parity(x), \
624           signed char: __builtin_parity(x), \
625         unsigned short: __builtin_parity(x), \
626           signed short: __builtin_parity(x), \
627         unsigned int: __builtin_parity(x), \
628           signed int: __builtin_parity(x), \
629         unsigned long: __builtin_parityl(x), \
630           signed long: __builtin_parityl(x), \
631         unsigned long long: __builtin_parityll(x), \
632           signed long long: __builtin_parityll(x))
633
634 # else
635 VLC_USED static inline int ctz(unsigned x)
636 {
637     return __builtin_ctz(x);
638 }
639
640 VLC_USED static inline int ctz(unsigned long x)
641 {
642     return __builtin_ctzl(x);
643 }
644
645 VLC_USED static inline int ctz(unsigned long long x)
646 {
647     return __builtin_ctzll(x);
648 }
649
650 VLC_USED static inline int popcount(unsigned char x)
651 {
652     return __builtin_popcount(x);
653 }
654
655 VLC_USED static inline int popcount(unsigned short x)
656 {
657     return __builtin_popcount(x);
658 }
659
660 VLC_USED static inline int popcount(unsigned x)
661 {
662     return __builtin_popcount(x);
663 }
664
665 VLC_USED static inline int popcount(unsigned long x)
666 {
667     return __builtin_popcountl(x);
668 }
669
670 VLC_USED static inline int popcount(unsigned long long x)
671 {
672     return __builtin_popcountll(x);
673 }
674
675 VLC_USED static inline int parity(unsigned x)
676 {
677     return __builtin_parity(x);
678 }
679
680 VLC_USED static inline int parity(unsigned long x)
681 {
682     return __builtin_parityl(x);
683 }
684
685 VLC_USED static inline int parity(unsigned long long x)
686 {
687     return __builtin_parityll(x);
688 }
689
690 # endif
691 #else /* __GNUC__ */
692 # ifndef __cplusplus
693 VLC_USED static inline int clzbits(unsigned long long x, int maxbits)
694 {
695     int i = maxbits;
696
697     while (x)
698     {
699         x >>= 1;
700         i--;
701     }
702     return i;
703 }
704 #  define clztype(x, type) clzbits(x, sizeof (type) * 8)
705
706 /**
707  * Count leading zeroes
708  *
709  * This function counts the number of consecutive zero (clear) bits
710  * down from the highest order bit in an unsigned integer.
711  *
712  * \param x a non-zero integer
713  * \note This macro assumes that CHAR_BIT equals 8.
714  * \warning By definition, the result depends on the (width of the) type of x.
715  * \return The number of leading zero bits in x.
716  */
717 #  define clz(x) \
718     _Generic((x), \
719         unsigned char: clzbits(x, char), \
720         unsigned short: clzbits(x, short), \
721         unsigned: clzbits(x, int), \
722         unsigned long: clzbits(x, long), \
723         unsigned long long: clzbits(x, long long))
724 # endif
725
726 /**
727  * Count trailing zeroes
728  *
729  * This function counts the number of consecutive zero bits
730  * up from the lowest order bit in an unsigned integer.
731  *
732  * \param x a non-zero integer
733  * \note This function assumes that CHAR_BIT equals 8.
734  * \return The number of trailing zero bits in x.
735  */
736 VLC_USED static inline int ctz(unsigned long long x)
737 {
738     unsigned i = sizeof (x) * 8;
739
740     while (x)
741     {
742         x <<= 1;
743         i--;
744     }
745     return i;
746 }
747
748 VLC_USED static inline int popcount(unsigned long long x)
749 {
750     int count = 0;
751     while (x)
752     {
753         count += x & 1;
754         x = x >> 1;
755     }
756     return count;
757 }
758
759 # ifndef __cplusplus
760 /**
761  * Bit weight / population count
762  *
763  * This function counts the number of non-zero bits in an integer.
764  *
765  * \return The count of non-zero bits.
766  */
767 #  define popcount(x) \
768     _Generic((x), \
769         unsigned char:      popcount(x), \
770           signed char:      popcount((unsigned char)(x)), \
771         unsigned short:     popcount(x), \
772           signed short:     popcount((unsigned short)(x)), \
773         unsigned int:       popcount(x), \
774           signed int:       popcount((unsigned int)(x)), \
775         unsigned long:      popcount(x), \
776           signed long:      popcount((unsigned long)(x)), \
777         unsigned long long: popcount(x), \
778           signed long long: popcount(x))
779 #endif
780
781 /**
782  * Parity
783  *
784  * This function determines the parity of an integer.
785  * \retval 0 if x has an even number of set bits.
786  * \retval 1 if x has an odd number of set bits.
787  */
788 VLC_USED static inline int parity(unsigned long long x)
789 {
790     for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
791         x ^= x >> i;
792     return x & 1;
793 }
794
795 #endif /* __GNUC__ */
796
797 /** Byte swap (16 bits) */
798 VLC_USED
799 static inline uint16_t (bswap16)(uint16_t x)
800 {
801     return (x << 8) | (x >> 8);
802 }
803
804 /** Byte swap (32 bits) */
805 VLC_USED
806 static inline uint32_t (bswap32)(uint32_t x)
807 {
808 #if defined (__GNUC__) || defined(__clang__)
809     return __builtin_bswap32 (x);
810 #else
811     return ((x & 0x000000FF) << 24)
812          | ((x & 0x0000FF00) <<  8)
813          | ((x & 0x00FF0000) >>  8)
814          | ((x & 0xFF000000) >> 24);
815 #endif
816 }
817
818 /** Byte swap (64 bits) */
819 VLC_USED
820 static inline uint64_t (bswap64)(uint64_t x)
821 {
822 #if defined (__GNUC__) || defined(__clang__)
823     return __builtin_bswap64 (x);
824 #elif !defined (__cplusplus)
825     return ((x & 0x00000000000000FF) << 56)
826          | ((x & 0x000000000000FF00) << 40)
827          | ((x & 0x0000000000FF0000) << 24)
828          | ((x & 0x00000000FF000000) <<  8)
829          | ((x & 0x000000FF00000000) >>  8)
830          | ((x & 0x0000FF0000000000) >> 24)
831          | ((x & 0x00FF000000000000) >> 40)
832          | ((x & 0xFF00000000000000) >> 56);
833 #else
834     return ((x & 0x00000000000000FFULL) << 56)
835          | ((x & 0x000000000000FF00ULL) << 40)
836          | ((x & 0x0000000000FF0000ULL) << 24)
837          | ((x & 0x00000000FF000000ULL) <<  8)
838          | ((x & 0x000000FF00000000ULL) >>  8)
839          | ((x & 0x0000FF0000000000ULL) >> 24)
840          | ((x & 0x00FF000000000000ULL) >> 40)
841          | ((x & 0xFF00000000000000ULL) >> 56);
842 #endif
843 }
844 /** @} */
845
846 /**
847  * \defgroup overflow Overflowing arithmetic
848  * @{
849  */
850 static inline bool uadd_overflow(unsigned a, unsigned b, unsigned *res)
851 {
852 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
853      return __builtin_uadd_overflow(a, b, res);
854 #else
855      *res = a + b;
856      return (a + b) < a;
857 #endif
858 }
859
860 static inline bool uaddl_overflow(unsigned long a, unsigned long b,
861                                   unsigned long *res)
862 {
863 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
864      return __builtin_uaddl_overflow(a, b, res);
865 #else
866      *res = a + b;
867      return (a + b) < a;
868 #endif
869 }
870
871 static inline bool uaddll_overflow(unsigned long long a, unsigned long long b,
872                                    unsigned long long *res)
873 {
874 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
875      return __builtin_uaddll_overflow(a, b, res);
876 #else
877      *res = a + b;
878      return (a + b) < a;
879 #endif
880 }
881
882 #ifndef __cplusplus
883 /**
884  * Overflowing addition
885  *
886  * Converts \p a and \p b to the type of \p *r.
887  * Then computes the sum of both conversions while checking for overflow.
888  * Finally stores the result in \p *r.
889  *
890  * \param a an integer
891  * \param b an integer
892  * \param r a pointer to an integer [OUT]
893  * \retval false The sum did not overflow.
894  * \retval true The sum overflowed.
895  */
896 # define add_overflow(a,b,r) \
897     _Generic(*(r), \
898         unsigned: uadd_overflow(a, b, (unsigned *)(r)), \
899         unsigned long: uaddl_overflow(a, b, (unsigned long *)(r)), \
900         unsigned long long: uaddll_overflow(a, b, (unsigned long long *)(r)))
901 #else
902 static inline bool add_overflow(unsigned a, unsigned b, unsigned *res)
903 {
904     return uadd_overflow(a, b, res);
905 }
906
907 static inline bool add_overflow(unsigned long a, unsigned long b,
908                                 unsigned long *res)
909 {
910     return uaddl_overflow(a, b, res);
911 }
912
913 static inline bool add_overflow(unsigned long long a, unsigned long long b,
914                                 unsigned long long *res)
915 {
916     return uaddll_overflow(a, b, res);
917 }
918 #endif
919
920 #if !(VLC_GCC_VERSION(5,0) || defined(__clang__))
921 # include <limits.h>
922 #endif
923
924 static inline bool umul_overflow(unsigned a, unsigned b, unsigned *res)
925 {
926 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
927      return __builtin_umul_overflow(a, b, res);
928 #else
929      *res = a * b;
930      return b > 0 && a > (UINT_MAX / b);
931 #endif
932 }
933
934 static inline bool umull_overflow(unsigned long a, unsigned long b,
935                                   unsigned long *res)
936 {
937 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
938      return __builtin_umull_overflow(a, b, res);
939 #else
940      *res = a * b;
941      return b > 0 && a > (ULONG_MAX / b);
942 #endif
943 }
944
945 static inline bool umulll_overflow(unsigned long long a, unsigned long long b,
946                                    unsigned long long *res)
947 {
948 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
949      return __builtin_umulll_overflow(a, b, res);
950 #else
951      *res = a * b;
952      return b > 0 && a > (ULLONG_MAX / b);
953 #endif
954 }
955
956 #ifndef __cplusplus
957 /**
958  * Overflowing multiplication
959  *
960  * Converts \p a and \p b to the type of \p *r.
961  * Then computes the product of both conversions while checking for overflow.
962  * Finally stores the result in \p *r.
963  *
964  * \param a an integer
965  * \param b an integer
966  * \param r a pointer to an integer [OUT]
967  * \retval false The product did not overflow.
968  * \retval true The product overflowed.
969  */
970 #define mul_overflow(a,b,r) \
971     _Generic(*(r), \
972         unsigned: umul_overflow(a, b, (unsigned *)(r)), \
973         unsigned long: umull_overflow(a, b, (unsigned long *)(r)), \
974         unsigned long long: umulll_overflow(a, b, (unsigned long long *)(r)))
975 #else
976 static inline bool mul_overflow(unsigned a, unsigned b, unsigned *res)
977 {
978     return umul_overflow(a, b, res);
979 }
980
981 static inline bool mul_overflow(unsigned long a, unsigned long b,
982                                 unsigned long *res)
983 {
984     return umull_overflow(a, b, res);
985 }
986
987 static inline bool mul_overflow(unsigned long long a, unsigned long long b,
988                                 unsigned long long *res)
989 {
990     return umulll_overflow(a, b, res);
991 }
992 #endif
993 /** @} */
994 /** @} */
995
996 /* Free and set set the variable to NULL */
997 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
998
999 #define EMPTY_STR(str) (!str || !*str)
1000
1001 VLC_API char const * vlc_error( int ) VLC_USED;
1002
1003 #include <vlc_arrays.h>
1004
1005 /* MSB (big endian)/LSB (little endian) conversions - network order is always
1006  * MSB, and should be used for both network communications and files. */
1007
1008 #ifdef WORDS_BIGENDIAN
1009 # define hton16(i) ((uint16_t)(i))
1010 # define hton32(i) ((uint32_t)(i))
1011 # define hton64(i) ((uint64_t)(i))
1012 #else
1013 # define hton16(i) bswap16(i)
1014 # define hton32(i) bswap32(i)
1015 # define hton64(i) bswap64(i)
1016 #endif
1017 #define ntoh16(i) hton16(i)
1018 #define ntoh32(i) hton32(i)
1019 #define ntoh64(i) hton64(i)
1020
1021 /** Reads 16 bits in network byte order */
1022 VLC_USED
1023 static inline uint16_t U16_AT (const void *p)
1024 {
1025     uint16_t x;
1026
1027     memcpy (&x, p, sizeof (x));
1028     return ntoh16 (x);
1029 }
1030
1031 /** Reads 32 bits in network byte order */
1032 VLC_USED
1033 static inline uint32_t U32_AT (const void *p)
1034 {
1035     uint32_t x;
1036
1037     memcpy (&x, p, sizeof (x));
1038     return ntoh32 (x);
1039 }
1040
1041 /** Reads 64 bits in network byte order */
1042 VLC_USED
1043 static inline uint64_t U64_AT (const void *p)
1044 {
1045     uint64_t x;
1046
1047     memcpy (&x, p, sizeof (x));
1048     return ntoh64 (x);
1049 }
1050
1051 #define GetWBE(p)  U16_AT(p)
1052 #define GetDWBE(p) U32_AT(p)
1053 #define GetQWBE(p) U64_AT(p)
1054
1055 /** Reads 16 bits in little-endian order */
1056 VLC_USED
1057 static inline uint16_t GetWLE (const void *p)
1058 {
1059     uint16_t x;
1060
1061     memcpy (&x, p, sizeof (x));
1062 #ifdef WORDS_BIGENDIAN
1063     x = bswap16 (x);
1064 #endif
1065     return x;
1066 }
1067
1068 /** Reads 32 bits in little-endian order */
1069 VLC_USED
1070 static inline uint32_t GetDWLE (const void *p)
1071 {
1072     uint32_t x;
1073
1074     memcpy (&x, p, sizeof (x));
1075 #ifdef WORDS_BIGENDIAN
1076     x = bswap32 (x);
1077 #endif
1078     return x;
1079 }
1080
1081 /** Reads 64 bits in little-endian order */
1082 VLC_USED
1083 static inline uint64_t GetQWLE (const void *p)
1084 {
1085     uint64_t x;
1086
1087     memcpy (&x, p, sizeof (x));
1088 #ifdef WORDS_BIGENDIAN
1089     x = bswap64 (x);
1090 #endif
1091     return x;
1092 }
1093
1094 /** Writes 16 bits in network byte order */
1095 static inline void SetWBE (void *p, uint16_t w)
1096 {
1097     w = hton16 (w);
1098     memcpy (p, &w, sizeof (w));
1099 }
1100
1101 /** Writes 32 bits in network byte order */
1102 static inline void SetDWBE (void *p, uint32_t dw)
1103 {
1104     dw = hton32 (dw);
1105     memcpy (p, &dw, sizeof (dw));
1106 }
1107
1108 /** Writes 64 bits in network byte order */
1109 static inline void SetQWBE (void *p, uint64_t qw)
1110 {
1111     qw = hton64 (qw);
1112     memcpy (p, &qw, sizeof (qw));
1113 }
1114
1115 /** Writes 16 bits in little endian order */
1116 static inline void SetWLE (void *p, uint16_t w)
1117 {
1118 #ifdef WORDS_BIGENDIAN
1119     w = bswap16 (w);
1120 #endif
1121     memcpy (p, &w, sizeof (w));
1122 }
1123
1124 /** Writes 32 bits in little endian order */
1125 static inline void SetDWLE (void *p, uint32_t dw)
1126 {
1127 #ifdef WORDS_BIGENDIAN
1128     dw = bswap32 (dw);
1129 #endif
1130     memcpy (p, &dw, sizeof (dw));
1131 }
1132
1133 /** Writes 64 bits in little endian order */
1134 static inline void SetQWLE (void *p, uint64_t qw)
1135 {
1136 #ifdef WORDS_BIGENDIAN
1137     qw = bswap64 (qw);
1138 #endif
1139     memcpy (p, &qw, sizeof (qw));
1140 }
1141
1142 /* */
1143 #define VLC_UNUSED(x) (void)(x)
1144
1145 /* Stuff defined in src/extras/libc.c */
1146
1147 #if defined(_WIN32)
1148 /* several type definitions */
1149 #   if defined( __MINGW32__ )
1150 #       if !defined( _OFF_T_ )
1151             typedef long long _off_t;
1152             typedef _off_t off_t;
1153 #           define _OFF_T_
1154 #       else
1155 #           ifdef off_t
1156 #               undef off_t
1157 #           endif
1158 #           define off_t long long
1159 #       endif
1160 #   endif
1161
1162 #   ifndef O_NONBLOCK
1163 #       define O_NONBLOCK 0
1164 #   endif
1165
1166 #   include <tchar.h>
1167 #endif /* _WIN32 */
1168
1169 typedef struct {
1170     unsigned num, den;
1171 } vlc_rational_t;
1172
1173 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
1174
1175 #define container_of(ptr, type, member) \
1176     ((type *)(((char *)(ptr)) - offsetof(type, member)))
1177
1178 VLC_USED VLC_MALLOC
1179 static inline void *vlc_alloc(size_t count, size_t size)
1180 {
1181     return mul_overflow(count, size, &size) ? NULL : malloc(size);
1182 }
1183
1184 /*****************************************************************************
1185  * I18n stuff
1186  *****************************************************************************/
1187 VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
1188 VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
1189
1190 #define vlc_pgettext( ctx, id ) \
1191         vlc_pgettext_aux( ctx "\004" id, id )
1192
1193 VLC_FORMAT_ARG(2)
1194 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
1195 {
1196     const char *tr = vlc_gettext( ctx );
1197     return (tr == ctx) ? id : tr;
1198 }
1199
1200 /*****************************************************************************
1201  * Loosy memory allocation functions. Do not use in new code.
1202  *****************************************************************************/
1203 static inline void *xmalloc(size_t len)
1204 {
1205     void *ptr = malloc(len);
1206     if (unlikely(ptr == NULL && len > 0))
1207         abort();
1208     return ptr;
1209 }
1210
1211 static inline void *xrealloc(void *ptr, size_t len)
1212 {
1213     void *nptr = realloc(ptr, len);
1214     if (unlikely(nptr == NULL && len > 0))
1215         abort();
1216     return nptr;
1217 }
1218
1219 static inline void *xcalloc(size_t n, size_t size)
1220 {
1221     void *ptr = calloc(n, size);
1222     if (unlikely(ptr == NULL && (n > 0 || size > 0)))
1223         abort ();
1224     return ptr;
1225 }
1226
1227 static inline char *xstrdup (const char *str)
1228 {
1229     char *ptr = strdup (str);
1230     if (unlikely(ptr == NULL))
1231         abort ();
1232     return ptr;
1233 }
1234
1235 /*****************************************************************************
1236  * libvlc features
1237  *****************************************************************************/
1238 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
1239 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
1240 VLC_API const char * VLC_Compiler( void ) VLC_USED;
1241
1242 /*****************************************************************************
1243  * Additional vlc stuff
1244  *****************************************************************************/
1245 #include "vlc_messages.h"
1246 #include "vlc_objects.h"
1247 #include "vlc_variables.h"
1248 #include "vlc_configuration.h"
1249
1250 #if defined( _WIN32 ) || defined( __OS2__ )
1251 #   define DIR_SEP_CHAR '\\'
1252 #   define DIR_SEP "\\"
1253 #   define PATH_SEP_CHAR ';'
1254 #   define PATH_SEP ";"
1255 #else
1256 #   define DIR_SEP_CHAR '/'
1257 #   define DIR_SEP "/"
1258 #   define PATH_SEP_CHAR ':'
1259 #   define PATH_SEP ":"
1260 #endif
1261
1262 #define LICENSE_MSG \
1263   _("This program comes with NO WARRANTY, to the extent permitted by " \
1264     "law.\nYou may redistribute it under the terms of the GNU General " \
1265     "Public License;\nsee the file named COPYING for details.\n" \
1266     "Written by the VideoLAN team; see the AUTHORS file.\n")
1267
1268 #endif /* !VLC_COMMON_H */