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