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