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