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

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