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 #if defined (__ELF__) || defined (__MACH__)
 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_item_t input_item_t;
 358 typedef struct input_item_node_t input_item_node_t;
 359 typedef struct stream_t     stream_t;
 360 typedef struct stream_t demux_t;
 361 typedef struct es_out_t     es_out_t;
 362 typedef struct es_out_id_t  es_out_id_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 typedef struct vlc_es_id_t vlc_es_id_t;
 375
 376 /* Audio */
 377 typedef struct audio_output audio_output_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
 387 /* Subpictures */
 388 typedef struct spu_t spu_t;
 389 typedef struct subpicture_t subpicture_t;
 390 typedef struct subpicture_region_t subpicture_region_t;
 391
 392 typedef struct image_handler_t image_handler_t;
 393
 394 /* Stream output */
 395 typedef struct sout_instance_t sout_instance_t;
 396
 397 typedef struct sout_input_t sout_input_t;
 398 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 399
 400 typedef struct sout_access_out_t sout_access_out_t;
 401
 402 typedef struct sout_mux_t sout_mux_t;
 403
 404 typedef struct sout_stream_t    sout_stream_t;
 405
 406 typedef struct config_chain_t       config_chain_t;
 407 typedef struct session_descriptor_t session_descriptor_t;
 408
 409 /* Decoders */
 410 typedef struct decoder_t         decoder_t;
 411 typedef struct decoder_synchro_t decoder_synchro_t;
 412
 413 /* Encoders */
 414 typedef struct encoder_t      encoder_t;
 415
 416 /* Filters */
 417 typedef struct filter_t filter_t;
 418
 419 /* Network */
 420 typedef struct vlc_url_t vlc_url_t;
 421
 422 /* Misc */
 423 typedef struct iso639_lang_t iso639_lang_t;
 424
 425 /* block */
 426 typedef struct block_t      block_t;
 427 typedef struct block_fifo_t block_fifo_t;
 428
 429 /* Hashing */
 430 typedef struct md5_s md5_t;
 431
 432 /* XML */
 433 typedef struct xml_t xml_t;
 434 typedef struct xml_reader_t xml_reader_t;
 435
 436 /* vod server */
 437 typedef struct vod_t     vod_t;
 438 typedef struct vod_media_t vod_media_t;
 439
 440 /* VLM */
 441 typedef struct vlm_t         vlm_t;
 442 typedef struct vlm_message_t vlm_message_t;
 443
 444 /* misc */
 445 typedef struct vlc_meta_t    vlc_meta_t;
 446 typedef struct input_stats_t input_stats_t;
 447 typedef struct addon_entry_t addon_entry_t;
 448
 449 /* Update */
 450 typedef struct update_t update_t;
 451
 452 /**
 453  * VLC value structure
 454  */
 455 typedef union
 456 {
 457     int64_t         i_int;
 458     bool            b_bool;
 459     float           f_float;
 460     char *          psz_string;
 461     void *          p_address;
 462     struct { int32_t x; int32_t y; } coords;
 463
 464 } vlc_value_t;
 465
 466 /*****************************************************************************
 467  * Error values (shouldn't be exposed)
 468  *****************************************************************************/
 469 /** No error */
 470 #define VLC_SUCCESS        (-0)
 471 /** Unspecified error */
 472 #define VLC_EGENERIC       (-1)
 473 /** Not enough memory */
 474 #define VLC_ENOMEM         (-2)
 475 /** Timeout */
 476 #define VLC_ETIMEOUT       (-3)
 477 /** Module not found */
 478 #define VLC_ENOMOD         (-4)
 479 /** Object not found */
 480 #define VLC_ENOOBJ         (-5)
 481 /** Variable not found */
 482 #define VLC_ENOVAR         (-6)
 483 /** Bad variable value */
 484 #define VLC_EBADVAR        (-7)
 485 /** Item not found */
 486 #define VLC_ENOITEM        (-8)
 487
 488 /*****************************************************************************
 489  * Variable callbacks: called when the value is modified
 490  *****************************************************************************/
 491 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 492                                    char const *,            /* variable name */
 493                                    vlc_value_t,                 /* old value */
 494                                    vlc_value_t,                 /* new value */
 495                                    void * );                /* callback data */
 496
 497 /*****************************************************************************
 498  * List callbacks: called when elements are added/removed from the list
 499  *****************************************************************************/
 500 typedef int ( * vlc_list_callback_t ) ( vlc_object_t *,      /* variable's object */
 501                                         char const *,            /* variable name */
 502                                         int,                  /* VLC_VAR_* action */
 503                                         vlc_value_t *,      /* new/deleted value  */
 504                                         void *);                 /* callback data */
 505
 506 /*****************************************************************************
 507  * OS-specific headers and thread types
 508  *****************************************************************************/
 509 #if defined( _WIN32 )
 510 #   include <malloc.h>
 511 #   ifndef PATH_MAX
 512 #       define PATH_MAX MAX_PATH
 513 #   endif
 514 #   include <windows.h>
 515 #endif
 516
 517 #ifdef __APPLE__
 518 #include <sys/syslimits.h>
 519 #include <AvailabilityMacros.h>
 520 #endif
 521
 522 #ifdef __OS2__
 523 #   define OS2EMX_PLAIN_CHAR
 524 #   define INCL_BASE
 525 #   define INCL_PM
 526 #   include <os2safe.h>
 527 #   include <os2.h>
 528 #endif
 529
 530 #include "vlc_tick.h"
 531 #include "vlc_threads.h"
 532
 533 /**
 534  * \defgroup intops Integer operations
 535  * \ingroup cext
 536  *
 537  * Common integer functions.
 538  * @{
 539  */
 540 /* __MAX and __MIN: self explanatory */
 541 #ifndef __MAX
 542 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 543 #endif
 544 #ifndef __MIN
 545 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 546 #endif
 547
 548 /* clip v in [min, max] */
 549 #define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
 550
 551 /** Greatest common divisor */
 552 VLC_USED
 553 static inline int64_t GCD ( int64_t a, int64_t b )
 554 {
 555     while( b )
 556     {
 557         int64_t c = a % b;
 558         a = b;
 559         b = c;
 560     }
 561     return a;
 562 }
 563
 564 /* function imported from libavutil/common.h */
 565 VLC_USED
 566 static inline uint8_t clip_uint8_vlc( int32_t a )
 567 {
 568     if( a&(~255) ) return (-a)>>31;
 569     else           return a;
 570 }
 571
 572 /**
 573  * \defgroup bitops Bit operations
 574  * @{
 575  */
 576
 577 #define VLC_INT_FUNC(basename) \
 578         VLC_INT_FUNC_TYPE(basename, unsigned, ) \
 579         VLC_INT_FUNC_TYPE(basename, unsigned long, l) \
 580         VLC_INT_FUNC_TYPE(basename, unsigned long long, ll)
 581
 582 #if defined (__GNUC__) || defined (__clang__)
 583 # define VLC_INT_FUNC_TYPE(basename,type,suffix) \
 584 VLC_USED static inline int vlc_##basename##suffix(type x) \
 585 { \
 586     return __builtin_##basename##suffix(x); \
 587 }
 588
 589 VLC_INT_FUNC(clz)
 590 #else
 591 VLC_USED static inline int vlc_clzll(unsigned long long x)
 592 {
 593     int i = sizeof (x) * 8;
 594
 595     while (x)
 596     {
 597         x >>= 1;
 598         i--;
 599     }
 600     return i;
 601 }
 602
 603 VLC_USED static inline int vlc_clzl(unsigned long x)
 604 {
 605     return vlc_clzll(x) - ((sizeof (long long) - sizeof (long)) * 8);
 606 }
 607
 608 VLC_USED static inline int vlc_clz(unsigned x)
 609 {
 610     return vlc_clzll(x) - ((sizeof (long long) - sizeof (int)) * 8);
 611 }
 612
 613 VLC_USED static inline int vlc_ctz_generic(unsigned long long x)
 614 {
 615     unsigned i = sizeof (x) * 8;
 616
 617     while (x)
 618     {
 619         x <<= 1;
 620         i--;
 621     }
 622     return i;
 623 }
 624
 625 VLC_USED static inline int vlc_parity_generic(unsigned long long x)
 626 {
 627     for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
 628         x ^= x >> i;
 629     return x & 1;
 630 }
 631
 632 VLC_USED static inline int vlc_popcount_generic(unsigned long long x)
 633 {
 634     int count = 0;
 635     while (x)
 636     {
 637         count += x & 1;
 638         x = x >> 1;
 639     }
 640     return count;
 641 }
 642
 643 # define VLC_INT_FUNC_TYPE(basename,type,suffix) \
 644 VLC_USED static inline int vlc_##basename##suffix(type x) \
 645 { \
 646     return vlc_##basename##_generic(x); \
 647 }
 648 #endif
 649
 650 VLC_INT_FUNC(ctz)
 651 VLC_INT_FUNC(parity)
 652 VLC_INT_FUNC(popcount)
 653
 654 #ifndef __cplusplus
 655 # define VLC_INT_GENERIC(func,x) \
 656     _Generic((x), \
 657         unsigned char:      func(x), \
 658           signed char:      func(x), \
 659         unsigned short:     func(x), \
 660           signed short:     func(x), \
 661         unsigned int:       func(x), \
 662           signed int:       func(x), \
 663         unsigned long:      func##l(x), \
 664           signed long:      func##l(x), \
 665         unsigned long long: func##ll(x), \
 666           signed long long: func##ll(x))
 667
 668 /**
 669  * Count leading zeroes
 670  *
 671  * This function counts the number of consecutive zero (clear) bits
 672  * down from the highest order bit in an unsigned integer.
 673  *
 674  * \param x a non-zero integer
 675  * \note This macro assumes that CHAR_BIT equals 8.
 676  * \warning By definition, the result depends on the (width of the) type of x.
 677  * \return The number of leading zero bits in x.
 678  */
 679 # define clz(x) \
 680     _Generic((x), \
 681         unsigned char: (vlc_clz(x) - (sizeof (unsigned) - 1) * 8), \
 682         unsigned short: (vlc_clz(x) \
 683         - (sizeof (unsigned) - sizeof (unsigned short)) * 8), \
 684         unsigned: vlc_clz(x), \
 685         unsigned long: vlc_clzl(x), \
 686         unsigned long long: vlc_clzll(x))
 687
 688 /**
 689  * Count trailing zeroes
 690  *
 691  * This function counts the number of consecutive zero bits
 692  * up from the lowest order bit in an unsigned integer.
 693  *
 694  * \param x a non-zero integer
 695  * \note This function assumes that CHAR_BIT equals 8.
 696  * \return The number of trailing zero bits in x.
 697  */
 698 # define ctz(x) VLC_INT_GENERIC(vlc_ctz, x)
 699
 700 /**
 701  * Parity
 702  *
 703  * This function determines the parity of an integer.
 704  * \retval 0 if x has an even number of set bits.
 705  * \retval 1 if x has an odd number of set bits.
 706  */
 707 # define parity(x) VLC_INT_GENERIC(vlc_parity, x)
 708
 709 /**
 710  * Bit weight / population count
 711  *
 712  * This function counts the number of non-zero bits in an integer.
 713  *
 714  * \return The count of non-zero bits.
 715  */
 716 # define vlc_popcount(x) \
 717     _Generic((x), \
 718         signed char:  vlc_popcount((unsigned char)(x)), \
 719         signed short: vlc_popcount((unsigned short)(x)), \
 720         default: VLC_INT_GENERIC(vlc_popcount ,x))
 721 #else
 722 VLC_USED static inline int vlc_popcount(unsigned char x)
 723 {
 724     return vlc_popcount((unsigned)x);
 725 }
 726
 727 VLC_USED static inline int vlc_popcount(unsigned short x)
 728 {
 729     return vlc_popcount((unsigned)x);
 730 }
 731
 732 VLC_USED static inline int vlc_popcount(unsigned long x)
 733 {
 734     return vlc_popcountl(x);
 735 }
 736
 737 VLC_USED static inline int vlc_popcount(unsigned long long x)
 738 {
 739     return vlc_popcountll(x);
 740 }
 741 #endif
 742
 743 /** Byte swap (16 bits) */
 744 VLC_USED
 745 static inline uint16_t vlc_bswap16(uint16_t x)
 746 {
 747     return (x << 8) | (x >> 8);
 748 }
 749
 750 /** Byte swap (32 bits) */
 751 VLC_USED
 752 static inline uint32_t vlc_bswap32(uint32_t x)
 753 {
 754 #if defined (__GNUC__) || defined(__clang__)
 755     return __builtin_bswap32 (x);
 756 #else
 757     return ((x & 0x000000FF) << 24)
 758          | ((x & 0x0000FF00) <<  8)
 759          | ((x & 0x00FF0000) >>  8)
 760          | ((x & 0xFF000000) >> 24);
 761 #endif
 762 }
 763
 764 /** Byte swap (64 bits) */
 765 VLC_USED
 766 static inline uint64_t vlc_bswap64(uint64_t x)
 767 {
 768 #if defined (__GNUC__) || defined(__clang__)
 769     return __builtin_bswap64 (x);
 770 #elif !defined (__cplusplus)
 771     return ((x & 0x00000000000000FF) << 56)
 772          | ((x & 0x000000000000FF00) << 40)
 773          | ((x & 0x0000000000FF0000) << 24)
 774          | ((x & 0x00000000FF000000) <<  8)
 775          | ((x & 0x000000FF00000000) >>  8)
 776          | ((x & 0x0000FF0000000000) >> 24)
 777          | ((x & 0x00FF000000000000) >> 40)
 778          | ((x & 0xFF00000000000000) >> 56);
 779 #else
 780     return ((x & 0x00000000000000FFULL) << 56)
 781          | ((x & 0x000000000000FF00ULL) << 40)
 782          | ((x & 0x0000000000FF0000ULL) << 24)
 783          | ((x & 0x00000000FF000000ULL) <<  8)
 784          | ((x & 0x000000FF00000000ULL) >>  8)
 785          | ((x & 0x0000FF0000000000ULL) >> 24)
 786          | ((x & 0x00FF000000000000ULL) >> 40)
 787          | ((x & 0xFF00000000000000ULL) >> 56);
 788 #endif
 789 }
 790 /** @} */
 791
 792 /**
 793  * \defgroup overflow Overflowing arithmetic
 794  * @{
 795  */
 796 static inline bool uadd_overflow(unsigned a, unsigned b, unsigned *res)
 797 {
 798 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
 799      return __builtin_uadd_overflow(a, b, res);
 800 #else
 801      *res = a + b;
 802      return (a + b) < a;
 803 #endif
 804 }
 805
 806 static inline bool uaddl_overflow(unsigned long a, unsigned long b,
 807                                   unsigned long *res)
 808 {
 809 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
 810      return __builtin_uaddl_overflow(a, b, res);
 811 #else
 812      *res = a + b;
 813      return (a + b) < a;
 814 #endif
 815 }
 816
 817 static inline bool uaddll_overflow(unsigned long long a, unsigned long long b,
 818                                    unsigned long long *res)
 819 {
 820 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
 821      return __builtin_uaddll_overflow(a, b, res);
 822 #else
 823      *res = a + b;
 824      return (a + b) < a;
 825 #endif
 826 }
 827
 828 #ifndef __cplusplus
 829 /**
 830  * Overflowing addition
 831  *
 832  * Converts \p a and \p b to the type of \p *r.
 833  * Then computes the sum of both conversions while checking for overflow.
 834  * Finally stores the result in \p *r.
 835  *
 836  * \param a an integer
 837  * \param b an integer
 838  * \param r a pointer to an integer [OUT]
 839  * \retval false The sum did not overflow.
 840  * \retval true The sum overflowed.
 841  */
 842 # define add_overflow(a,b,r) \
 843     _Generic(*(r), \
 844         unsigned: uadd_overflow(a, b, (unsigned *)(r)), \
 845         unsigned long: uaddl_overflow(a, b, (unsigned long *)(r)), \
 846         unsigned long long: uaddll_overflow(a, b, (unsigned long long *)(r)))
 847 #else
 848 static inline bool add_overflow(unsigned a, unsigned b, unsigned *res)
 849 {
 850     return uadd_overflow(a, b, res);
 851 }
 852
 853 static inline bool add_overflow(unsigned long a, unsigned long b,
 854                                 unsigned long *res)
 855 {
 856     return uaddl_overflow(a, b, res);
 857 }
 858
 859 static inline bool add_overflow(unsigned long long a, unsigned long long b,
 860                                 unsigned long long *res)
 861 {
 862     return uaddll_overflow(a, b, res);
 863 }
 864 #endif
 865
 866 #if !(VLC_GCC_VERSION(5,0) || defined(__clang__))
 867 # include <limits.h>
 868 #endif
 869
 870 static inline bool umul_overflow(unsigned a, unsigned b, unsigned *res)
 871 {
 872 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
 873      return __builtin_umul_overflow(a, b, res);
 874 #else
 875      *res = a * b;
 876      return b > 0 && a > (UINT_MAX / b);
 877 #endif
 878 }
 879
 880 static inline bool umull_overflow(unsigned long a, unsigned long b,
 881                                   unsigned long *res)
 882 {
 883 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
 884      return __builtin_umull_overflow(a, b, res);
 885 #else
 886      *res = a * b;
 887      return b > 0 && a > (ULONG_MAX / b);
 888 #endif
 889 }
 890
 891 static inline bool umulll_overflow(unsigned long long a, unsigned long long b,
 892                                    unsigned long long *res)
 893 {
 894 #if VLC_GCC_VERSION(5,0) || defined(__clang__)
 895      return __builtin_umulll_overflow(a, b, res);
 896 #else
 897      *res = a * b;
 898      return b > 0 && a > (ULLONG_MAX / b);
 899 #endif
 900 }
 901
 902 #ifndef __cplusplus
 903 /**
 904  * Overflowing multiplication
 905  *
 906  * Converts \p a and \p b to the type of \p *r.
 907  * Then computes the product of both conversions while checking for overflow.
 908  * Finally stores the result in \p *r.
 909  *
 910  * \param a an integer
 911  * \param b an integer
 912  * \param r a pointer to an integer [OUT]
 913  * \retval false The product did not overflow.
 914  * \retval true The product overflowed.
 915  */
 916 #define mul_overflow(a,b,r) \
 917     _Generic(*(r), \
 918         unsigned: umul_overflow(a, b, (unsigned *)(r)), \
 919         unsigned long: umull_overflow(a, b, (unsigned long *)(r)), \
 920         unsigned long long: umulll_overflow(a, b, (unsigned long long *)(r)))
 921 #else
 922 static inline bool mul_overflow(unsigned a, unsigned b, unsigned *res)
 923 {
 924     return umul_overflow(a, b, res);
 925 }
 926
 927 static inline bool mul_overflow(unsigned long a, unsigned long b,
 928                                 unsigned long *res)
 929 {
 930     return umull_overflow(a, b, res);
 931 }
 932
 933 static inline bool mul_overflow(unsigned long long a, unsigned long long b,
 934                                 unsigned long long *res)
 935 {
 936     return umulll_overflow(a, b, res);
 937 }
 938 #endif
 939 /** @} */
 940 /** @} */
 941
 942 /* Free and set set the variable to NULL */
 943 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 944
 945 #define EMPTY_STR(str) (!str || !*str)
 946
 947 #include <vlc_arrays.h>
 948
 949 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 950  * MSB, and should be used for both network communications and files. */
 951
 952 #ifdef WORDS_BIGENDIAN
 953 # define hton16(i) ((uint16_t)(i))
 954 # define hton32(i) ((uint32_t)(i))
 955 # define hton64(i) ((uint64_t)(i))
 956 #else
 957 # define hton16(i) vlc_bswap16(i)
 958 # define hton32(i) vlc_bswap32(i)
 959 # define hton64(i) vlc_bswap64(i)
 960 #endif
 961 #define ntoh16(i) hton16(i)
 962 #define ntoh32(i) hton32(i)
 963 #define ntoh64(i) hton64(i)
 964
 965 /** Reads 16 bits in network byte order */
 966 VLC_USED
 967 static inline uint16_t U16_AT (const void *p)
 968 {
 969     uint16_t x;
 970
 971     memcpy (&x, p, sizeof (x));
 972     return ntoh16 (x);
 973 }
 974
 975 /** Reads 32 bits in network byte order */
 976 VLC_USED
 977 static inline uint32_t U32_AT (const void *p)
 978 {
 979     uint32_t x;
 980
 981     memcpy (&x, p, sizeof (x));
 982     return ntoh32 (x);
 983 }
 984
 985 /** Reads 64 bits in network byte order */
 986 VLC_USED
 987 static inline uint64_t U64_AT (const void *p)
 988 {
 989     uint64_t x;
 990
 991     memcpy (&x, p, sizeof (x));
 992     return ntoh64 (x);
 993 }
 994
 995 #define GetWBE(p)  U16_AT(p)
 996 #define GetDWBE(p) U32_AT(p)
 997 #define GetQWBE(p) U64_AT(p)
 998
 999 /** Reads 16 bits in little-endian order */
1000 VLC_USED
1001 static inline uint16_t GetWLE (const void *p)
1002 {
1003     uint16_t x;
1004
1005     memcpy (&x, p, sizeof (x));
1006 #ifdef WORDS_BIGENDIAN
1007     x = vlc_bswap16 (x);
1008 #endif
1009     return x;
1010 }
1011
1012 /** Reads 32 bits in little-endian order */
1013 VLC_USED
1014 static inline uint32_t GetDWLE (const void *p)
1015 {
1016     uint32_t x;
1017
1018     memcpy (&x, p, sizeof (x));
1019 #ifdef WORDS_BIGENDIAN
1020     x = vlc_bswap32 (x);
1021 #endif
1022     return x;
1023 }
1024
1025 /** Reads 64 bits in little-endian order */
1026 VLC_USED
1027 static inline uint64_t GetQWLE (const void *p)
1028 {
1029     uint64_t x;
1030
1031     memcpy (&x, p, sizeof (x));
1032 #ifdef WORDS_BIGENDIAN
1033     x = vlc_bswap64 (x);
1034 #endif
1035     return x;
1036 }
1037
1038 /** Writes 16 bits in network byte order */
1039 static inline void SetWBE (void *p, uint16_t w)
1040 {
1041     w = hton16 (w);
1042     memcpy (p, &w, sizeof (w));
1043 }
1044
1045 /** Writes 32 bits in network byte order */
1046 static inline void SetDWBE (void *p, uint32_t dw)
1047 {
1048     dw = hton32 (dw);
1049     memcpy (p, &dw, sizeof (dw));
1050 }
1051
1052 /** Writes 64 bits in network byte order */
1053 static inline void SetQWBE (void *p, uint64_t qw)
1054 {
1055     qw = hton64 (qw);
1056     memcpy (p, &qw, sizeof (qw));
1057 }
1058
1059 /** Writes 16 bits in little endian order */
1060 static inline void SetWLE (void *p, uint16_t w)
1061 {
1062 #ifdef WORDS_BIGENDIAN
1063     w = vlc_bswap16 (w);
1064 #endif
1065     memcpy (p, &w, sizeof (w));
1066 }
1067
1068 /** Writes 32 bits in little endian order */
1069 static inline void SetDWLE (void *p, uint32_t dw)
1070 {
1071 #ifdef WORDS_BIGENDIAN
1072     dw = vlc_bswap32 (dw);
1073 #endif
1074     memcpy (p, &dw, sizeof (dw));
1075 }
1076
1077 /** Writes 64 bits in little endian order */
1078 static inline void SetQWLE (void *p, uint64_t qw)
1079 {
1080 #ifdef WORDS_BIGENDIAN
1081     qw = vlc_bswap64 (qw);
1082 #endif
1083     memcpy (p, &qw, sizeof (qw));
1084 }
1085
1086 /* */
1087 #define VLC_UNUSED(x) (void)(x)
1088
1089 /* Stuff defined in src/extras/libc.c */
1090
1091 #if defined(_WIN32)
1092 /* several type definitions */
1093 #   if defined( __MINGW32__ )
1094 #       if !defined( _OFF_T_ )
1095             typedef long long _off_t;
1096             typedef _off_t off_t;
1097 #           define _OFF_T_
1098 #       else
1099 #           ifdef off_t
1100 #               undef off_t
1101 #           endif
1102 #           define off_t long long
1103 #       endif
1104 #   endif
1105
1106 #   ifndef O_NONBLOCK
1107 #       define O_NONBLOCK 0
1108 #   endif
1109
1110 /* the mingw32 swab() and win32 _swab() prototypes expect a char* instead of a
1111    const void* */
1112 #  define swab(a,b,c)  swab((char*) (a), (char*) (b), (c))
1113
1114 #endif /* _WIN32 */
1115
1116 typedef struct {
1117     unsigned num, den;
1118 } vlc_rational_t;
1119
1120 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
1121
1122 #define container_of(ptr, type, member) \
1123     ((type *)(((char *)(ptr)) - offsetof(type, member)))
1124
1125 VLC_USED VLC_MALLOC
1126 static inline void *vlc_alloc(size_t count, size_t size)
1127 {
1128     return mul_overflow(count, size, &size) ? NULL : malloc(size);
1129 }
1130
1131 VLC_USED
1132 static inline void *vlc_reallocarray(void *ptr, size_t count, size_t size)
1133 {
1134     return mul_overflow(count, size, &size) ? NULL : realloc(ptr, size);
1135 }
1136
1137 /*****************************************************************************
1138  * I18n stuff
1139  *****************************************************************************/
1140 VLC_API const char *vlc_gettext(const char *msgid) VLC_FORMAT_ARG(1);
1141 VLC_API const char *vlc_ngettext(const char *s, const char *p, unsigned long n)
1142 VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
1143
1144 #define vlc_pgettext( ctx, id ) \
1145         vlc_pgettext_aux( ctx "\004" id, id )
1146
1147 VLC_FORMAT_ARG(2)
1148 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
1149 {
1150     const char *tr = vlc_gettext( ctx );
1151     return (tr == ctx) ? id : tr;
1152 }
1153
1154 /*****************************************************************************
1155  * Loosy memory allocation functions. Do not use in new code.
1156  *****************************************************************************/
1157 static inline void *xmalloc(size_t len)
1158 {
1159     void *ptr = malloc(len);
1160     if (unlikely(ptr == NULL && len > 0))
1161         abort();
1162     return ptr;
1163 }
1164
1165 static inline void *xrealloc(void *ptr, size_t len)
1166 {
1167     void *nptr = realloc(ptr, len);
1168     if (unlikely(nptr == NULL && len > 0))
1169         abort();
1170     return nptr;
1171 }
1172
1173 static inline char *xstrdup (const char *str)
1174 {
1175     char *ptr = strdup (str);
1176     if (unlikely(ptr == NULL))
1177         abort ();
1178     return ptr;
1179 }
1180
1181 /*****************************************************************************
1182  * libvlc features
1183  *****************************************************************************/
1184 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
1185 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
1186 VLC_API const char * VLC_Compiler( void ) VLC_USED;
1187
1188 /*****************************************************************************
1189  * Additional vlc stuff
1190  *****************************************************************************/
1191 #include "vlc_messages.h"
1192 #include "vlc_objects.h"
1193 #include "vlc_variables.h"
1194 #include "vlc_configuration.h"
1195
1196 #if defined( _WIN32 ) || defined( __OS2__ )
1197 #   define DIR_SEP_CHAR '\\'
1198 #   define DIR_SEP "\\"
1199 #   define PATH_SEP_CHAR ';'
1200 #   define PATH_SEP ";"
1201 #else
1202 #   define DIR_SEP_CHAR '/'
1203 #   define DIR_SEP "/"
1204 #   define PATH_SEP_CHAR ':'
1205 #   define PATH_SEP ":"
1206 #endif
1207
1208 #define LICENSE_MSG \
1209   _("This program comes with NO WARRANTY, to the extent permitted by " \
1210     "law.\nYou may redistribute it under the terms of the GNU General " \
1211     "Public License;\nsee the file named COPYING for details.\n" \
1212     "Written by the VideoLAN team; see the AUTHORS file.\n")
1213
1214 #endif /* !VLC_COMMON_H */