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