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