vlc_common.h 15.9 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3 4 5
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
 * Copyright (C) 1998, 1999, 2000 VideoLAN
6
 * $Id: vlc_common.h,v 1.12 2002/07/23 00:39:16 sam Exp $
Sam Hocevar's avatar
 
Sam Hocevar committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
 *          Gildas Bazin <gbazin@netcourrier.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

27 28 29 30 31 32 33 34
/*****************************************************************************
 * Compiler-specific workarounds
 *****************************************************************************/
#if defined( __BORLANDC__ )
#   undef HAVE_VARIADIC_MACROS
#   undef HAVE_STDINT_H
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
35 36 37
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
38 39 40 41 42 43 44
#ifdef HAVE_STRING_H
#   include <string.h>                                         /* strerror() */
#endif

#ifdef HAVE_SYS_TYPES_H
#   include <sys/types.h>
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
45 46 47 48

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
49 50 51 52
#ifdef HAVE_STDINT_H
#   include <stdint.h>
    typedef uint8_t             u8;
    typedef int8_t              s8;
Sam Hocevar's avatar
 
Sam Hocevar committed
53

54 55
    typedef uint16_t            u16;
    typedef int16_t             s16;
Sam Hocevar's avatar
 
Sam Hocevar committed
56

57 58
    typedef uint32_t            u32;
    typedef int32_t             s32;
Sam Hocevar's avatar
 
Sam Hocevar committed
59

60 61
    typedef uint64_t            u64;
    typedef int64_t             s64;
Sam Hocevar's avatar
 
Sam Hocevar committed
62
#else
63 64
    typedef unsigned char       u8;
    typedef signed char         s8;
Sam Hocevar's avatar
 
Sam Hocevar committed
65

66 67
    typedef unsigned short      u16;
    typedef signed short        s16;
Sam Hocevar's avatar
 
Sam Hocevar committed
68

69 70 71 72 73 74 75 76 77 78
    typedef unsigned int        u32;
    typedef signed int          s32;

#   if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
    typedef unsigned __int64    u64;
    typedef signed __int64      s64;
#   else
    typedef unsigned long long  u64;
    typedef signed long long    s64;
#   endif
Sam Hocevar's avatar
 
Sam Hocevar committed
79 80
#endif

81 82
typedef u8                      byte_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
83 84 85 86 87 88 89 90 91 92 93 94
/* ptrdiff_t definition */
#ifdef HAVE_STDDEF_H
#   include <stddef.h>
#else
#   include <malloc.h>
#   ifndef _PTRDIFF_T
#       define _PTRDIFF_T
/* Not portable in a 64-bit environment. */
typedef int                 ptrdiff_t;
#   endif
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
95 96
#if defined( WIN32 )
typedef int                 ssize_t;
Xavier Marchesini's avatar
 
Xavier Marchesini committed
97 98
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
typedef s16                 dctelem_t;

/* Video buffer types */
typedef u8                  yuv_data_t;

/*****************************************************************************
 * mtime_t: high precision date or time interval
 *****************************************************************************
 * Store an high precision date or time interval. The maximum precision is the
 * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
 * time interval is then 292271 years, which should be long enough for any
 * video). Date are stored as a time interval since a common date.
 * Note that date and time intervals can be manipulated using regular
 * arithmetic operators, and that no special functions are required.
 *****************************************************************************/
typedef s64 mtime_t;

120 121 122 123 124 125 126 127 128 129 130 131 132
/*****************************************************************************
 * The vlc_fourcc_t type.
 *****************************************************************************
 * See http://www.webartz.com/fourcc/ for a very detailed list.
 *****************************************************************************/
typedef u32 vlc_fourcc_t;

#define VLC_FOURCC( a, b, c, d ) \
    ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )

#define VLC_TWOCC( a, b ) \
    ( (u16)(a) | ( (u16)(b) << 8 ) )

Sam Hocevar's avatar
 
Sam Hocevar committed
133 134 135 136
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

137
/* Messages */
138 139
VLC_DECLARE_STRUCT(msg_bank_t)
VLC_DECLARE_STRUCT(msg_subscription_t)
Sam Hocevar's avatar
 
Sam Hocevar committed
140

Gildas Bazin's avatar
 
Gildas Bazin committed
141
/* Playlist */
142 143
VLC_DECLARE_STRUCT(playlist_t)
VLC_DECLARE_STRUCT(playlist_item_t)
Sam Hocevar's avatar
 
Sam Hocevar committed
144

145
/* Modules */
146 147 148 149 150
VLC_DECLARE_STRUCT(module_bank_t)
VLC_DECLARE_STRUCT(module_t)
VLC_DECLARE_STRUCT(module_config_t)
VLC_DECLARE_STRUCT(module_symbols_t)
VLC_DECLARE_STRUCT(module_functions_t)
Sam Hocevar's avatar
 
Sam Hocevar committed
151 152

/* Interface */
153 154 155 156 157
VLC_DECLARE_STRUCT(intf_thread_t)
VLC_DECLARE_STRUCT(intf_sys_t)
VLC_DECLARE_STRUCT(intf_console_t)
VLC_DECLARE_STRUCT(intf_msg_t)
VLC_DECLARE_STRUCT(intf_channel_t)
Sam Hocevar's avatar
 
Sam Hocevar committed
158 159

/* Input */
160 161 162 163 164 165
VLC_DECLARE_STRUCT(input_thread_t)
VLC_DECLARE_STRUCT(input_channel_t)
VLC_DECLARE_STRUCT(input_cfg_t)
VLC_DECLARE_STRUCT(input_area_t)
VLC_DECLARE_STRUCT(input_buffers_t)
VLC_DECLARE_STRUCT(input_socket_t)
Sam Hocevar's avatar
 
Sam Hocevar committed
166 167

/* Audio */
168 169 170
VLC_DECLARE_STRUCT(aout_thread_t)
VLC_DECLARE_STRUCT(aout_sys_t)
VLC_DECLARE_STRUCT(aout_fifo_t)
Sam Hocevar's avatar
 
Sam Hocevar committed
171 172

/* Video */
173 174 175 176 177 178 179 180 181
VLC_DECLARE_STRUCT(vout_thread_t)
VLC_DECLARE_STRUCT(vout_font_t)
VLC_DECLARE_STRUCT(vout_sys_t)
VLC_DECLARE_STRUCT(chroma_sys_t)
VLC_DECLARE_STRUCT(picture_t)
VLC_DECLARE_STRUCT(picture_sys_t)
VLC_DECLARE_STRUCT(picture_heap_t)
VLC_DECLARE_STRUCT(subpicture_t)
VLC_DECLARE_STRUCT(subpicture_sys_t)
Sam Hocevar's avatar
 
Sam Hocevar committed
182 183

/* Decoders */
184
VLC_DECLARE_STRUCT(decoder_fifo_t)
Sam Hocevar's avatar
 
Sam Hocevar committed
185 186

/* Misc */
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
VLC_DECLARE_STRUCT(macroblock_t)
VLC_DECLARE_STRUCT(data_packet_t)
VLC_DECLARE_STRUCT(data_buffer_t)
VLC_DECLARE_STRUCT(downmix_t)
VLC_DECLARE_STRUCT(imdct_t)
VLC_DECLARE_STRUCT(complex_t)
VLC_DECLARE_STRUCT(dm_par_t)
VLC_DECLARE_STRUCT(es_descriptor_t)
VLC_DECLARE_STRUCT(pgrm_descriptor_t)
VLC_DECLARE_STRUCT(stream_descriptor_t)
VLC_DECLARE_STRUCT(stream_position_t)
VLC_DECLARE_STRUCT(stream_ctrl_t)
VLC_DECLARE_STRUCT(pes_packet_t)
VLC_DECLARE_STRUCT(bit_stream_t)
VLC_DECLARE_STRUCT(network_socket_t)
VLC_DECLARE_STRUCT(iso639_lang_t)
203 204
VLC_DECLARE_STRUCT(input_info_t)
VLC_DECLARE_STRUCT(input_info_category_t)
205

Gildas Bazin's avatar
 
Gildas Bazin committed
206 207 208 209 210 211 212 213 214 215
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
#ifndef __PLUGIN__
#   define VLC_EXPORT( type, name, args ) type name args;
#else
#   define VLC_EXPORT( type, name, args ) ;
    extern module_symbols_t* p_symbols;
#endif

216 217 218
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
219 220 221 222 223
#if defined( WIN32 )
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
#endif

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
#include "vlc_threads.h"

/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
    char *psz_object_type;                                                  \
    char *psz_object_name;                                                  \
                                                                            \
    /* Thread properties, if any */                                         \
    vlc_bool_t   b_thread;                                                  \
    vlc_thread_t thread_id;                                                 \
Sam Hocevar's avatar
Sam Hocevar committed
240 241 242 243
                                                                            \
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
                                                                            \
    volatile vlc_bool_t b_error;                    /* set by the object */ \
    volatile vlc_bool_t b_die;                     /* set by the outside */ \
    volatile vlc_bool_t b_dead;                     /* set by the object */ \
                                                                            \
    vlc_t *         p_vlc;                           /* root of all evil */ \
                                                                            \
    volatile int    i_refcount;                                             \
    vlc_object_t ** pp_parents;                           /* our parents */ \
    volatile int    i_parents;                                              \
    vlc_object_t ** pp_children;                         /* our children */ \
    volatile int    i_children;                                             \
                                                                            \
    /* Just a reminder so that people don't cast garbage */                 \
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \

/* The real vlc_object_t type. Yes, it's that simple :-) */
261
struct vlc_object_t
262 263 264 265 266 267 268
{
    VLC_COMMON_MEMBERS
};

/* CAST_TO_VLC_OBJECT: attempt at doing a clever cast */
#define CAST_TO_VLC_OBJECT( x ) \
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
269

Sam Hocevar's avatar
 
Sam Hocevar committed
270 271 272 273 274 275
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

276
#elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
Sam Hocevar's avatar
 
Sam Hocevar committed
277 278 279 280 281 282 283 284 285 286
#   include <netinet/in.h>

#endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */

/* CEIL: division with round to nearest greater integer */
#define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )

/* PAD: PAD(n, d) = CEIL(n ,d) * d */
#define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )

Sam Hocevar's avatar
 
Sam Hocevar committed
287 288 289
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
290
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
291 292
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
293 294 295 296 297
#endif

/* MSB (big endian)/LSB (little endian) conversions - network order is always
 * MSB, and should be used for both network communications and files. Note that
 * byte orders other than little and big endians are not supported, but only
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
 * the VAX seems to have such exotic properties. */
static inline u16 U16_AT( void * _p )
{
    u8 * p = (u8 *)_p;
    return ( ((u16)p[0] << 8) | p[1] );
}
static inline u32 U32_AT( void * _p )
{
    u8 * p = (u8 *)_p;
    return ( ((u32)p[0] << 24) | ((u32)p[1] << 16) | ((u32)p[2] << 8) | p[3] );
}
static inline u64 U64_AT( void * _p )
{
    u8 * p = (u8 *)_p;
    return ( ((u64)p[0] << 56) | ((u64)p[1] << 48) | ((u64)p[2] << 40) 
              | ((u64)p[3] << 32) | ((u64)p[4] << 24) | ((u64)p[5] << 16)
              | ((u64)p[6] << 8) | p[7] );
}
Sam Hocevar's avatar
 
Sam Hocevar committed
316
#if WORDS_BIGENDIAN
317 318
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
319
#   define hton64(i)   ( i )
320 321
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
322 323
#   define ntoh64(i)   ( i )
#else
324 325 326 327 328 329
#   define hton16(i)   U16_AT(&i)
#   define hton32(i)   U32_AT(&i)
#   define hton64(i)   U64_AT(&i)
#   define ntoh16(i)   U16_AT(&i)
#   define ntoh32(i)   U32_AT(&i)
#   define ntoh64(i)   U64_AT(&i)
Sam Hocevar's avatar
 
Sam Hocevar committed
330 331 332 333 334 335 336 337 338
#endif

/* Alignment of critical static data structures */
#ifdef ATTRIBUTE_ALIGNED_MAX
#   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
#else
#   define ATTR_ALIGN(align)
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
339 340 341 342 343 344 345 346 347 348 349 350
/* Alignment of critical dynamic data structure
 *
 * Not all platforms support memalign so we provide a vlc_memalign wrapper
 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 * *pp_orig is the pointer that has to be freed afterwards.
 */
#if 0
#ifdef HAVE_POSIX_MEMALIGN
#   define vlc_memalign(align,size,pp_orig) \
    ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
#endif
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
351 352 353
#ifdef HAVE_MEMALIGN
    /* Some systems have memalign() but no declaration for it */
    void * memalign( size_t align, size_t size );
Gildas Bazin's avatar
 
Gildas Bazin committed
354

355
#   define vlc_memalign(pp_orig,align,size) \
Gildas Bazin's avatar
 
Gildas Bazin committed
356 357 358
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
359 360 361
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
362
                       & (~(unsigned long)(align-1)) ) \
363
        : NULL )
Gildas Bazin's avatar
 
Gildas Bazin committed
364

Sam Hocevar's avatar
 
Sam Hocevar committed
365 366
#endif

367 368 369 370 371
/* strndup (defined in src/misc/extras.c) */
#ifndef HAVE_STRNDUP
char * strndup( const char *s, size_t n );
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
372

Sam Hocevar's avatar
 
Sam Hocevar committed
373 374
#define I64C(x)         x##LL

375
#ifdef WIN32
Sam Hocevar's avatar
 
Sam Hocevar committed
376
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
377
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
378 379 380 381
#       define __attribute__(x)
#       define __inline__      __inline
#       define strncasecmp     strnicmp
#       define strcasecmp      stricmp
Gildas Bazin's avatar
 
Gildas Bazin committed
382
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
383 384 385 386
#       define S_ISBLK(m)      (0)
#       define S_ISCHR(m)      (0)
#       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
#       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
Gildas Bazin's avatar
 
Gildas Bazin committed
387
#       undef I64C
Sam Hocevar's avatar
 
Sam Hocevar committed
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
#       define I64C(x)         x##i64
#   endif

/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
typedef long long _off_t;
typedef _off_t off_t;
#           define _OFF_T_
#       else
#           define off_t long long
#       endif
#   endif

#   if defined( _MSC_VER )
#       if !defined( _OFF_T_DEFINED )
typedef __int64 off_t;
#           define _OFF_T_DEFINED
#       else
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
411
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
412
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
413
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
414 415
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
416 417 418 419
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
#   endif

Sam Hocevar's avatar
 
Sam Hocevar committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
#   ifndef snprintf
#       define snprintf _snprintf  /* snprintf not defined in mingw32 (bug?) */
#   endif

#endif

/*****************************************************************************
 * CPU capabilities
 *****************************************************************************/
#define CPU_CAPABILITY_NONE    0
#define CPU_CAPABILITY_486     (1<<0)
#define CPU_CAPABILITY_586     (1<<1)
#define CPU_CAPABILITY_PPRO    (1<<2)
#define CPU_CAPABILITY_MMX     (1<<3)
#define CPU_CAPABILITY_3DNOW   (1<<4)
#define CPU_CAPABILITY_MMXEXT  (1<<5)
#define CPU_CAPABILITY_SSE     (1<<6)
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
443
#ifndef PACKAGE /* Borland C++ uses this ! */
Sam Hocevar's avatar
 
Sam Hocevar committed
444 445 446 447
#define PACKAGE VLC_PACKAGE
#endif
#define VERSION VLC_VERSION

Sam Hocevar's avatar
 
Sam Hocevar committed
448
#if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( MODULE_NAME_IS_gnome )
Sam Hocevar's avatar
 
Sam Hocevar committed
449
#   include <libintl.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
450 451 452 453 454 455 456 457
#   undef _
#   define _(String) dgettext (PACKAGE, String)
#   ifdef gettext_noop
#       define N_(String) gettext_noop (String)
#   else
#       define N_(String) (String)
#   endif
#elif !defined( MODULE_NAME_IS_gnome )
Sam Hocevar's avatar
 
Sam Hocevar committed
458 459 460 461
#   define _(String) (String)
#   define N_(String) (String)
#endif

462
/*****************************************************************************
463
 * Plug-in stuff
464
 *****************************************************************************/
465
#include "vlc_symbols.h"