vlc_common.h 32.4 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3 4 5
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
 * Copyright (C) 1998, 1999, 2000 VideoLAN
6
 * $Id: vlc_common.h,v 1.111 2004/03/03 13:25:00 fenrir Exp $
Sam Hocevar's avatar
 
Sam Hocevar committed
7 8 9 10 11 12 13 14 15
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
 *          Gildas Bazin <gbazin@netcourrier.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
16
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
17 18 19 20 21 22 23 24 25 26
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
27
/**
Sam Hocevar's avatar
Sam Hocevar committed
28
 * \file
Clément Stenac's avatar
Clément Stenac committed
29 30 31
 * This file is a collection of common definitions and types
 */

32
/*****************************************************************************
33
 * Required vlc headers
34
 *****************************************************************************/
35 36 37 38 39 40
#if defined( __BORLANDC__ )
#   undef PACKAGE
#endif

#include "config.h"

41 42 43
#if defined( __BORLANDC__ )
#   undef HAVE_VARIADIC_MACROS
#   undef HAVE_STDINT_H
44
#   undef HAVE_INTTYPES_H
45
#   undef off_t
Gildas Bazin's avatar
 
Gildas Bazin committed
46 47
#elif defined( _MSC_VER )
#   pragma warning( disable : 4244 )
48 49
#endif

50 51 52
#include "vlc_config.h"
#include "modules_inner.h"

Sam Hocevar's avatar
 
Sam Hocevar committed
53 54 55
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
56
#include <stdlib.h>
57 58
#include <stdarg.h>

Sam Hocevar's avatar
 
Sam Hocevar committed
59 60 61 62 63 64 65
#ifdef HAVE_STRING_H
#   include <string.h>                                         /* strerror() */
#endif

#ifdef HAVE_SYS_TYPES_H
#   include <sys/types.h>
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
66 67 68 69

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
70
#if defined( HAVE_STDINT_H )
71
#   include <stdint.h>
72 73
#elif defined( HAVE_INTTYPES_H )
#   include <inttypes.h>
74 75 76 77 78 79 80
#elif defined( SYS_CYGWIN )
#   include <sys/types.h>
    /* Cygwin only defines half of these... */
    typedef u_int8_t            uint8_t;
    typedef u_int16_t           uint16_t;
    typedef u_int32_t           uint32_t;
    typedef u_int64_t           uint64_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
81
#else
82 83 84 85 86 87 88
    /* Fallback types (very x86-centric, sorry) */
    typedef unsigned char       uint8_t;
    typedef signed char         int8_t;
    typedef unsigned short      uint16_t;
    typedef signed short        int16_t;
    typedef unsigned int        uint32_t;
    typedef signed int          int32_t;
89 90 91
#   if defined( _MSC_VER ) \
      || defined( UNDER_CE ) \
      || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
92 93
    typedef unsigned __int64    uint64_t;
    typedef signed __int64      int64_t;
94
#   else
95 96
    typedef unsigned long long  uint64_t;
    typedef signed long long    int64_t;
97
#   endif
Sam Hocevar's avatar
Sam Hocevar committed
98 99
    typedef uint32_t            uintptr_t;
    typedef int32_t             intptr_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
100 101
#endif

102
typedef uint8_t                 byte_t;
103

Sam Hocevar's avatar
 
Sam Hocevar committed
104 105 106 107 108 109 110 111 112 113 114 115
/* ptrdiff_t definition */
#ifdef HAVE_STDDEF_H
#   include <stddef.h>
#else
#   include <malloc.h>
#   ifndef _PTRDIFF_T
#       define _PTRDIFF_T
/* Not portable in a 64-bit environment. */
typedef int                 ptrdiff_t;
#   endif
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
116 117
#if defined( WIN32 )
#   include <malloc.h>
118 119 120
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
121 122
#endif

123
#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
Gildas Bazin's avatar
 
Gildas Bazin committed
124
typedef int                 ssize_t;
Xavier Marchesini's avatar
 
Xavier Marchesini committed
125 126
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
127 128 129 130
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
131
typedef int16_t             dctelem_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
132 133

/* Video buffer types */
134
typedef uint8_t             yuv_data_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
135

136
/* Audio volume */
137 138
typedef uint16_t            audio_volume_t;

139 140 141 142
#ifndef HAVE_SOCKLEN_T
typedef int                 socklen_t;
#endif

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
143 144 145
/**
 * High precision date or time interval
 *
146 147
 * Store a high precision date or time interval. The maximum precision is the
 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
Sam Hocevar's avatar
 
Sam Hocevar committed
148
 * time interval is then 292271 years, which should be long enough for any
149 150
 * video). Dates are stored as microseconds since a common date (usually the
 * epoch). Note that date and time intervals can be manipulated using regular
Sam Hocevar's avatar
 
Sam Hocevar committed
151
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
152
 */
153
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
154

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
155
/**
156
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
157
 *
158
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
159
 */
160
typedef uint32_t vlc_fourcc_t;
161

162 163
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
164 165
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
166
#   define VLC_TWOCC( a, b ) \
167
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
168

169 170
#else
#   define VLC_FOURCC( a, b, c, d ) \
171 172
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
173
#   define VLC_TWOCC( a, b ) \
174
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
175 176

#endif
177

Sam Hocevar's avatar
 
Sam Hocevar committed
178 179 180 181
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

182 183
/* Internal types */
typedef struct libvlc_t libvlc_t;
Sam Hocevar's avatar
Sam Hocevar committed
184 185
typedef struct vlc_t vlc_t;
typedef struct variable_t variable_t;
186

187
/* Messages */
188 189
typedef struct msg_bank_t msg_bank_t;
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
190

Gildas Bazin's avatar
 
Gildas Bazin committed
191
/* Playlist */
192 193
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
194
typedef struct playlist_group_t playlist_group_t;
195 196
typedef struct item_info_t item_info_t;
typedef struct item_info_category_t item_info_category_t;
197
typedef struct playlist_export_t playlist_export_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
198

199
/* Modules */
200 201 202 203
typedef struct module_bank_t module_bank_t;
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
typedef struct module_symbols_t module_symbols_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
204 205

/* Interface */
206 207 208 209 210
typedef struct intf_thread_t intf_thread_t;
typedef struct intf_sys_t intf_sys_t;
typedef struct intf_console_t intf_console_t;
typedef struct intf_msg_t intf_msg_t;
typedef struct intf_channel_t intf_channel_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
211 212

/* Input */
213
typedef struct input_thread_t input_thread_t;
214
typedef struct input_thread_sys_t input_thread_sys_t;
215 216 217 218 219 220 221 222 223 224 225 226
typedef struct input_area_t input_area_t;
typedef struct input_buffers_t input_buffers_t;
typedef struct input_socket_t input_socket_t;
typedef struct input_info_t input_info_t;
typedef struct input_info_category_t input_info_category_t;
typedef struct access_sys_t access_sys_t;
typedef struct demux_sys_t demux_sys_t;
typedef struct es_descriptor_t es_descriptor_t;
typedef struct es_sys_t es_sys_t;
typedef struct pgrm_descriptor_t pgrm_descriptor_t;
typedef struct pgrm_sys_t pgrm_sys_t;
typedef struct stream_descriptor_t stream_descriptor_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
227

228 229 230 231
/* Format */
typedef struct audio_format_t audio_format_t;
typedef struct video_format_t video_format_t;
typedef struct subs_format_t subs_format_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
232 233
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
234

235
/* NInput */
236 237
typedef struct stream_sys_t stream_sys_t;
typedef struct stream_t     stream_t;
238 239 240
typedef struct es_out_t     es_out_t;
typedef struct es_out_id_t  es_out_id_t;
typedef struct es_out_sys_t es_out_sys_t;
241
typedef struct demux_t  demux_t;
242

Sam Hocevar's avatar
 
Sam Hocevar committed
243
/* Audio */
244 245
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
246
typedef struct aout_fifo_t aout_fifo_t;
247 248
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
249
typedef audio_format_t audio_sample_format_t;
250
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
251
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
252 253

/* Video */
254 255 256
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
typedef struct chroma_sys_t chroma_sys_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
257
typedef video_format_t video_frame_format_t;
258 259 260 261 262
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
263
typedef struct vout_synchro_t vout_synchro_t;
264 265
typedef struct text_renderer_sys_t text_renderer_sys_t;
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
266

267 268 269
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
typedef struct sout_fifo_t sout_fifo_t;
270
typedef struct sout_input_t sout_input_t;
271
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
272
typedef struct sout_buffer_t sout_buffer_t;
273
typedef struct sout_access_out_t sout_access_out_t;
274
typedef struct sout_mux_t sout_mux_t;
275 276
typedef struct sout_stream_t    sout_stream_t;
typedef struct sout_cfg_t       sout_cfg_t;
277 278
/*typedef struct sap_session_t    sap_session_t;
typedef struct slp_session_t    slp_session_t;*/
279

Sam Hocevar's avatar
 
Sam Hocevar committed
280
/* Decoders */
Gildas Bazin's avatar
 
Gildas Bazin committed
281 282
typedef struct decoder_t      decoder_t;
typedef struct decoder_sys_t  decoder_sys_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
283

Gildas Bazin's avatar
 
Gildas Bazin committed
284 285 286 287
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
288
/* Misc */
289 290 291 292 293 294 295
typedef struct data_packet_t data_packet_t;
typedef struct data_buffer_t data_buffer_t;
typedef struct stream_position_t stream_position_t;
typedef struct stream_ctrl_t stream_ctrl_t;
typedef struct pes_packet_t pes_packet_t;
typedef struct network_socket_t network_socket_t;
typedef struct iso639_lang_t iso639_lang_t;
296

297 298 299 300
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
/* httpd */
typedef struct httpd_t          httpd_t;
typedef struct httpd_host_t     httpd_host_t;
typedef struct httpd_url_t      httpd_url_t;
typedef struct httpd_client_t   httpd_client_t;
typedef struct httpd_callback_sys_t httpd_callback_sys_t;
typedef struct httpd_message_t  httpd_message_t;
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
typedef int (*httpd_file_callback_t)( httpd_file_sys_t*, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
typedef struct httpd_redirect_t httpd_redirect_t;
typedef struct httpd_stream_t httpd_stream_t;


316 317 318 319 320 321 322 323 324
/*****************************************************************************
 * Variable callbacks
 *****************************************************************************/
typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
                                   char const *,            /* variable name */
                                   vlc_value_t,                 /* old value */
                                   vlc_value_t,                 /* new value */
                                   void * );                /* callback data */

Gildas Bazin's avatar
 
Gildas Bazin committed
325 326 327 328
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
#ifndef __PLUGIN__
329
#   define VLC_EXPORT( type, name, args ) type name args
Gildas Bazin's avatar
 
Gildas Bazin committed
330
#else
331
#   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
Gildas Bazin's avatar
 
Gildas Bazin committed
332 333 334
    extern module_symbols_t* p_symbols;
#endif

335 336 337
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
338
#if defined( WIN32 ) || defined( UNDER_CE )
339 340
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
Gildas Bazin's avatar
 
Gildas Bazin committed
341
#   define IS_WINNT ( GetVersion() < 0x80000000 )
342 343
#endif

344 345 346 347 348 349 350 351
#include "vlc_threads.h"

/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
352 353 354 355
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
356 357 358 359 360 361 362 363
    int   i_object_id;                                                      \
    int   i_object_type;                                                    \
    char *psz_object_type;                                                  \
    char *psz_object_name;                                                  \
                                                                            \
    /* Thread properties, if any */                                         \
    vlc_bool_t   b_thread;                                                  \
    vlc_thread_t thread_id;                                                 \
Sam Hocevar's avatar
Sam Hocevar committed
364 365 366 367
                                                                            \
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
368
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
369
    /* Object properties */                                                 \
370 371 372 373
    volatile vlc_bool_t b_error;                  /**< set by the object */ \
    volatile vlc_bool_t b_die;                   /**< set by the outside */ \
    volatile vlc_bool_t b_dead;                   /**< set by the object */ \
    volatile vlc_bool_t b_attached;               /**< set by the object */ \
374
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
375 376 377 378 379 380
    /* Object variables */                                                  \
    vlc_mutex_t     var_lock;                                               \
    int             i_vars;                                                 \
    variable_t *    p_vars;                                                 \
                                                                            \
    /* Stuff related to the libvlc structure */                             \
381 382
    libvlc_t *      p_libvlc;                      /**< root of all evil */ \
    vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
383
                                                                            \
384 385 386
    volatile int    i_refcount;                         /**< usage count */ \
    vlc_object_t *  p_parent;                            /**< our parent */ \
    vlc_object_t ** pp_children;                       /**< our children */ \
387 388
    volatile int    i_children;                                             \
                                                                            \
389 390 391
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
392
    /** Just a reminder so that people don't cast garbage */                \
393
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
394
/**@}*/                                                                     \
395

396 397
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
398
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
399

Sam Hocevar's avatar
 
Sam Hocevar committed
400 401 402 403 404 405
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

406
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
 
Sam Hocevar committed
407 408 409 410 411 412 413 414 415 416
#   include <netinet/in.h>

#endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */

/* CEIL: division with round to nearest greater integer */
#define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )

/* PAD: PAD(n, d) = CEIL(n ,d) * d */
#define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )

Sam Hocevar's avatar
 
Sam Hocevar committed
417 418 419
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
420
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
421 422
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
423 424
#endif

425 426 427 428 429 430 431 432 433 434 435 436
/* Dynamic array handling: realloc array, move data, increment position */
#define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
    do                                                                        \
    {                                                                         \
        if( i_oldsize )                                                       \
        {                                                                     \
            (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) );  \
        }                                                                     \
        else                                                                  \
        {                                                                     \
            (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) );         \
        }                                                                     \
Gildas Bazin's avatar
 
Gildas Bazin committed
437 438 439 440 441 442
        if( (i_oldsize) - (i_pos) )                                           \
        {                                                                     \
            memmove( (p_ar) + (i_pos) + 1,                                    \
                     (p_ar) + (i_pos),                                        \
                     ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
        }                                                                     \
443 444 445 446 447 448 449 450
        (p_ar)[i_pos] = elem;                                                 \
        (i_oldsize)++;                                                        \
    }                                                                         \
    while( 0 )

#define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
    do                                                                        \
    {                                                                         \
Gildas Bazin's avatar
 
Gildas Bazin committed
451 452 453 454 455 456
        if( (i_oldsize) - (i_pos) - 1 )                                       \
        {                                                                     \
            memmove( (p_ar) + (i_pos),                                        \
                     (p_ar) + (i_pos) + 1,                                    \
                     ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
        }                                                                     \
457 458 459 460 461 462 463 464 465 466 467 468 469 470
        if( i_oldsize > 1 )                                                   \
        {                                                                     \
            (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
        }                                                                     \
        else                                                                  \
        {                                                                     \
            free( p_ar );                                                     \
            (p_ar) = NULL;                                                    \
        }                                                                     \
        (i_oldsize)--;                                                        \
    }                                                                         \
    while( 0 )


471 472 473
#define TAB_APPEND( count, tab, p )             \
    if( (count) > 0 )                           \
    {                                           \
474
        (void *)(tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
475 476 477
    }                                           \
    else                                        \
    {                                           \
478
        (void *)(tab) = malloc( sizeof( void ** ) );    \
479
    }                                           \
480
    ((void**)(tab))[count] = (void*)(p);        \
481 482 483 484 485 486 487 488
    (count)++

#define TAB_FIND( count, tab, p, index )        \
    {                                           \
        int _i_;                                \
        (index) = -1;                           \
        for( _i_ = 0; _i_ < (count); _i_++ )    \
        {                                       \
489
            if( ((void**)(tab))[_i_] == (void*)(p) )  \
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
            {                                   \
                (index) = _i_;                  \
                break;                          \
            }                                   \
        }                                       \
    }

#define TAB_REMOVE( count, tab, p )             \
    {                                           \
        int _i_index_;                          \
        TAB_FIND( count, tab, p, _i_index_ );   \
        if( _i_index_ >= 0 )                    \
        {                                       \
            if( (count) > 1 )                     \
            {                                   \
                memmove( ((void**)(tab) + _i_index_),    \
                         ((void**)(tab) + _i_index_+1),  \
                         ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
            }                                   \
            else                                \
            {                                   \
                free( tab );                    \
                (tab) = NULL;                   \
            }                                   \
            (count)--;                          \
        }                                       \
    }

Sam Hocevar's avatar
 
Sam Hocevar committed
518 519 520
/* MSB (big endian)/LSB (little endian) conversions - network order is always
 * MSB, and should be used for both network communications and files. Note that
 * byte orders other than little and big endians are not supported, but only
521
 * the VAX seems to have such exotic properties. */
Sam Hocevar's avatar
Sam Hocevar committed
522
static inline uint16_t U16_AT( void const * _p )
523
{
524 525
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[0] << 8) | p[1] );
526
}
Sam Hocevar's avatar
Sam Hocevar committed
527
static inline uint32_t U32_AT( void const * _p )
528
{
529 530 531
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
532
}
Sam Hocevar's avatar
Sam Hocevar committed
533
static inline uint64_t U64_AT( void const * _p )
534
{
535 536 537 538 539
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
              | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
              | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
              | ((uint64_t)p[6] << 8) | p[7] );
540
}
541

Sam Hocevar's avatar
Sam Hocevar committed
542
static inline uint16_t GetWLE( void const * _p )
543 544 545 546
{
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Sam Hocevar's avatar
Sam Hocevar committed
547
static inline uint32_t GetDWLE( void const * _p )
548 549 550 551 552
{
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
Sam Hocevar's avatar
Sam Hocevar committed
553
static inline uint64_t GetQWLE( void const * _p )
554 555 556 557 558 559 560 561 562 563 564 565
{
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
              | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
              | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
              | ((uint64_t)p[1] << 8) | p[0] );
}

#define GetWBE( p )     U16_AT( p )
#define GetDWBE( p )    U32_AT( p )
#define GetQWBE( p )    U64_AT( p )

Gildas Bazin's avatar
 
Gildas Bazin committed
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
/* Helper writer functions */

#define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
{
    p[3] = ( i_dw >> 24 )&0xff;
    p[2] = ( i_dw >> 16 )&0xff;
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
589

Sam Hocevar's avatar
 
Sam Hocevar committed
590
#if WORDS_BIGENDIAN
591 592
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
593
#   define hton64(i)   ( i )
594 595
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
 
Sam Hocevar committed
596 597
#   define ntoh64(i)   ( i )
#else
598 599 600 601 602 603
#   define hton16(i)   U16_AT(&i)
#   define hton32(i)   U32_AT(&i)
#   define hton64(i)   U64_AT(&i)
#   define ntoh16(i)   U16_AT(&i)
#   define ntoh32(i)   U32_AT(&i)
#   define ntoh64(i)   U64_AT(&i)
Sam Hocevar's avatar
 
Sam Hocevar committed
604 605
#endif

606 607 608 609 610 611 612
/* Format string sanity checks */
#ifdef HAVE_ATTRIBUTE_FORMAT
#   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
#else
#   define ATTRIBUTE_FORMAT(x,y)
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
613 614 615 616 617 618 619
/* Alignment of critical static data structures */
#ifdef ATTRIBUTE_ALIGNED_MAX
#   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
#else
#   define ATTR_ALIGN(align)
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
620 621 622 623 624 625 626 627 628 629 630 631
/* Alignment of critical dynamic data structure
 *
 * Not all platforms support memalign so we provide a vlc_memalign wrapper
 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 * *pp_orig is the pointer that has to be freed afterwards.
 */
#if 0
#ifdef HAVE_POSIX_MEMALIGN
#   define vlc_memalign(align,size,pp_orig) \
    ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
#endif
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
632 633 634
#ifdef HAVE_MEMALIGN
    /* Some systems have memalign() but no declaration for it */
    void * memalign( size_t align, size_t size );
Gildas Bazin's avatar
 
Gildas Bazin committed
635

636
#   define vlc_memalign(pp_orig,align,size) \
Gildas Bazin's avatar
 
Gildas Bazin committed
637 638 639
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
640 641 642
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
643
                       & (~(unsigned long)(align-1)) ) \
644
        : NULL )
Gildas Bazin's avatar
 
Gildas Bazin committed
645

Sam Hocevar's avatar
 
Sam Hocevar committed
646 647
#endif

648
/* Stuff defined in src/extras/libc.c */
649
#ifndef HAVE_STRDUP
650 651 652 653
#   define strdup vlc_strdup
    VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
#elif !defined(__PLUGIN__)
#   define vlc_strdup NULL
654
#endif
655

656
#if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
657
#   define vasprintf vlc_vasprintf
658
    VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
659 660 661 662
#elif !defined(__PLUGIN__)
#   define vlc_vasprintf NULL
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
663 664 665 666 667 668 669
#if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
#   define asprintf vlc_asprintf
    VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
#elif !defined(__PLUGIN__)
#   define vlc_asprintf NULL
#endif

670
#ifndef HAVE_STRNDUP
671
#   if defined(STRNDUP_IN_GNOME_H) && \
672 673
        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
674 675 676 677 678
        /* Do nothing: gnome.h defines strndup for us */
#   else
#       define strndup vlc_strndup
        VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
#   endif
679 680
#elif !defined(__PLUGIN__)
#   define vlc_strndup NULL
681 682 683
#endif

#ifndef HAVE_ATOF
684 685 686 687
#   define atof vlc_atof
    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atof NULL
688 689
#endif

690 691 692 693 694 695 696
#ifndef HAVE_ATOLL
#   define atoll vlc_atoll
    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atoll NULL
#endif

697
#ifndef HAVE_GETENV
698 699 700 701
#   define getenv vlc_getenv
    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
#elif !defined(__PLUGIN__)
#   define vlc_getenv NULL
702 703 704 705 706
#endif

#ifndef HAVE_STRCASECMP
#   ifdef HAVE_STRICMP
#       define strcasecmp stricmp
Gildas Bazin's avatar
 
Gildas Bazin committed
707 708 709
#       if !defined(__PLUGIN__)
#           define vlc_strcasecmp NULL
#       endif
710 711 712
#   elif !defined(__PLUGIN__)
#       define strcasecmp vlc_strcasecmp
        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
713
#   endif
714 715
#elif !defined(__PLUGIN__)
#   define vlc_strcasecmp NULL
716 717 718 719 720
#endif

#ifndef HAVE_STRNCASECMP
#   ifdef HAVE_STRNICMP
#       define strncasecmp strnicmp
Gildas Bazin's avatar
 
Gildas Bazin committed
721 722 723
#       if !defined(__PLUGIN__)
#           define vlc_strncasecmp NULL
#       endif
724 725 726
#   elif !defined(__PLUGIN__)
#       define strncasecmp vlc_strncasecmp
        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
727
#   endif
728 729
#elif !defined(__PLUGIN__)
#   define vlc_strncasecmp NULL
730 731
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
732
/* Format type specifiers for 64 bits numbers */
733
#if !defined(WIN32) && !defined(UNDER_CE)
Gildas Bazin's avatar
 
Gildas Bazin committed
734 735 736 737 738 739 740 741 742 743 744 745 746
#   define I64Fd "%lld"
#   define I64Fi "%lli"
#   define I64Fo "%llo"
#   define I64Fu "%llu"
#   define I64Fx "%llx"
#   define I64FX "%llX"
#else
#   define I64Fd "%I64d"
#   define I64Fi "%I64i"
#   define I64Fo "%I64o"
#   define I64Fu "%I64u"
#   define I64Fx "%I64x"
#   define I64FX "%I64X"
747
#endif /* defined(WIN32)||defined(UNDER_CE) */
Gildas Bazin's avatar
 
Gildas Bazin committed
748 749

/* 64 bits integer constant suffix */
Gildas Bazin's avatar
 
Gildas Bazin committed
750
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
Gildas Bazin's avatar
 
Gildas Bazin committed
751
#   define I64C(x)         x##LL
Gildas Bazin's avatar
 
Gildas Bazin committed
752
#   define UI64C(x)        x##ULL
Gildas Bazin's avatar
 
Gildas Bazin committed
753 754
#else
#   define I64C(x)         x##i64
Gildas Bazin's avatar
 
Gildas Bazin committed
755
#   define UI64C(x)        x##ui64
756
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
 
Sam Hocevar committed
757

758
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
759
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
760
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
761 762
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
763
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
764 765 766 767 768 769 770 771 772 773 774 775 776
#       define S_ISBLK(m)      (0)
#       define S_ISCHR(m)      (0)
#       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
#       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
#   endif

/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
typedef long long _off_t;
typedef _off_t off_t;
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
777 778 779
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
780 781 782 783 784 785 786 787 788 789 790 791 792
#           define off_t long long
#       endif
#   endif

#   if defined( _MSC_VER )
#       if !defined( _OFF_T_DEFINED )
typedef __int64 off_t;
#           define _OFF_T_DEFINED
#       else
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
793
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
794
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
795
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
796 797
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
798 799
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
800 801 802 803
#   endif

#   ifndef alloca
#       define alloca _alloca
Gildas Bazin's avatar
 
Gildas Bazin committed
804 805
#   endif

806
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
 
Sam Hocevar committed
807
#   ifndef snprintf
808 809 810 811
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
 
Sam Hocevar committed
812 813 814 815
#   endif

#endif

816
/* lseek (defined in src/extras/libc.c) */
817
#ifndef HAVE_LSEEK
818 819 820 821
#   define lseek vlc_lseek
    VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
#elif !defined(__PLUGIN__)
#   define vlc_lseek NULL
822 823
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
824 825 826 827
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );

Sam Hocevar's avatar
 
Sam Hocevar committed
828 829 830 831 832 833 834 835 836 837 838
/*****************************************************************************
 * CPU capabilities
 *****************************************************************************/
#define CPU_CAPABILITY_NONE    0
#define CPU_CAPABILITY_486     (1<<0)
#define CPU_CAPABILITY_586     (1<<1)
#define CPU_CAPABILITY_PPRO    (1<<2)
#define CPU_CAPABILITY_MMX     (1<<3)
#define CPU_CAPABILITY_3DNOW   (1<<4)
#define CPU_CAPABILITY_MMXEXT  (1<<5)
#define CPU_CAPABILITY_SSE     (1<<6)
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
839
#define CPU_CAPABILITY_SSE2    (1<<7)
Sam Hocevar's avatar
 
Sam Hocevar committed
840 841 842 843 844 845
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
846 847
VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );

848
#if defined( ENABLE_NLS ) && \
849
     (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
Jean-Paul Saman's avatar
Jean-Paul Saman committed
850 851
      defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
      defined(MODULE_NAME_IS_pda))
852
    /* Declare nothing: gnome.h will do it for us */
853 854
#elif defined( ENABLE_NLS )
#if defined( HAVE_INCLUDED_GETTEXT )
855
#   include "libintl.h"
856 857 858
#else
#   include <libintl.h>
#endif
859
#   undef _
860
#if defined( __BORLANDC__ )
Sam Hocevar's avatar
Sam Hocevar committed
861
#define _(String) vlc_dgettext (PACKAGE_TARNAME, String)
862
#else
863
#   define _(String) vlc_dgettext (PACKAGE, String)
864
#endif
865
#   define N_(String) ((char*)(String))
866
#else
867 868
#   define _(String) ((char*)(String))
#   define N_(String) ((char*)(String))
Sam Hocevar's avatar
 
Sam Hocevar committed
869 870
#endif

871
/*****************************************************************************
872
 * Additional vlc stuff
873
 *****************************************************************************/
874
#include "vlc_symbols.h"
875 876
#include "os_specific.h"
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
877 878
#include "variables.h"
#include "vlc_objects.h"
879
#include "vlc_threads_funcs.h"
880 881 882 883 884 885 886 887 888 889
#include "mtime.h"
#include "modules.h"
#include "main.h"
#include "configuration.h"

#if defined( __BORLANDC__ )
#   undef PACKAGE
#   define PACKAGE
#endif