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.36 2002/11/10 23:41:53 sam 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
41 #include "vlc_config.h"
42 #include "modules_inner.h"
44 /*****************************************************************************
45 * Required system headers
46 *****************************************************************************/
48 # include <string.h> /* strerror() */
51 #ifdef HAVE_SYS_TYPES_H
52 # include <sys/types.h>
55 /*****************************************************************************
56 * Basic types definitions
57 *****************************************************************************/
58 #if defined( HAVE_STDINT_H )
60 #elif defined( HAVE_INTTYPES_H )
61 # include <inttypes.h>
62 #elif defined( SYS_CYGWIN )
63 # include <sys/types.h>
64 /* Cygwin only defines half of these... */
65 typedef u_int8_t uint8_t;
66 typedef u_int16_t uint16_t;
67 typedef u_int32_t uint32_t;
68 typedef u_int64_t uint64_t;
70 /* Fallback types (very x86-centric, sorry) */
71 typedef unsigned char uint8_t;
72 typedef signed char int8_t;
73 typedef unsigned short uint16_t;
74 typedef signed short int16_t;
75 typedef unsigned int uint32_t;
76 typedef signed int int32_t;
77 # if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
78 typedef unsigned __int64 uint64_t;
79 typedef signed __int64 int64_t;
81 typedef unsigned long long uint64_t;
82 typedef signed long long int64_t;
86 typedef uint8_t byte_t;
88 /* ptrdiff_t definition */
95 /* Not portable in a 64-bit environment. */
96 typedef int ptrdiff_t;
104 /* Counter for statistics and profiling */
105 typedef unsigned long count_t;
107 /* DCT elements types */
108 typedef int16_t dctelem_t;
110 /* Video buffer types */
111 typedef uint8_t yuv_data_t;
114 typedef uint16_t audio_volume_t;
116 /*****************************************************************************
117 * Old types definitions
118 *****************************************************************************
119 * We still provide these types because most of the VLC code uses them
120 * instead of the C9x types. They should be removed when the transition is
121 * complete (probably in 10 years).
122 *****************************************************************************/
125 typedef uint16_t u16;
127 typedef uint32_t u32;
129 typedef uint64_t u64;
132 /*****************************************************************************
133 * mtime_t: high precision date or time interval
134 *****************************************************************************
135 * Store a high precision date or time interval. The maximum precision is the
136 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
137 * time interval is then 292271 years, which should be long enough for any
138 * video). Dates are stored as microseconds since a common date (usually the
139 * epoch). Note that date and time intervals can be manipulated using regular
140 * arithmetic operators, and that no special functions are required.
141 *****************************************************************************/
142 typedef int64_t mtime_t;
144 /*****************************************************************************
145 * The vlc_fourcc_t type.
146 *****************************************************************************
147 * See http://www.webartz.com/fourcc/ for a very detailed list.
148 *****************************************************************************/
149 typedef uint32_t vlc_fourcc_t;
151 #ifdef WORDS_BIGENDIAN
152 # define VLC_FOURCC( a, b, c, d ) \
153 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
154 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
155 # define VLC_TWOCC( a, b ) \
156 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
159 # define VLC_FOURCC( a, b, c, d ) \
160 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
161 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
162 # define VLC_TWOCC( a, b ) \
163 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
167 /*****************************************************************************
168 * Classes declaration
169 *****************************************************************************/
172 typedef struct libvlc_t libvlc_t;
173 typedef struct vlc_t vlc_t;
174 typedef struct vlc_list_t vlc_list_t;
175 typedef struct vlc_object_t vlc_object_t;
176 typedef struct variable_t variable_t;
179 typedef struct msg_bank_t msg_bank_t;
180 typedef struct msg_subscription_t msg_subscription_t;
183 typedef struct playlist_t playlist_t;
184 typedef struct playlist_item_t playlist_item_t;
187 typedef struct module_bank_t module_bank_t;
188 typedef struct module_t module_t;
189 typedef struct module_config_t module_config_t;
190 typedef struct module_symbols_t module_symbols_t;
193 typedef struct intf_thread_t intf_thread_t;
194 typedef struct intf_sys_t intf_sys_t;
195 typedef struct intf_console_t intf_console_t;
196 typedef struct intf_msg_t intf_msg_t;
197 typedef struct intf_channel_t intf_channel_t;
200 typedef struct input_thread_t input_thread_t;
201 typedef struct input_channel_t input_channel_t;
202 typedef struct input_area_t input_area_t;
203 typedef struct input_buffers_t input_buffers_t;
204 typedef struct input_socket_t input_socket_t;
205 typedef struct input_info_t input_info_t;
206 typedef struct input_info_category_t input_info_category_t;
207 typedef struct access_sys_t access_sys_t;
208 typedef struct demux_sys_t demux_sys_t;
209 typedef struct es_descriptor_t es_descriptor_t;
210 typedef struct es_sys_t es_sys_t;
211 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
212 typedef struct pgrm_sys_t pgrm_sys_t;
213 typedef struct stream_descriptor_t stream_descriptor_t;
214 typedef struct stream_sys_t stream_sys_t;
217 typedef struct aout_instance_t aout_instance_t;
218 typedef struct aout_sys_t aout_sys_t;
219 typedef struct aout_fifo_t aout_fifo_t;
220 typedef struct aout_input_t aout_input_t;
221 typedef struct aout_buffer_t aout_buffer_t;
222 typedef struct audio_sample_format_t audio_sample_format_t;
223 typedef struct audio_date_t audio_date_t;
226 typedef struct vout_thread_t vout_thread_t;
227 typedef struct vout_font_t vout_font_t;
228 typedef struct vout_sys_t vout_sys_t;
229 typedef struct chroma_sys_t chroma_sys_t;
230 typedef struct picture_t picture_t;
231 typedef struct picture_sys_t picture_sys_t;
232 typedef struct picture_heap_t picture_heap_t;
233 typedef struct subpicture_t subpicture_t;
234 typedef struct subpicture_sys_t subpicture_sys_t;
237 typedef struct sout_instance_t sout_instance_t;
238 typedef struct sout_fifo_t sout_fifo_t;
241 typedef struct decoder_fifo_t decoder_fifo_t;
244 typedef struct data_packet_t data_packet_t;
245 typedef struct data_buffer_t data_buffer_t;
246 typedef struct stream_position_t stream_position_t;
247 typedef struct stream_ctrl_t stream_ctrl_t;
248 typedef struct pes_packet_t pes_packet_t;
249 typedef struct bit_stream_t bit_stream_t;
250 typedef struct network_socket_t network_socket_t;
251 typedef struct iso639_lang_t iso639_lang_t;
253 /*****************************************************************************
255 *****************************************************************************/
256 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
257 char const *, /* variable name */
258 vlc_value_t, /* old value */
259 vlc_value_t, /* new value */
260 void * ); /* callback data */
262 /*****************************************************************************
264 *****************************************************************************/
266 # define VLC_EXPORT( type, name, args ) type name args
268 # define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
269 extern module_symbols_t* p_symbols;
272 /*****************************************************************************
273 * OS-specific headers and thread types
274 *****************************************************************************/
276 # define WIN32_LEAN_AND_MEAN
277 # include <windows.h>
280 #include "vlc_threads.h"
282 /*****************************************************************************
283 * Common structure members
284 *****************************************************************************/
286 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
287 #define VLC_COMMON_MEMBERS \
290 char *psz_object_type; \
291 char *psz_object_name; \
293 /* Thread properties, if any */ \
294 vlc_bool_t b_thread; \
295 vlc_thread_t thread_id; \
297 /* Object access lock */ \
298 vlc_mutex_t object_lock; \
299 vlc_cond_t object_wait; \
301 /* Object properties */ \
302 volatile vlc_bool_t b_error; /* set by the object */ \
303 volatile vlc_bool_t b_die; /* set by the outside */ \
304 volatile vlc_bool_t b_dead; /* set by the object */ \
305 volatile vlc_bool_t b_attached; /* set by the object */ \
307 /* Object variables */ \
308 vlc_mutex_t var_lock; \
310 variable_t * p_vars; \
312 /* Stuff related to the libvlc structure */ \
313 libvlc_t * p_libvlc; /* root of all evil */ \
314 vlc_t * p_vlc; /* (root of all evil) - 1 */ \
316 volatile int i_refcount; /* usage count */ \
317 vlc_object_t * p_parent; /* our parent */ \
318 vlc_object_t ** pp_children; /* our children */ \
319 volatile int i_children; \
324 /* Just a reminder so that people don't cast garbage */ \
325 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
327 /* VLC_OBJECT: attempt at doing a clever cast */
328 #define VLC_OBJECT( x ) \
329 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
331 /*****************************************************************************
332 * Macros and inline functions
333 *****************************************************************************/
334 #ifdef NTOHL_IN_SYS_PARAM_H
335 # include <sys/param.h>
337 #elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
338 # include <netinet/in.h>
340 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
342 /* CEIL: division with round to nearest greater integer */
343 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
345 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
346 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
348 /* __MAX and __MIN: self explanatory */
350 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
353 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
356 /* Dynamic array handling: realloc array, move data, increment position */
357 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
362 (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
366 (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
368 memmove( (p_ar) + (i_pos) + 1, \
370 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
371 (p_ar)[i_pos] = elem; \
376 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
379 memmove( (p_ar) + (i_pos), \
380 (p_ar) + (i_pos) + 1, \
381 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
382 if( i_oldsize > 1 ) \
384 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
396 /* MSB (big endian)/LSB (little endian) conversions - network order is always
397 * MSB, and should be used for both network communications and files. Note that
398 * byte orders other than little and big endians are not supported, but only
399 * the VAX seems to have such exotic properties. */
400 static inline uint16_t U16_AT( void * _p )
402 uint8_t * p = (uint8_t *)_p;
403 return ( ((uint16_t)p[0] << 8) | p[1] );
405 static inline uint32_t U32_AT( void * _p )
407 uint8_t * p = (uint8_t *)_p;
408 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
409 | ((uint32_t)p[2] << 8) | p[3] );
411 static inline uint64_t U64_AT( void * _p )
413 uint8_t * p = (uint8_t *)_p;
414 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
415 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
416 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
417 | ((uint64_t)p[6] << 8) | p[7] );
420 # define hton16(i) ( i )
421 # define hton32(i) ( i )
422 # define hton64(i) ( i )
423 # define ntoh16(i) ( i )
424 # define ntoh32(i) ( i )
425 # define ntoh64(i) ( i )
427 # define hton16(i) U16_AT(&i)
428 # define hton32(i) U32_AT(&i)
429 # define hton64(i) U64_AT(&i)
430 # define ntoh16(i) U16_AT(&i)
431 # define ntoh32(i) U32_AT(&i)
432 # define ntoh64(i) U64_AT(&i)
435 /* Alignment of critical static data structures */
436 #ifdef ATTRIBUTE_ALIGNED_MAX
437 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
439 # define ATTR_ALIGN(align)
442 /* Alignment of critical dynamic data structure
444 * Not all platforms support memalign so we provide a vlc_memalign wrapper
445 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
446 * *pp_orig is the pointer that has to be freed afterwards.
449 #ifdef HAVE_POSIX_MEMALIGN
450 # define vlc_memalign(align,size,pp_orig) \
451 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
455 /* Some systems have memalign() but no declaration for it */
456 void * memalign( size_t align, size_t size );
458 # define vlc_memalign(pp_orig,align,size) \
459 ( *(pp_orig) = memalign( align, size ) )
461 #else /* We don't have any choice but to align manually */
462 # define vlc_memalign(pp_orig,align,size) \
463 (( *(pp_orig) = malloc( size + align - 1 )) \
464 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
465 & (~(unsigned long)(align-1)) ) \
470 /* strdup/strndup (defined in src/extras/libc.c) */
472 char * strdup( const char *s );
475 char * strndup( const char *s, size_t n );
478 /* atof (defined in src/extras/libc.c) */
480 double atof( const char *nptr );
483 /* getenv - always returns NULL */
485 char *getenv( const char *name );
488 /* strncasecmp/strcasecmp (defined in src/extras/libc.c) */
489 #ifndef HAVE_STRCASECMP
491 # define strcasecmp stricmp
493 int strcasecmp( const char *s1, const char *s2 );
497 #ifndef HAVE_STRNCASECMP
498 # ifdef HAVE_STRNICMP
499 # define strncasecmp strnicmp
501 int strncasecmp( const char *s1, const char *s2, size_t n );
505 /* Format type specifiers for 64 bits numbers */
507 # define I64Fd "%lld"
508 # define I64Fi "%lli"
509 # define I64Fo "%llo"
510 # define I64Fu "%llu"
511 # define I64Fx "%llx"
512 # define I64FX "%llX"
514 # define I64Fd "%I64d"
515 # define I64Fi "%I64i"
516 # define I64Fo "%I64o"
517 # define I64Fu "%I64u"
518 # define I64Fx "%I64x"
519 # define I64FX "%I64X"
520 #endif /* defined(WIN32) */
522 /* 64 bits integer constant suffix */
524 # define I64C(x) x##LL
526 # define I64C(x) x##i64
527 #endif /* defined(WIN32) */
530 /* win32, cl and icl support */
531 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
532 # define __attribute__(x)
533 # define __inline__ __inline
534 # define S_IFBLK 0x3000 /* Block */
535 # define S_ISBLK(m) (0)
536 # define S_ISCHR(m) (0)
537 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
538 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
541 /* several type definitions */
542 # if defined( __MINGW32__ )
543 # if !defined( _OFF_T_ )
544 typedef long long _off_t;
545 typedef _off_t off_t;
548 # define off_t long long
552 # if defined( _MSC_VER )
553 # if !defined( _OFF_T_DEFINED )
554 typedef __int64 off_t;
555 # define _OFF_T_DEFINED
557 # define off_t __int64
561 # if defined( __BORLANDC__ )
563 # define off_t unsigned __int64
567 # define O_NONBLOCK 0
570 /* These two are not defined in mingw32 (bug?) */
572 # define snprintf _snprintf
575 # define vsnprintf _vsnprintf
580 /* lseek (defined in src/extras/libc.c) */
582 off_t lseek( int fildes, off_t offset, int whence );
585 /*****************************************************************************
587 *****************************************************************************/
588 #define CPU_CAPABILITY_NONE 0
589 #define CPU_CAPABILITY_486 (1<<0)
590 #define CPU_CAPABILITY_586 (1<<1)
591 #define CPU_CAPABILITY_PPRO (1<<2)
592 #define CPU_CAPABILITY_MMX (1<<3)
593 #define CPU_CAPABILITY_3DNOW (1<<4)
594 #define CPU_CAPABILITY_MMXEXT (1<<5)
595 #define CPU_CAPABILITY_SSE (1<<6)
596 #define CPU_CAPABILITY_ALTIVEC (1<<16)
597 #define CPU_CAPABILITY_FPU (1<<31)
599 /*****************************************************************************
601 *****************************************************************************/
602 #if defined( ENABLE_NLS ) \
603 && ( defined(HAVE_GETTEXT) || defined(HAVE_INCLUDED_GETTEXT) )
604 # include <libintl.h>
606 # define _(String) dgettext (PACKAGE, String)
608 # define N_(String) gettext_noop (String)
610 # define N_(String) (String)
612 #elif !defined( NEED_GNOMESUPPORT_H )
613 # define _(String) (String)
614 # define N_(String) (String)
617 /*****************************************************************************
618 * Additional vlc stuff
619 *****************************************************************************/
620 #include "vlc_symbols.h"
621 #include "os_specific.h"
622 #include "vlc_messages.h"
623 #include "variables.h"
624 #include "vlc_objects.h"
625 #include "vlc_threads_funcs.h"
629 #include "configuration.h"
631 #if defined( __BORLANDC__ )