vlc_common.h 42.8 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 202
/* Internal types */
typedef struct libvlc_t libvlc_t;
Sam Hocevar's avatar
Sam Hocevar committed
203 204
typedef struct vlc_t vlc_t;
typedef struct variable_t variable_t;
205
typedef struct date_t date_t;
206
typedef struct hashtable_entry_t hashtable_entry_t;
207
typedef struct gc_object_t gc_object_t ;
208

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

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

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


231 232
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
233
typedef struct playlist_view_t playlist_view_t;
234
typedef struct playlist_export_t playlist_export_t;
235 236
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
237
typedef struct playlist_add_t playlist_add_t;
238
typedef struct playlist_preparse_t playlist_preparse_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 sout_cfg_t       sout_cfg_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

Sam Hocevar's avatar
 
Sam Hocevar committed
337
/* Decoders */
Gildas Bazin's avatar
 
Gildas Bazin committed
338 339
typedef struct decoder_t      decoder_t;
typedef struct decoder_sys_t  decoder_sys_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
340

Gildas Bazin's avatar
 
Gildas Bazin committed
341 342 343 344
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

345 346 347 348
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

349
/* Network */
350
typedef struct network_socket_t network_socket_t;
351
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
352 353
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
354
typedef struct vlc_acl_t vlc_acl_t;
355

356 357 358
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

359 360 361 362
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

363 364 365 366 367 368 369 370 371 372
/* 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;
373 374 375
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
376
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 );
377 378 379
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
380 381 382 383 384
/* TLS support */
typedef struct tls_t tls_t;
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

385 386 387
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
388 389 390 391 392 393
/* 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;

394 395 396
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
397
typedef struct vod_media_t vod_media_t;
398

399 400 401 402
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

403 404 405 406 407 408 409
/* 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;

410
/* VLM */
411 412
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
413 414 415 416 417
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;
418

419
/* Stats */
420 421 422
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
423
typedef struct input_stats_t input_stats_t;
424
typedef struct global_stats_t global_stats_t;
425

426 427 428
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
429

430 431 432 433 434 435 436 437 438
/*****************************************************************************
 * 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
439 440 441
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
442
#if !defined (__PLUGIN__) || defined (HAVE_SHARED_LIBVLC)
443 444 445 446 447
#   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
448
#else
449
#   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
Gildas Bazin's avatar
 
Gildas Bazin committed
450 451 452
    extern module_symbols_t* p_symbols;
#endif

453 454 455
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
456
#if defined( WIN32 ) || defined( UNDER_CE )
457 458
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
459 460 461 462 463
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
464 465
#endif

466 467 468 469 470 471 472 473
#include "vlc_threads.h"

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

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
474 475 476 477
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
478 479
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
480
    const char *psz_object_type;                                            \
481 482
    char *psz_object_name;                                                  \
                                                                            \
483 484
    /* Messages header */                                                   \
    char *psz_header;                                                       \
485
    int  i_flags;                                                           \
486
                                                                            \
487 488 489
    /* Thread properties, if any */                                         \
    vlc_bool_t   b_thread;                                                  \
    vlc_thread_t thread_id;                                                 \
Sam Hocevar's avatar
Sam Hocevar committed
490 491 492 493
                                                                            \
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
494
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
495
    /* Object properties */                                                 \
496 497 498 499
    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 */ \
500
    vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
501
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
502 503 504 505 506 507
    /* Object variables */                                                  \
    vlc_mutex_t     var_lock;                                               \
    int             i_vars;                                                 \
    variable_t *    p_vars;                                                 \
                                                                            \
    /* Stuff related to the libvlc structure */                             \
508 509
    libvlc_t *      p_libvlc;                      /**< root of all evil */ \
    vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
510
                                                                            \
511 512 513
    volatile int    i_refcount;                         /**< usage count */ \
    vlc_object_t *  p_parent;                            /**< our parent */ \
    vlc_object_t ** pp_children;                       /**< our children */ \
514 515
    volatile int    i_children;                                             \
                                                                            \
516 517 518
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
519
    /** Just a reminder so that people don't cast garbage */                \
520
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
521
/**@}*/                                                                     \
522

523 524
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
525
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
526

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
#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
565 566 567 568 569 570
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

571
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
572 573 574 575 576 577 578 579 580 581
#   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
582 583 584
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
585
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
586 587
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
588 589
#endif

590 591 592 593 594 595
static int64_t GCD( int64_t a, int64_t b )
{
    if( b ) return GCD( b, a % b );
    else return a;
}

596
/* Dynamic array handling: realloc array, move data, increment position */
597
#if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
598 599 600 601
#   define VLCCVP (void**) /* Work-around for broken compiler */
#else
#   define VLCCVP
#endif
602 603 604
#define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
    do                                                                        \
    {                                                                         \
605 606
        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
607 608
        if( (i_oldsize) - (i_pos) )                                           \
        {                                                                     \
609
            memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos),                  \
Gildas Bazin's avatar
 
Gildas Bazin committed
610 611
                     ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
        }                                                                     \
612 613 614 615 616 617 618 619
        (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
620 621 622 623 624 625
        if( (i_oldsize) - (i_pos) - 1 )                                       \
        {                                                                     \
            memmove( (p_ar) + (i_pos),                                        \
                     (p_ar) + (i_pos) + 1,                                    \
                     ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
        }                                                                     \
626 627 628 629 630 631 632 633 634 635 636 637 638 639
        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 )


640 641 642
#define TAB_APPEND( count, tab, p )             \
    if( (count) > 0 )                           \
    {                                           \
643
        (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
644 645 646
    }                                           \
    else                                        \
    {                                           \
647
        (tab) = malloc( sizeof( void ** ) );    \
648
    }                                           \
649
    (tab)[count] = (p);        \
650 651 652 653 654 655 656 657
    (count)++

#define TAB_FIND( count, tab, p, index )        \
    {                                           \
        int _i_;                                \
        (index) = -1;                           \
        for( _i_ = 0; _i_ < (count); _i_++ )    \
        {                                       \
658
            if( (tab)[_i_] == (p) )  \
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
            {                                   \
                (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* ) );\
            }                                   \
678 679
            (count)--;                          \
            if( (count) == 0 )                  \
680 681 682 683 684 685 686
            {                                   \
                free( tab );                    \
                (tab) = NULL;                   \
            }                                   \
        }                                       \
    }

687 688 689 690 691 692 693 694 695 696 697 698 699 700
/* Hash tables handling */
struct hashtable_entry_t
{
    int       i_id;
    char     *psz_name;
    uint64_t  i_hash;
    void     *p_data;
};

VLC_EXPORT( void, vlc_HashInsert, (hashtable_entry_t **, int *, int, const char *, void *));
VLC_EXPORT( void*, vlc_HashRetrieve, (hashtable_entry_t*, int, int, const char *) );
VLC_EXPORT( int, vlc_HashLookup, (hashtable_entry_t *, int, int, const char *) );


Sam Hocevar's avatar
 
Sam Hocevar committed
701 702 703
/* 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
704
 * the VAX seems to have such exotic properties. */
Sam Hocevar's avatar
Sam Hocevar committed
705
static inline uint16_t U16_AT( void const * _p )
706
{
707 708
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[0] << 8) | p[1] );
709
}
Sam Hocevar's avatar
Sam Hocevar committed
710
static inline uint32_t U32_AT( void const * _p )
711
{
712 713 714
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
715
}
Sam Hocevar's avatar
Sam Hocevar committed
716
static inline uint64_t U64_AT( void const * _p )
717
{
718 719 720 721 722
    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] );
723
}
724

Sam Hocevar's avatar
Sam Hocevar committed
725
static inline uint16_t GetWLE( void const * _p )
726 727 728 729
{
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Sam Hocevar's avatar
Sam Hocevar committed
730
static inline uint32_t GetDWLE( void const * _p )
731 732 733 734 735
{
    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
736
static inline uint64_t GetQWLE( void const * _p )
737 738 739 740 741 742 743 744 745 746 747 748
{
    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
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
/* 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 );
}
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
#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 );
}
792

Sam Hocevar's avatar
 
Sam Hocevar committed
793
#if WORDS_BIGENDIAN
794 795
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
796
#   define hton64(i)   ( i )
797 798
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
799 800
#   define ntoh64(i)   ( i )
#else
801 802 803 804 805 806
#   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
807 808
#endif

809 810 811 812 813 814 815
/* 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
816 817 818 819 820 821 822
/* 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
823 824 825 826 827 828 829 830 831 832 833 834
/* 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
835 836 837
#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
838

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

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

Sam Hocevar's avatar
 
Sam Hocevar committed
849 850
#endif

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

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

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

873
#ifndef HAVE_STRNDUP
874
#   if defined(STRNDUP_IN_GNOME_H) && \
875 876
        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
877 878 879 880 881
        /* 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
882 883
#elif !defined(__PLUGIN__)
#   define vlc_strndup NULL
884 885
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
886 887 888 889 890 891 892
#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

893
#ifndef HAVE_ATOF
894 895 896 897
#   define atof vlc_atof
    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atof NULL
898 899
#endif

900 901 902 903 904 905
#ifndef HAVE_STRTOF
#   ifdef HAVE_STRTOD
#       define strtof strtod
#   endif
#endif

906 907 908 909 910
#ifndef HAVE_ATOLL
#   define atoll vlc_atoll
    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atoll NULL
911 912 913 914 915 916 917
#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
918 919
#endif

920
#if defined(SYS_BEOS)
921 922 923 924 925 926 927 928 929 930
    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

931 932 933
#ifndef HAVE_SCANDIR
#   define scandir vlc_scandir
#   define alphasort vlc_alphasort
934
    struct dirent;
935 936
    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 ) );
937 938 939 940 941
#elif !defined(__PLUGIN__)
#   define vlc_scandir NULL
#   define vlc_alphasort NULL
#endif

942
#ifndef HAVE_GETENV
943 944 945 946
#   define getenv vlc_getenv
    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
#elif !defined(__PLUGIN__)
#   define vlc_getenv NULL
947 948 949
#endif

#ifndef HAVE_STRCASECMP
950 951 952 953
#   ifndef HAVE_STRICMP
#       define strcasecmp vlc_strcasecmp
        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
#   else
954
#       define strcasecmp stricmp
Gildas Bazin's avatar
 
Gildas Bazin committed
955 956 957
#       if !defined(__PLUGIN__)
#           define vlc_strcasecmp NULL
#       endif
958
#   endif
959 960
#elif !defined(__PLUGIN__)
#   define vlc_strcasecmp NULL
961 962 963
#endif

#ifndef HAVE_STRNCASECMP
964 965 966 967
#   ifndef HAVE_STRNICMP
#       define strncasecmp vlc_strncasecmp
        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
#   else
968
#       define strncasecmp strnicmp
Gildas Bazin's avatar
 
Gildas Bazin committed
969 970 971
#       if !defined(__PLUGIN__)
#           define vlc_strncasecmp NULL
#       endif
972
#   endif
973 974
#elif !defined(__PLUGIN__)
#   define vlc_strncasecmp NULL
975 976
#endif

977
#ifndef HAVE_STRCASESTR
978 979 980 981
#   ifndef HAVE_STRISTR
#       define strcasestr vlc_strcasestr
        VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
#   else
982 983 984 985 986 987 988 989 990
#       define strcasestr stristr
#       if !defined(__PLUGIN__)
#           define vlc_strcasestr NULL
#       endif
#   endif
#elif !defined(__PLUGIN__)
#   define vlc_strcasestr NULL
#endif

991
#ifndef HAVE_DIRENT_H
992
    typedef void DIR;
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
#   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
1006 1007 1008
    VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
    VLC_EXPORT( void *, vlc_readdir, ( void * ) );
    VLC_EXPORT( int, vlc_closedir, ( void * ) );
1009 1010 1011 1012 1013 1014 1015
#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
1016 1017
#endif

1018 1019 1020 1021
    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
1022
/* Format type specifiers for 64 bits numbers */
Damien Fouilleul's avatar
Damien Fouilleul committed
1023
#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
#   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
1039 1040 1041 1042 1043 1044 1045
#else
#   define I64Fd "%I64d"
#   define I64Fi "%I64i"
#   define I64Fo "%I64o"
#   define I64Fu "%I64u"
#   define I64Fx "%I64x"
#   define I64FX "%I64X"
1046
#endif /* defined(WIN32)||defined(UNDER_CE) */
Gildas Bazin's avatar
 
Gildas Bazin committed
1047 1048

/* 64 bits integer constant suffix */
Gildas Bazin's avatar
 
Gildas Bazin committed
1049
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1050 1051 1052 1053 1054 1055 1056
#   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
1057 1058
#else
#   define I64C(x)         x##i64
Gildas Bazin's avatar
 
Gildas Bazin committed
1059
#   define UI64C(x)        x##ui64
1060
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1061

1062
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
1063
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
1064
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1065 1066
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
1067
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
1068 1069 1070 1071 1072 1073 1074 1075 1076
#       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_ )
1077 1078
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1079 1080
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
1081 1082 1083
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
1084 1085 1086 1087
#           define off_t long long
#       endif
#   endif

1088
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1089
#       if !defined( _OFF_T_DEFINED )
1090
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
1091 1092
#           define _OFF_T_DEFINED
#       else
1093
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
1094 1095 1096 1097
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
1098
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
1099
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
1100
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
1101 1102
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
1103 1104
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
1105 1106 1107 1108
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
1109 1110
#   endif

1111
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
1112
#   ifndef snprintf
1113 1114 1115 1116
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
1117 1118
#   endif

1119
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
1120 1121
#endif

1122
VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1123
VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1124

Gildas Bazin's avatar
 
Gildas Bazin committed
1125 1126
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
1127
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
1128

1129 1130 1131
/* 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 * ) );
1132
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1133 1134
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

1135 1136 1137 1138
/* 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
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
/*****************************************************************************
 * 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
1150
#define CPU_CAPABILITY_SSE2    (1<<7)
Sam Hocevar's avatar
 
Sam Hocevar committed
1151 1152 1153 1154 1155 1156
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
1157
#if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC)
1158
VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1159
#endif
1160

1161
#if defined( ENABLE_NLS ) && \
1162
     (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
Jean-Paul Saman's avatar
Jean-Paul Saman committed
1163 1164
      defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
      defined(MODULE_NAME_IS_pda))
1165
    /* Declare nothing: gnome.h will do it for us */
1166
#elif defined( ENABLE_NLS )
Sam Hocevar's avatar
Sam Hocevar committed
1167 1168 1169 1170 1171
#   if defined( HAVE_INCLUDED_GETTEXT )
#       include "libintl.h"
#   else
#       include <libintl.h>
#   endif
1172
#   undef _
1173 1174
#   if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC)
#       define _(String) vlc_dgettext (PACKAGE_NAME, String)
1175
#   else
1176
#       define _(String) dgettext(PACKAGE_NAME, String)
1177
#   endif
1178
#   define N_(String) ((char*)(String))
1179
#else
1180 1181
#   define _(String) ((char*)(String))
#   define N_(String) ((char*)(String))
Sam Hocevar's avatar
 
Sam Hocevar committed
1182 1183
#endif

1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
VLC_EXPORT( const char *, VLC_Version, ( void ) );
VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
VLC_EXPORT( const char *, VLC_Error, ( int ) );

1194
/*****************************************************************************
1195
 * Additional vlc stuff
1196