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.40 2002/11/24 18:54:54 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__ )
32 # undef HAVE_INTTYPES_H
37 #if defined( __BORLANDC__ )
38 # undef HAVE_VARIADIC_MACROS
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 /*****************************************************************************
120 * Old types definitions
121 *****************************************************************************
122 * We still provide these types because most of the VLC code uses them
123 * instead of the C9x types. They should be removed when the transition is
124 * complete (probably in 10 years).
125 *****************************************************************************/
128 typedef uint16_t u16;
130 typedef uint32_t u32;
132 typedef uint64_t u64;
135 /*****************************************************************************
136 * mtime_t: high precision date or time interval
137 *****************************************************************************
138 * Store a high precision date or time interval. The maximum precision is the
139 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
140 * time interval is then 292271 years, which should be long enough for any
141 * video). Dates are stored as microseconds since a common date (usually the
142 * epoch). Note that date and time intervals can be manipulated using regular
143 * arithmetic operators, and that no special functions are required.
144 *****************************************************************************/
145 typedef int64_t mtime_t;
147 /*****************************************************************************
148 * The vlc_fourcc_t type.
149 *****************************************************************************
150 * See http://www.webartz.com/fourcc/ for a very detailed list.
151 *****************************************************************************/
152 typedef uint32_t vlc_fourcc_t;
154 #ifdef WORDS_BIGENDIAN
155 # define VLC_FOURCC( a, b, c, d ) \
156 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
157 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
158 # define VLC_TWOCC( a, b ) \
159 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
162 # define VLC_FOURCC( a, b, c, d ) \
163 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
164 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
165 # define VLC_TWOCC( a, b ) \
166 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
170 /*****************************************************************************
171 * Classes declaration
172 *****************************************************************************/
175 typedef struct libvlc_t libvlc_t;
176 typedef struct vlc_t vlc_t;
177 typedef struct vlc_list_t vlc_list_t;
178 typedef struct vlc_object_t vlc_object_t;
179 typedef struct variable_t variable_t;
182 typedef struct msg_bank_t msg_bank_t;
183 typedef struct msg_subscription_t msg_subscription_t;
186 typedef struct playlist_t playlist_t;
187 typedef struct playlist_item_t playlist_item_t;
190 typedef struct module_bank_t module_bank_t;
191 typedef struct module_t module_t;
192 typedef struct module_config_t module_config_t;
193 typedef struct module_symbols_t module_symbols_t;
196 typedef struct intf_thread_t intf_thread_t;
197 typedef struct intf_sys_t intf_sys_t;
198 typedef struct intf_console_t intf_console_t;
199 typedef struct intf_msg_t intf_msg_t;
200 typedef struct intf_channel_t intf_channel_t;
203 typedef struct input_thread_t input_thread_t;
204 typedef struct input_channel_t input_channel_t;
205 typedef struct input_area_t input_area_t;
206 typedef struct input_buffers_t input_buffers_t;
207 typedef struct input_socket_t input_socket_t;
208 typedef struct input_info_t input_info_t;
209 typedef struct input_info_category_t input_info_category_t;
210 typedef struct access_sys_t access_sys_t;
211 typedef struct demux_sys_t demux_sys_t;
212 typedef struct es_descriptor_t es_descriptor_t;
213 typedef struct es_sys_t es_sys_t;
214 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
215 typedef struct pgrm_sys_t pgrm_sys_t;
216 typedef struct stream_descriptor_t stream_descriptor_t;
217 typedef struct stream_sys_t stream_sys_t;
220 typedef struct aout_instance_t aout_instance_t;
221 typedef struct aout_sys_t aout_sys_t;
222 typedef struct aout_fifo_t aout_fifo_t;
223 typedef struct aout_input_t aout_input_t;
224 typedef struct aout_buffer_t aout_buffer_t;
225 typedef struct audio_sample_format_t audio_sample_format_t;
226 typedef struct audio_date_t audio_date_t;
229 typedef struct vout_thread_t vout_thread_t;
230 typedef struct vout_font_t vout_font_t;
231 typedef struct vout_sys_t vout_sys_t;
232 typedef struct chroma_sys_t chroma_sys_t;
233 typedef struct picture_t picture_t;
234 typedef struct picture_sys_t picture_sys_t;
235 typedef struct picture_heap_t picture_heap_t;
236 typedef struct subpicture_t subpicture_t;
237 typedef struct subpicture_sys_t subpicture_sys_t;
240 typedef struct sout_instance_t sout_instance_t;
241 typedef struct sout_fifo_t sout_fifo_t;
244 typedef struct decoder_fifo_t decoder_fifo_t;
247 typedef struct data_packet_t data_packet_t;
248 typedef struct data_buffer_t data_buffer_t;
249 typedef struct stream_position_t stream_position_t;
250 typedef struct stream_ctrl_t stream_ctrl_t;
251 typedef struct pes_packet_t pes_packet_t;
252 typedef struct bit_stream_t bit_stream_t;
253 typedef struct network_socket_t network_socket_t;
254 typedef struct iso639_lang_t iso639_lang_t;
256 /*****************************************************************************
258 *****************************************************************************/
259 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
260 char const *, /* variable name */
261 vlc_value_t, /* old value */
262 vlc_value_t, /* new value */
263 void * ); /* callback data */
265 /*****************************************************************************
267 *****************************************************************************/
269 # define VLC_EXPORT( type, name, args ) type name args
271 # define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
272 extern module_symbols_t* p_symbols;
275 /*****************************************************************************
276 * OS-specific headers and thread types
277 *****************************************************************************/
278 #if defined( WIN32 ) || defined( UNDER_CE )
279 # define WIN32_LEAN_AND_MEAN
280 # include <windows.h>
283 #include "vlc_threads.h"
285 /*****************************************************************************
286 * Common structure members
287 *****************************************************************************/
289 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
290 #define VLC_COMMON_MEMBERS \
293 char *psz_object_type; \
294 char *psz_object_name; \
296 /* Thread properties, if any */ \
297 vlc_bool_t b_thread; \
298 vlc_thread_t thread_id; \
300 /* Object access lock */ \
301 vlc_mutex_t object_lock; \
302 vlc_cond_t object_wait; \
304 /* Object properties */ \
305 volatile vlc_bool_t b_error; /* set by the object */ \
306 volatile vlc_bool_t b_die; /* set by the outside */ \
307 volatile vlc_bool_t b_dead; /* set by the object */ \
308 volatile vlc_bool_t b_attached; /* set by the object */ \
310 /* Object variables */ \
311 vlc_mutex_t var_lock; \
313 variable_t * p_vars; \
315 /* Stuff related to the libvlc structure */ \
316 libvlc_t * p_libvlc; /* root of all evil */ \
317 vlc_t * p_vlc; /* (root of all evil) - 1 */ \
319 volatile int i_refcount; /* usage count */ \
320 vlc_object_t * p_parent; /* our parent */ \
321 vlc_object_t ** pp_children; /* our children */ \
322 volatile int i_children; \
327 /* Just a reminder so that people don't cast garbage */ \
328 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
330 /* VLC_OBJECT: attempt at doing a clever cast */
331 #define VLC_OBJECT( x ) \
332 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
334 /*****************************************************************************
335 * Macros and inline functions
336 *****************************************************************************/
337 #ifdef NTOHL_IN_SYS_PARAM_H
338 # include <sys/param.h>
340 #elif !defined(WIN32) && !defined( UNDER_CE )
341 # include <netinet/in.h>
343 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
345 /* CEIL: division with round to nearest greater integer */
346 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
348 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
349 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
351 /* __MAX and __MIN: self explanatory */
353 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
356 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
359 /* Dynamic array handling: realloc array, move data, increment position */
360 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
365 (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
369 (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
371 memmove( (p_ar) + (i_pos) + 1, \
373 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
374 (p_ar)[i_pos] = elem; \
379 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
382 memmove( (p_ar) + (i_pos), \
383 (p_ar) + (i_pos) + 1, \
384 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
385 if( i_oldsize > 1 ) \
387 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
399 /* MSB (big endian)/LSB (little endian) conversions - network order is always
400 * MSB, and should be used for both network communications and files. Note that
401 * byte orders other than little and big endians are not supported, but only
402 * the VAX seems to have such exotic properties. */
403 static inline uint16_t U16_AT( void * _p )
405 uint8_t * p = (uint8_t *)_p;
406 return ( ((uint16_t)p[0] << 8) | p[1] );
408 static inline uint32_t U32_AT( void * _p )
410 uint8_t * p = (uint8_t *)_p;
411 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
412 | ((uint32_t)p[2] << 8) | p[3] );
414 static inline uint64_t U64_AT( void * _p )
416 uint8_t * p = (uint8_t *)_p;
417 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
418 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
419 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
420 | ((uint64_t)p[6] << 8) | p[7] );
423 # define hton16(i) ( i )
424 # define hton32(i) ( i )
425 # define hton64(i) ( i )
426 # define ntoh16(i) ( i )
427 # define ntoh32(i) ( i )
428 # define ntoh64(i) ( i )
430 # define hton16(i) U16_AT(&i)
431 # define hton32(i) U32_AT(&i)
432 # define hton64(i) U64_AT(&i)
433 # define ntoh16(i) U16_AT(&i)
434 # define ntoh32(i) U32_AT(&i)
435 # define ntoh64(i) U64_AT(&i)
438 /* Alignment of critical static data structures */
439 #ifdef ATTRIBUTE_ALIGNED_MAX
440 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
442 # define ATTR_ALIGN(align)
445 /* Alignment of critical dynamic data structure
447 * Not all platforms support memalign so we provide a vlc_memalign wrapper
448 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
449 * *pp_orig is the pointer that has to be freed afterwards.
452 #ifdef HAVE_POSIX_MEMALIGN
453 # define vlc_memalign(align,size,pp_orig) \
454 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
458 /* Some systems have memalign() but no declaration for it */
459 void * memalign( size_t align, size_t size );
461 # define vlc_memalign(pp_orig,align,size) \
462 ( *(pp_orig) = memalign( align, size ) )
464 #else /* We don't have any choice but to align manually */
465 # define vlc_memalign(pp_orig,align,size) \
466 (( *(pp_orig) = malloc( size + align - 1 )) \
467 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
468 & (~(unsigned long)(align-1)) ) \
473 /* Stuff defined in src/extras/libc.c */
475 # define strdup vlc_strdup
476 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
477 #elif !defined(__PLUGIN__)
478 # define vlc_strdup NULL
482 # define strndup vlc_strndup
483 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
484 #elif !defined(__PLUGIN__)
485 # define vlc_strndup NULL
489 # define atof vlc_atof
490 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
491 #elif !defined(__PLUGIN__)
492 # define vlc_atof NULL
496 # define getenv vlc_getenv
497 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
498 #elif !defined(__PLUGIN__)
499 # define vlc_getenv NULL
502 #ifndef HAVE_STRCASECMP
504 # define strcasecmp stricmp
505 # define vlc_strcasecmp NULL
506 # elif !defined(__PLUGIN__)
507 # define strcasecmp vlc_strcasecmp
508 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
510 #elif !defined(__PLUGIN__)
511 # define vlc_strcasecmp NULL
514 #ifndef HAVE_STRNCASECMP
515 # ifdef HAVE_STRNICMP
516 # define strncasecmp strnicmp
517 # define vlc_strncasecmp NULL
518 # elif !defined(__PLUGIN__)
519 # define strncasecmp vlc_strncasecmp
520 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
522 #elif !defined(__PLUGIN__)
523 # define vlc_strncasecmp NULL
526 /* Format type specifiers for 64 bits numbers */
527 #if !defined(WIN32) && !defined(UNDER_CE)
528 # define I64Fd "%lld"
529 # define I64Fi "%lli"
530 # define I64Fo "%llo"
531 # define I64Fu "%llu"
532 # define I64Fx "%llx"
533 # define I64FX "%llX"
535 # define I64Fd "%I64d"
536 # define I64Fi "%I64i"
537 # define I64Fo "%I64o"
538 # define I64Fu "%I64u"
539 # define I64Fx "%I64x"
540 # define I64FX "%I64X"
541 #endif /* defined(WIN32)||defined(UNDER_CE) */
543 /* 64 bits integer constant suffix */
544 #if !defined(WIN32) && !defined(UNDER_CE)
545 # define I64C(x) x##LL
547 # define I64C(x) x##i64
548 #endif /* defined(WIN32)||defined(UNDER_CE) */
550 #if defined(WIN32) || defined(UNDER_CE)
551 /* win32, cl and icl support */
552 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
553 # define __attribute__(x)
554 # define __inline__ __inline
555 # define S_IFBLK 0x3000 /* Block */
556 # define S_ISBLK(m) (0)
557 # define S_ISCHR(m) (0)
558 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
559 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
562 /* several type definitions */
563 # if defined( __MINGW32__ )
564 # if !defined( _OFF_T_ )
565 typedef long long _off_t;
566 typedef _off_t off_t;
569 # define off_t long long
573 # if defined( _MSC_VER )
574 # if !defined( _OFF_T_DEFINED )
575 typedef __int64 off_t;
576 # define _OFF_T_DEFINED
578 # define off_t __int64
582 # if defined( __BORLANDC__ )
584 # define off_t unsigned __int64
588 # define O_NONBLOCK 0
591 /* These two are not defined in mingw32 (bug?) */
593 # define snprintf _snprintf
596 # define vsnprintf _vsnprintf
601 /* lseek (defined in src/extras/libc.c) */
603 # define lseek vlc_lseek
604 VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
605 #elif !defined(__PLUGIN__)
606 # define vlc_lseek NULL
609 /*****************************************************************************
611 *****************************************************************************/
612 #define CPU_CAPABILITY_NONE 0
613 #define CPU_CAPABILITY_486 (1<<0)
614 #define CPU_CAPABILITY_586 (1<<1)
615 #define CPU_CAPABILITY_PPRO (1<<2)
616 #define CPU_CAPABILITY_MMX (1<<3)
617 #define CPU_CAPABILITY_3DNOW (1<<4)
618 #define CPU_CAPABILITY_MMXEXT (1<<5)
619 #define CPU_CAPABILITY_SSE (1<<6)
620 #define CPU_CAPABILITY_ALTIVEC (1<<16)
621 #define CPU_CAPABILITY_FPU (1<<31)
623 /*****************************************************************************
625 *****************************************************************************/
626 #if defined( ENABLE_NLS ) \
627 && ( defined(HAVE_GETTEXT) || defined(HAVE_INCLUDED_GETTEXT) )
628 # include <libintl.h>
630 # define _(String) dgettext (PACKAGE, String)
632 # define N_(String) gettext_noop (String)
634 # define N_(String) (String)
636 #elif !defined( NEED_GNOMESUPPORT_H )
637 # define _(String) (String)
638 # define N_(String) (String)
641 /*****************************************************************************
642 * Additional vlc stuff
643 *****************************************************************************/
644 #include "vlc_symbols.h"
645 #include "os_specific.h"
646 #include "vlc_messages.h"
647 #include "variables.h"
648 #include "vlc_objects.h"
649 #include "vlc_threads_funcs.h"
653 #include "configuration.h"
655 #if defined( __BORLANDC__ )