vlc_common.h 45.1 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
 *****************************************************************************/

27

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

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

#include "config.h"

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

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

60 61 62
#include "vlc_config.h"
#include "modules_inner.h"

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

Sam Hocevar's avatar
 
Sam Hocevar committed
69 70 71 72 73 74 75
#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
76 77 78 79

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

112
typedef uint8_t                 byte_t;
113

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

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

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

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

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

/* Video buffer types */
153
typedef uint8_t             yuv_data_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
154

155
/* Audio volume */
156 157
typedef uint16_t            audio_volume_t;

158 159 160 161
#ifndef HAVE_SOCKLEN_T
typedef int                 socklen_t;
#endif

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

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

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

188 189
#else
#   define VLC_FOURCC( a, b, c, d ) \
190 191
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
192
#   define VLC_TWOCC( a, b ) \
193
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
194 195

#endif
196

Sam Hocevar's avatar
 
Sam Hocevar committed
197 198 199 200
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

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

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

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

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


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

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

248 249
typedef struct config_category_t config_category_t;

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

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

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

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

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

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

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

312 313
typedef struct image_handler_t image_handler_t;

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

318
typedef struct sout_input_t sout_input_t;
319
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
320

321
typedef struct sout_access_out_t sout_access_out_t;
322 323
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

324
typedef struct sout_mux_t sout_mux_t;
325 326
typedef struct sout_mux_sys_t sout_mux_sys_t;

327
typedef struct sout_stream_t    sout_stream_t;
328 329
typedef struct sout_stream_sys_t sout_stream_sys_t;

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

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

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

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

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

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

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

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

379 380 381 382 383 384 385 386 387 388
/* 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;
389 390 391
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
392
typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data );
393 394 395
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
396 397 398 399 400
/* TLS support */
typedef struct tls_t tls_t;
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

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

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

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

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

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

426
/* VLM */
427 428
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
429 430 431 432 433
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;
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 451 452 453 454 455 456 457
/*****************************************************************************
 * 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
458 459 460
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
461
#if !defined (__PLUGIN__) || defined (HAVE_SHARED_LIBVLC)
462 463 464 465 466
#   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
467
#else
468
#   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
Gildas Bazin's avatar
 
Gildas Bazin committed
469 470 471
    extern module_symbols_t* p_symbols;
#endif

472 473 474
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
475
#if defined( WIN32 ) || defined( UNDER_CE )
476 477
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
478 479 480 481 482
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
483 484
#endif

485 486 487 488 489 490 491 492
#include "vlc_threads.h"

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

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

542 543
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
544
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
545

546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
#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
584 585 586 587 588 589
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

590
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
591 592 593 594 595 596 597 598 599 600
#   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
601 602 603
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
604
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
605 606
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
607 608
#endif

609 610 611 612 613 614
static int64_t GCD( int64_t a, int64_t b )
{
    if( b ) return GCD( b, a % b );
    else return a;
}

615 616 617 618 619 620 621 622 623 624 625
/* 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;
626 627
#define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return VLC_ENOMEM;
628 629 630
#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return NULL;

631
#define FREENULL(a) if( a ) { free( a ); a = NULL; }
632
#define FREE(a) if( a ) { free( a ); }
633

634
/* Dynamic array handling: realloc array, move data, increment position */
635
#if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
636 637 638 639
#   define VLCCVP (void**) /* Work-around for broken compiler */
#else
#   define VLCCVP
#endif
640 641 642
#define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
    do                                                                        \
    {                                                                         \
643 644
        if( !i_oldsize ) (p_ar) = NULL;                                       \
        (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
Gildas Bazin's avatar
 
Gildas Bazin committed
645 646
        if( (i_oldsize) - (i_pos) )                                           \
        {                                                                     \
647
            memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos),                  \
Gildas Bazin's avatar
 
Gildas Bazin committed
648 649
                     ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
        }                                                                     \
650 651 652 653 654 655 656 657
        (p_ar)[i_pos] = elem;                                                 \
        (i_oldsize)++;                                                        \
    }                                                                         \
    while( 0 )

#define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
    do                                                                        \
    {                                                                         \
Gildas Bazin's avatar
 
Gildas Bazin committed
658 659 660 661 662 663
        if( (i_oldsize) - (i_pos) - 1 )                                       \
        {                                                                     \
            memmove( (p_ar) + (i_pos),                                        \
                     (p_ar) + (i_pos) + 1,                                    \
                     ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
        }                                                                     \
664 665 666 667 668 669 670 671 672 673 674 675 676 677
        if( i_oldsize > 1 )                                                   \
        {                                                                     \
            (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
        }                                                                     \
        else                                                                  \
        {                                                                     \
            free( p_ar );                                                     \
            (p_ar) = NULL;                                                    \
        }                                                                     \
        (i_oldsize)--;                                                        \
    }                                                                         \
    while( 0 )


678 679 680
#define TAB_APPEND( count, tab, p )             \
    if( (count) > 0 )                           \
    {                                           \
681
        (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
682 683 684
    }                                           \
    else                                        \
    {                                           \
685
        (tab) = malloc( sizeof( void ** ) );    \
686
    }                                           \
687
    (tab)[count] = (p);        \
688 689 690 691 692 693 694 695
    (count)++

#define TAB_FIND( count, tab, p, index )        \
    {                                           \
        int _i_;                                \
        (index) = -1;                           \
        for( _i_ = 0; _i_ < (count); _i_++ )    \
        {                                       \
696
            if( (tab)[_i_] == (p) )  \
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
            {                                   \
                (index) = _i_;                  \
                break;                          \
            }                                   \
        }                                       \
    }

#define TAB_REMOVE( count, tab, p )             \
    {                                           \
        int _i_index_;                          \
        TAB_FIND( count, tab, p, _i_index_ );   \
        if( _i_index_ >= 0 )                    \
        {                                       \
            if( (count) > 1 )                     \
            {                                   \
                memmove( ((void**)(tab) + _i_index_),    \
                         ((void**)(tab) + _i_index_+1),  \
                         ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
            }                                   \
716 717
            (count)--;                          \
            if( (count) == 0 )                  \
718 719 720 721 722 723 724
            {                                   \
                free( tab );                    \
                (tab) = NULL;                   \
            }                                   \
        }                                       \
    }

Clément Stenac's avatar
Clément Stenac committed
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
/* Binary search in an array */
#define BSEARCH( entries, count, elem, zetype, key, answer ) {  \
    int low = 0, high = count - 1;   \
    answer = -1; \
    while( low <= high ) {\
        int mid = (low + high ) / 2; /* Just don't care about 2^30 tables */ \
        zetype mid_val = entries[mid] elem;\
        if( mid_val < key ) \
            low = mid + 1; \
        else if ( mid_val > key ) \
            high = mid -1;  \
        else    \
        {   \
            answer = mid;  break;   \
        }\
    } \
}

/* Dictionnary handling */
struct dict_entry_t
745
{
Clément Stenac's avatar
Clément Stenac committed
746 747
    int       i_int;
    char     *psz_string;
748 749 750 751
    uint64_t  i_hash;
    void     *p_data;
};

Clément Stenac's avatar
Clément Stenac committed
752 753 754 755 756
struct dict_t
{
    dict_entry_t *p_entries;
    int i_entries;
};
757

Clément Stenac's avatar
Clément Stenac committed
758 759 760 761 762
VLC_EXPORT( dict_t *, vlc_DictNew, (void) );
VLC_EXPORT( void, vlc_DictClear, (dict_t * ) );
VLC_EXPORT( void, vlc_DictInsert, (dict_t *, int, const char *, void * ) );
VLC_EXPORT( void*, vlc_DictGet, (dict_t *, int, const char * ) );
VLC_EXPORT( int, vlc_DictLookup, (dict_t *, int, const char * ) );
763

Sam Hocevar's avatar
 
Sam Hocevar committed
764 765 766
/* 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
767
 * the VAX seems to have such exotic properties. */
Sam Hocevar's avatar
Sam Hocevar committed
768
static inline uint16_t U16_AT( void const * _p )
769
{
770 771
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[0] << 8) | p[1] );
772
}
Sam Hocevar's avatar
Sam Hocevar committed
773
static inline uint32_t U32_AT( void const * _p )
774
{
775 776 777
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
778
}
Sam Hocevar's avatar
Sam Hocevar committed
779
static inline uint64_t U64_AT( void const * _p )
780
{
781 782 783 784 785
    uint8_t * p = (uint8_t *)_p;
    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] );
786
}
787

Sam Hocevar's avatar
Sam Hocevar committed
788
static inline uint16_t GetWLE( void const * _p )
789 790 791 792
{
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Sam Hocevar's avatar
Sam Hocevar committed
793
static inline uint32_t GetDWLE( void const * _p )
794 795 796 797 798
{
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
Sam Hocevar's avatar
Sam Hocevar committed
799
static inline uint64_t GetQWLE( void const * _p )
800 801 802 803 804 805 806 807 808 809 810 811
{
    uint8_t * p = (uint8_t *)_p;
    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
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
/* 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 );
}
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
#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 );
}
855

Sam Hocevar's avatar
 
Sam Hocevar committed
856
#if WORDS_BIGENDIAN
857 858
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
859
#   define hton64(i)   ( i )
860 861
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
862 863
#   define ntoh64(i)   ( i )
#else
864 865 866 867 868 869
#   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
870 871
#endif

872 873 874 875 876 877 878
/* 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
879 880 881 882 883 884 885
/* 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
886 887 888 889 890 891 892 893 894 895 896 897
/* 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
898 899 900
#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
901

902
#   define vlc_memalign(pp_orig,align,size) \
Gildas Bazin's avatar
 
Gildas Bazin committed
903 904 905
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
906 907 908
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
909
                       & (~(unsigned long)(align-1)) ) \
910
        : NULL )
Gildas Bazin's avatar
 
Gildas Bazin committed
911

Sam Hocevar's avatar
 
Sam Hocevar committed
912 913
#endif

914
/* Stuff defined in src/extras/libc.c */
915
#ifndef HAVE_STRDUP
916 917 918 919
#   define strdup vlc_strdup
    VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
#elif !defined(__PLUGIN__)
#   define vlc_strdup NULL
920
#endif
921

922
#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
923
#   define vasprintf vlc_vasprintf
924
    VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
925 926 927 928
#elif !defined(__PLUGIN__)
#   define vlc_vasprintf NULL
#endif

929
#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
Gildas Bazin's avatar
 
Gildas Bazin committed
930 931 932 933 934 935
#   define asprintf vlc_asprintf
    VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
#elif !defined(__PLUGIN__)
#   define vlc_asprintf NULL
#endif

936
#ifndef HAVE_STRNDUP
937
#   if defined(STRNDUP_IN_GNOME_H) && \
938 939
        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
940 941 942 943 944
        /* 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
945 946
#elif !defined(__PLUGIN__)
#   define vlc_strndup NULL
947 948
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
949 950 951 952 953 954 955
#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

956
#ifndef HAVE_ATOF
957 958 959 960
#   define atof vlc_atof
    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atof NULL
961 962
#endif

963 964 965 966 967 968
#ifndef HAVE_STRTOF
#   ifdef HAVE_STRTOD
#       define strtof strtod
#   endif
#endif

969 970 971 972 973
#ifndef HAVE_ATOLL
#   define atoll vlc_atoll
    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atoll NULL
974 975 976 977 978 979 980
#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
981 982
#endif

983
#if defined(SYS_BEOS)
984 985 986 987 988 989 990 991 992 993
    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

994 995 996
#ifndef HAVE_SCANDIR
#   define scandir vlc_scandir
#   define alphasort vlc_alphasort
997
    struct dirent;
998 999
    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 ) );
1000 1001 1002 1003 1004
#elif !defined(__PLUGIN__)
#   define vlc_scandir NULL
#   define vlc_alphasort NULL
#endif

1005
#ifndef HAVE_GETENV
1006 1007 1008 1009
#   define getenv vlc_getenv
    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
#elif !defined(__PLUGIN__)
#   define vlc_getenv NULL
1010 1011 1012
#endif

#ifndef HAVE_STRCASECMP
1013 1014 1015 1016
#   ifndef HAVE_STRICMP
#       define strcasecmp vlc_strcasecmp
        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
#   else
1017
#       define strcasecmp stricmp
Gildas Bazin's avatar
 
Gildas Bazin committed
1018 1019 1020
#       if !defined(__PLUGIN__)
#           define vlc_strcasecmp NULL
#       endif
1021
#   endif
1022 1023
#elif !defined(__PLUGIN__)
#   define vlc_strcasecmp NULL
1024 1025 1026
#endif

#ifndef HAVE_STRNCASECMP
1027 1028 1029 1030
#   ifndef HAVE_STRNICMP
#       define strncasecmp vlc_strncasecmp
        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
#   else
1031
#       define strncasecmp strnicmp
Gildas Bazin's avatar
 
Gildas Bazin committed
1032 1033 1034
#       if !defined(__PLUGIN__)
#           define vlc_strncasecmp NULL
#       endif
1035
#   endif
1036 1037
#elif !defined(__PLUGIN__)
#   define vlc_strncasecmp NULL
1038 1039
#endif

1040
#ifndef HAVE_STRCASESTR
1041 1042 1043 1044
#   ifndef HAVE_STRISTR
#       define strcasestr vlc_strcasestr
        VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
#   else
1045 1046 1047 1048 1049 1050 1051 1052 1053
#       define strcasestr stristr
#       if !defined(__PLUGIN__)
#           define vlc_strcasestr NULL
#       endif
#   endif
#elif !defined(__PLUGIN__)
#   define vlc_strcasestr NULL
#endif

1054
#ifndef HAVE_DIRENT_H
1055
    typedef void DIR;
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
#   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
1069 1070 1071
    VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
    VLC_EXPORT( void *, vlc_readdir, ( void * ) );
    VLC_EXPORT( int, vlc_closedir, ( void * ) );
1072 1073 1074 1075 1076 1077 1078
#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
1079 1080
#endif

1081 1082 1083 1084
    VLC_EXPORT( void *, vlc_opendir_wrapper, ( const char * ) );
    VLC_EXPORT( struct dirent *, vlc_readdir_wrapper, ( void * ) );
    VLC_EXPORT( int, vlc_closedir_wrapper, ( void * ) );

Gildas Bazin's avatar
 
Gildas Bazin committed
1085
/* Format type specifiers for 64 bits numbers */
Damien Fouilleul's avatar
Damien Fouilleul committed
1086
#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
#   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
1102 1103 1104 1105 1106 1107 1108
#else
#   define I64Fd "%I64d"
#   define I64Fi "%I64i"
#   define I64Fo "%I64o"
#   define I64Fu "%I64u"
#   define I64Fx "%I64x"
#   define I64FX "%I64X"
1109
#endif /* defined(WIN32)||defined(UNDER_CE) */
Gildas Bazin's avatar
 
Gildas Bazin committed
1110 1111

/* 64 bits integer constant suffix */
Gildas Bazin's avatar
 
Gildas Bazin committed
1112
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1113 1114 1115 1116 1117 1118 1119
#   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
1120 1121
#else
#   define I64C(x)         x##i64
Gildas Bazin's avatar
 
Gildas Bazin committed
1122
#   define UI64C(x)        x##ui64
1123
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1124

1125
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
1126
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
1127
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1128 1129
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
1130
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
1131 1132 1133 1134 1135 1136 1137 1138 1139
#       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_ )
1140 1141
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1142 1143
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
1144 1145 1146
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
1147 1148 1149 1150
#           define off_t long long
#       endif
#   endif

1151
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1152
#       if !defined( _OFF_T_DEFINED )
1153
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1154 1155
#           define _OFF_T_DEFINED
#       else
1156
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
1157 1158 1159 1160
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
1161
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1162
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
1163
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
1164 1165
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
1166 1167
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
1168 1169 1170 1171
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
1172 1173
#   endif

1174
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1175
#   ifndef snprintf
1176 1177 1178 1179
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
1180 1181
#   endif

1182
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
1183 1184
#endif

1185
VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1186
VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1187

Gildas Bazin's avatar
 
Gildas Bazin committed
1188 1189
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
1190
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
1191

1192 1193 1194
/* 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 * ) );
1195
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1196 1197
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

1198 1199 1200 1201
/* 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
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
/*****************************************************************************
 * 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)