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