vlc_common.h 43 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
dionoea's avatar
dionoea committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25 26
 *****************************************************************************/

27

zorglub's avatar
zorglub committed
28
/**
Sam Hocevar's avatar
Sam Hocevar committed
29
 * \file
zorglub's avatar
zorglub 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
ipkiss's avatar
ipkiss committed
54
#   undef HAVE_INTTYPES_H
55
#   undef off_t
gbazin's avatar
 
gbazin 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
 *****************************************************************************/
gbazin's avatar
 
gbazin 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 )
gbazin's avatar
 
gbazin committed
136
#   include <malloc.h>
137 138 139
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
gbazin's avatar
 
gbazin committed
140 141
#endif

142
#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
gbazin's avatar
 
gbazin 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

sigmunau's avatar
sigmunau 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.
sigmunau's avatar
sigmunau committed
171
 */
172
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
173

sigmunau's avatar
sigmunau committed
174
/**
175
 * The vlc_fourcc_t type.
sigmunau's avatar
sigmunau committed
176
 *
177
 * See http://www.webartz.com/fourcc/ for a very detailed list.
sigmunau's avatar
sigmunau 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;
zorglub's avatar
zorglub committed
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

gbazin's avatar
 
gbazin committed
214
/* Playlist */
hartman's avatar
hartman committed
215 216 217 218 219 220

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
zorglub's avatar
zorglub committed
221
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
222
    PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
zorglub's avatar
zorglub committed
223 224 225 226 227 228 229
    PLAYLIST_VIEWPLAY,  /**< arg1= int, arg2= playlist_item_t*,*/
                        /**  arg3 = playlist_item_t*          , res=can fail */
    PLAYLIST_ITEMPLAY,  /** <arg1 = playlist_item_t *         , res=can fail */
    PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
    PLAYLIST_GOTO,      /**< arg1=int                           res=can fail */
230
    PLAYLIST_VIEWGOTO   /**< arg1=int                           res=can fail */
hartman's avatar
hartman committed
231 232 233
} playlist_command_t;


234 235
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
zorglub's avatar
zorglub committed
236
typedef struct playlist_view_t playlist_view_t;
zorglub's avatar
zorglub committed
237
typedef struct playlist_export_t playlist_export_t;
zorglub's avatar
zorglub committed
238 239
typedef struct services_discovery_t services_discovery_t;
typedef struct services_discovery_sys_t services_discovery_sys_t;
zorglub's avatar
zorglub committed
240
typedef struct playlist_add_t playlist_add_t;
241
typedef struct playlist_preparse_t playlist_preparse_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
242

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

zorglub's avatar
zorglub committed
250 251
typedef struct config_category_t config_category_t;

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

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

279 280 281 282
/* 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;
gbazin's avatar
 
gbazin committed
283 284
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
285

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

/* Video */
297 298
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
299
typedef struct vout_synchro_t vout_synchro_t;
300
typedef struct chroma_sys_t chroma_sys_t;
301

gbazin's avatar
 
gbazin committed
302
typedef video_format_t video_frame_format_t;
303 304 305
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
306

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

314 315
typedef struct image_handler_t image_handler_t;

316 317
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
318 319
typedef struct sout_instance_sys_t sout_instance_sys_t;

320
typedef struct sout_input_t sout_input_t;
321
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
322

323
typedef struct sout_access_out_t sout_access_out_t;
324 325
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

326
typedef struct sout_mux_t sout_mux_t;
327 328
typedef struct sout_mux_sys_t sout_mux_sys_t;

329
typedef struct sout_stream_t    sout_stream_t;
330 331
typedef struct sout_stream_sys_t sout_stream_sys_t;

332
typedef struct sout_cfg_t       sout_cfg_t;
zorglub's avatar
zorglub committed
333 334 335 336 337 338
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;
339

Sam Hocevar's avatar
 
Sam Hocevar committed
340
/* Decoders */
gbazin's avatar
 
gbazin committed
341 342
typedef struct decoder_t      decoder_t;
typedef struct decoder_sys_t  decoder_sys_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
343

gbazin's avatar
 
gbazin committed
344 345 346 347
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

348 349 350 351
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

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

359 360 361
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

362 363 364 365
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

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

388 389 390
/* Hashing */
typedef struct md5_s md5_t;

gbazin's avatar
gbazin committed
391 392 393 394 395 396
/* 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;

397 398 399
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
400
typedef struct vod_media_t vod_media_t;
401

402 403 404 405
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

406 407 408 409 410 411 412
/* 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;

413
/* VLM */
414 415
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
416 417 418 419 420
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;
421

422
/* Stats */
423 424 425
typedef struct counter_t     counter_t;
typedef struct counter_sample_t counter_sample_t;
typedef struct stats_handler_t stats_handler_t;
zorglub's avatar
zorglub committed
426
typedef struct input_stats_t input_stats_t;
zorglub's avatar
zorglub committed
427
typedef struct global_stats_t global_stats_t;
428

429 430 431
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
432

433 434 435 436 437 438 439 440 441
/*****************************************************************************
 * 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 */

gbazin's avatar
 
gbazin committed
442 443 444
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
445
#if !defined (__PLUGIN__) || defined (HAVE_SHARED_LIBVLC)
446 447 448 449 450
#   ifdef __cplusplus
#      define VLC_EXPORT( type, name, args ) extern "C" type name args
#   else
#      define VLC_EXPORT( type, name, args ) type name args
#   endif
gbazin's avatar
 
gbazin committed
451
#else
452
#   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
gbazin's avatar
 
gbazin committed
453 454 455
    extern module_symbols_t* p_symbols;
#endif

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

469 470 471 472 473 474 475 476
#include "vlc_threads.h"

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

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

526 527
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
528
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
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 565 566 567
#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
568 569 570 571 572 573
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

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

593 594 595 596 597 598
static int64_t GCD( int64_t a, int64_t b )
{
    if( b ) return GCD( b, a % b );
    else return a;
}

599
/* Dynamic array handling: realloc array, move data, increment position */
gbazin's avatar
gbazin committed
600
#if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
601 602 603 604
#   define VLCCVP (void**) /* Work-around for broken compiler */
#else
#   define VLCCVP
#endif
605 606 607
#define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
    do                                                                        \
    {                                                                         \
608 609
        if( !i_oldsize ) (p_ar) = NULL;                                       \
        (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
gbazin's avatar
 
gbazin committed
610 611
        if( (i_oldsize) - (i_pos) )                                           \
        {                                                                     \
612
            memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos),                  \
gbazin's avatar
 
gbazin committed
613 614
                     ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
        }                                                                     \
615 616 617 618 619 620 621 622
        (p_ar)[i_pos] = elem;                                                 \
        (i_oldsize)++;                                                        \
    }                                                                         \
    while( 0 )

#define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
    do                                                                        \
    {                                                                         \
gbazin's avatar
 
gbazin committed
623 624 625 626 627 628
        if( (i_oldsize) - (i_pos) - 1 )                                       \
        {                                                                     \
            memmove( (p_ar) + (i_pos),                                        \
                     (p_ar) + (i_pos) + 1,                                    \
                     ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
        }                                                                     \
629 630 631 632 633 634 635 636 637 638 639 640 641 642
        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 )


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

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

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

Sam Hocevar's avatar
Sam Hocevar committed
728
static inline uint16_t GetWLE( void const * _p )
729 730 731 732
{
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Sam Hocevar's avatar
Sam Hocevar committed
733
static inline uint32_t GetDWLE( void const * _p )
734 735 736 737 738
{
    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
739
static inline uint64_t GetQWLE( void const * _p )
740 741 742 743 744 745 746 747 748 749 750 751
{
    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 )

gbazin's avatar
 
gbazin committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
/* 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 );
}
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
#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 );
}
795

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

812 813 814 815 816 817 818
/* 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
819 820 821 822 823 824 825
/* 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

gbazin's avatar
 
gbazin committed
826 827 828 829 830 831 832 833 834 835 836 837
/* 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
838 839 840
#ifdef HAVE_MEMALIGN
    /* Some systems have memalign() but no declaration for it */
    void * memalign( size_t align, size_t size );
gbazin's avatar
 
gbazin committed
841

842
#   define vlc_memalign(pp_orig,align,size) \
gbazin's avatar
 
gbazin committed
843 844 845
    ( *(pp_orig) = memalign( align, size ) )

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

Sam Hocevar's avatar
 
Sam Hocevar committed
852 853
#endif

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

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

869
#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
gbazin's avatar
 
gbazin committed
870 871 872 873 874 875
#   define asprintf vlc_asprintf
    VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
#elif !defined(__PLUGIN__)
#   define vlc_asprintf NULL
#endif

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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
889 890 891 892 893 894 895
#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

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

903 904 905 906 907 908
#ifndef HAVE_STRTOF
#   ifdef HAVE_STRTOD
#       define strtof strtod
#   endif
#endif

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

923
#if defined(SYS_BEOS)
924 925 926 927 928 929 930 931 932 933
    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

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

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

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

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