vlc_common.h 42.7 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
#include <stdarg.h>
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
66
#include <assert.h>
67

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

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

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
78
#if defined( HAVE_STDINT_H )
79
#   include <stdint.h>
80 81
#elif defined( HAVE_INTTYPES_H )
#   include <inttypes.h>
82 83 84 85 86 87 88
#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
89
#else
90 91 92 93 94 95 96
    /* 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;
97 98 99
#   if defined( _MSC_VER ) \
      || defined( UNDER_CE ) \
      || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
100 101
    typedef unsigned __int64    uint64_t;
    typedef signed __int64      int64_t;
102
#   else
103 104
    typedef unsigned long long  uint64_t;
    typedef signed long long    int64_t;
105
#   endif
Sam Hocevar's avatar
Sam Hocevar committed
106 107
    typedef uint32_t            uintptr_t;
    typedef int32_t             intptr_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
108 109
#endif

110
typedef uint8_t                 byte_t;
111

112 113 114 115 116 117 118 119 120
/* 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
121 122 123 124 125 126 127 128 129 130 131 132
/* 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

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

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

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

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

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

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

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

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
160 161 162
/**
 * High precision date or time interval
 *
163 164
 * 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
165
 * time interval is then 292271 years, which should be long enough for any
166 167
 * 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
168
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
169
 */
170
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
171

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

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

186 187
#else
#   define VLC_FOURCC( a, b, c, d ) \
188 189
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
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
213 214 215 216
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

217
/* Internal types */
218 219
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
220
typedef struct variable_t variable_t;
221
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
222 223
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
224
typedef struct gc_object_t gc_object_t ;
225

226
/* Messages */
227
typedef struct msg_bank_t msg_bank_t;
228
typedef struct msg_queue_t msg_queue_t;
229
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
230

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

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
238
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
239
    PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
240 241
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
242 243 244
    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
245 246 247
} playlist_command_t;


248 249
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
250
typedef struct playlist_view_t playlist_view_t;
251
typedef struct playlist_export_t playlist_export_t;
252 253
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
254
typedef struct playlist_add_t playlist_add_t;
255
typedef struct playlist_preparse_t playlist_preparse_t;
256
typedef struct playlist_fetcher_t playlist_fetcher_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
257

258
/* Modules */
259 260 261 262
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;
263
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
264

265 266
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
267
/* Interface */
268 269 270 271
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;
272 273 274
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
275 276

/* Input */
277
typedef struct input_thread_t input_thread_t;
278
typedef struct input_thread_sys_t input_thread_sys_t;
279
typedef struct input_item_t input_item_t;
280
typedef struct access_t access_t;
281
typedef struct access_sys_t access_sys_t;
282 283 284
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
285
typedef struct demux_meta_t demux_meta_t;
286
typedef struct demux_sys_t demux_sys_t;
287 288 289
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;
290
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
291
typedef struct seekpoint_t seekpoint_t;
292 293
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
294
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
295

296 297 298 299
/* 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
300 301
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
302

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

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

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

323
/* Subpictures */
324
typedef struct spu_t spu_t;
325 326
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
327
typedef struct subpicture_region_t subpicture_region_t;
328
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
329

330 331
typedef struct image_handler_t image_handler_t;

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

336
typedef struct sout_input_t sout_input_t;
337
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
338

339
typedef struct sout_access_out_t sout_access_out_t;
340 341
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

342
typedef struct sout_mux_t sout_mux_t;
343 344
typedef struct sout_mux_sys_t sout_mux_sys_t;

345
typedef struct sout_stream_t    sout_stream_t;
346 347
typedef struct sout_stream_sys_t sout_stream_sys_t;

348
typedef struct config_chain_t       config_chain_t;
349 350 351 352 353 354
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;
355

356 357
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
358 359 360 361 362 363 364 365
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;
366
typedef struct profile_parser_t profile_parser_t;
367

Sam Hocevar's avatar
 
Sam Hocevar committed
368
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
369 370 371
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
372

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

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

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

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

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

399 400 401 402 403 404 405
/* 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
406
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
407 408
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
409 410 411
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
412
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 );
413 414 415
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
416 417 418 419
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

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

Gildas Bazin's avatar
Gildas Bazin committed
423 424 425 426 427 428
/* 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;

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

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

438 439 440 441 442 443 444
/* 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;

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

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

453
/* Stats */
454 455 456
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
457
typedef struct input_stats_t input_stats_t;
458
typedef struct global_stats_t global_stats_t;
459

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

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

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

478 479 480 481 482 483 484 485 486
/*****************************************************************************
 * 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
487 488 489
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
490

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

493 494
#if defined (WIN32) && defined (DLL_EXPORT)
#  ifdef __cplusplus
495 496
#    define VLC_PUBLIC_API __declspec(dllexport)
#    define VLC_PRIVATE_API __declspec(dllexport)
497
#    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
498 499
#    define VLC_INTERNAL( type, name, args ) extern "C" type name args
#  else
500 501
#    define VLC_PUBLIC_API extern __declspec(dllexport)
#    define VLC_PRIVATE_API extern __declspec(dllexport)
502
#    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
503 504 505
#    define VLC_INTERNAL( type, name, args ) type name args
#  endif
#else
506 507 508 509 510 511
#  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
512
#    else
513 514 515
#      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
516
#    endif
517
#  else
518 519 520 521 522 523
#    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
524
#      define VLC_PUBLIC_API extern
525 526 527 528
#      define VLC_PRIVATE_API extern
#      define   VLC_EXPORT( type, name, args ) type name args
#      define VLC_INTERNAL( type, name, args ) type name args
#    endif
529
#  endif
Gildas Bazin's avatar
 
Gildas Bazin committed
530 531
#endif

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

545 546
#include "vlc_threads.h"

547 548
typedef struct vlc_object_internals_t vlc_object_internals_t;

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

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

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

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
#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 )
{
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
614 615
    assert( p_gc->i_gc_refcount > 0 );

616 617 618 619 620
    p_gc->i_gc_refcount ++;
};

static inline void __vlc_gc_decref( gc_object_t *p_gc )
{
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
621 622 623 624
    if( !p_gc ) return;

    assert( p_gc->i_gc_refcount > 0 );

625 626 627 628 629 630
    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 ! */
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
631 632 633 634 635 636 637 638 639 640
    }
}

static inline void
__vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
               void * arg)
{
    p_gc->i_gc_refcount = 1;
    p_gc->pf_destructor = pf_destructor;
    p_gc->p_destructor_arg = arg;
641 642 643 644
}

#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
645
#define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
646 647


Sam Hocevar's avatar
 
Sam Hocevar committed
648 649 650 651 652 653
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

654
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
655 656 657 658 659 660 661 662 663 664
#   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
665 666 667
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
668
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
669 670
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
671 672
#endif

673 674 675 676 677 678
static int64_t GCD( int64_t a, int64_t b )
{
    if( b ) return GCD( b, a % b );
    else return a;
}

679 680 681 682 683 684 685
/* 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;
}

686
/* Malloc with automatic error */
687 688 689 690 691 692 693 694
#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)
695 696
#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return;
697
#define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
698
                                    if( !var ) return VLC_ENOMEM;
699 700 701
#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return NULL;

702
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
703

704 705
#define EMPTY_STR(str) (!str || !*str)

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

708
#include <vlc_arrays.h>
709

Sam Hocevar's avatar
 
Sam Hocevar committed
710 711 712
/* 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
713
 * the VAX seems to have such exotic properties. */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
714
static inline uint16_t U16_AT( const void * _p )
715
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
716
    const uint8_t * p = (const uint8_t *)_p;
717
    return ( ((uint16_t)p[0] << 8) | p[1] );
718
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
719
static inline uint32_t U32_AT( const void * _p )
720
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
721
    const uint8_t * p = (const uint8_t *)_p;
722 723
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
724
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
725
static inline uint64_t U64_AT( 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 731
    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] );
732
}
733

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
734
static inline uint16_t GetWLE( const void * _p )
735
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
736
    const uint8_t * p = (const uint8_t *)_p;
737 738
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
739
static inline uint32_t GetDWLE( const void * _p )
740
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
741
    const uint8_t * p = (const uint8_t *)_p;
742 743 744
    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
745
static inline uint64_t GetQWLE( const void * _p )
746
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
747
    const uint8_t * p = (const uint8_t *)_p;
748 749 750 751 752 753 754 755 756 757
    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
758
/* Helper writer functions */
759
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
760 761 762 763 764 765
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

766
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
767 768 769 770 771 772 773
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;
}
774
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
775 776 777 778 779
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
780
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
781 782 783 784 785 786
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

787
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
788 789 790 791 792 793 794
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;
}
795
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
796 797 798 799 800
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
801

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
802
#ifdef WORDS_BIGENDIAN
803 804
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
805
#   define hton64(i)   ( i )
806 807
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
808 809
#   define ntoh64(i)   ( i )
#else
810 811 812 813 814 815
#   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
816 817
#endif

818 819 820 821 822 823 824
/* 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
825 826 827 828 829 830 831
/* 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

832 833 834
/* */
#define VLC_UNUSED(x) (void)(x)

Gildas Bazin's avatar
 
Gildas Bazin committed
835 836 837 838 839 840 841 842 843 844 845 846
/* 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
847 848 849
#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
850

851
#   define vlc_memalign(pp_orig,align,size) \
Gildas Bazin's avatar
 
Gildas Bazin committed
852 853 854
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
855 856 857
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
858
                       & (~(unsigned long)(align-1)) ) \
859
        : NULL )
Gildas Bazin's avatar
 
Gildas Bazin committed
860

Sam Hocevar's avatar
 
Sam Hocevar committed
861 862
#endif

863
/* Stuff defined in src/extras/libc.c */
864
#ifndef HAVE_STRDUP
865 866 867 868
#   define strdup vlc_strdup
    VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
#elif !defined(__PLUGIN__)
#   define vlc_strdup NULL
869
#endif
870

871
#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
872
#   define vasprintf vlc_vasprintf
873
    VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
874 875 876 877
#elif !defined(__PLUGIN__)
#   define vlc_vasprintf NULL
#endif

878
#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
Gildas Bazin's avatar
 
Gildas Bazin committed
879
#   define asprintf vlc_asprintf
880
    VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
881 882 883 884
#elif !defined(__PLUGIN__)
#   define vlc_asprintf NULL
#endif

885
#ifndef HAVE_STRNDUP
886
#   if defined(STRNDUP_IN_GNOME_H) && \
887 888
        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
889 890 891 892 893
        /* 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
894 895
#elif !defined(__PLUGIN__)
#   define vlc_strndup NULL
896 897
#endif

898 899 900 901 902 903 904
#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
905 906 907 908 909 910 911
#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

912
#ifndef HAVE_ATOF
913 914 915 916
#   define atof vlc_atof
    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atof NULL
917 918
#endif

919 920 921 922 923 924
#ifndef HAVE_STRTOF
#   ifdef HAVE_STRTOD
#       define strtof strtod
#   endif
#endif

925 926 927 928 929
#ifndef HAVE_ATOLL
#   define atoll vlc_atoll
    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atoll NULL
930 931 932 933 934 935 936
#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
937 938
#endif

939
#if defined(SYS_BEOS) \
940
 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
941 942 943 944 945 946 947 948 949 950
    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

951 952 953
#ifndef HAVE_SCANDIR
#   define scandir vlc_scandir
#   define alphasort vlc_alphasort
954
    struct dirent;
955 956
    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 ) );
957 958 959 960 961
#elif !defined(__PLUGIN__)
#   define vlc_scandir NULL
#   define vlc_alphasort NULL
#endif

962
#ifndef HAVE_GETENV
963 964 965 966
#   define getenv vlc_getenv
    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
#elif !defined(__PLUGIN__)
#   define vlc_getenv NULL
967 968 969
#endif

#ifndef HAVE_STRCASECMP
970 971 972 973
#   ifndef HAVE_STRICMP
#       define strcasecmp vlc_strcasecmp
        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
#   else
974
#       define strcasecmp stricmp
Gildas Bazin's avatar
 
Gildas Bazin committed
975 976 977
#       if !defined(__PLUGIN__)
#           define vlc_strcasecmp NULL
#       endif
978
#   endif
979 980
#elif !defined(__PLUGIN__)
#   define vlc_strcasecmp NULL
981 982 983
#endif

#ifndef HAVE_STRNCASECMP
984 985 986 987
#   ifndef HAVE_STRNICMP
#       define strncasecmp vlc_strncasecmp
        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
#   else
988
#       define strncasecmp strnicmp
Gildas Bazin's avatar
 
Gildas Bazin committed
989 990 991
#       if !defined(__PLUGIN__)
#           define vlc_strncasecmp NULL
#       endif
992
#   endif
993 994
#elif !defined(__PLUGIN__)
#   define vlc_strncasecmp NULL
995 996
#endif

997
#ifndef HAVE_STRCASESTR
998 999 1000 1001
#   ifndef HAVE_STRISTR
#       define strcasestr vlc_strcasestr
        VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
#   else
1002 1003 1004 1005 1006 1007 1008 1009 1010
#       define strcasestr stristr
#       if !defined(__PLUGIN__)
#           define vlc_strcasestr NULL
#       endif
#   endif
#elif !defined(__PLUGIN__)
#   define vlc_strcasestr NULL
#endif

1011
#ifndef HAVE_DIRENT_H
1012
    typedef void DIR;
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
#   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
1026 1027 1028
#   define rewinddir vlc_rewindir
#   define seekdir vlc_seekdir
#   define telldir vlc_telldir
1029 1030 1031
    VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
    VLC_EXPORT( void *, vlc_readdir, ( void * ) );
    VLC_EXPORT( int, vlc_closedir, ( void * ) );
1032 1033 1034
    VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
    VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
    VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1035 1036 1037 1038 1039 1040
#else
#   if !defined(__PLUGIN__)
#       define vlc_opendir  NULL
#       define vlc_readdir  NULL
#       define vlc_closedir NULL
#   endif
1041 1042
#endif

1043 1044
#if defined (WIN32)
#   include <dirent.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1045 1046 1047 1048 1049 1050
 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 * ) );
1051 1052 1053 1054 1055
#   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
1056
#   define _wclosedir vlc_wclosedir
1057 1058 1059
#   define rewinddir vlc_rewinddir
#   define seekdir vlc_seekdir
#   define telldir vlc_telldir
1060 1061
#elif !defined(__PLUGIN__)
#   define vlc_wclosedir NULL
1062
#endif
1063

Gildas Bazin's avatar
 
Gildas Bazin committed
1064
/* Format type specifiers for 64 bits numbers */
Damien Fouilleul's avatar
Damien Fouilleul committed
1065
#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
#   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
1081 1082 1083 1084 1085 1086 1087
#else
#   define I64Fd "%I64d"
#   define I64Fi "%I64i"
#   define I64Fo "%I64o"
#   define I64Fu "%I64u"
#   define I64Fx "%I64x"
#   define I64FX "%I64X"
1088
#endif /* defined(WIN32)||defined(UNDER_CE) */
Gildas Bazin's avatar
 
Gildas Bazin committed
1089 1090

/* 64 bits integer constant suffix */
Gildas Bazin's avatar
 
Gildas Bazin committed
1091
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1092 1093 1094 1095 1096 1097 1098
#   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
1099 1100
#else
#   define I64C(x)         x##i64
Gildas Bazin's avatar
 
Gildas Bazin committed
1101
#   define UI64C(x)        x##ui64
1102
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1103

1104
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
1105
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
1106
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1107 1108
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
1109
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
1110 1111 1112 1113 1114 1115 1116 1117 1118
#       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_ )
Gildas Bazin's avatar