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