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