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