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