vlc_common.h 40 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 34 35 36
#ifndef PACKAGE
/* Temporary regression test */
#error You probably forgot to include config.h!!
#endif

37
/*****************************************************************************
38
 * Required vlc headers
39 40 41
 *****************************************************************************/
#if defined( __BORLANDC__ )
#   undef HAVE_STDINT_H
42
#   undef HAVE_INTTYPES_H
Gildas Bazin's avatar
 
Gildas Bazin committed
43 44
#elif defined( _MSC_VER )
#   pragma warning( disable : 4244 )
45 46
#endif

47 48
#include "vlc_config.h"

Sam Hocevar's avatar
 
Sam Hocevar committed
49 50 51
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
52
#include <stdlib.h>
53 54
#include <stdarg.h>

55
#include <string.h>
56
#include <stdio.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
57 58 59 60

#ifdef HAVE_SYS_TYPES_H
#   include <sys/types.h>
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
61 62 63 64

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
65
#if defined( HAVE_STDINT_H )
66
#   include <stdint.h>
67 68
#elif defined( HAVE_INTTYPES_H )
#   include <inttypes.h>
69 70 71 72 73 74 75
#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
76
#else
77 78 79 80 81 82 83
    /* 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;
84 85 86
#   if defined( _MSC_VER ) \
      || defined( UNDER_CE ) \
      || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
87 88
    typedef unsigned __int64    uint64_t;
    typedef signed __int64      int64_t;
89
#   else
90 91
    typedef unsigned long long  uint64_t;
    typedef signed long long    int64_t;
92
#   endif
Sam Hocevar's avatar
Sam Hocevar committed
93 94
    typedef uint32_t            uintptr_t;
    typedef int32_t             intptr_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
95 96
#endif

97
typedef uint8_t                 byte_t;
98

99 100 101 102 103 104 105 106 107
/* 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
108 109 110 111 112 113 114 115 116 117 118 119
/* 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

120
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
121
#   include <malloc.h>
122 123 124
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
125 126
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
127 128 129 130
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
131
typedef int16_t             dctelem_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
132 133

/* Video buffer types */
134
typedef uint8_t             yuv_data_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
135

136
/* Audio volume */
137 138
typedef uint16_t            audio_volume_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
139 140 141
/**
 * High precision date or time interval
 *
142 143
 * 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
144
 * time interval is then 292271 years, which should be long enough for any
145 146
 * 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
147
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
148
 */
149
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
150

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
151
/**
152
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
153
 *
154
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
155
 */
156
typedef uint32_t vlc_fourcc_t;
157

158 159
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
160 161
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
162
#   define VLC_TWOCC( a, b ) \
163
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
164

165 166
#else
#   define VLC_FOURCC( a, b, c, d ) \
167 168
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
169
#   define VLC_TWOCC( a, b ) \
170
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
171 172

#endif
173

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
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
192 193 194 195
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

196
/* Internal types */
197 198
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
199
typedef struct variable_t variable_t;
200
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
201 202
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
203
typedef struct gc_object_t gc_object_t ;
204

205
/* Messages */
206
typedef struct msg_bank_t msg_bank_t;
207
typedef struct msg_queue_t msg_queue_t;
208
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
209

Gildas Bazin's avatar
 
Gildas Bazin committed
210
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
211 212 213 214 215 216

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
217
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
218
    PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
219 220
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
221 222 223
    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
224 225 226
} playlist_command_t;


227 228
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
229
typedef struct playlist_view_t playlist_view_t;
230
typedef struct playlist_export_t playlist_export_t;
231 232
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
233
typedef struct playlist_add_t playlist_add_t;
234
typedef struct playlist_preparse_t playlist_preparse_t;
235
typedef struct playlist_fetcher_t playlist_fetcher_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
236

237
/* Modules */
238 239 240 241
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;
242
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
243

Clément Stenac's avatar
Clément Stenac committed
244 245
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
246
/* Interface */
247 248 249 250
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;
251 252 253
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
254 255

/* Input */
256
typedef struct input_thread_t input_thread_t;
257
typedef struct input_thread_sys_t input_thread_sys_t;
258
typedef struct input_item_t input_item_t;
259
typedef struct access_t access_t;
260
typedef struct access_sys_t access_sys_t;
261 262 263
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
264
typedef struct demux_meta_t demux_meta_t;
265
typedef struct demux_sys_t demux_sys_t;
266 267 268
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;
269
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
270
typedef struct seekpoint_t seekpoint_t;
271 272
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
273
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
274

275 276 277 278
/* 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
279 280
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
281

Sam Hocevar's avatar
 
Sam Hocevar committed
282
/* Audio */
283 284
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
285
typedef struct aout_fifo_t aout_fifo_t;
286 287
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
288
typedef audio_format_t audio_sample_format_t;
289
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
290
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
291 292

/* Video */
293 294 295
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
typedef struct chroma_sys_t chroma_sys_t;
296

Gildas Bazin's avatar
 
Gildas Bazin committed
297
typedef video_format_t video_frame_format_t;
298 299 300
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
301

302
/* Subpictures */
303
typedef struct spu_t spu_t;
304 305
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
306
typedef struct subpicture_region_t subpicture_region_t;
307
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
308

309 310
typedef struct image_handler_t image_handler_t;

311 312
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
313 314
typedef struct sout_instance_sys_t sout_instance_sys_t;

315
typedef struct sout_input_t sout_input_t;
316
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
317

318
typedef struct sout_access_out_t sout_access_out_t;
319 320
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

321
typedef struct sout_mux_t sout_mux_t;
322 323
typedef struct sout_mux_sys_t sout_mux_sys_t;

324
typedef struct sout_stream_t    sout_stream_t;
325 326
typedef struct sout_stream_sys_t sout_stream_sys_t;

327
typedef struct config_chain_t       config_chain_t;
328 329 330 331 332 333
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;
334

335 336
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
337 338 339 340 341 342 343 344
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;
345
typedef struct profile_parser_t profile_parser_t;
346

Sam Hocevar's avatar
 
Sam Hocevar committed
347
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
348 349 350
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
351

Gildas Bazin's avatar
 
Gildas Bazin committed
352 353 354 355
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

356 357 358 359
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

360
/* Network */
361
typedef struct network_socket_t network_socket_t;
362
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
363 364
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
365
typedef struct vlc_acl_t vlc_acl_t;
366
typedef struct vlc_url_t vlc_url_t;
367

368 369
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
Clément Stenac's avatar
Clément Stenac committed
370
typedef struct device_t device_t;
371 372
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
373

374 375 376 377
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

378 379 380 381 382 383 384
/* 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
385
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
386 387
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
388 389 390
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
391
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 );
392 393 394
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
395 396 397 398
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

399 400 401
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
402 403 404 405 406 407
/* 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;

408 409 410
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
411
typedef struct vod_media_t vod_media_t;
412

413 414 415 416
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

417 418 419 420 421 422 423
/* 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;

424
/* VLM */
425 426
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
427 428 429

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

432
/* Stats */
433 434 435
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
436
typedef struct input_stats_t input_stats_t;
437
typedef struct global_stats_t global_stats_t;
438

439 440 441
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
442

443 444 445
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

446 447
/* stat/lstat/fstat */
#ifdef WIN32
448
#include <sys/stat.h>
449
struct _stati64;
450 451 452
#define stat _stati64
#define fstat _fstati64
/* You should otherwise use utf8_stat and utf8_lstat. */
453 454 455 456
#else
struct stat;
#endif

457 458 459 460 461 462 463 464 465
/*****************************************************************************
 * 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
466 467 468
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
469

Clément Stenac's avatar
Clément Stenac committed
470
#include "vlc_modules_macros.h"
471

472 473
#if defined (WIN32) && defined (DLL_EXPORT)
#  ifdef __cplusplus
474 475
#    define VLC_PUBLIC_API __declspec(dllexport)
#    define VLC_PRIVATE_API __declspec(dllexport)
Damien Fouilleul's avatar
Damien Fouilleul committed
476
#    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
477 478
#    define VLC_INTERNAL( type, name, args ) extern "C" type name args
#  else
479 480
#    define VLC_PUBLIC_API extern __declspec(dllexport)
#    define VLC_PRIVATE_API extern __declspec(dllexport)
Damien Fouilleul's avatar
Damien Fouilleul committed
481
#    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
482 483 484
#    define VLC_INTERNAL( type, name, args ) type name args
#  endif
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
485
#  ifdef __cplusplus
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
486
#    ifdef HAVE_ATTRIBUTE_VISIBILITY
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
487 488 489 490
#      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
491
#    else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
492 493 494
#      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
495
#    endif
496
#  else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
497
#    ifdef HAVE_ATTRIBUTE_VISIBILITY
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
498 499 500 501 502
#      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
503
#      define VLC_PUBLIC_API extern
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
504 505 506 507
#      define VLC_PRIVATE_API extern
#      define   VLC_EXPORT( type, name, args ) type name args
#      define VLC_INTERNAL( type, name, args ) type name args
#    endif
508
#  endif
Gildas Bazin's avatar
 
Gildas Bazin committed
509 510
#endif

511 512 513
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
514
#if defined( WIN32 ) || defined( UNDER_CE )
515 516
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
517 518 519 520 521
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
522 523
#endif

524 525
#include "vlc_threads.h"

526 527
typedef struct vlc_object_internals_t vlc_object_internals_t;

528 529 530 531 532 533
/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
534 535 536 537
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
538
    vlc_object_internals_t *p_internals;                                    \
539 540
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
541
    const char *psz_object_type;                                            \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
542
    const char *psz_object_name;                                            \
543
                                                                            \
544 545
    /* Messages header */                                                   \
    char *psz_header;                                                       \
546
    int  i_flags;                                                           \
547
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
548 549 550
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
551
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
552
    /* Object properties */                                                 \
553 554 555
    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 */ \
556
    vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
557
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
558
    /* Stuff related to the libvlc structure */                             \
559
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
560
                                                                            \
561 562
    vlc_object_t *  p_parent;                            /**< our parent */ \
    vlc_object_t ** pp_children;                       /**< our children */ \
563 564
    volatile int    i_children;                                             \
                                                                            \
565 566 567
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
568
    /** Just a reminder so that people don't cast garbage */                \
569
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
570
/**@}*/                                                                     \
571

572 573
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
574
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
575

576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
#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
};

591 592
#include <assert.h> /* FIXME: should not be included here */

593 594
static inline void __vlc_gc_incref( gc_object_t * p_gc )
{
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
595 596
    assert( p_gc->i_gc_refcount > 0 );

597 598 599 600 601
    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
602 603 604 605
    if( !p_gc ) return;

    assert( p_gc->i_gc_refcount > 0 );

606 607 608 609 610 611
    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
612 613 614 615 616 617 618 619 620 621
    }
}

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;
622 623 624 625
}

#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
626
#define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
627 628


Sam Hocevar's avatar
 
Sam Hocevar committed
629 630 631 632 633 634
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

635
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
636 637 638 639 640 641 642 643 644 645
#   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
646 647 648
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
649
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
650 651
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
652 653
#endif

654
static inline int64_t GCD( int64_t a, int64_t b )
655
{
656 657 658 659 660 661 662
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
663 664
}

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)

821
/* Stuff defined in src/extras/libc.c */
822
#ifndef HAVE_STRDUP
823 824
#   define strdup vlc_strdup
    VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
825
#endif
826

827
#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
828
#   define vasprintf vlc_vasprintf
829
    VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
830 831
#endif

832
#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
Gildas Bazin's avatar
 
Gildas Bazin committed
833
#   define asprintf vlc_asprintf
834
    VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
835 836
#endif

837
#ifndef HAVE_STRNDUP
838
#   if defined(STRNDUP_IN_GNOME_H) && \
839 840
        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
841 842 843 844 845
        /* 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
846 847
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
848 849 850 851 852
#ifndef HAVE_STRLCPY
#   define strlcpy vlc_strlcpy
    VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
#endif

853
#ifndef HAVE_ATOF
854 855
#   define atof vlc_atof
    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
856 857
#endif

858 859 860 861 862 863
#ifndef HAVE_STRTOF
#   ifdef HAVE_STRTOD
#       define strtof strtod
#   endif
#endif

864 865 866
#ifndef HAVE_ATOLL
#   define atoll vlc_atoll
    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
867 868 869 870 871
#endif

#ifndef HAVE_STRTOLL
#   define strtoll vlc_strtoll
    VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
872 873
#endif

874
#if defined(SYS_BEOS) \
875
 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
876 877 878 879 880 881 882 883
    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 ) );
#endif

884 885 886
#ifndef HAVE_SCANDIR
#   define scandir vlc_scandir
#   define alphasort vlc_alphasort
887
    struct dirent;
888 889
    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 ) );
890 891
#endif

892
#ifndef HAVE_GETENV
893 894
#   define getenv vlc_getenv
    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
895 896 897
#endif

#ifndef HAVE_STRCASECMP
898 899 900 901
#   ifndef HAVE_STRICMP
#       define strcasecmp vlc_strcasecmp
        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
#   else
902 903 904 905 906
#       define strcasecmp stricmp
#   endif
#endif

#ifndef HAVE_STRNCASECMP
907 908 909 910
#   ifndef HAVE_STRNICMP
#       define strncasecmp vlc_strncasecmp
        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
#   else
911 912
#       define strncasecmp strnicmp
#   endif
913 914
#endif

915
#ifndef HAVE_STRCASESTR
916 917 918 919
#   ifndef HAVE_STRISTR
#       define strcasestr vlc_strcasestr
        VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
#   else
920 921 922 923
#       define strcasestr stristr
#   endif
#endif

924
#ifndef HAVE_DIRENT_H
925
    typedef void DIR;
926 927 928 929 930 931 932 933 934 935 936 937 938
#   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
939 940 941
#   define rewinddir vlc_rewindir
#   define seekdir vlc_seekdir
#   define telldir vlc_telldir
942 943 944
    VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
    VLC_EXPORT( void *, vlc_readdir, ( void * ) );
    VLC_EXPORT( int, vlc_closedir, ( void * ) );
945 946 947
    VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
    VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
    VLC_INTERNAL( long, vlc_telldir, ( void * ) );
948 949
#endif

950 951
#if defined (WIN32)
#   include <dirent.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
952 953 954 955 956 957
 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 * ) );
958 959 960 961 962
#   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
963
#   define _wclosedir vlc_wclosedir
964 965 966
#   define rewinddir vlc_rewinddir
#   define seekdir vlc_seekdir
#   define telldir vlc_telldir
967
#endif
968

Gildas Bazin's avatar
 
Gildas Bazin committed
969
/* Format type specifiers for 64 bits numbers */
Damien Fouilleul's avatar
Damien Fouilleul committed
970
#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
#   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
986 987 988 989 990 991 992
#else
#   define I64Fd "%I64d"
#   define I64Fi "%I64i"
#   define I64Fo "%I64o"
#   define I64Fu "%I64u"
#   define I64Fx "%I64x"
#   define I64FX "%I64X"
993
#endif /* defined(WIN32)||defined(UNDER_CE) */
Gildas Bazin's avatar
 
Gildas Bazin committed
994 995

/* 64 bits integer constant suffix */
Gildas Bazin's avatar
 
Gildas Bazin committed
996
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
997 998 999 1000 1001 1002 1003
#   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
1004 1005
#else
#   define I64C(x)         x##i64
Gildas Bazin's avatar
 
Gildas Bazin committed
1006
#   define UI64C(x)        x##ui64
1007
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1008

1009
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
1010
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
1011
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1012 1013
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
1014
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
1015 1016 1017 1018 1019 1020 1021 1022 1023
#       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_ )
1024 1025
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1026 1027
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
1028 1029 1030
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
1031 1032 1033 1034
#           define off_t long long
#       endif
#   endif

1035
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1036
#       if !defined( _OFF_T_DEFINED )
1037
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1038 1039
#           define _OFF_T_DEFINED
#       else
1040
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
1041 1042 1043 1044
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
1045
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1046
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
1047
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
1048 1049
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
1050 1051
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
1052 1053 1054 1055
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
1056 1057
#   endif

1058
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1059
#   ifndef snprintf
1060 1061 1062 1063
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
1064 1065
#   endif

1066
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
1067 1068
#endif

1069
VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1070
VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1071

Gildas Bazin's avatar
 
Gildas Bazin committed
1072 1073
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
1074
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
1075

1076 1077 1078
/* iconv wrappers (defined in src/extras/libc.c) */
typedef void *vlc_iconv_t;
VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1079
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t,