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