* ./include/vlc_common.h: got rid of i_thread in VLC_COMMON_MEMBERS.
[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.5 2002/06/02 15:51:30 gbazin 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  * Required system headers
29  *****************************************************************************/
30 #ifdef HAVE_STRING_H
31 #   include <string.h>                                         /* strerror() */
32 #endif
33
34 #ifdef HAVE_SYS_TYPES_H
35 #   include <sys/types.h>
36 #endif
37
38 /*****************************************************************************
39  * Basic types definitions
40  *****************************************************************************/
41 #ifdef HAVE_STDINT_H
42 #   include <stdint.h>
43     typedef uint8_t             u8;
44     typedef int8_t              s8;
45
46     typedef uint16_t            u16;
47     typedef int16_t             s16;
48
49     typedef uint32_t            u32;
50     typedef int32_t             s32;
51
52     typedef uint64_t            u64;
53     typedef int64_t             s64;
54 #else
55     typedef unsigned char       u8;
56     typedef signed char         s8;
57
58     typedef unsigned short      u16;
59     typedef signed short        s16;
60
61     typedef unsigned int        u32;
62     typedef signed int          s32;
63
64 #   if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
65     typedef unsigned __int64    u64;
66     typedef signed __int64      s64;
67 #   else
68     typedef unsigned long long  u64;
69     typedef signed long long    s64;
70 #   endif
71 #endif
72
73 typedef u8                      byte_t;
74
75 /* ptrdiff_t definition */
76 #ifdef HAVE_STDDEF_H
77 #   include <stddef.h>
78 #else
79 #   include <malloc.h>
80 #   ifndef _PTRDIFF_T
81 #       define _PTRDIFF_T
82 /* Not portable in a 64-bit environment. */
83 typedef int                 ptrdiff_t;
84 #   endif
85 #endif
86
87 #if defined( WIN32 )
88 typedef int                 ssize_t;
89 #endif
90
91 /* Counter for statistics and profiling */
92 typedef unsigned long       count_t;
93
94 /* DCT elements types */
95 typedef s16                 dctelem_t;
96
97 /* Video buffer types */
98 typedef u8                  yuv_data_t;
99
100 /*****************************************************************************
101  * mtime_t: high precision date or time interval
102  *****************************************************************************
103  * Store an high precision date or time interval. The maximum precision is the
104  * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
105  * time interval is then 292271 years, which should be long enough for any
106  * video). Date are stored as a time interval since a common date.
107  * Note that date and time intervals can be manipulated using regular
108  * arithmetic operators, and that no special functions are required.
109  *****************************************************************************/
110 typedef s64 mtime_t;
111
112 /*****************************************************************************
113  * Classes declaration
114  *****************************************************************************/
115
116 /* Messages */
117 VLC_DECLARE_STRUCT(msg_bank)
118 VLC_DECLARE_STRUCT(msg_subscription)
119
120 /* Playlist */
121 VLC_DECLARE_STRUCT(playlist)
122 VLC_DECLARE_STRUCT(playlist_item)
123
124 /* Modules */
125 VLC_DECLARE_STRUCT(module_bank)
126 VLC_DECLARE_STRUCT(module)
127 VLC_DECLARE_STRUCT(module_config)
128 VLC_DECLARE_STRUCT(module_symbols)
129 VLC_DECLARE_STRUCT(module_functions)
130
131 /* Interface */
132 VLC_DECLARE_STRUCT(intf_thread)
133 VLC_DECLARE_STRUCT(intf_sys)
134 VLC_DECLARE_STRUCT(intf_console)
135 VLC_DECLARE_STRUCT(intf_msg)
136 VLC_DECLARE_STRUCT(intf_channel)
137
138 /* Input */
139 VLC_DECLARE_STRUCT(input_thread)
140 VLC_DECLARE_STRUCT(input_channel)
141 VLC_DECLARE_STRUCT(input_cfg)
142 VLC_DECLARE_STRUCT(input_area)
143 VLC_DECLARE_STRUCT(input_buffers)
144 VLC_DECLARE_STRUCT(input_socket)
145
146 /* Audio */
147 VLC_DECLARE_STRUCT(aout_thread)
148 VLC_DECLARE_STRUCT(aout_sys)
149 VLC_DECLARE_STRUCT(aout_fifo)
150
151 /* Video */
152 VLC_DECLARE_STRUCT(vout_thread)
153 VLC_DECLARE_STRUCT(vout_font)
154 VLC_DECLARE_STRUCT(vout_sys)
155 VLC_DECLARE_STRUCT(chroma_sys)
156 VLC_DECLARE_STRUCT(picture)
157 VLC_DECLARE_STRUCT(picture_sys)
158 VLC_DECLARE_STRUCT(picture_heap)
159 VLC_DECLARE_STRUCT(subpicture)
160 VLC_DECLARE_STRUCT(subpicture_sys)
161
162 /* Decoders */
163 VLC_DECLARE_STRUCT(decoder_fifo)
164
165 /* Misc */
166 VLC_DECLARE_STRUCT(macroblock)
167 VLC_DECLARE_STRUCT(data_packet)
168 VLC_DECLARE_STRUCT(data_buffer)
169 VLC_DECLARE_STRUCT(downmix)
170 VLC_DECLARE_STRUCT(imdct)
171 VLC_DECLARE_STRUCT(complex)
172 VLC_DECLARE_STRUCT(dm_par)
173 VLC_DECLARE_STRUCT(es_descriptor)
174 VLC_DECLARE_STRUCT(pgrm_descriptor)
175 VLC_DECLARE_STRUCT(stream_descriptor)
176 VLC_DECLARE_STRUCT(stream_position)
177 VLC_DECLARE_STRUCT(stream_ctrl)
178 VLC_DECLARE_STRUCT(pes_packet)
179 VLC_DECLARE_STRUCT(bit_stream)
180 VLC_DECLARE_STRUCT(network_socket)
181 VLC_DECLARE_STRUCT(iso639_lang)
182
183 /*****************************************************************************
184  * Plug-in stuff
185  *****************************************************************************/
186 #ifndef __PLUGIN__
187 #   define VLC_EXPORT( type, name, args ) type name args;
188 #else
189 #   define VLC_EXPORT( type, name, args ) ;
190     extern module_symbols_t* p_symbols;
191 #endif
192
193 /*****************************************************************************
194  * OS-specific headers and thread types
195  *****************************************************************************/
196 #if defined( WIN32 )
197 #   define WIN32_LEAN_AND_MEAN
198 #   include <windows.h>
199 #endif
200
201 #include "vlc_threads.h"
202
203 /*****************************************************************************
204  * Compiler-specific workarounds
205  *****************************************************************************/
206 #if defined( __BORLANDC__ )
207 #   undef HAVE_VARIADIC_MACROS
208 #endif
209
210 /*****************************************************************************
211  * Common structure members
212  *****************************************************************************/
213
214 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
215 #define VLC_COMMON_MEMBERS                                                  \
216     int   i_object_id;                                                      \
217     int   i_object_type;                                                    \
218     char *psz_object_type;                                                  \
219     char *psz_object_name;                                                  \
220                                                                             \
221     /* Thread properties, if any */                                         \
222     vlc_bool_t   b_thread;                                                  \
223     vlc_thread_t thread_id;                                                 \
224     vlc_mutex_t  thread_lock;                                               \
225     vlc_cond_t   thread_wait;                                               \
226                                                                             \
227     volatile vlc_bool_t b_error;                    /* set by the object */ \
228     volatile vlc_bool_t b_die;                     /* set by the outside */ \
229     volatile vlc_bool_t b_dead;                     /* set by the object */ \
230                                                                             \
231     vlc_t *         p_vlc;                           /* root of all evil */ \
232                                                                             \
233     volatile int    i_refcount;                                             \
234     vlc_object_t ** pp_parents;                           /* our parents */ \
235     volatile int    i_parents;                                              \
236     vlc_object_t ** pp_children;                         /* our children */ \
237     volatile int    i_children;                                             \
238                                                                             \
239     /* Just a reminder so that people don't cast garbage */                 \
240     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
241
242 /* The real vlc_object_t type. Yes, it's that simple :-) */
243 struct vlc_object_s
244 {
245     VLC_COMMON_MEMBERS
246 };
247
248 /* CAST_TO_VLC_OBJECT: attempt at doing a clever cast */
249 #define CAST_TO_VLC_OBJECT( x ) \
250     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
251
252 /*****************************************************************************
253  * Macros and inline functions
254  *****************************************************************************/
255 #ifdef NTOHL_IN_SYS_PARAM_H
256 #   include <sys/param.h>
257
258 #elif defined(WIN32)
259 /* Swap bytes in 16 bit value.  */
260 #   define __bswap_constant_16(x) \
261      ((((x) >> 8) & 0xff) | (((x) & 0xff) << 8))
262
263 #   if defined __GNUC__ && __GNUC__ >= 2
264 #       define __bswap_16(x) \
265             (__extension__                                                    \
266              ({ register unsigned short int __v;                              \
267                 if (__builtin_constant_p (x))                                 \
268                   __v = __bswap_constant_16 (x);                              \
269                 else                                                          \
270                   __asm__ __volatile__ ("rorw $8, %w0"                        \
271                                         : "=r" (__v)                          \
272                                         : "0" ((unsigned short int) (x))      \
273                                         : "cc");                              \
274                 __v; }))
275 #   else
276 /* This is better than nothing.  */
277 #       define __bswap_16(x) __bswap_constant_16 (x)
278 #   endif
279
280 /* Swap bytes in 32 bit value.  */
281 #   define __bswap_constant_32(x) \
282         ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >>  8) |            \
283          (((x) & 0x0000ff00) <<  8) | (((x) & 0x000000ff) << 24))
284
285 #   if defined __GNUC__ && __GNUC__ >= 2
286 /* To swap the bytes in a word the i486 processors and up provide the
287    `bswap' opcode.  On i386 we have to use three instructions.  */
288 #       if !defined __i486__ && !defined __pentium__ && !defined __pentiumpro__
289 #           define __bswap_32(x) \
290                 (__extension__                                                \
291                  ({ register unsigned int __v;                                \
292                     if (__builtin_constant_p (x))                             \
293                       __v = __bswap_constant_32 (x);                          \
294                     else                                                      \
295                       __asm__ __volatile__ ("rorw $8, %w0;"                   \
296                                             "rorl $16, %0;"                   \
297                                             "rorw $8, %w0"                    \
298                                             : "=r" (__v)                      \
299                                             : "0" ((unsigned int) (x))        \
300                                             : "cc");                          \
301                     __v; }))
302 #       else
303 #           define __bswap_32(x) \
304                 (__extension__                                                \
305                  ({ register unsigned int __v;                                \
306                     if (__builtin_constant_p (x))                             \
307                       __v = __bswap_constant_32 (x);                          \
308                     else                                                      \
309                       __asm__ __volatile__ ("bswap %0"                        \
310                                             : "=r" (__v)                      \
311                                             : "0" ((unsigned int) (x)));      \
312                     __v; }))
313 #       endif
314 #   else
315 #       define __bswap_32(x) __bswap_constant_32 (x)
316 #   endif
317
318 #   if defined __GNUC__ && __GNUC__ >= 2
319 /* Swap bytes in 64 bit value.  */
320 #       define __bswap_constant_64(x) \
321             ((((x) & 0xff00000000000000ull) >> 56)                            \
322              | (((x) & 0x00ff000000000000ull) >> 40)                          \
323              | (((x) & 0x0000ff0000000000ull) >> 24)                          \
324              | (((x) & 0x000000ff00000000ull) >> 8)                           \
325              | (((x) & 0x00000000ff000000ull) << 8)                           \
326              | (((x) & 0x0000000000ff0000ull) << 24)                          \
327              | (((x) & 0x000000000000ff00ull) << 40)                          \
328              | (((x) & 0x00000000000000ffull) << 56))
329
330 #       define __bswap_64(x) \
331             (__extension__                                                    \
332              ({ union { __extension__ unsigned long long int __ll;            \
333                         unsigned long int __l[2]; } __w, __r;                 \
334                 if (__builtin_constant_p (x))                                 \
335                   __r.__ll = __bswap_constant_64 (x);                         \
336                 else                                                          \
337                   {                                                           \
338                     __w.__ll = (x);                                           \
339                     __r.__l[0] = __bswap_32 (__w.__l[1]);                     \
340                     __r.__l[1] = __bswap_32 (__w.__l[0]);                     \
341                   }                                                           \
342                 __r.__ll; }))
343 #   else
344 #       define __bswap_64(i) \
345             (u64)((__bswap_32((i) & 0xffffffff) << 32) |                      \
346             __bswap_32(((i) >> 32) & 0xffffffff ))
347 #   endif
348
349 #else /* NTOHL_IN_SYS_PARAM_H || WIN32 */
350 #   include <netinet/in.h>
351
352 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
353
354 /* CEIL: division with round to nearest greater integer */
355 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
356
357 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
358 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
359
360 /* __MAX and __MIN: self explanatory */
361 #ifndef __MAX
362 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
363 #endif
364 #ifndef __MIN
365 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
366 #endif
367
368 /* MSB (big endian)/LSB (little endian) conversions - network order is always
369  * MSB, and should be used for both network communications and files. Note that
370  * byte orders other than little and big endians are not supported, but only
371  * the VAX seems to have such exotic properties - note that these 'functions'
372  * needs <netinet/in.h> or the local equivalent. */
373 #if !defined( WIN32 )
374 #if WORDS_BIGENDIAN
375 #   define hton16      htons
376 #   define hton32      htonl
377 #   define hton64(i)   ( i )
378 #   define ntoh16      ntohs
379 #   define ntoh32      ntohl
380 #   define ntoh64(i)   ( i )
381 #else
382 #   define hton16      htons
383 #   define hton32      htonl
384     static inline u64 __hton64( u64 i )
385     {
386         return ((u64)(htonl((i) & 0xffffffff)) << 32)
387                 | htonl(((i) >> 32) & 0xffffffff );
388     }
389 #   define hton64(i)   __hton64( i )
390 #   define ntoh16      ntohs
391 #   define ntoh32      ntohl
392 #   define ntoh64      hton64
393 #endif
394 #endif /* !defined( WIN32 ) */
395
396 /* Macros with automatic casts */
397 #define U64_AT(p)   ( ntoh64 ( *( (u64 *)(p) ) ) )
398 #define U32_AT(p)   ( ntoh32 ( *( (u32 *)(p) ) ) )
399 #define U16_AT(p)   ( ntoh16 ( *( (u16 *)(p) ) ) )
400
401 /* Alignment of critical static data structures */
402 #ifdef ATTRIBUTE_ALIGNED_MAX
403 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
404 #else
405 #   define ATTR_ALIGN(align)
406 #endif
407
408 /* Alignment of critical dynamic data structure
409  *
410  * Not all platforms support memalign so we provide a vlc_memalign wrapper
411  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
412  * *pp_orig is the pointer that has to be freed afterwards.
413  */
414 #if 0
415 #ifdef HAVE_POSIX_MEMALIGN
416 #   define vlc_memalign(align,size,pp_orig) \
417     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
418 #endif
419 #endif
420 #ifdef HAVE_MEMALIGN
421     /* Some systems have memalign() but no declaration for it */
422     void * memalign( size_t align, size_t size );
423
424 #   define vlc_memalign(pp_orig,align,size) \
425     ( *(pp_orig) = memalign( align, size ) )
426
427 #else /* We don't have any choice but to align manually */
428 #   define vlc_memalign(pp_orig,align,size) \
429     (( *(pp_orig) = malloc( size + align - 1 )) \
430         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
431                        & (~(unsigned long)(align-1)) ) \
432         : NULL )
433
434 #endif
435
436
437 #define I64C(x)         x##LL
438
439
440 #if defined( WIN32 )
441 /* The ntoh* and hton* bytes swapping functions are provided by winsock
442  * but for conveniency and speed reasons it is better to implement them
443  * ourselves. ( several plugins use them and it is too much hassle to link
444  * winsock with each of them ;-)
445  */
446 #   ifdef WORDS_BIGENDIAN
447 #       define ntoh32(x)       (x)
448 #       define ntoh16(x)       (x)
449 #       define ntoh64(x)       (x)
450 #       define hton32(x)       (x)
451 #       define hton16(x)       (x)
452 #       define hton64(x)       (x)
453 #   else
454 #       define ntoh32(x)     __bswap_32 (x)
455 #       define ntoh16(x)     __bswap_16 (x)
456 #       define ntoh64(x)     __bswap_32 (x)
457 #       define hton32(x)     __bswap_32 (x)
458 #       define hton16(x)     __bswap_16 (x)
459 #       define hton64(x)     __bswap_64 (x)
460 #   endif
461
462 /* win32, cl and icl support */
463 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
464 #       define __attribute__(x)
465 #       define __inline__      __inline
466 #       define strncasecmp     strnicmp
467 #       define strcasecmp      stricmp
468 #       define S_IFBLK         0x3000  /* Block */
469 #       define S_ISBLK(m)      (0)
470 #       define S_ISCHR(m)      (0)
471 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
472 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
473 #       undef I64C
474 #       define I64C(x)         x##i64
475 #   endif
476
477 /* several type definitions */
478 #   if defined( __MINGW32__ )
479 #       if !defined( _OFF_T_ )
480 typedef long long _off_t;
481 typedef _off_t off_t;
482 #           define _OFF_T_
483 #       else
484 #           define off_t long long
485 #       endif
486 #   endif
487
488 #   if defined( _MSC_VER )
489 #       if !defined( _OFF_T_DEFINED )
490 typedef __int64 off_t;
491 #           define _OFF_T_DEFINED
492 #       else
493 #           define off_t __int64
494 #       endif
495 #   endif
496
497 #   if defined( __BORLANDC__ )
498 #       undef off_t
499 #       define off_t unsigned __int64
500 #   endif
501
502 #   ifndef O_NONBLOCK
503 #       define O_NONBLOCK 0
504 #   endif
505
506 #   ifndef snprintf
507 #       define snprintf _snprintf  /* snprintf not defined in mingw32 (bug?) */
508 #   endif
509
510 #endif
511
512 /*****************************************************************************
513  * CPU capabilities
514  *****************************************************************************/
515 #define CPU_CAPABILITY_NONE    0
516 #define CPU_CAPABILITY_486     (1<<0)
517 #define CPU_CAPABILITY_586     (1<<1)
518 #define CPU_CAPABILITY_PPRO    (1<<2)
519 #define CPU_CAPABILITY_MMX     (1<<3)
520 #define CPU_CAPABILITY_3DNOW   (1<<4)
521 #define CPU_CAPABILITY_MMXEXT  (1<<5)
522 #define CPU_CAPABILITY_SSE     (1<<6)
523 #define CPU_CAPABILITY_ALTIVEC (1<<16)
524 #define CPU_CAPABILITY_FPU     (1<<31)
525
526 /*****************************************************************************
527  * I18n stuff
528  *****************************************************************************/
529 #ifndef PACKAGE /* Borland C++ uses this ! */
530 #define PACKAGE VLC_PACKAGE
531 #endif
532 #define VERSION VLC_VERSION
533
534 #if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( MODULE_NAME_IS_gnome )
535 #   include <libintl.h>
536 #   undef _
537 #   define _(String) dgettext (PACKAGE, String)
538 #   ifdef gettext_noop
539 #       define N_(String) gettext_noop (String)
540 #   else
541 #       define N_(String) (String)
542 #   endif
543 #elif !defined( MODULE_NAME_IS_gnome )
544 #   define _(String) (String)
545 #   define N_(String) (String)
546 #endif
547
548 /*****************************************************************************
549  * Plug-in stuff
550  *****************************************************************************/
551 #include "vlc_symbols.h"