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.19 2002/08/12 22:12:50 massiot 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 * Compiler-specific workarounds
29 *****************************************************************************/
30 #if defined( __BORLANDC__ )
31 # undef HAVE_VARIADIC_MACROS
35 /*****************************************************************************
36 * Required system headers
37 *****************************************************************************/
39 # include <string.h> /* strerror() */
42 #ifdef HAVE_SYS_TYPES_H
43 # include <sys/types.h>
46 /*****************************************************************************
47 * Basic types definitions
48 *****************************************************************************/
63 typedef unsigned char u8;
64 typedef signed char s8;
66 typedef unsigned short u16;
67 typedef signed short s16;
69 typedef unsigned int u32;
70 typedef signed int s32;
72 # if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
73 typedef unsigned __int64 u64;
74 typedef signed __int64 s64;
76 typedef unsigned long long u64;
77 typedef signed long long s64;
83 /* ptrdiff_t definition */
90 /* Not portable in a 64-bit environment. */
91 typedef int ptrdiff_t;
99 /* Counter for statistics and profiling */
100 typedef unsigned long count_t;
102 /* DCT elements types */
103 typedef s16 dctelem_t;
105 /* Video buffer types */
106 typedef u8 yuv_data_t;
108 /*****************************************************************************
109 * mtime_t: high precision date or time interval
110 *****************************************************************************
111 * Store an high precision date or time interval. The maximum precision is the
112 * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
113 * time interval is then 292271 years, which should be long enough for any
114 * video). Date are stored as a time interval since a common date.
115 * Note that date and time intervals can be manipulated using regular
116 * arithmetic operators, and that no special functions are required.
117 *****************************************************************************/
120 /*****************************************************************************
121 * The vlc_fourcc_t type.
122 *****************************************************************************
123 * See http://www.webartz.com/fourcc/ for a very detailed list.
124 *****************************************************************************/
125 typedef u32 vlc_fourcc_t;
127 #define VLC_FOURCC( a, b, c, d ) \
128 ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )
130 #define VLC_TWOCC( a, b ) \
131 ( (u16)(a) | ( (u16)(b) << 8 ) )
133 /*****************************************************************************
134 * Classes declaration
135 *****************************************************************************/
138 typedef struct msg_bank_t msg_bank_t;
139 typedef struct msg_subscription_t msg_subscription_t;
142 typedef struct playlist_t playlist_t;
143 typedef struct playlist_item_t playlist_item_t;
146 typedef struct module_bank_t module_bank_t;
147 typedef struct module_t module_t;
148 typedef struct module_config_t module_config_t;
149 typedef struct module_symbols_t module_symbols_t;
152 typedef struct intf_thread_t intf_thread_t;
153 typedef struct intf_sys_t intf_sys_t;
154 typedef struct intf_console_t intf_console_t;
155 typedef struct intf_msg_t intf_msg_t;
156 typedef struct intf_channel_t intf_channel_t;
159 typedef struct input_thread_t input_thread_t;
160 typedef struct input_channel_t input_channel_t;
161 typedef struct input_area_t input_area_t;
162 typedef struct input_buffers_t input_buffers_t;
163 typedef struct input_socket_t input_socket_t;
164 typedef struct input_info_t input_info_t;
165 typedef struct input_info_category_t input_info_category_t;
166 typedef struct access_sys_t access_sys_t;
167 typedef struct demux_sys_t demux_sys_t;
168 typedef struct es_descriptor_t es_descriptor_t;
169 typedef struct es_sys_t es_sys_t;
170 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
171 typedef struct pgrm_sys_t pgrm_sys_t;
172 typedef struct stream_descriptor_t stream_descriptor_t;
173 typedef struct stream_sys_t stream_sys_t;
176 typedef struct aout_instance_t aout_instance_t;
177 typedef struct aout_sys_t aout_sys_t;
178 typedef struct aout_input_t aout_input_t;
179 typedef struct aout_buffer_t aout_buffer_t;
180 typedef struct audio_sample_format_t audio_sample_format_t;
183 typedef struct vout_thread_t vout_thread_t;
184 typedef struct vout_font_t vout_font_t;
185 typedef struct vout_sys_t vout_sys_t;
186 typedef struct chroma_sys_t chroma_sys_t;
187 typedef struct picture_t picture_t;
188 typedef struct picture_sys_t picture_sys_t;
189 typedef struct picture_heap_t picture_heap_t;
190 typedef struct subpicture_t subpicture_t;
191 typedef struct subpicture_sys_t subpicture_sys_t;
194 typedef struct sout_instance_t sout_instance_t;
195 typedef struct sout_fifo_t sout_fifo_t;
198 typedef struct decoder_fifo_t decoder_fifo_t;
201 typedef struct data_packet_t data_packet_t;
202 typedef struct data_buffer_t data_buffer_t;
203 typedef struct stream_position_t stream_position_t;
204 typedef struct stream_ctrl_t stream_ctrl_t;
205 typedef struct pes_packet_t pes_packet_t;
206 typedef struct bit_stream_t bit_stream_t;
207 typedef struct network_socket_t network_socket_t;
208 typedef struct iso639_lang_t iso639_lang_t;
210 /*****************************************************************************
212 *****************************************************************************/
214 # define VLC_EXPORT( type, name, args ) type name args
216 # define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
217 extern module_symbols_t* p_symbols;
220 /*****************************************************************************
221 * OS-specific headers and thread types
222 *****************************************************************************/
224 # define WIN32_LEAN_AND_MEAN
225 # include <windows.h>
228 #include "vlc_threads.h"
230 /*****************************************************************************
231 * Common structure members
232 *****************************************************************************/
234 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
235 #define VLC_COMMON_MEMBERS \
238 char *psz_object_type; \
239 char *psz_object_name; \
241 /* Thread properties, if any */ \
242 vlc_bool_t b_thread; \
243 vlc_thread_t thread_id; \
245 /* Object access lock */ \
246 vlc_mutex_t object_lock; \
247 vlc_cond_t object_wait; \
249 volatile vlc_bool_t b_error; /* set by the object */ \
250 volatile vlc_bool_t b_die; /* set by the outside */ \
251 volatile vlc_bool_t b_dead; /* set by the object */ \
252 volatile vlc_bool_t b_attached; /* set by the object */ \
254 vlc_t * p_vlc; /* root of all evil */ \
256 volatile int i_refcount; /* usage count */ \
257 vlc_object_t * p_parent; /* our parent */ \
258 vlc_object_t ** pp_children; /* our children */ \
259 volatile int i_children; \
264 /* Just a reminder so that people don't cast garbage */ \
265 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
267 /* The real vlc_object_t type. Yes, it's that simple :-) */
273 /* VLC_OBJECT: attempt at doing a clever cast */
274 #define VLC_OBJECT( x ) \
275 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
277 /*****************************************************************************
278 * Macros and inline functions
279 *****************************************************************************/
280 #ifdef NTOHL_IN_SYS_PARAM_H
281 # include <sys/param.h>
283 #elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
284 # include <netinet/in.h>
286 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
288 /* CEIL: division with round to nearest greater integer */
289 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
291 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
292 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
294 /* __MAX and __MIN: self explanatory */
296 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
299 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
302 /* MSB (big endian)/LSB (little endian) conversions - network order is always
303 * MSB, and should be used for both network communications and files. Note that
304 * byte orders other than little and big endians are not supported, but only
305 * the VAX seems to have such exotic properties. */
306 static inline u16 U16_AT( void * _p )
309 return ( ((u16)p[0] << 8) | p[1] );
311 static inline u32 U32_AT( void * _p )
314 return ( ((u32)p[0] << 24) | ((u32)p[1] << 16) | ((u32)p[2] << 8) | p[3] );
316 static inline u64 U64_AT( void * _p )
319 return ( ((u64)p[0] << 56) | ((u64)p[1] << 48) | ((u64)p[2] << 40)
320 | ((u64)p[3] << 32) | ((u64)p[4] << 24) | ((u64)p[5] << 16)
321 | ((u64)p[6] << 8) | p[7] );
324 # define hton16(i) ( i )
325 # define hton32(i) ( i )
326 # define hton64(i) ( i )
327 # define ntoh16(i) ( i )
328 # define ntoh32(i) ( i )
329 # define ntoh64(i) ( i )
331 # define hton16(i) U16_AT(&i)
332 # define hton32(i) U32_AT(&i)
333 # define hton64(i) U64_AT(&i)
334 # define ntoh16(i) U16_AT(&i)
335 # define ntoh32(i) U32_AT(&i)
336 # define ntoh64(i) U64_AT(&i)
339 /* Alignment of critical static data structures */
340 #ifdef ATTRIBUTE_ALIGNED_MAX
341 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
343 # define ATTR_ALIGN(align)
346 /* Alignment of critical dynamic data structure
348 * Not all platforms support memalign so we provide a vlc_memalign wrapper
349 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
350 * *pp_orig is the pointer that has to be freed afterwards.
353 #ifdef HAVE_POSIX_MEMALIGN
354 # define vlc_memalign(align,size,pp_orig) \
355 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
359 /* Some systems have memalign() but no declaration for it */
360 void * memalign( size_t align, size_t size );
362 # define vlc_memalign(pp_orig,align,size) \
363 ( *(pp_orig) = memalign( align, size ) )
365 #else /* We don't have any choice but to align manually */
366 # define vlc_memalign(pp_orig,align,size) \
367 (( *(pp_orig) = malloc( size + align - 1 )) \
368 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
369 & (~(unsigned long)(align-1)) ) \
374 /* strndup (defined in src/misc/extras.c) */
376 char * strndup( const char *s, size_t n );
380 #define I64C(x) x##LL
383 /* win32, cl and icl support */
384 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
385 # define __attribute__(x)
386 # define __inline__ __inline
387 # define strncasecmp strnicmp
388 # define strcasecmp stricmp
389 # define S_IFBLK 0x3000 /* Block */
390 # define S_ISBLK(m) (0)
391 # define S_ISCHR(m) (0)
392 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
393 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
395 # define I64C(x) x##i64
398 /* several type definitions */
399 # if defined( __MINGW32__ )
400 # if !defined( _OFF_T_ )
401 typedef long long _off_t;
402 typedef _off_t off_t;
405 # define off_t long long
409 # if defined( _MSC_VER )
410 # if !defined( _OFF_T_DEFINED )
411 typedef __int64 off_t;
412 # define _OFF_T_DEFINED
414 # define off_t __int64
418 # if defined( __BORLANDC__ )
420 # define off_t unsigned __int64
424 # define O_NONBLOCK 0
427 /* These two are not defined in mingw32 (bug?) */
429 # define snprintf _snprintf
432 # define vsnprintf _vsnprintf
437 /*****************************************************************************
439 *****************************************************************************/
440 #define CPU_CAPABILITY_NONE 0
441 #define CPU_CAPABILITY_486 (1<<0)
442 #define CPU_CAPABILITY_586 (1<<1)
443 #define CPU_CAPABILITY_PPRO (1<<2)
444 #define CPU_CAPABILITY_MMX (1<<3)
445 #define CPU_CAPABILITY_3DNOW (1<<4)
446 #define CPU_CAPABILITY_MMXEXT (1<<5)
447 #define CPU_CAPABILITY_SSE (1<<6)
448 #define CPU_CAPABILITY_ALTIVEC (1<<16)
449 #define CPU_CAPABILITY_FPU (1<<31)
451 /*****************************************************************************
453 *****************************************************************************/
454 #ifndef PACKAGE /* Borland C++ uses this ! */
455 #define PACKAGE VLC_PACKAGE
457 #define VERSION VLC_VERSION
459 #if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( MODULE_NAME_IS_gnome )
460 # include <libintl.h>
462 # define _(String) dgettext (PACKAGE, String)
464 # define N_(String) gettext_noop (String)
466 # define N_(String) (String)
468 #elif !defined( MODULE_NAME_IS_gnome )
469 # define _(String) (String)
470 # define N_(String) (String)
473 /*****************************************************************************
475 *****************************************************************************/
476 #include "vlc_symbols.h"