vlc_common.h 16.8 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.18 2002/08/12 09:34:15 sam 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
29
30
31
32
33
34
/*****************************************************************************
 * Compiler-specific workarounds
 *****************************************************************************/
#if defined( __BORLANDC__ )
#   undef HAVE_VARIADIC_MACROS
#   undef HAVE_STDINT_H
#endif

Sam Hocevar's avatar
   
Sam Hocevar committed
35
36
37
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
38
39
40
41
42
43
44
#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
45
46
47
48

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
49
50
51
52
#ifdef HAVE_STDINT_H
#   include <stdint.h>
    typedef uint8_t             u8;
    typedef int8_t              s8;
Sam Hocevar's avatar
   
Sam Hocevar committed
53

54
55
    typedef uint16_t            u16;
    typedef int16_t             s16;
Sam Hocevar's avatar
   
Sam Hocevar committed
56

57
58
    typedef uint32_t            u32;
    typedef int32_t             s32;
Sam Hocevar's avatar
   
Sam Hocevar committed
59

60
61
    typedef uint64_t            u64;
    typedef int64_t             s64;
Sam Hocevar's avatar
   
Sam Hocevar committed
62
#else
63
64
    typedef unsigned char       u8;
    typedef signed char         s8;
Sam Hocevar's avatar
   
Sam Hocevar committed
65

66
67
    typedef unsigned short      u16;
    typedef signed short        s16;
Sam Hocevar's avatar
   
Sam Hocevar committed
68

69
70
71
72
73
74
75
76
77
78
    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
79
80
#endif

81
82
typedef u8                      byte_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
83
84
85
86
87
88
89
90
91
92
93
94
/* 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
95
96
#if defined( WIN32 )
typedef int                 ssize_t;
Xavier Marchesini's avatar
   
Xavier Marchesini committed
97
98
#endif

Sam Hocevar's avatar
   
Sam Hocevar committed
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/* 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;

/*****************************************************************************
 * 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;

120
121
122
123
124
125
126
127
128
129
130
131
132
/*****************************************************************************
 * The vlc_fourcc_t type.
 *****************************************************************************
 * See http://www.webartz.com/fourcc/ for a very detailed list.
 *****************************************************************************/
typedef u32 vlc_fourcc_t;

#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 ) )

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

137
/* Messages */
138
139
typedef struct msg_bank_t msg_bank_t;
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
140

gbazin's avatar
   
gbazin committed
141
/* Playlist */
142
143
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
144

145
/* Modules */
146
147
148
149
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
150
151

/* Interface */
152
153
154
155
156
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
157
158

/* Input */
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
174
175

/* Audio */
176
177
178
179
180
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
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;
Sam Hocevar's avatar
   
Sam Hocevar committed
181
182

/* Video */
183
184
185
186
187
188
189
190
191
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
192
193

/* Decoders */
194
typedef struct decoder_fifo_t decoder_fifo_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
195
196

/* Misc */
197
198
199
200
201
202
203
204
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;
205

gbazin's avatar
   
gbazin committed
206
207
208
209
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
#ifndef __PLUGIN__
210
#   define VLC_EXPORT( type, name, args ) type name args
gbazin's avatar
   
gbazin committed
211
#else
212
#   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
gbazin's avatar
   
gbazin committed
213
214
215
    extern module_symbols_t* p_symbols;
#endif

216
217
218
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
219
220
221
222
223
#if defined( WIN32 )
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
#endif

224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
#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
240
241
242
243
                                                                            \
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
244
245
246
247
                                                                            \
    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 */ \
248
    volatile vlc_bool_t b_attached;                 /* set by the object */ \
249
250
251
                                                                            \
    vlc_t *         p_vlc;                           /* root of all evil */ \
                                                                            \
252
253
    volatile int    i_refcount;                           /* usage count */ \
    vlc_object_t *  p_parent;                              /* our parent */ \
254
255
256
    vlc_object_t ** pp_children;                         /* our children */ \
    volatile int    i_children;                                             \
                                                                            \
257
258
259
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
260
261
262
263
    /* 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 :-) */
264
struct vlc_object_t
265
266
267
268
{
    VLC_COMMON_MEMBERS
};

269
270
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
271
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
272

Sam Hocevar's avatar
   
Sam Hocevar committed
273
274
275
276
277
278
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

279
#elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
Sam Hocevar's avatar
   
Sam Hocevar committed
280
281
282
283
284
285
286
287
288
289
#   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
290
291
292
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
   
Sam Hocevar committed
293
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
294
295
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
   
Sam Hocevar committed
296
297
298
299
300
#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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 * 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
319
#if WORDS_BIGENDIAN
320
321
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
   
Sam Hocevar committed
322
#   define hton64(i)   ( i )
323
324
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
   
Sam Hocevar committed
325
326
#   define ntoh64(i)   ( i )
#else
327
328
329
330
331
332
#   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
333
334
335
336
337
338
339
340
341
#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
342
343
344
345
346
347
348
349
350
351
352
353
/* 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
354
355
356
#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
357

358
#   define vlc_memalign(pp_orig,align,size) \
gbazin's avatar
   
gbazin committed
359
360
361
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
362
363
364
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
365
                       & (~(unsigned long)(align-1)) ) \
366
        : NULL )
gbazin's avatar
   
gbazin committed
367

Sam Hocevar's avatar
   
Sam Hocevar committed
368
369
#endif

370
371
372
373
374
/* strndup (defined in src/misc/extras.c) */
#ifndef HAVE_STRNDUP
char * strndup( const char *s, size_t n );
#endif

gbazin's avatar
   
gbazin committed
375

Sam Hocevar's avatar
   
Sam Hocevar committed
376
377
#define I64C(x)         x##LL

378
#ifdef WIN32
Sam Hocevar's avatar
   
Sam Hocevar committed
379
/* win32, cl and icl support */
Sam Hocevar's avatar
   
Sam Hocevar committed
380
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
   
Sam Hocevar committed
381
382
383
384
#       define __attribute__(x)
#       define __inline__      __inline
#       define strncasecmp     strnicmp
#       define strcasecmp      stricmp
gbazin's avatar
   
gbazin committed
385
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
   
Sam Hocevar committed
386
387
388
389
#       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
390
#       undef I64C
Sam Hocevar's avatar
   
Sam Hocevar committed
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
#       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
414
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
   
Sam Hocevar committed
415
#       undef off_t
ipkiss's avatar
   
ipkiss committed
416
#       define off_t unsigned __int64
Sam Hocevar's avatar
   
Sam Hocevar committed
417
418
#   endif

gbazin's avatar
   
gbazin committed
419
420
421
422
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
#   endif

423
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
   
Sam Hocevar committed
424
#   ifndef snprintf
425
426
427
428
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
   
Sam Hocevar committed
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
#   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
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
450
#ifndef PACKAGE /* Borland C++ uses this ! */
Sam Hocevar's avatar
   
Sam Hocevar committed
451
452
453
454
#define PACKAGE VLC_PACKAGE
#endif
#define VERSION VLC_VERSION

Sam Hocevar's avatar
   
Sam Hocevar committed
455
#if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( MODULE_NAME_IS_gnome )
Sam Hocevar's avatar
   
Sam Hocevar committed
456
#   include <libintl.h>
Sam Hocevar's avatar
   
Sam Hocevar committed
457
458
459
460
461
462
463
464
#   undef _
#   define _(String) dgettext (PACKAGE, String)
#   ifdef gettext_noop
#       define N_(String) gettext_noop (String)
#   else
#       define N_(String) (String)
#   endif
#elif !defined( MODULE_NAME_IS_gnome )
Sam Hocevar's avatar
   
Sam Hocevar committed
465
466
467
468
#   define _(String) (String)
#   define N_(String) (String)
#endif

469
/*****************************************************************************
470
 * Plug-in stuff
471
 *****************************************************************************/
472
#include "vlc_symbols.h"