git.sesse.net Git - vlc/blob - include/vlc_common.h

   1 /*****************************************************************************
   2  * common.h: common definitions
   3  * Collection of useful common types and macros definitions
   4  *****************************************************************************
   5  * Copyright (C) 1998-2005 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
   9  *          Vincent Seguin <seguin@via.ecp.fr>
  10  *          Gildas Bazin <gbazin@videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /**
  28  * \file
  29  * This file is a collection of common definitions and types
  30  */
  31
  32 #ifndef PACKAGE
  33 /* Temporary regression test */
  34 #error You probably forgot to include config.h!!
  35 #endif
  36
  37 /*****************************************************************************
  38  * Required vlc headers
  39  *****************************************************************************/
  40 #if defined( __BORLANDC__ )
  41 #   undef HAVE_VARIADIC_MACROS
  42 #   undef HAVE_STDINT_H
  43 #   undef HAVE_INTTYPES_H
  44 #elif defined( _MSC_VER )
  45 #   pragma warning( disable : 4244 )
  46 #endif
  47
  48 #include "vlc_config.h"
  49
  50 /*****************************************************************************
  51  * Required system headers
  52  *****************************************************************************/
  53 #include <stdlib.h>
  54 #include <stdarg.h>
  55
  56 #include <string.h>
  57 #include <stdio.h>
  58
  59 #ifdef HAVE_SYS_TYPES_H
  60 #   include <sys/types.h>
  61 #endif
  62
  63 /*****************************************************************************
  64  * Basic types definitions
  65  *****************************************************************************/
  66 #if defined( HAVE_STDINT_H )
  67 #   include <stdint.h>
  68 #elif defined( HAVE_INTTYPES_H )
  69 #   include <inttypes.h>
  70 #elif defined( SYS_CYGWIN )
  71 #   include <sys/types.h>
  72     /* Cygwin only defines half of these... */
  73     typedef u_int8_t            uint8_t;
  74     typedef u_int16_t           uint16_t;
  75     typedef u_int32_t           uint32_t;
  76     typedef u_int64_t           uint64_t;
  77 #else
  78     /* Fallback types (very x86-centric, sorry) */
  79     typedef unsigned char       uint8_t;
  80     typedef signed char         int8_t;
  81     typedef unsigned short      uint16_t;
  82     typedef signed short        int16_t;
  83     typedef unsigned int        uint32_t;
  84     typedef signed int          int32_t;
  85 #   if defined( _MSC_VER ) \
  86       || defined( UNDER_CE ) \
  87       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
  88     typedef unsigned __int64    uint64_t;
  89     typedef signed __int64      int64_t;
  90 #   else
  91     typedef unsigned long long  uint64_t;
  92     typedef signed long long    int64_t;
  93 #   endif
  94     typedef uint32_t            uintptr_t;
  95     typedef int32_t             intptr_t;
  96 #endif
  97
  98 typedef uint8_t                 byte_t;
  99
 100 /* Systems that don't have stdint.h may not define INT64_MIN and
 101    INT64_MAX */
 102 #ifndef INT64_MIN
 103 #define INT64_MIN (-9223372036854775807LL-1)
 104 #endif
 105 #ifndef INT64_MAX
 106 #define INT64_MAX (9223372036854775807LL)
 107 #endif
 108
 109 /* ptrdiff_t definition */
 110 #ifdef HAVE_STDDEF_H
 111 #   include <stddef.h>
 112 #else
 113 #   include <malloc.h>
 114 #   ifndef _PTRDIFF_T
 115 #       define _PTRDIFF_T
 116 /* Not portable in a 64-bit environment. */
 117 typedef int                 ptrdiff_t;
 118 #   endif
 119 #endif
 120
 121 #if defined( WIN32 ) || defined( UNDER_CE )
 122 #   include <malloc.h>
 123 #   ifndef PATH_MAX
 124 #       define PATH_MAX MAX_PATH
 125 #   endif
 126 #endif
 127
 128 /* Counter for statistics and profiling */
 129 typedef unsigned long       count_t;
 130
 131 /* DCT elements types */
 132 typedef int16_t             dctelem_t;
 133
 134 /* Video buffer types */
 135 typedef uint8_t             yuv_data_t;
 136
 137 /* Audio volume */
 138 typedef uint16_t            audio_volume_t;
 139
 140 /**
 141  * High precision date or time interval
 142  *
 143  * Store a high precision date or time interval. The maximum precision is the
 144  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
 145  * time interval is then 292271 years, which should be long enough for any
 146  * video). Dates are stored as microseconds since a common date (usually the
 147  * epoch). Note that date and time intervals can be manipulated using regular
 148  * arithmetic operators, and that no special functions are required.
 149  */
 150 typedef int64_t mtime_t;
 151
 152 /**
 153  * The vlc_fourcc_t type.
 154  *
 155  * See http://www.webartz.com/fourcc/ for a very detailed list.
 156  */
 157 typedef uint32_t vlc_fourcc_t;
 158
 159 #ifdef WORDS_BIGENDIAN
 160 #   define VLC_FOURCC( a, b, c, d ) \
 161         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 162            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 163 #   define VLC_TWOCC( a, b ) \
 164         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 165
 166 #else
 167 #   define VLC_FOURCC( a, b, c, d ) \
 168         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 169            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 170 #   define VLC_TWOCC( a, b ) \
 171         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 172
 173 #endif
 174
 175 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
 176 {
 177 #ifdef WORDS_BIGENDIAN
 178     psz_fourcc[0] = (uint32_t) (fcc >> 24);
 179     psz_fourcc[1] = (uint32_t) (fcc >> 16);
 180     psz_fourcc[2] = (uint32_t) (fcc >> 8);
 181     psz_fourcc[3] = (uint32_t) (fcc);
 182 #else
 183     psz_fourcc[3] = (uint32_t) (fcc >> 24);
 184     psz_fourcc[2] = (uint32_t) (fcc >> 16);
 185     psz_fourcc[1] = (uint32_t) (fcc >> 8);
 186     psz_fourcc[0] = (uint32_t) (fcc);
 187 #endif
 188 }
 189
 190 #define vlc_fourcc_to_char( a, b ) \
 191     __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
 192
 193 /*****************************************************************************
 194  * Classes declaration
 195  *****************************************************************************/
 196
 197 /* Internal types */
 198 typedef struct libvlc_global_data_t libvlc_global_data_t;
 199 typedef struct libvlc_int_t libvlc_int_t;
 200 typedef struct variable_t variable_t;
 201 typedef struct date_t date_t;
 202 typedef struct dict_entry_t dict_entry_t;
 203 typedef struct dict_t dict_t;
 204 typedef struct gc_object_t gc_object_t ;
 205
 206 /* Messages */
 207 typedef struct msg_bank_t msg_bank_t;
 208 typedef struct msg_queue_t msg_queue_t;
 209 typedef struct msg_subscription_t msg_subscription_t;
 210
 211 /* Playlist */
 212
 213 /* FIXME */
 214 /**
 215  * Playlist commands
 216  */
 217 typedef enum {
 218     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
 219     PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
 220     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
 221                         /**  arg2 = playlist_item_t*          , res=can fail */
 222     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
 223     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
 224     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
 225 } playlist_command_t;
 226
 227
 228 typedef struct playlist_t playlist_t;
 229 typedef struct playlist_item_t playlist_item_t;
 230 typedef struct playlist_view_t playlist_view_t;
 231 typedef struct playlist_export_t playlist_export_t;
 232 typedef struct services_discovery_t services_discovery_t;
 233 typedef struct services_discovery_sys_t services_discovery_sys_t;
 234 typedef struct playlist_add_t playlist_add_t;
 235 typedef struct playlist_preparse_t playlist_preparse_t;
 236 typedef struct playlist_fetcher_t playlist_fetcher_t;
 237
 238 /* Modules */
 239 typedef struct module_bank_t module_bank_t;
 240 typedef struct module_t module_t;
 241 typedef struct module_config_t module_config_t;
 242 typedef struct module_symbols_t module_symbols_t;
 243 typedef struct module_cache_t module_cache_t;
 244
 245 typedef struct config_category_t config_category_t;
 246
 247 /* Interface */
 248 typedef struct intf_thread_t intf_thread_t;
 249 typedef struct intf_sys_t intf_sys_t;
 250 typedef struct intf_console_t intf_console_t;
 251 typedef struct intf_msg_t intf_msg_t;
 252 typedef struct interaction_t interaction_t;
 253 typedef struct interaction_dialog_t interaction_dialog_t;
 254 typedef struct user_widget_t user_widget_t;
 255
 256 /* Input */
 257 typedef struct input_thread_t input_thread_t;
 258 typedef struct input_thread_sys_t input_thread_sys_t;
 259 typedef struct input_item_t input_item_t;
 260 typedef struct access_t access_t;
 261 typedef struct access_sys_t access_sys_t;
 262 typedef struct stream_t     stream_t;
 263 typedef struct stream_sys_t stream_sys_t;
 264 typedef struct demux_t  demux_t;
 265 typedef struct demux_meta_t demux_meta_t;
 266 typedef struct demux_sys_t demux_sys_t;
 267 typedef struct es_out_t     es_out_t;
 268 typedef struct es_out_id_t  es_out_id_t;
 269 typedef struct es_out_sys_t es_out_sys_t;
 270 typedef struct es_descriptor_t es_descriptor_t;
 271 typedef struct seekpoint_t seekpoint_t;
 272 typedef struct info_t info_t;
 273 typedef struct info_category_t info_category_t;
 274 typedef struct input_attachment_t input_attachment_t;
 275
 276 /* Format */
 277 typedef struct audio_format_t audio_format_t;
 278 typedef struct video_format_t video_format_t;
 279 typedef struct subs_format_t subs_format_t;
 280 typedef struct es_format_t es_format_t;
 281 typedef struct video_palette_t video_palette_t;
 282
 283 /* Audio */
 284 typedef struct aout_instance_t aout_instance_t;
 285 typedef struct aout_sys_t aout_sys_t;
 286 typedef struct aout_fifo_t aout_fifo_t;
 287 typedef struct aout_input_t aout_input_t;
 288 typedef struct aout_buffer_t aout_buffer_t;
 289 typedef audio_format_t audio_sample_format_t;
 290 typedef struct audio_date_t audio_date_t;
 291 typedef struct aout_filter_t aout_filter_t;
 292
 293 /* Video */
 294 typedef struct vout_thread_t vout_thread_t;
 295 typedef struct vout_sys_t vout_sys_t;
 296 typedef struct chroma_sys_t chroma_sys_t;
 297
 298 typedef video_format_t video_frame_format_t;
 299 typedef struct picture_t picture_t;
 300 typedef struct picture_sys_t picture_sys_t;
 301 typedef struct picture_heap_t picture_heap_t;
 302
 303 /* Subpictures */
 304 typedef struct spu_t spu_t;
 305 typedef struct subpicture_t subpicture_t;
 306 typedef struct subpicture_sys_t subpicture_sys_t;
 307 typedef struct subpicture_region_t subpicture_region_t;
 308 typedef struct text_style_t text_style_t;
 309
 310 typedef struct image_handler_t image_handler_t;
 311
 312 /* Stream output */
 313 typedef struct sout_instance_t sout_instance_t;
 314 typedef struct sout_instance_sys_t sout_instance_sys_t;
 315
 316 typedef struct sout_input_t sout_input_t;
 317 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 318
 319 typedef struct sout_access_out_t sout_access_out_t;
 320 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 321
 322 typedef struct sout_mux_t sout_mux_t;
 323 typedef struct sout_mux_sys_t sout_mux_sys_t;
 324
 325 typedef struct sout_stream_t    sout_stream_t;
 326 typedef struct sout_stream_sys_t sout_stream_sys_t;
 327
 328 typedef struct config_chain_t       config_chain_t;
 329 typedef struct sap_session_t    sap_session_t;
 330 typedef struct sap_address_t sap_address_t;
 331 typedef struct session_descriptor_t session_descriptor_t;
 332 typedef struct announce_method_t announce_method_t;
 333 typedef struct announce_handler_t announce_handler_t;
 334 typedef struct sap_handler_t sap_handler_t;
 335
 336 typedef struct sout_param_t sout_param_t;
 337 typedef struct sout_pcat_t sout_pcat_t;
 338 typedef struct sout_std_t sout_std_t;
 339 typedef struct sout_display_t sout_display_t;
 340 typedef struct sout_duplicate_t sout_duplicate_t;
 341 typedef struct sout_transcode_t sout_transcode_t;
 342 typedef struct sout_chain_t sout_chain_t;
 343 typedef struct streaming_profile_t streaming_profile_t;
 344 typedef struct sout_module_t sout_module_t;
 345 typedef struct sout_gui_descr_t sout_gui_descr_t;
 346 typedef struct profile_parser_t profile_parser_t;
 347
 348 /* Decoders */
 349 typedef struct decoder_t         decoder_t;
 350 typedef struct decoder_sys_t     decoder_sys_t;
 351 typedef struct decoder_synchro_t decoder_synchro_t;
 352
 353 /* Encoders */
 354 typedef struct encoder_t      encoder_t;
 355 typedef struct encoder_sys_t  encoder_sys_t;
 356
 357 /* Filters */
 358 typedef struct filter_t filter_t;
 359 typedef struct filter_sys_t filter_sys_t;
 360
 361 /* Network */
 362 typedef struct network_socket_t network_socket_t;
 363 typedef struct virtual_socket_t v_socket_t;
 364 typedef struct sockaddr sockaddr;
 365 typedef struct addrinfo addrinfo;
 366 typedef struct vlc_acl_t vlc_acl_t;
 367 typedef struct vlc_url_t vlc_url_t;
 368
 369 /* Misc */
 370 typedef struct iso639_lang_t iso639_lang_t;
 371 typedef struct device_t device_t;
 372 typedef struct device_probe_t device_probe_t;
 373 typedef struct probe_sys_t probe_sys_t;
 374
 375 /* block */
 376 typedef struct block_t      block_t;
 377 typedef struct block_fifo_t block_fifo_t;
 378
 379 /* httpd */
 380 typedef struct httpd_t          httpd_t;
 381 typedef struct httpd_host_t     httpd_host_t;
 382 typedef struct httpd_url_t      httpd_url_t;
 383 typedef struct httpd_client_t   httpd_client_t;
 384 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 385 typedef struct httpd_message_t  httpd_message_t;
 386 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
 387 typedef struct httpd_file_t     httpd_file_t;
 388 typedef struct httpd_file_sys_t httpd_file_sys_t;
 389 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 390 typedef struct httpd_handler_t  httpd_handler_t;
 391 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
 392 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 );
 393 typedef struct httpd_redirect_t httpd_redirect_t;
 394 typedef struct httpd_stream_t httpd_stream_t;
 395
 396 /* TLS support */
 397 typedef struct tls_server_t tls_server_t;
 398 typedef struct tls_session_t tls_session_t;
 399
 400 /* Hashing */
 401 typedef struct md5_s md5_t;
 402
 403 /* XML */
 404 typedef struct xml_t xml_t;
 405 typedef struct xml_sys_t xml_sys_t;
 406 typedef struct xml_reader_t xml_reader_t;
 407 typedef struct xml_reader_sys_t xml_reader_sys_t;
 408
 409 /* vod server */
 410 typedef struct vod_t     vod_t;
 411 typedef struct vod_sys_t vod_sys_t;
 412 typedef struct vod_media_t vod_media_t;
 413
 414 /* opengl */
 415 typedef struct opengl_t     opengl_t;
 416 typedef struct opengl_sys_t opengl_sys_t;
 417
 418 /* osdmenu */
 419 typedef struct osd_menu_t   osd_menu_t;
 420 typedef struct osd_state_t  osd_state_t;
 421 typedef struct osd_event_t  osd_event_t;
 422 typedef struct osd_button_t osd_button_t;
 423 typedef struct osd_menu_state_t osd_menu_state_t;
 424
 425 /* VLM */
 426 typedef struct vlm_t         vlm_t;
 427 typedef struct vlm_message_t vlm_message_t;
 428
 429 /* divers */
 430 typedef struct vlc_meta_t    vlc_meta_t;
 431 typedef struct meta_export_t meta_export_t;
 432
 433 /* Stats */
 434 typedef struct counter_t     counter_t;
 435 typedef struct counter_sample_t counter_sample_t;
 436 typedef struct stats_handler_t stats_handler_t;
 437 typedef struct input_stats_t input_stats_t;
 438 typedef struct global_stats_t global_stats_t;
 439
 440 /* Update */
 441 typedef struct update_t update_t;
 442 typedef struct update_iterator_t update_iterator_t;
 443
 444 /* Meta engine */
 445 typedef struct meta_engine_t meta_engine_t;
 446
 447 /* stat/lstat/fstat */
 448 #ifdef WIN32
 449 #include <sys/stat.h>
 450 struct _stati64;
 451 #define stat _stati64
 452 #define fstat _fstati64
 453 /* You should otherwise use utf8_stat and utf8_lstat. */
 454 #else
 455 struct stat;
 456 #endif
 457
 458 /*****************************************************************************
 459  * Variable callbacks
 460  *****************************************************************************/
 461 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 462                                    char const *,            /* variable name */
 463                                    vlc_value_t,                 /* old value */
 464                                    vlc_value_t,                 /* new value */
 465                                    void * );                /* callback data */
 466
 467 /*****************************************************************************
 468  * Plug-in stuff
 469  *****************************************************************************/
 470
 471 #include "vlc_modules_macros.h"
 472
 473 #if defined (WIN32) && defined (DLL_EXPORT)
 474 #  ifdef __cplusplus
 475 #    define VLC_PUBLIC_API __declspec(dllexport)
 476 #    define VLC_PRIVATE_API __declspec(dllexport)
 477 #    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
 478 #    define VLC_INTERNAL( type, name, args ) extern "C" type name args
 479 #  else
 480 #    define VLC_PUBLIC_API extern __declspec(dllexport)
 481 #    define VLC_PRIVATE_API extern __declspec(dllexport)
 482 #    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
 483 #    define VLC_INTERNAL( type, name, args ) type name args
 484 #  endif
 485 #else
 486 #  ifdef __cplusplus
 487 #    if HAVE_ATTRIBUTE_VISIBILITY
 488 #      define VLC_PUBLIC_API __attribute__((visibility("default")))
 489 #      define VLC_PRIVATE_API __attribute__((visibility("default")))
 490 #      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
 491 #      define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
 492 #    else
 493 #      define VLC_PUBLIC_API
 494 #      define   VLC_EXPORT( type, name, args ) extern "C" type name args
 495 #      define VLC_INTERNAL( type, name, args ) extern "C" type name args
 496 #    endif
 497 #  else
 498 #    if HAVE_ATTRIBUTE_VISIBILITY
 499 #      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
 500 #      define VLC_PRIVATE_API extern __attribute__((visibility("default")))
 501 #      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
 502 #      define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
 503 #    else
 504 #      define VLC_PUBLIC_API extern
 505 #      define VLC_PRIVATE_API extern
 506 #      define   VLC_EXPORT( type, name, args ) type name args
 507 #      define VLC_INTERNAL( type, name, args ) type name args
 508 #    endif
 509 #  endif
 510 #endif
 511
 512 /*****************************************************************************
 513  * OS-specific headers and thread types
 514  *****************************************************************************/
 515 #if defined( WIN32 ) || defined( UNDER_CE )
 516 #   define WIN32_LEAN_AND_MEAN
 517 #   include <windows.h>
 518 #   if defined( UNDER_CE )
 519 #      define IS_WINNT 0
 520 #   else
 521 #      define IS_WINNT ( GetVersion() < 0x80000000 )
 522 #   endif
 523 #endif
 524
 525 #include "vlc_threads.h"
 526
 527 typedef struct vlc_object_internals_t vlc_object_internals_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     vlc_object_internals_t *p_internals;                                    \
 540     int   i_object_id;                                                      \
 541     int   i_object_type;                                                    \
 542     const char *psz_object_type;                                            \
 543     const char *psz_object_name;                                            \
 544                                                                             \
 545     /* Messages header */                                                   \
 546     char *psz_header;                                                       \
 547     int  i_flags;                                                           \
 548                                                                             \
 549     /* Object access lock */                                                \
 550     vlc_mutex_t  object_lock;                                               \
 551     vlc_cond_t   object_wait;                                               \
 552                                                                             \
 553     /* Object properties */                                                 \
 554     volatile vlc_bool_t b_error;                  /**< set by the object */ \
 555     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
 556     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
 557     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
 558                                                                             \
 559     /* Stuff related to the libvlc structure */                             \
 560     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 561                                                                             \
 562     vlc_object_t *  p_parent;                            /**< our parent */ \
 563     vlc_object_t ** pp_children;                       /**< our children */ \
 564     volatile int    i_children;                                             \
 565                                                                             \
 566     /* Private data */                                                      \
 567     void *          p_private;                                              \
 568                                                                             \
 569     /** Just a reminder so that people don't cast garbage */                \
 570     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
 571 /**@}*/                                                                     \
 572
 573 /* VLC_OBJECT: attempt at doing a clever cast */
 574 #define VLC_OBJECT( x ) \
 575     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 576
 577 #define VLC_GC_MEMBERS                                                       \
 578 /** \name VLC_GC_MEMBERS                                                     \
 579  * these members are common to all objects that wish to be garbage-collected \
 580  */                                                                          \
 581 /**@{*/                                                                      \
 582     int i_gc_refcount;                                                       \
 583     void (*pf_destructor) ( gc_object_t * );                                 \
 584     void *p_destructor_arg;                                                  \
 585 /**@}*/
 586
 587 struct gc_object_t
 588 {
 589             VLC_GC_MEMBERS
 590 };
 591
 592 #include <assert.h> /* FIXME: should not be included here */
 593
 594 static inline void __vlc_gc_incref( gc_object_t * p_gc )
 595 {
 596     assert( p_gc->i_gc_refcount > 0 );
 597
 598     p_gc->i_gc_refcount ++;
 599 };
 600
 601 static inline void __vlc_gc_decref( gc_object_t *p_gc )
 602 {
 603     if( !p_gc ) return;
 604
 605     assert( p_gc->i_gc_refcount > 0 );
 606
 607     p_gc->i_gc_refcount -- ;
 608
 609     if( p_gc->i_gc_refcount == 0 )
 610     {
 611         p_gc->pf_destructor( p_gc );
 612         /* Do not use the p_gc pointer from now on ! */
 613     }
 614 }
 615
 616 static inline void
 617 __vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
 618                void * arg)
 619 {
 620     p_gc->i_gc_refcount = 1;
 621     p_gc->pf_destructor = pf_destructor;
 622     p_gc->p_destructor_arg = arg;
 623 }
 624
 625 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
 626 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
 627 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
 628
 629
 630 /*****************************************************************************
 631  * Macros and inline functions
 632  *****************************************************************************/
 633 #ifdef NTOHL_IN_SYS_PARAM_H
 634 #   include <sys/param.h>
 635
 636 #elif !defined(WIN32) && !defined( UNDER_CE )
 637 #   include <netinet/in.h>
 638
 639 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 640
 641 /* CEIL: division with round to nearest greater integer */
 642 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 643
 644 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 645 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 646
 647 /* __MAX and __MIN: self explanatory */
 648 #ifndef __MAX
 649 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 650 #endif
 651 #ifndef __MIN
 652 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 653 #endif
 654
 655 static inline int64_t GCD( int64_t a, int64_t b )
 656 {
 657     while( b )
 658     {
 659         int64_t c = a % b;
 660         a = b;
 661         b = c;
 662     }
 663     return a;
 664 }
 665
 666 /* function imported from libavutil/common.h */
 667 static inline uint8_t clip_uint8_vlc( int32_t a )
 668 {
 669     if( a&(~255) ) return (-a)>>31;
 670     else           return a;
 671 }
 672
 673 /* Malloc with automatic error */
 674 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 675                                    if( !var ) return; } while(0)
 676 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 677                                    if( !var ) return NULL; } while(0)
 678 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 679                                    if( !var ) return VLC_ENOMEM; } while(0)
 680 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 681                                       if( !var ) goto error; } while(0)
 682 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
 683                                     if( !var ) return;
 684 #define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
 685                                     if( !var ) return VLC_ENOMEM;
 686 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
 687                                     if( !var ) return NULL;
 688
 689 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 690
 691 #define EMPTY_STR(str) (!str || !*str)
 692
 693 VLC_EXPORT( char const *, vlc_error, ( int ) );
 694
 695 #include <vlc_arrays.h>
 696
 697 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 698  * MSB, and should be used for both network communications and files. Note that
 699  * byte orders other than little and big endians are not supported, but only
 700  * the VAX seems to have such exotic properties. */
 701 static inline uint16_t U16_AT( const void * _p )
 702 {
 703     const uint8_t * p = (const uint8_t *)_p;
 704     return ( ((uint16_t)p[0] << 8) | p[1] );
 705 }
 706 static inline uint32_t U32_AT( const void * _p )
 707 {
 708     const uint8_t * p = (const uint8_t *)_p;
 709     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 710               | ((uint32_t)p[2] << 8) | p[3] );
 711 }
 712 static inline uint64_t U64_AT( const void * _p )
 713 {
 714     const uint8_t * p = (const uint8_t *)_p;
 715     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 716               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 717               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 718               | ((uint64_t)p[6] << 8) | p[7] );
 719 }
 720
 721 static inline uint16_t GetWLE( const void * _p )
 722 {
 723     const uint8_t * p = (const uint8_t *)_p;
 724     return ( ((uint16_t)p[1] << 8) | p[0] );
 725 }
 726 static inline uint32_t GetDWLE( const void * _p )
 727 {
 728     const uint8_t * p = (const uint8_t *)_p;
 729     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 730               | ((uint32_t)p[1] << 8) | p[0] );
 731 }
 732 static inline uint64_t GetQWLE( const void * _p )
 733 {
 734     const uint8_t * p = (const uint8_t *)_p;
 735     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 736               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 737               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 738               | ((uint64_t)p[1] << 8) | p[0] );
 739 }
 740
 741 #define GetWBE( p )     U16_AT( p )
 742 #define GetDWBE( p )    U32_AT( p )
 743 #define GetQWBE( p )    U64_AT( p )
 744
 745 /* Helper writer functions */
 746 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
 747 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 748 {
 749     p[1] = ( i_dw >>  8 )&0xff;
 750     p[0] = ( i_dw       )&0xff;
 751 }
 752
 753 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
 754 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 755 {
 756     p[3] = ( i_dw >> 24 )&0xff;
 757     p[2] = ( i_dw >> 16 )&0xff;
 758     p[1] = ( i_dw >>  8 )&0xff;
 759     p[0] = ( i_dw       )&0xff;
 760 }
 761 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
 762 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 763 {
 764     SetDWLE( p,   i_qw&0xffffffff );
 765     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 766 }
 767 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
 768 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 769 {
 770     p[0] = ( i_dw >>  8 )&0xff;
 771     p[1] = ( i_dw       )&0xff;
 772 }
 773
 774 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
 775 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 776 {
 777     p[0] = ( i_dw >> 24 )&0xff;
 778     p[1] = ( i_dw >> 16 )&0xff;
 779     p[2] = ( i_dw >>  8 )&0xff;
 780     p[3] = ( i_dw       )&0xff;
 781 }
 782 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
 783 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 784 {
 785     SetDWBE( p+4,   i_qw&0xffffffff );
 786     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 787 }
 788
 789 #ifdef WORDS_BIGENDIAN
 790 #   define hton16(i)   ( i )
 791 #   define hton32(i)   ( i )
 792 #   define hton64(i)   ( i )
 793 #   define ntoh16(i)   ( i )
 794 #   define ntoh32(i)   ( i )
 795 #   define ntoh64(i)   ( i )
 796 #else
 797 #   define hton16(i)   U16_AT(&i)
 798 #   define hton32(i)   U32_AT(&i)
 799 #   define hton64(i)   U64_AT(&i)
 800 #   define ntoh16(i)   U16_AT(&i)
 801 #   define ntoh32(i)   U32_AT(&i)
 802 #   define ntoh64(i)   U64_AT(&i)
 803 #endif
 804
 805 /* Format string sanity checks */
 806 #ifdef HAVE_ATTRIBUTE_FORMAT
 807 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
 808 #else
 809 #   define ATTRIBUTE_FORMAT(x,y)
 810 #endif
 811
 812 /* Alignment of critical static data structures */
 813 #ifdef ATTRIBUTE_ALIGNED_MAX
 814 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
 815 #else
 816 #   define ATTR_ALIGN(align)
 817 #endif
 818
 819 /* */
 820 #define VLC_UNUSED(x) (void)(x)
 821
 822 /* Alignment of critical dynamic data structure
 823  *
 824  * Not all platforms support memalign so we provide a vlc_memalign wrapper
 825  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 826  * *pp_orig is the pointer that has to be freed afterwards.
 827  */
 828 #if 0
 829 #ifdef HAVE_POSIX_MEMALIGN
 830 #   define vlc_memalign(align,size,pp_orig) \
 831     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
 832 #endif
 833 #endif
 834 #ifdef HAVE_MEMALIGN
 835     /* Some systems have memalign() but no declaration for it */
 836     void * memalign( size_t align, size_t size );
 837
 838 #   define vlc_memalign(pp_orig,align,size) \
 839     ( *(pp_orig) = memalign( align, size ) )
 840
 841 #else /* We don't have any choice but to align manually */
 842 #   define vlc_memalign(pp_orig,align,size) \
 843     (( *(pp_orig) = malloc( size + align - 1 )) \
 844         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
 845                        & (~(unsigned long)(align-1)) ) \
 846         : NULL )
 847
 848 #endif
 849
 850 /* Stuff defined in src/extras/libc.c */
 851 #ifndef HAVE_STRDUP
 852 #   define strdup vlc_strdup
 853     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
 854 #elif !defined(__PLUGIN__)
 855 #   define vlc_strdup NULL
 856 #endif
 857
 858 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
 859 #   define vasprintf vlc_vasprintf
 860     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
 861 #elif !defined(__PLUGIN__)
 862 #   define vlc_vasprintf NULL
 863 #endif
 864
 865 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
 866 #   define asprintf vlc_asprintf
 867     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
 868 #elif !defined(__PLUGIN__)
 869 #   define vlc_asprintf NULL
 870 #endif
 871
 872 #ifndef HAVE_STRNDUP
 873 #   if defined(STRNDUP_IN_GNOME_H) && \
 874         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 875          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
 876         /* Do nothing: gnome.h defines strndup for us */
 877 #   else
 878 #       define strndup vlc_strndup
 879         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
 880 #   endif
 881 #elif !defined(__PLUGIN__)
 882 #   define vlc_strndup NULL
 883 #endif
 884
 885 #ifndef HAVE_STRNLEN
 886 #   define strnlen vlc_strnlen
 887     VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
 888 #elif !defined(__PLUGIN__)
 889 #   define vlc_strnlen NULL
 890 #endif
 891
 892 #ifndef HAVE_STRLCPY
 893 #   define strlcpy vlc_strlcpy
 894     VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
 895 #elif !defined(__PLUGIN__)
 896 #   define vlc_strlcpy NULL
 897 #endif
 898
 899 #ifndef HAVE_ATOF
 900 #   define atof vlc_atof
 901     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
 902 #elif !defined(__PLUGIN__)
 903 #   define vlc_atof NULL
 904 #endif
 905
 906 #ifndef HAVE_STRTOF
 907 #   ifdef HAVE_STRTOD
 908 #       define strtof strtod
 909 #   endif
 910 #endif
 911
 912 #ifndef HAVE_ATOLL
 913 #   define atoll vlc_atoll
 914     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
 915 #elif !defined(__PLUGIN__)
 916 #   define vlc_atoll NULL
 917 #endif
 918
 919 #ifndef HAVE_STRTOLL
 920 #   define strtoll vlc_strtoll
 921     VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
 922 #elif !defined(__PLUGIN__)
 923 #   define vlc_strtoll NULL
 924 #endif
 925
 926 #if defined(SYS_BEOS) \
 927  || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
 928     typedef struct {
 929         long long quot; /* Quotient. */
 930         long long rem;  /* Remainder. */
 931     } lldiv_t;
 932 #   define lldiv vlc_lldiv
 933     VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
 934 #elif !defined(__PLUGIN__)
 935 #   define vlc_lldiv NULL
 936 #endif
 937
 938 #ifndef HAVE_SCANDIR
 939 #   define scandir vlc_scandir
 940 #   define alphasort vlc_alphasort
 941     struct dirent;
 942     VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
 943     VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
 944 #elif !defined(__PLUGIN__)
 945 #   define vlc_scandir NULL
 946 #   define vlc_alphasort NULL
 947 #endif
 948
 949 #ifndef HAVE_GETENV
 950 #   define getenv vlc_getenv
 951     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
 952 #elif !defined(__PLUGIN__)
 953 #   define vlc_getenv NULL
 954 #endif
 955
 956 #ifndef HAVE_STRCASECMP
 957 #   ifndef HAVE_STRICMP
 958 #       define strcasecmp vlc_strcasecmp
 959         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
 960 #   else
 961 #       define strcasecmp stricmp
 962 #       if !defined(__PLUGIN__)
 963 #           define vlc_strcasecmp NULL
 964 #       endif
 965 #   endif
 966 #elif !defined(__PLUGIN__)
 967 #   define vlc_strcasecmp NULL
 968 #endif
 969
 970 #ifndef HAVE_STRNCASECMP
 971 #   ifndef HAVE_STRNICMP
 972 #       define strncasecmp vlc_strncasecmp
 973         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
 974 #   else
 975 #       define strncasecmp strnicmp
 976 #       if !defined(__PLUGIN__)
 977 #           define vlc_strncasecmp NULL
 978 #       endif
 979 #   endif
 980 #elif !defined(__PLUGIN__)
 981 #   define vlc_strncasecmp NULL
 982 #endif
 983
 984 #ifndef HAVE_STRCASESTR
 985 #   ifndef HAVE_STRISTR
 986 #       define strcasestr vlc_strcasestr
 987         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
 988 #   else
 989 #       define strcasestr stristr
 990 #       if !defined(__PLUGIN__)
 991 #           define vlc_strcasestr NULL
 992 #       endif
 993 #   endif
 994 #elif !defined(__PLUGIN__)
 995 #   define vlc_strcasestr NULL
 996 #endif
 997
 998 #ifndef HAVE_DIRENT_H
 999     typedef void DIR;
1000 #   ifndef FILENAME_MAX
1001 #       define FILENAME_MAX (260)
1002 #   endif
1003     struct dirent
1004     {
1005         long            d_ino;          /* Always zero. */
1006         unsigned short  d_reclen;       /* Always zero. */
1007         unsigned short  d_namlen;       /* Length of name in d_name. */
1008         char            d_name[FILENAME_MAX]; /* File name. */
1009     };
1010 #   define opendir vlc_opendir
1011 #   define readdir vlc_readdir
1012 #   define closedir vlc_closedir
1013 #   define rewinddir vlc_rewindir
1014 #   define seekdir vlc_seekdir
1015 #   define telldir vlc_telldir
1016     VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
1017     VLC_EXPORT( void *, vlc_readdir, ( void * ) );
1018     VLC_EXPORT( int, vlc_closedir, ( void * ) );
1019     VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1020     VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1021     VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1022 #else
1023 #   if !defined(__PLUGIN__)
1024 #       define vlc_opendir  NULL
1025 #       define vlc_readdir  NULL
1026 #       define vlc_closedir NULL
1027 #   endif
1028 #endif
1029
1030 #if defined (WIN32)
1031 #   include <dirent.h>
1032  VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
1033  VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
1034  VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
1035  VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1036  VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1037  VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1038 #   define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
1039 #   define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
1040 #   define closedir vlc_wclosedir
1041 #   define _wopendir vlc_wopendir
1042 #   define _wreaddir vlc_wreaddir
1043 #   define _wclosedir vlc_wclosedir
1044 #   define rewinddir vlc_rewinddir
1045 #   define seekdir vlc_seekdir
1046 #   define telldir vlc_telldir
1047 #elif !defined(__PLUGIN__)
1048 #   define vlc_wclosedir NULL
1049 #endif
1050
1051 /* Format type specifiers for 64 bits numbers */
1052 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1053 #   if defined(__WORDSIZE) && __WORDSIZE == 64
1054 #       define I64Fd "%ld"
1055 #       define I64Fi "%li"
1056 #       define I64Fo "%lo"
1057 #       define I64Fu "%lu"
1058 #       define I64Fx "%lx"
1059 #       define I64FX "%lX"
1060 #   else
1061 #       define I64Fd "%lld"
1062 #       define I64Fi "%lli"
1063 #       define I64Fo "%llo"
1064 #       define I64Fu "%llu"
1065 #       define I64Fx "%llx"
1066 #       define I64FX "%llX"
1067 #   endif
1068 #else
1069 #   define I64Fd "%I64d"
1070 #   define I64Fi "%I64i"
1071 #   define I64Fo "%I64o"
1072 #   define I64Fu "%I64u"
1073 #   define I64Fx "%I64x"
1074 #   define I64FX "%I64X"
1075 #endif /* defined(WIN32)||defined(UNDER_CE) */
1076
1077 /* 64 bits integer constant suffix */
1078 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1079 #   if defined(__WORDSIZE) && __WORDSIZE == 64
1080 #       define I64C(x)         x##L
1081 #       define UI64C(x)        x##UL
1082 #   else
1083 #       define I64C(x)         x##LL
1084 #       define UI64C(x)        x##ULL
1085 #   endif
1086 #else
1087 #   define I64C(x)         x##i64
1088 #   define UI64C(x)        x##ui64
1089 #endif /* defined(WIN32)||defined(UNDER_CE) */
1090
1091 #if defined(WIN32) || defined(UNDER_CE)
1092 /* win32, cl and icl support */
1093 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
1094 #       define __attribute__(x)
1095 #       define __inline__      __inline
1096 #       define S_IFBLK         0x3000  /* Block */
1097 #       define S_ISBLK(m)      (0)
1098 #       define S_ISCHR(m)      (0)
1099 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
1100 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
1101 #   endif
1102
1103 /* several type definitions */
1104 #   if defined( __MINGW32__ )
1105 #       if !defined( _OFF_T_ )
1106             typedef long long _off_t;
1107             typedef _off_t off_t;
1108 #           define _OFF_T_
1109 #       else
1110 #           ifdef off_t
1111 #               undef off_t
1112 #           endif
1113 #           define off_t long long
1114 #       endif
1115 #   endif
1116
1117 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
1118 #       if !defined( _OFF_T_DEFINED )
1119             typedef __int64 off_t;
1120 #           define _OFF_T_DEFINED
1121 #       else
1122             /* for wx compatibility typedef long off_t; */
1123 #           define off_t __int64
1124 #       endif
1125 #   endif
1126
1127 #   if defined( __BORLANDC__ )
1128 #       undef off_t
1129 #       define off_t unsigned __int64
1130 #   endif
1131
1132 #   ifndef O_NONBLOCK
1133 #       define O_NONBLOCK 0
1134 #   endif
1135
1136 #   ifndef alloca
1137 #       define alloca _alloca
1138 #   endif
1139
1140     /* These two are not defined in mingw32 (bug?) */
1141 #   ifndef snprintf
1142 #       define snprintf _snprintf
1143 #   endif
1144 #   ifndef vsnprintf
1145 #       define vsnprintf _vsnprintf
1146 #   endif
1147
1148 #   include <tchar.h>
1149 #endif
1150
1151 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1152 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1153
1154 /* vlc_wraptext (defined in src/extras/libc.c) */
1155 #define wraptext vlc_wraptext
1156 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1157
1158 /* iconv wrappers (defined in src/extras/libc.c) */
1159 typedef void *vlc_iconv_t;
1160 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1161 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1162 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1163
1164 /* execve wrapper (defined in src/extras/libc.c) */
1165 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 ) );
1166 #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)
1167
1168 /*****************************************************************************
1169  * CPU capabilities
1170  *****************************************************************************/
1171 #define CPU_CAPABILITY_NONE    0
1172 #define CPU_CAPABILITY_486     (1<<0)
1173 #define CPU_CAPABILITY_586     (1<<1)
1174 #define CPU_CAPABILITY_PPRO    (1<<2)
1175 #define CPU_CAPABILITY_MMX     (1<<3)
1176 #define CPU_CAPABILITY_3DNOW   (1<<4)
1177 #define CPU_CAPABILITY_MMXEXT  (1<<5)
1178 #define CPU_CAPABILITY_SSE     (1<<6)
1179 #define CPU_CAPABILITY_SSE2    (1<<7)
1180 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1181 #define CPU_CAPABILITY_FPU     (1<<31)
1182 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1183
1184 /*****************************************************************************
1185  * I18n stuff
1186  *****************************************************************************/
1187 #ifdef WIN32
1188     VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1189 #endif
1190
1191 #if defined( ENABLE_NLS ) && \
1192      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1193       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1194       defined(MODULE_NAME_IS_pda))
1195     /* Declare nothing: gnome.h will do it for us */
1196 #elif defined( ENABLE_NLS )
1197 #   if defined( HAVE_INCLUDED_GETTEXT )
1198 #       include "libintl.h"
1199 #   else
1200 #       include <libintl.h>
1201 #   endif
1202 #   undef _
1203 #   ifdef WIN32
1204 #       define _(String) vlc_dgettext (PACKAGE_NAME, String)
1205 #   else
1206 #       define _(String) dgettext(PACKAGE_NAME, String)
1207 #   endif
1208 #   define N_(String) (String)
1209 #else
1210 #   define _(String) (String)
1211 #   define N_(String) (String)
1212 #endif
1213
1214 /*****************************************************************************
1215  * libvlc features
1216  *****************************************************************************/
1217 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1218 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1219 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1220 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1221 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1222 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1223 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1224
1225 /*****************************************************************************
1226  * Additional vlc stuff
1227  *****************************************************************************/
1228 #include "vlc_os_specific.h"
1229 #include "vlc_messages.h"
1230 #include "vlc_variables.h"
1231 #include "vlc_objects.h"
1232 #include "vlc_mtime.h"
1233 #include "vlc_threads_funcs.h"
1234 #include "vlc_modules.h"
1235 #include "main.h"
1236 #include "vlc_configuration.h"
1237
1238 /** The global thread var for msg stack context
1239  *  We store this as a static global variable so we don't need a vlc_object_t
1240  *  everywhere.
1241  *  This key is created in vlc_threads_init and is therefore ready to use at
1242  *  the very beginning of the universe */
1243 extern vlc_threadvar_t msg_context_global_key;
1244
1245
1246 #if defined( WIN32 ) || defined( UNDER_CE )
1247 #   define DIR_SEP_CHAR '\\'
1248 #   define DIR_SEP "\\"
1249 #else
1250 #   define DIR_SEP_CHAR '/'
1251 #   define DIR_SEP "/"
1252 #endif