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

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

32
33
34
#ifndef VLC_COMMON_H
# define VLC_COMMON_H 1

35
/*****************************************************************************
36
 * Required vlc headers
37
 *****************************************************************************/
38
#if defined( _MSC_VER )
gbazin's avatar
   
gbazin committed
39
#   pragma warning( disable : 4244 )
40
41
#endif

42
43
#include "vlc_config.h"

Sam Hocevar's avatar
   
Sam Hocevar committed
44
45
46
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
gbazin's avatar
   
gbazin committed
47
#include <stdlib.h>
48
49
#include <stdarg.h>

50
#include <string.h>
51
#include <stdio.h>
52
#include <inttypes.h>
53
#include <stddef.h>
Sam Hocevar's avatar
   
Sam Hocevar committed
54

55
56
57
58
#ifndef __cplusplus
# include <stdbool.h>
#endif

59
60
61
62
63
64
65
66
67
/* Format string sanity checks */
#ifdef __GNUC__
#   define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
#   define LIBVLC_USED __attribute__ ((warn_unused_result))
#else
#   define LIBVLC_FORMAT(x,y)
#   define LIBVLC_USED
#endif

Sam Hocevar's avatar
   
Sam Hocevar committed
68
69
70
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
71
#if defined( WIN32 ) || defined( UNDER_CE )
gbazin's avatar
   
gbazin committed
72
#   include <malloc.h>
73
74
75
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
gbazin's avatar
   
gbazin committed
76
77
#endif

Sam Hocevar's avatar
   
Sam Hocevar committed
78
79
80
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

81
/* Audio volume */
82
83
typedef uint16_t            audio_volume_t;

sigmunau's avatar
sigmunau committed
84
85
86
/**
 * High precision date or time interval
 *
87
88
 * 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
89
 * time interval is then 292271 years, which should be long enough for any
90
91
 * 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
92
 * arithmetic operators, and that no special functions are required.
sigmunau's avatar
sigmunau committed
93
 */
94
typedef int64_t mtime_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
95

sigmunau's avatar
sigmunau committed
96
/**
97
 * The vlc_fourcc_t type.
sigmunau's avatar
sigmunau committed
98
 *
99
 * See http://www.webartz.com/fourcc/ for a very detailed list.
sigmunau's avatar
sigmunau committed
100
 */
101
typedef uint32_t vlc_fourcc_t;
102

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )

#else
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )

#endif

119
120
121
122
123
124
125
/**
 * Translate a vlc_fourcc into its string representation. This function
 * assumes there is enough room in psz_fourcc to store 4 characters in.
 *
 * \param fcc a vlc_fourcc_t
 * \param psz_fourcc string to store string representation of vlc_fourcc in
 */
126
127
static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
{
128
    memcpy( psz_fourcc, &fcc, 4 );
129
130
131
132
133
}

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

Sam Hocevar's avatar
   
Sam Hocevar committed
134
135
136
137
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

138
/* Internal types */
139
140
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
141
typedef struct libvlc_int_t libvlc_int_t;
142
typedef struct date_t date_t;
zorglub's avatar
zorglub committed
143
144
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
145

gbazin's avatar
   
gbazin committed
146
/* Playlist */
hartman's avatar
hartman committed
147
148
149
150
151
152

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
zorglub's avatar
zorglub committed
153
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
154
155
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
zorglub's avatar
zorglub committed
156
157
158
    PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
hartman's avatar
hartman committed
159
160
161
} playlist_command_t;


162
163
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
zorglub's avatar
zorglub committed
164
typedef struct playlist_view_t playlist_view_t;
zorglub's avatar
zorglub committed
165
typedef struct playlist_export_t playlist_export_t;
zorglub's avatar
zorglub committed
166
167
typedef struct services_discovery_t services_discovery_t;
typedef struct services_discovery_sys_t services_discovery_sys_t;
zorglub's avatar
zorglub committed
168
typedef struct playlist_add_t playlist_add_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
169

170
/* Modules */
171
172
173
174
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;
175
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
176

zorglub's avatar
zorglub committed
177
178
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
179
/* Interface */
180
181
182
typedef struct intf_thread_t intf_thread_t;
typedef struct intf_sys_t intf_sys_t;
typedef struct intf_msg_t intf_msg_t;
183
typedef struct user_widget_t user_widget_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
184
185

/* Input */
186
typedef struct input_thread_t input_thread_t;
187
typedef struct input_thread_sys_t input_thread_sys_t;
188
typedef struct input_item_t input_item_t;
189
typedef struct access_t access_t;
190
typedef struct access_sys_t access_sys_t;
191
192
193
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
194
typedef struct demux_meta_t demux_meta_t;
195
typedef struct demux_sys_t demux_sys_t;
196
197
198
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;
199
typedef struct es_descriptor_t es_descriptor_t;
gbazin's avatar
gbazin committed
200
typedef struct seekpoint_t seekpoint_t;
201
202
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
203
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
204

205
206
207
208
/* 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
209
210
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
211

Sam Hocevar's avatar
   
Sam Hocevar committed
212
/* Audio */
213
214
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
215
typedef struct aout_fifo_t aout_fifo_t;
216
217
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
gbazin's avatar
   
gbazin committed
218
typedef audio_format_t audio_sample_format_t;
219
typedef struct audio_date_t audio_date_t;
gbazin's avatar
   
gbazin committed
220
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
221
222

/* Video */
223
224
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
225

gbazin's avatar
   
gbazin committed
226
typedef video_format_t video_frame_format_t;
227
228
229
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
230

231
/* Subpictures */
232
typedef struct spu_t spu_t;
233
234
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
235
typedef struct subpicture_region_t subpicture_region_t;
236
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
237

238
239
typedef struct image_handler_t image_handler_t;

240
241
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
242
243
typedef struct sout_instance_sys_t sout_instance_sys_t;

244
typedef struct sout_input_t sout_input_t;
245
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
246

247
typedef struct sout_access_out_t sout_access_out_t;
248
249
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

250
typedef struct sout_mux_t sout_mux_t;
251
252
typedef struct sout_mux_sys_t sout_mux_sys_t;

253
typedef struct sout_stream_t    sout_stream_t;
254
255
typedef struct sout_stream_sys_t sout_stream_sys_t;

256
typedef struct config_chain_t       config_chain_t;
zorglub's avatar
zorglub committed
257
258
typedef struct session_descriptor_t session_descriptor_t;
typedef struct announce_method_t announce_method_t;
259

260
261
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
262
263
264
265
266
267
268
269
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;
zorglub's avatar
zorglub committed
270
typedef struct profile_parser_t profile_parser_t;
271

Sam Hocevar's avatar
   
Sam Hocevar committed
272
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
273
274
275
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
276

gbazin's avatar
   
gbazin committed
277
278
279
280
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

281
282
283
284
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

285
/* Network */
286
typedef struct network_socket_t network_socket_t;
287
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
288
289
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
290
typedef struct vlc_acl_t vlc_acl_t;
291
typedef struct vlc_url_t vlc_url_t;
292

293
294
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
zorglub's avatar
zorglub committed
295
typedef struct device_t device_t;
296
297
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
298

299
300
301
302
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

303
304
305
306
307
308
309
/* 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
310
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
311
312
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
313
314
315
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
316
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 );
317
318
319
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
320
321
322
323
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

324
325
326
/* Hashing */
typedef struct md5_s md5_t;

gbazin's avatar
gbazin committed
327
328
329
330
331
332
/* 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;

333
334
335
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
336
typedef struct vod_media_t vod_media_t;
337

338
339
340
341
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

342
343
344
345
346
347
348
/* 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;

349
/* VLM */
350
351
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
352
353
354

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

357
/* Stats */
358
359
360
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
361
typedef struct input_stats_t input_stats_t;
362

363
364
365
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
366

367
368
369
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

370
371
/* stat/lstat/fstat */
#ifdef WIN32
372
#include <sys/stat.h>
373

geal's avatar
geal committed
374
# ifndef UNDER_CE
375
struct _stati64;
376
377
#define stat _stati64
#define fstat _fstati64
378
379
#endif

380
/* You should otherwise use utf8_stat and utf8_lstat. */
381
382
383
384
#else
struct stat;
#endif

385
386
387
388
389
390
/**
 * VLC value structure
 */
typedef union
{
    int             i_int;
391
    bool            b_bool;
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_object_t *  p_object;
    vlc_list_t *    p_list;
    mtime_t         i_time;

    struct { char *psz_name; int i_object_id; } var;

   /* Make sure the structure is at least 64bits */
    struct { char a, b, c, d, e, f, g, h; } padding;

} vlc_value_t;

/**
 * VLC list structure
 */
struct vlc_list_t
{
    int             i_count;
    vlc_value_t *   p_values;
    int *           pi_types;

};

/**
 * \defgroup var_type Variable types
 * These are the different types a vlc variable can have.
 * @{
 */
#define VLC_VAR_VOID      0x0010
#define VLC_VAR_BOOL      0x0020
#define VLC_VAR_INTEGER   0x0030
#define VLC_VAR_HOTKEY    0x0031
#define VLC_VAR_STRING    0x0040
#define VLC_VAR_MODULE    0x0041
#define VLC_VAR_FILE      0x0042
#define VLC_VAR_DIRECTORY 0x0043
#define VLC_VAR_VARIABLE  0x0044
#define VLC_VAR_FLOAT     0x0050
#define VLC_VAR_TIME      0x0060
#define VLC_VAR_ADDRESS   0x0070
#define VLC_VAR_MUTEX     0x0080
#define VLC_VAR_LIST      0x0090
/**@}*/

/*****************************************************************************
 * Error values (shouldn't be exposed)
 *****************************************************************************/
#define VLC_SUCCESS         -0                                   /* No error */
#define VLC_ENOMEM          -1                          /* Not enough memory */
#define VLC_ETHREAD         -2                               /* Thread error */
#define VLC_ETIMEOUT        -3                                    /* Timeout */

#define VLC_ENOMOD         -10                           /* Module not found */

#define VLC_ENOOBJ         -20                           /* Object not found */

#define VLC_ENOVAR         -30                         /* Variable not found */
#define VLC_EBADVAR        -31                         /* Bad variable value */

#define VLC_ENOITEM        -40                           /**< Item not found */

#define VLC_EEXIT         -255                             /* Program exited */
#define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
#define VLC_EGENERIC      -666                              /* Generic error */

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

472
473
474
475
476
#ifdef __cplusplus
# define LIBVLC_EXTERN extern "C"
#else
# define LIBVLC_EXTERN extern
#endif
477
#if defined (WIN32) && defined (DLL_EXPORT)
geal's avatar
geal committed
478
479
480
#if defined (UNDER_CE)
# include <windef.h>
#endif
481
# define LIBVLC_EXPORT __declspec(dllexport)
482
#else
483
# define LIBVLC_EXPORT
gbazin's avatar
   
gbazin committed
484
#endif
485
486
#define VLC_EXPORT( type, name, args ) \
                        LIBVLC_EXTERN LIBVLC_EXPORT type name args
gbazin's avatar
   
gbazin committed
487

488
489
490
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
491
#if defined( WIN32 ) || defined( UNDER_CE )
492
493
494
495
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
496
#include "vlc_mtime.h"
497
498
499
500
501
502
503
504
#include "vlc_threads.h"

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

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
505
506
507
508
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
509
    const char *psz_object_type;                                            \
510
    char *psz_object_name;                                                  \
511
                                                                            \
512
513
    /* Messages header */                                                   \
    char *psz_header;                                                       \
514
    int  i_flags;                                                           \
515
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
516
    /* Object properties */                                                 \
517
518
    volatile bool b_error;                  /**< set by the object */ \
    volatile bool b_die;                   /**< set by the outside */ \
519
    bool b_force;      /**< set by the outside (eg. module_need()) */ \
520
                                                                            \
521
522
523
    /** Just a reminder so that people don't cast garbage */                \
    bool be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                       \
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
524
    /* Stuff related to the libvlc structure */                             \
525
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
526
                                                                            \
527
    vlc_object_t *  p_parent;                            /**< our parent */ \
528
                                                                            \
529
530
531
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
532
/**@}*/                                                                     \
533

534
/* VLC_OBJECT: attempt at doing a clever cast */
535
536
537
538
539
540
#ifdef __GNUC__
# define VLC_OBJECT( x ) \
    (((vlc_object_t *)(x))+0*(((typeof(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct))
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)(x))
#endif
541

542
typedef struct gc_object_t
543
{
544
545
546
547
    vlc_spinlock_t spin;
    uintptr_t      refs;
    void          (*pf_destructor) (struct gc_object_t *);
} gc_object_t;
548

549
550
551
552
/**
 * These members are common to all objects that wish to be garbage-collected.
 */
#define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
553

554
555
556
VLC_EXPORT(void *, vlc_gc_init, (gc_object_t *, void (*)(gc_object_t *)));
VLC_EXPORT(void *, vlc_hold, (gc_object_t *));
VLC_EXPORT(void, vlc_release, (gc_object_t *));
557

558
559
560
561
#define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
#define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
#define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
#define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
562

Sam Hocevar's avatar
   
Sam Hocevar committed
563
564
565
566
567
568
569
570
571
572
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/

/* 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
573
574
575
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
   
Sam Hocevar committed
576
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
577
578
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
   
Sam Hocevar committed
579
580
#endif

581
582
LIBVLC_USED
static inline int64_t GCD ( int64_t a, int64_t b )
583
{
584
585
586
587
588
589
590
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
591
592
}

593
/* function imported from libavutil/common.h */
594
LIBVLC_USED
595
596
597
598
599
600
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

601
/* Free and set set the variable to NULL */
602
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
zorglub's avatar
zorglub committed
603

604
605
#define EMPTY_STR(str) (!str || !*str)

606
VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED );
zorglub's avatar
zorglub committed
607

zorglub's avatar
zorglub committed
608
#include <vlc_arrays.h>
zorglub's avatar
zorglub committed
609

Sam Hocevar's avatar
   
Sam Hocevar committed
610
/* MSB (big endian)/LSB (little endian) conversions - network order is always
611
 * MSB, and should be used for both network communications and files. */
612
LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
613
static inline uint16_t U16_AT( const void * _p )
614
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
615
    const uint8_t * p = (const uint8_t *)_p;
616
    return ( ((uint16_t)p[0] << 8) | p[1] );
617
}
618
619

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
620
static inline uint32_t U32_AT( const void * _p )
621
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
622
    const uint8_t * p = (const uint8_t *)_p;
623
624
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
625
}
626
627

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
628
static inline uint64_t U64_AT( const void * _p )
629
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
630
    const uint8_t * p = (const uint8_t *)_p;
631
632
633
634
    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] );
635
}
636

637
LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
638
static inline uint16_t GetWLE( const void * _p )
639
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
640
    const uint8_t * p = (const uint8_t *)_p;
641
642
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
643
644

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
645
static inline uint32_t GetDWLE( const void * _p )
646
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
647
    const uint8_t * p = (const uint8_t *)_p;
648
649
650
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
651
652

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
653
static inline uint64_t GetQWLE( const void * _p )
654
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
655
    const uint8_t * p = (const uint8_t *)_p;
656
657
658
659
660
661
662
663
664
665
    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
666
/* Helper writer functions */
667
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
gbazin's avatar
   
gbazin committed
668
669
670
671
672
673
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

674
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
gbazin's avatar
   
gbazin committed
675
676
677
678
679
680
681
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;
}
682
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
gbazin's avatar
   
gbazin committed
683
684
685
686
687
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
688
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
689
690
691
692
693
694
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

695
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
696
697
698
699
700
701
702
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;
}
703
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
704
705
706
707
708
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
709

710
711
712
713
714
#define hton16(i) htons(i)
#define hton32(i) htonl(i)
#define ntoh16(i) ntohs(i)
#define ntoh32(i) ntohl(i)

715
LIBVLC_USED
716
717
718
719
720
721
722
723
724
725
726
727
728
static inline uint64_t ntoh64 (uint64_t ll)
{
    union { uint64_t qw; uint8_t b[16]; } v = { ll };
    return ((uint64_t)v.b[0] << 56)
         | ((uint64_t)v.b[1] << 48)
         | ((uint64_t)v.b[2] << 40)
         | ((uint64_t)v.b[3] << 32)
         | ((uint64_t)v.b[4] << 24)
         | ((uint64_t)v.b[5] << 16)
         | ((uint64_t)v.b[6] <<  8)
         | ((uint64_t)v.b[7] <<  0);
}
#define hton64(i) ntoh64(i)
Sam Hocevar's avatar
   
Sam Hocevar committed
729

730
731
732
/* */
#define VLC_UNUSED(x) (void)(x)

733
/* Stuff defined in src/extras/libc.c */
734
VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
735
VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) LIBVLC_USED );
736

737
VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) LIBVLC_USED );
738

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

765
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
   
Sam Hocevar committed
766
#       if !defined( _OFF_T_DEFINED )
767
            typedef __int64 off_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
768
769
#           define _OFF_T_DEFINED
#       else
770
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
   
Sam Hocevar committed
771
772
773
774
#           define off_t __int64
#       endif
#   endif

ipkiss's avatar
   
ipkiss committed
775
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
   
Sam Hocevar committed
776
#       undef off_t
ipkiss's avatar
   
ipkiss committed
777
#       define off_t unsigned __int64
Sam Hocevar's avatar
   
Sam Hocevar committed
778
779
#   endif

gbazin's avatar
   
gbazin committed
780
781
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
gbazin's avatar
   
gbazin committed
782
783
784
785
#   endif

#   ifndef alloca
#       define alloca _alloca
Sam Hocevar's avatar
   
Sam Hocevar committed
786
787
#   endif

788
#   include <tchar.h>
Sam Hocevar's avatar
   
Sam Hocevar committed
789
790
#endif

791
VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
792

gbazin's avatar
   
gbazin committed
793
794
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
795
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) LIBVLC_USED );
gbazin's avatar
   
gbazin committed
796

797
798
/* iconv wrappers (defined in src/extras/libc.c) */
typedef void *vlc_iconv_t;
799
800
VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) LIBVLC_USED );
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) LIBVLC_USED );
801
802
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

803
/* execve wrapper (defined in src/extras/libc.c) */
804
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 ) LIBVLC_USED );
805
806
#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)

807
808
809
/* dir wrappers (defined in src/extras/libc.c) */
VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));

Sam Hocevar's avatar
   
Sam Hocevar committed
810
811
812
813
814
815
816
817
818
819
820
/*****************************************************************************
 * 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)
sigmunau's avatar
sigmunau committed
821
#define CPU_CAPABILITY_SSE2    (1<<7)
Sam Hocevar's avatar
   
Sam Hocevar committed
822
823
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)
824
VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
825
826
827
828
829

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) );
830
831
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
832
833
834
835

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
836
VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_USED );
837

838
839
840
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
841
842
843
844
845
846
VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_Error, ( int ) LIBVLC_USED );
847

848
/*****************************************************************************
849
 * Additional vlc stuff
850
 *****************************************************************************/
851
#include "vlc_messages.h"
zorglub's avatar
zorglub committed
852
#include "vlc_variables.h"
Sam Hocevar's avatar
Sam Hocevar committed
853
#include "vlc_objects.h"
zorglub's avatar
zorglub committed
854
#include "vlc_modules.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
855
#include "vlc_main.h"
zorglub's avatar
zorglub committed
856
#include "vlc_configuration.h"
857

dionoea's avatar
dionoea committed
858
#if defined( WIN32 ) || defined( UNDER_CE )
dionoea's avatar
dionoea committed
859
#   define DIR_SEP_CHAR '\\'
dionoea's avatar
dionoea committed
860
#   define DIR_SEP "\\"
861
862
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
dionoea's avatar
dionoea committed
863
#else
dionoea's avatar
dionoea committed
864
#   define DIR_SEP_CHAR '/'
dionoea's avatar
dionoea committed
865
#   define DIR_SEP "/"
866
867
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
dionoea's avatar
dionoea committed
868
#endif
869

870
871
872
873
874
875
#define LICENSE_MSG \
  _("This program comes with NO WARRANTY, to the extent permitted by " \
    "law.\nYou may redistribute it under the terms of the GNU General " \
    "Public License;\nsee the file named COPYING for details.\n" \
    "Written by the VideoLAN team; see the AUTHORS file.\n")

876
#endif /* !VLC_COMMON_H */