vlc_common.h 42.5 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3 4
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
5
 * Copyright (C) 1998-2005 the VideoLAN team
6
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
7 8 9
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
10
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
11 12 13 14 15
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
16
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
17 18 19 20 21 22 23
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25 26
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
27
/**
Sam Hocevar's avatar
Sam Hocevar committed
28
 * \file
Clément Stenac's avatar
Clément Stenac committed
29 30 31
 * This file is a collection of common definitions and types
 */

32
/*****************************************************************************
33
 * Required vlc headers
34
 *****************************************************************************/
35 36 37 38 39 40
#if defined( __BORLANDC__ )
#   undef PACKAGE
#endif

#include "config.h"

Sam Hocevar's avatar
Sam Hocevar committed
41 42
#if defined(PACKAGE)
#   undef PACKAGE_NAME
Sam Hocevar's avatar
Sam Hocevar committed
43 44
#   define PACKAGE_NAME PACKAGE
#endif
Sam Hocevar's avatar
Sam Hocevar committed
45 46
#if defined(VERSION)
#   undef PACKAGE_VERSION
Sam Hocevar's avatar
Sam Hocevar committed
47 48 49
#   define PACKAGE_VERSION VERSION
#endif

50 51 52
#if defined( __BORLANDC__ )
#   undef HAVE_VARIADIC_MACROS
#   undef HAVE_STDINT_H
53
#   undef HAVE_INTTYPES_H
54
#   undef off_t
Gildas Bazin's avatar
 
Gildas Bazin committed
55 56
#elif defined( _MSC_VER )
#   pragma warning( disable : 4244 )
57 58
#endif

59 60
#include "vlc_config.h"

Sam Hocevar's avatar
 
Sam Hocevar committed
61 62 63
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
64
#include <stdlib.h>
65 66
#include <stdarg.h>

67
#include <string.h>
68
#include <stdio.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
69 70 71 72

#ifdef HAVE_SYS_TYPES_H
#   include <sys/types.h>
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
73 74 75 76

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
77
#if defined( HAVE_STDINT_H )
78
#   include <stdint.h>
79 80
#elif defined( HAVE_INTTYPES_H )
#   include <inttypes.h>
81 82 83 84 85 86 87
#elif defined( SYS_CYGWIN )
#   include <sys/types.h>
    /* Cygwin only defines half of these... */
    typedef u_int8_t            uint8_t;
    typedef u_int16_t           uint16_t;
    typedef u_int32_t           uint32_t;
    typedef u_int64_t           uint64_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
88
#else
89 90 91 92 93 94 95
    /* Fallback types (very x86-centric, sorry) */
    typedef unsigned char       uint8_t;
    typedef signed char         int8_t;
    typedef unsigned short      uint16_t;
    typedef signed short        int16_t;
    typedef unsigned int        uint32_t;
    typedef signed int          int32_t;
96 97 98
#   if defined( _MSC_VER ) \
      || defined( UNDER_CE ) \
      || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
99 100
    typedef unsigned __int64    uint64_t;
    typedef signed __int64      int64_t;
101
#   else
102 103
    typedef unsigned long long  uint64_t;
    typedef signed long long    int64_t;
104
#   endif
Sam Hocevar's avatar
Sam Hocevar committed
105 106
    typedef uint32_t            uintptr_t;
    typedef int32_t             intptr_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
107 108
#endif

109
typedef uint8_t                 byte_t;
110

111 112 113 114 115 116 117 118 119
/* Systems that don't have stdint.h may not define INT64_MIN and
   INT64_MAX */
#ifndef INT64_MIN
#define INT64_MIN (-9223372036854775807LL-1)
#endif
#ifndef INT64_MAX
#define INT64_MAX (9223372036854775807LL)
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
120 121 122 123 124 125 126 127 128 129 130 131
/* ptrdiff_t definition */
#ifdef HAVE_STDDEF_H
#   include <stddef.h>
#else
#   include <malloc.h>
#   ifndef _PTRDIFF_T
#       define _PTRDIFF_T
/* Not portable in a 64-bit environment. */
typedef int                 ptrdiff_t;
#   endif
#endif

132
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
133
#   include <malloc.h>
134 135 136
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
137 138
#endif

139
#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
Gildas Bazin's avatar
 
Gildas Bazin committed
140
typedef int                 ssize_t;
Xavier Marchesini's avatar
 
Xavier Marchesini committed
141 142
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
143 144 145 146
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
147
typedef int16_t             dctelem_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
148 149

/* Video buffer types */
150
typedef uint8_t             yuv_data_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
151

152
/* Audio volume */
153 154
typedef uint16_t            audio_volume_t;

155 156 157 158
#ifndef HAVE_SOCKLEN_T
typedef int                 socklen_t;
#endif

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
159 160 161
/**
 * High precision date or time interval
 *
162 163
 * Store a high precision date or time interval. The maximum precision is the
 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
Sam Hocevar's avatar
 
Sam Hocevar committed
164
 * time interval is then 292271 years, which should be long enough for any
165 166
 * video). Dates are stored as microseconds since a common date (usually the
 * epoch). Note that date and time intervals can be manipulated using regular
Sam Hocevar's avatar
 
Sam Hocevar committed
167
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
168
 */
169
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
170

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
171
/**
172
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
173
 *
174
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
175
 */
176
typedef uint32_t vlc_fourcc_t;
177

178 179
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
180 181
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
182
#   define VLC_TWOCC( a, b ) \
183
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
184

185 186
#else
#   define VLC_FOURCC( a, b, c, d ) \
187 188
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
{
#ifdef WORDS_BIGENDIAN
    psz_fourcc[0] = (uint32_t) (fcc >> 24);
    psz_fourcc[1] = (uint32_t) (fcc >> 16);
    psz_fourcc[2] = (uint32_t) (fcc >> 8);
    psz_fourcc[3] = (uint32_t) (fcc);
#else
    psz_fourcc[3] = (uint32_t) (fcc >> 24);
    psz_fourcc[2] = (uint32_t) (fcc >> 16);
    psz_fourcc[1] = (uint32_t) (fcc >> 8);
    psz_fourcc[0] = (uint32_t) (fcc);
#endif
}

#define vlc_fourcc_to_char( a, b ) \
    __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )

Sam Hocevar's avatar
 
Sam Hocevar committed
212 213 214 215
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

216
/* Internal types */
217 218
typedef struct libvlc_global_data_t libvlc_global_data_t;
typedef struct libvlc_int_t libvlc_int_t;
Sam Hocevar's avatar
Sam Hocevar committed
219
typedef struct variable_t variable_t;
220
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
221 222
typedef struct dict_entry_t dict_entry_t;
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;
Sam Hocevar's avatar
 
Sam Hocevar committed
229

Gildas Bazin's avatar
 
Gildas Bazin committed
230
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
231 232 233 234 235 236

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
237
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
238
    PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
239 240
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
241 242 243
    PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
244 245 246
} playlist_command_t;


247 248
typedef struct playlist_t playlist_t;
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 252
typedef struct services_discovery_t services_discovery_t;
typedef struct services_discovery_sys_t services_discovery_sys_t;
Clément Stenac's avatar
Clément Stenac committed
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;
Sam Hocevar's avatar
 
Sam Hocevar committed
256

257
/* Modules */
258 259 260 261
typedef struct module_bank_t module_bank_t;
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
typedef struct module_symbols_t module_symbols_t;
262
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
263

Clément Stenac's avatar
Clément Stenac committed
264 265
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
266
/* Interface */
267 268 269 270
typedef struct intf_thread_t intf_thread_t;
typedef struct intf_sys_t intf_sys_t;
typedef struct intf_console_t intf_console_t;
typedef struct intf_msg_t intf_msg_t;
271 272 273
typedef struct interaction_t interaction_t;
typedef struct interaction_dialog_t interaction_dialog_t;
typedef struct user_widget_t user_widget_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
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 282 283
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
284
typedef struct demux_meta_t demux_meta_t;
285
typedef struct demux_sys_t demux_sys_t;
286 287 288
typedef struct es_out_t     es_out_t;
typedef struct es_out_id_t  es_out_id_t;
typedef struct es_out_sys_t es_out_sys_t;
289
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
290
typedef struct seekpoint_t seekpoint_t;
291 292
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
293
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
294

295 296 297 298
/* Format */
typedef struct audio_format_t audio_format_t;
typedef struct video_format_t video_format_t;
typedef struct subs_format_t subs_format_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
299 300
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
301

Sam Hocevar's avatar
 
Sam Hocevar committed
302
/* Audio */
303 304
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
305
typedef struct aout_fifo_t aout_fifo_t;
306 307
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
308
typedef audio_format_t audio_sample_format_t;
309
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
310
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
311 312

/* Video */
313 314 315
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
typedef struct chroma_sys_t chroma_sys_t;
316

Gildas Bazin's avatar
 
Gildas Bazin committed
317
typedef video_format_t video_frame_format_t;
318 319 320
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
321

322
/* Subpictures */
323
typedef struct spu_t spu_t;
324 325
typedef struct subpicture_t subpicture_t;
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;
Sam Hocevar's avatar
 
Sam Hocevar committed
328

329 330
typedef struct image_handler_t image_handler_t;

331 332
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
333 334
typedef struct sout_instance_sys_t sout_instance_sys_t;

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 340
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

341
typedef struct sout_mux_t sout_mux_t;
342 343
typedef struct sout_mux_sys_t sout_mux_sys_t;

344
typedef struct sout_stream_t    sout_stream_t;
345 346
typedef struct sout_stream_sys_t sout_stream_sys_t;

347
typedef struct config_chain_t       config_chain_t;
348 349 350 351 352 353
typedef struct sap_session_t    sap_session_t;
typedef struct sap_address_t sap_address_t;
typedef struct session_descriptor_t session_descriptor_t;
typedef struct announce_method_t announce_method_t;
typedef struct announce_handler_t announce_handler_t;
typedef struct sap_handler_t sap_handler_t;
354

355 356
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
357 358 359 360 361 362 363 364
typedef struct sout_std_t sout_std_t;
typedef struct sout_display_t sout_display_t;
typedef struct sout_duplicate_t sout_duplicate_t;
typedef struct sout_transcode_t sout_transcode_t;
typedef struct sout_chain_t sout_chain_t;
typedef struct streaming_profile_t streaming_profile_t;
typedef struct sout_module_t sout_module_t;
typedef struct sout_gui_descr_t sout_gui_descr_t;
365
typedef struct profile_parser_t profile_parser_t;
366

Sam Hocevar's avatar
 
Sam Hocevar committed
367
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
368 369 370
typedef struct decoder_t         decoder_t;
typedef struct decoder_sys_t     decoder_sys_t;
typedef struct decoder_synchro_t decoder_synchro_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
371

Gildas Bazin's avatar
 
Gildas Bazin committed
372 373 374 375
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

376 377 378 379
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

380
/* Network */
381
typedef struct network_socket_t network_socket_t;
382
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
383 384
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
385
typedef struct vlc_acl_t vlc_acl_t;
386
typedef struct vlc_url_t vlc_url_t;
387

388 389
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
Clément Stenac's avatar
Clément Stenac committed
390
typedef struct device_t device_t;
391 392
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
393

394 395 396 397
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

398 399 400 401 402 403 404
/* httpd */
typedef struct httpd_t          httpd_t;
typedef struct httpd_host_t     httpd_host_t;
typedef struct httpd_url_t      httpd_url_t;
typedef struct httpd_client_t   httpd_client_t;
typedef struct httpd_callback_sys_t httpd_callback_sys_t;
typedef struct httpd_message_t  httpd_message_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
405
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
406 407
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
408 409 410
typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
typedef struct httpd_handler_t  httpd_handler_t;
typedef struct httpd_handler_sys_t httpd_handler_sys_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
411
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 );
412 413 414
typedef struct httpd_redirect_t httpd_redirect_t;
typedef struct httpd_stream_t httpd_stream_t;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
415 416 417 418
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

419 420 421
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
422 423 424 425 426 427
/* XML */
typedef struct xml_t xml_t;
typedef struct xml_sys_t xml_sys_t;
typedef struct xml_reader_t xml_reader_t;
typedef struct xml_reader_sys_t xml_reader_sys_t;

428 429 430
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
431
typedef struct vod_media_t vod_media_t;
432

433 434 435 436
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

437 438 439 440 441 442 443
/* osdmenu */
typedef struct osd_menu_t   osd_menu_t;
typedef struct osd_state_t  osd_state_t;
typedef struct osd_event_t  osd_event_t;
typedef struct osd_button_t osd_button_t;
typedef struct osd_menu_state_t osd_menu_state_t;

444
/* VLM */
445 446
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
447 448 449

/* divers */
typedef struct vlc_meta_t    vlc_meta_t;
Rafaël Carré's avatar
Rafaël Carré committed
450
typedef struct meta_export_t meta_export_t;
451

452
/* Stats */
453 454 455
typedef struct counter_t     counter_t;
typedef struct counter_sample_t counter_sample_t;
typedef struct stats_handler_t stats_handler_t;
Clément Stenac's avatar
Clément Stenac committed
456
typedef struct input_stats_t input_stats_t;
457
typedef struct global_stats_t global_stats_t;
458

459 460 461
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
462

463 464 465
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

466 467
/* stat/lstat/fstat */
#ifdef WIN32
468
#include <sys/stat.h>
469
struct _stati64;
470 471 472
#define stat _stati64
#define fstat _fstati64
/* You should otherwise use utf8_stat and utf8_lstat. */
473 474 475 476
#else
struct stat;
#endif

477 478 479 480 481 482 483 484 485
/*****************************************************************************
 * Variable callbacks
 *****************************************************************************/
typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
                                   char const *,            /* variable name */
                                   vlc_value_t,                 /* old value */
                                   vlc_value_t,                 /* new value */
                                   void * );                /* callback data */

Gildas Bazin's avatar
 
Gildas Bazin committed
486 487 488
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
489

Clément Stenac's avatar
Clément Stenac committed
490
#include "vlc_modules_macros.h"
491

492 493
#if defined (WIN32) && defined (DLL_EXPORT)
#  ifdef __cplusplus
494 495
#    define VLC_PUBLIC_API __declspec(dllexport)
#    define VLC_PRIVATE_API __declspec(dllexport)
Damien Fouilleul's avatar
Damien Fouilleul committed
496
#    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
497 498
#    define VLC_INTERNAL( type, name, args ) extern "C" type name args
#  else
499 500
#    define VLC_PUBLIC_API extern __declspec(dllexport)
#    define VLC_PRIVATE_API extern __declspec(dllexport)
Damien Fouilleul's avatar
Damien Fouilleul committed
501
#    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
502 503 504
#    define VLC_INTERNAL( type, name, args ) type name args
#  endif
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
505 506 507 508 509 510
#  ifdef __cplusplus
#    if HAVE_ATTRIBUTE_VISIBILITY
#      define VLC_PUBLIC_API __attribute__((visibility("default")))
#      define VLC_PRIVATE_API __attribute__((visibility("default")))
#      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
#      define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
Damien Fouilleul's avatar
Damien Fouilleul committed
511
#    else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
512 513 514
#      define VLC_PUBLIC_API
#      define   VLC_EXPORT( type, name, args ) extern "C" type name args
#      define VLC_INTERNAL( type, name, args ) extern "C" type name args
Damien Fouilleul's avatar
Damien Fouilleul committed
515
#    endif
516
#  else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
517 518 519 520 521 522
#    if HAVE_ATTRIBUTE_VISIBILITY
#      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
#      define VLC_PRIVATE_API extern __attribute__((visibility("default")))
#      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
#      define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
#    else
523
#      define VLC_PUBLIC_API extern
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
524 525 526 527
#      define VLC_PRIVATE_API extern
#      define   VLC_EXPORT( type, name, args ) type name args
#      define VLC_INTERNAL( type, name, args ) type name args
#    endif
528
#  endif
Gildas Bazin's avatar
 
Gildas Bazin committed
529 530
#endif

531 532 533
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
534
#if defined( WIN32 ) || defined( UNDER_CE )
535 536
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
537 538 539 540 541
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
542 543
#endif

544 545
#include "vlc_threads.h"

546 547
typedef struct vlc_object_internals_t vlc_object_internals_t;

548 549 550 551 552 553
/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
554 555 556 557
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
558
    vlc_object_internals_t *p_internals;                                    \
559 560
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
561
    const char *psz_object_type;                                            \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
562
    const char *psz_object_name;                                            \
563
                                                                            \
564 565
    /* Messages header */                                                   \
    char *psz_header;                                                       \
566
    int  i_flags;                                                           \
567
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
568 569 570
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
571
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
572
    /* Object properties */                                                 \
573 574 575
    volatile vlc_bool_t b_error;                  /**< set by the object */ \
    volatile vlc_bool_t b_die;                   /**< set by the outside */ \
    volatile vlc_bool_t b_dead;                   /**< set by the object */ \
576
    vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
577
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
578
    /* Stuff related to the libvlc structure */                             \
579
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
580
                                                                            \
581 582
    vlc_object_t *  p_parent;                            /**< our parent */ \
    vlc_object_t ** pp_children;                       /**< our children */ \
583 584
    volatile int    i_children;                                             \
                                                                            \
585 586 587
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
588
    /** Just a reminder so that people don't cast garbage */                \
589
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
590
/**@}*/                                                                     \
591

592 593
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
594
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
595

596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
#define VLC_GC_MEMBERS                                                       \
/** \name VLC_GC_MEMBERS                                                     \
 * these members are common to all objects that wish to be garbage-collected \
 */                                                                          \
/**@{*/                                                                      \
    int i_gc_refcount;                                                       \
    void (*pf_destructor) ( gc_object_t * );                                 \
    void *p_destructor_arg;                                                  \
/**@}*/

struct gc_object_t
{
            VLC_GC_MEMBERS
};

static inline void __vlc_gc_incref( gc_object_t * p_gc )
{
    p_gc->i_gc_refcount ++;
};

static inline void __vlc_gc_decref( gc_object_t *p_gc )
{
    p_gc->i_gc_refcount -- ;

    if( p_gc->i_gc_refcount == 0 )
    {
        p_gc->pf_destructor( p_gc );
        /* Do not use the p_gc pointer from now on ! */
     }
}

#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
#define vlc_gc_init( a,b,c ) {  ((gc_object_t *)a)->i_gc_refcount = 0; \
                              ((gc_object_t *)a)->pf_destructor = b; \
                              ((gc_object_t *)a)->p_destructor_arg = c; }


Sam Hocevar's avatar
 
Sam Hocevar committed
634 635 636 637 638 639
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

640
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
641 642 643 644 645 646 647 648 649 650
#   include <netinet/in.h>

#endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */

/* CEIL: division with round to nearest greater integer */
#define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )

/* PAD: PAD(n, d) = CEIL(n ,d) * d */
#define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )

Sam Hocevar's avatar
 
Sam Hocevar committed
651 652 653
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
654
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
655 656
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
657 658
#endif

659 660 661 662 663 664
static int64_t GCD( int64_t a, int64_t b )
{
    if( b ) return GCD( b, a % b );
    else return a;
}

665 666 667 668 669 670 671
/* function imported from libavutil/common.h */
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

672
/* Malloc with automatic error */
673 674 675 676 677 678 679 680
#define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return; } while(0)
#define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return NULL; } while(0)
#define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return VLC_ENOMEM; } while(0)
#define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                      if( !var ) goto error; } while(0)
681 682
#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return;
683
#define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
684
                                    if( !var ) return VLC_ENOMEM;
685 686 687
#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return NULL;

688
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
Clément Stenac's avatar
Clément Stenac committed
689

690 691
#define EMPTY_STR(str) (!str || !*str)

Clément Stenac's avatar
Clément Stenac committed
692 693
VLC_EXPORT( char const *, vlc_error, ( int ) );

694
#include <vlc_arrays.h>
695

Sam Hocevar's avatar
 
Sam Hocevar committed
696 697 698
/* MSB (big endian)/LSB (little endian) conversions - network order is always
 * MSB, and should be used for both network communications and files. Note that
 * byte orders other than little and big endians are not supported, but only
699
 * the VAX seems to have such exotic properties. */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
700
static inline uint16_t U16_AT( const void * _p )
701
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
702
    const uint8_t * p = (const uint8_t *)_p;
703
    return ( ((uint16_t)p[0] << 8) | p[1] );
704
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
705
static inline uint32_t U32_AT( const void * _p )
706
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
707
    const uint8_t * p = (const uint8_t *)_p;
708 709
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
710
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
711
static inline uint64_t U64_AT( const void * _p )
712
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
713
    const uint8_t * p = (const uint8_t *)_p;
714 715 716 717
    return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
              | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
              | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
              | ((uint64_t)p[6] << 8) | p[7] );
718
}
719

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
720
static inline uint16_t GetWLE( const void * _p )
721
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
722
    const uint8_t * p = (const uint8_t *)_p;
723 724
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
725
static inline uint32_t GetDWLE( const void * _p )
726
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
727
    const uint8_t * p = (const uint8_t *)_p;
728 729 730
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
731
static inline uint64_t GetQWLE( const void * _p )
732
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
733
    const uint8_t * p = (const uint8_t *)_p;
734 735 736 737 738 739 740 741 742 743
    return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
              | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
              | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
              | ((uint64_t)p[1] << 8) | p[0] );
}

#define GetWBE( p )     U16_AT( p )
#define GetDWBE( p )    U32_AT( p )
#define GetQWBE( p )    U64_AT( p )

Gildas Bazin's avatar
 
Gildas Bazin committed
744
/* Helper writer functions */
745
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
746 747 748 749 750 751
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

752
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
753 754 755 756 757 758 759
static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
{
    p[3] = ( i_dw >> 24 )&0xff;
    p[2] = ( i_dw >> 16 )&0xff;
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}
760
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
761 762 763 764 765
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
766
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
767 768 769 770 771 772
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

773
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
774 775 776 777 778 779 780
static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
{
    p[0] = ( i_dw >> 24 )&0xff;
    p[1] = ( i_dw >> 16 )&0xff;
    p[2] = ( i_dw >>  8 )&0xff;
    p[3] = ( i_dw       )&0xff;
}
781
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
782 783 784 785 786
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
787

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
788
#ifdef WORDS_BIGENDIAN
789 790
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
791
#   define hton64(i)   ( i )
792 793
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
794 795
#   define ntoh64(i)   ( i )
#else
796 797 798 799 800 801
#   define hton16(i)   U16_AT(&i)
#   define hton32(i)   U32_AT(&i)
#   define hton64(i)   U64_AT(&i)
#   define ntoh16(i)   U16_AT(&i)
#   define ntoh32(i)   U32_AT(&i)
#   define ntoh64(i)   U64_AT(&i)
Sam Hocevar's avatar
 
Sam Hocevar committed
802 803
#endif

804 805 806 807 808 809 810
/* Format string sanity checks */
#ifdef HAVE_ATTRIBUTE_FORMAT
#   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
#else
#   define ATTRIBUTE_FORMAT(x,y)
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
811 812 813 814 815 816 817
/* Alignment of critical static data structures */
#ifdef ATTRIBUTE_ALIGNED_MAX
#   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
#else
#   define ATTR_ALIGN(align)
#endif

818 819 820
/* */
#define VLC_UNUSED(x) (void)(x)

Gildas Bazin's avatar
 
Gildas Bazin committed
821 822 823 824 825 826 827 828 829 830 831 832
/* Alignment of critical dynamic data structure
 *
 * Not all platforms support memalign so we provide a vlc_memalign wrapper
 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 * *pp_orig is the pointer that has to be freed afterwards.
 */
#if 0
#ifdef HAVE_POSIX_MEMALIGN
#   define vlc_memalign(align,size,pp_orig) \
    ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
#endif
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
833 834 835
#ifdef HAVE_MEMALIGN
    /* Some systems have memalign() but no declaration for it */
    void * memalign( size_t align, size_t size );
Gildas Bazin's avatar
 
Gildas Bazin committed
836

837
#   define vlc_memalign(pp_orig,align,size) \
Gildas Bazin's avatar
 
Gildas Bazin committed
838 839 840
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
841 842 843
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
844
                       & (~(unsigned long)(align-1)) ) \
845
        : NULL )
Gildas Bazin's avatar
 
Gildas Bazin committed
846

Sam Hocevar's avatar
 
Sam Hocevar committed
847 848
#endif

849
/* Stuff defined in src/extras/libc.c */
850
#ifndef HAVE_STRDUP
851 852 853 854
#   define strdup vlc_strdup
    VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
#elif !defined(__PLUGIN__)
#   define vlc_strdup NULL
855
#endif
856

857
#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
858
#   define vasprintf vlc_vasprintf
859
    VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
860 861 862 863
#elif !defined(__PLUGIN__)
#   define vlc_vasprintf NULL
#endif

864
#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
Gildas Bazin's avatar
 
Gildas Bazin committed
865
#   define asprintf vlc_asprintf
866
    VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
867 868 869 870
#elif !defined(__PLUGIN__)
#   define vlc_asprintf NULL
#endif

871
#ifndef HAVE_STRNDUP
872
#   if defined(STRNDUP_IN_GNOME_H) && \
873 874
        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
875 876 877 878 879
        /* Do nothing: gnome.h defines strndup for us */
#   else
#       define strndup vlc_strndup
        VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
#   endif
880 881
#elif !defined(__PLUGIN__)
#   define vlc_strndup NULL
882 883
#endif

884 885 886 887 888 889 890
#ifndef HAVE_STRNLEN
#   define strnlen vlc_strnlen
    VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
#elif !defined(__PLUGIN__)
#   define vlc_strnlen NULL
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
891 892 893 894 895 896 897
#ifndef HAVE_STRLCPY
#   define strlcpy vlc_strlcpy
    VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
#elif !defined(__PLUGIN__)
#   define vlc_strlcpy NULL
#endif

898
#ifndef HAVE_ATOF
899 900 901 902
#   define atof vlc_atof
    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atof NULL
903 904
#endif

905 906 907 908 909 910
#ifndef HAVE_STRTOF
#   ifdef HAVE_STRTOD
#       define strtof strtod
#   endif
#endif

911 912 913 914 915
#ifndef HAVE_ATOLL
#   define atoll vlc_atoll
    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atoll NULL
916 917 918 919 920 921 922
#endif

#ifndef HAVE_STRTOLL
#   define strtoll vlc_strtoll
    VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
#elif !defined(__PLUGIN__)
#   define vlc_strtoll NULL
923 924
#endif

925
#if defined(SYS_BEOS) \
926
 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
927 928 929 930 931 932 933 934 935 936
    typedef struct {
        long long quot; /* Quotient. */
        long long rem;  /* Remainder. */
    } lldiv_t;
#   define lldiv vlc_lldiv
    VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
#elif !defined(__PLUGIN__)
#   define vlc_lldiv NULL
#endif

937 938 939
#ifndef HAVE_SCANDIR
#   define scandir vlc_scandir
#   define alphasort vlc_alphasort
940
    struct dirent;
941 942
    VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
    VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
943 944 945 946 947
#elif !defined(__PLUGIN__)
#   define vlc_scandir NULL
#   define vlc_alphasort NULL
#endif

948
#ifndef HAVE_GETENV
949 950 951 952
#   define getenv vlc_getenv
    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
#elif !defined(__PLUGIN__)
#   define vlc_getenv NULL
953 954 955
#endif

#ifndef HAVE_STRCASECMP
956 957 958 959
#   ifndef HAVE_STRICMP
#       define strcasecmp vlc_strcasecmp
        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
#   else
960
#       define strcasecmp stricmp
Gildas Bazin's avatar
 
Gildas Bazin committed
961 962 963
#       if !defined(__PLUGIN__)
#           define vlc_strcasecmp NULL
#       endif
964
#   endif
965 966
#elif !defined(__PLUGIN__)
#   define vlc_strcasecmp NULL
967 968 969
#endif

#ifndef HAVE_STRNCASECMP
970 971 972 973
#   ifndef HAVE_STRNICMP
#       define strncasecmp vlc_strncasecmp
        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
#   else
974
#       define strncasecmp strnicmp
Gildas Bazin's avatar
 
Gildas Bazin committed
975 976 977
#       if !defined(__PLUGIN__)
#           define vlc_strncasecmp NULL
#       endif
978
#   endif
979 980
#elif !defined(__PLUGIN__)
#   define vlc_strncasecmp NULL
981 982
#endif

983
#ifndef HAVE_STRCASESTR
984 985 986 987
#   ifndef HAVE_STRISTR
#       define strcasestr vlc_strcasestr
        VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
#   else
988 989 990 991 992 993 994 995 996
#       define strcasestr stristr
#       if !defined(__PLUGIN__)
#           define vlc_strcasestr NULL
#       endif
#   endif
#elif !defined(__PLUGIN__)
#   define vlc_strcasestr NULL
#endif

997
#ifndef HAVE_DIRENT_H
998
    typedef void DIR;
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
#   ifndef FILENAME_MAX
#       define FILENAME_MAX (260)
#   endif
    struct dirent
    {
        long            d_ino;          /* Always zero. */
        unsigned short  d_reclen;       /* Always zero. */
        unsigned short  d_namlen;       /* Length of name in d_name. */
        char            d_name[FILENAME_MAX]; /* File name. */
    };
#   define opendir vlc_opendir
#   define readdir vlc_readdir
#   define closedir vlc_closedir
1012 1013 1014
#   define rewinddir vlc_rewindir
#   define seekdir vlc_seekdir
#   define telldir vlc_telldir
1015 1016 1017
    VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
    VLC_EXPORT( void *, vlc_readdir, ( void * ) );
    VLC_EXPORT( int, vlc_closedir, ( void * ) );
1018 1019 1020
    VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
    VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
    VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1021 1022 1023 1024 1025 1026
#else
#   if !defined(__PLUGIN__)
#       define vlc_opendir  NULL
#       define vlc_readdir  NULL
#       define vlc_closedir NULL
#   endif
1027 1028
#endif

1029 1030
#if defined (WIN32)
#   include <dirent.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1031 1032 1033 1034 1035 1036
 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1037 1038 1039 1040 1041
#   define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
#   define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
#   define closedir vlc_wclosedir
#   define _wopendir vlc_wopendir
#   define _wreaddir vlc_wreaddir
1042
#   define _wclosedir vlc_wclosedir
1043 1044 1045
#   define rewinddir vlc_rewinddir
#   define seekdir vlc_seekdir
#   define telldir vlc_telldir
1046 1047
#elif !defined(__PLUGIN__)
#   define vlc_wclosedir NULL
1048
#endif
1049

Gildas Bazin's avatar
 
Gildas Bazin committed
1050
/* Format type specifiers for 64 bits numbers */
Damien Fouilleul's avatar
Damien Fouilleul committed
1051
#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
#   if defined(__WORDSIZE) && __WORDSIZE == 64
#       define I64Fd "%ld"
#       define I64Fi "%li"
#       define I64Fo "%lo"
#       define I64Fu "%lu"
#       define I64Fx "%lx"
#       define I64FX "%lX"
#   else
#       define I64Fd "%lld"
#       define I64Fi "%lli"
#       define I64Fo "%llo"
#       define I64Fu "%llu"
#       define I64Fx "%llx"
#       define I64FX "%llX"
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
1067 1068 1069 1070 1071 1072 1073
#else
#   define I64Fd "%I64d"
#   define I64Fi "%I64i"
#   define I64Fo "%I64o"
#   define I64Fu "%I64u"
#   define I64Fx "%I64x"
#   define I64FX "%I64X"
1074
#endif /* defined(WIN32)||defined(UNDER_CE) */
Gildas Bazin's avatar
 
Gildas Bazin committed
1075 1076

/* 64 bits integer constant suffix */
Gildas Bazin's avatar
 
Gildas Bazin committed
1077
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1078 1079 1080 1081 1082 1083 1084
#   if defined(__WORDSIZE) && __WORDSIZE == 64
#       define I64C(x)         x##L
#       define UI64C(x)        x##UL
#   else
#       define I64C(x)         x##LL
#       define UI64C(x)        x##ULL
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
1085 1086
#else
#   define I64C(x)         x##i64
Gildas Bazin's avatar
 
Gildas Bazin committed
1087
#   define UI64C(x)        x##ui64
1088
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1089

1090
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
1091
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
1092
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1093 1094
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
1095
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
1096 1097 1098 1099 1100 1101 1102 1103 1104
#       define S_ISBLK(m)      (0)
#       define S_ISCHR(m)      (0)
#       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
#       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
#   endif

/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
1105 1106
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1107 1108
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
1109 1110 1111
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
1112 1113 1114 1115
#           define off_t long long
#       endif
#   endif

1116
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1117
#       if !defined( _OFF_T_DEFINED )
1118
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1119 1120
#           define _OFF_T_DEFINED
#       else
1121
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed