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.67 2003/06/05 11:52:19 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
43 #include "vlc_config.h"
44 #include "modules_inner.h"
46 /*****************************************************************************
47 * Required system headers
48 *****************************************************************************/
50 # include <string.h> /* strerror() */
53 #ifdef HAVE_SYS_TYPES_H
54 # include <sys/types.h>
57 /*****************************************************************************
58 * Basic types definitions
59 *****************************************************************************/
60 #if defined( HAVE_STDINT_H )
62 #elif defined( HAVE_INTTYPES_H )
63 # include <inttypes.h>
64 #elif defined( SYS_CYGWIN )
65 # include <sys/types.h>
66 /* Cygwin only defines half of these... */
67 typedef u_int8_t uint8_t;
68 typedef u_int16_t uint16_t;
69 typedef u_int32_t uint32_t;
70 typedef u_int64_t uint64_t;
72 /* Fallback types (very x86-centric, sorry) */
73 typedef unsigned char uint8_t;
74 typedef signed char int8_t;
75 typedef unsigned short uint16_t;
76 typedef signed short int16_t;
77 typedef unsigned int uint32_t;
78 typedef signed int int32_t;
79 # if defined( _MSC_VER ) \
80 || defined( UNDER_CE ) \
81 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
82 typedef unsigned __int64 uint64_t;
83 typedef signed __int64 int64_t;
85 typedef unsigned long long uint64_t;
86 typedef signed long long int64_t;
90 typedef uint8_t byte_t;
92 /* ptrdiff_t definition */
99 /* Not portable in a 64-bit environment. */
100 typedef int ptrdiff_t;
108 #if defined( WIN32 ) || defined( UNDER_CE )
112 /* Counter for statistics and profiling */
113 typedef unsigned long count_t;
115 /* DCT elements types */
116 typedef int16_t dctelem_t;
118 /* Video buffer types */
119 typedef uint8_t yuv_data_t;
122 typedef uint16_t audio_volume_t;
124 #ifndef HAVE_SOCKLEN_T
125 typedef int socklen_t;
128 /*****************************************************************************
129 * Old types definitions
130 *****************************************************************************
131 * We still provide these types because most of the VLC code uses them
132 * instead of the C9x types. They should be removed when the transition is
133 * complete (probably in 10 years).
134 *****************************************************************************/
137 typedef uint16_t u16;
139 typedef uint32_t u32;
141 typedef uint64_t u64;
144 /*****************************************************************************
145 * mtime_t: high precision date or time interval
146 *****************************************************************************
147 * Store a high precision date or time interval. The maximum precision is the
148 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
149 * time interval is then 292271 years, which should be long enough for any
150 * video). Dates are stored as microseconds since a common date (usually the
151 * epoch). Note that date and time intervals can be manipulated using regular
152 * arithmetic operators, and that no special functions are required.
153 *****************************************************************************/
154 typedef int64_t mtime_t;
156 /*****************************************************************************
157 * The vlc_fourcc_t type.
158 *****************************************************************************
159 * See http://www.webartz.com/fourcc/ for a very detailed list.
160 *****************************************************************************/
161 typedef uint32_t vlc_fourcc_t;
163 #ifdef WORDS_BIGENDIAN
164 # define VLC_FOURCC( a, b, c, d ) \
165 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
166 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
167 # define VLC_TWOCC( a, b ) \
168 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
171 # define VLC_FOURCC( a, b, c, d ) \
172 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
173 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
174 # define VLC_TWOCC( a, b ) \
175 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
179 /*****************************************************************************
180 * Classes declaration
181 *****************************************************************************/
184 typedef struct libvlc_t libvlc_t;
185 typedef struct vlc_t vlc_t;
186 typedef struct variable_t variable_t;
189 typedef struct msg_bank_t msg_bank_t;
190 typedef struct msg_subscription_t msg_subscription_t;
193 typedef struct playlist_t playlist_t;
194 typedef struct playlist_item_t playlist_item_t;
197 typedef struct module_bank_t module_bank_t;
198 typedef struct module_t module_t;
199 typedef struct module_config_t module_config_t;
200 typedef struct module_symbols_t module_symbols_t;
203 typedef struct intf_thread_t intf_thread_t;
204 typedef struct intf_sys_t intf_sys_t;
205 typedef struct intf_console_t intf_console_t;
206 typedef struct intf_msg_t intf_msg_t;
207 typedef struct intf_channel_t intf_channel_t;
210 typedef struct input_thread_t input_thread_t;
211 typedef struct input_channel_t input_channel_t;
212 typedef struct input_area_t input_area_t;
213 typedef struct input_buffers_t input_buffers_t;
214 typedef struct input_socket_t input_socket_t;
215 typedef struct input_info_t input_info_t;
216 typedef struct input_info_category_t input_info_category_t;
217 typedef struct access_sys_t access_sys_t;
218 typedef struct demux_sys_t demux_sys_t;
219 typedef struct es_descriptor_t es_descriptor_t;
220 typedef struct es_sys_t es_sys_t;
221 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
222 typedef struct pgrm_sys_t pgrm_sys_t;
223 typedef struct stream_descriptor_t stream_descriptor_t;
224 typedef struct stream_sys_t stream_sys_t;
227 typedef struct aout_instance_t aout_instance_t;
228 typedef struct aout_sys_t aout_sys_t;
229 typedef struct aout_fifo_t aout_fifo_t;
230 typedef struct aout_input_t aout_input_t;
231 typedef struct aout_buffer_t aout_buffer_t;
232 typedef struct audio_sample_format_t audio_sample_format_t;
233 typedef struct audio_date_t audio_date_t;
236 typedef struct vout_thread_t vout_thread_t;
237 typedef struct vout_font_t vout_font_t;
238 typedef struct vout_sys_t vout_sys_t;
239 typedef struct chroma_sys_t chroma_sys_t;
240 typedef struct picture_t picture_t;
241 typedef struct picture_sys_t picture_sys_t;
242 typedef struct picture_heap_t picture_heap_t;
243 typedef struct subpicture_t subpicture_t;
244 typedef struct subpicture_sys_t subpicture_sys_t;
245 typedef struct vout_synchro_t vout_synchro_t;
248 typedef struct sout_instance_t sout_instance_t;
249 typedef struct sout_fifo_t sout_fifo_t;
250 typedef struct sout_input_t sout_input_t;
251 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
252 typedef struct sout_buffer_t sout_buffer_t;
253 typedef struct sout_access_out_t sout_access_out_t;
254 typedef struct sout_mux_t sout_mux_t;
255 typedef struct sout_stream_t sout_stream_t;
256 typedef struct sout_cfg_t sout_cfg_t;
257 typedef struct sout_format_t sout_format_t;
258 typedef struct sap_session_t sap_session_t;
260 typedef struct decoder_fifo_t decoder_fifo_t;
263 typedef struct data_packet_t data_packet_t;
264 typedef struct data_buffer_t data_buffer_t;
265 typedef struct stream_position_t stream_position_t;
266 typedef struct stream_ctrl_t stream_ctrl_t;
267 typedef struct pes_packet_t pes_packet_t;
268 typedef struct bit_stream_t bit_stream_t;
269 typedef struct network_socket_t network_socket_t;
270 typedef struct iso639_lang_t iso639_lang_t;
272 /*****************************************************************************
274 *****************************************************************************/
275 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
276 char const *, /* variable name */
277 vlc_value_t, /* old value */
278 vlc_value_t, /* new value */
279 void * ); /* callback data */
281 /*****************************************************************************
283 *****************************************************************************/
285 # define VLC_EXPORT( type, name, args ) type name args
287 # define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
288 extern module_symbols_t* p_symbols;
291 /*****************************************************************************
292 * OS-specific headers and thread types
293 *****************************************************************************/
294 #if defined( WIN32 ) || defined( UNDER_CE )
295 # define WIN32_LEAN_AND_MEAN
296 # include <windows.h>
297 # define IS_WINNT ( GetVersion() < 0x80000000 )
300 #include "vlc_threads.h"
302 /*****************************************************************************
303 * Common structure members
304 *****************************************************************************/
306 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
307 #define VLC_COMMON_MEMBERS \
310 char *psz_object_type; \
311 char *psz_object_name; \
313 /* Thread properties, if any */ \
314 vlc_bool_t b_thread; \
315 vlc_thread_t thread_id; \
317 /* Object access lock */ \
318 vlc_mutex_t object_lock; \
319 vlc_cond_t object_wait; \
321 /* Object properties */ \
322 volatile vlc_bool_t b_error; /* set by the object */ \
323 volatile vlc_bool_t b_die; /* set by the outside */ \
324 volatile vlc_bool_t b_dead; /* set by the object */ \
325 volatile vlc_bool_t b_attached; /* set by the object */ \
327 /* Object variables */ \
328 vlc_mutex_t var_lock; \
330 variable_t * p_vars; \
332 /* Stuff related to the libvlc structure */ \
333 libvlc_t * p_libvlc; /* root of all evil */ \
334 vlc_t * p_vlc; /* (root of all evil) - 1 */ \
336 volatile int i_refcount; /* usage count */ \
337 vlc_object_t * p_parent; /* our parent */ \
338 vlc_object_t ** pp_children; /* our children */ \
339 volatile int i_children; \
344 /* Just a reminder so that people don't cast garbage */ \
345 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
347 /* VLC_OBJECT: attempt at doing a clever cast */
348 #define VLC_OBJECT( x ) \
349 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
351 /*****************************************************************************
352 * Macros and inline functions
353 *****************************************************************************/
354 #ifdef NTOHL_IN_SYS_PARAM_H
355 # include <sys/param.h>
357 #elif !defined(WIN32) && !defined( UNDER_CE )
358 # include <netinet/in.h>
360 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
362 /* CEIL: division with round to nearest greater integer */
363 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
365 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
366 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
368 /* __MAX and __MIN: self explanatory */
370 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
373 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
376 /* Dynamic array handling: realloc array, move data, increment position */
377 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
382 (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
386 (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
388 if( (i_oldsize) - (i_pos) ) \
390 memmove( (p_ar) + (i_pos) + 1, \
392 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
394 (p_ar)[i_pos] = elem; \
399 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
402 if( (i_oldsize) - (i_pos) - 1 ) \
404 memmove( (p_ar) + (i_pos), \
405 (p_ar) + (i_pos) + 1, \
406 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
408 if( i_oldsize > 1 ) \
410 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
422 /* MSB (big endian)/LSB (little endian) conversions - network order is always
423 * MSB, and should be used for both network communications and files. Note that
424 * byte orders other than little and big endians are not supported, but only
425 * the VAX seems to have such exotic properties. */
426 static inline uint16_t U16_AT( void * _p )
428 uint8_t * p = (uint8_t *)_p;
429 return ( ((uint16_t)p[0] << 8) | p[1] );
431 static inline uint32_t U32_AT( void * _p )
433 uint8_t * p = (uint8_t *)_p;
434 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
435 | ((uint32_t)p[2] << 8) | p[3] );
437 static inline uint64_t U64_AT( void * _p )
439 uint8_t * p = (uint8_t *)_p;
440 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
441 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
442 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
443 | ((uint64_t)p[6] << 8) | p[7] );
446 # define hton16(i) ( i )
447 # define hton32(i) ( i )
448 # define hton64(i) ( i )
449 # define ntoh16(i) ( i )
450 # define ntoh32(i) ( i )
451 # define ntoh64(i) ( i )
453 # define hton16(i) U16_AT(&i)
454 # define hton32(i) U32_AT(&i)
455 # define hton64(i) U64_AT(&i)
456 # define ntoh16(i) U16_AT(&i)
457 # define ntoh32(i) U32_AT(&i)
458 # define ntoh64(i) U64_AT(&i)
461 /* Format string sanity checks */
462 #ifdef HAVE_ATTRIBUTE_FORMAT
463 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
465 # define ATTRIBUTE_FORMAT(x,y)
468 /* Alignment of critical static data structures */
469 #ifdef ATTRIBUTE_ALIGNED_MAX
470 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
472 # define ATTR_ALIGN(align)
475 /* Alignment of critical dynamic data structure
477 * Not all platforms support memalign so we provide a vlc_memalign wrapper
478 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
479 * *pp_orig is the pointer that has to be freed afterwards.
482 #ifdef HAVE_POSIX_MEMALIGN
483 # define vlc_memalign(align,size,pp_orig) \
484 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
488 /* Some systems have memalign() but no declaration for it */
489 void * memalign( size_t align, size_t size );
491 # define vlc_memalign(pp_orig,align,size) \
492 ( *(pp_orig) = memalign( align, size ) )
494 #else /* We don't have any choice but to align manually */
495 # define vlc_memalign(pp_orig,align,size) \
496 (( *(pp_orig) = malloc( size + align - 1 )) \
497 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
498 & (~(unsigned long)(align-1)) ) \
503 /* Stuff defined in src/extras/libc.c */
505 # define strdup vlc_strdup
506 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
507 #elif !defined(__PLUGIN__)
508 # define vlc_strdup NULL
512 # if defined(STRNDUP_IN_GNOME_H) && \
513 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
514 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
515 /* Do nothing: gnome.h defines strndup for us */
517 # define strndup vlc_strndup
518 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
520 #elif !defined(__PLUGIN__)
521 # define vlc_strndup NULL
525 # define atof vlc_atof
526 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
527 #elif !defined(__PLUGIN__)
528 # define vlc_atof NULL
532 # define getenv vlc_getenv
533 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
534 #elif !defined(__PLUGIN__)
535 # define vlc_getenv NULL
538 #ifndef HAVE_STRCASECMP
540 # define strcasecmp stricmp
541 # if !defined(__PLUGIN__)
542 # define vlc_strcasecmp NULL
544 # elif !defined(__PLUGIN__)
545 # define strcasecmp vlc_strcasecmp
546 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
548 #elif !defined(__PLUGIN__)
549 # define vlc_strcasecmp NULL
552 #ifndef HAVE_STRNCASECMP
553 # ifdef HAVE_STRNICMP
554 # define strncasecmp strnicmp
555 # if !defined(__PLUGIN__)
556 # define vlc_strncasecmp NULL
558 # elif !defined(__PLUGIN__)
559 # define strncasecmp vlc_strncasecmp
560 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
562 #elif !defined(__PLUGIN__)
563 # define vlc_strncasecmp NULL
566 /* Format type specifiers for 64 bits numbers */
567 #if !defined(WIN32) && !defined(UNDER_CE)
568 # define I64Fd "%lld"
569 # define I64Fi "%lli"
570 # define I64Fo "%llo"
571 # define I64Fu "%llu"
572 # define I64Fx "%llx"
573 # define I64FX "%llX"
575 # define I64Fd "%I64d"
576 # define I64Fi "%I64i"
577 # define I64Fo "%I64o"
578 # define I64Fu "%I64u"
579 # define I64Fx "%I64x"
580 # define I64FX "%I64X"
581 #endif /* defined(WIN32)||defined(UNDER_CE) */
583 /* 64 bits integer constant suffix */
584 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
585 # define I64C(x) x##LL
587 # define I64C(x) x##i64
588 #endif /* defined(WIN32)||defined(UNDER_CE) */
590 #if defined(WIN32) || defined(UNDER_CE)
591 /* win32, cl and icl support */
592 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
593 # define __attribute__(x)
594 # define __inline__ __inline
595 # define S_IFBLK 0x3000 /* Block */
596 # define S_ISBLK(m) (0)
597 # define S_ISCHR(m) (0)
598 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
599 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
602 /* several type definitions */
603 # if defined( __MINGW32__ )
604 # if !defined( _OFF_T_ )
605 typedef long long _off_t;
606 typedef _off_t off_t;
612 # define off_t long long
616 # if defined( _MSC_VER )
617 # if !defined( _OFF_T_DEFINED )
618 typedef __int64 off_t;
619 # define _OFF_T_DEFINED
621 # define off_t __int64
625 # if defined( __BORLANDC__ )
627 # define off_t unsigned __int64
631 # define O_NONBLOCK 0
635 # define alloca _alloca
638 /* These two are not defined in mingw32 (bug?) */
640 # define snprintf _snprintf
643 # define vsnprintf _vsnprintf
648 /* lseek (defined in src/extras/libc.c) */
650 # define lseek vlc_lseek
651 VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
652 #elif !defined(__PLUGIN__)
653 # define vlc_lseek NULL
656 /*****************************************************************************
658 *****************************************************************************/
659 #define CPU_CAPABILITY_NONE 0
660 #define CPU_CAPABILITY_486 (1<<0)
661 #define CPU_CAPABILITY_586 (1<<1)
662 #define CPU_CAPABILITY_PPRO (1<<2)
663 #define CPU_CAPABILITY_MMX (1<<3)
664 #define CPU_CAPABILITY_3DNOW (1<<4)
665 #define CPU_CAPABILITY_MMXEXT (1<<5)
666 #define CPU_CAPABILITY_SSE (1<<6)
667 #define CPU_CAPABILITY_ALTIVEC (1<<16)
668 #define CPU_CAPABILITY_FPU (1<<31)
670 /*****************************************************************************
672 *****************************************************************************/
673 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
675 #if defined( ENABLE_NLS ) && \
676 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
677 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
678 /* Declare nothing: gnome.h will do it for us */
679 #elif defined( ENABLE_NLS )
680 #if defined( HAVE_INCLUDED_GETTEXT )
681 # include "libintl.h"
683 # include <libintl.h>
686 #if defined( __BORLANDC__ )
687 #define _(String) vlc_dgettext (PACKAGE_TARNAME, String)
689 # define _(String) vlc_dgettext (PACKAGE, String)
691 # define N_(String) ((char*)(String))
693 # define _(String) ((char*)(String))
694 # define N_(String) ((char*)(String))
697 /*****************************************************************************
698 * Additional vlc stuff
699 *****************************************************************************/
700 #include "vlc_symbols.h"
701 #include "os_specific.h"
702 #include "vlc_messages.h"
703 #include "variables.h"
704 #include "vlc_objects.h"
705 #include "vlc_threads_funcs.h"
709 #include "configuration.h"
711 #if defined( __BORLANDC__ )