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