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 VideoLAN
   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 /* XML */
 390 typedef struct xml_t xml_t;
 391 typedef struct xml_sys_t xml_sys_t;
 392 typedef struct xml_reader_t xml_reader_t;
 393 typedef struct xml_reader_sys_t xml_reader_sys_t;
 394
 395 /* vod server */
 396 typedef struct vod_t     vod_t;
 397 typedef struct vod_sys_t vod_sys_t;
 398 typedef struct vod_media_t vod_media_t;
 399
 400 /* opengl */
 401 typedef struct opengl_t     opengl_t;
 402 typedef struct opengl_sys_t opengl_sys_t;
 403
 404 /* VLM */
 405 typedef struct vlm_t         vlm_t;
 406 typedef struct vlm_message_t vlm_message_t;
 407 typedef struct vlm_media_t   vlm_media_t;
 408 typedef struct vlm_schedule_t vlm_schedule_t;
 409
 410 /* divers */
 411 typedef struct vlc_meta_t    vlc_meta_t;
 412
 413
 414 /*****************************************************************************
 415  * Variable callbacks
 416  *****************************************************************************/
 417 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 418                                    char const *,            /* variable name */
 419                                    vlc_value_t,                 /* old value */
 420                                    vlc_value_t,                 /* new value */
 421                                    void * );                /* callback data */
 422
 423 /*****************************************************************************
 424  * Plug-in stuff
 425  *****************************************************************************/
 426 #ifndef __PLUGIN__
 427 #   define VLC_EXPORT( type, name, args ) type name args
 428 #else
 429 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
 430     extern module_symbols_t* p_symbols;
 431 #endif
 432
 433 /*****************************************************************************
 434  * OS-specific headers and thread types
 435  *****************************************************************************/
 436 #if defined( WIN32 ) || defined( UNDER_CE )
 437 #   define WIN32_LEAN_AND_MEAN
 438 #   include <windows.h>
 439 #   if defined( UNDER_CE )
 440 #      define IS_WINNT 0
 441 #   else
 442 #      define IS_WINNT ( GetVersion() < 0x80000000 )
 443 #   endif
 444 #endif
 445
 446 #include "vlc_threads.h"
 447
 448 /*****************************************************************************
 449  * Common structure members
 450  *****************************************************************************/
 451
 452 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 453 #define VLC_COMMON_MEMBERS                                                  \
 454 /** \name VLC_COMMON_MEMBERS                                                \
 455  * these members are common for all vlc objects                             \
 456  */                                                                         \
 457 /**@{*/                                                                     \
 458     int   i_object_id;                                                      \
 459     int   i_object_type;                                                    \
 460     char *psz_object_type;                                                  \
 461     char *psz_object_name;                                                  \
 462                                                                             \
 463     /* Thread properties, if any */                                         \
 464     vlc_bool_t   b_thread;                                                  \
 465     vlc_thread_t thread_id;                                                 \
 466                                                                             \
 467     /* Object access lock */                                                \
 468     vlc_mutex_t  object_lock;                                               \
 469     vlc_cond_t   object_wait;                                               \
 470                                                                             \
 471     /* Object properties */                                                 \
 472     volatile vlc_bool_t b_error;                  /**< set by the object */ \
 473     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
 474     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
 475     volatile vlc_bool_t b_attached;               /**< set by the object */ \
 476     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
 477                                                                             \
 478     /* Object variables */                                                  \
 479     vlc_mutex_t     var_lock;                                               \
 480     int             i_vars;                                                 \
 481     variable_t *    p_vars;                                                 \
 482                                                                             \
 483     /* Stuff related to the libvlc structure */                             \
 484     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
 485     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
 486                                                                             \
 487     volatile int    i_refcount;                         /**< usage count */ \
 488     vlc_object_t *  p_parent;                            /**< our parent */ \
 489     vlc_object_t ** pp_children;                       /**< our children */ \
 490     volatile int    i_children;                                             \
 491                                                                             \
 492     /* Private data */                                                      \
 493     void *          p_private;                                              \
 494                                                                             \
 495     /** Just a reminder so that people don't cast garbage */                \
 496     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
 497 /**@}*/                                                                     \
 498
 499 /* VLC_OBJECT: attempt at doing a clever cast */
 500 #define VLC_OBJECT( x ) \
 501     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 502
 503 /*****************************************************************************
 504  * Macros and inline functions
 505  *****************************************************************************/
 506 #ifdef NTOHL_IN_SYS_PARAM_H
 507 #   include <sys/param.h>
 508
 509 #elif !defined(WIN32) && !defined( UNDER_CE )
 510 #   include <netinet/in.h>
 511
 512 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 513
 514 /* CEIL: division with round to nearest greater integer */
 515 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 516
 517 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 518 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 519
 520 /* __MAX and __MIN: self explanatory */
 521 #ifndef __MAX
 522 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 523 #endif
 524 #ifndef __MIN
 525 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 526 #endif
 527
 528 static int64_t GCD( int64_t a, int64_t b )
 529 {
 530     if( b ) return GCD( b, a % b );
 531     else return a;
 532 }
 533
 534 /* Dynamic array handling: realloc array, move data, increment position */
 535 #if defined( _MSC_VER )
 536 #   define VLCCVP (void**) /* Work-around for broken compiler */
 537 #else
 538 #   define VLCCVP
 539 #endif
 540 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
 541     do                                                                        \
 542     {                                                                         \
 543         if( !i_oldsize ) (p_ar) = NULL;                                       \
 544         (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
 545         if( (i_oldsize) - (i_pos) )                                           \
 546         {                                                                     \
 547             memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos),                  \
 548                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
 549         }                                                                     \
 550         (p_ar)[i_pos] = elem;                                                 \
 551         (i_oldsize)++;                                                        \
 552     }                                                                         \
 553     while( 0 )
 554
 555 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
 556     do                                                                        \
 557     {                                                                         \
 558         if( (i_oldsize) - (i_pos) - 1 )                                       \
 559         {                                                                     \
 560             memmove( (p_ar) + (i_pos),                                        \
 561                      (p_ar) + (i_pos) + 1,                                    \
 562                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
 563         }                                                                     \
 564         if( i_oldsize > 1 )                                                   \
 565         {                                                                     \
 566             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
 567         }                                                                     \
 568         else                                                                  \
 569         {                                                                     \
 570             free( p_ar );                                                     \
 571             (p_ar) = NULL;                                                    \
 572         }                                                                     \
 573         (i_oldsize)--;                                                        \
 574     }                                                                         \
 575     while( 0 )
 576
 577
 578 #define TAB_APPEND( count, tab, p )             \
 579     if( (count) > 0 )                           \
 580     {                                           \
 581         (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
 582     }                                           \
 583     else                                        \
 584     {                                           \
 585         (tab) = malloc( sizeof( void ** ) );    \
 586     }                                           \
 587     (tab)[count] = (p);        \
 588     (count)++
 589
 590 #define TAB_FIND( count, tab, p, index )        \
 591     {                                           \
 592         int _i_;                                \
 593         (index) = -1;                           \
 594         for( _i_ = 0; _i_ < (count); _i_++ )    \
 595         {                                       \
 596             if( (tab)[_i_] == (p) )  \
 597             {                                   \
 598                 (index) = _i_;                  \
 599                 break;                          \
 600             }                                   \
 601         }                                       \
 602     }
 603
 604 #define TAB_REMOVE( count, tab, p )             \
 605     {                                           \
 606         int _i_index_;                          \
 607         TAB_FIND( count, tab, p, _i_index_ );   \
 608         if( _i_index_ >= 0 )                    \
 609         {                                       \
 610             if( (count) > 1 )                     \
 611             {                                   \
 612                 memmove( ((void**)(tab) + _i_index_),    \
 613                          ((void**)(tab) + _i_index_+1),  \
 614                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
 615             }                                   \
 616             (count)--;                          \
 617             if( (count) == 0 )                  \
 618             {                                   \
 619                 free( tab );                    \
 620                 (tab) = NULL;                   \
 621             }                                   \
 622         }                                       \
 623     }
 624
 625 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 626  * MSB, and should be used for both network communications and files. Note that
 627  * byte orders other than little and big endians are not supported, but only
 628  * the VAX seems to have such exotic properties. */
 629 static inline uint16_t U16_AT( void const * _p )
 630 {
 631     uint8_t * p = (uint8_t *)_p;
 632     return ( ((uint16_t)p[0] << 8) | p[1] );
 633 }
 634 static inline uint32_t U32_AT( void const * _p )
 635 {
 636     uint8_t * p = (uint8_t *)_p;
 637     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 638               | ((uint32_t)p[2] << 8) | p[3] );
 639 }
 640 static inline uint64_t U64_AT( void const * _p )
 641 {
 642     uint8_t * p = (uint8_t *)_p;
 643     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 644               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 645               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 646               | ((uint64_t)p[6] << 8) | p[7] );
 647 }
 648
 649 static inline uint16_t GetWLE( void const * _p )
 650 {
 651     uint8_t * p = (uint8_t *)_p;
 652     return ( ((uint16_t)p[1] << 8) | p[0] );
 653 }
 654 static inline uint32_t GetDWLE( void const * _p )
 655 {
 656     uint8_t * p = (uint8_t *)_p;
 657     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 658               | ((uint32_t)p[1] << 8) | p[0] );
 659 }
 660 static inline uint64_t GetQWLE( void const * _p )
 661 {
 662     uint8_t * p = (uint8_t *)_p;
 663     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 664               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 665               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 666               | ((uint64_t)p[1] << 8) | p[0] );
 667 }
 668
 669 #define GetWBE( p )     U16_AT( p )
 670 #define GetDWBE( p )    U32_AT( p )
 671 #define GetQWBE( p )    U64_AT( p )
 672
 673 /* Helper writer functions */
 674 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
 675 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 676 {
 677     p[1] = ( i_dw >>  8 )&0xff;
 678     p[0] = ( i_dw       )&0xff;
 679 }
 680
 681 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
 682 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 683 {
 684     p[3] = ( i_dw >> 24 )&0xff;
 685     p[2] = ( i_dw >> 16 )&0xff;
 686     p[1] = ( i_dw >>  8 )&0xff;
 687     p[0] = ( i_dw       )&0xff;
 688 }
 689 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
 690 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 691 {
 692     SetDWLE( p,   i_qw&0xffffffff );
 693     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 694 }
 695 #define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
 696 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 697 {
 698     p[0] = ( i_dw >>  8 )&0xff;
 699     p[1] = ( i_dw       )&0xff;
 700 }
 701
 702 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
 703 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 704 {
 705     p[0] = ( i_dw >> 24 )&0xff;
 706     p[1] = ( i_dw >> 16 )&0xff;
 707     p[2] = ( i_dw >>  8 )&0xff;
 708     p[3] = ( i_dw       )&0xff;
 709 }
 710 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
 711 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 712 {
 713     SetDWBE( p+4,   i_qw&0xffffffff );
 714     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 715 }
 716
 717 #if WORDS_BIGENDIAN
 718 #   define hton16(i)   ( i )
 719 #   define hton32(i)   ( i )
 720 #   define hton64(i)   ( i )
 721 #   define ntoh16(i)   ( i )
 722 #   define ntoh32(i)   ( i )
 723 #   define ntoh64(i)   ( i )
 724 #else
 725 #   define hton16(i)   U16_AT(&i)
 726 #   define hton32(i)   U32_AT(&i)
 727 #   define hton64(i)   U64_AT(&i)
 728 #   define ntoh16(i)   U16_AT(&i)
 729 #   define ntoh32(i)   U32_AT(&i)
 730 #   define ntoh64(i)   U64_AT(&i)
 731 #endif
 732
 733 /* Format string sanity checks */
 734 #ifdef HAVE_ATTRIBUTE_FORMAT
 735 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
 736 #else
 737 #   define ATTRIBUTE_FORMAT(x,y)
 738 #endif
 739
 740 /* Alignment of critical static data structures */
 741 #ifdef ATTRIBUTE_ALIGNED_MAX
 742 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
 743 #else
 744 #   define ATTR_ALIGN(align)
 745 #endif
 746
 747 /* Alignment of critical dynamic data structure
 748  *
 749  * Not all platforms support memalign so we provide a vlc_memalign wrapper
 750  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 751  * *pp_orig is the pointer that has to be freed afterwards.
 752  */
 753 #if 0
 754 #ifdef HAVE_POSIX_MEMALIGN
 755 #   define vlc_memalign(align,size,pp_orig) \
 756     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
 757 #endif
 758 #endif
 759 #ifdef HAVE_MEMALIGN
 760     /* Some systems have memalign() but no declaration for it */
 761     void * memalign( size_t align, size_t size );
 762
 763 #   define vlc_memalign(pp_orig,align,size) \
 764     ( *(pp_orig) = memalign( align, size ) )
 765
 766 #else /* We don't have any choice but to align manually */
 767 #   define vlc_memalign(pp_orig,align,size) \
 768     (( *(pp_orig) = malloc( size + align - 1 )) \
 769         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
 770                        & (~(unsigned long)(align-1)) ) \
 771         : NULL )
 772
 773 #endif
 774
 775 /* Stuff defined in src/extras/libc.c */
 776 #ifndef HAVE_STRDUP
 777 #   define strdup vlc_strdup
 778     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
 779 #elif !defined(__PLUGIN__)
 780 #   define vlc_strdup NULL
 781 #endif
 782
 783 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
 784 #   define vasprintf vlc_vasprintf
 785     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
 786 #elif !defined(__PLUGIN__)
 787 #   define vlc_vasprintf NULL
 788 #endif
 789
 790 #if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
 791 #   define asprintf vlc_asprintf
 792     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
 793 #elif !defined(__PLUGIN__)
 794 #   define vlc_asprintf NULL
 795 #endif
 796
 797 #ifndef HAVE_STRNDUP
 798 #   if defined(STRNDUP_IN_GNOME_H) && \
 799         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 800          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
 801         /* Do nothing: gnome.h defines strndup for us */
 802 #   else
 803 #       define strndup vlc_strndup
 804         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
 805 #   endif
 806 #elif !defined(__PLUGIN__)
 807 #   define vlc_strndup NULL
 808 #endif
 809
 810 #ifndef HAVE_ATOF
 811 #   define atof vlc_atof
 812     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
 813 #elif !defined(__PLUGIN__)
 814 #   define vlc_atof NULL
 815 #endif
 816
 817 #ifndef HAVE_STRTOF
 818 #   ifdef HAVE_STRTOD
 819 #       define strtof strtod
 820 #   endif
 821 #endif
 822
 823 #ifndef HAVE_ATOLL
 824 #   define atoll vlc_atoll
 825     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
 826 #elif !defined(__PLUGIN__)
 827 #   define vlc_atoll NULL
 828 #endif
 829
 830 #ifndef HAVE_STRTOLL
 831 #   define strtoll vlc_strtoll
 832     VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
 833 #elif !defined(__PLUGIN__)
 834 #   define vlc_strtoll NULL
 835 #endif
 836
 837 #ifndef HAVE_GETENV
 838 #   define getenv vlc_getenv
 839     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
 840 #elif !defined(__PLUGIN__)
 841 #   define vlc_getenv NULL
 842 #endif
 843
 844 #ifndef HAVE_STRCASECMP
 845 #   ifndef HAVE_STRICMP
 846 #       define strcasecmp vlc_strcasecmp
 847         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
 848 #   else
 849 #       define strcasecmp stricmp
 850 #       if !defined(__PLUGIN__)
 851 #           define vlc_strcasecmp NULL
 852 #       endif
 853 #   endif
 854 #elif !defined(__PLUGIN__)
 855 #   define vlc_strcasecmp NULL
 856 #endif
 857
 858 #ifndef HAVE_STRNCASECMP
 859 #   ifndef HAVE_STRNICMP
 860 #       define strncasecmp vlc_strncasecmp
 861         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
 862 #   else
 863 #       define strncasecmp strnicmp
 864 #       if !defined(__PLUGIN__)
 865 #           define vlc_strncasecmp NULL
 866 #       endif
 867 #   endif
 868 #elif !defined(__PLUGIN__)
 869 #   define vlc_strncasecmp NULL
 870 #endif
 871
 872 #ifndef HAVE_STRCASESTR
 873 #   ifndef HAVE_STRISTR
 874 #       define strcasestr vlc_strcasestr
 875         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
 876 #   else
 877 #       define strcasestr stristr
 878 #       if !defined(__PLUGIN__)
 879 #           define vlc_strcasestr NULL
 880 #       endif
 881 #   endif
 882 #elif !defined(__PLUGIN__)
 883 #   define vlc_strcasestr NULL
 884 #endif
 885
 886 #ifndef HAVE_DIRENT_H
 887     typedef void DIR;
 888 #   ifndef FILENAME_MAX
 889 #       define FILENAME_MAX (260)
 890 #   endif
 891     struct dirent
 892     {
 893         long            d_ino;          /* Always zero. */
 894         unsigned short  d_reclen;       /* Always zero. */
 895         unsigned short  d_namlen;       /* Length of name in d_name. */
 896         char            d_name[FILENAME_MAX]; /* File name. */
 897     };
 898 #   define opendir vlc_opendir
 899 #   define readdir vlc_readdir
 900 #   define closedir vlc_closedir
 901     VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
 902     VLC_EXPORT( void *, vlc_readdir, ( void * ) );
 903     VLC_EXPORT( int, vlc_closedir, ( void * ) );
 904 #elif !defined(__PLUGIN__)
 905 #   define vlc_opendir  NULL
 906 #   define vlc_readdir  NULL
 907 #   define vlc_closedir NULL
 908 #endif
 909
 910 /* Format type specifiers for 64 bits numbers */
 911 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
 912 #   define I64Fd "%lld"
 913 #   define I64Fi "%lli"
 914 #   define I64Fo "%llo"
 915 #   define I64Fu "%llu"
 916 #   define I64Fx "%llx"
 917 #   define I64FX "%llX"
 918 #else
 919 #   define I64Fd "%I64d"
 920 #   define I64Fi "%I64i"
 921 #   define I64Fo "%I64o"
 922 #   define I64Fu "%I64u"
 923 #   define I64Fx "%I64x"
 924 #   define I64FX "%I64X"
 925 #endif /* defined(WIN32)||defined(UNDER_CE) */
 926
 927 /* 64 bits integer constant suffix */
 928 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
 929 #   define I64C(x)         x##LL
 930 #   define UI64C(x)        x##ULL
 931 #else
 932 #   define I64C(x)         x##i64
 933 #   define UI64C(x)        x##ui64
 934 #endif /* defined(WIN32)||defined(UNDER_CE) */
 935
 936 #if defined(WIN32) || defined(UNDER_CE)
 937 /* win32, cl and icl support */
 938 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 939 #       define __attribute__(x)
 940 #       define __inline__      __inline
 941 #       define S_IFBLK         0x3000  /* Block */
 942 #       define S_ISBLK(m)      (0)
 943 #       define S_ISCHR(m)      (0)
 944 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 945 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 946 #   endif
 947
 948 /* several type definitions */
 949 #   if defined( __MINGW32__ )
 950 #       if !defined( _OFF_T_ )
 951 typedef long long _off_t;
 952 typedef _off_t off_t;
 953 #           define _OFF_T_
 954 #       else
 955 #           ifdef off_t
 956 #               undef off_t
 957 #           endif
 958 #           define off_t long long
 959 #       endif
 960 #   endif
 961
 962 /*
 963 #   if (defined( _MSC_VER ) && (!defined(__WXMSW__)))
 964 #       if !defined( _OFF_T_DEFINED )
 965 typedef __int64 off_t;
 966 #           define _OFF_T_DEFINED
 967 #       else
 968 #           define off_t __int64
 969             // for wx compatibility typedef long off_t;
 970 #       endif
 971 #   endif
 972 */
 973
 974 #   if defined( __BORLANDC__ )
 975 #       undef off_t
 976 #       define off_t unsigned __int64
 977 #   endif
 978
 979 #   ifndef O_NONBLOCK
 980 #       define O_NONBLOCK 0
 981 #   endif
 982
 983 #   ifndef alloca
 984 #       define alloca _alloca
 985 #   endif
 986
 987     /* These two are not defined in mingw32 (bug?) */
 988 #   ifndef snprintf
 989 #       define snprintf _snprintf
 990 #   endif
 991 #   ifndef vsnprintf
 992 #       define vsnprintf _vsnprintf
 993 #   endif
 994
 995 #   include <tchar.h>
 996 #endif
 997
 998 VLC_EXPORT( vlc_bool_t, vlc_reduce, ( int *, int *, int64_t, int64_t, int64_t ) );
 999 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1000
1001 /* vlc_wraptext (defined in src/extras/libc.c) */
1002 #define wraptext vlc_wraptext
1003 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
1004
1005 /* iconv wrappers (defined in src/extras/libc.c) */
1006 typedef void *vlc_iconv_t;
1007 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1008 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) );
1009 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1010
1011 /*****************************************************************************
1012  * CPU capabilities
1013  *****************************************************************************/
1014 #define CPU_CAPABILITY_NONE    0
1015 #define CPU_CAPABILITY_486     (1<<0)
1016 #define CPU_CAPABILITY_586     (1<<1)
1017 #define CPU_CAPABILITY_PPRO    (1<<2)
1018 #define CPU_CAPABILITY_MMX     (1<<3)
1019 #define CPU_CAPABILITY_3DNOW   (1<<4)
1020 #define CPU_CAPABILITY_MMXEXT  (1<<5)
1021 #define CPU_CAPABILITY_SSE     (1<<6)
1022 #define CPU_CAPABILITY_SSE2    (1<<7)
1023 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1024 #define CPU_CAPABILITY_FPU     (1<<31)
1025
1026 /*****************************************************************************
1027  * I18n stuff
1028  *****************************************************************************/
1029 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1030
1031 #if defined( ENABLE_NLS ) && \
1032      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1033       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1034       defined(MODULE_NAME_IS_pda))
1035     /* Declare nothing: gnome.h will do it for us */
1036 #elif defined( ENABLE_NLS )
1037 #   if defined( HAVE_INCLUDED_GETTEXT )
1038 #       include "libintl.h"
1039 #   else
1040 #       include <libintl.h>
1041 #   endif
1042 #   undef _
1043 #   define _(String) vlc_dgettext (PACKAGE_NAME, String)
1044 #   define N_(String) ((char*)(String))
1045 #else
1046 #   define _(String) ((char*)(String))
1047 #   define N_(String) ((char*)(String))
1048 #endif
1049
1050 /*****************************************************************************
1051  * Additional vlc stuff
1052  *****************************************************************************/
1053 #include "vlc_symbols.h"
1054 #include "os_specific.h"
1055 #include "vlc_messages.h"
1056 #include "variables.h"
1057 #include "vlc_objects.h"
1058 #include "vlc_threads_funcs.h"
1059 #include "mtime.h"
1060 #include "modules.h"
1061 #include "main.h"
1062 #include "configuration.h"
1063
1064 #if defined( __BORLANDC__ )
1065 #   undef PACKAGE
1066 #   define PACKAGE
1067 #endif
1068