(new in MAIN)
[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.6 2002/06/04 00:11:12 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  * 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                                                                             \
225     /* Object access lock */                                                \
226     vlc_mutex_t  object_lock;                                               \
227     vlc_cond_t   object_wait;                                               \
228                                                                             \
229     volatile vlc_bool_t b_error;                    /* set by the object */ \
230     volatile vlc_bool_t b_die;                     /* set by the outside */ \
231     volatile vlc_bool_t b_dead;                     /* set by the object */ \
232                                                                             \
233     vlc_t *         p_vlc;                           /* root of all evil */ \
234                                                                             \
235     volatile int    i_refcount;                                             \
236     vlc_object_t ** pp_parents;                           /* our parents */ \
237     volatile int    i_parents;                                              \
238     vlc_object_t ** pp_children;                         /* our children */ \
239     volatile int    i_children;                                             \
240                                                                             \
241     /* Just a reminder so that people don't cast garbage */                 \
242     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
243
244 /* The real vlc_object_t type. Yes, it's that simple :-) */
245 struct vlc_object_s
246 {
247     VLC_COMMON_MEMBERS
248 };
249
250 /* CAST_TO_VLC_OBJECT: attempt at doing a clever cast */
251 #define CAST_TO_VLC_OBJECT( x ) \
252     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
253
254 /*****************************************************************************
255  * Macros and inline functions
256  *****************************************************************************/
257 #ifdef NTOHL_IN_SYS_PARAM_H
258 #   include <sys/param.h>
259
260 #elif defined(WIN32)
261 /* Swap bytes in 16 bit value.  */
262 #   define __bswap_constant_16(x) \
263      ((((x) >> 8) & 0xff) | (((x) & 0xff) << 8))
264
265 #   if defined __GNUC__ && __GNUC__ >= 2
266 #       define __bswap_16(x) \
267             (__extension__                                                    \
268              ({ register unsigned short int __v;                              \
269                 if (__builtin_constant_p (x))                                 \
270                   __v = __bswap_constant_16 (x);                              \
271                 else                                                          \
272                   __asm__ __volatile__ ("rorw $8, %w0"                        \
273                                         : "=r" (__v)                          \
274                                         : "0" ((unsigned short int) (x))      \
275                                         : "cc");                              \
276                 __v; }))
277 #   else
278 /* This is better than nothing.  */
279 #       define __bswap_16(x) __bswap_constant_16 (x)
280 #   endif
281
282 /* Swap bytes in 32 bit value.  */
283 #   define __bswap_constant_32(x) \
284         ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >>  8) |            \
285          (((x) & 0x0000ff00) <<  8) | (((x) & 0x000000ff) << 24))
286
287 #   if defined __GNUC__ && __GNUC__ >= 2
288 /* To swap the bytes in a word the i486 processors and up provide the
289    `bswap' opcode.  On i386 we have to use three instructions.  */
290 #       if !defined __i486__ && !defined __pentium__ && !defined __pentiumpro__
291 #           define __bswap_32(x) \
292                 (__extension__                                                \
293                  ({ register unsigned int __v;                                \
294                     if (__builtin_constant_p (x))                             \
295                       __v = __bswap_constant_32 (x);                          \
296                     else                                                      \
297                       __asm__ __volatile__ ("rorw $8, %w0;"                   \
298                                             "rorl $16, %0;"                   \
299                                             "rorw $8, %w0"                    \
300                                             : "=r" (__v)                      \
301                                             : "0" ((unsigned int) (x))        \
302                                             : "cc");                          \
303                     __v; }))
304 #       else
305 #           define __bswap_32(x) \
306                 (__extension__                                                \
307                  ({ register unsigned int __v;                                \
308                     if (__builtin_constant_p (x))                             \
309                       __v = __bswap_constant_32 (x);                          \
310                     else                                                      \
311                       __asm__ __volatile__ ("bswap %0"                        \
312                                             : "=r" (__v)                      \
313                                             : "0" ((unsigned int) (x)));      \
314                     __v; }))
315 #       endif
316 #   else
317 #       define __bswap_32(x) __bswap_constant_32 (x)
318 #   endif
319
320 #   if defined __GNUC__ && __GNUC__ >= 2
321 /* Swap bytes in 64 bit value.  */
322 #       define __bswap_constant_64(x) \
323             ((((x) & 0xff00000000000000ull) >> 56)                            \
324              | (((x) & 0x00ff000000000000ull) >> 40)                          \
325              | (((x) & 0x0000ff0000000000ull) >> 24)                          \
326              | (((x) & 0x000000ff00000000ull) >> 8)                           \
327              | (((x) & 0x00000000ff000000ull) << 8)                           \
328              | (((x) & 0x0000000000ff0000ull) << 24)                          \
329              | (((x) & 0x000000000000ff00ull) << 40)                          \
330              | (((x) & 0x00000000000000ffull) << 56))
331
332 #       define __bswap_64(x) \
333             (__extension__                                                    \
334              ({ union { __extension__ unsigned long long int __ll;            \
335                         unsigned long int __l[2]; } __w, __r;                 \
336                 if (__builtin_constant_p (x))                                 \
337                   __r.__ll = __bswap_constant_64 (x);                         \
338                 else                                                          \
339                   {                                                           \
340                     __w.__ll = (x);                                           \
341                     __r.__l[0] = __bswap_32 (__w.__l[1]);                     \
342                     __r.__l[1] = __bswap_32 (__w.__l[0]);                     \
343                   }                                                           \
344                 __r.__ll; }))
345 #   else
346 #       define __bswap_64(i) \
347             (u64)((__bswap_32((i) & 0xffffffff) << 32) |                      \
348             __bswap_32(((i) >> 32) & 0xffffffff ))
349 #   endif
350
351 #else /* NTOHL_IN_SYS_PARAM_H || WIN32 */
352 #   include <netinet/in.h>
353
354 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
355
356 /* CEIL: division with round to nearest greater integer */
357 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
358
359 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
360 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
361
362 /* __MAX and __MIN: self explanatory */
363 #ifndef __MAX
364 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
365 #endif
366 #ifndef __MIN
367 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
368 #endif
369
370 /* MSB (big endian)/LSB (little endian) conversions - network order is always
371  * MSB, and should be used for both network communications and files. Note that
372  * byte orders other than little and big endians are not supported, but only
373  * the VAX seems to have such exotic properties - note that these 'functions'
374  * needs <netinet/in.h> or the local equivalent. */
375 #if !defined( WIN32 )
376 #if WORDS_BIGENDIAN
377 #   define hton16      htons
378 #   define hton32      htonl
379 #   define hton64(i)   ( i )
380 #   define ntoh16      ntohs
381 #   define ntoh32      ntohl
382 #   define ntoh64(i)   ( i )
383 #else
384 #   define hton16      htons
385 #   define hton32      htonl
386     static inline u64 __hton64( u64 i )
387     {
388         return ((u64)(htonl((i) & 0xffffffff)) << 32)
389                 | htonl(((i) >> 32) & 0xffffffff );
390     }
391 #   define hton64(i)   __hton64( i )
392 #   define ntoh16      ntohs
393 #   define ntoh32      ntohl
394 #   define ntoh64      hton64
395 #endif
396 #endif /* !defined( WIN32 ) */
397
398 /* Macros with automatic casts */
399 #define U64_AT(p)   ( ntoh64 ( *( (u64 *)(p) ) ) )
400 #define U32_AT(p)   ( ntoh32 ( *( (u32 *)(p) ) ) )
401 #define U16_AT(p)   ( ntoh16 ( *( (u16 *)(p) ) ) )
402
403 /* Alignment of critical static data structures */
404 #ifdef ATTRIBUTE_ALIGNED_MAX
405 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
406 #else
407 #   define ATTR_ALIGN(align)
408 #endif
409
410 /* Alignment of critical dynamic data structure
411  *
412  * Not all platforms support memalign so we provide a vlc_memalign wrapper
413  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
414  * *pp_orig is the pointer that has to be freed afterwards.
415  */
416 #if 0
417 #ifdef HAVE_POSIX_MEMALIGN
418 #   define vlc_memalign(align,size,pp_orig) \
419     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
420 #endif
421 #endif
422 #ifdef HAVE_MEMALIGN
423     /* Some systems have memalign() but no declaration for it */
424     void * memalign( size_t align, size_t size );
425
426 #   define vlc_memalign(pp_orig,align,size) \
427     ( *(pp_orig) = memalign( align, size ) )
428
429 #else /* We don't have any choice but to align manually */
430 #   define vlc_memalign(pp_orig,align,size) \
431     (( *(pp_orig) = malloc( size + align - 1 )) \
432         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
433                        & (~(unsigned long)(align-1)) ) \
434         : NULL )
435
436 #endif
437
438
439 #define I64C(x)         x##LL
440
441
442 #if defined( WIN32 )
443 /* The ntoh* and hton* bytes swapping functions are provided by winsock
444  * but for conveniency and speed reasons it is better to implement them
445  * ourselves. ( several plugins use them and it is too much hassle to link
446  * winsock with each of them ;-)
447  */
448 #   ifdef WORDS_BIGENDIAN
449 #       define ntoh32(x)       (x)
450 #       define ntoh16(x)       (x)
451 #       define ntoh64(x)       (x)
452 #       define hton32(x)       (x)
453 #       define hton16(x)       (x)
454 #       define hton64(x)       (x)
455 #   else
456 #       define ntoh32(x)     __bswap_32 (x)
457 #       define ntoh16(x)     __bswap_16 (x)
458 #       define ntoh64(x)     __bswap_32 (x)
459 #       define hton32(x)     __bswap_32 (x)
460 #       define hton16(x)     __bswap_16 (x)
461 #       define hton64(x)     __bswap_64 (x)
462 #   endif
463
464 /* win32, cl and icl support */
465 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
466 #       define __attribute__(x)
467 #       define __inline__      __inline
468 #       define strncasecmp     strnicmp
469 #       define strcasecmp      stricmp
470 #       define S_IFBLK         0x3000  /* Block */
471 #       define S_ISBLK(m)      (0)
472 #       define S_ISCHR(m)      (0)
473 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
474 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
475 #       undef I64C
476 #       define I64C(x)         x##i64
477 #   endif
478
479 /* several type definitions */
480 #   if defined( __MINGW32__ )
481 #       if !defined( _OFF_T_ )
482 typedef long long _off_t;
483 typedef _off_t off_t;
484 #           define _OFF_T_
485 #       else
486 #           define off_t long long
487 #       endif
488 #   endif
489
490 #   if defined( _MSC_VER )
491 #       if !defined( _OFF_T_DEFINED )
492 typedef __int64 off_t;
493 #           define _OFF_T_DEFINED
494 #       else
495 #           define off_t __int64
496 #       endif
497 #   endif
498
499 #   if defined( __BORLANDC__ )
500 #       undef off_t
501 #       define off_t unsigned __int64
502 #   endif
503
504 #   ifndef O_NONBLOCK
505 #       define O_NONBLOCK 0
506 #   endif
507
508 #   ifndef snprintf
509 #       define snprintf _snprintf  /* snprintf not defined in mingw32 (bug?) */
510 #   endif
511
512 #endif
513
514 /*****************************************************************************
515  * CPU capabilities
516  *****************************************************************************/
517 #define CPU_CAPABILITY_NONE    0
518 #define CPU_CAPABILITY_486     (1<<0)
519 #define CPU_CAPABILITY_586     (1<<1)
520 #define CPU_CAPABILITY_PPRO    (1<<2)
521 #define CPU_CAPABILITY_MMX     (1<<3)
522 #define CPU_CAPABILITY_3DNOW   (1<<4)
523 #define CPU_CAPABILITY_MMXEXT  (1<<5)
524 #define CPU_CAPABILITY_SSE     (1<<6)
525 #define CPU_CAPABILITY_ALTIVEC (1<<16)
526 #define CPU_CAPABILITY_FPU     (1<<31)
527
528 /*****************************************************************************
529  * I18n stuff
530  *****************************************************************************/
531 #ifndef PACKAGE /* Borland C++ uses this ! */
532 #define PACKAGE VLC_PACKAGE
533 #endif
534 #define VERSION VLC_VERSION
535
536 #if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( MODULE_NAME_IS_gnome )
537 #   include <libintl.h>
538 #   undef _
539 #   define _(String) dgettext (PACKAGE, String)
540 #   ifdef gettext_noop
541 #       define N_(String) gettext_noop (String)
542 #   else
543 #       define N_(String) (String)
544 #   endif
545 #elif !defined( MODULE_NAME_IS_gnome )
546 #   define _(String) (String)
547 #   define N_(String) (String)
548 #endif
549
550 /*****************************************************************************
551  * Plug-in stuff
552  *****************************************************************************/
553 #include "vlc_symbols.h"