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