git.sesse.net Git - vlc/blob - include/vlc_common.h

   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.26 2002/08/30 22:22:24 massiot Exp $
   7  *
   8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
   9  *          Vincent Seguin <seguin@via.ecp.fr>
  10  *          Gildas Bazin <gbazin@netcourrier.com>
  11  *
  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.
  16  *
  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.
  21  *
  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  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Required vlc headers
  29  *****************************************************************************/
  30 #if defined( __BORLANDC__ )
  31 #   undef PACKAGE
  32 #endif
  33
  34 #include "config.h"
  35
  36 #if defined( __BORLANDC__ )
  37 #   undef HAVE_VARIADIC_MACROS
  38 #   undef HAVE_STDINT_H
  39 #endif
  40
  41 #include "vlc_config.h"
  42 #include "modules_inner.h"
  43
  44 /*****************************************************************************
  45  * Required system headers
  46  *****************************************************************************/
  47 #ifdef HAVE_STRING_H
  48 #   include <string.h>                                         /* strerror() */
  49 #endif
  50
  51 #ifdef HAVE_SYS_TYPES_H
  52 #   include <sys/types.h>
  53 #endif
  54
  55 /*****************************************************************************
  56  * Basic types definitions
  57  *****************************************************************************/
  58 #ifdef HAVE_STDINT_H
  59 #   include <stdint.h>
  60     typedef uint8_t             u8;
  61     typedef int8_t              s8;
  62
  63     typedef uint16_t            u16;
  64     typedef int16_t             s16;
  65
  66     typedef uint32_t            u32;
  67     typedef int32_t             s32;
  68
  69     typedef uint64_t            u64;
  70     typedef int64_t             s64;
  71 #else
  72     typedef unsigned char       u8;
  73     typedef signed char         s8;
  74
  75     typedef unsigned short      u16;
  76     typedef signed short        s16;
  77
  78     typedef unsigned int        u32;
  79     typedef signed int          s32;
  80
  81 #   if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
  82     typedef unsigned __int64    u64;
  83     typedef signed __int64      s64;
  84 #   else
  85     typedef unsigned long long  u64;
  86     typedef signed long long    s64;
  87 #   endif
  88 #endif
  89
  90 typedef u8                      byte_t;
  91
  92 /* ptrdiff_t definition */
  93 #ifdef HAVE_STDDEF_H
  94 #   include <stddef.h>
  95 #else
  96 #   include <malloc.h>
  97 #   ifndef _PTRDIFF_T
  98 #       define _PTRDIFF_T
  99 /* Not portable in a 64-bit environment. */
 100 typedef int                 ptrdiff_t;
 101 #   endif
 102 #endif
 103
 104 #if defined( WIN32 )
 105 typedef int                 ssize_t;
 106 #endif
 107
 108 /* Counter for statistics and profiling */
 109 typedef unsigned long       count_t;
 110
 111 /* DCT elements types */
 112 typedef s16                 dctelem_t;
 113
 114 /* Video buffer types */
 115 typedef u8                  yuv_data_t;
 116
 117 /*****************************************************************************
 118  * mtime_t: high precision date or time interval
 119  *****************************************************************************
 120  * Store an high precision date or time interval. The maximum precision is the
 121  * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
 122  * time interval is then 292271 years, which should be long enough for any
 123  * video). Date are stored as a time interval since a common date.
 124  * Note that date and time intervals can be manipulated using regular
 125  * arithmetic operators, and that no special functions are required.
 126  *****************************************************************************/
 127 typedef s64 mtime_t;
 128
 129 /*****************************************************************************
 130  * The vlc_fourcc_t type.
 131  *****************************************************************************
 132  * See http://www.webartz.com/fourcc/ for a very detailed list.
 133  *****************************************************************************/
 134 typedef u32 vlc_fourcc_t;
 135
 136 #ifdef WORDS_BIGENDIAN
 137 #   define VLC_FOURCC( a, b, c, d ) \
 138         ( ((u32)d) | ( ((u32)c) << 8 ) | ( ((u32)b) << 16 ) | ( ((u32)a) << 24 ) )
 139 #   define VLC_TWOCC( a, b ) \
 140         ( (u16)(b) | ( (u16)(a) << 8 ) )
 141
 142 #else
 143 #   define VLC_FOURCC( a, b, c, d ) \
 144         ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )
 145 #   define VLC_TWOCC( a, b ) \
 146         ( (u16)(a) | ( (u16)(b) << 8 ) )
 147
 148 #endif
 149
 150 /*****************************************************************************
 151  * Classes declaration
 152  *****************************************************************************/
 153
 154 /* Messages */
 155 typedef struct msg_bank_t msg_bank_t;
 156 typedef struct msg_subscription_t msg_subscription_t;
 157
 158 /* Playlist */
 159 typedef struct playlist_t playlist_t;
 160 typedef struct playlist_item_t playlist_item_t;
 161
 162 /* Modules */
 163 typedef struct module_bank_t module_bank_t;
 164 typedef struct module_t module_t;
 165 typedef struct module_config_t module_config_t;
 166 typedef struct module_symbols_t module_symbols_t;
 167
 168 /* Interface */
 169 typedef struct intf_thread_t intf_thread_t;
 170 typedef struct intf_sys_t intf_sys_t;
 171 typedef struct intf_console_t intf_console_t;
 172 typedef struct intf_msg_t intf_msg_t;
 173 typedef struct intf_channel_t intf_channel_t;
 174
 175 /* Input */
 176 typedef struct input_thread_t input_thread_t;
 177 typedef struct input_channel_t input_channel_t;
 178 typedef struct input_area_t input_area_t;
 179 typedef struct input_buffers_t input_buffers_t;
 180 typedef struct input_socket_t input_socket_t;
 181 typedef struct input_info_t input_info_t;
 182 typedef struct input_info_category_t input_info_category_t;
 183 typedef struct access_sys_t access_sys_t;
 184 typedef struct demux_sys_t demux_sys_t;
 185 typedef struct es_descriptor_t es_descriptor_t;
 186 typedef struct es_sys_t es_sys_t;
 187 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
 188 typedef struct pgrm_sys_t pgrm_sys_t;
 189 typedef struct stream_descriptor_t stream_descriptor_t;
 190 typedef struct stream_sys_t stream_sys_t;
 191
 192 /* Audio */
 193 typedef struct aout_instance_t aout_instance_t;
 194 typedef struct aout_sys_t aout_sys_t;
 195 typedef struct aout_fifo_t aout_fifo_t;
 196 typedef struct aout_input_t aout_input_t;
 197 typedef struct aout_buffer_t aout_buffer_t;
 198 typedef struct audio_sample_format_t audio_sample_format_t;
 199 typedef struct audio_date_t audio_date_t;
 200
 201 /* Video */
 202 typedef struct vout_thread_t vout_thread_t;
 203 typedef struct vout_font_t vout_font_t;
 204 typedef struct vout_sys_t vout_sys_t;
 205 typedef struct chroma_sys_t chroma_sys_t;
 206 typedef struct picture_t picture_t;
 207 typedef struct picture_sys_t picture_sys_t;
 208 typedef struct picture_heap_t picture_heap_t;
 209 typedef struct subpicture_t subpicture_t;
 210 typedef struct subpicture_sys_t subpicture_sys_t;
 211
 212 /* Stream output */
 213 typedef struct sout_instance_t sout_instance_t;
 214 typedef struct sout_fifo_t sout_fifo_t;
 215
 216 /* Decoders */
 217 typedef struct decoder_fifo_t decoder_fifo_t;
 218
 219 /* Misc */
 220 typedef struct data_packet_t data_packet_t;
 221 typedef struct data_buffer_t data_buffer_t;
 222 typedef struct stream_position_t stream_position_t;
 223 typedef struct stream_ctrl_t stream_ctrl_t;
 224 typedef struct pes_packet_t pes_packet_t;
 225 typedef struct bit_stream_t bit_stream_t;
 226 typedef struct network_socket_t network_socket_t;
 227 typedef struct iso639_lang_t iso639_lang_t;
 228
 229 /*****************************************************************************
 230  * Plug-in stuff
 231  *****************************************************************************/
 232 #ifndef __PLUGIN__
 233 #   define VLC_EXPORT( type, name, args ) type name args
 234 #else
 235 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
 236     extern module_symbols_t* p_symbols;
 237 #endif
 238
 239 /*****************************************************************************
 240  * OS-specific headers and thread types
 241  *****************************************************************************/
 242 #if defined( WIN32 )
 243 #   define WIN32_LEAN_AND_MEAN
 244 #   include <windows.h>
 245 #endif
 246
 247 #include "vlc_threads.h"
 248
 249 /*****************************************************************************
 250  * Common structure members
 251  *****************************************************************************/
 252
 253 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 254 #define VLC_COMMON_MEMBERS                                                  \
 255     int   i_object_id;                                                      \
 256     int   i_object_type;                                                    \
 257     char *psz_object_type;                                                  \
 258     char *psz_object_name;                                                  \
 259                                                                             \
 260     /* Thread properties, if any */                                         \
 261     vlc_bool_t   b_thread;                                                  \
 262     vlc_thread_t thread_id;                                                 \
 263                                                                             \
 264     /* Object access lock */                                                \
 265     vlc_mutex_t  object_lock;                                               \
 266     vlc_cond_t   object_wait;                                               \
 267                                                                             \
 268     volatile vlc_bool_t b_error;                    /* set by the object */ \
 269     volatile vlc_bool_t b_die;                     /* set by the outside */ \
 270     volatile vlc_bool_t b_dead;                     /* set by the object */ \
 271     volatile vlc_bool_t b_attached;                 /* set by the object */ \
 272                                                                             \
 273     vlc_t *         p_vlc;                           /* root of all evil */ \
 274                                                                             \
 275     volatile int    i_refcount;                           /* usage count */ \
 276     vlc_object_t *  p_parent;                              /* our parent */ \
 277     vlc_object_t ** pp_children;                         /* our children */ \
 278     volatile int    i_children;                                             \
 279                                                                             \
 280     /* Private data */                                                      \
 281     void *          p_private;                                              \
 282                                                                             \
 283     /* Just a reminder so that people don't cast garbage */                 \
 284     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
 285
 286 /* The real vlc_object_t type. Yes, it's that simple :-) */
 287 struct vlc_object_t
 288 {
 289     VLC_COMMON_MEMBERS
 290 };
 291
 292 /* The object list */
 293 struct vlc_list_t
 294 {
 295     int             i_count;
 296     vlc_object_t ** pp_objects;
 297
 298     /* Private */
 299     int             _i_extra;
 300     vlc_object_t *  _p_first;
 301 };
 302
 303 /* VLC_OBJECT: attempt at doing a clever cast */
 304 #define VLC_OBJECT( x ) \
 305     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 306
 307 /*****************************************************************************
 308  * Macros and inline functions
 309  *****************************************************************************/
 310 #ifdef NTOHL_IN_SYS_PARAM_H
 311 #   include <sys/param.h>
 312
 313 #elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 314 #   include <netinet/in.h>
 315
 316 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 317
 318 /* CEIL: division with round to nearest greater integer */
 319 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 320
 321 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 322 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 323
 324 /* __MAX and __MIN: self explanatory */
 325 #ifndef __MAX
 326 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 327 #endif
 328 #ifndef __MIN
 329 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 330 #endif
 331
 332 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 333  * MSB, and should be used for both network communications and files. Note that
 334  * byte orders other than little and big endians are not supported, but only
 335  * the VAX seems to have such exotic properties. */
 336 static inline u16 U16_AT( void * _p )
 337 {
 338     u8 * p = (u8 *)_p;
 339     return ( ((u16)p[0] << 8) | p[1] );
 340 }
 341 static inline u32 U32_AT( void * _p )
 342 {
 343     u8 * p = (u8 *)_p;
 344     return ( ((u32)p[0] << 24) | ((u32)p[1] << 16) | ((u32)p[2] << 8) | p[3] );
 345 }
 346 static inline u64 U64_AT( void * _p )
 347 {
 348     u8 * p = (u8 *)_p;
 349     return ( ((u64)p[0] << 56) | ((u64)p[1] << 48) | ((u64)p[2] << 40)
 350               | ((u64)p[3] << 32) | ((u64)p[4] << 24) | ((u64)p[5] << 16)
 351               | ((u64)p[6] << 8) | p[7] );
 352 }
 353 #if WORDS_BIGENDIAN
 354 #   define hton16(i)   ( i )
 355 #   define hton32(i)   ( i )
 356 #   define hton64(i)   ( i )
 357 #   define ntoh16(i)   ( i )
 358 #   define ntoh32(i)   ( i )
 359 #   define ntoh64(i)   ( i )
 360 #else
 361 #   define hton16(i)   U16_AT(&i)
 362 #   define hton32(i)   U32_AT(&i)
 363 #   define hton64(i)   U64_AT(&i)
 364 #   define ntoh16(i)   U16_AT(&i)
 365 #   define ntoh32(i)   U32_AT(&i)
 366 #   define ntoh64(i)   U64_AT(&i)
 367 #endif
 368
 369 /* Alignment of critical static data structures */
 370 #ifdef ATTRIBUTE_ALIGNED_MAX
 371 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
 372 #else
 373 #   define ATTR_ALIGN(align)
 374 #endif
 375
 376 /* Alignment of critical dynamic data structure
 377  *
 378  * Not all platforms support memalign so we provide a vlc_memalign wrapper
 379  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 380  * *pp_orig is the pointer that has to be freed afterwards.
 381  */
 382 #if 0
 383 #ifdef HAVE_POSIX_MEMALIGN
 384 #   define vlc_memalign(align,size,pp_orig) \
 385     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
 386 #endif
 387 #endif
 388 #ifdef HAVE_MEMALIGN
 389     /* Some systems have memalign() but no declaration for it */
 390     void * memalign( size_t align, size_t size );
 391
 392 #   define vlc_memalign(pp_orig,align,size) \
 393     ( *(pp_orig) = memalign( align, size ) )
 394
 395 #else /* We don't have any choice but to align manually */
 396 #   define vlc_memalign(pp_orig,align,size) \
 397     (( *(pp_orig) = malloc( size + align - 1 )) \
 398         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
 399                        & (~(unsigned long)(align-1)) ) \
 400         : NULL )
 401
 402 #endif
 403
 404 /* strndup (defined in src/misc/extras.c) */
 405 #ifndef HAVE_STRNDUP
 406 char * strndup( const char *s, size_t n );
 407 #endif
 408
 409
 410 #define I64C(x)         x##LL
 411
 412 #ifdef WIN32
 413 /* win32, cl and icl support */
 414 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 415 #       define __attribute__(x)
 416 #       define __inline__      __inline
 417 #       define strncasecmp     strnicmp
 418 #       define strcasecmp      stricmp
 419 #       define S_IFBLK         0x3000  /* Block */
 420 #       define S_ISBLK(m)      (0)
 421 #       define S_ISCHR(m)      (0)
 422 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 423 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 424 #       undef I64C
 425 #       define I64C(x)         x##i64
 426 #   endif
 427
 428 /* several type definitions */
 429 #   if defined( __MINGW32__ )
 430 #       if !defined( _OFF_T_ )
 431 typedef long long _off_t;
 432 typedef _off_t off_t;
 433 #           define _OFF_T_
 434 #       else
 435 #           define off_t long long
 436 #       endif
 437 #   endif
 438
 439 #   if defined( _MSC_VER )
 440 #       if !defined( _OFF_T_DEFINED )
 441 typedef __int64 off_t;
 442 #           define _OFF_T_DEFINED
 443 #       else
 444 #           define off_t __int64
 445 #       endif
 446 #   endif
 447
 448 #   if defined( __BORLANDC__ )
 449 #       undef off_t
 450 #       define off_t unsigned __int64
 451 #   endif
 452
 453 #   ifndef O_NONBLOCK
 454 #       define O_NONBLOCK 0
 455 #   endif
 456
 457     /* These two are not defined in mingw32 (bug?) */
 458 #   ifndef snprintf
 459 #       define snprintf _snprintf
 460 #   endif
 461 #   ifndef vsnprintf
 462 #       define vsnprintf _vsnprintf
 463 #   endif
 464
 465 #endif
 466
 467 /*****************************************************************************
 468  * CPU capabilities
 469  *****************************************************************************/
 470 #define CPU_CAPABILITY_NONE    0
 471 #define CPU_CAPABILITY_486     (1<<0)
 472 #define CPU_CAPABILITY_586     (1<<1)
 473 #define CPU_CAPABILITY_PPRO    (1<<2)
 474 #define CPU_CAPABILITY_MMX     (1<<3)
 475 #define CPU_CAPABILITY_3DNOW   (1<<4)
 476 #define CPU_CAPABILITY_MMXEXT  (1<<5)
 477 #define CPU_CAPABILITY_SSE     (1<<6)
 478 #define CPU_CAPABILITY_ALTIVEC (1<<16)
 479 #define CPU_CAPABILITY_FPU     (1<<31)
 480
 481 /*****************************************************************************
 482  * I18n stuff
 483  *****************************************************************************/
 484 #if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( NEED_GNOMESUPPORT_H )
 485 #   include <libintl.h>
 486 #   undef _
 487 #   define _(String) dgettext (PACKAGE, String)
 488 #   ifdef gettext_noop
 489 #       define N_(String) gettext_noop (String)
 490 #   else
 491 #       define N_(String) (String)
 492 #   endif
 493 #elif !defined( NEED_GNOMESUPPORT_H )
 494 #   define _(String) (String)
 495 #   define N_(String) (String)
 496 #endif
 497
 498 /*****************************************************************************
 499  * Additional vlc stuff
 500  *****************************************************************************/
 501 #include "vlc_symbols.h"
 502 #include "os_specific.h"
 503 #include "vlc_messages.h"
 504 #include "vlc_threads_funcs.h"
 505 #include "mtime.h"
 506 #include "modules.h"
 507 #include "main.h"
 508 #include "configuration.h"
 509 #include "vlc_objects.h"
 510
 511 #if defined( __BORLANDC__ )
 512 #   undef PACKAGE
 513 #   define PACKAGE
 514 #endif
 515