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