vlc_common.h 17.7 KB
Newer Older
Sam Hocevar's avatar
   
Sam Hocevar committed
1
2
3
4
5
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
 * Copyright (C) 1998, 1999, 2000 VideoLAN
6
 * $Id: vlc_common.h,v 1.27 2002/09/18 21:21:23 massiot Exp $
Sam Hocevar's avatar
   
Sam Hocevar committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
 *          Gildas Bazin <gbazin@netcourrier.com>
 *
 * 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.
 * 
 * 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
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

27
/*****************************************************************************
28
 * Required vlc headers
29
 *****************************************************************************/
30
31
32
33
34
35
#if defined( __BORLANDC__ )
#   undef PACKAGE
#endif

#include "config.h"

36
37
38
39
40
#if defined( __BORLANDC__ )
#   undef HAVE_VARIADIC_MACROS
#   undef HAVE_STDINT_H
#endif

41
42
43
#include "vlc_config.h"
#include "modules_inner.h"

Sam Hocevar's avatar
   
Sam Hocevar committed
44
45
46
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
47
48
49
50
51
52
53
#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
54
55
56
57

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
58
59
60
61
#ifdef HAVE_STDINT_H
#   include <stdint.h>
    typedef uint8_t             u8;
    typedef int8_t              s8;
Sam Hocevar's avatar
   
Sam Hocevar committed
62

63
64
    typedef uint16_t            u16;
    typedef int16_t             s16;
Sam Hocevar's avatar
   
Sam Hocevar committed
65

66
67
    typedef uint32_t            u32;
    typedef int32_t             s32;
Sam Hocevar's avatar
   
Sam Hocevar committed
68

69
70
    typedef uint64_t            u64;
    typedef int64_t             s64;
Sam Hocevar's avatar
   
Sam Hocevar committed
71
#else
72
73
    typedef unsigned char       u8;
    typedef signed char         s8;
Sam Hocevar's avatar
   
Sam Hocevar committed
74

75
76
    typedef unsigned short      u16;
    typedef signed short        s16;
Sam Hocevar's avatar
   
Sam Hocevar committed
77

78
79
80
81
82
83
84
85
86
87
    typedef unsigned int        u32;
    typedef signed int          s32;

#   if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
    typedef unsigned __int64    u64;
    typedef signed __int64      s64;
#   else
    typedef unsigned long long  u64;
    typedef signed long long    s64;
#   endif
Sam Hocevar's avatar
   
Sam Hocevar committed
88
89
#endif

90
91
typedef u8                      byte_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
92
93
94
95
96
97
98
99
100
101
102
103
/* 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

gbazin's avatar
   
gbazin committed
104
105
#if defined( WIN32 )
typedef int                 ssize_t;
Xavier Marchesini's avatar
   
Xavier Marchesini committed
106
107
#endif

Sam Hocevar's avatar
   
Sam Hocevar committed
108
109
110
111
112
113
114
115
116
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
typedef s16                 dctelem_t;

/* Video buffer types */
typedef u8                  yuv_data_t;

117
118
119
/* Audio volume */
typedef u16                 audio_volume_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
120
121
122
123
124
125
126
127
128
129
130
131
/*****************************************************************************
 * mtime_t: high precision date or time interval
 *****************************************************************************
 * Store an high precision date or time interval. The maximum precision is the
 * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
 * time interval is then 292271 years, which should be long enough for any
 * video). Date are stored as a time interval since a common date.
 * Note that date and time intervals can be manipulated using regular
 * arithmetic operators, and that no special functions are required.
 *****************************************************************************/
typedef s64 mtime_t;

132
133
134
135
136
137
138
/*****************************************************************************
 * The vlc_fourcc_t type.
 *****************************************************************************
 * See http://www.webartz.com/fourcc/ for a very detailed list.
 *****************************************************************************/
typedef u32 vlc_fourcc_t;

139
140
141
142
143
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((u32)d) | ( ((u32)c) << 8 ) | ( ((u32)b) << 16 ) | ( ((u32)a) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (u16)(b) | ( (u16)(a) << 8 ) )
144

145
146
147
148
149
150
151
#else
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (u16)(a) | ( (u16)(b) << 8 ) )

#endif
152

Sam Hocevar's avatar
   
Sam Hocevar committed
153
154
155
156
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

157
/* Messages */
158
159
typedef struct msg_bank_t msg_bank_t;
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
160

gbazin's avatar
   
gbazin committed
161
/* Playlist */
162
163
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
164

165
/* Modules */
166
167
168
169
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;
Sam Hocevar's avatar
   
Sam Hocevar committed
170
171

/* Interface */
172
173
174
175
176
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;
typedef struct intf_channel_t intf_channel_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
177
178

/* Input */
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
typedef struct input_thread_t input_thread_t;
typedef struct input_channel_t input_channel_t;
typedef struct input_area_t input_area_t;
typedef struct input_buffers_t input_buffers_t;
typedef struct input_socket_t input_socket_t;
typedef struct input_info_t input_info_t;
typedef struct input_info_category_t input_info_category_t;
typedef struct access_sys_t access_sys_t;
typedef struct demux_sys_t demux_sys_t;
typedef struct es_descriptor_t es_descriptor_t;
typedef struct es_sys_t es_sys_t;
typedef struct pgrm_descriptor_t pgrm_descriptor_t;
typedef struct pgrm_sys_t pgrm_sys_t;
typedef struct stream_descriptor_t stream_descriptor_t;
typedef struct stream_sys_t stream_sys_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
194
195

/* Audio */
196
197
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
198
typedef struct aout_fifo_t aout_fifo_t;
199
200
201
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
typedef struct audio_sample_format_t audio_sample_format_t;
202
typedef struct audio_date_t audio_date_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
203
204

/* Video */
205
206
207
208
209
210
211
212
213
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_font_t vout_font_t;
typedef struct vout_sys_t vout_sys_t;
typedef struct chroma_sys_t chroma_sys_t;
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
214

215
216
217
218
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
typedef struct sout_fifo_t sout_fifo_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
219
/* Decoders */
220
typedef struct decoder_fifo_t decoder_fifo_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
221
222

/* Misc */
223
224
225
226
227
228
229
230
typedef struct data_packet_t data_packet_t;
typedef struct data_buffer_t data_buffer_t;
typedef struct stream_position_t stream_position_t;
typedef struct stream_ctrl_t stream_ctrl_t;
typedef struct pes_packet_t pes_packet_t;
typedef struct bit_stream_t bit_stream_t;
typedef struct network_socket_t network_socket_t;
typedef struct iso639_lang_t iso639_lang_t;
231

gbazin's avatar
   
gbazin committed
232
233
234
235
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
#ifndef __PLUGIN__
236
#   define VLC_EXPORT( type, name, args ) type name args
gbazin's avatar
   
gbazin committed
237
#else
238
#   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
gbazin's avatar
   
gbazin committed
239
240
241
    extern module_symbols_t* p_symbols;
#endif

242
243
244
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
245
246
247
248
249
#if defined( WIN32 )
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
#endif

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
#include "vlc_threads.h"

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

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
    char *psz_object_type;                                                  \
    char *psz_object_name;                                                  \
                                                                            \
    /* Thread properties, if any */                                         \
    vlc_bool_t   b_thread;                                                  \
    vlc_thread_t thread_id;                                                 \
Sam Hocevar's avatar
Sam Hocevar committed
266
267
268
269
                                                                            \
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
270
271
272
273
                                                                            \
    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 */ \
274
    volatile vlc_bool_t b_attached;                 /* set by the object */ \
275
276
277
                                                                            \
    vlc_t *         p_vlc;                           /* root of all evil */ \
                                                                            \
278
279
    volatile int    i_refcount;                           /* usage count */ \
    vlc_object_t *  p_parent;                              /* our parent */ \
280
281
282
    vlc_object_t ** pp_children;                         /* our children */ \
    volatile int    i_children;                                             \
                                                                            \
283
284
285
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
286
287
288
289
    /* Just a reminder so that people don't cast garbage */                 \
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \

/* The real vlc_object_t type. Yes, it's that simple :-) */
290
struct vlc_object_t
291
292
293
294
{
    VLC_COMMON_MEMBERS
};

295
296
297
298
299
300
301
302
303
304
305
/* The object list */
struct vlc_list_t
{
    int             i_count;
    vlc_object_t ** pp_objects;

    /* Private */
    int             _i_extra;
    vlc_object_t *  _p_first;
};  

306
307
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
308
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
309

Sam Hocevar's avatar
   
Sam Hocevar committed
310
311
312
313
314
315
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

316
#elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
Sam Hocevar's avatar
   
Sam Hocevar committed
317
318
319
320
321
322
323
324
325
326
#   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
327
328
329
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
   
Sam Hocevar committed
330
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
331
332
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
   
Sam Hocevar committed
333
334
335
336
337
#endif

/* 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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 * the VAX seems to have such exotic properties. */
static inline u16 U16_AT( void * _p )
{
    u8 * p = (u8 *)_p;
    return ( ((u16)p[0] << 8) | p[1] );
}
static inline u32 U32_AT( void * _p )
{
    u8 * p = (u8 *)_p;
    return ( ((u32)p[0] << 24) | ((u32)p[1] << 16) | ((u32)p[2] << 8) | p[3] );
}
static inline u64 U64_AT( void * _p )
{
    u8 * p = (u8 *)_p;
    return ( ((u64)p[0] << 56) | ((u64)p[1] << 48) | ((u64)p[2] << 40) 
              | ((u64)p[3] << 32) | ((u64)p[4] << 24) | ((u64)p[5] << 16)
              | ((u64)p[6] << 8) | p[7] );
}
Sam Hocevar's avatar
   
Sam Hocevar committed
356
#if WORDS_BIGENDIAN
357
358
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
   
Sam Hocevar committed
359
#   define hton64(i)   ( i )
360
361
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
   
Sam Hocevar committed
362
363
#   define ntoh64(i)   ( i )
#else
364
365
366
367
368
369
#   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
370
371
372
373
374
375
376
377
378
#endif

/* 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
379
380
381
382
383
384
385
386
387
388
389
390
/* 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
391
392
393
#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
394

395
#   define vlc_memalign(pp_orig,align,size) \
gbazin's avatar
   
gbazin committed
396
397
398
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
399
400
401
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
402
                       & (~(unsigned long)(align-1)) ) \
403
        : NULL )
gbazin's avatar
   
gbazin committed
404

Sam Hocevar's avatar
   
Sam Hocevar committed
405
406
#endif

407
408
409
410
411
/* strndup (defined in src/misc/extras.c) */
#ifndef HAVE_STRNDUP
char * strndup( const char *s, size_t n );
#endif

gbazin's avatar
   
gbazin committed
412

Sam Hocevar's avatar
   
Sam Hocevar committed
413
414
#define I64C(x)         x##LL

415
#ifdef WIN32
Sam Hocevar's avatar
   
Sam Hocevar committed
416
/* win32, cl and icl support */
Sam Hocevar's avatar
   
Sam Hocevar committed
417
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
   
Sam Hocevar committed
418
419
420
421
#       define __attribute__(x)
#       define __inline__      __inline
#       define strncasecmp     strnicmp
#       define strcasecmp      stricmp
gbazin's avatar
   
gbazin committed
422
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
   
Sam Hocevar committed
423
424
425
426
#       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)
gbazin's avatar
   
gbazin committed
427
#       undef I64C
Sam Hocevar's avatar
   
Sam Hocevar committed
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
#       define I64C(x)         x##i64
#   endif

/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
typedef long long _off_t;
typedef _off_t off_t;
#           define _OFF_T_
#       else
#           define off_t long long
#       endif
#   endif

#   if defined( _MSC_VER )
#       if !defined( _OFF_T_DEFINED )
typedef __int64 off_t;
#           define _OFF_T_DEFINED
#       else
#           define off_t __int64
#       endif
#   endif

ipkiss's avatar
   
ipkiss committed
451
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
   
Sam Hocevar committed
452
#       undef off_t
ipkiss's avatar
   
ipkiss committed
453
#       define off_t unsigned __int64
Sam Hocevar's avatar
   
Sam Hocevar committed
454
455
#   endif

gbazin's avatar
   
gbazin committed
456
457
458
459
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
#   endif

460
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
   
Sam Hocevar committed
461
#   ifndef snprintf
462
463
464
465
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
   
Sam Hocevar committed
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
#   endif

#endif

/*****************************************************************************
 * 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)
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
487
#if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( NEED_GNOMESUPPORT_H )
Sam Hocevar's avatar
   
Sam Hocevar committed
488
#   include <libintl.h>
Sam Hocevar's avatar
   
Sam Hocevar committed
489
490
491
492
493
494
495
#   undef _
#   define _(String) dgettext (PACKAGE, String)
#   ifdef gettext_noop
#       define N_(String) gettext_noop (String)
#   else
#       define N_(String) (String)
#   endif
496
#elif !defined( NEED_GNOMESUPPORT_H )
Sam Hocevar's avatar
   
Sam Hocevar committed
497
498
499
500
#   define _(String) (String)
#   define N_(String) (String)
#endif

501
/*****************************************************************************
502
 * Additional vlc stuff
503
 *****************************************************************************/
504
#include "vlc_symbols.h"
505
506
#include "os_specific.h"
#include "vlc_messages.h"
507
#include "vlc_threads_funcs.h"
508
509
510
511
512
513
514
515
516
517
518
#include "mtime.h"
#include "modules.h"
#include "main.h"
#include "configuration.h"
#include "vlc_objects.h"

#if defined( __BORLANDC__ )
#   undef PACKAGE
#   define PACKAGE
#endif