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.77 2003/09/12 18:34:44 fenrir 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 #   undef HAVE_INTTYPES_H
  40 #   undef off_t
  41 #endif
  42
  43 #include "vlc_config.h"
  44 #include "modules_inner.h"
  45
  46 /*****************************************************************************
  47  * Required system headers
  48  *****************************************************************************/
  49 #include <stdarg.h>
  50
  51 #ifdef HAVE_STRING_H
  52 #   include <string.h>                                         /* strerror() */
  53 #endif
  54
  55 #ifdef HAVE_SYS_TYPES_H
  56 #   include <sys/types.h>
  57 #endif
  58
  59 /*****************************************************************************
  60  * Basic types definitions
  61  *****************************************************************************/
  62 #if defined( HAVE_STDINT_H )
  63 #   include <stdint.h>
  64 #elif defined( HAVE_INTTYPES_H )
  65 #   include <inttypes.h>
  66 #elif defined( SYS_CYGWIN )
  67 #   include <sys/types.h>
  68     /* Cygwin only defines half of these... */
  69     typedef u_int8_t            uint8_t;
  70     typedef u_int16_t           uint16_t;
  71     typedef u_int32_t           uint32_t;
  72     typedef u_int64_t           uint64_t;
  73 #else
  74     /* Fallback types (very x86-centric, sorry) */
  75     typedef unsigned char       uint8_t;
  76     typedef signed char         int8_t;
  77     typedef unsigned short      uint16_t;
  78     typedef signed short        int16_t;
  79     typedef unsigned int        uint32_t;
  80     typedef signed int          int32_t;
  81 #   if defined( _MSC_VER ) \
  82       || defined( UNDER_CE ) \
  83       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
  84     typedef unsigned __int64    uint64_t;
  85     typedef signed __int64      int64_t;
  86 #   else
  87     typedef unsigned long long  uint64_t;
  88     typedef signed long long    int64_t;
  89 #   endif
  90 #endif
  91
  92 typedef uint8_t                 byte_t;
  93
  94 /* ptrdiff_t definition */
  95 #ifdef HAVE_STDDEF_H
  96 #   include <stddef.h>
  97 #else
  98 #   include <malloc.h>
  99 #   ifndef _PTRDIFF_T
 100 #       define _PTRDIFF_T
 101 /* Not portable in a 64-bit environment. */
 102 typedef int                 ptrdiff_t;
 103 #   endif
 104 #endif
 105
 106 #if defined( WIN32 )
 107 #   include <malloc.h>
 108 #define PATH_MAX MAX_PATH
 109 #endif
 110
 111 #if defined( WIN32 ) || defined( UNDER_CE )
 112 typedef int                 ssize_t;
 113 #endif
 114
 115 /* Counter for statistics and profiling */
 116 typedef unsigned long       count_t;
 117
 118 /* DCT elements types */
 119 typedef int16_t             dctelem_t;
 120
 121 /* Video buffer types */
 122 typedef uint8_t             yuv_data_t;
 123
 124 /* Audio volume */
 125 typedef uint16_t            audio_volume_t;
 126
 127 #ifndef HAVE_SOCKLEN_T
 128 typedef int                 socklen_t;
 129 #endif
 130
 131 /*****************************************************************************
 132  * Old types definitions
 133  *****************************************************************************
 134  * We still provide these types because most of the VLC code uses them
 135  * instead of the C9x types. They should be removed when the transition is
 136  * complete (probably in 10 years).
 137  *****************************************************************************/
 138 typedef uint8_t    u8;
 139 typedef int8_t     s8;
 140 typedef uint16_t   u16;
 141 typedef int16_t    s16;
 142 typedef uint32_t   u32;
 143 typedef int32_t    s32;
 144 typedef uint64_t   u64;
 145 typedef int64_t    s64;
 146
 147 /*****************************************************************************
 148  * mtime_t: high precision date or time interval
 149  *****************************************************************************
 150  * Store a high precision date or time interval. The maximum precision is the
 151  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
 152  * time interval is then 292271 years, which should be long enough for any
 153  * video). Dates are stored as microseconds since a common date (usually the
 154  * epoch). Note that date and time intervals can be manipulated using regular
 155  * arithmetic operators, and that no special functions are required.
 156  *****************************************************************************/
 157 typedef int64_t mtime_t;
 158
 159 /*****************************************************************************
 160  * The vlc_fourcc_t type.
 161  *****************************************************************************
 162  * See http://www.webartz.com/fourcc/ for a very detailed list.
 163  *****************************************************************************/
 164 typedef uint32_t vlc_fourcc_t;
 165
 166 #ifdef WORDS_BIGENDIAN
 167 #   define VLC_FOURCC( a, b, c, d ) \
 168         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 169            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 170 #   define VLC_TWOCC( a, b ) \
 171         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 172
 173 #else
 174 #   define VLC_FOURCC( a, b, c, d ) \
 175         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 176            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 177 #   define VLC_TWOCC( a, b ) \
 178         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 179
 180 #endif
 181
 182 /*****************************************************************************
 183  * Classes declaration
 184  *****************************************************************************/
 185
 186 /* Internal types */
 187 typedef struct libvlc_t libvlc_t;
 188 typedef struct vlc_t vlc_t;
 189 typedef struct variable_t variable_t;
 190
 191 /* Messages */
 192 typedef struct msg_bank_t msg_bank_t;
 193 typedef struct msg_subscription_t msg_subscription_t;
 194
 195 /* Playlist */
 196 typedef struct playlist_t playlist_t;
 197 typedef struct playlist_item_t playlist_item_t;
 198
 199 /* Modules */
 200 typedef struct module_bank_t module_bank_t;
 201 typedef struct module_t module_t;
 202 typedef struct module_config_t module_config_t;
 203 typedef struct module_symbols_t module_symbols_t;
 204
 205 /* Interface */
 206 typedef struct intf_thread_t intf_thread_t;
 207 typedef struct intf_sys_t intf_sys_t;
 208 typedef struct intf_console_t intf_console_t;
 209 typedef struct intf_msg_t intf_msg_t;
 210 typedef struct intf_channel_t intf_channel_t;
 211
 212 /* Input */
 213 typedef struct input_thread_t input_thread_t;
 214 typedef struct input_channel_t input_channel_t;
 215 typedef struct input_area_t input_area_t;
 216 typedef struct input_buffers_t input_buffers_t;
 217 typedef struct input_socket_t input_socket_t;
 218 typedef struct input_info_t input_info_t;
 219 typedef struct input_info_category_t input_info_category_t;
 220 typedef struct access_sys_t access_sys_t;
 221 typedef struct demux_sys_t demux_sys_t;
 222 typedef struct es_descriptor_t es_descriptor_t;
 223 typedef struct es_sys_t es_sys_t;
 224 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
 225 typedef struct pgrm_sys_t pgrm_sys_t;
 226 typedef struct stream_descriptor_t stream_descriptor_t;
 227 typedef struct stream_sys_t stream_sys_t;
 228
 229 /* NInput */
 230 typedef struct stream_t stream_t;
 231 typedef struct es_out_t     es_out_t;
 232 typedef struct es_out_id_t  es_out_id_t;
 233 typedef struct es_out_sys_t es_out_sys_t;
 234
 235
 236 /* Audio */
 237 typedef struct aout_instance_t aout_instance_t;
 238 typedef struct aout_sys_t aout_sys_t;
 239 typedef struct aout_fifo_t aout_fifo_t;
 240 typedef struct aout_input_t aout_input_t;
 241 typedef struct aout_buffer_t aout_buffer_t;
 242 typedef struct audio_sample_format_t audio_sample_format_t;
 243 typedef struct audio_date_t audio_date_t;
 244
 245 /* Video */
 246 typedef struct vout_thread_t vout_thread_t;
 247 typedef struct vout_font_t vout_font_t;
 248 typedef struct vout_sys_t vout_sys_t;
 249 typedef struct chroma_sys_t chroma_sys_t;
 250 typedef struct picture_t picture_t;
 251 typedef struct picture_sys_t picture_sys_t;
 252 typedef struct picture_heap_t picture_heap_t;
 253 typedef struct subpicture_t subpicture_t;
 254 typedef struct subpicture_sys_t subpicture_sys_t;
 255 typedef struct vout_synchro_t vout_synchro_t;
 256 typedef struct text_renderer_sys_t text_renderer_sys_t;
 257 typedef struct text_style_t text_style_t;
 258
 259 /* Stream output */
 260 typedef struct sout_instance_t sout_instance_t;
 261 typedef struct sout_fifo_t sout_fifo_t;
 262 typedef struct sout_input_t sout_input_t;
 263 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 264 typedef struct sout_buffer_t sout_buffer_t;
 265 typedef struct sout_access_out_t sout_access_out_t;
 266 typedef struct sout_mux_t sout_mux_t;
 267 typedef struct sout_stream_t    sout_stream_t;
 268 typedef struct sout_cfg_t       sout_cfg_t;
 269 typedef struct sout_format_t    sout_format_t;
 270 /*typedef struct sap_session_t    sap_session_t;
 271 typedef struct slp_session_t    slp_session_t;*/
 272
 273 /* Decoders */
 274 typedef struct decoder_fifo_t decoder_fifo_t;
 275 typedef struct decoder_t      decoder_t;
 276 typedef struct decoder_sys_t  decoder_sys_t;
 277
 278 /* Misc */
 279 typedef struct data_packet_t data_packet_t;
 280 typedef struct data_buffer_t data_buffer_t;
 281 typedef struct stream_position_t stream_position_t;
 282 typedef struct stream_ctrl_t stream_ctrl_t;
 283 typedef struct pes_packet_t pes_packet_t;
 284 typedef struct bit_stream_t bit_stream_t;
 285 typedef struct network_socket_t network_socket_t;
 286 typedef struct iso639_lang_t iso639_lang_t;
 287
 288 /* block */
 289 typedef struct block_t      block_t;
 290 typedef struct block_fifo_t block_fifo_t;
 291
 292 /*****************************************************************************
 293  * Variable callbacks
 294  *****************************************************************************/
 295 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 296                                    char const *,            /* variable name */
 297                                    vlc_value_t,                 /* old value */
 298                                    vlc_value_t,                 /* new value */
 299                                    void * );                /* callback data */
 300
 301 /*****************************************************************************
 302  * Plug-in stuff
 303  *****************************************************************************/
 304 #ifndef __PLUGIN__
 305 #   define VLC_EXPORT( type, name, args ) type name args
 306 #else
 307 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
 308     extern module_symbols_t* p_symbols;
 309 #endif
 310
 311 /*****************************************************************************
 312  * OS-specific headers and thread types
 313  *****************************************************************************/
 314 #if defined( WIN32 ) || defined( UNDER_CE )
 315 #   define WIN32_LEAN_AND_MEAN
 316 #   include <windows.h>
 317 #   define IS_WINNT ( GetVersion() < 0x80000000 )
 318 #endif
 319
 320 #include "vlc_threads.h"
 321
 322 /*****************************************************************************
 323  * Common structure members
 324  *****************************************************************************/
 325
 326 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 327 #define VLC_COMMON_MEMBERS                                                  \
 328 /** \name VLC_COMMON_MEMBERS                                                \
 329  * these members are common for all vlc objects                             \
 330  */                                                                         \
 331 /**@{*/                                                                     \
 332     int   i_object_id;                                                      \
 333     int   i_object_type;                                                    \
 334     char *psz_object_type;                                                  \
 335     char *psz_object_name;                                                  \
 336                                                                             \
 337     /* Thread properties, if any */                                         \
 338     vlc_bool_t   b_thread;                                                  \
 339     vlc_thread_t thread_id;                                                 \
 340                                                                             \
 341     /* Object access lock */                                                \
 342     vlc_mutex_t  object_lock;                                               \
 343     vlc_cond_t   object_wait;                                               \
 344                                                                             \
 345     /* Object properties */                                                 \
 346     volatile vlc_bool_t b_error;                  /**< set by the object */ \
 347     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
 348     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
 349     volatile vlc_bool_t b_attached;               /**< set by the object */ \
 350                                                                             \
 351     /* Object variables */                                                  \
 352     vlc_mutex_t     var_lock;                                               \
 353     int             i_vars;                                                 \
 354     variable_t *    p_vars;                                                 \
 355                                                                             \
 356     /* Stuff related to the libvlc structure */                             \
 357     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
 358     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
 359                                                                             \
 360     volatile int    i_refcount;                         /**< usage count */ \
 361     vlc_object_t *  p_parent;                            /**< our parent */ \
 362     vlc_object_t ** pp_children;                       /**< our children */ \
 363     volatile int    i_children;                                             \
 364                                                                             \
 365     /* Private data */                                                      \
 366     void *          p_private;                                              \
 367                                                                             \
 368     /** Just a reminder so that people don't cast garbage */                \
 369     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
 370 /**@}*/                                                                     \
 371
 372 /* VLC_OBJECT: attempt at doing a clever cast */
 373 #define VLC_OBJECT( x ) \
 374     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 375
 376 /*****************************************************************************
 377  * Macros and inline functions
 378  *****************************************************************************/
 379 #ifdef NTOHL_IN_SYS_PARAM_H
 380 #   include <sys/param.h>
 381
 382 #elif !defined(WIN32) && !defined( UNDER_CE )
 383 #   include <netinet/in.h>
 384
 385 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 386
 387 /* CEIL: division with round to nearest greater integer */
 388 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 389
 390 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 391 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 392
 393 /* __MAX and __MIN: self explanatory */
 394 #ifndef __MAX
 395 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 396 #endif
 397 #ifndef __MIN
 398 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 399 #endif
 400
 401 /* Dynamic array handling: realloc array, move data, increment position */
 402 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
 403     do                                                                        \
 404     {                                                                         \
 405         if( i_oldsize )                                                       \
 406         {                                                                     \
 407             (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) );  \
 408         }                                                                     \
 409         else                                                                  \
 410         {                                                                     \
 411             (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) );         \
 412         }                                                                     \
 413         if( (i_oldsize) - (i_pos) )                                           \
 414         {                                                                     \
 415             memmove( (p_ar) + (i_pos) + 1,                                    \
 416                      (p_ar) + (i_pos),                                        \
 417                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
 418         }                                                                     \
 419         (p_ar)[i_pos] = elem;                                                 \
 420         (i_oldsize)++;                                                        \
 421     }                                                                         \
 422     while( 0 )
 423
 424 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
 425     do                                                                        \
 426     {                                                                         \
 427         if( (i_oldsize) - (i_pos) - 1 )                                       \
 428         {                                                                     \
 429             memmove( (p_ar) + (i_pos),                                        \
 430                      (p_ar) + (i_pos) + 1,                                    \
 431                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
 432         }                                                                     \
 433         if( i_oldsize > 1 )                                                   \
 434         {                                                                     \
 435             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
 436         }                                                                     \
 437         else                                                                  \
 438         {                                                                     \
 439             free( p_ar );                                                     \
 440             (p_ar) = NULL;                                                    \
 441         }                                                                     \
 442         (i_oldsize)--;                                                        \
 443     }                                                                         \
 444     while( 0 )
 445
 446
 447 #define TAB_APPEND( count, tab, p )             \
 448     if( (count) > 0 )                           \
 449     {                                           \
 450         (tab) = realloc( (tab), sizeof( void ** ) * ( (count) + 1 ) ); \
 451     }                                           \
 452     else                                        \
 453     {                                           \
 454         (tab) = malloc( sizeof( void ** ) );    \
 455     }                                           \
 456     (void**)(tab)[(count)] = (void*)(p);        \
 457     (count)++
 458
 459 #define TAB_FIND( count, tab, p, index )        \
 460     {                                           \
 461         int _i_;                                \
 462         (index) = -1;                           \
 463         for( _i_ = 0; _i_ < (count); _i_++ )    \
 464         {                                       \
 465             if((void**)(tab)[_i_]==(void*)(p))  \
 466             {                                   \
 467                 (index) = _i_;                  \
 468                 break;                          \
 469             }                                   \
 470         }                                       \
 471     }
 472
 473 #define TAB_REMOVE( count, tab, p )             \
 474     {                                           \
 475         int _i_index_;                          \
 476         TAB_FIND( count, tab, p, _i_index_ );   \
 477         if( _i_index_ >= 0 )                    \
 478         {                                       \
 479             if( (count) > 1 )                     \
 480             {                                   \
 481                 memmove( ((void**)(tab) + _i_index_),    \
 482                          ((void**)(tab) + _i_index_+1),  \
 483                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
 484             }                                   \
 485             else                                \
 486             {                                   \
 487                 free( tab );                    \
 488                 (tab) = NULL;                   \
 489             }                                   \
 490             (count)--;                          \
 491         }                                       \
 492     }
 493
 494 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 495  * MSB, and should be used for both network communications and files. Note that
 496  * byte orders other than little and big endians are not supported, but only
 497  * the VAX seems to have such exotic properties. */
 498 static inline uint16_t U16_AT( void * _p )
 499 {
 500     uint8_t * p = (uint8_t *)_p;
 501     return ( ((uint16_t)p[0] << 8) | p[1] );
 502 }
 503 static inline uint32_t U32_AT( void * _p )
 504 {
 505     uint8_t * p = (uint8_t *)_p;
 506     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 507               | ((uint32_t)p[2] << 8) | p[3] );
 508 }
 509 static inline uint64_t U64_AT( void * _p )
 510 {
 511     uint8_t * p = (uint8_t *)_p;
 512     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 513               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 514               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 515               | ((uint64_t)p[6] << 8) | p[7] );
 516 }
 517
 518 static inline uint16_t GetWLE( void * _p )
 519 {
 520     uint8_t * p = (uint8_t *)_p;
 521     return ( ((uint16_t)p[1] << 8) | p[0] );
 522 }
 523 static inline uint32_t GetDWLE( void * _p )
 524 {
 525     uint8_t * p = (uint8_t *)_p;
 526     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 527               | ((uint32_t)p[1] << 8) | p[0] );
 528 }
 529 static inline uint64_t GetQWLE( void * _p )
 530 {
 531     uint8_t * p = (uint8_t *)_p;
 532     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 533               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 534               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 535               | ((uint64_t)p[1] << 8) | p[0] );
 536 }
 537
 538 #define GetWBE( p )     U16_AT( p )
 539 #define GetDWBE( p )    U32_AT( p )
 540 #define GetQWBE( p )    U64_AT( p )
 541
 542
 543 #if WORDS_BIGENDIAN
 544 #   define hton16(i)   ( i )
 545 #   define hton32(i)   ( i )
 546 #   define hton64(i)   ( i )
 547 #   define ntoh16(i)   ( i )
 548 #   define ntoh32(i)   ( i )
 549 #   define ntoh64(i)   ( i )
 550 #else
 551 #   define hton16(i)   U16_AT(&i)
 552 #   define hton32(i)   U32_AT(&i)
 553 #   define hton64(i)   U64_AT(&i)
 554 #   define ntoh16(i)   U16_AT(&i)
 555 #   define ntoh32(i)   U32_AT(&i)
 556 #   define ntoh64(i)   U64_AT(&i)
 557 #endif
 558
 559 /* Format string sanity checks */
 560 #ifdef HAVE_ATTRIBUTE_FORMAT
 561 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
 562 #else
 563 #   define ATTRIBUTE_FORMAT(x,y)
 564 #endif
 565
 566 /* Alignment of critical static data structures */
 567 #ifdef ATTRIBUTE_ALIGNED_MAX
 568 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
 569 #else
 570 #   define ATTR_ALIGN(align)
 571 #endif
 572
 573 /* Alignment of critical dynamic data structure
 574  *
 575  * Not all platforms support memalign so we provide a vlc_memalign wrapper
 576  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 577  * *pp_orig is the pointer that has to be freed afterwards.
 578  */
 579 #if 0
 580 #ifdef HAVE_POSIX_MEMALIGN
 581 #   define vlc_memalign(align,size,pp_orig) \
 582     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
 583 #endif
 584 #endif
 585 #ifdef HAVE_MEMALIGN
 586     /* Some systems have memalign() but no declaration for it */
 587     void * memalign( size_t align, size_t size );
 588
 589 #   define vlc_memalign(pp_orig,align,size) \
 590     ( *(pp_orig) = memalign( align, size ) )
 591
 592 #else /* We don't have any choice but to align manually */
 593 #   define vlc_memalign(pp_orig,align,size) \
 594     (( *(pp_orig) = malloc( size + align - 1 )) \
 595         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
 596                        & (~(unsigned long)(align-1)) ) \
 597         : NULL )
 598
 599 #endif
 600
 601 /* Stuff defined in src/extras/libc.c */
 602 #ifndef HAVE_STRDUP
 603 #   define strdup vlc_strdup
 604     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
 605 #elif !defined(__PLUGIN__)
 606 #   define vlc_strdup NULL
 607 #endif
 608
 609 #ifndef HAVE_STRNDUP
 610 #   if defined(STRNDUP_IN_GNOME_H) && \
 611         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 612          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
 613         /* Do nothing: gnome.h defines strndup for us */
 614 #   else
 615 #       define strndup vlc_strndup
 616         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
 617 #   endif
 618 #elif !defined(__PLUGIN__)
 619 #   define vlc_strndup NULL
 620 #endif
 621
 622 #ifndef HAVE_ATOF
 623 #   define atof vlc_atof
 624     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
 625 #elif !defined(__PLUGIN__)
 626 #   define vlc_atof NULL
 627 #endif
 628
 629 #ifndef HAVE_ATOLL
 630 #   define atoll vlc_atoll
 631     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
 632 #elif !defined(__PLUGIN__)
 633 #   define vlc_atoll NULL
 634 #endif
 635
 636 #ifndef HAVE_GETENV
 637 #   define getenv vlc_getenv
 638     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
 639 #elif !defined(__PLUGIN__)
 640 #   define vlc_getenv NULL
 641 #endif
 642
 643 #ifndef HAVE_STRCASECMP
 644 #   ifdef HAVE_STRICMP
 645 #       define strcasecmp stricmp
 646 #       if !defined(__PLUGIN__)
 647 #           define vlc_strcasecmp NULL
 648 #       endif
 649 #   elif !defined(__PLUGIN__)
 650 #       define strcasecmp vlc_strcasecmp
 651         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
 652 #   endif
 653 #elif !defined(__PLUGIN__)
 654 #   define vlc_strcasecmp NULL
 655 #endif
 656
 657 #ifndef HAVE_STRNCASECMP
 658 #   ifdef HAVE_STRNICMP
 659 #       define strncasecmp strnicmp
 660 #       if !defined(__PLUGIN__)
 661 #           define vlc_strncasecmp NULL
 662 #       endif
 663 #   elif !defined(__PLUGIN__)
 664 #       define strncasecmp vlc_strncasecmp
 665         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
 666 #   endif
 667 #elif !defined(__PLUGIN__)
 668 #   define vlc_strncasecmp NULL
 669 #endif
 670
 671 /* Format type specifiers for 64 bits numbers */
 672 #if !defined(WIN32) && !defined(UNDER_CE)
 673 #   define I64Fd "%lld"
 674 #   define I64Fi "%lli"
 675 #   define I64Fo "%llo"
 676 #   define I64Fu "%llu"
 677 #   define I64Fx "%llx"
 678 #   define I64FX "%llX"
 679 #else
 680 #   define I64Fd "%I64d"
 681 #   define I64Fi "%I64i"
 682 #   define I64Fo "%I64o"
 683 #   define I64Fu "%I64u"
 684 #   define I64Fx "%I64x"
 685 #   define I64FX "%I64X"
 686 #endif /* defined(WIN32)||defined(UNDER_CE) */
 687
 688 /* 64 bits integer constant suffix */
 689 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
 690 #   define I64C(x)         x##LL
 691 #else
 692 #   define I64C(x)         x##i64
 693 #endif /* defined(WIN32)||defined(UNDER_CE) */
 694
 695 #if defined(WIN32) || defined(UNDER_CE)
 696 /* win32, cl and icl support */
 697 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 698 #       define __attribute__(x)
 699 #       define __inline__      __inline
 700 #       define S_IFBLK         0x3000  /* Block */
 701 #       define S_ISBLK(m)      (0)
 702 #       define S_ISCHR(m)      (0)
 703 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 704 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 705 #   endif
 706
 707 /* several type definitions */
 708 #   if defined( __MINGW32__ )
 709 #       if !defined( _OFF_T_ )
 710 typedef long long _off_t;
 711 typedef _off_t off_t;
 712 #           define _OFF_T_
 713 #       else
 714 #           ifdef off_t
 715 #               undef off_t
 716 #           endif
 717 #           define off_t long long
 718 #       endif
 719 #   endif
 720
 721 #   if defined( _MSC_VER )
 722 #       if !defined( _OFF_T_DEFINED )
 723 typedef __int64 off_t;
 724 #           define _OFF_T_DEFINED
 725 #       else
 726 #           define off_t __int64
 727 #       endif
 728 #   endif
 729
 730 #   if defined( __BORLANDC__ )
 731 #       undef off_t
 732 #       define off_t unsigned __int64
 733 #   endif
 734
 735 #   ifndef O_NONBLOCK
 736 #       define O_NONBLOCK 0
 737 #   endif
 738
 739 #   ifndef alloca
 740 #       define alloca _alloca
 741 #   endif
 742
 743     /* These two are not defined in mingw32 (bug?) */
 744 #   ifndef snprintf
 745 #       define snprintf _snprintf
 746 #   endif
 747 #   ifndef vsnprintf
 748 #       define vsnprintf _vsnprintf
 749 #   endif
 750
 751 #endif
 752
 753 /* lseek (defined in src/extras/libc.c) */
 754 #ifndef HAVE_LSEEK
 755 #   define lseek vlc_lseek
 756     VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
 757 #elif !defined(__PLUGIN__)
 758 #   define vlc_lseek NULL
 759 #endif
 760
 761 /*****************************************************************************
 762  * CPU capabilities
 763  *****************************************************************************/
 764 #define CPU_CAPABILITY_NONE    0
 765 #define CPU_CAPABILITY_486     (1<<0)
 766 #define CPU_CAPABILITY_586     (1<<1)
 767 #define CPU_CAPABILITY_PPRO    (1<<2)
 768 #define CPU_CAPABILITY_MMX     (1<<3)
 769 #define CPU_CAPABILITY_3DNOW   (1<<4)
 770 #define CPU_CAPABILITY_MMXEXT  (1<<5)
 771 #define CPU_CAPABILITY_SSE     (1<<6)
 772 #define CPU_CAPABILITY_ALTIVEC (1<<16)
 773 #define CPU_CAPABILITY_FPU     (1<<31)
 774
 775 /*****************************************************************************
 776  * I18n stuff
 777  *****************************************************************************/
 778 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
 779
 780 #if defined( ENABLE_NLS ) && \
 781      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 782       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
 783     /* Declare nothing: gnome.h will do it for us */
 784 #elif defined( ENABLE_NLS )
 785 #if defined( HAVE_INCLUDED_GETTEXT )
 786 #   include "libintl.h"
 787 #else
 788 #   include <libintl.h>
 789 #endif
 790 #   undef _
 791 #if defined( __BORLANDC__ )
 792 #define _(String) vlc_dgettext (PACKAGE_TARNAME, String)
 793 #else
 794 #   define _(String) vlc_dgettext (PACKAGE, String)
 795 #endif
 796 #   define N_(String) ((char*)(String))
 797 #else
 798 #   define _(String) ((char*)(String))
 799 #   define N_(String) ((char*)(String))
 800 #endif
 801
 802 /*****************************************************************************
 803  * Additional vlc stuff
 804  *****************************************************************************/
 805 #include "vlc_symbols.h"
 806 #include "os_specific.h"
 807 #include "vlc_messages.h"
 808 #include "variables.h"
 809 #include "vlc_objects.h"
 810 #include "vlc_threads_funcs.h"
 811 #include "mtime.h"
 812 #include "modules.h"
 813 #include "main.h"
 814 #include "configuration.h"
 815
 816 #if defined( __BORLANDC__ )
 817 #   undef PACKAGE
 818 #   define PACKAGE
 819 #endif
 820