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