vlc_common.h 35.5 KB
Newer Older
Sam Hocevar's avatar
   
Sam Hocevar committed
1
2
3
4
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
5
 * Copyright (C) 1998-2004 VideoLAN
6
 * $Id$
Sam Hocevar's avatar
   
Sam Hocevar committed
7
8
9
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
10
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
   
Sam Hocevar committed
11
12
13
14
15
 *
 * 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.
 *****************************************************************************/

zorglub's avatar
zorglub committed
27
/**
Sam Hocevar's avatar
Sam Hocevar committed
28
 * \file
zorglub's avatar
zorglub 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"

Sam Hocevar's avatar
Sam Hocevar committed
41
42
#if defined(PACKAGE)
#   undef PACKAGE_NAME
Sam Hocevar's avatar
Sam Hocevar committed
43
44
#   define PACKAGE_NAME PACKAGE
#endif
Sam Hocevar's avatar
Sam Hocevar committed
45
46
#if defined(VERSION)
#   undef PACKAGE_VERSION
Sam Hocevar's avatar
Sam Hocevar committed
47
48
49
#   define PACKAGE_VERSION VERSION
#endif

50
51
52
#if defined( __BORLANDC__ )
#   undef HAVE_VARIADIC_MACROS
#   undef HAVE_STDINT_H
53
#   undef HAVE_INTTYPES_H
54
#   undef off_t
gbazin's avatar
   
gbazin committed
55
56
#elif defined( _MSC_VER )
#   pragma warning( disable : 4244 )
57
58
#endif

59
60
61
#include "vlc_config.h"
#include "modules_inner.h"

Sam Hocevar's avatar
   
Sam Hocevar committed
62
63
64
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
gbazin's avatar
   
gbazin committed
65
#include <stdlib.h>
66
67
#include <stdarg.h>

Sam Hocevar's avatar
   
Sam Hocevar committed
68
69
70
71
72
73
74
#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
75
76
77
78

/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
79
#if defined( HAVE_STDINT_H )
80
#   include <stdint.h>
81
82
#elif defined( HAVE_INTTYPES_H )
#   include <inttypes.h>
83
84
85
86
87
88
89
#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
90
#else
91
92
93
94
95
96
97
    /* 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;
98
99
100
#   if defined( _MSC_VER ) \
      || defined( UNDER_CE ) \
      || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
101
102
    typedef unsigned __int64    uint64_t;
    typedef signed __int64      int64_t;
103
#   else
104
105
    typedef unsigned long long  uint64_t;
    typedef signed long long    int64_t;
106
#   endif
Sam Hocevar's avatar
Sam Hocevar committed
107
108
    typedef uint32_t            uintptr_t;
    typedef int32_t             intptr_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
109
110
#endif

111
typedef uint8_t                 byte_t;
112

Sam Hocevar's avatar
   
Sam Hocevar committed
113
114
115
116
117
118
119
120
121
122
123
124
/* 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

gbazin's avatar
   
gbazin committed
125
126
#if defined( WIN32 )
#   include <malloc.h>
127
128
129
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
gbazin's avatar
   
gbazin committed
130
131
#endif

132
#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
gbazin's avatar
   
gbazin committed
133
typedef int                 ssize_t;
Xavier Marchesini's avatar
   
Xavier Marchesini committed
134
135
#endif

Sam Hocevar's avatar
   
Sam Hocevar committed
136
137
138
139
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

/* DCT elements types */
140
typedef int16_t             dctelem_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
141
142

/* Video buffer types */
143
typedef uint8_t             yuv_data_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
144

145
/* Audio volume */
146
147
typedef uint16_t            audio_volume_t;

148
149
150
151
#ifndef HAVE_SOCKLEN_T
typedef int                 socklen_t;
#endif

sigmunau's avatar
sigmunau committed
152
153
154
/**
 * High precision date or time interval
 *
155
156
 * 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
157
 * time interval is then 292271 years, which should be long enough for any
158
159
 * 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
160
 * arithmetic operators, and that no special functions are required.
sigmunau's avatar
sigmunau committed
161
 */
162
typedef int64_t mtime_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
163

sigmunau's avatar
sigmunau committed
164
/**
165
 * The vlc_fourcc_t type.
sigmunau's avatar
sigmunau committed
166
 *
167
 * See http://www.webartz.com/fourcc/ for a very detailed list.
sigmunau's avatar
sigmunau committed
168
 */
169
typedef uint32_t vlc_fourcc_t;
170

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

178
179
#else
#   define VLC_FOURCC( a, b, c, d ) \
180
181
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((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

Sam Hocevar's avatar
   
Sam Hocevar committed
187
188
189
190
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

191
192
/* Internal types */
typedef struct libvlc_t libvlc_t;
Sam Hocevar's avatar
Sam Hocevar committed
193
194
typedef struct vlc_t vlc_t;
typedef struct variable_t variable_t;
195
typedef struct date_t date_t;
196

197
/* Messages */
198
199
typedef struct msg_bank_t msg_bank_t;
typedef struct msg_subscription_t msg_subscription_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
200

gbazin's avatar
   
gbazin committed
201
/* Playlist */
hartman's avatar
hartman committed
202
203
204
205
206
207
208
209
210
211
212
213
214
215

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
    PLAYLIST_PLAY,                              /**< Starts playing. No arg. */
    PLAYLIST_PAUSE,                     /**< Toggles playlist pause. No arg. */
    PLAYLIST_STOP,                               /**< Stops playing. No arg. */
    PLAYLIST_SKIP,                               /**< Skip X items and play. */
    PLAYLIST_GOTO,                                       /**< Goto Xth item. */
} playlist_command_t;


216
217
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
zorglub's avatar
zorglub committed
218
typedef struct playlist_group_t playlist_group_t;
zorglub's avatar
zorglub committed
219
typedef struct playlist_export_t playlist_export_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
220

221
/* Modules */
222
223
224
225
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;
226
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
227
228

/* Interface */
229
230
231
232
233
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
234
235

/* Input */
236
typedef struct input_thread_t input_thread_t;
237
typedef struct input_thread_sys_t input_thread_sys_t;
238
typedef struct input_item_t input_item_t;
239
240
241
242
243
244
245
246
247
248
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 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;
gbazin's avatar
gbazin committed
249
typedef struct seekpoint_t seekpoint_t;
250
251
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
252

253
254
255
256
/* 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;
gbazin's avatar
   
gbazin committed
257
258
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
259

260
/* NInput */
261
262
typedef struct stream_sys_t stream_sys_t;
typedef struct stream_t     stream_t;
263
264
265
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;
266
typedef struct demux_t  demux_t;
267
typedef struct access_t access_t;
268

Sam Hocevar's avatar
   
Sam Hocevar committed
269
/* Audio */
270
271
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
272
typedef struct aout_fifo_t aout_fifo_t;
273
274
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
gbazin's avatar
   
gbazin committed
275
typedef audio_format_t audio_sample_format_t;
276
typedef struct audio_date_t audio_date_t;
gbazin's avatar
   
gbazin committed
277
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
278
279

/* Video */
280
281
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
282
typedef struct vout_synchro_t vout_synchro_t;
283
typedef struct chroma_sys_t chroma_sys_t;
284

gbazin's avatar
   
gbazin committed
285
typedef video_format_t video_frame_format_t;
286
287
288
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
289
290

typedef struct spu_t spu_t;
291
292
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
293
typedef struct subpicture_region_t subpicture_region_t;
294
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
295

296
297
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
298
299
typedef struct sout_instance_sys_t sout_instance_sys_t;

300
typedef struct sout_input_t sout_input_t;
301
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
302

303
typedef struct sout_access_out_t sout_access_out_t;
304
305
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

306
typedef struct sout_mux_t sout_mux_t;
307
308
typedef struct sout_mux_sys_t sout_mux_sys_t;

309
typedef struct sout_stream_t    sout_stream_t;
310
311
typedef struct sout_stream_sys_t sout_stream_sys_t;

312
typedef struct sout_cfg_t       sout_cfg_t;
zorglub's avatar
zorglub committed
313
314
315
316
317
318
319
typedef struct sap_session_t    sap_session_t;
typedef struct sap_address_t sap_address_t;
typedef struct session_descriptor_t session_descriptor_t;
typedef struct announce_method_t announce_method_t;
typedef struct announce_handler_t announce_handler_t;
typedef struct sap_handler_t sap_handler_t;
//typedef struct slp_session_t    slp_session_t;
320

Sam Hocevar's avatar
   
Sam Hocevar committed
321
/* Decoders */
gbazin's avatar
   
gbazin committed
322
323
typedef struct decoder_t      decoder_t;
typedef struct decoder_sys_t  decoder_sys_t;
Sam Hocevar's avatar
   
Sam Hocevar committed
324

gbazin's avatar
   
gbazin committed
325
326
327
328
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

329
330
331
332
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
333
/* Misc */
334
335
336
337
338
339
typedef struct data_packet_t data_packet_t;
typedef struct data_buffer_t data_buffer_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;
340

341
342
343
344
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

345
346
347
348
349
350
351
352
353
354
355
356
357
358
/* 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;

359
360
361
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
362
typedef struct vod_media_t vod_media_t;
363

364
365
366
367
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

368
/* divers */
369
370
371
372
typedef struct vlc_meta_t    vlc_meta_t;

typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
373

374

375
376
377
378
379
380
381
382
383
/*****************************************************************************
 * 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 */

gbazin's avatar
   
gbazin committed
384
385
386
387
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
#ifndef __PLUGIN__
388
#   define VLC_EXPORT( type, name, args ) type name args
gbazin's avatar
   
gbazin committed
389
#else
390
#   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
gbazin's avatar
   
gbazin committed
391
392
393
    extern module_symbols_t* p_symbols;
#endif

394
395
396
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
397
#if defined( WIN32 ) || defined( UNDER_CE )
398
399
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
400
401
402
403
404
#   if defined( UNDER_CE )
#      define IS_WINNT 0
#   else
#      define IS_WINNT ( GetVersion() < 0x80000000 )
#   endif
405
406
#endif

407
408
409
410
411
412
413
414
#include "vlc_threads.h"

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

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
415
416
417
418
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
419
420
421
422
423
424
425
426
    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
427
428
429
430
                                                                            \
    /* Object access lock */                                                \
    vlc_mutex_t  object_lock;                                               \
    vlc_cond_t   object_wait;                                               \
431
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
432
    /* Object properties */                                                 \
433
434
435
436
    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 */ \
437
    vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
438
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
439
440
441
442
443
444
    /* Object variables */                                                  \
    vlc_mutex_t     var_lock;                                               \
    int             i_vars;                                                 \
    variable_t *    p_vars;                                                 \
                                                                            \
    /* Stuff related to the libvlc structure */                             \
445
446
    libvlc_t *      p_libvlc;                      /**< root of all evil */ \
    vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
447
                                                                            \
448
449
450
    volatile int    i_refcount;                         /**< usage count */ \
    vlc_object_t *  p_parent;                            /**< our parent */ \
    vlc_object_t ** pp_children;                       /**< our children */ \
451
452
    volatile int    i_children;                                             \
                                                                            \
453
454
455
    /* Private data */                                                      \
    void *          p_private;                                              \
                                                                            \
456
    /** Just a reminder so that people don't cast garbage */                \
457
    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
458
/**@}*/                                                                     \
459

460
461
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
462
    ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
463

Sam Hocevar's avatar
   
Sam Hocevar committed
464
465
466
467
468
469
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/
#ifdef NTOHL_IN_SYS_PARAM_H
#   include <sys/param.h>

470
#elif !defined(WIN32) && !defined( UNDER_CE )
Sam Hocevar's avatar
   
Sam Hocevar committed
471
472
473
474
475
476
477
478
479
480
#   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
481
482
483
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
   
Sam Hocevar committed
484
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
485
486
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
   
Sam Hocevar committed
487
488
#endif

489
490
491
492
493
494
static int64_t GCD( int64_t a, int64_t b )
{
    if( b ) return GCD( b, a % b );
    else return a;
}

495
496
497
498
499
500
501
502
503
504
505
506
/* 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) ) );         \
        }                                                                     \
gbazin's avatar
   
gbazin committed
507
508
509
510
511
512
        if( (i_oldsize) - (i_pos) )                                           \
        {                                                                     \
            memmove( (p_ar) + (i_pos) + 1,                                    \
                     (p_ar) + (i_pos),                                        \
                     ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
        }                                                                     \
513
514
515
516
517
518
519
520
        (p_ar)[i_pos] = elem;                                                 \
        (i_oldsize)++;                                                        \
    }                                                                         \
    while( 0 )

#define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
    do                                                                        \
    {                                                                         \
gbazin's avatar
   
gbazin committed
521
522
523
524
525
526
        if( (i_oldsize) - (i_pos) - 1 )                                       \
        {                                                                     \
            memmove( (p_ar) + (i_pos),                                        \
                     (p_ar) + (i_pos) + 1,                                    \
                     ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
        }                                                                     \
527
528
529
530
531
532
533
534
535
536
537
538
539
540
        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 )


541
542
543
#define TAB_APPEND( count, tab, p )             \
    if( (count) > 0 )                           \
    {                                           \
544
        (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
545
546
547
    }                                           \
    else                                        \
    {                                           \
548
        (tab) = malloc( sizeof( void ** ) );    \
549
    }                                           \
550
    (tab)[count] = (p);        \
551
552
553
554
555
556
557
558
    (count)++

#define TAB_FIND( count, tab, p, index )        \
    {                                           \
        int _i_;                                \
        (index) = -1;                           \
        for( _i_ = 0; _i_ < (count); _i_++ )    \
        {                                       \
559
            if( (tab)[_i_] == (p) )  \
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
            {                                   \
                (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* ) );\
            }                                   \
579
580
            (count)--;                          \
            if( (count) == 0 )                  \
581
582
583
584
585
586
587
            {                                   \
                free( tab );                    \
                (tab) = NULL;                   \
            }                                   \
        }                                       \
    }

Sam Hocevar's avatar
   
Sam Hocevar committed
588
589
590
/* 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
591
 * the VAX seems to have such exotic properties. */
Sam Hocevar's avatar
Sam Hocevar committed
592
static inline uint16_t U16_AT( void const * _p )
593
{
594
595
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[0] << 8) | p[1] );
596
}
Sam Hocevar's avatar
Sam Hocevar committed
597
static inline uint32_t U32_AT( void const * _p )
598
{
599
600
601
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
602
}
Sam Hocevar's avatar
Sam Hocevar committed
603
static inline uint64_t U64_AT( void const * _p )
604
{
605
606
607
608
609
    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] );
610
}
611

Sam Hocevar's avatar
Sam Hocevar committed
612
static inline uint16_t GetWLE( void const * _p )
613
614
615
616
{
    uint8_t * p = (uint8_t *)_p;
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
Sam Hocevar's avatar
Sam Hocevar committed
617
static inline uint32_t GetDWLE( void const * _p )
618
619
620
621
622
{
    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
623
static inline uint64_t GetQWLE( void const * _p )
624
625
626
627
628
629
630
631
632
633
634
635
{
    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 )

gbazin's avatar
   
gbazin committed
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
/* 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 );
}
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
#define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
{
    p[0] = ( i_dw >> 24 )&0xff;
    p[1] = ( i_dw >> 16 )&0xff;
    p[2] = ( i_dw >>  8 )&0xff;
    p[3] = ( i_dw       )&0xff;
}
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
679

Sam Hocevar's avatar
   
Sam Hocevar committed
680
#if WORDS_BIGENDIAN
681
682
#   define hton16(i)   ( i )
#   define hton32(i)   ( i )
Sam Hocevar's avatar
   
Sam Hocevar committed
683
#   define hton64(i)   ( i )
684
685
#   define ntoh16(i)   ( i )
#   define ntoh32(i)   ( i )
Sam Hocevar's avatar
   
Sam Hocevar committed
686
687
#   define ntoh64(i)   ( i )
#else
688
689
690
691
692
693
#   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
694
695
#endif

696
697
698
699
700
701
702
/* 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
703
704
705
706
707
708
709
/* 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

gbazin's avatar
   
gbazin committed
710
711
712
713
714
715
716
717
718
719
720
721
/* 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
722
723
724
#ifdef HAVE_MEMALIGN
    /* Some systems have memalign() but no declaration for it */
    void * memalign( size_t align, size_t size );
gbazin's avatar
   
gbazin committed
725

726
#   define vlc_memalign(pp_orig,align,size) \
gbazin's avatar
   
gbazin committed
727
728
729
    ( *(pp_orig) = memalign( align, size ) )

#else /* We don't have any choice but to align manually */
730
731
732
#   define vlc_memalign(pp_orig,align,size) \
    (( *(pp_orig) = malloc( size + align - 1 )) \
        ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
733
                       & (~(unsigned long)(align-1)) ) \
734
        : NULL )
gbazin's avatar
   
gbazin committed
735

Sam Hocevar's avatar
   
Sam Hocevar committed
736
737
#endif

738
/* Stuff defined in src/extras/libc.c */
739
#ifndef HAVE_STRDUP
740
741
742
743
#   define strdup vlc_strdup
    VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
#elif !defined(__PLUGIN__)
#   define vlc_strdup NULL
744
#endif
745

746
#if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
747
#   define vasprintf vlc_vasprintf
748
    VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
749
750
751
752
#elif !defined(__PLUGIN__)
#   define vlc_vasprintf NULL
#endif

gbazin's avatar
   
gbazin committed
753
754
755
756
757
758
759
#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

760
#ifndef HAVE_STRNDUP
761
#   if defined(STRNDUP_IN_GNOME_H) && \
762
763
        (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
         defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
764
765
766
767
768
        /* 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
769
770
#elif !defined(__PLUGIN__)
#   define vlc_strndup NULL
771
772
773
#endif

#ifndef HAVE_ATOF
774
775
776
777
#   define atof vlc_atof
    VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atof NULL
778
779
#endif

780
781
782
783
784
#ifndef HAVE_ATOLL
#   define atoll vlc_atoll
    VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
#elif !defined(__PLUGIN__)
#   define vlc_atoll NULL
785
786
787
788
789
790
791
#endif

#ifndef HAVE_STRTOLL
#   define strtoll vlc_strtoll
    VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
#elif !defined(__PLUGIN__)
#   define vlc_strtoll NULL
792
793
#endif

794
#ifndef HAVE_GETENV
795
796
797
798
#   define getenv vlc_getenv
    VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
#elif !defined(__PLUGIN__)
#   define vlc_getenv NULL
799
800
801
#endif

#ifndef HAVE_STRCASECMP
802
803
804
805
#   ifndef HAVE_STRICMP
#       define strcasecmp vlc_strcasecmp
        VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
#   else
806
#       define strcasecmp stricmp
gbazin's avatar
   
gbazin committed
807
808
809
#       if !defined(__PLUGIN__)
#           define vlc_strcasecmp NULL
#       endif
810
#   endif
811
812
#elif !defined(__PLUGIN__)
#   define vlc_strcasecmp NULL
813
814
815
#endif

#ifndef HAVE_STRNCASECMP
816
817
818
819
#   ifndef HAVE_STRNICMP
#       define strncasecmp vlc_strncasecmp
        VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
#   else
820
#       define strncasecmp strnicmp
gbazin's avatar
   
gbazin committed
821
822
823
#       if !defined(__PLUGIN__)
#           define vlc_strncasecmp NULL
#       endif
824
#   endif
825
826
#elif !defined(__PLUGIN__)
#   define vlc_strncasecmp NULL
827
828
#endif

829
#ifndef HAVE_STRCASESTR
830
831
832
833
#   ifndef HAVE_STRISTR
#       define strcasestr vlc_strcasestr
        VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
#   else
834
835
836
837
838
839
840
841
842
#       define strcasestr stristr
#       if !defined(__PLUGIN__)
#           define vlc_strcasestr NULL
#       endif
#   endif
#elif !defined(__PLUGIN__)
#   define vlc_strcasestr NULL
#endif

gbazin's avatar
   
gbazin committed
843
/* Format type specifiers for 64 bits numbers */
844
#if !defined(WIN32) && !defined(UNDER_CE)
gbazin's avatar
   
gbazin committed
845
846
847
848
849
850
851
852
853
854
855
856
857
#   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"
858
#endif /* defined(WIN32)||defined(UNDER_CE) */
gbazin's avatar
   
gbazin committed
859
860

/* 64 bits integer constant suffix */
gbazin's avatar
   
gbazin committed
861
#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
gbazin's avatar
   
gbazin committed
862
#   define I64C(x)         x##LL
gbazin's avatar
   
gbazin committed
863
#   define UI64C(x)        x##ULL
gbazin's avatar
   
gbazin committed
864
865
#else
#   define I64C(x)         x##i64
gbazin's avatar
   
gbazin committed
866
#   define UI64C(x)        x##ui64
867
#endif /* defined(WIN32)||defined(UNDER_CE) */
Sam Hocevar's avatar
   
Sam Hocevar committed
868

869
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
   
Sam Hocevar committed
870
/* win32, cl and icl support */
Sam Hocevar's avatar
   
Sam Hocevar committed
871
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
   
Sam Hocevar committed
872
873
#       define __attribute__(x)
#       define __inline__      __inline
gbazin's avatar
   
gbazin committed
874
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
   
Sam Hocevar committed
875
876
877
878
879
880
881
882
883
884
885
886
887
#       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
gbazin's avatar
   
gbazin committed
888
889
890
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
   
Sam Hocevar committed
891
892
893
894
895
896
897
898
899
900
901
902
903
#           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

ipkiss's avatar
   
ipkiss committed
904
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
   
Sam Hocevar committed
905
#       undef off_t
ipkiss's avatar
   
ipkiss committed
906
#       define off_t unsigned __int64
Sam Hocevar's avatar
   
Sam Hocevar committed
907
908
#   endif

gbazin's avatar
   
gbazin committed
909
910
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
gbazin's avatar
   
gbazin committed
911
912
913
914
#   endif

#   ifndef alloca
#       define alloca _alloca
gbazin's avatar
   
gbazin committed
915
916
#   endif

917
    /* These two are not defined in mingw32 (bug?) */
Sam Hocevar's avatar
   
Sam Hocevar committed
918
#   ifndef snprintf
919
920
921
922
#       define snprintf _snprintf
#   endif
#   ifndef vsnprintf
#       define vsnprintf _vsnprintf
Sam Hocevar's avatar
   
Sam Hocevar committed
923
924
925
926
#   endif

#endif

927
/* lseek (defined in src/extras/libc.c) */
928
#ifndef HAVE_LSEEK
929
930
931
932
#   define lseek vlc_lseek
    VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
#elif !defined(__PLUGIN__)
#   define vlc_lseek NULL
933
934
#endif

935
936
VLC_EXPORT( vlc_bool_t, vlc_reduce, ( int *, int *, int64_t, int64_t, int64_t ) );

gbazin's avatar
   
gbazin committed
937
938
939
940
/* vlc_wraptext (defined in src/extras/libc.c) */
#define wraptext vlc_wraptext
VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );

941
942
943
944
945
946
/* iconv wrappers (defined in src/extras/libc.c) */
typedef void *vlc_iconv_t;
VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) );
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

Sam Hocevar's avatar
   
Sam Hocevar committed
947
948
949
950
951
952
953
954
955
956
957
/*****************************************************************************
 * 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)
sigmunau's avatar
sigmunau committed
958
#define CPU_CAPABILITY_SSE2    (1<<7)
Sam Hocevar's avatar
   
Sam Hocevar committed
959
960
961
962
963
964
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU     (1<<31)

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
965
966
VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );

967
#if defined( ENABLE_NLS ) && \
968
     (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
Jean-Paul Saman's avatar
Jean-Paul Saman committed
969
970
      defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
      defined(MODULE_NAME_IS_pda))
971
    /* Declare nothing: gnome.h will do it for us */
972
#elif defined( ENABLE_NLS )
Sam Hocevar's avatar
Sam Hocevar committed
973
974
975
976
977
#   if defined( HAVE_INCLUDED_GETTEXT )
#       include "libintl.h"
#   else
#       include <libintl.h>
#   endif
978
#   undef _
Sam Hocevar's avatar
Sam Hocevar committed
979
#   define _(String) vlc_dgettext (PACKAGE_NAME, String)
980
#   define N_(String) ((char*)(String))
981
#else
982
983
#   define _(String) ((char*)(String))
#   define N_(String) ((char*)(String))
Sam Hocevar's avatar
   
Sam Hocevar committed
984
985
#endif

986
/*****************************************************************************
987
 * Additional vlc stuff
988
 *****************************************************************************/
989
#include "vlc_symbols.h"
990
991
#include "os_specific.h"
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
992
993
#include "variables.h"
#include "vlc_objects.h"
994
#include "vlc_threads_funcs.h"
995
996
997
998
999
1000
1001
1002
1003
1004
#include "mtime.h"
#include "modules.h"
#include "main.h"
#include "configuration.h"

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