1be334513cc2895b4a458ade85985550c5a1d7a7
[vlc.git] / include / vlc_common.h
1 /*****************************************************************************
2  * common.h: common definitions
3  * Collection of useful common types and macros definitions
4  *****************************************************************************
5  * Copyright (C) 1998, 1999, 2000 VideoLAN
6  * $Id: vlc_common.h,v 1.20 2002/08/14 17:06:53 sam Exp $
7  *
8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
9  *          Vincent Seguin <seguin@via.ecp.fr>
10  *          Gildas Bazin <gbazin@netcourrier.com>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  * 
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Compiler-specific workarounds
29  *****************************************************************************/
30 #if defined( __BORLANDC__ )
31 #   undef HAVE_VARIADIC_MACROS
32 #   undef HAVE_STDINT_H
33 #endif
34
35 /*****************************************************************************
36  * Required system headers
37  *****************************************************************************/
38 #ifdef HAVE_STRING_H
39 #   include <string.h>                                         /* strerror() */
40 #endif
41
42 #ifdef HAVE_SYS_TYPES_H
43 #   include <sys/types.h>
44 #endif
45
46 /*****************************************************************************
47  * Basic types definitions
48  *****************************************************************************/
49 #ifdef HAVE_STDINT_H
50 #   include <stdint.h>
51     typedef uint8_t             u8;
52     typedef int8_t              s8;
53
54     typedef uint16_t            u16;
55     typedef int16_t             s16;
56
57     typedef uint32_t            u32;
58     typedef int32_t             s32;
59
60     typedef uint64_t            u64;
61     typedef int64_t             s64;
62 #else
63     typedef unsigned char       u8;
64     typedef signed char         s8;
65
66     typedef unsigned short      u16;
67     typedef signed short        s16;
68
69     typedef unsigned int        u32;
70     typedef signed int          s32;
71
72 #   if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
73     typedef unsigned __int64    u64;
74     typedef signed __int64      s64;
75 #   else
76     typedef unsigned long long  u64;
77     typedef signed long long    s64;
78 #   endif
79 #endif
80
81 typedef u8                      byte_t;
82
83 /* ptrdiff_t definition */
84 #ifdef HAVE_STDDEF_H
85 #   include <stddef.h>
86 #else
87 #   include <malloc.h>
88 #   ifndef _PTRDIFF_T
89 #       define _PTRDIFF_T
90 /* Not portable in a 64-bit environment. */
91 typedef int                 ptrdiff_t;
92 #   endif
93 #endif
94
95 #if defined( WIN32 )
96 typedef int                 ssize_t;
97 #endif
98
99 /* Counter for statistics and profiling */
100 typedef unsigned long       count_t;
101
102 /* DCT elements types */
103 typedef s16                 dctelem_t;
104
105 /* Video buffer types */
106 typedef u8                  yuv_data_t;
107
108 /*****************************************************************************
109  * mtime_t: high precision date or time interval
110  *****************************************************************************
111  * Store an high precision date or time interval. The maximum precision is the
112  * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
113  * time interval is then 292271 years, which should be long enough for any
114  * video). Date are stored as a time interval since a common date.
115  * Note that date and time intervals can be manipulated using regular
116  * arithmetic operators, and that no special functions are required.
117  *****************************************************************************/
118 typedef s64 mtime_t;
119
120 /*****************************************************************************
121  * The vlc_fourcc_t type.
122  *****************************************************************************
123  * See http://www.webartz.com/fourcc/ for a very detailed list.
124  *****************************************************************************/
125 typedef u32 vlc_fourcc_t;
126
127 #define VLC_FOURCC( a, b, c, d ) \
128     ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )
129
130 #define VLC_TWOCC( a, b ) \
131     ( (u16)(a) | ( (u16)(b) << 8 ) )
132
133 /*****************************************************************************
134  * Classes declaration
135  *****************************************************************************/
136
137 /* Messages */
138 typedef struct msg_bank_t msg_bank_t;
139 typedef struct msg_subscription_t msg_subscription_t;
140
141 /* Playlist */
142 typedef struct playlist_t playlist_t;
143 typedef struct playlist_item_t playlist_item_t;
144
145 /* Modules */
146 typedef struct module_bank_t module_bank_t;
147 typedef struct module_t module_t;
148 typedef struct module_config_t module_config_t;
149 typedef struct module_symbols_t module_symbols_t;
150
151 /* Interface */
152 typedef struct intf_thread_t intf_thread_t;
153 typedef struct intf_sys_t intf_sys_t;
154 typedef struct intf_console_t intf_console_t;
155 typedef struct intf_msg_t intf_msg_t;
156 typedef struct intf_channel_t intf_channel_t;
157
158 /* Input */
159 typedef struct input_thread_t input_thread_t;
160 typedef struct input_channel_t input_channel_t;
161 typedef struct input_area_t input_area_t;
162 typedef struct input_buffers_t input_buffers_t;
163 typedef struct input_socket_t input_socket_t;
164 typedef struct input_info_t input_info_t;
165 typedef struct input_info_category_t input_info_category_t;
166 typedef struct access_sys_t access_sys_t;
167 typedef struct demux_sys_t demux_sys_t;
168 typedef struct es_descriptor_t es_descriptor_t;
169 typedef struct es_sys_t es_sys_t;
170 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
171 typedef struct pgrm_sys_t pgrm_sys_t;
172 typedef struct stream_descriptor_t stream_descriptor_t;
173 typedef struct stream_sys_t stream_sys_t;
174
175 /* Audio */
176 typedef struct aout_instance_t aout_instance_t;
177 typedef struct aout_sys_t aout_sys_t;
178 typedef struct aout_input_t aout_input_t;
179 typedef struct aout_buffer_t aout_buffer_t;
180 typedef struct audio_sample_format_t audio_sample_format_t;
181
182 /* Video */
183 typedef struct vout_thread_t vout_thread_t;
184 typedef struct vout_font_t vout_font_t;
185 typedef struct vout_sys_t vout_sys_t;
186 typedef struct chroma_sys_t chroma_sys_t;
187 typedef struct picture_t picture_t;
188 typedef struct picture_sys_t picture_sys_t;
189 typedef struct picture_heap_t picture_heap_t;
190 typedef struct subpicture_t subpicture_t;
191 typedef struct subpicture_sys_t subpicture_sys_t;
192
193 /* Stream output */
194 typedef struct sout_instance_t sout_instance_t;
195 typedef struct sout_fifo_t sout_fifo_t;
196
197 /* Decoders */
198 typedef struct decoder_fifo_t decoder_fifo_t;
199
200 /* Misc */
201 typedef struct data_packet_t data_packet_t;
202 typedef struct data_buffer_t data_buffer_t;
203 typedef struct stream_position_t stream_position_t;
204 typedef struct stream_ctrl_t stream_ctrl_t;
205 typedef struct pes_packet_t pes_packet_t;
206 typedef struct bit_stream_t bit_stream_t;
207 typedef struct network_socket_t network_socket_t;
208 typedef struct iso639_lang_t iso639_lang_t;
209
210 /*****************************************************************************
211  * Plug-in stuff
212  *****************************************************************************/
213 #ifndef __PLUGIN__
214 #   define VLC_EXPORT( type, name, args ) type name args
215 #else
216 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
217     extern module_symbols_t* p_symbols;
218 #endif
219
220 /*****************************************************************************
221  * OS-specific headers and thread types
222  *****************************************************************************/
223 #if defined( WIN32 )
224 #   define WIN32_LEAN_AND_MEAN
225 #   include <windows.h>
226 #endif
227
228 #include "vlc_threads.h"
229
230 /*****************************************************************************
231  * Common structure members
232  *****************************************************************************/
233
234 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
235 #define VLC_COMMON_MEMBERS                                                  \
236     int   i_object_id;                                                      \
237     int   i_object_type;                                                    \
238     char *psz_object_type;                                                  \
239     char *psz_object_name;                                                  \
240                                                                             \
241     /* Thread properties, if any */                                         \
242     vlc_bool_t   b_thread;                                                  \
243     vlc_thread_t thread_id;                                                 \
244                                                                             \
245     /* Object access lock */                                                \
246     vlc_mutex_t  object_lock;                                               \
247     vlc_cond_t   object_wait;                                               \
248                                                                             \
249     volatile vlc_bool_t b_error;                    /* set by the object */ \
250     volatile vlc_bool_t b_die;                     /* set by the outside */ \
251     volatile vlc_bool_t b_dead;                     /* set by the object */ \
252     volatile vlc_bool_t b_attached;                 /* set by the object */ \
253                                                                             \
254     vlc_t *         p_vlc;                           /* root of all evil */ \
255                                                                             \
256     volatile int    i_refcount;                           /* usage count */ \
257     vlc_object_t *  p_parent;                              /* our parent */ \
258     vlc_object_t ** pp_children;                         /* our children */ \
259     volatile int    i_children;                                             \
260                                                                             \
261     /* Private data */                                                      \
262     void *          p_private;                                              \
263                                                                             \
264     /* Just a reminder so that people don't cast garbage */                 \
265     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
266
267 /* The real vlc_object_t type. Yes, it's that simple :-) */
268 struct vlc_object_t
269 {
270     VLC_COMMON_MEMBERS
271 };
272
273 /* The object list */
274 struct vlc_list_t
275 {
276     int             i_count;
277     vlc_object_t ** pp_objects;
278
279     /* Private */
280     int             _i_extra;
281     vlc_object_t *  _p_first;
282 };  
283
284 /* VLC_OBJECT: attempt at doing a clever cast */
285 #define VLC_OBJECT( x ) \
286     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
287
288 /*****************************************************************************
289  * Macros and inline functions
290  *****************************************************************************/
291 #ifdef NTOHL_IN_SYS_PARAM_H
292 #   include <sys/param.h>
293
294 #elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
295 #   include <netinet/in.h>
296
297 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
298
299 /* CEIL: division with round to nearest greater integer */
300 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
301
302 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
303 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
304
305 /* __MAX and __MIN: self explanatory */
306 #ifndef __MAX
307 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
308 #endif
309 #ifndef __MIN
310 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
311 #endif
312
313 /* MSB (big endian)/LSB (little endian) conversions - network order is always
314  * MSB, and should be used for both network communications and files. Note that
315  * byte orders other than little and big endians are not supported, but only
316  * the VAX seems to have such exotic properties. */
317 static inline u16 U16_AT( void * _p )
318 {
319     u8 * p = (u8 *)_p;
320     return ( ((u16)p[0] << 8) | p[1] );
321 }
322 static inline u32 U32_AT( void * _p )
323 {
324     u8 * p = (u8 *)_p;
325     return ( ((u32)p[0] << 24) | ((u32)p[1] << 16) | ((u32)p[2] << 8) | p[3] );
326 }
327 static inline u64 U64_AT( void * _p )
328 {
329     u8 * p = (u8 *)_p;
330     return ( ((u64)p[0] << 56) | ((u64)p[1] << 48) | ((u64)p[2] << 40) 
331               | ((u64)p[3] << 32) | ((u64)p[4] << 24) | ((u64)p[5] << 16)
332               | ((u64)p[6] << 8) | p[7] );
333 }
334 #if WORDS_BIGENDIAN
335 #   define hton16(i)   ( i )
336 #   define hton32(i)   ( i )
337 #   define hton64(i)   ( i )
338 #   define ntoh16(i)   ( i )
339 #   define ntoh32(i)   ( i )
340 #   define ntoh64(i)   ( i )
341 #else
342 #   define hton16(i)   U16_AT(&i)
343 #   define hton32(i)   U32_AT(&i)
344 #   define hton64(i)   U64_AT(&i)
345 #   define ntoh16(i)   U16_AT(&i)
346 #   define ntoh32(i)   U32_AT(&i)
347 #   define ntoh64(i)   U64_AT(&i)
348 #endif
349
350 /* Alignment of critical static data structures */
351 #ifdef ATTRIBUTE_ALIGNED_MAX
352 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
353 #else
354 #   define ATTR_ALIGN(align)
355 #endif
356
357 /* Alignment of critical dynamic data structure
358  *
359  * Not all platforms support memalign so we provide a vlc_memalign wrapper
360  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
361  * *pp_orig is the pointer that has to be freed afterwards.
362  */
363 #if 0
364 #ifdef HAVE_POSIX_MEMALIGN
365 #   define vlc_memalign(align,size,pp_orig) \
366     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
367 #endif
368 #endif
369 #ifdef HAVE_MEMALIGN
370     /* Some systems have memalign() but no declaration for it */
371     void * memalign( size_t align, size_t size );
372
373 #   define vlc_memalign(pp_orig,align,size) \
374     ( *(pp_orig) = memalign( align, size ) )
375
376 #else /* We don't have any choice but to align manually */
377 #   define vlc_memalign(pp_orig,align,size) \
378     (( *(pp_orig) = malloc( size + align - 1 )) \
379         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
380                        & (~(unsigned long)(align-1)) ) \
381         : NULL )
382
383 #endif
384
385 /* strndup (defined in src/misc/extras.c) */
386 #ifndef HAVE_STRNDUP
387 char * strndup( const char *s, size_t n );
388 #endif
389
390
391 #define I64C(x)         x##LL
392
393 #ifdef WIN32
394 /* win32, cl and icl support */
395 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
396 #       define __attribute__(x)
397 #       define __inline__      __inline
398 #       define strncasecmp     strnicmp
399 #       define strcasecmp      stricmp
400 #       define S_IFBLK         0x3000  /* Block */
401 #       define S_ISBLK(m)      (0)
402 #       define S_ISCHR(m)      (0)
403 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
404 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
405 #       undef I64C
406 #       define I64C(x)         x##i64
407 #   endif
408
409 /* several type definitions */
410 #   if defined( __MINGW32__ )
411 #       if !defined( _OFF_T_ )
412 typedef long long _off_t;
413 typedef _off_t off_t;
414 #           define _OFF_T_
415 #       else
416 #           define off_t long long
417 #       endif
418 #   endif
419
420 #   if defined( _MSC_VER )
421 #       if !defined( _OFF_T_DEFINED )
422 typedef __int64 off_t;
423 #           define _OFF_T_DEFINED
424 #       else
425 #           define off_t __int64
426 #       endif
427 #   endif
428
429 #   if defined( __BORLANDC__ )
430 #       undef off_t
431 #       define off_t unsigned __int64
432 #   endif
433
434 #   ifndef O_NONBLOCK
435 #       define O_NONBLOCK 0
436 #   endif
437
438     /* These two are not defined in mingw32 (bug?) */
439 #   ifndef snprintf
440 #       define snprintf _snprintf
441 #   endif
442 #   ifndef vsnprintf
443 #       define vsnprintf _vsnprintf
444 #   endif
445
446 #endif
447
448 /*****************************************************************************
449  * CPU capabilities
450  *****************************************************************************/
451 #define CPU_CAPABILITY_NONE    0
452 #define CPU_CAPABILITY_486     (1<<0)
453 #define CPU_CAPABILITY_586     (1<<1)
454 #define CPU_CAPABILITY_PPRO    (1<<2)
455 #define CPU_CAPABILITY_MMX     (1<<3)
456 #define CPU_CAPABILITY_3DNOW   (1<<4)
457 #define CPU_CAPABILITY_MMXEXT  (1<<5)
458 #define CPU_CAPABILITY_SSE     (1<<6)
459 #define CPU_CAPABILITY_ALTIVEC (1<<16)
460 #define CPU_CAPABILITY_FPU     (1<<31)
461
462 /*****************************************************************************
463  * I18n stuff
464  *****************************************************************************/
465 #ifndef PACKAGE /* Borland C++ uses this ! */
466 #define PACKAGE VLC_PACKAGE
467 #endif
468 #define VERSION VLC_VERSION
469
470 #if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( MODULE_NAME_IS_gnome )
471 #   include <libintl.h>
472 #   undef _
473 #   define _(String) dgettext (PACKAGE, String)
474 #   ifdef gettext_noop
475 #       define N_(String) gettext_noop (String)
476 #   else
477 #       define N_(String) (String)
478 #   endif
479 #elif !defined( MODULE_NAME_IS_gnome )
480 #   define _(String) (String)
481 #   define N_(String) (String)
482 #endif
483
484 /*****************************************************************************
485  * Plug-in stuff
486  *****************************************************************************/
487 #include "vlc_symbols.h"