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 /*****************************************************************************
  33  * Required vlc headers
  34  *****************************************************************************/
  35 #if defined( _MSC_VER )
  36 #   pragma warning( disable : 4244 )
  37 #endif
  38
  39 #include "vlc_config.h"
  40
  41 /*****************************************************************************
  42  * Required system headers
  43  *****************************************************************************/
  44 #include <stdlib.h>
  45 #include <stdarg.h>
  46
  47 #include <string.h>
  48 #include <stdio.h>
  49
  50 #ifdef HAVE_SYS_TYPES_H
  51 #   include <sys/types.h>
  52 #endif
  53
  54 /*****************************************************************************
  55  * Basic types definitions
  56  *****************************************************************************/
  57 #if defined( HAVE_INTTYPES_H )
  58 #   include <inttypes.h>
  59 #elif defined( SYS_CYGWIN )
  60     /* Cygwin only defines half of these... */
  61     typedef u_int8_t            uint8_t;
  62     typedef u_int16_t           uint16_t;
  63     typedef u_int32_t           uint32_t;
  64     typedef u_int64_t           uint64_t;
  65 #else
  66     /* Fallback types (very x86-centric, sorry) */
  67     typedef unsigned char       uint8_t;
  68     typedef signed char         int8_t;
  69     typedef unsigned short      uint16_t;
  70     typedef signed short        int16_t;
  71     typedef unsigned int        uint32_t;
  72     typedef signed int          int32_t;
  73 #   if defined( _MSC_VER ) \
  74       || defined( UNDER_CE ) \
  75       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
  76     typedef unsigned __int64    uint64_t;
  77     typedef signed __int64      int64_t;
  78 #   else
  79     typedef unsigned long long  uint64_t;
  80     typedef signed long long    int64_t;
  81 #   endif
  82     typedef uint32_t            uintptr_t;
  83     typedef int32_t             intptr_t;
  84 #endif
  85
  86 /* Systems that don't have stdint.h may not define INT64_MIN and
  87    INT64_MAX */
  88 #ifndef INT64_MIN
  89 #define INT64_MIN (-9223372036854775807LL-1)
  90 #endif
  91 #ifndef INT64_MAX
  92 #define INT64_MAX (9223372036854775807LL)
  93 #endif
  94
  95 #if defined( WIN32 ) || defined( UNDER_CE )
  96 #   include <malloc.h>
  97 #   ifndef PATH_MAX
  98 #       define PATH_MAX MAX_PATH
  99 #   endif
 100 #endif
 101
 102 /* Counter for statistics and profiling */
 103 typedef unsigned long       count_t;
 104
 105 /* DCT elements types */
 106 typedef int16_t             dctelem_t;
 107
 108 /* Video buffer types */
 109 typedef uint8_t             yuv_data_t;
 110
 111 /* Audio volume */
 112 typedef uint16_t            audio_volume_t;
 113
 114 /**
 115  * High precision date or time interval
 116  *
 117  * Store a high precision date or time interval. The maximum precision is the
 118  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
 119  * time interval is then 292271 years, which should be long enough for any
 120  * video). Dates are stored as microseconds since a common date (usually the
 121  * epoch). Note that date and time intervals can be manipulated using regular
 122  * arithmetic operators, and that no special functions are required.
 123  */
 124 typedef int64_t mtime_t;
 125
 126 /**
 127  * The vlc_fourcc_t type.
 128  *
 129  * See http://www.webartz.com/fourcc/ for a very detailed list.
 130  */
 131 typedef uint32_t vlc_fourcc_t;
 132
 133 #ifdef WORDS_BIGENDIAN
 134 #   define VLC_FOURCC( a, b, c, d ) \
 135         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 136            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 137 #   define VLC_TWOCC( a, b ) \
 138         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 139
 140 #else
 141 #   define VLC_FOURCC( a, b, c, d ) \
 142         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 143            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 144 #   define VLC_TWOCC( a, b ) \
 145         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 146
 147 #endif
 148
 149 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
 150 {
 151     memcpy( psz_fourcc, &fcc, 4 );
 152 }
 153
 154 #define vlc_fourcc_to_char( a, b ) \
 155     __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
 156
 157 /*****************************************************************************
 158  * Classes declaration
 159  *****************************************************************************/
 160
 161 /* Internal types */
 162 typedef struct libvlc_global_data_t libvlc_global_data_t;
 163 typedef struct libvlc_int_t libvlc_int_t;
 164 typedef struct variable_t variable_t;
 165 typedef struct date_t date_t;
 166 typedef struct dict_entry_t dict_entry_t;
 167 typedef struct dict_t dict_t;
 168 typedef struct gc_object_t gc_object_t ;
 169
 170 /* Messages */
 171 typedef struct msg_bank_t msg_bank_t;
 172 typedef struct msg_queue_t msg_queue_t;
 173 typedef struct msg_subscription_t msg_subscription_t;
 174
 175 /* Playlist */
 176
 177 /* FIXME */
 178 /**
 179  * Playlist commands
 180  */
 181 typedef enum {
 182     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
 183     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
 184                         /**  arg2 = playlist_item_t*          , res=can fail */
 185     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
 186     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
 187     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
 188 } playlist_command_t;
 189
 190
 191 typedef struct playlist_t playlist_t;
 192 typedef struct playlist_item_t playlist_item_t;
 193 typedef struct playlist_view_t playlist_view_t;
 194 typedef struct playlist_export_t playlist_export_t;
 195 typedef struct services_discovery_t services_discovery_t;
 196 typedef struct services_discovery_sys_t services_discovery_sys_t;
 197 typedef struct playlist_add_t playlist_add_t;
 198 typedef struct playlist_preparse_t playlist_preparse_t;
 199 typedef struct playlist_fetcher_t playlist_fetcher_t;
 200
 201 /* Modules */
 202 typedef struct module_bank_t module_bank_t;
 203 typedef struct module_t module_t;
 204 typedef struct module_config_t module_config_t;
 205 typedef struct module_symbols_t module_symbols_t;
 206 typedef struct module_cache_t module_cache_t;
 207
 208 typedef struct config_category_t config_category_t;
 209
 210 /* Interface */
 211 typedef struct intf_thread_t intf_thread_t;
 212 typedef struct intf_sys_t intf_sys_t;
 213 typedef struct intf_console_t intf_console_t;
 214 typedef struct intf_msg_t intf_msg_t;
 215 typedef struct interaction_t interaction_t;
 216 typedef struct interaction_dialog_t interaction_dialog_t;
 217 typedef struct user_widget_t user_widget_t;
 218
 219 /* Input */
 220 typedef struct input_thread_t input_thread_t;
 221 typedef struct input_thread_sys_t input_thread_sys_t;
 222 typedef struct input_item_t input_item_t;
 223 typedef struct access_t access_t;
 224 typedef struct access_sys_t access_sys_t;
 225 typedef struct stream_t     stream_t;
 226 typedef struct stream_sys_t stream_sys_t;
 227 typedef struct demux_t  demux_t;
 228 typedef struct demux_meta_t demux_meta_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 es_descriptor_t es_descriptor_t;
 234 typedef struct seekpoint_t seekpoint_t;
 235 typedef struct info_t info_t;
 236 typedef struct info_category_t info_category_t;
 237 typedef struct input_attachment_t input_attachment_t;
 238
 239 /* Format */
 240 typedef struct audio_format_t audio_format_t;
 241 typedef struct video_format_t video_format_t;
 242 typedef struct subs_format_t subs_format_t;
 243 typedef struct es_format_t es_format_t;
 244 typedef struct video_palette_t video_palette_t;
 245
 246 /* Audio */
 247 typedef struct aout_instance_t aout_instance_t;
 248 typedef struct aout_sys_t aout_sys_t;
 249 typedef struct aout_fifo_t aout_fifo_t;
 250 typedef struct aout_input_t aout_input_t;
 251 typedef struct aout_buffer_t aout_buffer_t;
 252 typedef audio_format_t audio_sample_format_t;
 253 typedef struct audio_date_t audio_date_t;
 254 typedef struct aout_filter_t aout_filter_t;
 255
 256 /* Video */
 257 typedef struct vout_thread_t vout_thread_t;
 258 typedef struct vout_sys_t vout_sys_t;
 259 typedef struct chroma_sys_t chroma_sys_t;
 260
 261 typedef video_format_t video_frame_format_t;
 262 typedef struct picture_t picture_t;
 263 typedef struct picture_sys_t picture_sys_t;
 264 typedef struct picture_heap_t picture_heap_t;
 265
 266 /* Subpictures */
 267 typedef struct spu_t spu_t;
 268 typedef struct subpicture_t subpicture_t;
 269 typedef struct subpicture_sys_t subpicture_sys_t;
 270 typedef struct subpicture_region_t subpicture_region_t;
 271 typedef struct text_style_t text_style_t;
 272
 273 typedef struct image_handler_t image_handler_t;
 274
 275 /* Stream output */
 276 typedef struct sout_instance_t sout_instance_t;
 277 typedef struct sout_instance_sys_t sout_instance_sys_t;
 278
 279 typedef struct sout_input_t sout_input_t;
 280 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 281
 282 typedef struct sout_access_out_t sout_access_out_t;
 283 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 284
 285 typedef struct sout_mux_t sout_mux_t;
 286 typedef struct sout_mux_sys_t sout_mux_sys_t;
 287
 288 typedef struct sout_stream_t    sout_stream_t;
 289 typedef struct sout_stream_sys_t sout_stream_sys_t;
 290
 291 typedef struct config_chain_t       config_chain_t;
 292 typedef struct sap_session_t    sap_session_t;
 293 typedef struct sap_address_t sap_address_t;
 294 typedef struct session_descriptor_t session_descriptor_t;
 295 typedef struct announce_method_t announce_method_t;
 296 typedef struct announce_handler_t announce_handler_t;
 297 typedef struct sap_handler_t sap_handler_t;
 298
 299 typedef struct sout_param_t sout_param_t;
 300 typedef struct sout_pcat_t sout_pcat_t;
 301 typedef struct sout_std_t sout_std_t;
 302 typedef struct sout_display_t sout_display_t;
 303 typedef struct sout_duplicate_t sout_duplicate_t;
 304 typedef struct sout_transcode_t sout_transcode_t;
 305 typedef struct sout_chain_t sout_chain_t;
 306 typedef struct streaming_profile_t streaming_profile_t;
 307 typedef struct sout_module_t sout_module_t;
 308 typedef struct sout_gui_descr_t sout_gui_descr_t;
 309 typedef struct profile_parser_t profile_parser_t;
 310
 311 /* Decoders */
 312 typedef struct decoder_t         decoder_t;
 313 typedef struct decoder_sys_t     decoder_sys_t;
 314 typedef struct decoder_synchro_t decoder_synchro_t;
 315
 316 /* Encoders */
 317 typedef struct encoder_t      encoder_t;
 318 typedef struct encoder_sys_t  encoder_sys_t;
 319
 320 /* Filters */
 321 typedef struct filter_t filter_t;
 322 typedef struct filter_sys_t filter_sys_t;
 323
 324 /* Network */
 325 typedef struct network_socket_t network_socket_t;
 326 typedef struct virtual_socket_t v_socket_t;
 327 typedef struct sockaddr sockaddr;
 328 typedef struct addrinfo addrinfo;
 329 typedef struct vlc_acl_t vlc_acl_t;
 330 typedef struct vlc_url_t vlc_url_t;
 331
 332 /* Misc */
 333 typedef struct iso639_lang_t iso639_lang_t;
 334 typedef struct device_t device_t;
 335 typedef struct device_probe_t device_probe_t;
 336 typedef struct probe_sys_t probe_sys_t;
 337
 338 /* block */
 339 typedef struct block_t      block_t;
 340 typedef struct block_fifo_t block_fifo_t;
 341
 342 /* httpd */
 343 typedef struct httpd_t          httpd_t;
 344 typedef struct httpd_host_t     httpd_host_t;
 345 typedef struct httpd_url_t      httpd_url_t;
 346 typedef struct httpd_client_t   httpd_client_t;
 347 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 348 typedef struct httpd_message_t  httpd_message_t;
 349 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
 350 typedef struct httpd_file_t     httpd_file_t;
 351 typedef struct httpd_file_sys_t httpd_file_sys_t;
 352 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 353 typedef struct httpd_handler_t  httpd_handler_t;
 354 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
 355 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 );
 356 typedef struct httpd_redirect_t httpd_redirect_t;
 357 typedef struct httpd_stream_t httpd_stream_t;
 358
 359 /* TLS support */
 360 typedef struct tls_server_t tls_server_t;
 361 typedef struct tls_session_t tls_session_t;
 362
 363 /* Hashing */
 364 typedef struct md5_s md5_t;
 365
 366 /* XML */
 367 typedef struct xml_t xml_t;
 368 typedef struct xml_sys_t xml_sys_t;
 369 typedef struct xml_reader_t xml_reader_t;
 370 typedef struct xml_reader_sys_t xml_reader_sys_t;
 371
 372 /* vod server */
 373 typedef struct vod_t     vod_t;
 374 typedef struct vod_sys_t vod_sys_t;
 375 typedef struct vod_media_t vod_media_t;
 376
 377 /* opengl */
 378 typedef struct opengl_t     opengl_t;
 379 typedef struct opengl_sys_t opengl_sys_t;
 380
 381 /* osdmenu */
 382 typedef struct osd_menu_t   osd_menu_t;
 383 typedef struct osd_state_t  osd_state_t;
 384 typedef struct osd_event_t  osd_event_t;
 385 typedef struct osd_button_t osd_button_t;
 386 typedef struct osd_menu_state_t osd_menu_state_t;
 387
 388 /* VLM */
 389 typedef struct vlm_t         vlm_t;
 390 typedef struct vlm_message_t vlm_message_t;
 391
 392 /* divers */
 393 typedef struct vlc_meta_t    vlc_meta_t;
 394 typedef struct meta_export_t meta_export_t;
 395
 396 /* Stats */
 397 typedef struct counter_t     counter_t;
 398 typedef struct counter_sample_t counter_sample_t;
 399 typedef struct stats_handler_t stats_handler_t;
 400 typedef struct input_stats_t input_stats_t;
 401 typedef struct global_stats_t global_stats_t;
 402
 403 /* Update */
 404 typedef struct update_t update_t;
 405 typedef struct update_iterator_t update_iterator_t;
 406
 407 /* Meta engine */
 408 typedef struct meta_engine_t meta_engine_t;
 409
 410 /* stat/lstat/fstat */
 411 #ifdef WIN32
 412 #include <sys/stat.h>
 413 struct _stati64;
 414 #define stat _stati64
 415 #define fstat _fstati64
 416 /* You should otherwise use utf8_stat and utf8_lstat. */
 417 #else
 418 struct stat;
 419 #endif
 420
 421 /*****************************************************************************
 422  * Variable callbacks
 423  *****************************************************************************/
 424 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 425                                    char const *,            /* variable name */
 426                                    vlc_value_t,                 /* old value */
 427                                    vlc_value_t,                 /* new value */
 428                                    void * );                /* callback data */
 429
 430 /*****************************************************************************
 431  * Plug-in stuff
 432  *****************************************************************************/
 433
 434 #include "vlc_modules_macros.h"
 435
 436 #if defined (WIN32) && defined (DLL_EXPORT)
 437 #  ifdef __cplusplus
 438 #    define VLC_PUBLIC_API extern "C" __declspec(dllexport)
 439 #    define VLC_PRIVATE_API extern "C" __declspec(dllexport)
 440 #    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
 441 #    define VLC_INTERNAL( type, name, args ) extern "C" type name args
 442 #  else
 443 #    define VLC_PUBLIC_API extern __declspec(dllexport)
 444 #    define VLC_PRIVATE_API extern __declspec(dllexport)
 445 #    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
 446 #    define VLC_INTERNAL( type, name, args ) type name args
 447 #  endif
 448 #else
 449 #  ifdef __cplusplus
 450 #    ifdef HAVE_ATTRIBUTE_VISIBILITY
 451 #      define VLC_PUBLIC_API extern "C" __attribute__((visibility("default")))
 452 #      define VLC_PRIVATE_API extern "C" __attribute__((visibility("default")))
 453 #      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
 454 #      define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
 455 #    else
 456 #      define VLC_PUBLIC_API extern "C"
 457 #      define   VLC_EXPORT( type, name, args ) extern "C" type name args
 458 #      define VLC_INTERNAL( type, name, args ) extern "C" type name args
 459 #    endif
 460 #  else
 461 #    ifdef HAVE_ATTRIBUTE_VISIBILITY
 462 #      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
 463 #      define VLC_PRIVATE_API extern __attribute__((visibility("default")))
 464 #      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
 465 #      define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
 466 #    else
 467 #      define VLC_PUBLIC_API extern
 468 #      define VLC_PRIVATE_API extern
 469 #      define   VLC_EXPORT( type, name, args ) extern type name args
 470 #      define VLC_INTERNAL( type, name, args ) type name args
 471 #    endif
 472 #  endif
 473 #endif
 474
 475 /*****************************************************************************
 476  * OS-specific headers and thread types
 477  *****************************************************************************/
 478 #if defined( WIN32 ) || defined( UNDER_CE )
 479 #   define WIN32_LEAN_AND_MEAN
 480 #   include <windows.h>
 481 #   if defined( UNDER_CE )
 482 #      define IS_WINNT 0
 483 #   else
 484 #      define IS_WINNT ( GetVersion() < 0x80000000 )
 485 #   endif
 486 #endif
 487
 488 #include "vlc_threads.h"
 489
 490 typedef struct vlc_object_internals_t vlc_object_internals_t;
 491
 492 /*****************************************************************************
 493  * Common structure members
 494  *****************************************************************************/
 495
 496 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 497 #define VLC_COMMON_MEMBERS                                                  \
 498 /** \name VLC_COMMON_MEMBERS                                                \
 499  * these members are common for all vlc objects                             \
 500  */                                                                         \
 501 /**@{*/                                                                     \
 502     vlc_object_internals_t *p_internals;                                    \
 503     int   i_object_id;                                                      \
 504     int   i_object_type;                                                    \
 505     const char *psz_object_type;                                            \
 506     char *psz_object_name;                                                  \
 507                                                                             \
 508     /* Messages header */                                                   \
 509     char *psz_header;                                                       \
 510     int  i_flags;                                                           \
 511                                                                             \
 512     /* Object access lock */                                                \
 513     vlc_mutex_t  object_lock;                                               \
 514     vlc_cond_t   object_wait;                                               \
 515                                                                             \
 516     /* Object properties */                                                 \
 517     volatile bool b_error;                  /**< set by the object */ \
 518     volatile bool b_die;                   /**< set by the outside */ \
 519     volatile bool b_dead;                   /**< set by the object */ \
 520     bool b_force;      /**< set by the outside (eg. module_Need()) */ \
 521                                                                             \
 522     /* Stuff related to the libvlc structure */                             \
 523     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 524                                                                             \
 525     vlc_object_t *  p_parent;                            /**< our parent */ \
 526     vlc_object_t ** pp_children;                       /**< our children */ \
 527     volatile int    i_children;                                             \
 528                                                                             \
 529     /* Private data */                                                      \
 530     void *          p_private;                                              \
 531                                                                             \
 532     /** Just a reminder so that people don't cast garbage */                \
 533     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
 534 /**@}*/                                                                     \
 535
 536 /* VLC_OBJECT: attempt at doing a clever cast */
 537 #define VLC_OBJECT( x ) \
 538     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 539
 540 #define VLC_GC_MEMBERS                                                       \
 541 /** \name VLC_GC_MEMBERS                                                     \
 542  * these members are common to all objects that wish to be garbage-collected \
 543  */                                                                          \
 544 /**@{*/                                                                      \
 545     int i_gc_refcount;                                                       \
 546     void (*pf_destructor) ( gc_object_t * );                                 \
 547     void *p_destructor_arg;                                                  \
 548 /**@}*/
 549
 550 struct gc_object_t
 551 {
 552             VLC_GC_MEMBERS
 553 };
 554
 555 static inline void __vlc_gc_incref( gc_object_t * p_gc )
 556 {
 557     p_gc->i_gc_refcount ++;
 558 };
 559
 560 static inline void __vlc_gc_decref( gc_object_t *p_gc )
 561 {
 562     if( !p_gc ) return;
 563
 564     p_gc->i_gc_refcount -- ;
 565
 566     if( p_gc->i_gc_refcount == 0 )
 567     {
 568         p_gc->pf_destructor( p_gc );
 569         /* Do not use the p_gc pointer from now on ! */
 570     }
 571 }
 572
 573 static inline void
 574 __vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
 575                void * arg)
 576 {
 577     p_gc->i_gc_refcount = 1;
 578     p_gc->pf_destructor = pf_destructor;
 579     p_gc->p_destructor_arg = arg;
 580 }
 581
 582 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
 583 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
 584 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
 585
 586
 587 /*****************************************************************************
 588  * Macros and inline functions
 589  *****************************************************************************/
 590 #ifdef NTOHL_IN_SYS_PARAM_H
 591 #   include <sys/param.h>
 592
 593 #elif !defined(WIN32) && !defined( UNDER_CE )
 594 #   include <netinet/in.h>
 595
 596 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 597
 598 /* CEIL: division with round to nearest greater integer */
 599 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 600
 601 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 602 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 603
 604 /* __MAX and __MIN: self explanatory */
 605 #ifndef __MAX
 606 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 607 #endif
 608 #ifndef __MIN
 609 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 610 #endif
 611
 612 static inline int64_t GCD( int64_t a, int64_t b )
 613 {
 614     while( b )
 615     {
 616         int64_t c = a % b;
 617         a = b;
 618         b = c;
 619     }
 620     return a;
 621 }
 622
 623 /* function imported from libavutil/common.h */
 624 static inline uint8_t clip_uint8_vlc( int32_t a )
 625 {
 626     if( a&(~255) ) return (-a)>>31;
 627     else           return a;
 628 }
 629
 630 /* Malloc with automatic error */
 631 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 632                                    if( !var ) return; } while(0)
 633 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 634                                    if( !var ) return NULL; } while(0)
 635 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 636                                    if( !var ) return VLC_ENOMEM; } while(0)
 637 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 638                                       if( !var ) goto error; } while(0)
 639 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
 640                                     if( !var ) return;
 641 #define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
 642                                     if( !var ) return VLC_ENOMEM;
 643 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
 644                                     if( !var ) return NULL;
 645
 646 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 647
 648 #define EMPTY_STR(str) (!str || !*str)
 649
 650 VLC_EXPORT( char const *, vlc_error, ( int ) );
 651
 652 #include <vlc_arrays.h>
 653
 654 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 655  * MSB, and should be used for both network communications and files. Note that
 656  * byte orders other than little and big endians are not supported, but only
 657  * the VAX seems to have such exotic properties. */
 658 static inline uint16_t U16_AT( const void * _p )
 659 {
 660     const uint8_t * p = (const uint8_t *)_p;
 661     return ( ((uint16_t)p[0] << 8) | p[1] );
 662 }
 663 static inline uint32_t U32_AT( const void * _p )
 664 {
 665     const uint8_t * p = (const uint8_t *)_p;
 666     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 667               | ((uint32_t)p[2] << 8) | p[3] );
 668 }
 669 static inline uint64_t U64_AT( const void * _p )
 670 {
 671     const uint8_t * p = (const uint8_t *)_p;
 672     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 673               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 674               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 675               | ((uint64_t)p[6] << 8) | p[7] );
 676 }
 677
 678 static inline uint16_t GetWLE( const void * _p )
 679 {
 680     const uint8_t * p = (const uint8_t *)_p;
 681     return ( ((uint16_t)p[1] << 8) | p[0] );
 682 }
 683 static inline uint32_t GetDWLE( const void * _p )
 684 {
 685     const uint8_t * p = (const uint8_t *)_p;
 686     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 687               | ((uint32_t)p[1] << 8) | p[0] );
 688 }
 689 static inline uint64_t GetQWLE( const void * _p )
 690 {
 691     const uint8_t * p = (const uint8_t *)_p;
 692     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 693               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 694               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 695               | ((uint64_t)p[1] << 8) | p[0] );
 696 }
 697
 698 #define GetWBE( p )     U16_AT( p )
 699 #define GetDWBE( p )    U32_AT( p )
 700 #define GetQWBE( p )    U64_AT( p )
 701
 702 /* Helper writer functions */
 703 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
 704 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 705 {
 706     p[1] = ( i_dw >>  8 )&0xff;
 707     p[0] = ( i_dw       )&0xff;
 708 }
 709
 710 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
 711 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 712 {
 713     p[3] = ( i_dw >> 24 )&0xff;
 714     p[2] = ( i_dw >> 16 )&0xff;
 715     p[1] = ( i_dw >>  8 )&0xff;
 716     p[0] = ( i_dw       )&0xff;
 717 }
 718 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
 719 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 720 {
 721     SetDWLE( p,   i_qw&0xffffffff );
 722     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 723 }
 724 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
 725 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 726 {
 727     p[0] = ( i_dw >>  8 )&0xff;
 728     p[1] = ( i_dw       )&0xff;
 729 }
 730
 731 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
 732 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 733 {
 734     p[0] = ( i_dw >> 24 )&0xff;
 735     p[1] = ( i_dw >> 16 )&0xff;
 736     p[2] = ( i_dw >>  8 )&0xff;
 737     p[3] = ( i_dw       )&0xff;
 738 }
 739 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
 740 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 741 {
 742     SetDWBE( p+4,   i_qw&0xffffffff );
 743     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 744 }
 745
 746 #ifdef WORDS_BIGENDIAN
 747 #   define hton16(i)   ( i )
 748 #   define hton32(i)   ( i )
 749 #   define hton64(i)   ( i )
 750 #   define ntoh16(i)   ( i )
 751 #   define ntoh32(i)   ( i )
 752 #   define ntoh64(i)   ( i )
 753 #else
 754 #   define hton16(i)   U16_AT(&i)
 755 #   define hton32(i)   U32_AT(&i)
 756 #   define hton64(i)   U64_AT(&i)
 757 #   define ntoh16(i)   U16_AT(&i)
 758 #   define ntoh32(i)   U32_AT(&i)
 759 #   define ntoh64(i)   U64_AT(&i)
 760 #endif
 761
 762 /* Format string sanity checks */
 763 #ifdef HAVE_ATTRIBUTE_FORMAT
 764 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
 765 #else
 766 #   define ATTRIBUTE_FORMAT(x,y)
 767 #endif
 768
 769 /* Alignment of critical static data structures */
 770 #ifdef ATTRIBUTE_ALIGNED_MAX
 771 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
 772 #else
 773 #   define ATTR_ALIGN(align)
 774 #endif
 775
 776 #ifdef HAVE_ATTRIBUTE_PACKED
 777 #   define ATTR_PACKED __attribute__((__packed__))
 778 #endif
 779
 780 /* */
 781 #define VLC_UNUSED(x) (void)(x)
 782
 783 /* Stuff defined in src/extras/libc.c */
 784 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
 785 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
 786 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
 787 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
 788 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
 789 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
 790 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
 791 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
 792 VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
 793
 794 #if defined(SYS_BEOS) \
 795  || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
 796     typedef struct {
 797         long long quot; /* Quotient. */
 798         long long rem;  /* Remainder. */
 799     } lldiv_t;
 800 #endif
 801 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
 802
 803 struct dirent;
 804 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
 805 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
 806
 807 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
 808
 809 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
 810 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
 811 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
 812
 813 #ifndef HAVE_DIRENT_H
 814     typedef void DIR;
 815 #   ifndef FILENAME_MAX
 816 #       define FILENAME_MAX (260)
 817 #   endif
 818     struct dirent
 819     {
 820         long            d_ino;          /* Always zero. */
 821         unsigned short  d_reclen;       /* Always zero. */
 822         unsigned short  d_namlen;       /* Length of name in d_name. */
 823         char            d_name[FILENAME_MAX]; /* File name. */
 824     };
 825 #   define opendir vlc_opendir
 826 #   define readdir vlc_readdir
 827 #   define closedir vlc_closedir
 828 #   define rewinddir vlc_rewindir
 829 #   define seekdir vlc_seekdir
 830 #   define telldir vlc_telldir
 831     VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
 832     VLC_EXPORT( void *, vlc_readdir, ( void * ) );
 833     VLC_EXPORT( int, vlc_closedir, ( void * ) );
 834     VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
 835     VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
 836     VLC_INTERNAL( long, vlc_telldir, ( void * ) );
 837 #endif
 838
 839 #if defined (WIN32)
 840 #   include <dirent.h>
 841  VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
 842  VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
 843  VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
 844  VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
 845  VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
 846  VLC_INTERNAL( long, vlc_telldir, ( void * ) );
 847 #   define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
 848 #   define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
 849 #   define closedir vlc_wclosedir
 850 #   define _wopendir vlc_wopendir
 851 #   define _wreaddir vlc_wreaddir
 852 #   define _wclosedir vlc_wclosedir
 853 #   define rewinddir vlc_rewinddir
 854 #   define seekdir vlc_seekdir
 855 #   define telldir vlc_telldir
 856 #endif
 857
 858 #if defined(WIN32) || defined(UNDER_CE)
 859 /* win32, cl and icl support */
 860 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 861 #       define __attribute__(x)
 862 #       define __inline__      __inline
 863 #       define S_IFBLK         0x3000  /* Block */
 864 #       define S_ISBLK(m)      (0)
 865 #       define S_ISCHR(m)      (0)
 866 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 867 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 868 #   endif
 869
 870 /* several type definitions */
 871 #   if defined( __MINGW32__ )
 872 #       if !defined( _OFF_T_ )
 873             typedef long long _off_t;
 874             typedef _off_t off_t;
 875 #           define _OFF_T_
 876 #       else
 877 #           ifdef off_t
 878 #               undef off_t
 879 #           endif
 880 #           define off_t long long
 881 #       endif
 882 #   endif
 883
 884 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
 885 #       if !defined( _OFF_T_DEFINED )
 886             typedef __int64 off_t;
 887 #           define _OFF_T_DEFINED
 888 #       else
 889             /* for wx compatibility typedef long off_t; */
 890 #           define off_t __int64
 891 #       endif
 892 #   endif
 893
 894 #   if defined( __BORLANDC__ )
 895 #       undef off_t
 896 #       define off_t unsigned __int64
 897 #   endif
 898
 899 #   ifndef O_NONBLOCK
 900 #       define O_NONBLOCK 0
 901 #   endif
 902
 903 #   ifndef alloca
 904 #       define alloca _alloca
 905 #   endif
 906
 907     /* These two are not defined in mingw32 (bug?) */
 908 #   ifndef snprintf
 909 #       define snprintf _snprintf
 910 #   endif
 911 #   ifndef vsnprintf
 912 #       define vsnprintf _vsnprintf
 913 #   endif
 914
 915 #   include <tchar.h>
 916 #endif
 917
 918 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
 919 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
 920
 921 /* vlc_wraptext (defined in src/extras/libc.c) */
 922 #define wraptext vlc_wraptext
 923 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
 924
 925 /* iconv wrappers (defined in src/extras/libc.c) */
 926 typedef void *vlc_iconv_t;
 927 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
 928 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
 929 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
 930
 931 /* execve wrapper (defined in src/extras/libc.c) */
 932 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 ) );
 933 #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)
 934
 935 /*****************************************************************************
 936  * CPU capabilities
 937  *****************************************************************************/
 938 #define CPU_CAPABILITY_NONE    0
 939 #define CPU_CAPABILITY_486     (1<<0)
 940 #define CPU_CAPABILITY_586     (1<<1)
 941 #define CPU_CAPABILITY_PPRO    (1<<2)
 942 #define CPU_CAPABILITY_MMX     (1<<3)
 943 #define CPU_CAPABILITY_3DNOW   (1<<4)
 944 #define CPU_CAPABILITY_MMXEXT  (1<<5)
 945 #define CPU_CAPABILITY_SSE     (1<<6)
 946 #define CPU_CAPABILITY_SSE2    (1<<7)
 947 #define CPU_CAPABILITY_ALTIVEC (1<<16)
 948 #define CPU_CAPABILITY_FPU     (1<<31)
 949 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
 950
 951 /*****************************************************************************
 952  * I18n stuff
 953  *****************************************************************************/
 954 #ifdef WIN32
 955     VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
 956 #endif
 957
 958 #if defined( ENABLE_NLS ) && \
 959      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 960       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
 961       defined(MODULE_NAME_IS_pda))
 962     /* Declare nothing: gnome.h will do it for us */
 963 #elif defined( ENABLE_NLS )
 964 #   include <libintl.h>
 965 #   undef _
 966 #   ifdef WIN32
 967 #       define _(String) vlc_dgettext (PACKAGE_NAME, String)
 968 #   else
 969 #       define _(String) dgettext(PACKAGE_NAME, String)
 970 #   endif
 971 #   define N_(String) (String)
 972 #else
 973 #   define _(String) (String)
 974 #   define N_(String) (String)
 975 #endif
 976
 977 /*****************************************************************************
 978  * libvlc features
 979  *****************************************************************************/
 980 VLC_EXPORT( const char *, VLC_Version, ( void ) );
 981 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
 982 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
 983 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
 984 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
 985 VLC_EXPORT( const char *, VLC_Error, ( int ) );
 986 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
 987
 988 /*****************************************************************************
 989  * Additional vlc stuff
 990  *****************************************************************************/
 991 #include "vlc_messages.h"
 992 #include "vlc_variables.h"
 993 #include "vlc_objects.h"
 994 #include "vlc_mtime.h"
 995 #include "vlc_threads_funcs.h"
 996 #include "vlc_modules.h"
 997 #include "main.h"
 998 #include "vlc_configuration.h"
 999
1000 #if defined( WIN32 ) || defined( UNDER_CE )
1001 #   define DIR_SEP_CHAR '\\'
1002 #   define DIR_SEP "\\"
1003 #   define PATH_SEP_CHAR ';'
1004 #   define PATH_SEP ";"
1005 #else
1006 #   define DIR_SEP_CHAR '/'
1007 #   define DIR_SEP "/"
1008 #   define PATH_SEP_CHAR ':'
1009 #   define PATH_SEP ":"
1010 #endif