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