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: common.h,v 1.64 2002/01/04 14:01:34 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 system headers
29 *****************************************************************************/
30 #include <string.h> /* strerror() */
32 /*****************************************************************************
33 * Basic types definitions
34 *****************************************************************************/
39 #ifdef BOOLEAN_T_IN_SYS_TYPES_H
40 # include <sys/types.h>
41 #elif defined(BOOLEAN_T_IN_PTHREAD_H)
43 #elif defined(BOOLEAN_T_IN_CTHREADS_H)
44 # include <cthreads.h>
46 typedef int boolean_t;
49 # define _MACH_I386_BOOLEAN_H_
52 /* ptrdiff_t definition */
59 /* Not portable in a 64-bit environment. */
60 typedef int ptrdiff_t;
64 /* Counter for statistics and profiling */
65 typedef unsigned long count_t;
67 /* DCT elements types */
68 typedef s16 dctelem_t;
70 /* Video buffer types */
71 typedef u8 yuv_data_t;
73 /*****************************************************************************
74 * mtime_t: high precision date or time interval
75 *****************************************************************************
76 * Store an high precision date or time interval. The maximum precision is the
77 * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
78 * time interval is then 292271 years, which should be long enough for any
79 * video). Date are stored as a time interval since a common date.
80 * Note that date and time intervals can be manipulated using regular
81 * arithmetic operators, and that no special functions are required.
82 *****************************************************************************/
85 /*****************************************************************************
87 *****************************************************************************/
93 typedef struct plugin_bank_s * p_plugin_bank_t;
94 typedef struct plugin_info_s * p_plugin_info_t;
98 struct playlist_item_s;
101 typedef struct playlist_s * p_playlist_t;
102 typedef struct playlist_item_s * p_playlist_item_t;
105 struct intf_thread_s;
107 struct intf_console_s;
109 struct intf_channel_s;
111 typedef struct intf_thread_s * p_intf_thread_t;
112 typedef struct intf_sys_s * p_intf_sys_t;
113 typedef struct intf_console_s * p_intf_console_t;
114 typedef struct intf_msg_s * p_intf_msg_t;
115 typedef struct intf_channel_s * p_intf_channel_t;
118 struct input_thread_s;
119 struct input_channel_s;
123 typedef struct input_thread_s * p_input_thread_t;
124 typedef struct input_channel_s * p_input_channel_t;
125 typedef struct input_cfg_s * p_input_cfg_t;
126 typedef struct input_area_s * p_input_area_t;
129 struct aout_thread_s;
132 typedef struct aout_thread_s * p_aout_thread_t;
133 typedef struct aout_sys_s * p_aout_sys_t;
136 struct vout_thread_s;
140 struct vdec_thread_s;
141 struct vpar_thread_s;
142 struct video_parser_s;
144 typedef struct vout_thread_s * p_vout_thread_t;
145 typedef struct vout_font_s * p_vout_font_t;
146 typedef struct vout_sys_s * p_vout_sys_t;
147 typedef struct chroma_sys_s * p_chroma_sys_t;
148 typedef struct vdec_thread_s * p_vdec_thread_t;
149 typedef struct vpar_thread_s * p_vpar_thread_t;
150 typedef struct video_parser_s * p_video_parser_t;
153 struct decoder_config_s;
154 struct decoder_fifo_s;
158 struct data_packet_s;
163 struct picture_sys_s;
164 struct picture_heap_s;
165 struct es_descriptor_s;
166 struct pgrm_descriptor_s;
172 /*****************************************************************************
173 * Macros and inline functions
174 *****************************************************************************/
175 #ifdef NTOHL_IN_SYS_PARAM_H
176 # include <sys/param.h>
179 /* Swap bytes in 16 bit value. */
180 # define __bswap_constant_16(x) \
181 ((((x) >> 8) & 0xff) | (((x) & 0xff) << 8))
183 # if defined __GNUC__ && __GNUC__ >= 2
184 # define __bswap_16(x) \
186 ({ register unsigned short int __v; \
187 if (__builtin_constant_p (x)) \
188 __v = __bswap_constant_16 (x); \
190 __asm__ __volatile__ ("rorw $8, %w0" \
192 : "0" ((unsigned short int) (x)) \
196 /* This is better than nothing. */
197 # define __bswap_16(x) __bswap_constant_16 (x)
200 /* Swap bytes in 32 bit value. */
201 # define __bswap_constant_32(x) \
202 ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >> 8) | \
203 (((x) & 0x0000ff00) << 8) | (((x) & 0x000000ff) << 24))
205 # if defined __GNUC__ && __GNUC__ >= 2
206 /* To swap the bytes in a word the i486 processors and up provide the
207 `bswap' opcode. On i386 we have to use three instructions. */
208 # if !defined __i486__ && !defined __pentium__ && !defined __pentiumpro__
209 # define __bswap_32(x) \
211 ({ register unsigned int __v; \
212 if (__builtin_constant_p (x)) \
213 __v = __bswap_constant_32 (x); \
215 __asm__ __volatile__ ("rorw $8, %w0;" \
219 : "0" ((unsigned int) (x)) \
223 # define __bswap_32(x) \
225 ({ register unsigned int __v; \
226 if (__builtin_constant_p (x)) \
227 __v = __bswap_constant_32 (x); \
229 __asm__ __volatile__ ("bswap %0" \
231 : "0" ((unsigned int) (x))); \
235 # define __bswap_32(x) __bswap_constant_32 (x)
238 # if defined __GNUC__ && __GNUC__ >= 2
239 /* Swap bytes in 64 bit value. */
240 # define __bswap_constant_64(x) \
241 ((((x) & 0xff00000000000000ull) >> 56) \
242 | (((x) & 0x00ff000000000000ull) >> 40) \
243 | (((x) & 0x0000ff0000000000ull) >> 24) \
244 | (((x) & 0x000000ff00000000ull) >> 8) \
245 | (((x) & 0x00000000ff000000ull) << 8) \
246 | (((x) & 0x0000000000ff0000ull) << 24) \
247 | (((x) & 0x000000000000ff00ull) << 40) \
248 | (((x) & 0x00000000000000ffull) << 56))
250 # define __bswap_64(x) \
252 ({ union { __extension__ unsigned long long int __ll; \
253 unsigned long int __l[2]; } __w, __r; \
254 if (__builtin_constant_p (x)) \
255 __r.__ll = __bswap_constant_64 (x); \
259 __r.__l[0] = __bswap_32 (__w.__l[1]); \
260 __r.__l[1] = __bswap_32 (__w.__l[0]); \
265 #else /* NTOHL_IN_SYS_PARAM_H || WIN32 */
266 # include <netinet/in.h>
268 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
270 /* CEIL: division with round to nearest greater integer */
271 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
273 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
274 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
276 /* MAX and MIN: self explanatory */
278 # define MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
281 # define MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
284 /* MSB (big endian)/LSB (little endian) conversions - network order is always
285 * MSB, and should be used for both network communications and files. Note that
286 * byte orders other than little and big endians are not supported, but only
287 * the VAX seems to have such exotic properties - note that these 'functions'
288 * needs <netinet/in.h> or the local equivalent. */
289 /* FIXME: hton64 should be declared as an extern inline function to avoid
290 * border effects (see byteorder.h) */
292 # define hton16 htons
293 # define hton32 htonl
294 # define hton64(i) ( i )
295 # define ntoh16 ntohs
296 # define ntoh32 ntohl
297 # define ntoh64(i) ( i )
299 # define hton16 htons
300 # define hton32 htonl
301 # define hton64(i) ( ((u64)(htonl((i) & 0xffffffff)) << 32) | htonl(((i) >> 32) & 0xffffffff ) )
302 # define ntoh16 ntohs
303 # define ntoh32 ntohl
304 # define ntoh64 hton64
307 /* Macros with automatic casts */
308 #define U64_AT(p) ( ntoh64 ( *( (u64 *)(p) ) ) )
309 #define U32_AT(p) ( ntoh32 ( *( (u32 *)(p) ) ) )
310 #define U16_AT(p) ( ntoh16 ( *( (u16 *)(p) ) ) )
312 /* Alignment of critical static data structures */
313 #ifdef ATTRIBUTE_ALIGNED_MAX
314 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
316 # define ATTR_ALIGN(align)
319 /* Alignment of critical dynamic data structure */
321 /* Some systems have memalign() but no declaration for it */
322 void * memalign( size_t align, size_t size );
325 /* That's like using a hammer to kill a fly, but eh... */
327 # define memalign(align,size) valloc(size)
329 /* Assume malloc alignment is sufficient */
330 # define memalign(align,size) malloc(size)
334 #define I64C(x) x##LL
338 /* The ntoh* and hton* bytes swapping functions are provided by winsock
339 * but for conveniency and speed reasons it is better to implement them
340 * ourselves. ( several plugins use them and it is too much hassle to link
341 * winsock with each of them ;-)
350 # ifdef WORDS_BIGENDIAN
351 # define ntoh32(x) (x)
352 # define ntoh16(x) (x)
353 # define ntoh64(x) (x)
354 # define hton32(x) (x)
355 # define hton16(x) (x)
356 # define hton64(x) (x)
358 # define ntoh32(x) __bswap_32 (x)
359 # define ntoh16(x) __bswap_16 (x)
360 # define ntoh64(x) __bswap_32 (x)
361 # define hton32(x) __bswap_32 (x)
362 # define hton16(x) __bswap_16 (x)
363 # define hton64(x) __bswap_32 (x)
366 /* win32, cl and icl support */
367 # if defined( _MSC_VER )
368 # define __attribute__(x)
369 # define __inline__ __inline
370 # define strncasecmp strnicmp
371 # define strcasecmp stricmp
372 # define S_ISBLK(m) (0)
373 # define S_ISCHR(m) (0)
374 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
375 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
377 # define I64C(x) x##i64
380 /* several type definitions */
381 # if defined( __MINGW32__ )
382 # if !defined( _OFF_T_ )
383 typedef long long _off_t;
384 typedef _off_t off_t;
387 # define off_t long long
391 # if defined( _MSC_VER )
392 # if !defined( _OFF_T_DEFINED )
393 typedef __int64 off_t;
394 # define _OFF_T_DEFINED
396 # define off_t __int64
398 # define stat _stati64
402 # define snprintf _snprintf /* snprintf not defined in mingw32 (bug?) */
407 /*****************************************************************************
409 *****************************************************************************/
410 #define CPU_CAPABILITY_NONE 0
411 #define CPU_CAPABILITY_486 (1<<0)
412 #define CPU_CAPABILITY_586 (1<<1)
413 #define CPU_CAPABILITY_PPRO (1<<2)
414 #define CPU_CAPABILITY_MMX (1<<3)
415 #define CPU_CAPABILITY_3DNOW (1<<4)
416 #define CPU_CAPABILITY_MMXEXT (1<<5)
417 #define CPU_CAPABILITY_SSE (1<<6)
418 #define CPU_CAPABILITY_ALTIVEC (1<<16)
419 #define CPU_CAPABILITY_FPU (1<<31)
421 /*****************************************************************************
423 *****************************************************************************/
424 #if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT )
425 # include <libintl.h>
427 # define _(String) (String)
428 # define N_(String) (String)
429 # define textdomain(Domain)
430 # define bindtextdomain(Package, Directory) 1
433 /*****************************************************************************
435 *****************************************************************************/
436 typedef struct module_symbols_s
438 struct main_s* p_main;
439 struct aout_bank_s* p_aout_bank;
440 struct vout_bank_s* p_vout_bank;
442 int ( * main_GetIntVariable ) ( char *, int );
443 char * ( * main_GetPszVariable ) ( char *, char * );
444 void ( * main_PutIntVariable ) ( char *, int );
445 void ( * main_PutPszVariable ) ( char *, char * );
447 int ( * intf_ProcessKey ) ( struct intf_thread_s *, int );
448 void ( * intf_AssignKey ) ( struct intf_thread_s *, int, int, int );
450 void ( * intf_Msg ) ( char *, ... );
451 void ( * intf_ErrMsg ) ( char *, ... );
452 void ( * intf_StatMsg ) ( char *, ... );
453 void ( * intf_WarnMsg ) ( int, char *, ... );
454 void ( * intf_WarnMsgImm ) ( int, char *, ... );
456 void ( * intf_DbgMsg ) ( char *, char *, int, char *, ... );
457 void ( * intf_DbgMsgImm ) ( char *, char *, int, char *, ... );
460 int ( * intf_PlaylistAdd ) ( struct playlist_s *, int, const char* );
461 int ( * intf_PlaylistDelete ) ( struct playlist_s *, int );
462 void ( * intf_PlaylistNext ) ( struct playlist_s * );
463 void ( * intf_PlaylistPrev ) ( struct playlist_s * );
464 void ( * intf_PlaylistDestroy ) ( struct playlist_s * );
465 void ( * intf_PlaylistJumpto ) ( struct playlist_s *, int );
466 void ( * intf_UrlDecode ) ( char * );
468 void ( * msleep ) ( mtime_t );
469 mtime_t ( * mdate ) ( void );
471 int ( * network_ChannelCreate )( void );
472 int ( * network_ChannelJoin ) ( int );
474 int ( * input_SetProgram ) ( struct input_thread_s *,
475 struct pgrm_descriptor_s * );
476 void ( * input_SetStatus ) ( struct input_thread_s *, int );
477 void ( * input_Seek ) ( struct input_thread_s *, off_t );
478 void ( * input_DumpStream ) ( struct input_thread_s * );
479 char * ( * input_OffsetToTime ) ( struct input_thread_s *, char *, off_t );
480 int ( * input_ChangeES ) ( struct input_thread_s *,
481 struct es_descriptor_s *, u8 );
482 int ( * input_ToggleES ) ( struct input_thread_s *,
483 struct es_descriptor_s *, boolean_t );
484 int ( * input_ChangeArea ) ( struct input_thread_s *,
485 struct input_area_s * );
486 struct es_descriptor_s * ( * input_FindES ) ( struct input_thread_s *,
488 struct es_descriptor_s * ( * input_AddES ) ( struct input_thread_s *,
489 struct pgrm_descriptor_s *, u16, size_t );
490 void ( * input_DelES ) ( struct input_thread_s *,
491 struct es_descriptor_s * );
492 int ( * input_SelectES ) ( struct input_thread_s *,
493 struct es_descriptor_s * );
494 int ( * input_UnselectES ) ( struct input_thread_s *,
495 struct es_descriptor_s * );
496 struct pgrm_descriptor_s* ( * input_AddProgram ) ( struct input_thread_s *,
498 void ( * input_DelProgram ) ( struct input_thread_s *,
499 struct pgrm_descriptor_s * );
500 struct input_area_s * ( * input_AddArea ) ( struct input_thread_s * );
501 void ( * input_DelArea ) ( struct input_thread_s *,
502 struct input_area_s * );
504 void ( * InitBitstream ) ( struct bit_stream_s *,
505 struct decoder_fifo_s *,
506 void ( * ) ( struct bit_stream_s *,
509 void ( * DecoderError ) ( struct decoder_fifo_s * p_fifo );
510 int ( * input_InitStream ) ( struct input_thread_s *, size_t );
511 void ( * input_EndStream ) ( struct input_thread_s * );
513 void ( * input_ParsePES ) ( struct input_thread_s *,
514 struct es_descriptor_s * );
515 void ( * input_GatherPES ) ( struct input_thread_s *,
516 struct data_packet_s *,
517 struct es_descriptor_s *,
518 boolean_t, boolean_t );
519 void ( * input_DecodePES ) ( struct decoder_fifo_s *,
520 struct pes_packet_s * );
521 struct es_descriptor_s * ( * input_ParsePS ) ( struct input_thread_s *,
522 struct data_packet_s * );
523 void ( * input_DemuxPS ) ( struct input_thread_s *,
524 struct data_packet_s * );
525 void ( * input_DemuxTS ) ( struct input_thread_s *,
526 struct data_packet_s * );
527 void ( * input_DemuxPSI ) ( struct input_thread_s *,
528 struct data_packet_s *,
529 struct es_descriptor_s *,
530 boolean_t, boolean_t );
532 int ( * input_ClockManageControl ) ( struct input_thread_s *,
533 struct pgrm_descriptor_s *,
536 struct aout_fifo_s * ( * aout_CreateFifo )
537 ( int, int, long, long, long, void * );
538 void ( * aout_DestroyFifo ) ( struct aout_fifo_s * );
540 struct vout_thread_s * (* vout_CreateThread) ( int *, int, int, u32, int );
541 void ( * vout_DestroyThread ) ( struct vout_thread_s *, int * );
543 struct picture_s * ( * vout_CreatePicture )
544 ( struct vout_thread_s *,
545 boolean_t, boolean_t, boolean_t );
546 void ( * vout_AllocatePicture )( struct picture_s *, int, int, u32 );
547 void ( * vout_DisplayPicture ) ( struct vout_thread_s *,
548 struct picture_s * );
549 void ( * vout_DestroyPicture ) ( struct vout_thread_s *,
550 struct picture_s * );
551 void ( * vout_LinkPicture ) ( struct vout_thread_s *,
552 struct picture_s * );
553 void ( * vout_UnlinkPicture ) ( struct vout_thread_s *,
554 struct picture_s * );
555 void ( * vout_DatePicture ) ( struct vout_thread_s *,
556 struct picture_s *, mtime_t );
557 void ( * vout_PlacePicture ) ( struct vout_thread_s *, int, int,
558 int *, int *, int *, int * );
560 struct subpicture_s * (* vout_CreateSubPicture)
561 ( struct vout_thread_s *, int, int );
562 void ( * vout_DestroySubPicture ) ( struct vout_thread_s *,
563 struct subpicture_s * );
564 void ( * vout_DisplaySubPicture ) ( struct vout_thread_s *,
565 struct subpicture_s * );
567 u32 ( * UnalignedShowBits ) ( struct bit_stream_s *, unsigned int );
568 void ( * UnalignedRemoveBits ) ( struct bit_stream_s * );
569 u32 ( * UnalignedGetBits ) ( struct bit_stream_s *, unsigned int );
571 char * ( * DecodeLanguage ) ( u16 );
573 struct module_s * ( * module_Need ) ( int, char *, struct probedata_s * );
574 void ( * module_Unneed ) ( struct module_s * );
578 extern module_symbols_t* p_symbols;