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

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