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-2005 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
   9  *          Vincent Seguin <seguin@via.ecp.fr>
  10  *          Gildas Bazin <gbazin@videolan.org>
  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(PACKAGE)
  42 #   undef PACKAGE_NAME
  43 #   define PACKAGE_NAME PACKAGE
  44 #endif
  45 #if defined(VERSION)
  46 #   undef PACKAGE_VERSION
  47 #   define PACKAGE_VERSION VERSION
  48 #endif
  49
  50 #if defined( __BORLANDC__ )
  51 #   undef HAVE_VARIADIC_MACROS
  52 #   undef HAVE_STDINT_H
  53 #   undef HAVE_INTTYPES_H
  54 #   undef off_t
  55 #elif defined( _MSC_VER )
  56 #   pragma warning( disable : 4244 )
  57 #endif
  58
  59 #include "vlc_config.h"
  60 #include "modules_inner.h"
  61
  62 /*****************************************************************************
  63  * Required system headers
  64  *****************************************************************************/
  65 #include <stdlib.h>
  66 #include <stdarg.h>
  67
  68 #ifdef HAVE_STRING_H
  69 #   include <string.h>                                         /* strerror() */
  70 #endif
  71
  72 #ifdef HAVE_SYS_TYPES_H
  73 #   include <sys/types.h>
  74 #endif
  75
  76 /*****************************************************************************
  77  * Basic types definitions
  78  *****************************************************************************/
  79 #if defined( HAVE_STDINT_H )
  80 #   include <stdint.h>
  81 #elif defined( HAVE_INTTYPES_H )
  82 #   include <inttypes.h>
  83 #elif defined( SYS_CYGWIN )
  84 #   include <sys/types.h>
  85     /* Cygwin only defines half of these... */
  86     typedef u_int8_t            uint8_t;
  87     typedef u_int16_t           uint16_t;
  88     typedef u_int32_t           uint32_t;
  89     typedef u_int64_t           uint64_t;
  90 #else
  91     /* Fallback types (very x86-centric, sorry) */
  92     typedef unsigned char       uint8_t;
  93     typedef signed char         int8_t;
  94     typedef unsigned short      uint16_t;
  95     typedef signed short        int16_t;
  96     typedef unsigned int        uint32_t;
  97     typedef signed int          int32_t;
  98 #   if defined( _MSC_VER ) \
  99       || defined( UNDER_CE ) \
 100       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
 101     typedef unsigned __int64    uint64_t;
 102     typedef signed __int64      int64_t;
 103 #   else
 104     typedef unsigned long long  uint64_t;
 105     typedef signed long long    int64_t;
 106 #   endif
 107     typedef uint32_t            uintptr_t;
 108     typedef int32_t             intptr_t;
 109 #endif
 110
 111 typedef uint8_t                 byte_t;
 112
 113 /* Systems that don't have stdint.h may not define INT64_MIN and
 114    INT64_MAX */
 115 #ifndef INT64_MIN
 116 #define INT64_MIN (-9223372036854775807LL-1)
 117 #endif
 118 #ifndef INT64_MAX
 119 #define INT64_MAX (9223372036854775807LL)
 120 #endif
 121
 122 /* ptrdiff_t definition */
 123 #ifdef HAVE_STDDEF_H
 124 #   include <stddef.h>
 125 #else
 126 #   include <malloc.h>
 127 #   ifndef _PTRDIFF_T
 128 #       define _PTRDIFF_T
 129 /* Not portable in a 64-bit environment. */
 130 typedef int                 ptrdiff_t;
 131 #   endif
 132 #endif
 133
 134 #if defined( WIN32 ) || defined( UNDER_CE )
 135 #   include <malloc.h>
 136 #   ifndef PATH_MAX
 137 #       define PATH_MAX MAX_PATH
 138 #   endif
 139 #endif
 140
 141 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
 142 typedef int                 ssize_t;
 143 #endif
 144
 145 /* Counter for statistics and profiling */
 146 typedef unsigned long       count_t;
 147
 148 /* DCT elements types */
 149 typedef int16_t             dctelem_t;
 150
 151 /* Video buffer types */
 152 typedef uint8_t             yuv_data_t;
 153
 154 /* Audio volume */
 155 typedef uint16_t            audio_volume_t;
 156
 157 #ifndef HAVE_SOCKLEN_T
 158 typedef int                 socklen_t;
 159 #endif
 160
 161 /**
 162  * High precision date or time interval
 163  *
 164  * Store a high precision date or time interval. The maximum precision is the
 165  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
 166  * time interval is then 292271 years, which should be long enough for any
 167  * video). Dates are stored as microseconds since a common date (usually the
 168  * epoch). Note that date and time intervals can be manipulated using regular
 169  * arithmetic operators, and that no special functions are required.
 170  */
 171 typedef int64_t mtime_t;
 172
 173 /**
 174  * The vlc_fourcc_t type.
 175  *
 176  * See http://www.webartz.com/fourcc/ for a very detailed list.
 177  */
 178 typedef uint32_t vlc_fourcc_t;
 179
 180 #ifdef WORDS_BIGENDIAN
 181 #   define VLC_FOURCC( a, b, c, d ) \
 182         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 183            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 184 #   define VLC_TWOCC( a, b ) \
 185         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 186
 187 #else
 188 #   define VLC_FOURCC( a, b, c, d ) \
 189         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 190            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 191 #   define VLC_TWOCC( a, b ) \
 192         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 193
 194 #endif
 195
 196 /*****************************************************************************
 197  * Classes declaration
 198  *****************************************************************************/
 199
 200 /* Internal types */
 201 typedef struct libvlc_t libvlc_t;
 202 typedef struct vlc_t vlc_t;
 203 typedef struct variable_t variable_t;
 204 typedef struct date_t date_t;
 205
 206 /* Messages */
 207 typedef struct msg_bank_t msg_bank_t;
 208 typedef struct msg_subscription_t msg_subscription_t;
 209
 210 /* Playlist */
 211
 212 /* FIXME */
 213 /**
 214  * Playlist commands
 215  */
 216 typedef enum {
 217     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
 218     PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
 219     PLAYLIST_VIEWPLAY,  /**< arg1= int, arg2= playlist_item_t*,*/
 220                         /**  arg3 = playlist_item_t*          , res=can fail */
 221     PLAYLIST_ITEMPLAY,  /** <arg1 = playlist_item_t *         , res=can fail */
 222     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
 223     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
 224     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
 225     PLAYLIST_GOTO,      /**< arg1=int                           res=can fail */
 226     PLAYLIST_VIEWGOTO,      /**< arg1=int                       res=can fail */
 227 } playlist_command_t;
 228
 229
 230 typedef struct playlist_t playlist_t;
 231 typedef struct playlist_item_t playlist_item_t;
 232 typedef struct playlist_view_t playlist_view_t;
 233 typedef struct playlist_export_t playlist_export_t;
 234 typedef struct services_discovery_t services_discovery_t;
 235 typedef struct services_discovery_sys_t services_discovery_sys_t;
 236 typedef struct playlist_add_t playlist_add_t;
 237 typedef struct playlist_preparse_t playlist_preparse_t;
 238
 239 /* Modules */
 240 typedef struct module_bank_t module_bank_t;
 241 typedef struct module_t module_t;
 242 typedef struct module_config_t module_config_t;
 243 typedef struct module_symbols_t module_symbols_t;
 244 typedef struct module_cache_t module_cache_t;
 245
 246 typedef struct config_category_t config_category_t;
 247
 248 /* Interface */
 249 typedef struct intf_thread_t intf_thread_t;
 250 typedef struct intf_sys_t intf_sys_t;
 251 typedef struct intf_console_t intf_console_t;
 252 typedef struct intf_msg_t intf_msg_t;
 253 typedef struct intf_channel_t intf_channel_t;
 254
 255 /* Input */
 256 typedef struct input_thread_t input_thread_t;
 257 typedef struct input_thread_sys_t input_thread_sys_t;
 258 typedef struct input_item_t input_item_t;
 259 typedef struct input_area_t input_area_t;
 260 typedef struct input_buffers_t input_buffers_t;
 261 typedef struct input_socket_t input_socket_t;
 262 typedef struct access_sys_t access_sys_t;
 263 typedef struct demux_sys_t demux_sys_t;
 264 typedef struct es_descriptor_t es_descriptor_t;
 265 typedef struct es_sys_t es_sys_t;
 266 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
 267 typedef struct pgrm_sys_t pgrm_sys_t;
 268 typedef struct stream_descriptor_t stream_descriptor_t;
 269 typedef struct seekpoint_t seekpoint_t;
 270 typedef struct info_t info_t;
 271 typedef struct info_category_t info_category_t;
 272
 273 /* Format */
 274 typedef struct audio_format_t audio_format_t;
 275 typedef struct video_format_t video_format_t;
 276 typedef struct subs_format_t subs_format_t;
 277 typedef struct es_format_t es_format_t;
 278 typedef struct video_palette_t video_palette_t;
 279
 280 /* NInput */
 281 typedef struct stream_sys_t stream_sys_t;
 282 typedef struct stream_t     stream_t;
 283 typedef struct es_out_t     es_out_t;
 284 typedef struct es_out_id_t  es_out_id_t;
 285 typedef struct es_out_sys_t es_out_sys_t;
 286 typedef struct demux_t  demux_t;
 287 typedef struct access_t access_t;
 288
 289 /* Audio */
 290 typedef struct aout_instance_t aout_instance_t;
 291 typedef struct aout_sys_t aout_sys_t;
 292 typedef struct aout_fifo_t aout_fifo_t;
 293 typedef struct aout_input_t aout_input_t;
 294 typedef struct aout_buffer_t aout_buffer_t;
 295 typedef audio_format_t audio_sample_format_t;
 296 typedef struct audio_date_t audio_date_t;
 297 typedef struct aout_filter_t aout_filter_t;
 298
 299 /* Video */
 300 typedef struct vout_thread_t vout_thread_t;
 301 typedef struct vout_sys_t vout_sys_t;
 302 typedef struct vout_synchro_t vout_synchro_t;
 303 typedef struct chroma_sys_t chroma_sys_t;
 304
 305 typedef video_format_t video_frame_format_t;
 306 typedef struct picture_t picture_t;
 307 typedef struct picture_sys_t picture_sys_t;
 308 typedef struct picture_heap_t picture_heap_t;
 309
 310 typedef struct spu_t spu_t;
 311 typedef struct subpicture_t subpicture_t;
 312 typedef struct subpicture_sys_t subpicture_sys_t;
 313 typedef struct subpicture_region_t subpicture_region_t;
 314 typedef struct text_style_t text_style_t;
 315
 316 typedef struct image_handler_t image_handler_t;
 317
 318 /* Stream output */
 319 typedef struct sout_instance_t sout_instance_t;
 320 typedef struct sout_instance_sys_t sout_instance_sys_t;
 321
 322 typedef struct sout_input_t sout_input_t;
 323 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 324
 325 typedef struct sout_access_out_t sout_access_out_t;
 326 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 327
 328 typedef struct sout_mux_t sout_mux_t;
 329 typedef struct sout_mux_sys_t sout_mux_sys_t;
 330
 331 typedef struct sout_stream_t    sout_stream_t;
 332 typedef struct sout_stream_sys_t sout_stream_sys_t;
 333
 334 typedef struct sout_cfg_t       sout_cfg_t;
 335 typedef struct sap_session_t    sap_session_t;
 336 typedef struct sap_address_t sap_address_t;
 337 typedef struct session_descriptor_t session_descriptor_t;
 338 typedef struct announce_method_t announce_method_t;
 339 typedef struct announce_handler_t announce_handler_t;
 340 typedef struct sap_handler_t sap_handler_t;
 341 //typedef struct slp_session_t    slp_session_t;
 342
 343 /* Decoders */
 344 typedef struct decoder_t      decoder_t;
 345 typedef struct decoder_sys_t  decoder_sys_t;
 346
 347 /* Encoders */
 348 typedef struct encoder_t      encoder_t;
 349 typedef struct encoder_sys_t  encoder_sys_t;
 350
 351 /* Filters */
 352 typedef struct filter_t filter_t;
 353 typedef struct filter_sys_t filter_sys_t;
 354
 355 /* Misc */
 356 typedef struct data_packet_t data_packet_t;
 357 typedef struct data_buffer_t data_buffer_t;
 358 typedef struct stream_ctrl_t stream_ctrl_t;
 359 typedef struct pes_packet_t pes_packet_t;
 360 typedef struct network_socket_t network_socket_t;
 361 typedef struct virtual_socket_t v_socket_t;
 362 typedef struct iso639_lang_t iso639_lang_t;
 363 typedef struct sockaddr sockaddr;
 364 typedef struct addrinfo addrinfo;
 365
 366 /* block */
 367 typedef struct block_t      block_t;
 368 typedef struct block_fifo_t block_fifo_t;
 369
 370 /* httpd */
 371 typedef struct httpd_t          httpd_t;
 372 typedef struct httpd_host_t     httpd_host_t;
 373 typedef struct httpd_url_t      httpd_url_t;
 374 typedef struct httpd_client_t   httpd_client_t;
 375 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 376 typedef struct httpd_message_t  httpd_message_t;
 377 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
 378 typedef struct httpd_file_t     httpd_file_t;
 379 typedef struct httpd_file_sys_t httpd_file_sys_t;
 380 typedef int (*httpd_file_callback_t)( httpd_file_sys_t*, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 381 typedef struct httpd_redirect_t httpd_redirect_t;
 382 typedef struct httpd_stream_t httpd_stream_t;
 383
 384 /* TLS support */
 385 typedef struct tls_t tls_t;
 386 typedef struct tls_server_t tls_server_t;
 387 typedef struct tls_session_t tls_session_t;
 388
 389 /* Hashing */
 390 typedef struct md5_s md5_t;
 391
 392 /* XML */
 393 typedef struct xml_t xml_t;
 394 typedef struct xml_sys_t xml_sys_t;
 395 typedef struct xml_reader_t xml_reader_t;
 396 typedef struct xml_reader_sys_t xml_reader_sys_t;
 397
 398 /* vod server */
 399 typedef struct vod_t     vod_t;
 400 typedef struct vod_sys_t vod_sys_t;
 401 typedef struct vod_media_t vod_media_t;
 402
 403 /* opengl */
 404 typedef struct opengl_t     opengl_t;
 405 typedef struct opengl_sys_t opengl_sys_t;
 406
 407 /* VLM */
 408 typedef struct vlm_t         vlm_t;
 409 typedef struct vlm_message_t vlm_message_t;
 410 typedef struct vlm_media_t   vlm_media_t;
 411 typedef struct vlm_schedule_t vlm_schedule_t;
 412
 413 /* divers */
 414 typedef struct vlc_meta_t    vlc_meta_t;
 415
 416
 417 /*****************************************************************************
 418  * Variable callbacks
 419  *****************************************************************************/
 420 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 421                                    char const *,            /* variable name */
 422                                    vlc_value_t,                 /* old value */
 423                                    vlc_value_t,                 /* new value */
 424                                    void * );                /* callback data */
 425
 426 /*****************************************************************************
 427  * Plug-in stuff
 428  *****************************************************************************/
 429 #ifndef __PLUGIN__
 430 #   define VLC_EXPORT( type, name, args ) type name args
 431 #else
 432 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
 433     extern module_symbols_t* p_symbols;
 434 #endif
 435
 436 /*****************************************************************************
 437  * OS-specific headers and thread types
 438  *****************************************************************************/
 439 #if defined( WIN32 ) || defined( UNDER_CE )
 440 #   define WIN32_LEAN_AND_MEAN
 441 #   include <windows.h>
 442 #   if defined( UNDER_CE )
 443 #      define IS_WINNT 0
 444 #   else
 445 #      define IS_WINNT ( GetVersion() < 0x80000000 )
 446 #   endif
 447 #endif
 448
 449 #include "vlc_threads.h"
 450
 451 /*****************************************************************************
 452  * Common structure members
 453  *****************************************************************************/
 454
 455 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 456 #define VLC_COMMON_MEMBERS                                                  \
 457 /** \name VLC_COMMON_MEMBERS                                                \
 458  * these members are common for all vlc objects                             \
 459  */                                                                         \
 460 /**@{*/                                                                     \
 461     int   i_object_id;                                                      \
 462     int   i_object_type;                                                    \
 463     char *psz_object_type;                                                  \
 464     char *psz_object_name;                                                  \
 465                                                                             \
 466     /* Thread properties, if any */                                         \
 467     vlc_bool_t   b_thread;                                                  \
 468     vlc_thread_t thread_id;                                                 \
 469                                                                             \
 470     /* Object access lock */                                                \
 471     vlc_mutex_t  object_lock;                                               \
 472     vlc_cond_t   object_wait;                                               \
 473                                                                             \
 474     /* Object properties */                                                 \
 475     volatile vlc_bool_t b_error;                  /**< set by the object */ \
 476     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
 477     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
 478     volatile vlc_bool_t b_attached;               /**< set by the object */ \
 479     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
 480                                                                             \
 481     /* Object variables */                                                  \
 482     vlc_mutex_t     var_lock;                                               \
 483     int             i_vars;                                                 \
 484     variable_t *    p_vars;                                                 \
 485                                                                             \
 486     /* Stuff related to the libvlc structure */                             \
 487     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
 488     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
 489                                                                             \
 490     volatile int    i_refcount;                         /**< usage count */ \
 491     vlc_object_t *  p_parent;                            /**< our parent */ \
 492     vlc_object_t ** pp_children;                       /**< our children */ \
 493     volatile int    i_children;                                             \
 494                                                                             \
 495     /* Private data */                                                      \
 496     void *          p_private;                                              \
 497                                                                             \
 498     /** Just a reminder so that people don't cast garbage */                \
 499     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
 500 /**@}*/                                                                     \
 501
 502 /* VLC_OBJECT: attempt at doing a clever cast */
 503 #define VLC_OBJECT( x ) \
 504     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 505
 506 /*****************************************************************************
 507  * Macros and inline functions
 508  *****************************************************************************/
 509 #ifdef NTOHL_IN_SYS_PARAM_H
 510 #   include <sys/param.h>
 511
 512 #elif !defined(WIN32) && !defined( UNDER_CE )
 513 #   include <netinet/in.h>
 514
 515 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 516
 517 /* CEIL: division with round to nearest greater integer */
 518 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 519
 520 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 521 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 522
 523 /* __MAX and __MIN: self explanatory */
 524 #ifndef __MAX
 525 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 526 #endif
 527 #ifndef __MIN
 528 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 529 #endif
 530
 531 static int64_t GCD( int64_t a, int64_t b )
 532 {
 533     if( b ) return GCD( b, a % b );
 534     else return a;
 535 }
 536
 537 /* Dynamic array handling: realloc array, move data, increment position */
 538 #if defined( _MSC_VER )
 539 #   define VLCCVP (void**) /* Work-around for broken compiler */
 540 #else
 541 #   define VLCCVP
 542 #endif
 543 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
 544     do                                                                        \
 545     {                                                                         \
 546         if( !i_oldsize ) (p_ar) = NULL;                                       \
 547         (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
 548         if( (i_oldsize) - (i_pos) )                                           \
 549         {                                                                     \
 550             memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos),                  \
 551                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
 552         }                                                                     \
 553         (p_ar)[i_pos] = elem;                                                 \
 554         (i_oldsize)++;                                                        \
 555     }                                                                         \
 556     while( 0 )
 557
 558 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
 559     do                                                                        \
 560     {                                                                         \
 561         if( (i_oldsize) - (i_pos) - 1 )                                       \
 562         {                                                                     \
 563             memmove( (p_ar) + (i_pos),                                        \
 564                      (p_ar) + (i_pos) + 1,                                    \
 565                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
 566         }                                                                     \
 567         if( i_oldsize > 1 )                                                   \
 568         {                                                                     \
 569             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
 570         }                                                                     \
 571         else                                                                  \
 572         {                                                                     \
 573             free( p_ar );                                                     \
 574             (p_ar) = NULL;                                                    \
 575         }                                                                     \
 576         (i_oldsize)--;                                                        \
 577     }                                                                         \
 578     while( 0 )
 579
 580
 581 #define TAB_APPEND( count, tab, p )             \
 582     if( (count) > 0 )                           \
 583     {                                           \
 584         (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
 585     }                                           \
 586     else                                        \
 587     {                                           \
 588         (tab) = malloc( sizeof( void ** ) );    \
 589     }                                           \
 590     (tab)[count] = (p);        \
 591     (count)++
 592
 593 #define TAB_FIND( count, tab, p, index )        \
 594     {                                           \
 595         int _i_;                                \
 596         (index) = -1;                           \
 597         for( _i_ = 0; _i_ < (count); _i_++ )    \
 598         {                                       \
 599             if( (tab)[_i_] == (p) )  \
 600             {                                   \
 601                 (index) = _i_;                  \
 602                 break;                          \
 603             }                                   \
 604         }                                       \
 605     }
 606
 607 #define TAB_REMOVE( count, tab, p )             \
 608     {                                           \
 609         int _i_index_;                          \
 610         TAB_FIND( count, tab, p, _i_index_ );   \
 611         if( _i_index_ >= 0 )                    \
 612         {                                       \
 613             if( (count) > 1 )                     \
 614             {                                   \
 615                 memmove( ((void**)(tab) + _i_index_),    \
 616                          ((void**)(tab) + _i_index_+1),  \
 617                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
 618             }                                   \
 619             (count)--;                          \
 620             if( (count) == 0 )                  \
 621             {                                   \
 622                 free( tab );                    \
 623                 (tab) = NULL;                   \
 624             }                                   \
 625         }                                       \
 626     }
 627
 628 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 629  * MSB, and should be used for both network communications and files. Note that
 630  * byte orders other than little and big endians are not supported, but only
 631  * the VAX seems to have such exotic properties. */
 632 static inline uint16_t U16_AT( void const * _p )
 633 {
 634     uint8_t * p = (uint8_t *)_p;
 635     return ( ((uint16_t)p[0] << 8) | p[1] );
 636 }
 637 static inline uint32_t U32_AT( void const * _p )
 638 {
 639     uint8_t * p = (uint8_t *)_p;
 640     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 641               | ((uint32_t)p[2] << 8) | p[3] );
 642 }
 643 static inline uint64_t U64_AT( void const * _p )
 644 {
 645     uint8_t * p = (uint8_t *)_p;
 646     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 647               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 648               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 649               | ((uint64_t)p[6] << 8) | p[7] );
 650 }
 651
 652 static inline uint16_t GetWLE( void const * _p )
 653 {
 654     uint8_t * p = (uint8_t *)_p;
 655     return ( ((uint16_t)p[1] << 8) | p[0] );
 656 }
 657 static inline uint32_t GetDWLE( void const * _p )
 658 {
 659     uint8_t * p = (uint8_t *)_p;
 660     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 661               | ((uint32_t)p[1] << 8) | p[0] );
 662 }
 663 static inline uint64_t GetQWLE( void const * _p )
 664 {
 665     uint8_t * p = (uint8_t *)_p;
 666     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 667               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 668               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 669               | ((uint64_t)p[1] << 8) | p[0] );
 670 }
 671
 672 #define GetWBE( p )     U16_AT( p )
 673 #define GetDWBE( p )    U32_AT( p )
 674 #define GetQWBE( p )    U64_AT( p )
 675
 676 /* Helper writer functions */
 677 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
 678 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 679 {
 680     p[1] = ( i_dw >>  8 )&0xff;
 681     p[0] = ( i_dw       )&0xff;
 682 }
 683
 684 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
 685 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 686 {
 687     p[3] = ( i_dw >> 24 )&0xff;
 688     p[2] = ( i_dw >> 16 )&0xff;
 689     p[1] = ( i_dw >>  8 )&0xff;
 690     p[0] = ( i_dw       )&0xff;
 691 }
 692 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
 693 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 694 {
 695     SetDWLE( p,   i_qw&0xffffffff );
 696     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 697 }
 698 #define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
 699 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 700 {
 701     p[0] = ( i_dw >>  8 )&0xff;
 702     p[1] = ( i_dw       )&0xff;
 703 }
 704
 705 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
 706 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 707 {
 708     p[0] = ( i_dw >> 24 )&0xff;
 709     p[1] = ( i_dw >> 16 )&0xff;
 710     p[2] = ( i_dw >>  8 )&0xff;
 711     p[3] = ( i_dw       )&0xff;
 712 }
 713 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
 714 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 715 {
 716     SetDWBE( p+4,   i_qw&0xffffffff );
 717     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 718 }
 719
 720 #if WORDS_BIGENDIAN
 721 #   define hton16(i)   ( i )
 722 #   define hton32(i)   ( i )
 723 #   define hton64(i)   ( i )
 724 #   define ntoh16(i)   ( i )
 725 #   define ntoh32(i)   ( i )
 726 #   define ntoh64(i)   ( i )
 727 #else
 728 #   define hton16(i)   U16_AT(&i)
 729 #   define hton32(i)   U32_AT(&i)
 730 #   define hton64(i)   U64_AT(&i)
 731 #   define ntoh16(i)   U16_AT(&i)
 732 #   define ntoh32(i)   U32_AT(&i)
 733 #   define ntoh64(i)   U64_AT(&i)
 734 #endif
 735
 736 /* Format string sanity checks */
 737 #ifdef HAVE_ATTRIBUTE_FORMAT
 738 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
 739 #else
 740 #   define ATTRIBUTE_FORMAT(x,y)
 741 #endif
 742
 743 /* Alignment of critical static data structures */
 744 #ifdef ATTRIBUTE_ALIGNED_MAX
 745 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
 746 #else
 747 #   define ATTR_ALIGN(align)
 748 #endif
 749
 750 /* Alignment of critical dynamic data structure
 751  *
 752  * Not all platforms support memalign so we provide a vlc_memalign wrapper
 753  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 754  * *pp_orig is the pointer that has to be freed afterwards.
 755  */
 756 #if 0
 757 #ifdef HAVE_POSIX_MEMALIGN
 758 #   define vlc_memalign(align,size,pp_orig) \
 759     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
 760 #endif
 761 #endif
 762 #ifdef HAVE_MEMALIGN
 763     /* Some systems have memalign() but no declaration for it */
 764     void * memalign( size_t align, size_t size );
 765
 766 #   define vlc_memalign(pp_orig,align,size) \
 767     ( *(pp_orig) = memalign( align, size ) )
 768
 769 #else /* We don't have any choice but to align manually */
 770 #   define vlc_memalign(pp_orig,align,size) \
 771     (( *(pp_orig) = malloc( size + align - 1 )) \
 772         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
 773                        & (~(unsigned long)(align-1)) ) \
 774         : NULL )
 775
 776 #endif
 777
 778 /* Stuff defined in src/extras/libc.c */
 779 #ifndef HAVE_STRDUP
 780 #   define strdup vlc_strdup
 781     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
 782 #elif !defined(__PLUGIN__)
 783 #   define vlc_strdup NULL
 784 #endif
 785
 786 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
 787 #   define vasprintf vlc_vasprintf
 788     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
 789 #elif !defined(__PLUGIN__)
 790 #   define vlc_vasprintf NULL
 791 #endif
 792
 793 #if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
 794 #   define asprintf vlc_asprintf
 795     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
 796 #elif !defined(__PLUGIN__)
 797 #   define vlc_asprintf NULL
 798 #endif
 799
 800 #ifndef HAVE_STRNDUP
 801 #   if defined(STRNDUP_IN_GNOME_H) && \
 802         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 803          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
 804         /* Do nothing: gnome.h defines strndup for us */
 805 #   else
 806 #       define strndup vlc_strndup
 807         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
 808 #   endif
 809 #elif !defined(__PLUGIN__)
 810 #   define vlc_strndup NULL
 811 #endif
 812
 813 #ifndef HAVE_ATOF
 814 #   define atof vlc_atof
 815     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
 816 #elif !defined(__PLUGIN__)
 817 #   define vlc_atof NULL
 818 #endif
 819
 820 #ifndef HAVE_STRTOF
 821 #   ifdef HAVE_STRTOD
 822 #       define strtof strtod
 823 #   endif
 824 #endif
 825
 826 #ifndef HAVE_ATOLL
 827 #   define atoll vlc_atoll
 828     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
 829 #elif !defined(__PLUGIN__)
 830 #   define vlc_atoll NULL
 831 #endif
 832
 833 #ifndef HAVE_STRTOLL
 834 #   define strtoll vlc_strtoll
 835     VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
 836 #elif !defined(__PLUGIN__)
 837 #   define vlc_strtoll NULL
 838 #endif
 839
 840 #ifndef HAVE_GETENV
 841 #   define getenv vlc_getenv
 842     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
 843 #elif !defined(__PLUGIN__)
 844 #   define vlc_getenv NULL
 845 #endif
 846
 847 #ifndef HAVE_STRCASECMP
 848 #   ifndef HAVE_STRICMP
 849 #       define strcasecmp vlc_strcasecmp
 850         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
 851 #   else
 852 #       define strcasecmp stricmp
 853 #       if !defined(__PLUGIN__)
 854 #           define vlc_strcasecmp NULL
 855 #       endif
 856 #   endif
 857 #elif !defined(__PLUGIN__)
 858 #   define vlc_strcasecmp NULL
 859 #endif
 860
 861 #ifndef HAVE_STRNCASECMP
 862 #   ifndef HAVE_STRNICMP
 863 #       define strncasecmp vlc_strncasecmp
 864         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
 865 #   else
 866 #       define strncasecmp strnicmp
 867 #       if !defined(__PLUGIN__)
 868 #           define vlc_strncasecmp NULL
 869 #       endif
 870 #   endif
 871 #elif !defined(__PLUGIN__)
 872 #   define vlc_strncasecmp NULL
 873 #endif
 874
 875 #ifndef HAVE_STRCASESTR
 876 #   ifndef HAVE_STRISTR
 877 #       define strcasestr vlc_strcasestr
 878         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
 879 #   else
 880 #       define strcasestr stristr
 881 #       if !defined(__PLUGIN__)
 882 #           define vlc_strcasestr NULL
 883 #       endif
 884 #   endif
 885 #elif !defined(__PLUGIN__)
 886 #   define vlc_strcasestr NULL
 887 #endif
 888
 889 #ifndef HAVE_DIRENT_H
 890     typedef void DIR;
 891 #   ifndef FILENAME_MAX
 892 #       define FILENAME_MAX (260)
 893 #   endif
 894     struct dirent
 895     {
 896         long            d_ino;          /* Always zero. */
 897         unsigned short  d_reclen;       /* Always zero. */
 898         unsigned short  d_namlen;       /* Length of name in d_name. */
 899         char            d_name[FILENAME_MAX]; /* File name. */
 900     };
 901 #   define opendir vlc_opendir
 902 #   define readdir vlc_readdir
 903 #   define closedir vlc_closedir
 904     VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
 905     VLC_EXPORT( void *, vlc_readdir, ( void * ) );
 906     VLC_EXPORT( int, vlc_closedir, ( void * ) );
 907 #elif !defined(__PLUGIN__)
 908 #   define vlc_opendir  NULL
 909 #   define vlc_readdir  NULL
 910 #   define vlc_closedir NULL
 911 #endif
 912
 913 /* Format type specifiers for 64 bits numbers */
 914 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
 915 #   if defined(__WORDSIZE) && __WORDSIZE == 64
 916 #       define I64Fd "%ld"
 917 #       define I64Fi "%li"
 918 #       define I64Fo "%lo"
 919 #       define I64Fu "%lu"
 920 #       define I64Fx "%lx"
 921 #       define I64FX "%lX"
 922 #   else
 923 #       define I64Fd "%lld"
 924 #       define I64Fi "%lli"
 925 #       define I64Fo "%llo"
 926 #       define I64Fu "%llu"
 927 #       define I64Fx "%llx"
 928 #       define I64FX "%llX"
 929 #   endif
 930 #else
 931 #   define I64Fd "%I64d"
 932 #   define I64Fi "%I64i"
 933 #   define I64Fo "%I64o"
 934 #   define I64Fu "%I64u"
 935 #   define I64Fx "%I64x"
 936 #   define I64FX "%I64X"
 937 #endif /* defined(WIN32)||defined(UNDER_CE) */
 938
 939 /* 64 bits integer constant suffix */
 940 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
 941 #   if defined(__WORDSIZE) && __WORDSIZE == 64
 942 #       define I64C(x)         x##L
 943 #       define UI64C(x)        x##UL
 944 #   else
 945 #       define I64C(x)         x##LL
 946 #       define UI64C(x)        x##ULL
 947 #   endif
 948 #else
 949 #   define I64C(x)         x##i64
 950 #   define UI64C(x)        x##ui64
 951 #endif /* defined(WIN32)||defined(UNDER_CE) */
 952
 953 #if defined(WIN32) || defined(UNDER_CE)
 954 /* win32, cl and icl support */
 955 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 956 #       define __attribute__(x)
 957 #       define __inline__      __inline
 958 #       define S_IFBLK         0x3000  /* Block */
 959 #       define S_ISBLK(m)      (0)
 960 #       define S_ISCHR(m)      (0)
 961 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 962 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 963 #   endif
 964
 965 /* several type definitions */
 966 #   if defined( __MINGW32__ )
 967 #       if !defined( _OFF_T_ )
 968 typedef long long _off_t;
 969 typedef _off_t off_t;
 970 #           define _OFF_T_
 971 #       else
 972 #           ifdef off_t
 973 #               undef off_t
 974 #           endif
 975 #           define off_t long long
 976 #       endif
 977 #   endif
 978
 979 /*
 980 #   if (defined( _MSC_VER ) && (!defined(__WXMSW__)))
 981 #       if !defined( _OFF_T_DEFINED )
 982 typedef __int64 off_t;
 983 #           define _OFF_T_DEFINED
 984 #       else
 985 #           define off_t __int64
 986             // for wx compatibility typedef long off_t;
 987 #       endif
 988 #   endif
 989 */
 990
 991 #   if defined( __BORLANDC__ )
 992 #       undef off_t
 993 #       define off_t unsigned __int64
 994 #   endif
 995
 996 #   ifndef O_NONBLOCK
 997 #       define O_NONBLOCK 0
 998 #   endif
 999
1000 #   ifndef alloca
1001 #       define alloca _alloca
1002 #   endif
1003
1004     /* These two are not defined in mingw32 (bug?) */
1005 #   ifndef snprintf
1006 #       define snprintf _snprintf
1007 #   endif
1008 #   ifndef vsnprintf
1009 #       define vsnprintf _vsnprintf
1010 #   endif
1011
1012 #   include <tchar.h>
1013 #endif
1014
1015 VLC_EXPORT( vlc_bool_t, vlc_reduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1016 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1017
1018 /* vlc_wraptext (defined in src/extras/libc.c) */
1019 #define wraptext vlc_wraptext
1020 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
1021
1022 /* iconv wrappers (defined in src/extras/libc.c) */
1023 typedef void *vlc_iconv_t;
1024 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1025 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) );
1026 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1027
1028 /*****************************************************************************
1029  * CPU capabilities
1030  *****************************************************************************/
1031 #define CPU_CAPABILITY_NONE    0
1032 #define CPU_CAPABILITY_486     (1<<0)
1033 #define CPU_CAPABILITY_586     (1<<1)
1034 #define CPU_CAPABILITY_PPRO    (1<<2)
1035 #define CPU_CAPABILITY_MMX     (1<<3)
1036 #define CPU_CAPABILITY_3DNOW   (1<<4)
1037 #define CPU_CAPABILITY_MMXEXT  (1<<5)
1038 #define CPU_CAPABILITY_SSE     (1<<6)
1039 #define CPU_CAPABILITY_SSE2    (1<<7)
1040 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1041 #define CPU_CAPABILITY_FPU     (1<<31)
1042
1043 /*****************************************************************************
1044  * I18n stuff
1045  *****************************************************************************/
1046 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1047
1048 #if defined( ENABLE_NLS ) && \
1049      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1050       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1051       defined(MODULE_NAME_IS_pda))
1052     /* Declare nothing: gnome.h will do it for us */
1053 #elif defined( ENABLE_NLS )
1054 #   if defined( HAVE_INCLUDED_GETTEXT )
1055 #       include "libintl.h"
1056 #   else
1057 #       include <libintl.h>
1058 #   endif
1059 #   undef _
1060 #   define _(String) vlc_dgettext (PACKAGE_NAME, String)
1061 #   define N_(String) ((char*)(String))
1062 #else
1063 #   define _(String) ((char*)(String))
1064 #   define N_(String) ((char*)(String))
1065 #endif
1066
1067 /*****************************************************************************
1068  * Additional vlc stuff
1069  *****************************************************************************/
1070 #include "vlc_symbols.h"
1071 #include "os_specific.h"
1072 #include "vlc_messages.h"
1073 #include "variables.h"
1074 #include "vlc_objects.h"
1075 #include "vlc_threads_funcs.h"
1076 #include "mtime.h"
1077 #include "modules.h"
1078 #include "main.h"
1079 #include "configuration.h"
1080
1081 #if defined( __BORLANDC__ )
1082 #   undef PACKAGE
1083 #   define PACKAGE
1084 #endif
1085