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.47 2002/12/30 17:36:01 gbazin Exp $
8 * Authors: Samuel Hocevar <sam@via.ecp.fr>
9 * Vincent Seguin <seguin@via.ecp.fr>
10 * Gildas Bazin <gbazin@netcourrier.com>
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.
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.
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 *****************************************************************************/
27 /*****************************************************************************
28 * Required vlc headers
29 *****************************************************************************/
30 #if defined( __BORLANDC__ )
36 #if defined( __BORLANDC__ )
37 # undef HAVE_VARIADIC_MACROS
39 # undef HAVE_INTTYPES_H
42 #include "vlc_config.h"
43 #include "modules_inner.h"
45 /*****************************************************************************
46 * Required system headers
47 *****************************************************************************/
49 # include <string.h> /* strerror() */
52 #ifdef HAVE_SYS_TYPES_H
53 # include <sys/types.h>
56 /*****************************************************************************
57 * Basic types definitions
58 *****************************************************************************/
59 #if defined( HAVE_STDINT_H )
61 #elif defined( HAVE_INTTYPES_H )
62 # include <inttypes.h>
63 #elif defined( SYS_CYGWIN )
64 # include <sys/types.h>
65 /* Cygwin only defines half of these... */
66 typedef u_int8_t uint8_t;
67 typedef u_int16_t uint16_t;
68 typedef u_int32_t uint32_t;
69 typedef u_int64_t uint64_t;
71 /* Fallback types (very x86-centric, sorry) */
72 typedef unsigned char uint8_t;
73 typedef signed char int8_t;
74 typedef unsigned short uint16_t;
75 typedef signed short int16_t;
76 typedef unsigned int uint32_t;
77 typedef signed int int32_t;
78 # if defined( _MSC_VER ) \
79 || defined( UNDER_CE ) \
80 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
81 typedef unsigned __int64 uint64_t;
82 typedef signed __int64 int64_t;
84 typedef unsigned long long uint64_t;
85 typedef signed long long int64_t;
89 typedef uint8_t byte_t;
91 /* ptrdiff_t definition */
98 /* Not portable in a 64-bit environment. */
99 typedef int ptrdiff_t;
103 #if defined( WIN32 ) || defined( UNDER_CE )
107 /* Counter for statistics and profiling */
108 typedef unsigned long count_t;
110 /* DCT elements types */
111 typedef int16_t dctelem_t;
113 /* Video buffer types */
114 typedef uint8_t yuv_data_t;
117 typedef uint16_t audio_volume_t;
119 #ifndef HAVE_SOCKLEN_T
120 typedef int socklen_t;
123 /*****************************************************************************
124 * Old types definitions
125 *****************************************************************************
126 * We still provide these types because most of the VLC code uses them
127 * instead of the C9x types. They should be removed when the transition is
128 * complete (probably in 10 years).
129 *****************************************************************************/
132 typedef uint16_t u16;
134 typedef uint32_t u32;
136 typedef uint64_t u64;
139 /*****************************************************************************
140 * mtime_t: high precision date or time interval
141 *****************************************************************************
142 * Store a high precision date or time interval. The maximum precision is the
143 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
144 * time interval is then 292271 years, which should be long enough for any
145 * video). Dates are stored as microseconds since a common date (usually the
146 * epoch). Note that date and time intervals can be manipulated using regular
147 * arithmetic operators, and that no special functions are required.
148 *****************************************************************************/
149 typedef int64_t mtime_t;
151 /*****************************************************************************
152 * The vlc_fourcc_t type.
153 *****************************************************************************
154 * See http://www.webartz.com/fourcc/ for a very detailed list.
155 *****************************************************************************/
156 typedef uint32_t vlc_fourcc_t;
158 #ifdef WORDS_BIGENDIAN
159 # define VLC_FOURCC( a, b, c, d ) \
160 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
161 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
162 # define VLC_TWOCC( a, b ) \
163 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
166 # define VLC_FOURCC( a, b, c, d ) \
167 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
168 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
169 # define VLC_TWOCC( a, b ) \
170 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
174 /*****************************************************************************
175 * Classes declaration
176 *****************************************************************************/
179 typedef struct libvlc_t libvlc_t;
180 typedef struct vlc_t vlc_t;
181 typedef struct variable_t variable_t;
184 typedef struct msg_bank_t msg_bank_t;
185 typedef struct msg_subscription_t msg_subscription_t;
188 typedef struct playlist_t playlist_t;
189 typedef struct playlist_item_t playlist_item_t;
192 typedef struct module_bank_t module_bank_t;
193 typedef struct module_t module_t;
194 typedef struct module_config_t module_config_t;
195 typedef struct module_symbols_t module_symbols_t;
198 typedef struct intf_thread_t intf_thread_t;
199 typedef struct intf_sys_t intf_sys_t;
200 typedef struct intf_console_t intf_console_t;
201 typedef struct intf_msg_t intf_msg_t;
202 typedef struct intf_channel_t intf_channel_t;
205 typedef struct input_thread_t input_thread_t;
206 typedef struct input_channel_t input_channel_t;
207 typedef struct input_area_t input_area_t;
208 typedef struct input_buffers_t input_buffers_t;
209 typedef struct input_socket_t input_socket_t;
210 typedef struct input_info_t input_info_t;
211 typedef struct input_info_category_t input_info_category_t;
212 typedef struct access_sys_t access_sys_t;
213 typedef struct demux_sys_t demux_sys_t;
214 typedef struct es_descriptor_t es_descriptor_t;
215 typedef struct es_sys_t es_sys_t;
216 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
217 typedef struct pgrm_sys_t pgrm_sys_t;
218 typedef struct stream_descriptor_t stream_descriptor_t;
219 typedef struct stream_sys_t stream_sys_t;
222 typedef struct aout_instance_t aout_instance_t;
223 typedef struct aout_sys_t aout_sys_t;
224 typedef struct aout_fifo_t aout_fifo_t;
225 typedef struct aout_input_t aout_input_t;
226 typedef struct aout_buffer_t aout_buffer_t;
227 typedef struct audio_sample_format_t audio_sample_format_t;
228 typedef struct audio_date_t audio_date_t;
231 typedef struct vout_thread_t vout_thread_t;
232 typedef struct vout_font_t vout_font_t;
233 typedef struct vout_sys_t vout_sys_t;
234 typedef struct chroma_sys_t chroma_sys_t;
235 typedef struct picture_t picture_t;
236 typedef struct picture_sys_t picture_sys_t;
237 typedef struct picture_heap_t picture_heap_t;
238 typedef struct subpicture_t subpicture_t;
239 typedef struct subpicture_sys_t subpicture_sys_t;
242 typedef struct sout_instance_t sout_instance_t;
243 typedef struct sout_fifo_t sout_fifo_t;
244 typedef struct sout_input_t sout_input_t;
245 typedef struct sout_buffer_t sout_buffer_t;
246 typedef struct sout_packet_format_t sout_packet_format_t;
249 typedef struct decoder_fifo_t decoder_fifo_t;
252 typedef struct data_packet_t data_packet_t;
253 typedef struct data_buffer_t data_buffer_t;
254 typedef struct stream_position_t stream_position_t;
255 typedef struct stream_ctrl_t stream_ctrl_t;
256 typedef struct pes_packet_t pes_packet_t;
257 typedef struct bit_stream_t bit_stream_t;
258 typedef struct network_socket_t network_socket_t;
259 typedef struct iso639_lang_t iso639_lang_t;
261 /*****************************************************************************
263 *****************************************************************************/
264 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
265 char const *, /* variable name */
266 vlc_value_t, /* old value */
267 vlc_value_t, /* new value */
268 void * ); /* callback data */
270 /*****************************************************************************
272 *****************************************************************************/
274 # define VLC_EXPORT( type, name, args ) type name args
276 # define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
277 extern module_symbols_t* p_symbols;
280 /*****************************************************************************
281 * OS-specific headers and thread types
282 *****************************************************************************/
283 #if defined( WIN32 ) || defined( UNDER_CE )
284 # define WIN32_LEAN_AND_MEAN
285 # include <windows.h>
286 # define IS_WINNT ( GetVersion() < 0x80000000 )
289 #include "vlc_threads.h"
291 /*****************************************************************************
292 * Common structure members
293 *****************************************************************************/
295 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
296 #define VLC_COMMON_MEMBERS \
299 char *psz_object_type; \
300 char *psz_object_name; \
302 /* Thread properties, if any */ \
303 vlc_bool_t b_thread; \
304 vlc_thread_t thread_id; \
306 /* Object access lock */ \
307 vlc_mutex_t object_lock; \
308 vlc_cond_t object_wait; \
310 /* Object properties */ \
311 volatile vlc_bool_t b_error; /* set by the object */ \
312 volatile vlc_bool_t b_die; /* set by the outside */ \
313 volatile vlc_bool_t b_dead; /* set by the object */ \
314 volatile vlc_bool_t b_attached; /* set by the object */ \
316 /* Object variables */ \
317 vlc_mutex_t var_lock; \
319 variable_t * p_vars; \
321 /* Stuff related to the libvlc structure */ \
322 libvlc_t * p_libvlc; /* root of all evil */ \
323 vlc_t * p_vlc; /* (root of all evil) - 1 */ \
325 volatile int i_refcount; /* usage count */ \
326 vlc_object_t * p_parent; /* our parent */ \
327 vlc_object_t ** pp_children; /* our children */ \
328 volatile int i_children; \
333 /* Just a reminder so that people don't cast garbage */ \
334 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
336 /* VLC_OBJECT: attempt at doing a clever cast */
337 #define VLC_OBJECT( x ) \
338 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
340 /*****************************************************************************
341 * Macros and inline functions
342 *****************************************************************************/
343 #ifdef NTOHL_IN_SYS_PARAM_H
344 # include <sys/param.h>
346 #elif !defined(WIN32) && !defined( UNDER_CE )
347 # include <netinet/in.h>
349 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
351 /* CEIL: division with round to nearest greater integer */
352 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
354 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
355 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
357 /* __MAX and __MIN: self explanatory */
359 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
362 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
365 /* Dynamic array handling: realloc array, move data, increment position */
366 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
371 (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
375 (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
377 memmove( (p_ar) + (i_pos) + 1, \
379 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
380 (p_ar)[i_pos] = elem; \
385 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
388 memmove( (p_ar) + (i_pos), \
389 (p_ar) + (i_pos) + 1, \
390 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
391 if( i_oldsize > 1 ) \
393 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
405 /* MSB (big endian)/LSB (little endian) conversions - network order is always
406 * MSB, and should be used for both network communications and files. Note that
407 * byte orders other than little and big endians are not supported, but only
408 * the VAX seems to have such exotic properties. */
409 static inline uint16_t U16_AT( void * _p )
411 uint8_t * p = (uint8_t *)_p;
412 return ( ((uint16_t)p[0] << 8) | p[1] );
414 static inline uint32_t U32_AT( void * _p )
416 uint8_t * p = (uint8_t *)_p;
417 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
418 | ((uint32_t)p[2] << 8) | p[3] );
420 static inline uint64_t U64_AT( void * _p )
422 uint8_t * p = (uint8_t *)_p;
423 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
424 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
425 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
426 | ((uint64_t)p[6] << 8) | p[7] );
429 # define hton16(i) ( i )
430 # define hton32(i) ( i )
431 # define hton64(i) ( i )
432 # define ntoh16(i) ( i )
433 # define ntoh32(i) ( i )
434 # define ntoh64(i) ( i )
436 # define hton16(i) U16_AT(&i)
437 # define hton32(i) U32_AT(&i)
438 # define hton64(i) U64_AT(&i)
439 # define ntoh16(i) U16_AT(&i)
440 # define ntoh32(i) U32_AT(&i)
441 # define ntoh64(i) U64_AT(&i)
444 /* Format string sanity checks */
445 #ifdef HAVE_ATTRIBUTE_FORMAT
446 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
448 # define ATTRIBUTE_FORMAT(x,y)
451 /* Alignment of critical static data structures */
452 #ifdef ATTRIBUTE_ALIGNED_MAX
453 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
455 # define ATTR_ALIGN(align)
458 /* Alignment of critical dynamic data structure
460 * Not all platforms support memalign so we provide a vlc_memalign wrapper
461 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
462 * *pp_orig is the pointer that has to be freed afterwards.
465 #ifdef HAVE_POSIX_MEMALIGN
466 # define vlc_memalign(align,size,pp_orig) \
467 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
471 /* Some systems have memalign() but no declaration for it */
472 void * memalign( size_t align, size_t size );
474 # define vlc_memalign(pp_orig,align,size) \
475 ( *(pp_orig) = memalign( align, size ) )
477 #else /* We don't have any choice but to align manually */
478 # define vlc_memalign(pp_orig,align,size) \
479 (( *(pp_orig) = malloc( size + align - 1 )) \
480 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
481 & (~(unsigned long)(align-1)) ) \
486 /* Stuff defined in src/extras/libc.c */
488 # define strdup vlc_strdup
489 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
490 #elif !defined(__PLUGIN__)
491 # define vlc_strdup NULL
495 # define strndup vlc_strndup
496 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
497 #elif !defined(__PLUGIN__)
498 # define vlc_strndup NULL
502 # define atof vlc_atof
503 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
504 #elif !defined(__PLUGIN__)
505 # define vlc_atof NULL
509 # define getenv vlc_getenv
510 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
511 #elif !defined(__PLUGIN__)
512 # define vlc_getenv NULL
515 #ifndef HAVE_STRCASECMP
517 # define strcasecmp stricmp
518 # define vlc_strcasecmp NULL
519 # elif !defined(__PLUGIN__)
520 # define strcasecmp vlc_strcasecmp
521 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
523 #elif !defined(__PLUGIN__)
524 # define vlc_strcasecmp NULL
527 #ifndef HAVE_STRNCASECMP
528 # ifdef HAVE_STRNICMP
529 # define strncasecmp strnicmp
530 # define vlc_strncasecmp NULL
531 # elif !defined(__PLUGIN__)
532 # define strncasecmp vlc_strncasecmp
533 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
535 #elif !defined(__PLUGIN__)
536 # define vlc_strncasecmp NULL
539 /* Format type specifiers for 64 bits numbers */
540 #if !defined(WIN32) && !defined(UNDER_CE)
541 # define I64Fd "%lld"
542 # define I64Fi "%lli"
543 # define I64Fo "%llo"
544 # define I64Fu "%llu"
545 # define I64Fx "%llx"
546 # define I64FX "%llX"
548 # define I64Fd "%I64d"
549 # define I64Fi "%I64i"
550 # define I64Fo "%I64o"
551 # define I64Fu "%I64u"
552 # define I64Fx "%I64x"
553 # define I64FX "%I64X"
554 #endif /* defined(WIN32)||defined(UNDER_CE) */
556 /* 64 bits integer constant suffix */
557 #if !defined(WIN32) && !defined(UNDER_CE)
558 # define I64C(x) x##LL
560 # define I64C(x) x##i64
561 #endif /* defined(WIN32)||defined(UNDER_CE) */
563 #if defined(WIN32) || defined(UNDER_CE)
564 /* win32, cl and icl support */
565 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
566 # define __attribute__(x)
567 # define __inline__ __inline
568 # define S_IFBLK 0x3000 /* Block */
569 # define S_ISBLK(m) (0)
570 # define S_ISCHR(m) (0)
571 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
572 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
575 /* several type definitions */
576 # if defined( __MINGW32__ )
577 # if !defined( _OFF_T_ )
578 typedef long long _off_t;
579 typedef _off_t off_t;
585 # define off_t long long
589 # if defined( _MSC_VER )
590 # if !defined( _OFF_T_DEFINED )
591 typedef __int64 off_t;
592 # define _OFF_T_DEFINED
594 # define off_t __int64
598 # if defined( __BORLANDC__ )
600 # define off_t unsigned __int64
604 # define O_NONBLOCK 0
607 /* These two are not defined in mingw32 (bug?) */
609 # define snprintf _snprintf
612 # define vsnprintf _vsnprintf
617 /* lseek (defined in src/extras/libc.c) */
619 # define lseek vlc_lseek
620 VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
621 #elif !defined(__PLUGIN__)
622 # define vlc_lseek NULL
625 /*****************************************************************************
627 *****************************************************************************/
628 #define CPU_CAPABILITY_NONE 0
629 #define CPU_CAPABILITY_486 (1<<0)
630 #define CPU_CAPABILITY_586 (1<<1)
631 #define CPU_CAPABILITY_PPRO (1<<2)
632 #define CPU_CAPABILITY_MMX (1<<3)
633 #define CPU_CAPABILITY_3DNOW (1<<4)
634 #define CPU_CAPABILITY_MMXEXT (1<<5)
635 #define CPU_CAPABILITY_SSE (1<<6)
636 #define CPU_CAPABILITY_ALTIVEC (1<<16)
637 #define CPU_CAPABILITY_FPU (1<<31)
639 /*****************************************************************************
641 *****************************************************************************/
642 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
644 #if defined( ENABLE_NLS ) && defined( HAVE_INCLUDED_GETTEXT )
645 # include "libintl.h"
647 # define _(String) vlc_dgettext (PACKAGE, String)
648 # define N_(String) ((char*)(String))
649 #elif defined( ENABLE_NLS ) && defined( HAVE_GETTEXT )
650 # include <libintl.h>
652 # define _(String) dgettext (PACKAGE, String)
653 # define N_(String) ((char*)(String))
654 #elif !defined( NEED_GNOMESUPPORT_H )
655 # define _(String) ((char*)(String))
656 # define N_(String) ((char*)(String))
659 /*****************************************************************************
660 * Additional vlc stuff
661 *****************************************************************************/
662 #include "vlc_symbols.h"
663 #include "os_specific.h"
664 #include "vlc_messages.h"
665 #include "variables.h"
666 #include "vlc_objects.h"
667 #include "vlc_threads_funcs.h"
671 #include "configuration.h"
673 #if defined( __BORLANDC__ )