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.72 2003/08/14 11:47:32 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 *****************************************************************************/
52 # include <string.h> /* strerror() */
55 #ifdef HAVE_SYS_TYPES_H
56 # include <sys/types.h>
59 /*****************************************************************************
60 * Basic types definitions
61 *****************************************************************************/
62 #if defined( HAVE_STDINT_H )
64 #elif defined( HAVE_INTTYPES_H )
65 # include <inttypes.h>
66 #elif defined( SYS_CYGWIN )
67 # include <sys/types.h>
68 /* Cygwin only defines half of these... */
69 typedef u_int8_t uint8_t;
70 typedef u_int16_t uint16_t;
71 typedef u_int32_t uint32_t;
72 typedef u_int64_t uint64_t;
74 /* Fallback types (very x86-centric, sorry) */
75 typedef unsigned char uint8_t;
76 typedef signed char int8_t;
77 typedef unsigned short uint16_t;
78 typedef signed short int16_t;
79 typedef unsigned int uint32_t;
80 typedef signed int int32_t;
81 # if defined( _MSC_VER ) \
82 || defined( UNDER_CE ) \
83 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
84 typedef unsigned __int64 uint64_t;
85 typedef signed __int64 int64_t;
87 typedef unsigned long long uint64_t;
88 typedef signed long long int64_t;
92 typedef uint8_t byte_t;
94 /* ptrdiff_t definition */
101 /* Not portable in a 64-bit environment. */
102 typedef int ptrdiff_t;
108 #define PATH_MAX MAX_PATH
111 #if defined( WIN32 ) || defined( UNDER_CE )
115 /* Counter for statistics and profiling */
116 typedef unsigned long count_t;
118 /* DCT elements types */
119 typedef int16_t dctelem_t;
121 /* Video buffer types */
122 typedef uint8_t yuv_data_t;
125 typedef uint16_t audio_volume_t;
127 #ifndef HAVE_SOCKLEN_T
128 typedef int socklen_t;
131 /*****************************************************************************
132 * Old types definitions
133 *****************************************************************************
134 * We still provide these types because most of the VLC code uses them
135 * instead of the C9x types. They should be removed when the transition is
136 * complete (probably in 10 years).
137 *****************************************************************************/
140 typedef uint16_t u16;
142 typedef uint32_t u32;
144 typedef uint64_t u64;
147 /*****************************************************************************
148 * mtime_t: high precision date or time interval
149 *****************************************************************************
150 * Store a high precision date or time interval. The maximum precision is the
151 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
152 * time interval is then 292271 years, which should be long enough for any
153 * video). Dates are stored as microseconds since a common date (usually the
154 * epoch). Note that date and time intervals can be manipulated using regular
155 * arithmetic operators, and that no special functions are required.
156 *****************************************************************************/
157 typedef int64_t mtime_t;
159 /*****************************************************************************
160 * The vlc_fourcc_t type.
161 *****************************************************************************
162 * See http://www.webartz.com/fourcc/ for a very detailed list.
163 *****************************************************************************/
164 typedef uint32_t vlc_fourcc_t;
166 #ifdef WORDS_BIGENDIAN
167 # define VLC_FOURCC( a, b, c, d ) \
168 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
169 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
170 # define VLC_TWOCC( a, b ) \
171 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
174 # define VLC_FOURCC( a, b, c, d ) \
175 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
176 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
177 # define VLC_TWOCC( a, b ) \
178 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
182 /*****************************************************************************
183 * Classes declaration
184 *****************************************************************************/
187 typedef struct libvlc_t libvlc_t;
188 typedef struct vlc_t vlc_t;
189 typedef struct variable_t variable_t;
192 typedef struct msg_bank_t msg_bank_t;
193 typedef struct msg_subscription_t msg_subscription_t;
196 typedef struct playlist_t playlist_t;
197 typedef struct playlist_item_t playlist_item_t;
200 typedef struct module_bank_t module_bank_t;
201 typedef struct module_t module_t;
202 typedef struct module_config_t module_config_t;
203 typedef struct module_symbols_t module_symbols_t;
206 typedef struct intf_thread_t intf_thread_t;
207 typedef struct intf_sys_t intf_sys_t;
208 typedef struct intf_console_t intf_console_t;
209 typedef struct intf_msg_t intf_msg_t;
210 typedef struct intf_channel_t intf_channel_t;
213 typedef struct input_thread_t input_thread_t;
214 typedef struct input_channel_t input_channel_t;
215 typedef struct input_area_t input_area_t;
216 typedef struct input_buffers_t input_buffers_t;
217 typedef struct input_socket_t input_socket_t;
218 typedef struct input_info_t input_info_t;
219 typedef struct input_info_category_t input_info_category_t;
220 typedef struct access_sys_t access_sys_t;
221 typedef struct demux_sys_t demux_sys_t;
222 typedef struct es_descriptor_t es_descriptor_t;
223 typedef struct es_sys_t es_sys_t;
224 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
225 typedef struct pgrm_sys_t pgrm_sys_t;
226 typedef struct stream_descriptor_t stream_descriptor_t;
227 typedef struct stream_sys_t stream_sys_t;
230 typedef struct stream_t stream_t;
233 typedef struct aout_instance_t aout_instance_t;
234 typedef struct aout_sys_t aout_sys_t;
235 typedef struct aout_fifo_t aout_fifo_t;
236 typedef struct aout_input_t aout_input_t;
237 typedef struct aout_buffer_t aout_buffer_t;
238 typedef struct audio_sample_format_t audio_sample_format_t;
239 typedef struct audio_date_t audio_date_t;
242 typedef struct vout_thread_t vout_thread_t;
243 typedef struct vout_font_t vout_font_t;
244 typedef struct vout_sys_t vout_sys_t;
245 typedef struct chroma_sys_t chroma_sys_t;
246 typedef struct picture_t picture_t;
247 typedef struct picture_sys_t picture_sys_t;
248 typedef struct picture_heap_t picture_heap_t;
249 typedef struct subpicture_t subpicture_t;
250 typedef struct subpicture_sys_t subpicture_sys_t;
251 typedef struct vout_synchro_t vout_synchro_t;
252 typedef struct text_renderer_sys_t text_renderer_sys_t;
253 typedef struct text_style_t text_style_t;
256 typedef struct sout_instance_t sout_instance_t;
257 typedef struct sout_fifo_t sout_fifo_t;
258 typedef struct sout_input_t sout_input_t;
259 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
260 typedef struct sout_buffer_t sout_buffer_t;
261 typedef struct sout_access_out_t sout_access_out_t;
262 typedef struct sout_mux_t sout_mux_t;
263 typedef struct sout_stream_t sout_stream_t;
264 typedef struct sout_cfg_t sout_cfg_t;
265 typedef struct sout_format_t sout_format_t;
266 typedef struct sap_session_t sap_session_t;
267 typedef struct slp_session_t slp_session_t;
270 typedef struct decoder_fifo_t decoder_fifo_t;
273 typedef struct data_packet_t data_packet_t;
274 typedef struct data_buffer_t data_buffer_t;
275 typedef struct stream_position_t stream_position_t;
276 typedef struct stream_ctrl_t stream_ctrl_t;
277 typedef struct pes_packet_t pes_packet_t;
278 typedef struct bit_stream_t bit_stream_t;
279 typedef struct network_socket_t network_socket_t;
280 typedef struct iso639_lang_t iso639_lang_t;
282 /*****************************************************************************
284 *****************************************************************************/
285 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
286 char const *, /* variable name */
287 vlc_value_t, /* old value */
288 vlc_value_t, /* new value */
289 void * ); /* callback data */
291 /*****************************************************************************
293 *****************************************************************************/
295 # define VLC_EXPORT( type, name, args ) type name args
297 # define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
298 extern module_symbols_t* p_symbols;
301 /*****************************************************************************
302 * OS-specific headers and thread types
303 *****************************************************************************/
304 #if defined( WIN32 ) || defined( UNDER_CE )
305 # define WIN32_LEAN_AND_MEAN
306 # include <windows.h>
307 # define IS_WINNT ( GetVersion() < 0x80000000 )
310 #include "vlc_threads.h"
312 /*****************************************************************************
313 * Common structure members
314 *****************************************************************************/
316 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
317 #define VLC_COMMON_MEMBERS \
318 /** \name VLC_COMMON_MEMBERS \
319 * these members are common for all vlc objects \
324 char *psz_object_type; \
325 char *psz_object_name; \
327 /* Thread properties, if any */ \
328 vlc_bool_t b_thread; \
329 vlc_thread_t thread_id; \
331 /* Object access lock */ \
332 vlc_mutex_t object_lock; \
333 vlc_cond_t object_wait; \
335 /* Object properties */ \
336 volatile vlc_bool_t b_error; /**< set by the object */ \
337 volatile vlc_bool_t b_die; /**< set by the outside */ \
338 volatile vlc_bool_t b_dead; /**< set by the object */ \
339 volatile vlc_bool_t b_attached; /**< set by the object */ \
341 /* Object variables */ \
342 vlc_mutex_t var_lock; \
344 variable_t * p_vars; \
346 /* Stuff related to the libvlc structure */ \
347 libvlc_t * p_libvlc; /**< root of all evil */ \
348 vlc_t * p_vlc; /**< (root of all evil) - 1 */ \
350 volatile int i_refcount; /**< usage count */ \
351 vlc_object_t * p_parent; /**< our parent */ \
352 vlc_object_t ** pp_children; /**< our children */ \
353 volatile int i_children; \
358 /** Just a reminder so that people don't cast garbage */ \
359 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
362 /* VLC_OBJECT: attempt at doing a clever cast */
363 #define VLC_OBJECT( x ) \
364 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
366 /*****************************************************************************
367 * Macros and inline functions
368 *****************************************************************************/
369 #ifdef NTOHL_IN_SYS_PARAM_H
370 # include <sys/param.h>
372 #elif !defined(WIN32) && !defined( UNDER_CE )
373 # include <netinet/in.h>
375 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
377 /* CEIL: division with round to nearest greater integer */
378 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
380 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
381 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
383 /* __MAX and __MIN: self explanatory */
385 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
388 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
391 /* Dynamic array handling: realloc array, move data, increment position */
392 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
397 (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
401 (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
403 if( (i_oldsize) - (i_pos) ) \
405 memmove( (p_ar) + (i_pos) + 1, \
407 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
409 (p_ar)[i_pos] = elem; \
414 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
417 if( (i_oldsize) - (i_pos) - 1 ) \
419 memmove( (p_ar) + (i_pos), \
420 (p_ar) + (i_pos) + 1, \
421 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
423 if( i_oldsize > 1 ) \
425 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
437 /* MSB (big endian)/LSB (little endian) conversions - network order is always
438 * MSB, and should be used for both network communications and files. Note that
439 * byte orders other than little and big endians are not supported, but only
440 * the VAX seems to have such exotic properties. */
441 static inline uint16_t U16_AT( void * _p )
443 uint8_t * p = (uint8_t *)_p;
444 return ( ((uint16_t)p[0] << 8) | p[1] );
446 static inline uint32_t U32_AT( void * _p )
448 uint8_t * p = (uint8_t *)_p;
449 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
450 | ((uint32_t)p[2] << 8) | p[3] );
452 static inline uint64_t U64_AT( void * _p )
454 uint8_t * p = (uint8_t *)_p;
455 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
456 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
457 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
458 | ((uint64_t)p[6] << 8) | p[7] );
461 # define hton16(i) ( i )
462 # define hton32(i) ( i )
463 # define hton64(i) ( i )
464 # define ntoh16(i) ( i )
465 # define ntoh32(i) ( i )
466 # define ntoh64(i) ( i )
468 # define hton16(i) U16_AT(&i)
469 # define hton32(i) U32_AT(&i)
470 # define hton64(i) U64_AT(&i)
471 # define ntoh16(i) U16_AT(&i)
472 # define ntoh32(i) U32_AT(&i)
473 # define ntoh64(i) U64_AT(&i)
476 /* Format string sanity checks */
477 #ifdef HAVE_ATTRIBUTE_FORMAT
478 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
480 # define ATTRIBUTE_FORMAT(x,y)
483 /* Alignment of critical static data structures */
484 #ifdef ATTRIBUTE_ALIGNED_MAX
485 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
487 # define ATTR_ALIGN(align)
490 /* Alignment of critical dynamic data structure
492 * Not all platforms support memalign so we provide a vlc_memalign wrapper
493 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
494 * *pp_orig is the pointer that has to be freed afterwards.
497 #ifdef HAVE_POSIX_MEMALIGN
498 # define vlc_memalign(align,size,pp_orig) \
499 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
503 /* Some systems have memalign() but no declaration for it */
504 void * memalign( size_t align, size_t size );
506 # define vlc_memalign(pp_orig,align,size) \
507 ( *(pp_orig) = memalign( align, size ) )
509 #else /* We don't have any choice but to align manually */
510 # define vlc_memalign(pp_orig,align,size) \
511 (( *(pp_orig) = malloc( size + align - 1 )) \
512 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
513 & (~(unsigned long)(align-1)) ) \
518 /* Stuff defined in src/extras/libc.c */
520 # define strdup vlc_strdup
521 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
522 #elif !defined(__PLUGIN__)
523 # define vlc_strdup NULL
527 # if defined(STRNDUP_IN_GNOME_H) && \
528 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
529 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
530 /* Do nothing: gnome.h defines strndup for us */
532 # define strndup vlc_strndup
533 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
535 #elif !defined(__PLUGIN__)
536 # define vlc_strndup NULL
540 # define atof vlc_atof
541 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
542 #elif !defined(__PLUGIN__)
543 # define vlc_atof NULL
547 # define atoll vlc_atoll
548 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
549 #elif !defined(__PLUGIN__)
550 # define vlc_atoll NULL
554 # define getenv vlc_getenv
555 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
556 #elif !defined(__PLUGIN__)
557 # define vlc_getenv NULL
560 #ifndef HAVE_STRCASECMP
562 # define strcasecmp stricmp
563 # if !defined(__PLUGIN__)
564 # define vlc_strcasecmp NULL
566 # elif !defined(__PLUGIN__)
567 # define strcasecmp vlc_strcasecmp
568 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
570 #elif !defined(__PLUGIN__)
571 # define vlc_strcasecmp NULL
574 #ifndef HAVE_STRNCASECMP
575 # ifdef HAVE_STRNICMP
576 # define strncasecmp strnicmp
577 # if !defined(__PLUGIN__)
578 # define vlc_strncasecmp NULL
580 # elif !defined(__PLUGIN__)
581 # define strncasecmp vlc_strncasecmp
582 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
584 #elif !defined(__PLUGIN__)
585 # define vlc_strncasecmp NULL
588 /* Format type specifiers for 64 bits numbers */
589 #if !defined(WIN32) && !defined(UNDER_CE)
590 # define I64Fd "%lld"
591 # define I64Fi "%lli"
592 # define I64Fo "%llo"
593 # define I64Fu "%llu"
594 # define I64Fx "%llx"
595 # define I64FX "%llX"
597 # define I64Fd "%I64d"
598 # define I64Fi "%I64i"
599 # define I64Fo "%I64o"
600 # define I64Fu "%I64u"
601 # define I64Fx "%I64x"
602 # define I64FX "%I64X"
603 #endif /* defined(WIN32)||defined(UNDER_CE) */
605 /* 64 bits integer constant suffix */
606 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
607 # define I64C(x) x##LL
609 # define I64C(x) x##i64
610 #endif /* defined(WIN32)||defined(UNDER_CE) */
612 #if defined(WIN32) || defined(UNDER_CE)
613 /* win32, cl and icl support */
614 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
615 # define __attribute__(x)
616 # define __inline__ __inline
617 # define S_IFBLK 0x3000 /* Block */
618 # define S_ISBLK(m) (0)
619 # define S_ISCHR(m) (0)
620 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
621 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
624 /* several type definitions */
625 # if defined( __MINGW32__ )
626 # if !defined( _OFF_T_ )
627 typedef long long _off_t;
628 typedef _off_t off_t;
634 # define off_t long long
638 # if defined( _MSC_VER )
639 # if !defined( _OFF_T_DEFINED )
640 typedef __int64 off_t;
641 # define _OFF_T_DEFINED
643 # define off_t __int64
647 # if defined( __BORLANDC__ )
649 # define off_t unsigned __int64
653 # define O_NONBLOCK 0
657 # define alloca _alloca
660 /* These two are not defined in mingw32 (bug?) */
662 # define snprintf _snprintf
665 # define vsnprintf _vsnprintf
670 /* lseek (defined in src/extras/libc.c) */
672 # define lseek vlc_lseek
673 VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
674 #elif !defined(__PLUGIN__)
675 # define vlc_lseek NULL
678 /*****************************************************************************
680 *****************************************************************************/
681 #define CPU_CAPABILITY_NONE 0
682 #define CPU_CAPABILITY_486 (1<<0)
683 #define CPU_CAPABILITY_586 (1<<1)
684 #define CPU_CAPABILITY_PPRO (1<<2)
685 #define CPU_CAPABILITY_MMX (1<<3)
686 #define CPU_CAPABILITY_3DNOW (1<<4)
687 #define CPU_CAPABILITY_MMXEXT (1<<5)
688 #define CPU_CAPABILITY_SSE (1<<6)
689 #define CPU_CAPABILITY_ALTIVEC (1<<16)
690 #define CPU_CAPABILITY_FPU (1<<31)
692 /*****************************************************************************
694 *****************************************************************************/
695 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
697 #if defined( ENABLE_NLS ) && \
698 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
699 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
700 /* Declare nothing: gnome.h will do it for us */
701 #elif defined( ENABLE_NLS )
702 #if defined( HAVE_INCLUDED_GETTEXT )
703 # include "libintl.h"
705 # include <libintl.h>
708 #if defined( __BORLANDC__ )
709 #define _(String) vlc_dgettext (PACKAGE_TARNAME, String)
711 # define _(String) vlc_dgettext (PACKAGE, String)
713 # define N_(String) ((char*)(String))
715 # define _(String) ((char*)(String))
716 # define N_(String) ((char*)(String))
719 /*****************************************************************************
720 * Additional vlc stuff
721 *****************************************************************************/
722 #include "vlc_symbols.h"
723 #include "os_specific.h"
724 #include "vlc_messages.h"
725 #include "variables.h"
726 #include "vlc_objects.h"
727 #include "vlc_threads_funcs.h"
731 #include "configuration.h"
733 #if defined( __BORLANDC__ )