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