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