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
 339 /* Update */
 340 typedef struct update_t update_t;
 341
 342 /**
 343  * VLC value structure
 344  */
 345 typedef union
 346 {
 347     int64_t         i_int;
 348     bool            b_bool;
 349     float           f_float;
 350     char *          psz_string;
 351     void *          p_address;
 352     vlc_object_t *  p_object;
 353     vlc_list_t *    p_list;
 354     mtime_t         i_time;
 355     struct { int32_t x; int32_t y; } coords;
 356
 357 } vlc_value_t;
 358
 359 /**
 360  * VLC list structure
 361  */
 362 struct vlc_list_t
 363 {
 364     int             i_count;
 365     vlc_value_t *   p_values;
 366     int *           pi_types;
 367
 368 };
 369
 370 /*****************************************************************************
 371  * Error values (shouldn't be exposed)
 372  *****************************************************************************/
 373 #define VLC_SUCCESS        (-0) /**< No error */
 374 #define VLC_EGENERIC       (-1) /**< Unspecified error */
 375 #define VLC_ENOMEM         (-2) /**< Not enough memory */
 376 #define VLC_ETIMEOUT       (-3) /**< Timeout */
 377 #define VLC_ENOMOD         (-4) /**< Module not found */
 378 #define VLC_ENOOBJ         (-5) /**< Object not found */
 379 #define VLC_ENOVAR         (-6) /**< Variable not found */
 380 #define VLC_EBADVAR        (-7) /**< Bad variable value */
 381 #define VLC_ENOITEM        (-8) /**< Item not found */
 382
 383 /*****************************************************************************
 384  * Variable callbacks
 385  *****************************************************************************/
 386 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 387                                    char const *,            /* variable name */
 388                                    vlc_value_t,                 /* old value */
 389                                    vlc_value_t,                 /* new value */
 390                                    void * );                /* callback data */
 391
 392 /*****************************************************************************
 393  * OS-specific headers and thread types
 394  *****************************************************************************/
 395 #if defined( _WIN32 )
 396 #   include <malloc.h>
 397 #   ifndef PATH_MAX
 398 #       define PATH_MAX MAX_PATH
 399 #   endif
 400 #   include <windows.h>
 401 #endif
 402
 403 #ifdef __SYMBIAN32__
 404  #include <sys/syslimits.h>
 405 #endif
 406
 407 #ifdef __OS2__
 408 #   define OS2EMX_PLAIN_CHAR
 409 #   define INCL_BASE
 410 #   define INCL_PM
 411 #   include <os2.h>
 412 #endif
 413
 414 #include "vlc_mtime.h"
 415 #include "vlc_threads.h"
 416
 417 /*****************************************************************************
 418  * Common structure members
 419  *****************************************************************************/
 420
 421 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 422 #define VLC_COMMON_MEMBERS                                                  \
 423 /** \name VLC_COMMON_MEMBERS                                                \
 424  * these members are common for all vlc objects                             \
 425  */                                                                         \
 426 /**@{*/                                                                     \
 427     const char *psz_object_type;                                            \
 428                                                                             \
 429     /* Messages header */                                                   \
 430     char *psz_header;                                                       \
 431     int  i_flags;                                                           \
 432                                                                             \
 433     /* Object properties */                                                 \
 434     bool b_force;      /**< set by the outside (eg. module_need()) */ \
 435                                                                             \
 436     /* Stuff related to the libvlc structure */                             \
 437     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 438                                                                             \
 439     vlc_object_t *  p_parent;                            /**< our parent */ \
 440                                                                             \
 441 /**@}*/                                                                     \
 442
 443 /* VLC_OBJECT: attempt at doing a clever cast */
 444 #if VLC_GCC_VERSION(4,0)
 445 # ifndef __cplusplus
 446 #  define VLC_OBJECT( x ) \
 447     __builtin_choose_expr( \
 448         __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
 449         (void)0 /* screw you */, \
 450         (vlc_object_t *)(x))
 451 # else
 452 #  define VLC_OBJECT( x ) \
 453     ((vlc_object_t *)(x) \
 454       + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
 455 # endif
 456 #else
 457 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
 458 #endif
 459
 460 /*****************************************************************************
 461  * Macros and inline functions
 462  *****************************************************************************/
 463
 464 /* CEIL: division with round to nearest greater integer */
 465 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 466
 467 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 468 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 469
 470 /* __MAX and __MIN: self explanatory */
 471 #ifndef __MAX
 472 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 473 #endif
 474 #ifndef __MIN
 475 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 476 #endif
 477
 478 /* clip v in [min, max] */
 479 #define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
 480
 481 VLC_USED
 482 static inline int64_t GCD ( int64_t a, int64_t b )
 483 {
 484     while( b )
 485     {
 486         int64_t c = a % b;
 487         a = b;
 488         b = c;
 489     }
 490     return a;
 491 }
 492
 493 /* function imported from libavutil/common.h */
 494 VLC_USED
 495 static inline uint8_t clip_uint8_vlc( int32_t a )
 496 {
 497     if( a&(~255) ) return (-a)>>31;
 498     else           return a;
 499 }
 500
 501 /** Count leading zeroes */
 502 VLC_USED
 503 static inline unsigned clz (unsigned x)
 504 {
 505 #if VLC_GCC_VERSION(3,4)
 506     return __builtin_clz (x);
 507 #else
 508     unsigned i = sizeof (x) * 8;
 509
 510     while (x)
 511     {
 512         x >>= 1;
 513         i--;
 514     }
 515     return i;
 516 #endif
 517 }
 518
 519 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
 520 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
 521 /* XXX: this assumes that int is 32-bits or more */
 522 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
 523
 524 /** Count trailing zeroes */
 525 VLC_USED
 526 static inline unsigned ctz (unsigned x)
 527 {
 528 #if VLC_GCC_VERSION(3,4)
 529     return __builtin_ctz (x);
 530 #else
 531     unsigned i = sizeof (x) * 8;
 532
 533     while (x)
 534     {
 535         x <<= 1;
 536         i--;
 537     }
 538     return i;
 539 #endif
 540 }
 541
 542 /** Bit weight */
 543 VLC_USED
 544 static inline unsigned popcount (unsigned x)
 545 {
 546 #if VLC_GCC_VERSION(3,4)
 547     return __builtin_popcount (x);
 548 #else
 549     unsigned count = 0;
 550     while (x)
 551     {
 552         count += x & 1;
 553         x = x >> 1;
 554     }
 555     return count;
 556 #endif
 557 }
 558
 559 VLC_USED
 560 static inline unsigned parity (unsigned x)
 561 {
 562 #if VLC_GCC_VERSION(3,4)
 563     return __builtin_parity (x);
 564 #else
 565     for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
 566         x ^= x >> i;
 567     return x & 1;
 568 #endif
 569 }
 570
 571 #ifdef __OS2__
 572 #   undef bswap16
 573 #   undef bswap32
 574 #   undef bswap64
 575 #endif
 576
 577 /** Byte swap (16 bits) */
 578 VLC_USED
 579 static inline uint16_t bswap16 (uint16_t x)
 580 {
 581     return (x << 8) | (x >> 8);
 582 }
 583
 584 /** Byte swap (32 bits) */
 585 VLC_USED
 586 static inline uint32_t bswap32 (uint32_t x)
 587 {
 588 #if VLC_GCC_VERSION(4,3) || defined(__clang__)
 589     return __builtin_bswap32 (x);
 590 #else
 591     return ((x & 0x000000FF) << 24)
 592          | ((x & 0x0000FF00) <<  8)
 593          | ((x & 0x00FF0000) >>  8)
 594          | ((x & 0xFF000000) >> 24);
 595 #endif
 596 }
 597
 598 /** Byte swap (64 bits) */
 599 VLC_USED
 600 static inline uint64_t bswap64 (uint64_t x)
 601 {
 602 #if VLC_GCC_VERSION(4,3) || defined(__clang__)
 603     return __builtin_bswap64 (x);
 604 #elif !defined (__cplusplus)
 605     return ((x & 0x00000000000000FF) << 56)
 606          | ((x & 0x000000000000FF00) << 40)
 607          | ((x & 0x0000000000FF0000) << 24)
 608          | ((x & 0x00000000FF000000) <<  8)
 609          | ((x & 0x000000FF00000000) >>  8)
 610          | ((x & 0x0000FF0000000000) >> 24)
 611          | ((x & 0x00FF000000000000) >> 40)
 612          | ((x & 0xFF00000000000000) >> 56);
 613 #else
 614     return ((x & 0x00000000000000FFULL) << 56)
 615          | ((x & 0x000000000000FF00ULL) << 40)
 616          | ((x & 0x0000000000FF0000ULL) << 24)
 617          | ((x & 0x00000000FF000000ULL) <<  8)
 618          | ((x & 0x000000FF00000000ULL) >>  8)
 619          | ((x & 0x0000FF0000000000ULL) >> 24)
 620          | ((x & 0x00FF000000000000ULL) >> 40)
 621          | ((x & 0xFF00000000000000ULL) >> 56);
 622 #endif
 623 }
 624
 625
 626 /* Free and set set the variable to NULL */
 627 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 628
 629 #define EMPTY_STR(str) (!str || !*str)
 630
 631 VLC_API char const * vlc_error( int ) VLC_USED;
 632
 633 #include <vlc_arrays.h>
 634
 635 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 636  * MSB, and should be used for both network communications and files. */
 637
 638 #ifdef WORDS_BIGENDIAN
 639 # define hton16(i) ((uint16_t)(i))
 640 # define hton32(i) ((uint32_t)(i))
 641 # define hton64(i) ((uint64_t)(i))
 642 #else
 643 # define hton16(i) bswap16(i)
 644 # define hton32(i) bswap32(i)
 645 # define hton64(i) bswap64(i)
 646 #endif
 647 #define ntoh16(i) hton16(i)
 648 #define ntoh32(i) hton32(i)
 649 #define ntoh64(i) hton64(i)
 650
 651 /** Reads 16 bits in network byte order */
 652 VLC_USED
 653 static inline uint16_t U16_AT (const void *p)
 654 {
 655     uint16_t x;
 656
 657     memcpy (&x, p, sizeof (x));
 658     return ntoh16 (x);
 659 }
 660
 661 /** Reads 32 bits in network byte order */
 662 VLC_USED
 663 static inline uint32_t U32_AT (const void *p)
 664 {
 665     uint32_t x;
 666
 667     memcpy (&x, p, sizeof (x));
 668     return ntoh32 (x);
 669 }
 670
 671 /** Reads 64 bits in network byte order */
 672 VLC_USED
 673 static inline uint64_t U64_AT (const void *p)
 674 {
 675     uint64_t x;
 676
 677     memcpy (&x, p, sizeof (x));
 678     return ntoh64 (x);
 679 }
 680
 681 #define GetWBE(p)  U16_AT(p)
 682 #define GetDWBE(p) U32_AT(p)
 683 #define GetQWBE(p) U64_AT(p)
 684
 685 /** Reads 16 bits in little-endian order */
 686 VLC_USED
 687 static inline uint16_t GetWLE (const void *p)
 688 {
 689     uint16_t x;
 690
 691     memcpy (&x, p, sizeof (x));
 692 #ifdef WORDS_BIGENDIAN
 693     x = bswap16 (x);
 694 #endif
 695     return x;
 696 }
 697
 698 /** Reads 32 bits in little-endian order */
 699 VLC_USED
 700 static inline uint32_t GetDWLE (const void *p)
 701 {
 702     uint32_t x;
 703
 704     memcpy (&x, p, sizeof (x));
 705 #ifdef WORDS_BIGENDIAN
 706     x = bswap32 (x);
 707 #endif
 708     return x;
 709 }
 710
 711 /** Reads 64 bits in little-endian order */
 712 VLC_USED
 713 static inline uint64_t GetQWLE (const void *p)
 714 {
 715     uint64_t x;
 716
 717     memcpy (&x, p, sizeof (x));
 718 #ifdef WORDS_BIGENDIAN
 719     x = bswap64 (x);
 720 #endif
 721     return x;
 722 }
 723
 724 /** Writes 16 bits in network byte order */
 725 static inline void SetWBE (void *p, uint16_t w)
 726 {
 727     w = hton16 (w);
 728     memcpy (p, &w, sizeof (w));
 729 }
 730
 731 /** Writes 32 bits in network byte order */
 732 static inline void SetDWBE (void *p, uint32_t dw)
 733 {
 734     dw = hton32 (dw);
 735     memcpy (p, &dw, sizeof (dw));
 736 }
 737
 738 /** Writes 64 bits in network byte order */
 739 static inline void SetQWBE (void *p, uint64_t qw)
 740 {
 741     qw = hton64 (qw);
 742     memcpy (p, &qw, sizeof (qw));
 743 }
 744
 745 /** Writes 16 bits in little endian order */
 746 static inline void SetWLE (void *p, uint16_t w)
 747 {
 748 #ifdef WORDS_BIGENDIAN
 749     w = bswap16 (w);
 750 #endif
 751     memcpy (p, &w, sizeof (w));
 752 }
 753
 754 /** Writes 32 bits in little endian order */
 755 static inline void SetDWLE (void *p, uint32_t dw)
 756 {
 757 #ifdef WORDS_BIGENDIAN
 758     dw = bswap32 (dw);
 759 #endif
 760     memcpy (p, &dw, sizeof (dw));
 761 }
 762
 763 /** Writes 64 bits in little endian order */
 764 static inline void SetQWLE (void *p, uint64_t qw)
 765 {
 766 #ifdef WORDS_BIGENDIAN
 767     qw = bswap64 (qw);
 768 #endif
 769     memcpy (p, &qw, sizeof (qw));
 770 }
 771
 772 /* */
 773 #define VLC_UNUSED(x) (void)(x)
 774
 775 /* Stuff defined in src/extras/libc.c */
 776
 777 #if defined(_WIN32)
 778 /* several type definitions */
 779 #   if defined( __MINGW32__ )
 780 #       if !defined( _OFF_T_ )
 781             typedef long long _off_t;
 782             typedef _off_t off_t;
 783 #           define _OFF_T_
 784 #       else
 785 #           ifdef off_t
 786 #               undef off_t
 787 #           endif
 788 #           define off_t long long
 789 #       endif
 790 #   endif
 791
 792 #   ifndef O_NONBLOCK
 793 #       define O_NONBLOCK 0
 794 #   endif
 795
 796 #   include <tchar.h>
 797 #endif /* _WIN32 */
 798
 799 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
 800
 801 /* Aligned memory allocator */
 802 #ifdef __APPLE__
 803 #include <AvailabilityMacros.h>
 804 #endif
 805
 806 #ifdef _WIN32
 807 # define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
 808 # define vlc_free(base)            (__mingw_aligned_free(base))
 809 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
 810 static inline void *vlc_memalign(size_t align, size_t size)
 811 {
 812     long diff;
 813     void *ptr;
 814
 815     ptr = malloc(size+align);
 816     if(!ptr)
 817         return ptr;
 818     diff = ((-(long)ptr - 1)&(align-1)) + 1;
 819     ptr  = (char*)ptr + diff;
 820     ((char*)ptr)[-1]= diff;
 821     return ptr;
 822 }
 823
 824 static void vlc_free(void *ptr)
 825 {
 826     if (ptr)
 827         free((char*)ptr - ((char*)ptr)[-1]);
 828 }
 829 #else
 830 static inline void *vlc_memalign(size_t align, size_t size)
 831 {
 832     void *base;
 833     if (unlikely(posix_memalign(&base, align, size)))
 834         base = NULL;
 835     return base;
 836 }
 837 # define vlc_free(base) free(base)
 838 #endif
 839
 840 VLC_API void vlc_tdestroy( void *, void (*)(void *) );
 841
 842 /*****************************************************************************
 843  * I18n stuff
 844  *****************************************************************************/
 845 VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
 846 VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
 847
 848 #define vlc_pgettext( ctx, id ) \
 849         vlc_pgettext_aux( ctx "\004" id, id )
 850
 851 VLC_FORMAT_ARG(2)
 852 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
 853 {
 854     const char *tr = vlc_gettext( ctx );
 855     return (tr == ctx) ? id : tr;
 856 }
 857
 858 /*****************************************************************************
 859  * Loosy memory allocation functions. Do not use in new code.
 860  *****************************************************************************/
 861 static inline void *xmalloc (size_t len)
 862 {
 863     void *ptr = malloc (len);
 864     if (unlikely (ptr == NULL))
 865         abort ();
 866     return ptr;
 867 }
 868
 869 static inline void *xrealloc (void *ptr, size_t len)
 870 {
 871     void *nptr = realloc (ptr, len);
 872     if (unlikely (nptr == NULL))
 873         abort ();
 874     return nptr;
 875 }
 876
 877 static inline void *xcalloc (size_t n, size_t size)
 878 {
 879     void *ptr = calloc (n, size);
 880     if (unlikely (ptr == NULL))
 881         abort ();
 882     return ptr;
 883 }
 884
 885 static inline char *xstrdup (const char *str)
 886 {
 887     char *ptr = strdup (str);
 888     if (unlikely(ptr == NULL))
 889         abort ();
 890     return ptr;
 891 }
 892
 893 /*****************************************************************************
 894  * libvlc features
 895  *****************************************************************************/
 896 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
 897 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
 898 VLC_API const char * VLC_Compiler( void ) VLC_USED;
 899
 900 /*****************************************************************************
 901  * Additional vlc stuff
 902  *****************************************************************************/
 903 #include "vlc_messages.h"
 904 #include "vlc_objects.h"
 905 #include "vlc_variables.h"
 906 #include "vlc_main.h"
 907 #include "vlc_configuration.h"
 908
 909 #if defined( _WIN32 ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
 910 #   define DIR_SEP_CHAR '\\'
 911 #   define DIR_SEP "\\"
 912 #   define PATH_SEP_CHAR ';'
 913 #   define PATH_SEP ";"
 914 #else
 915 #   define DIR_SEP_CHAR '/'
 916 #   define DIR_SEP "/"
 917 #   define PATH_SEP_CHAR ':'
 918 #   define PATH_SEP ":"
 919 #endif
 920
 921 #define LICENSE_MSG \
 922   _("This program comes with NO WARRANTY, to the extent permitted by " \
 923     "law.\nYou may redistribute it under the terms of the GNU General " \
 924     "Public License;\nsee the file named COPYING for details.\n" \
 925     "Written by the VideoLAN team; see the AUTHORS file.\n")
 926
 927 #endif /* !VLC_COMMON_H */