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