git.sesse.net Git - vlc/blob - include/vlc_common.h

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