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