vlc_common.h 40.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 66
#include <stdarg.h>

Sam Hocevar's avatar
 
Sam Hocevar committed
67 68 69 70 71 72 73
#ifdef HAVE_STRING_H
#   include <string.h>                                         /* strerror() */
#endif

#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

Sam Hocevar's avatar
 
Sam Hocevar committed
195 196 197 198
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

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

208
/* Messages */
209
typedef struct msg_bank_t msg_bank_t;
210
typedef struct msg_queue_t msg_queue_t;
211
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
212

Gildas Bazin's avatar
 
Gildas Bazin committed
213
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
214 215 216 217 218 219

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


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

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

Clément Stenac's avatar
Clément Stenac committed
247 248
typedef struct config_category_t config_category_t;

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

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

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

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

/* Video */
294 295
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
296
typedef struct vout_synchro_t vout_synchro_t;
297
typedef struct chroma_sys_t chroma_sys_t;
298

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

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

311 312
typedef struct image_handler_t image_handler_t;

313 314
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
315 316
typedef struct sout_instance_sys_t sout_instance_sys_t;

317
typedef struct sout_input_t sout_input_t;
318
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
319

320
typedef struct sout_access_out_t sout_access_out_t;
321 322
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

323
typedef struct sout_mux_t sout_mux_t;
324 325
typedef struct sout_mux_sys_t sout_mux_sys_t;

326
typedef struct sout_stream_t    sout_stream_t;
327 328
typedef struct sout_stream_sys_t sout_stream_sys_t;

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

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

Sam Hocevar's avatar
 
Sam Hocevar committed
349
/* Decoders */
Gildas Bazin's avatar
 
Gildas Bazin committed
350 351
typedef struct decoder_t      decoder_t;
typedef struct decoder_sys_t  decoder_sys_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
352

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

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

361
/* Network */
362
typedef struct network_socket_t network_socket_t;
363
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
364 365
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
366
typedef struct vlc_acl_t vlc_acl_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 385 386 387
/* 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;
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
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 399
/* TLS support */
typedef struct tls_t tls_t;
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

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

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

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

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

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

425
/* VLM */
426 427
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
428 429 430 431 432
typedef struct vlm_media_t   vlm_media_t;
typedef struct vlm_schedule_t vlm_schedule_t;

/* divers */
typedef struct vlc_meta_t    vlc_meta_t;
433
typedef struct meta_export_t meta_export_t;
434

435
/* Stats */
436 437 438
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
439
typedef struct input_stats_t input_stats_t;
440
typedef struct global_stats_t global_stats_t;
441

442 443 444
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
445

446 447 448
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

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

460 461 462 463 464 465 466 467 468
/*****************************************************************************
 * 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
469 470 471
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
472

Clément Stenac's avatar
Clément Stenac committed
473
#include "vlc_modules_macros.h"
474

475
#if !defined (__PLUGIN__) || defined (HAVE_SHARED_LIBVLC)
476 477 478 479 480
#   ifdef __cplusplus
#      define VLC_EXPORT( type, name, args ) extern "C" type name args
#   else
#      define VLC_EXPORT( type, name, args ) type name args
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
481
#else
482
#   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
Gildas Bazin's avatar
 
Gildas Bazin committed
483 484
    extern module_symbols_t* p_symbols;
#endif
485
#define VLC_INTERNAL( type, name, args ) VLC_EXPORT (type, name, args)
Gildas Bazin's avatar
 
Gildas Bazin committed
486

487 488 489
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
490
#if defined( WIN32 ) || defined( UNDER_CE )
491 492
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
493 494 495 496 497
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
498 499
#endif

500 501 502 503 504 505 506 507
#include "vlc_threads.h"

/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
508 509 510 511
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
512 513
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
514
    const char *psz_object_type;                                            \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
515
    const char *psz_object_name;                                            \
516
                                                                            \
517 518
    /* Messages header */                                                   \
    char *psz_header;                                                       \
519
    int  i_flags;                                                           \
520
                                                                            \
521 522 523
    /* Thread properties, if any */                                         \
    vlc_bool_t   b_thread;                                                  \
    vlc_thread_t thread_id;                                                 \
Sam Hocevar's avatar
Sam Hocevar committed
524 525 526 527
                                                                            \
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
528
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
529
    /* Object properties */                                                 \
530 531 532 533
    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 */ \
    volatile vlc_bool_t b_attached;               /**< set by the object */ \
534
    vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
535
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
536 537 538 539 540 541
    /* Object variables */                                                  \
    vlc_mutex_t     var_lock;                                               \
    int             i_vars;                                                 \
    variable_t *    p_vars;                                                 \
                                                                            \
    /* Stuff related to the libvlc structure */                             \
542 543
    libvlc_global_data_t *p_libvlc_global;         /**< root of all evil */ \
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
544
                                                                            \
545 546 547
    volatile int    i_refcount;                         /**< usage count */ \
    vlc_object_t *  p_parent;                            /**< our parent */ \
    vlc_object_t ** pp_children;                       /**< our children */ \
548 549
    volatile int    i_children;                                             \
                                                                            \
550 551 552
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
553
    /** Just a reminder so that people don't cast garbage */                \
554
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
555
/**@}*/                                                                     \
556

557 558
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
559
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
560

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
#define VLC_GC_MEMBERS                                                       \
/** \name VLC_GC_MEMBERS                                                     \
 * these members are common to all objects that wish to be garbage-collected \
 */                                                                          \
/**@{*/                                                                      \
    int i_gc_refcount;                                                       \
    void (*pf_destructor) ( gc_object_t * );                                 \
    void *p_destructor_arg;                                                  \
/**@}*/

struct gc_object_t
{
            VLC_GC_MEMBERS
};

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

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

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

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


Sam Hocevar's avatar
 
Sam Hocevar committed
599 600 601 602 603 604
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

605
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
606 607 608 609 610 611 612 613 614 615
#   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
616 617 618
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
619
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
620 621
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
622 623
#endif

624 625 626 627 628 629
static int64_t GCD( int64_t a, int64_t b )
{
    if( b ) return GCD( b, a % b );
    else return a;
}

630 631 632 633 634 635 636 637 638 639 640
/* Malloc with automatic error */
#define MALLOC_VOID( var, type ) { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return; }
#define MALLOC_NULL( var, type ) { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return NULL; }
#define MALLOC_ERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return VLC_ENOMEM; }
#define MALLOC_GOTOERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
                                      if( !var ) goto error; }
#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return;
641 642
#define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return VLC_ENOMEM;
643 644 645
#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return NULL;

Clément Stenac's avatar
Clément Stenac committed
646
#define FREENULL(a) if( a ) { free( a ); a = NULL; }
647
#define FREE(a) if( a ) { free( a ); }
Clément Stenac's avatar
Clément Stenac committed
648

649 650
#define EMPTY_STR(str) (!str || !*str)

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

653
#include <vlc_arrays.h>
654

Sam Hocevar's avatar
 
Sam Hocevar committed
655 656 657
/* 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
658
 * the VAX seems to have such exotic properties. */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
659
static inline uint16_t U16_AT( const void * _p )
660
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
661
    const uint8_t * p = (const uint8_t *)_p;
662
    return ( ((uint16_t)p[0] << 8) | p[1] );
663
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
664
static inline uint32_t U32_AT( const void * _p )
665
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
666
    const uint8_t * p = (const uint8_t *)_p;
667 668
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
669
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
670
static inline uint64_t U64_AT( const void * _p )
671
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
672
    const uint8_t * p = (const uint8_t *)_p;
673 674 675 676
    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] );
677
}
678

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
679
static inline uint16_t GetWLE( const void * _p )
680
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
681
    const uint8_t * p = (const uint8_t *)_p;
682 683
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
684
static inline uint32_t GetDWLE( const void * _p )
685
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
686
    const uint8_t * p = (const uint8_t *)_p;
687 688 689
    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
690
static inline uint64_t GetQWLE( const void * _p )
691
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
692
    const uint8_t * p = (const uint8_t *)_p;
693 694 695 696 697 698 699 700 701 702
    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
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
/* Helper writer functions */
#define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
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;
}
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
#define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
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;
}
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
746

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
747
#ifdef WORDS_BIGENDIAN
748 749
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
750
#   define hton64(i)   ( i )
751 752
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
753 754
#   define ntoh64(i)   ( i )
#else
755 756 757 758 759 760
#   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
761 762
#endif

763 764 765 766 767 768 769
/* 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
770 771 772 773 774 775 776
/* 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

Gildas Bazin's avatar
 
Gildas Bazin committed
777 778 779 780 781 782 783 784 785 786 787 788
/* 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
789 790 791
#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
792

793
#   define vlc_memalign(pp_orig,align,size) \
Gildas Bazin's avatar
 
Gildas Bazin committed
794 795 796
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
797 798 799
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
800
                       & (~(unsigned long)(align-1)) ) \
801
        : NULL )
Gildas Bazin's avatar
 
Gildas Bazin committed
802

Sam Hocevar's avatar
 
Sam Hocevar committed
803 804
#endif

805
/* Stuff defined in src/extras/libc.c */
806
#ifndef HAVE_STRDUP
807 808 809 810
#   define strdup vlc_strdup
    VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
#elif !defined(__PLUGIN__)
#   define vlc_strdup NULL
811
#endif
812

813
#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
814
#   define vasprintf vlc_vasprintf
815
    VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
816 817 818 819
#elif !defined(__PLUGIN__)
#   define vlc_vasprintf NULL
#endif

820
#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
Gildas Bazin's avatar
 
Gildas Bazin committed
821 822 823 824 825 826
#   define asprintf vlc_asprintf
    VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
#elif !defined(__PLUGIN__)
#   define vlc_asprintf NULL
#endif

827
#ifndef HAVE_STRNDUP
828
#   if defined(STRNDUP_IN_GNOME_H) && \
829 830
        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
831 832 833 834 835
        /* 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
836 837
#elif !defined(__PLUGIN__)
#   define vlc_strndup NULL
838 839
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
840 841 842 843 844 845 846
#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

847
#ifndef HAVE_ATOF
848 849 850 851
#   define atof vlc_atof
    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atof NULL
852 853
#endif

854 855 856 857 858 859
#ifndef HAVE_STRTOF
#   ifdef HAVE_STRTOD
#       define strtof strtod
#   endif
#endif

860 861 862 863 864
#ifndef HAVE_ATOLL
#   define atoll vlc_atoll
    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atoll NULL
865 866 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 ) );
#elif !defined(__PLUGIN__)
#   define vlc_strtoll NULL
872 873
#endif

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

886 887 888
#ifndef HAVE_SCANDIR
#   define scandir vlc_scandir
#   define alphasort vlc_alphasort
889
    struct dirent;
890 891
    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 ) );
892 893 894 895 896
#elif !defined(__PLUGIN__)
#   define vlc_scandir NULL
#   define vlc_alphasort NULL
#endif

897
#ifndef HAVE_GETENV
898 899 900 901
#   define getenv vlc_getenv
    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
#elif !defined(__PLUGIN__)
#   define vlc_getenv NULL
902 903 904
#endif

#ifndef HAVE_STRCASECMP
905 906 907 908
#   ifndef HAVE_STRICMP
#       define strcasecmp vlc_strcasecmp
        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
#   else
909
#       define strcasecmp stricmp
Gildas Bazin's avatar
 
Gildas Bazin committed
910 911 912
#       if !defined(__PLUGIN__)
#           define vlc_strcasecmp NULL
#       endif
913
#   endif
914 915
#elif !defined(__PLUGIN__)
#   define vlc_strcasecmp NULL
916 917 918
#endif

#ifndef HAVE_STRNCASECMP
919 920 921 922
#   ifndef HAVE_STRNICMP
#       define strncasecmp vlc_strncasecmp
        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
#   else
923
#       define strncasecmp strnicmp
Gildas Bazin's avatar
 
Gildas Bazin committed
924 925 926
#       if !defined(__PLUGIN__)
#           define vlc_strncasecmp NULL
#       endif
927
#   endif
928 929
#elif !defined(__PLUGIN__)
#   define vlc_strncasecmp NULL
930 931
#endif

932
#ifndef HAVE_STRCASESTR
933 934 935 936
#   ifndef HAVE_STRISTR
#       define strcasestr vlc_strcasestr
        VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
#   else
937 938 939 940 941 942 943 944 945
#       define strcasestr stristr
#       if !defined(__PLUGIN__)
#           define vlc_strcasestr NULL
#       endif
#   endif
#elif !defined(__PLUGIN__)
#   define vlc_strcasestr NULL
#endif

946
#ifndef HAVE_DIRENT_H
947
    typedef void DIR;
948 949 950 951 952 953 954 955 956 957 958 959 960
#   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
961 962 963
    VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
    VLC_EXPORT( void *, vlc_readdir, ( void * ) );
    VLC_EXPORT( int, vlc_closedir, ( void * ) );
964 965 966 967 968 969 970
#else
    struct dirent;  /* forward declaration for vlc_symbols.h */
#   if !defined(__PLUGIN__)
#       define vlc_opendir  NULL
#       define vlc_readdir  NULL
#       define vlc_closedir NULL
#   endif
971 972
#endif

973 974 975 976
#if defined (WIN32)
#   include <dirent.h>
VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
977
VLC_INTERNAL( int, vlc_wclosedir, ( void * ) );
978 979 980 981 982 983 984
#   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
#   define _wclosedir vlc_wclosedir
#endif
985

Gildas Bazin's avatar
 
Gildas Bazin committed
986
/* Format type specifiers for 64 bits numbers */
Damien Fouilleul's avatar
Damien Fouilleul committed
987
#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
#   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
1003 1004 1005 1006 1007 1008 1009
#else
#   define I64Fd "%I64d"
#   define I64Fi "%I64i"
#   define I64Fo "%I64o"
#   define I64Fu "%I64u"
#   define I64Fx "%I64x"
#   define I64FX "%I64X"
1010
#endif /* defined(WIN32)||defined(UNDER_CE) */
Gildas Bazin's avatar
 
Gildas Bazin committed
1011 1012

/* 64 bits integer constant suffix */
Gildas Bazin's avatar
 
Gildas Bazin committed
1013
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1014 1015 1016 1017 1018 1019 1020
#   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
1021 1022
#else
#   define I64C(x)         x##i64
Gildas Bazin's avatar
 
Gildas Bazin committed
1023
#   define UI64C(x)        x##ui64
1024
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1025

1026
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
1027
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
1028
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1029 1030
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
1031
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
1032 1033 1034 1035 1036 1037 1038 1039 1040
#       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_ )
1041 1042
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1043 1044
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
1045 1046 1047
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
1048 1049 1050 1051
#           define off_t long long
#       endif
#   endif

1052
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1053
#       if !defined( _OFF_T_DEFINED )
1054
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1055 1056
#           define _OFF_T_DEFINED
#       else
1057
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
1058 1059 1060 1061
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
1062
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1063
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
1064
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
1065 1066
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
1067 1068
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
1069 1070 1071 1072
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
1073 1074
#   endif

1075
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1076
#   ifndef snprintf
1077 1078 1079 1080
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
1081 1082
#   endif

1083
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
1084 1085
#endif

1086
VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1087
VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1088

Gildas Bazin's avatar
 
Gildas Bazin committed
1089 1090
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
1091
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
1092

1093 1094 1095
/* 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 * ) );
1096
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1097 1098
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

1099 1100 1101 1102
/* execve wrapper (defined in src/extras/libc.c) */
VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char **pp_argv, char **pp_env, char *psz_cwd, char *p_in, int i_in, char **pp_data, int *pi_data ) );
#define vlc_execve(a,b,c,d,e,f,g,h,i) __vlc_execve(VLC_OBJECT(a),b,c,d,e,f,g,h,i)

Sam Hocevar's avatar
 
Sam Hocevar committed
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
/*****************************************************************************
 * CPU capabilities
 *****************************************************************************/
#define CPU_CAPABILITY_NONE    0
#define CPU_CAPABILITY_486     (1<<0)
#define CPU_CAPABILITY_586     (1<<1)
#define CPU_CAPABILITY_PPRO    (1<<2)
#define CPU_CAPABILITY_MMX     (1<<3)
#define CPU_CAPABILITY_3DNOW   (1<<4)
#define CPU_CAPABILITY_MMXEXT  (1<<5)
#define CPU_CAPABILITY_SSE     (1<<6)
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
1114
#define CPU_CAPABILITY_SSE2    (1<<7)
Sam Hocevar's avatar
 
Sam Hocevar committed
1115 1116 1117 1118 1119 1120
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
1121
#if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC)
1122
VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1123
#endif
1124

1125
#if defined( ENABLE_NLS ) && \
1126
     (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
Jean-Paul Saman's avatar
Jean-Paul Saman committed
1127 1128
      defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
      defined(MODULE_NAME_IS_pda))
1129
    /* Declare nothing: gnome.h will do it for us */
1130
#elif defined( ENABLE_NLS )
Sam Hocevar's avatar
Sam Hocevar committed
1131 1132 1133 1134 1135
#   if defined( HAVE_INCLUDED_GETTEXT )
#       include "libintl.h"
#   else
#       include <libintl.h>
#   endif
1136
#   undef _
1137 1138
#   if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC)
#       define _(String) vlc_dgettext (PACKAGE_NAME, String)
1139
#   else