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