include/vlc_common.h

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