vlc_common.h 30.9 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3 4
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
5
 * Copyright (C) 1998-2005 the VideoLAN team
6
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
7 8 9
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
10
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
11 12 13 14 15
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
16
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
17 18 19 20 21 22 23
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25 26
 *****************************************************************************/

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

32
/*****************************************************************************
33
 * Required vlc headers
34
 *****************************************************************************/
35
#if defined( _MSC_VER )
Gildas Bazin's avatar
 
Gildas Bazin committed
36
#   pragma warning( disable : 4244 )
37 38
#endif

39 40
#include "vlc_config.h"

Sam Hocevar's avatar
 
Sam Hocevar committed
41 42 43
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
44
#include <stdlib.h>
45 46
#include <stdarg.h>

47
#include <string.h>
48
#include <stdio.h>
49
#include <inttypes.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
50

Sam Hocevar's avatar
 
Sam Hocevar committed
51 52 53
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
54
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
55
#   include <malloc.h>
56 57 58
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
59 60
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
61 62 63 64
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
65
typedef int16_t             dctelem_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
66 67

/* Video buffer types */
68
typedef uint8_t             yuv_data_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
69

70
/* Audio volume */
71 72
typedef uint16_t            audio_volume_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
73 74 75
/**
 * High precision date or time interval
 *
76 77
 * 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
78
 * time interval is then 292271 years, which should be long enough for any
79 80
 * 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
81
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
82
 */
83
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
84

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
85
/**
86
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
87
 *
88
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
89
 */
90
typedef uint32_t vlc_fourcc_t;
91

92 93
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
94 95
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
96
#   define VLC_TWOCC( a, b ) \
97
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
98

99 100
#else
#   define VLC_FOURCC( a, b, c, d ) \
101 102
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
103
#   define VLC_TWOCC( a, b ) \
104
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
105 106

#endif
107

108 109
static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
{
110
    memcpy( psz_fourcc, &fcc, 4 );
111 112 113 114 115
}

#define vlc_fourcc_to_char( a, b ) \
    __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )

Sam Hocevar's avatar
 
Sam Hocevar committed
116 117 118 119
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

120
/* Internal types */
121
typedef struct libvlc_int_t libvlc_int_t;
Sam Hocevar's avatar
Sam Hocevar committed
122
typedef struct variable_t variable_t;
123
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
124 125
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
126
typedef struct gc_object_t gc_object_t ;
127

128
/* Messages */
129
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
130

Gildas Bazin's avatar
 
Gildas Bazin committed
131
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
132 133 134 135 136 137

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
138
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
139 140
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
141 142 143
    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
144 145 146
} playlist_command_t;


147 148
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
149
typedef struct playlist_view_t playlist_view_t;
150
typedef struct playlist_export_t playlist_export_t;
151 152
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
153
typedef struct playlist_add_t playlist_add_t;
154
typedef struct playlist_preparse_t playlist_preparse_t;
155
typedef struct playlist_fetcher_t playlist_fetcher_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
156

157
/* Modules */
158 159 160 161
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;
162
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
163

Clément Stenac's avatar
Clément Stenac committed
164 165
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
166
/* Interface */
167 168 169 170
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;
171 172 173
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
174 175

/* Input */
176
typedef struct input_thread_t input_thread_t;
177
typedef struct input_thread_sys_t input_thread_sys_t;
178
typedef struct input_item_t input_item_t;
179
typedef struct access_t access_t;
180
typedef struct access_sys_t access_sys_t;
181 182 183
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
184
typedef struct demux_meta_t demux_meta_t;
185
typedef struct demux_sys_t demux_sys_t;
186 187 188
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;
189
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
190
typedef struct seekpoint_t seekpoint_t;
191 192
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
193
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
194

195 196 197 198
/* 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
199 200
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
201

Sam Hocevar's avatar
 
Sam Hocevar committed
202
/* Audio */
203 204
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
205
typedef struct aout_fifo_t aout_fifo_t;
206 207
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
208
typedef audio_format_t audio_sample_format_t;
209
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
210
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
211 212

/* Video */
213 214 215
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
typedef struct chroma_sys_t chroma_sys_t;
216

Gildas Bazin's avatar
 
Gildas Bazin committed
217
typedef video_format_t video_frame_format_t;
218 219 220
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
221

222
/* Subpictures */
223
typedef struct spu_t spu_t;
224 225
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
226
typedef struct subpicture_region_t subpicture_region_t;
227
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
228

229 230
typedef struct image_handler_t image_handler_t;

231 232
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
233 234
typedef struct sout_instance_sys_t sout_instance_sys_t;

235
typedef struct sout_input_t sout_input_t;
236
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
237

238
typedef struct sout_access_out_t sout_access_out_t;
239 240
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

241
typedef struct sout_mux_t sout_mux_t;
242 243
typedef struct sout_mux_sys_t sout_mux_sys_t;

244
typedef struct sout_stream_t    sout_stream_t;
245 246
typedef struct sout_stream_sys_t sout_stream_sys_t;

247
typedef struct config_chain_t       config_chain_t;
248 249 250 251 252 253
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;
254

255 256
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
257 258 259 260 261 262 263 264
typedef struct sout_std_t sout_std_t;
typedef struct sout_display_t sout_display_t;
typedef struct sout_duplicate_t sout_duplicate_t;
typedef struct sout_transcode_t sout_transcode_t;
typedef struct sout_chain_t sout_chain_t;
typedef struct streaming_profile_t streaming_profile_t;
typedef struct sout_module_t sout_module_t;
typedef struct sout_gui_descr_t sout_gui_descr_t;
265
typedef struct profile_parser_t profile_parser_t;
266

Sam Hocevar's avatar
 
Sam Hocevar committed
267
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
268 269 270
typedef struct decoder_t         decoder_t;
typedef struct decoder_sys_t     decoder_sys_t;
typedef struct decoder_synchro_t decoder_synchro_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
271

Gildas Bazin's avatar
 
Gildas Bazin committed
272 273 274 275
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

276 277 278 279
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

280
/* Network */
281
typedef struct network_socket_t network_socket_t;
282
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
283 284
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
285
typedef struct vlc_acl_t vlc_acl_t;
286
typedef struct vlc_url_t vlc_url_t;
287

288 289
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
Clément Stenac's avatar
Clément Stenac committed
290
typedef struct device_t device_t;
291 292
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
293

294 295 296 297
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

298 299 300 301 302 303 304
/* httpd */
typedef struct httpd_t          httpd_t;
typedef struct httpd_host_t     httpd_host_t;
typedef struct httpd_url_t      httpd_url_t;
typedef struct httpd_client_t   httpd_client_t;
typedef struct httpd_callback_sys_t httpd_callback_sys_t;
typedef struct httpd_message_t  httpd_message_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
305
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
306 307
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
308 309 310
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
311
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 );
312 313 314
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
315 316 317 318
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

319 320 321
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
322 323 324 325 326 327
/* 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;

328 329 330
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
331
typedef struct vod_media_t vod_media_t;
332

333 334 335 336
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

337 338 339 340 341 342 343
/* 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;

344
/* VLM */
345 346
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
347 348 349

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

352
/* Stats */
353 354 355
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
356
typedef struct input_stats_t input_stats_t;
357
typedef struct global_stats_t global_stats_t;
358

359 360 361
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
362

363 364 365
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

366 367
/* stat/lstat/fstat */
#ifdef WIN32
368
#include <sys/stat.h>
369
struct _stati64;
370 371 372
#define stat _stati64
#define fstat _fstati64
/* You should otherwise use utf8_stat and utf8_lstat. */
373 374 375 376
#else
struct stat;
#endif

377 378 379 380 381 382 383 384 385
/*****************************************************************************
 * 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
386 387 388
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
389

390 391
#if defined (WIN32) && defined (DLL_EXPORT)
#  ifdef __cplusplus
392
#    define VLC_PUBLIC_API extern "C" __declspec(dllexport)
Damien Fouilleul's avatar
Damien Fouilleul committed
393
#    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
394
#  else
395
#    define VLC_PUBLIC_API extern __declspec(dllexport)
Damien Fouilleul's avatar
Damien Fouilleul committed
396
#    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
397 398
#  endif
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
399
#  ifdef __cplusplus
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
400
#    ifdef HAVE_ATTRIBUTE_VISIBILITY
401
#      define VLC_PUBLIC_API extern "C" __attribute__((visibility("default")))
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
402
#      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
Damien Fouilleul's avatar
Damien Fouilleul committed
403
#    else
404
#      define VLC_PUBLIC_API extern "C"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
405
#      define   VLC_EXPORT( type, name, args ) extern "C" type name args
Damien Fouilleul's avatar
Damien Fouilleul committed
406
#    endif
407
#  else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
408
#    ifdef HAVE_ATTRIBUTE_VISIBILITY
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
409 410 411
#      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
#      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
#    else
412
#      define VLC_PUBLIC_API extern
413
#      define   VLC_EXPORT( type, name, args ) extern type name args
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
414
#    endif
415
#  endif
Gildas Bazin's avatar
 
Gildas Bazin committed
416 417
#endif

418 419 420
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
421
#if defined( WIN32 ) || defined( UNDER_CE )
422 423
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
424 425 426 427 428
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
429 430
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
431
#include "vlc_mtime.h"
432 433
#include "vlc_threads.h"

434 435
typedef struct vlc_object_internals_t vlc_object_internals_t;

436 437 438 439 440 441
/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
442 443 444 445
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
446 447
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
448
    const char *psz_object_type;                                            \
449
    char *psz_object_name;                                                  \
450
                                                                            \
451 452
    /* Messages header */                                                   \
    char *psz_header;                                                       \
453
    int  i_flags;                                                           \
454
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
455 456 457
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
458
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
459
    /* Object properties */                                                 \
460 461 462 463
    volatile bool b_error;                  /**< set by the object */ \
    volatile bool b_die;                   /**< set by the outside */ \
    volatile bool b_dead;                   /**< set by the object */ \
    bool b_force;      /**< set by the outside (eg. module_Need()) */ \
464
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
465
    /* Stuff related to the libvlc structure */                             \
466
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
467
                                                                            \
468
    vlc_object_t *  p_parent;                            /**< our parent */ \
469
                                                                            \
470 471 472
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
473
    /** Just a reminder so that people don't cast garbage */                \
474
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
475
/**@}*/                                                                     \
476

477 478
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
479
    (((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct)
480

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
#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 )
{
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
503 504
    if( !p_gc ) return;

505 506 507 508 509 510
    p_gc->i_gc_refcount -- ;

    if( p_gc->i_gc_refcount == 0 )
    {
        p_gc->pf_destructor( p_gc );
        /* Do not use the p_gc pointer from now on ! */
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
511 512 513 514 515 516 517 518 519 520
    }
}

static inline void
__vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
               void * arg)
{
    p_gc->i_gc_refcount = 1;
    p_gc->pf_destructor = pf_destructor;
    p_gc->p_destructor_arg = arg;
521 522 523 524
}

#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
525
#define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
526 527


Sam Hocevar's avatar
 
Sam Hocevar committed
528 529 530 531 532 533
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

534
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
535 536 537 538 539 540 541 542 543 544
#   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
545 546 547
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
548
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
549 550
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
551 552
#endif

553
static inline int64_t GCD( int64_t a, int64_t b )
554
{
555 556 557 558 559 560 561
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
562 563
}

564 565 566 567 568 569 570
/* function imported from libavutil/common.h */
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

571
/* Malloc with automatic error */
572 573 574 575 576 577 578 579
#define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return; } while(0)
#define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return NULL; } while(0)
#define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                   if( !var ) return VLC_ENOMEM; } while(0)
#define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
                                      if( !var ) goto error; } while(0)
580 581
#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return;
582
#define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
583
                                    if( !var ) return VLC_ENOMEM;
584 585 586
#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
                                    if( !var ) return NULL;

587
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
Clément Stenac's avatar
Clément Stenac committed
588

589 590
#define EMPTY_STR(str) (!str || !*str)

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

593
#include <vlc_arrays.h>
594

Sam Hocevar's avatar
 
Sam Hocevar committed
595 596 597
/* 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
598
 * the VAX seems to have such exotic properties. */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
599
static inline uint16_t U16_AT( const void * _p )
600
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
601
    const uint8_t * p = (const uint8_t *)_p;
602
    return ( ((uint16_t)p[0] << 8) | p[1] );
603
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
604
static inline uint32_t U32_AT( const void * _p )
605
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
606
    const uint8_t * p = (const uint8_t *)_p;
607 608
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
609
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
610
static inline uint64_t U64_AT( const void * _p )
611
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
612
    const uint8_t * p = (const uint8_t *)_p;
613 614 615 616
    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] );
617
}
618

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
619
static inline uint16_t GetWLE( const void * _p )
620
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
621
    const uint8_t * p = (const uint8_t *)_p;
622 623
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
624
static inline uint32_t GetDWLE( const void * _p )
625
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
626
    const uint8_t * p = (const uint8_t *)_p;
627 628 629
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
630
static inline uint64_t GetQWLE( const void * _p )
631
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
632
    const uint8_t * p = (const uint8_t *)_p;
633 634 635 636 637 638 639 640 641 642
    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
643
/* Helper writer functions */
644
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
645 646 647 648 649 650
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

651
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
652 653 654 655 656 657 658
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;
}
659
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
660 661 662 663 664
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
665
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
666 667 668 669 670 671
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

672
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
673 674 675 676 677 678 679
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;
}
680
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
681 682 683 684 685
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
686

687 688 689 690 691
#define hton16(i) htons(i)
#define hton32(i) htonl(i)
#define ntoh16(i) ntohs(i)
#define ntoh32(i) ntohl(i)

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
692
#ifdef WORDS_BIGENDIAN
Sam Hocevar's avatar
 
Sam Hocevar committed
693 694 695
#   define hton64(i)   ( i )
#   define ntoh64(i)   ( i )
#else
696 697
#   define hton64(i)   U64_AT(&i)
#   define ntoh64(i)   U64_AT(&i)
Sam Hocevar's avatar
 
Sam Hocevar committed
698 699
#endif

700 701 702 703 704 705 706
/* 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
707 708 709 710 711 712 713
/* 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

714 715 716 717
#ifdef HAVE_ATTRIBUTE_PACKED
#   define ATTR_PACKED __attribute__((__packed__))
#endif

718 719 720
/* */
#define VLC_UNUSED(x) (void)(x)

721
/* Stuff defined in src/extras/libc.c */
722 723 724 725
VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
726

727 728 729
struct dirent;
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 ) );
730

731
VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
732

733
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
734
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
735
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
736 737
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
738
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
739 740 741 742 743 744 745 746 747
#       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_ )
748 749
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
750 751
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
752 753 754
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
755 756 757 758
#           define off_t long long
#       endif
#   endif

759
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
760
#       if !defined( _OFF_T_DEFINED )
761
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
762 763
#           define _OFF_T_DEFINED
#       else
764
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
765 766 767 768
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
769
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
770
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
771
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
772 773
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
774 775
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
776 777 778 779
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
780 781
#   endif

782
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
783
#   ifndef snprintf
784 785 786 787
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
788 789
#   endif

790
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
791 792
#endif

793
VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
794

Gildas Bazin's avatar
 
Gildas Bazin committed
795 796
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
797
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
798

799 800 801
/* 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 * ) );
802
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
803 804
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

805
/* execve wrapper (defined in src/extras/libc.c) */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
806
VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const *pp_argv, char *const *pp_env, const char *psz_cwd, const char *p_in, size_t i_in, char **pp_data, size_t *pi_data ) );
807 808
#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
809 810 811 812 813 814 815 816 817 818 819
/*****************************************************************************
 * 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
820
#define CPU_CAPABILITY_SSE2    (1<<7)
Sam Hocevar's avatar
 
Sam Hocevar committed
821 822
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)
823
VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
824 825 826 827 828

typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);

VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
829 830
VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
Sam Hocevar's avatar
 
Sam Hocevar committed
831 832 833 834

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
835
#ifdef WIN32
836
VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
837
VLC_EXPORT( int, vlc_wclosedir, (void *) );
838
#endif
839

840
VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) );
841

842 843 844 845 846 847 848 849 850
/*****************************************************************************
 * 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 ) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
851
VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
852

853
/*****************************************************************************
854
 * Additional vlc stuff
855
 *****************************************************************************/
856
#include "vlc_messages.h"
Clément Stenac's avatar
Clément Stenac committed
857
#include "vlc_variables.h"
Sam Hocevar's avatar
Sam Hocevar committed
858
#include "vlc_objects.h"
Clément Stenac's avatar
Clément Stenac committed
859
#include "vlc_modules.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
860
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
861
#include "vlc_configuration.h"
862

Antoine Cellerier's avatar
Antoine Cellerier committed
863
#if defined( WIN32 ) || defined( UNDER_CE )
864
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
865
#   define DIR_SEP "\\"
866 867
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
868
#else
869
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
870
#   define DIR_SEP "/"
871 872
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
873
#endif