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 struct block_t aout_buffer_t;
 277 typedef audio_format_t audio_sample_format_t;
 278
 279 /* Video */
 280 typedef struct vout_thread_t vout_thread_t;
 281
 282 typedef video_format_t video_frame_format_t;
 283 typedef struct picture_t picture_t;
 284 typedef struct picture_sys_t picture_sys_t;
 285
 286 /* Subpictures */
 287 typedef struct spu_t spu_t;
 288 typedef struct subpicture_t subpicture_t;
 289 typedef struct subpicture_sys_t subpicture_sys_t;
 290 typedef struct subpicture_region_t subpicture_region_t;
 291
 292 typedef struct image_handler_t image_handler_t;
 293
 294 /* Stream output */
 295 typedef struct sout_instance_t sout_instance_t;
 296 typedef struct sout_instance_sys_t sout_instance_sys_t;
 297
 298 typedef struct sout_input_t sout_input_t;
 299 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 300
 301 typedef struct sout_access_out_t sout_access_out_t;
 302 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 303
 304 typedef struct sout_mux_t sout_mux_t;
 305 typedef struct sout_mux_sys_t sout_mux_sys_t;
 306
 307 typedef struct sout_stream_t    sout_stream_t;
 308 typedef struct sout_stream_sys_t sout_stream_sys_t;
 309
 310 typedef struct config_chain_t       config_chain_t;
 311 typedef struct session_descriptor_t session_descriptor_t;
 312
 313 /* Decoders */
 314 typedef struct decoder_t         decoder_t;
 315 typedef struct decoder_sys_t     decoder_sys_t;
 316 typedef struct decoder_synchro_t decoder_synchro_t;
 317
 318 /* Encoders */
 319 typedef struct encoder_t      encoder_t;
 320 typedef struct encoder_sys_t  encoder_sys_t;
 321
 322 /* Filters */
 323 typedef struct filter_t filter_t;
 324 typedef struct filter_sys_t filter_sys_t;
 325
 326 /* Network */
 327 typedef struct virtual_socket_t v_socket_t;
 328 typedef struct vlc_acl_t vlc_acl_t;
 329 typedef struct vlc_url_t vlc_url_t;
 330
 331 /* Misc */
 332 typedef struct iso639_lang_t iso639_lang_t;
 333
 334 /* block */
 335 typedef struct block_t      block_t;
 336 typedef struct block_fifo_t block_fifo_t;
 337
 338 /* httpd */
 339 typedef struct httpd_t          httpd_t;
 340 typedef struct httpd_host_t     httpd_host_t;
 341 typedef struct httpd_url_t      httpd_url_t;
 342 typedef struct httpd_client_t   httpd_client_t;
 343 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 344 typedef struct httpd_message_t  httpd_message_t;
 345 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
 346 typedef struct httpd_file_t     httpd_file_t;
 347 typedef struct httpd_file_sys_t httpd_file_sys_t;
 348 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 349 typedef struct httpd_handler_t  httpd_handler_t;
 350 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
 351 typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data );
 352 typedef struct httpd_redirect_t httpd_redirect_t;
 353 typedef struct httpd_stream_t httpd_stream_t;
 354
 355 /* Hashing */
 356 typedef struct md5_s md5_t;
 357
 358 /* XML */
 359 typedef struct xml_t xml_t;
 360 typedef struct xml_sys_t xml_sys_t;
 361 typedef struct xml_reader_t xml_reader_t;
 362 typedef struct xml_reader_sys_t xml_reader_sys_t;
 363
 364 /* vod server */
 365 typedef struct vod_t     vod_t;
 366 typedef struct vod_sys_t vod_sys_t;
 367 typedef struct vod_media_t vod_media_t;
 368
 369 /* osdmenu */
 370 typedef struct osd_menu_t   osd_menu_t;
 371 typedef struct osd_state_t  osd_state_t;
 372 typedef struct osd_event_t  osd_event_t;
 373 typedef struct osd_button_t osd_button_t;
 374 typedef struct osd_menu_state_t osd_menu_state_t;
 375
 376 /* VLM */
 377 typedef struct vlm_t         vlm_t;
 378 typedef struct vlm_message_t vlm_message_t;
 379
 380 /* misc */
 381 typedef struct vlc_meta_t    vlc_meta_t;
 382 typedef struct input_stats_t input_stats_t;
 383
 384 /* Update */
 385 typedef struct update_t update_t;
 386 typedef struct update_iterator_t update_iterator_t;
 387
 388 /* Meta engine */
 389 typedef struct meta_engine_t meta_engine_t;
 390
 391 /* stat/lstat/fstat */
 392 #ifdef WIN32
 393 # include <sys/stat.h>
 394
 395 # ifndef UNDER_CE
 396 struct _stati64;
 397 #  define stat _stati64
 398 #  define fstat _fstati64
 399 #endif
 400
 401 /* You should otherwise use vlc_stat and vlc_lstat. */
 402 #else
 403 struct stat;
 404 #endif
 405
 406 /**
 407  * VLC value structure
 408  */
 409 typedef union
 410 {
 411     int64_t         i_int;
 412     bool            b_bool;
 413     float           f_float;
 414     char *          psz_string;
 415     void *          p_address;
 416     vlc_object_t *  p_object;
 417     vlc_list_t *    p_list;
 418     mtime_t         i_time;
 419     struct { int32_t x; int32_t y; } coords;
 420
 421 } vlc_value_t;
 422
 423 /**
 424  * VLC list structure
 425  */
 426 struct vlc_list_t
 427 {
 428     int             i_count;
 429     vlc_value_t *   p_values;
 430     int *           pi_types;
 431
 432 };
 433
 434 /*****************************************************************************
 435  * Error values (shouldn't be exposed)
 436  *****************************************************************************/
 437 #define VLC_SUCCESS         -0                                   /* No error */
 438 #define VLC_ENOMEM          -1                          /* Not enough memory */
 439 #define VLC_ETIMEOUT        -3                                    /* Timeout */
 440
 441 #define VLC_ENOMOD         -10                           /* Module not found */
 442
 443 #define VLC_ENOOBJ         -20                           /* Object not found */
 444
 445 #define VLC_ENOVAR         -30                         /* Variable not found */
 446 #define VLC_EBADVAR        -31                         /* Bad variable value */
 447
 448 #define VLC_ENOITEM        -40                           /**< Item not found */
 449
 450 #define VLC_EEXIT         -255                             /* Program exited */
 451 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
 452 #define VLC_EGENERIC      -666                              /* Generic error */
 453
 454 /*****************************************************************************
 455  * Variable callbacks
 456  *****************************************************************************/
 457 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 458                                    char const *,            /* variable name */
 459                                    vlc_value_t,                 /* old value */
 460                                    vlc_value_t,                 /* new value */
 461                                    void * );                /* callback data */
 462
 463 /*****************************************************************************
 464  * OS-specific headers and thread types
 465  *****************************************************************************/
 466 #if defined( WIN32 ) || defined( UNDER_CE )
 467 /* WIN32_LEAN_AND_MEAN is needed to be able to include winsock2.h because else,
 468  * windows.h will also include winsock.h and declarations will conflict */
 469 # define WIN32_LEAN_AND_MEAN
 470 # include <windows.h>
 471 #endif
 472
 473 #ifdef __OS2__
 474 #   define OS2EMX_PLAIN_CHAR
 475 #   define INCL_BASE
 476 #   define INCL_PM
 477 #   include <os2.h>
 478 #endif
 479
 480 #include "vlc_mtime.h"
 481 #include "vlc_threads.h"
 482
 483 /**
 484  * Memory storage space for an atom. Never access it directly.
 485  */
 486 typedef union
 487 {
 488     volatile uintptr_t u;
 489     volatile intptr_t  s;
 490 } vlc_atomic_t;
 491
 492 /*****************************************************************************
 493  * Common structure members
 494  *****************************************************************************/
 495
 496 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 497 #define VLC_COMMON_MEMBERS                                                  \
 498 /** \name VLC_COMMON_MEMBERS                                                \
 499  * these members are common for all vlc objects                             \
 500  */                                                                         \
 501 /**@{*/                                                                     \
 502     const char *psz_object_type;                                            \
 503                                                                             \
 504     /* Messages header */                                                   \
 505     char *psz_header;                                                       \
 506     int  i_flags;                                                           \
 507                                                                             \
 508     /* Object properties */                                                 \
 509     volatile bool b_die;                   /**< set by the outside */ \
 510     bool b_force;      /**< set by the outside (eg. module_need()) */ \
 511                                                                             \
 512     /* Stuff related to the libvlc structure */                             \
 513     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 514                                                                             \
 515     vlc_object_t *  p_parent;                            /**< our parent */ \
 516                                                                             \
 517 /**@}*/                                                                     \
 518
 519 /* VLC_OBJECT: attempt at doing a clever cast */
 520 #if VLC_GCC_VERSION(4,0)
 521 # ifndef __cplusplus
 522 #  define VLC_OBJECT( x ) \
 523     __builtin_choose_expr( \
 524         __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
 525         (void)0 /* screw you */, \
 526         (vlc_object_t *)(x))
 527 # else
 528 #  define VLC_OBJECT( x ) \
 529     ((vlc_object_t *)(x) \
 530       + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
 531 # endif
 532 #else
 533 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
 534 #endif
 535
 536 typedef struct gc_object_t
 537 {
 538     vlc_atomic_t    refs;
 539     void          (*pf_destructor) (struct gc_object_t *);
 540 } gc_object_t;
 541
 542 /**
 543  * These members are common to all objects that wish to be garbage-collected.
 544  */
 545 #define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
 546
 547 VLC_API void * vlc_gc_init(gc_object_t *, void (*)(gc_object_t *));
 548 VLC_API void * vlc_hold(gc_object_t *);
 549 VLC_API void vlc_release(gc_object_t *);
 550
 551 #define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
 552 #define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
 553 #define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
 554 #define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
 555
 556 /*****************************************************************************
 557  * Macros and inline functions
 558  *****************************************************************************/
 559
 560 /* CEIL: division with round to nearest greater integer */
 561 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 562
 563 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 564 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 565
 566 /* __MAX and __MIN: self explanatory */
 567 #ifndef __MAX
 568 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 569 #endif
 570 #ifndef __MIN
 571 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 572 #endif
 573
 574 /* clip v in [min, max] */
 575 #define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
 576
 577 VLC_USED
 578 static inline int64_t GCD ( int64_t a, int64_t b )
 579 {
 580     while( b )
 581     {
 582         int64_t c = a % b;
 583         a = b;
 584         b = c;
 585     }
 586     return a;
 587 }
 588
 589 /* function imported from libavutil/common.h */
 590 VLC_USED
 591 static inline uint8_t clip_uint8_vlc( int32_t a )
 592 {
 593     if( a&(~255) ) return (-a)>>31;
 594     else           return a;
 595 }
 596
 597 /** Count leading zeroes */
 598 VLC_USED
 599 static inline unsigned clz (unsigned x)
 600 {
 601 #if VLC_GCC_VERSION(3,4)
 602     return __builtin_clz (x);
 603 #else
 604     unsigned i = sizeof (x) * 8;
 605
 606     while (x)
 607     {
 608         x = x >> 1;
 609         i--;
 610     }
 611     return i;
 612 #endif
 613 }
 614
 615 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
 616 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
 617 /* XXX: this assumes that int is 32-bits or more */
 618 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
 619
 620 /** Bit weight */
 621 VLC_USED
 622 static inline unsigned popcount (unsigned x)
 623 {
 624 #if VLC_GCC_VERSION(3,4)
 625     return __builtin_popcount (x);
 626 #else
 627     unsigned count = 0;
 628     while (x)
 629     {
 630         count += x & 1;
 631         x = x >> 1;
 632     }
 633     return count;
 634 #endif
 635 }
 636
 637 #ifdef __OS2__
 638 #   undef bswap16
 639 #   undef bswap32
 640 #   undef bswap64
 641 #endif
 642
 643 /** Byte swap (16 bits) */
 644 VLC_USED
 645 static inline uint16_t bswap16 (uint16_t x)
 646 {
 647     return (x << 8) | (x >> 8);
 648 }
 649
 650 /** Byte swap (32 bits) */
 651 VLC_USED
 652 static inline uint32_t bswap32 (uint32_t x)
 653 {
 654 #if VLC_GCC_VERSION(4,3)
 655     return __builtin_bswap32 (x);
 656 #else
 657     return ((x & 0x000000FF) << 24)
 658          | ((x & 0x0000FF00) <<  8)
 659          | ((x & 0x00FF0000) >>  8)
 660          | ((x & 0xFF000000) >> 24);
 661 #endif
 662 }
 663
 664 /** Byte swap (64 bits) */
 665 VLC_USED
 666 static inline uint64_t bswap64 (uint64_t x)
 667 {
 668 #if VLC_GCC_VERSION(4,3)
 669     return __builtin_bswap64 (x);
 670 #elif !defined (__cplusplus)
 671     return ((x & 0x00000000000000FF) << 56)
 672          | ((x & 0x000000000000FF00) << 40)
 673          | ((x & 0x0000000000FF0000) << 24)
 674          | ((x & 0x00000000FF000000) <<  8)
 675          | ((x & 0x000000FF00000000) >>  8)
 676          | ((x & 0x0000FF0000000000) >> 24)
 677          | ((x & 0x00FF000000000000) >> 40)
 678          | ((x & 0xFF00000000000000) >> 56);
 679 #else
 680     return ((x & 0x00000000000000FFLLU) << 56)
 681          | ((x & 0x000000000000FF00LLU) << 40)
 682          | ((x & 0x0000000000FF0000LLU) << 24)
 683          | ((x & 0x00000000FF000000LLU) <<  8)
 684          | ((x & 0x000000FF00000000LLU) >>  8)
 685          | ((x & 0x0000FF0000000000LLU) >> 24)
 686          | ((x & 0x00FF000000000000LLU) >> 40)
 687          | ((x & 0xFF00000000000000LLU) >> 56);
 688 #endif
 689 }
 690
 691
 692 /* Free and set set the variable to NULL */
 693 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 694
 695 #define EMPTY_STR(str) (!str || !*str)
 696
 697 VLC_API char const * vlc_error( int ) VLC_USED;
 698
 699 #include <vlc_arrays.h>
 700
 701 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 702  * MSB, and should be used for both network communications and files. */
 703
 704 #ifdef WORDS_BIGENDIAN
 705 # define hton16(i) ((uint16_t)(i))
 706 # define hton32(i) ((uint32_t)(i))
 707 # define hton64(i) ((uint64_t)(i))
 708 #else
 709 # define hton16(i) bswap16(i)
 710 # define hton32(i) bswap32(i)
 711 # define hton64(i) bswap64(i)
 712 #endif
 713 #define ntoh16(i) hton16(i)
 714 #define ntoh32(i) hton32(i)
 715 #define ntoh64(i) hton64(i)
 716
 717 /** Reads 16 bits in network byte order */
 718 VLC_USED
 719 static inline uint16_t U16_AT (const void *p)
 720 {
 721     uint16_t x;
 722
 723     memcpy (&x, p, sizeof (x));
 724     return ntoh16 (x);
 725 }
 726
 727 /** Reads 32 bits in network byte order */
 728 VLC_USED
 729 static inline uint32_t U32_AT (const void *p)
 730 {
 731     uint32_t x;
 732
 733     memcpy (&x, p, sizeof (x));
 734     return ntoh32 (x);
 735 }
 736
 737 /** Reads 64 bits in network byte order */
 738 VLC_USED
 739 static inline uint64_t U64_AT (const void *p)
 740 {
 741     uint64_t x;
 742
 743     memcpy (&x, p, sizeof (x));
 744     return ntoh64 (x);
 745 }
 746
 747 #define GetWBE(p)  U16_AT(p)
 748 #define GetDWBE(p) U32_AT(p)
 749 #define GetQWBE(p) U64_AT(p)
 750
 751 /** Reads 16 bits in little-endian order */
 752 VLC_USED
 753 static inline uint16_t GetWLE (const void *p)
 754 {
 755     uint16_t x;
 756
 757     memcpy (&x, p, sizeof (x));
 758 #ifdef WORDS_BIGENDIAN
 759     x = bswap16 (x);
 760 #endif
 761     return x;
 762 }
 763
 764 /** Reads 32 bits in little-endian order */
 765 VLC_USED
 766 static inline uint32_t GetDWLE (const void *p)
 767 {
 768     uint32_t x;
 769
 770     memcpy (&x, p, sizeof (x));
 771 #ifdef WORDS_BIGENDIAN
 772     x = bswap32 (x);
 773 #endif
 774     return x;
 775 }
 776
 777 /** Reads 64 bits in little-endian order */
 778 VLC_USED
 779 static inline uint64_t GetQWLE (const void *p)
 780 {
 781     uint64_t x;
 782
 783     memcpy (&x, p, sizeof (x));
 784 #ifdef WORDS_BIGENDIAN
 785     x = bswap64 (x);
 786 #endif
 787     return x;
 788 }
 789
 790 /** Writes 16 bits in network byte order */
 791 static inline void SetWBE (void *p, uint16_t w)
 792 {
 793     w = hton16 (w);
 794     memcpy (p, &w, sizeof (w));
 795 }
 796
 797 /** Writes 32 bits in network byte order */
 798 static inline void SetDWBE (void *p, uint32_t dw)
 799 {
 800     dw = hton32 (dw);
 801     memcpy (p, &dw, sizeof (dw));
 802 }
 803
 804 /** Writes 64 bits in network byte order */
 805 static inline void SetQWBE (void *p, uint64_t qw)
 806 {
 807     qw = hton64 (qw);
 808     memcpy (p, &qw, sizeof (qw));
 809 }
 810
 811 /** Writes 16 bits in little endian order */
 812 static inline void SetWLE (void *p, uint16_t w)
 813 {
 814 #ifdef WORDS_BIGENDIAN
 815     w = bswap16 (w);
 816 #endif
 817     memcpy (p, &w, sizeof (w));
 818 }
 819
 820 /** Writes 32 bits in little endian order */
 821 static inline void SetDWLE (void *p, uint32_t dw)
 822 {
 823 #ifdef WORDS_BIGENDIAN
 824     dw = bswap32 (dw);
 825 #endif
 826     memcpy (p, &dw, sizeof (dw));
 827 }
 828
 829 /** Writes 64 bits in little endian order */
 830 static inline void SetQWLE (void *p, uint64_t qw)
 831 {
 832 #ifdef WORDS_BIGENDIAN
 833     qw = bswap64 (qw);
 834 #endif
 835     memcpy (p, &qw, sizeof (qw));
 836 }
 837
 838 /* */
 839 #define VLC_UNUSED(x) (void)(x)
 840
 841 /* Stuff defined in src/extras/libc.c */
 842
 843 #if defined(WIN32) || defined(UNDER_CE)
 844 /* win32, cl and icl support */
 845 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 846 #       define __attribute__(x)
 847 #       define S_IFBLK         0x3000  /* Block */
 848 #       define S_ISBLK(m)      (0)
 849 #       define S_ISCHR(m)      (0)
 850 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 851 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 852 #   endif
 853
 854 /* several type definitions */
 855 #   if defined( __MINGW32__ )
 856 #       if !defined( _OFF_T_ )
 857             typedef long long _off_t;
 858             typedef _off_t off_t;
 859 #           define _OFF_T_
 860 #       else
 861 #           ifdef off_t
 862 #               undef off_t
 863 #           endif
 864 #           define off_t long long
 865 #       endif
 866 #   endif
 867
 868 #   if defined( _MSC_VER )
 869 #       if !defined( _OFF_T_DEFINED )
 870             typedef __int64 off_t;
 871 #           define _OFF_T_DEFINED
 872 #       else
 873             /* for wx compatibility typedef long off_t; */
 874 #           define off_t __int64
 875 #       endif
 876 #   endif
 877
 878 #   if defined( __BORLANDC__ )
 879 #       undef off_t
 880 #       define off_t unsigned __int64
 881 #   endif
 882
 883 #   ifndef O_NONBLOCK
 884 #       define O_NONBLOCK 0
 885 #   endif
 886
 887 #   ifndef alloca
 888 #       define alloca _alloca
 889 #   endif
 890
 891 #   include <tchar.h>
 892 #endif
 893
 894 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
 895
 896 /* Aligned memory allocator */
 897 #ifdef __APPLE__
 898 #include <AvailabilityMacros.h>
 899 #endif
 900
 901 #ifdef WIN32
 902 # include <malloc.h>
 903 # define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
 904 # define vlc_free(base)            (__mingw_aligned_free(base))
 905 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
 906 static inline void *vlc_memalign(size_t align, size_t size)
 907 {
 908     long diff;
 909     void *ptr;
 910
 911     ptr = malloc(size+align);
 912     if(!ptr)
 913         return ptr;
 914     diff = ((-(long)ptr - 1)&(align-1)) + 1;
 915     ptr  = (char*)ptr + diff;
 916     ((char*)ptr)[-1]= diff;
 917     return ptr;
 918 }
 919
 920 static void vlc_free(void *ptr)
 921 {
 922     if (ptr)
 923         free((char*)ptr - ((char*)ptr)[-1]);
 924 }
 925 #elif defined(__ANDROID__)
 926 # define vlc_memalign(align, size) memalign(align, size)
 927 # define vlc_free(base) free(base)
 928 #else
 929 static inline void *vlc_memalign(size_t align, size_t size)
 930 {
 931     void *base;
 932     if (unlikely(posix_memalign(&base, align, size)))
 933         base = NULL;
 934     return base;
 935 }
 936 # define vlc_free(base) free(base)
 937 #endif
 938
 939 VLC_API void vlc_tdestroy( void *, void (*)(void *) );
 940
 941 /* Fast large memory copy and memory set */
 942 VLC_API void * vlc_memcpy( void *, const void *, size_t );
 943 #define vlc_memset memset
 944
 945 /*****************************************************************************
 946  * I18n stuff
 947  *****************************************************************************/
 948 VLC_API char * vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
 949
 950 #define vlc_pgettext( ctx, id ) \
 951         vlc_pgettext_aux( ctx "\004" id, id )
 952
 953 VLC_FORMAT_ARG(2)
 954 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
 955 {
 956     const char *tr = vlc_gettext( ctx );
 957     return (tr == ctx) ? id : tr;
 958 }
 959
 960 /*****************************************************************************
 961  * Loosy memory allocation functions. Do not use in new code.
 962  *****************************************************************************/
 963 static inline void *xmalloc (size_t len)
 964 {
 965     void *ptr = malloc (len);
 966     if (unlikely (ptr == NULL))
 967         abort ();
 968     return ptr;
 969 }
 970
 971 static inline void *xrealloc (void *ptr, size_t len)
 972 {
 973     void *nptr = realloc (ptr, len);
 974     if (unlikely (nptr == NULL))
 975         abort ();
 976     return nptr;
 977 }
 978
 979 static inline void *xcalloc (size_t n, size_t size)
 980 {
 981     void *ptr = calloc (n, size);
 982     if (unlikely (ptr == NULL))
 983         abort ();
 984     return ptr;
 985 }
 986
 987 /*****************************************************************************
 988  * libvlc features
 989  *****************************************************************************/
 990 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
 991 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
 992 VLC_API const char * VLC_Compiler( void ) VLC_USED;
 993
 994 /*****************************************************************************
 995  * Additional vlc stuff
 996  *****************************************************************************/
 997 #include "vlc_messages.h"
 998 #include "vlc_objects.h"
 999 #include "vlc_variables.h"
1000 #include "vlc_main.h"
1001 #include "vlc_configuration.h"
1002
1003 #if defined( WIN32 ) || defined( UNDER_CE ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
1004 #   define DIR_SEP_CHAR '\\'
1005 #   define DIR_SEP "\\"
1006 #   define PATH_SEP_CHAR ';'
1007 #   define PATH_SEP ";"
1008 #else
1009 #   define DIR_SEP_CHAR '/'
1010 #   define DIR_SEP "/"
1011 #   define PATH_SEP_CHAR ':'
1012 #   define PATH_SEP ":"
1013 #endif
1014
1015 #define LICENSE_MSG \
1016   _("This program comes with NO WARRANTY, to the extent permitted by " \
1017     "law.\nYou may redistribute it under the terms of the GNU General " \
1018     "Public License;\nsee the file named COPYING for details.\n" \
1019     "Written by the VideoLAN team; see the AUTHORS file.\n")
1020
1021 #endif /* !VLC_COMMON_H */