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.56 2003/03/03 16:49:14 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;
104 #if defined( WIN32 ) || defined( UNDER_CE )
108 /* Counter for statistics and profiling */
109 typedef unsigned long count_t;
111 /* DCT elements types */
112 typedef int16_t dctelem_t;
114 /* Video buffer types */
115 typedef uint8_t yuv_data_t;
118 typedef uint16_t audio_volume_t;
120 #ifndef HAVE_SOCKLEN_T
121 typedef int socklen_t;
124 /*****************************************************************************
125 * Old types definitions
126 *****************************************************************************
127 * We still provide these types because most of the VLC code uses them
128 * instead of the C9x types. They should be removed when the transition is
129 * complete (probably in 10 years).
130 *****************************************************************************/
133 typedef uint16_t u16;
135 typedef uint32_t u32;
137 typedef uint64_t u64;
140 /*****************************************************************************
141 * mtime_t: high precision date or time interval
142 *****************************************************************************
143 * Store a high precision date or time interval. The maximum precision is the
144 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
145 * time interval is then 292271 years, which should be long enough for any
146 * video). Dates are stored as microseconds since a common date (usually the
147 * epoch). Note that date and time intervals can be manipulated using regular
148 * arithmetic operators, and that no special functions are required.
149 *****************************************************************************/
150 typedef int64_t mtime_t;
152 /*****************************************************************************
153 * The vlc_fourcc_t type.
154 *****************************************************************************
155 * See http://www.webartz.com/fourcc/ for a very detailed list.
156 *****************************************************************************/
157 typedef uint32_t vlc_fourcc_t;
159 #ifdef WORDS_BIGENDIAN
160 # define VLC_FOURCC( a, b, c, d ) \
161 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
162 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
163 # define VLC_TWOCC( a, b ) \
164 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
167 # define VLC_FOURCC( a, b, c, d ) \
168 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
169 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
170 # define VLC_TWOCC( a, b ) \
171 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
175 /*****************************************************************************
176 * Classes declaration
177 *****************************************************************************/
180 typedef struct libvlc_t libvlc_t;
181 typedef struct vlc_t vlc_t;
182 typedef struct variable_t variable_t;
185 typedef struct msg_bank_t msg_bank_t;
186 typedef struct msg_subscription_t msg_subscription_t;
189 typedef struct playlist_t playlist_t;
190 typedef struct playlist_item_t playlist_item_t;
193 typedef struct module_bank_t module_bank_t;
194 typedef struct module_t module_t;
195 typedef struct module_config_t module_config_t;
196 typedef struct module_symbols_t module_symbols_t;
199 typedef struct intf_thread_t intf_thread_t;
200 typedef struct intf_sys_t intf_sys_t;
201 typedef struct intf_console_t intf_console_t;
202 typedef struct intf_msg_t intf_msg_t;
203 typedef struct intf_channel_t intf_channel_t;
206 typedef struct input_thread_t input_thread_t;
207 typedef struct input_channel_t input_channel_t;
208 typedef struct input_area_t input_area_t;
209 typedef struct input_buffers_t input_buffers_t;
210 typedef struct input_socket_t input_socket_t;
211 typedef struct input_info_t input_info_t;
212 typedef struct input_info_category_t input_info_category_t;
213 typedef struct access_sys_t access_sys_t;
214 typedef struct demux_sys_t demux_sys_t;
215 typedef struct es_descriptor_t es_descriptor_t;
216 typedef struct es_sys_t es_sys_t;
217 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
218 typedef struct pgrm_sys_t pgrm_sys_t;
219 typedef struct stream_descriptor_t stream_descriptor_t;
220 typedef struct stream_sys_t stream_sys_t;
223 typedef struct aout_instance_t aout_instance_t;
224 typedef struct aout_sys_t aout_sys_t;
225 typedef struct aout_fifo_t aout_fifo_t;
226 typedef struct aout_input_t aout_input_t;
227 typedef struct aout_buffer_t aout_buffer_t;
228 typedef struct audio_sample_format_t audio_sample_format_t;
229 typedef struct audio_date_t audio_date_t;
232 typedef struct vout_thread_t vout_thread_t;
233 typedef struct vout_font_t vout_font_t;
234 typedef struct vout_sys_t vout_sys_t;
235 typedef struct chroma_sys_t chroma_sys_t;
236 typedef struct picture_t picture_t;
237 typedef struct picture_sys_t picture_sys_t;
238 typedef struct picture_heap_t picture_heap_t;
239 typedef struct subpicture_t subpicture_t;
240 typedef struct subpicture_sys_t subpicture_sys_t;
243 typedef struct sout_instance_t sout_instance_t;
244 typedef struct sout_fifo_t sout_fifo_t;
245 typedef struct sout_input_t sout_input_t;
246 typedef struct sout_buffer_t sout_buffer_t;
247 typedef struct sout_packet_format_t sout_packet_format_t;
248 typedef struct sout_access_out_t sout_access_out_t;
249 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
252 typedef struct decoder_fifo_t decoder_fifo_t;
255 typedef struct data_packet_t data_packet_t;
256 typedef struct data_buffer_t data_buffer_t;
257 typedef struct stream_position_t stream_position_t;
258 typedef struct stream_ctrl_t stream_ctrl_t;
259 typedef struct pes_packet_t pes_packet_t;
260 typedef struct bit_stream_t bit_stream_t;
261 typedef struct network_socket_t network_socket_t;
262 typedef struct iso639_lang_t iso639_lang_t;
264 /*****************************************************************************
266 *****************************************************************************/
267 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
268 char const *, /* variable name */
269 vlc_value_t, /* old value */
270 vlc_value_t, /* new value */
271 void * ); /* callback data */
273 /*****************************************************************************
275 *****************************************************************************/
277 # define VLC_EXPORT( type, name, args ) type name args
279 # define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
280 extern module_symbols_t* p_symbols;
283 /*****************************************************************************
284 * OS-specific headers and thread types
285 *****************************************************************************/
286 #if defined( WIN32 ) || defined( UNDER_CE )
287 # define WIN32_LEAN_AND_MEAN
288 # include <windows.h>
289 # define IS_WINNT ( GetVersion() < 0x80000000 )
292 #include "vlc_threads.h"
294 /*****************************************************************************
295 * Common structure members
296 *****************************************************************************/
298 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
299 #define VLC_COMMON_MEMBERS \
302 char *psz_object_type; \
303 char *psz_object_name; \
305 /* Thread properties, if any */ \
306 vlc_bool_t b_thread; \
307 vlc_thread_t thread_id; \
309 /* Object access lock */ \
310 vlc_mutex_t object_lock; \
311 vlc_cond_t object_wait; \
313 /* Object properties */ \
314 volatile vlc_bool_t b_error; /* set by the object */ \
315 volatile vlc_bool_t b_die; /* set by the outside */ \
316 volatile vlc_bool_t b_dead; /* set by the object */ \
317 volatile vlc_bool_t b_attached; /* set by the object */ \
319 /* Object variables */ \
320 vlc_mutex_t var_lock; \
322 variable_t * p_vars; \
324 /* Stuff related to the libvlc structure */ \
325 libvlc_t * p_libvlc; /* root of all evil */ \
326 vlc_t * p_vlc; /* (root of all evil) - 1 */ \
328 volatile int i_refcount; /* usage count */ \
329 vlc_object_t * p_parent; /* our parent */ \
330 vlc_object_t ** pp_children; /* our children */ \
331 volatile int i_children; \
336 /* Just a reminder so that people don't cast garbage */ \
337 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
339 /* VLC_OBJECT: attempt at doing a clever cast */
340 #define VLC_OBJECT( x ) \
341 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
343 /*****************************************************************************
344 * Macros and inline functions
345 *****************************************************************************/
346 #ifdef NTOHL_IN_SYS_PARAM_H
347 # include <sys/param.h>
349 #elif !defined(WIN32) && !defined( UNDER_CE )
350 # include <netinet/in.h>
352 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
354 /* CEIL: division with round to nearest greater integer */
355 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
357 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
358 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
360 /* __MAX and __MIN: self explanatory */
362 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
365 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
368 /* Dynamic array handling: realloc array, move data, increment position */
369 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
374 (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
378 (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
380 memmove( (p_ar) + (i_pos) + 1, \
382 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
383 (p_ar)[i_pos] = elem; \
388 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
391 memmove( (p_ar) + (i_pos), \
392 (p_ar) + (i_pos) + 1, \
393 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
394 if( i_oldsize > 1 ) \
396 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
408 /* MSB (big endian)/LSB (little endian) conversions - network order is always
409 * MSB, and should be used for both network communications and files. Note that
410 * byte orders other than little and big endians are not supported, but only
411 * the VAX seems to have such exotic properties. */
412 static inline uint16_t U16_AT( void * _p )
414 uint8_t * p = (uint8_t *)_p;
415 return ( ((uint16_t)p[0] << 8) | p[1] );
417 static inline uint32_t U32_AT( void * _p )
419 uint8_t * p = (uint8_t *)_p;
420 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
421 | ((uint32_t)p[2] << 8) | p[3] );
423 static inline uint64_t U64_AT( void * _p )
425 uint8_t * p = (uint8_t *)_p;
426 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
427 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
428 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
429 | ((uint64_t)p[6] << 8) | p[7] );
432 # define hton16(i) ( i )
433 # define hton32(i) ( i )
434 # define hton64(i) ( i )
435 # define ntoh16(i) ( i )
436 # define ntoh32(i) ( i )
437 # define ntoh64(i) ( i )
439 # define hton16(i) U16_AT(&i)
440 # define hton32(i) U32_AT(&i)
441 # define hton64(i) U64_AT(&i)
442 # define ntoh16(i) U16_AT(&i)
443 # define ntoh32(i) U32_AT(&i)
444 # define ntoh64(i) U64_AT(&i)
447 /* Format string sanity checks */
448 #ifdef HAVE_ATTRIBUTE_FORMAT
449 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
451 # define ATTRIBUTE_FORMAT(x,y)
454 /* Alignment of critical static data structures */
455 #ifdef ATTRIBUTE_ALIGNED_MAX
456 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
458 # define ATTR_ALIGN(align)
461 /* Alignment of critical dynamic data structure
463 * Not all platforms support memalign so we provide a vlc_memalign wrapper
464 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
465 * *pp_orig is the pointer that has to be freed afterwards.
468 #ifdef HAVE_POSIX_MEMALIGN
469 # define vlc_memalign(align,size,pp_orig) \
470 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
474 /* Some systems have memalign() but no declaration for it */
475 void * memalign( size_t align, size_t size );
477 # define vlc_memalign(pp_orig,align,size) \
478 ( *(pp_orig) = memalign( align, size ) )
480 #else /* We don't have any choice but to align manually */
481 # define vlc_memalign(pp_orig,align,size) \
482 (( *(pp_orig) = malloc( size + align - 1 )) \
483 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
484 & (~(unsigned long)(align-1)) ) \
489 /* Stuff defined in src/extras/libc.c */
491 # define strdup vlc_strdup
492 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
493 #elif !defined(__PLUGIN__)
494 # define vlc_strdup NULL
498 # if defined(STRNDUP_IN_GNOME_H) && \
499 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main))
500 /* Do nothing: gnome.h defines strndup for us */
502 # define strndup vlc_strndup
503 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
505 #elif !defined(__PLUGIN__)
506 # define vlc_strndup NULL
510 # define atof vlc_atof
511 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
512 #elif !defined(__PLUGIN__)
513 # define vlc_atof NULL
517 # define getenv vlc_getenv
518 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
519 #elif !defined(__PLUGIN__)
520 # define vlc_getenv NULL
523 #ifndef HAVE_STRCASECMP
525 # define strcasecmp stricmp
526 # define vlc_strcasecmp NULL
527 # elif !defined(__PLUGIN__)
528 # define strcasecmp vlc_strcasecmp
529 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
531 #elif !defined(__PLUGIN__)
532 # define vlc_strcasecmp NULL
535 #ifndef HAVE_STRNCASECMP
536 # ifdef HAVE_STRNICMP
537 # define strncasecmp strnicmp
538 # define vlc_strncasecmp NULL
539 # elif !defined(__PLUGIN__)
540 # define strncasecmp vlc_strncasecmp
541 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
543 #elif !defined(__PLUGIN__)
544 # define vlc_strncasecmp NULL
547 VLC_EXPORT( char *, vlc_wraptext, ( char *psz_text, size_t i_line ) );
549 /* Format type specifiers for 64 bits numbers */
550 #if !defined(WIN32) && !defined(UNDER_CE)
551 # define I64Fd "%lld"
552 # define I64Fi "%lli"
553 # define I64Fo "%llo"
554 # define I64Fu "%llu"
555 # define I64Fx "%llx"
556 # define I64FX "%llX"
558 # define I64Fd "%I64d"
559 # define I64Fi "%I64i"
560 # define I64Fo "%I64o"
561 # define I64Fu "%I64u"
562 # define I64Fx "%I64x"
563 # define I64FX "%I64X"
564 #endif /* defined(WIN32)||defined(UNDER_CE) */
566 /* 64 bits integer constant suffix */
567 #if !defined(WIN32) && !defined(UNDER_CE)
568 # define I64C(x) x##LL
570 # define I64C(x) x##i64
571 #endif /* defined(WIN32)||defined(UNDER_CE) */
573 #if defined(WIN32) || defined(UNDER_CE)
574 /* win32, cl and icl support */
575 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
576 # define __attribute__(x)
577 # define __inline__ __inline
578 # define S_IFBLK 0x3000 /* Block */
579 # define S_ISBLK(m) (0)
580 # define S_ISCHR(m) (0)
581 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
582 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
585 /* several type definitions */
586 # if defined( __MINGW32__ )
587 # if !defined( _OFF_T_ )
588 typedef long long _off_t;
589 typedef _off_t off_t;
595 # define off_t long long
599 # if defined( _MSC_VER )
600 # if !defined( _OFF_T_DEFINED )
601 typedef __int64 off_t;
602 # define _OFF_T_DEFINED
604 # define off_t __int64
608 # if defined( __BORLANDC__ )
610 # define off_t unsigned __int64
615 # define lseek _lseeki64
619 # define O_NONBLOCK 0
623 # define alloca _alloca
626 /* These two are not defined in mingw32 (bug?) */
628 # define snprintf _snprintf
631 # define vsnprintf _vsnprintf
636 /* lseek (defined in src/extras/libc.c) */
638 # define lseek vlc_lseek
639 VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
640 #elif !defined(__PLUGIN__)
641 # define vlc_lseek NULL
644 /*****************************************************************************
646 *****************************************************************************/
647 #define CPU_CAPABILITY_NONE 0
648 #define CPU_CAPABILITY_486 (1<<0)
649 #define CPU_CAPABILITY_586 (1<<1)
650 #define CPU_CAPABILITY_PPRO (1<<2)
651 #define CPU_CAPABILITY_MMX (1<<3)
652 #define CPU_CAPABILITY_3DNOW (1<<4)
653 #define CPU_CAPABILITY_MMXEXT (1<<5)
654 #define CPU_CAPABILITY_SSE (1<<6)
655 #define CPU_CAPABILITY_ALTIVEC (1<<16)
656 #define CPU_CAPABILITY_FPU (1<<31)
658 /*****************************************************************************
660 *****************************************************************************/
661 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
663 #if defined( ENABLE_NLS ) && \
664 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main))
665 /* Declare nothing: gnome.h will do it for us */
666 #elif defined( ENABLE_NLS ) && defined( HAVE_INCLUDED_GETTEXT )
667 # include "libintl.h"
669 #if defined( __BORLANDC__ )
670 #define _(String) vlc_dgettext (PACKAGE_TARNAME, String)
672 # define _(String) vlc_dgettext (PACKAGE, String)
674 # define N_(String) ((char*)(String))
675 #elif defined( ENABLE_NLS ) && defined( HAVE_GETTEXT )
676 # include <libintl.h>
678 # define _(String) dgettext (PACKAGE, String)
679 # define N_(String) ((char*)(String))
681 # define _(String) ((char*)(String))
682 # define N_(String) ((char*)(String))
685 /*****************************************************************************
686 * Additional vlc stuff
687 *****************************************************************************/
688 #include "vlc_symbols.h"
689 #include "os_specific.h"
690 #include "vlc_messages.h"
691 #include "variables.h"
692 #include "vlc_objects.h"
693 #include "vlc_threads_funcs.h"
697 #include "configuration.h"
699 #if defined( __BORLANDC__ )