]> git.sesse.net Git - vlc/blob - include/vlc_common.h
FSF address change.
[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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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_queue_t msg_queue_t;
209 typedef struct msg_subscription_t msg_subscription_t;
210
211 /* Playlist */
212
213 /* FIXME */
214 /**
215  * Playlist commands
216  */
217 typedef enum {
218     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
219     PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
220     PLAYLIST_VIEWPLAY,  /**< arg1= int, arg2= playlist_item_t*,*/
221                         /**  arg3 = playlist_item_t*          , res=can fail */
222     PLAYLIST_ITEMPLAY,  /** <arg1 = playlist_item_t *         , res=can fail */
223     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
224     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
225     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
226     PLAYLIST_GOTO,      /**< arg1=int                           res=can fail */
227     PLAYLIST_VIEWGOTO   /**< arg1=int                           res=can fail */
228 } playlist_command_t;
229
230
231 typedef struct playlist_t playlist_t;
232 typedef struct playlist_item_t playlist_item_t;
233 typedef struct playlist_view_t playlist_view_t;
234 typedef struct playlist_export_t playlist_export_t;
235 typedef struct services_discovery_t services_discovery_t;
236 typedef struct services_discovery_sys_t services_discovery_sys_t;
237 typedef struct playlist_add_t playlist_add_t;
238 typedef struct playlist_preparse_t playlist_preparse_t;
239
240 /* Modules */
241 typedef struct module_bank_t module_bank_t;
242 typedef struct module_t module_t;
243 typedef struct module_config_t module_config_t;
244 typedef struct module_symbols_t module_symbols_t;
245 typedef struct module_cache_t module_cache_t;
246
247 typedef struct config_category_t config_category_t;
248
249 /* Interface */
250 typedef struct intf_thread_t intf_thread_t;
251 typedef struct intf_sys_t intf_sys_t;
252 typedef struct intf_console_t intf_console_t;
253 typedef struct intf_msg_t intf_msg_t;
254 typedef struct interaction_t interaction_t;
255 typedef struct interaction_dialog_t interaction_dialog_t;
256 typedef struct user_widget_t user_widget_t;
257
258 /* Input */
259 typedef struct input_thread_t input_thread_t;
260 typedef struct input_thread_sys_t input_thread_sys_t;
261 typedef struct input_item_t input_item_t;
262 typedef struct access_t access_t;
263 typedef struct access_sys_t access_sys_t;
264 typedef struct stream_t     stream_t;
265 typedef struct stream_sys_t stream_sys_t;
266 typedef struct demux_t  demux_t;
267 typedef struct demux_sys_t demux_sys_t;
268 typedef struct es_out_t     es_out_t;
269 typedef struct es_out_id_t  es_out_id_t;
270 typedef struct es_out_sys_t es_out_sys_t;
271 typedef struct es_descriptor_t es_descriptor_t;
272 typedef struct seekpoint_t seekpoint_t;
273 typedef struct info_t info_t;
274 typedef struct info_category_t info_category_t;
275
276 /* Format */
277 typedef struct audio_format_t audio_format_t;
278 typedef struct video_format_t video_format_t;
279 typedef struct subs_format_t subs_format_t;
280 typedef struct es_format_t es_format_t;
281 typedef struct video_palette_t video_palette_t;
282
283 /* Audio */
284 typedef struct aout_instance_t aout_instance_t;
285 typedef struct aout_sys_t aout_sys_t;
286 typedef struct aout_fifo_t aout_fifo_t;
287 typedef struct aout_input_t aout_input_t;
288 typedef struct aout_buffer_t aout_buffer_t;
289 typedef audio_format_t audio_sample_format_t;
290 typedef struct audio_date_t audio_date_t;
291 typedef struct aout_filter_t aout_filter_t;
292
293 /* Video */
294 typedef struct vout_thread_t vout_thread_t;
295 typedef struct vout_sys_t vout_sys_t;
296 typedef struct vout_synchro_t vout_synchro_t;
297 typedef struct chroma_sys_t chroma_sys_t;
298
299 typedef video_format_t video_frame_format_t;
300 typedef struct picture_t picture_t;
301 typedef struct picture_sys_t picture_sys_t;
302 typedef struct picture_heap_t picture_heap_t;
303
304 /* Subpictures */
305 typedef struct spu_t spu_t;
306 typedef struct subpicture_t subpicture_t;
307 typedef struct subpicture_sys_t subpicture_sys_t;
308 typedef struct subpicture_region_t subpicture_region_t;
309 typedef struct text_style_t text_style_t;
310
311 typedef struct image_handler_t image_handler_t;
312
313 /* Stream output */
314 typedef struct sout_instance_t sout_instance_t;
315 typedef struct sout_instance_sys_t sout_instance_sys_t;
316
317 typedef struct sout_input_t sout_input_t;
318 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
319
320 typedef struct sout_access_out_t sout_access_out_t;
321 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
322
323 typedef struct sout_mux_t sout_mux_t;
324 typedef struct sout_mux_sys_t sout_mux_sys_t;
325
326 typedef struct sout_stream_t    sout_stream_t;
327 typedef struct sout_stream_sys_t sout_stream_sys_t;
328
329 typedef struct sout_cfg_t       sout_cfg_t;
330 typedef struct sap_session_t    sap_session_t;
331 typedef struct sap_address_t sap_address_t;
332 typedef struct session_descriptor_t session_descriptor_t;
333 typedef struct announce_method_t announce_method_t;
334 typedef struct announce_handler_t announce_handler_t;
335 typedef struct sap_handler_t sap_handler_t;
336
337 /* Decoders */
338 typedef struct decoder_t      decoder_t;
339 typedef struct decoder_sys_t  decoder_sys_t;
340
341 /* Encoders */
342 typedef struct encoder_t      encoder_t;
343 typedef struct encoder_sys_t  encoder_sys_t;
344
345 /* Filters */
346 typedef struct filter_t filter_t;
347 typedef struct filter_sys_t filter_sys_t;
348
349 /* Network */
350 typedef struct network_socket_t network_socket_t;
351 typedef struct virtual_socket_t v_socket_t;
352 typedef struct sockaddr sockaddr;
353 typedef struct addrinfo addrinfo;
354 typedef struct vlc_acl_t vlc_acl_t;
355
356 /* Misc */
357 typedef struct iso639_lang_t iso639_lang_t;
358
359 /* block */
360 typedef struct block_t      block_t;
361 typedef struct block_fifo_t block_fifo_t;
362
363 /* httpd */
364 typedef struct httpd_t          httpd_t;
365 typedef struct httpd_host_t     httpd_host_t;
366 typedef struct httpd_url_t      httpd_url_t;
367 typedef struct httpd_client_t   httpd_client_t;
368 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
369 typedef struct httpd_message_t  httpd_message_t;
370 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
371 typedef struct httpd_file_t     httpd_file_t;
372 typedef struct httpd_file_sys_t httpd_file_sys_t;
373 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
374 typedef struct httpd_handler_t  httpd_handler_t;
375 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
376 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 );
377 typedef struct httpd_redirect_t httpd_redirect_t;
378 typedef struct httpd_stream_t httpd_stream_t;
379
380 /* TLS support */
381 typedef struct tls_t tls_t;
382 typedef struct tls_server_t tls_server_t;
383 typedef struct tls_session_t tls_session_t;
384
385 /* Hashing */
386 typedef struct md5_s md5_t;
387
388 /* XML */
389 typedef struct xml_t xml_t;
390 typedef struct xml_sys_t xml_sys_t;
391 typedef struct xml_reader_t xml_reader_t;
392 typedef struct xml_reader_sys_t xml_reader_sys_t;
393
394 /* vod server */
395 typedef struct vod_t     vod_t;
396 typedef struct vod_sys_t vod_sys_t;
397 typedef struct vod_media_t vod_media_t;
398
399 /* opengl */
400 typedef struct opengl_t     opengl_t;
401 typedef struct opengl_sys_t opengl_sys_t;
402
403 /* osdmenu */
404 typedef struct osd_menu_t   osd_menu_t;
405 typedef struct osd_state_t  osd_state_t;
406 typedef struct osd_event_t  osd_event_t;
407 typedef struct osd_button_t osd_button_t;
408 typedef struct osd_menu_state_t osd_menu_state_t;
409
410 /* VLM */
411 typedef struct vlm_t         vlm_t;
412 typedef struct vlm_message_t vlm_message_t;
413 typedef struct vlm_media_t   vlm_media_t;
414 typedef struct vlm_schedule_t vlm_schedule_t;
415
416 /* divers */
417 typedef struct vlc_meta_t    vlc_meta_t;
418
419 typedef struct counter_t     counter_t;
420 typedef struct counter_sample_t counter_sample_t;
421 typedef struct stats_handler_t stats_handler_t;
422 typedef struct input_stats_t input_stats_t;
423
424
425 /*****************************************************************************
426  * Variable callbacks
427  *****************************************************************************/
428 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
429                                    char const *,            /* variable name */
430                                    vlc_value_t,                 /* old value */
431                                    vlc_value_t,                 /* new value */
432                                    void * );                /* callback data */
433
434 /*****************************************************************************
435  * Plug-in stuff
436  *****************************************************************************/
437 #ifndef __PLUGIN__
438 #   define VLC_EXPORT( type, name, args ) type name args
439 #else
440 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
441     extern module_symbols_t* p_symbols;
442 #endif
443
444 /*****************************************************************************
445  * OS-specific headers and thread types
446  *****************************************************************************/
447 #if defined( WIN32 ) || defined( UNDER_CE )
448 #   define WIN32_LEAN_AND_MEAN
449 #   include <windows.h>
450 #   if defined( UNDER_CE )
451 #      define IS_WINNT 0
452 #   else
453 #      define IS_WINNT ( GetVersion() < 0x80000000 )
454 #   endif
455 #endif
456
457 #include "vlc_threads.h"
458
459 /*****************************************************************************
460  * Common structure members
461  *****************************************************************************/
462
463 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
464 #define VLC_COMMON_MEMBERS                                                  \
465 /** \name VLC_COMMON_MEMBERS                                                \
466  * these members are common for all vlc objects                             \
467  */                                                                         \
468 /**@{*/                                                                     \
469     int   i_object_id;                                                      \
470     int   i_object_type;                                                    \
471     char *psz_object_type;                                                  \
472     char *psz_object_name;                                                  \
473                                                                             \
474     /* Thread properties, if any */                                         \
475     vlc_bool_t   b_thread;                                                  \
476     vlc_thread_t thread_id;                                                 \
477                                                                             \
478     /* Object access lock */                                                \
479     vlc_mutex_t  object_lock;                                               \
480     vlc_cond_t   object_wait;                                               \
481                                                                             \
482     /* Object properties */                                                 \
483     volatile vlc_bool_t b_error;                  /**< set by the object */ \
484     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
485     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
486     volatile vlc_bool_t b_attached;               /**< set by the object */ \
487     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
488                                                                             \
489     /* Object variables */                                                  \
490     vlc_mutex_t     var_lock;                                               \
491     int             i_vars;                                                 \
492     variable_t *    p_vars;                                                 \
493                                                                             \
494     /* Stuff related to the libvlc structure */                             \
495     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
496     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
497                                                                             \
498     volatile int    i_refcount;                         /**< usage count */ \
499     vlc_object_t *  p_parent;                            /**< our parent */ \
500     vlc_object_t ** pp_children;                       /**< our children */ \
501     volatile int    i_children;                                             \
502                                                                             \
503     /* Private data */                                                      \
504     void *          p_private;                                              \
505                                                                             \
506     /** Just a reminder so that people don't cast garbage */                \
507     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
508 /**@}*/                                                                     \
509
510 /* VLC_OBJECT: attempt at doing a clever cast */
511 #define VLC_OBJECT( x ) \
512     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
513
514 /*****************************************************************************
515  * Macros and inline functions
516  *****************************************************************************/
517 #ifdef NTOHL_IN_SYS_PARAM_H
518 #   include <sys/param.h>
519
520 #elif !defined(WIN32) && !defined( UNDER_CE )
521 #   include <netinet/in.h>
522
523 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
524
525 /* CEIL: division with round to nearest greater integer */
526 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
527
528 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
529 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
530
531 /* __MAX and __MIN: self explanatory */
532 #ifndef __MAX
533 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
534 #endif
535 #ifndef __MIN
536 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
537 #endif
538
539 static int64_t GCD( int64_t a, int64_t b )
540 {
541     if( b ) return GCD( b, a % b );
542     else return a;
543 }
544
545 /* Dynamic array handling: realloc array, move data, increment position */
546 #if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
547 #   define VLCCVP (void**) /* Work-around for broken compiler */
548 #else
549 #   define VLCCVP
550 #endif
551 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
552     do                                                                        \
553     {                                                                         \
554         if( !i_oldsize ) (p_ar) = NULL;                                       \
555         (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
556         if( (i_oldsize) - (i_pos) )                                           \
557         {                                                                     \
558             memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos),                  \
559                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
560         }                                                                     \
561         (p_ar)[i_pos] = elem;                                                 \
562         (i_oldsize)++;                                                        \
563     }                                                                         \
564     while( 0 )
565
566 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
567     do                                                                        \
568     {                                                                         \
569         if( (i_oldsize) - (i_pos) - 1 )                                       \
570         {                                                                     \
571             memmove( (p_ar) + (i_pos),                                        \
572                      (p_ar) + (i_pos) + 1,                                    \
573                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
574         }                                                                     \
575         if( i_oldsize > 1 )                                                   \
576         {                                                                     \
577             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
578         }                                                                     \
579         else                                                                  \
580         {                                                                     \
581             free( p_ar );                                                     \
582             (p_ar) = NULL;                                                    \
583         }                                                                     \
584         (i_oldsize)--;                                                        \
585     }                                                                         \
586     while( 0 )
587
588
589 #define TAB_APPEND( count, tab, p )             \
590     if( (count) > 0 )                           \
591     {                                           \
592         (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
593     }                                           \
594     else                                        \
595     {                                           \
596         (tab) = malloc( sizeof( void ** ) );    \
597     }                                           \
598     (tab)[count] = (p);        \
599     (count)++
600
601 #define TAB_FIND( count, tab, p, index )        \
602     {                                           \
603         int _i_;                                \
604         (index) = -1;                           \
605         for( _i_ = 0; _i_ < (count); _i_++ )    \
606         {                                       \
607             if( (tab)[_i_] == (p) )  \
608             {                                   \
609                 (index) = _i_;                  \
610                 break;                          \
611             }                                   \
612         }                                       \
613     }
614
615 #define TAB_REMOVE( count, tab, p )             \
616     {                                           \
617         int _i_index_;                          \
618         TAB_FIND( count, tab, p, _i_index_ );   \
619         if( _i_index_ >= 0 )                    \
620         {                                       \
621             if( (count) > 1 )                     \
622             {                                   \
623                 memmove( ((void**)(tab) + _i_index_),    \
624                          ((void**)(tab) + _i_index_+1),  \
625                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
626             }                                   \
627             (count)--;                          \
628             if( (count) == 0 )                  \
629             {                                   \
630                 free( tab );                    \
631                 (tab) = NULL;                   \
632             }                                   \
633         }                                       \
634     }
635
636 /* MSB (big endian)/LSB (little endian) conversions - network order is always
637  * MSB, and should be used for both network communications and files. Note that
638  * byte orders other than little and big endians are not supported, but only
639  * the VAX seems to have such exotic properties. */
640 static inline uint16_t U16_AT( void const * _p )
641 {
642     uint8_t * p = (uint8_t *)_p;
643     return ( ((uint16_t)p[0] << 8) | p[1] );
644 }
645 static inline uint32_t U32_AT( void const * _p )
646 {
647     uint8_t * p = (uint8_t *)_p;
648     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
649               | ((uint32_t)p[2] << 8) | p[3] );
650 }
651 static inline uint64_t U64_AT( void const * _p )
652 {
653     uint8_t * p = (uint8_t *)_p;
654     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
655               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
656               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
657               | ((uint64_t)p[6] << 8) | p[7] );
658 }
659
660 static inline uint16_t GetWLE( void const * _p )
661 {
662     uint8_t * p = (uint8_t *)_p;
663     return ( ((uint16_t)p[1] << 8) | p[0] );
664 }
665 static inline uint32_t GetDWLE( void const * _p )
666 {
667     uint8_t * p = (uint8_t *)_p;
668     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
669               | ((uint32_t)p[1] << 8) | p[0] );
670 }
671 static inline uint64_t GetQWLE( void const * _p )
672 {
673     uint8_t * p = (uint8_t *)_p;
674     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
675               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
676               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
677               | ((uint64_t)p[1] << 8) | p[0] );
678 }
679
680 #define GetWBE( p )     U16_AT( p )
681 #define GetDWBE( p )    U32_AT( p )
682 #define GetQWBE( p )    U64_AT( p )
683
684 /* Helper writer functions */
685 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
686 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
687 {
688     p[1] = ( i_dw >>  8 )&0xff;
689     p[0] = ( i_dw       )&0xff;
690 }
691
692 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
693 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
694 {
695     p[3] = ( i_dw >> 24 )&0xff;
696     p[2] = ( i_dw >> 16 )&0xff;
697     p[1] = ( i_dw >>  8 )&0xff;
698     p[0] = ( i_dw       )&0xff;
699 }
700 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
701 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
702 {
703     SetDWLE( p,   i_qw&0xffffffff );
704     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
705 }
706 #define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
707 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
708 {
709     p[0] = ( i_dw >>  8 )&0xff;
710     p[1] = ( i_dw       )&0xff;
711 }
712
713 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
714 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
715 {
716     p[0] = ( i_dw >> 24 )&0xff;
717     p[1] = ( i_dw >> 16 )&0xff;
718     p[2] = ( i_dw >>  8 )&0xff;
719     p[3] = ( i_dw       )&0xff;
720 }
721 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
722 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
723 {
724     SetDWBE( p+4,   i_qw&0xffffffff );
725     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
726 }
727
728 #if WORDS_BIGENDIAN
729 #   define hton16(i)   ( i )
730 #   define hton32(i)   ( i )
731 #   define hton64(i)   ( i )
732 #   define ntoh16(i)   ( i )
733 #   define ntoh32(i)   ( i )
734 #   define ntoh64(i)   ( i )
735 #else
736 #   define hton16(i)   U16_AT(&i)
737 #   define hton32(i)   U32_AT(&i)
738 #   define hton64(i)   U64_AT(&i)
739 #   define ntoh16(i)   U16_AT(&i)
740 #   define ntoh32(i)   U32_AT(&i)
741 #   define ntoh64(i)   U64_AT(&i)
742 #endif
743
744 /* Format string sanity checks */
745 #ifdef HAVE_ATTRIBUTE_FORMAT
746 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
747 #else
748 #   define ATTRIBUTE_FORMAT(x,y)
749 #endif
750
751 /* Alignment of critical static data structures */
752 #ifdef ATTRIBUTE_ALIGNED_MAX
753 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
754 #else
755 #   define ATTR_ALIGN(align)
756 #endif
757
758 /* Alignment of critical dynamic data structure
759  *
760  * Not all platforms support memalign so we provide a vlc_memalign wrapper
761  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
762  * *pp_orig is the pointer that has to be freed afterwards.
763  */
764 #if 0
765 #ifdef HAVE_POSIX_MEMALIGN
766 #   define vlc_memalign(align,size,pp_orig) \
767     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
768 #endif
769 #endif
770 #ifdef HAVE_MEMALIGN
771     /* Some systems have memalign() but no declaration for it */
772     void * memalign( size_t align, size_t size );
773
774 #   define vlc_memalign(pp_orig,align,size) \
775     ( *(pp_orig) = memalign( align, size ) )
776
777 #else /* We don't have any choice but to align manually */
778 #   define vlc_memalign(pp_orig,align,size) \
779     (( *(pp_orig) = malloc( size + align - 1 )) \
780         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
781                        & (~(unsigned long)(align-1)) ) \
782         : NULL )
783
784 #endif
785
786 /* Stuff defined in src/extras/libc.c */
787 #ifndef HAVE_STRDUP
788 #   define strdup vlc_strdup
789     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
790 #elif !defined(__PLUGIN__)
791 #   define vlc_strdup NULL
792 #endif
793
794 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
795 #   define vasprintf vlc_vasprintf
796     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
797 #elif !defined(__PLUGIN__)
798 #   define vlc_vasprintf NULL
799 #endif
800
801 #if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
802 #   define asprintf vlc_asprintf
803     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
804 #elif !defined(__PLUGIN__)
805 #   define vlc_asprintf NULL
806 #endif
807
808 #ifndef HAVE_STRNDUP
809 #   if defined(STRNDUP_IN_GNOME_H) && \
810         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
811          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
812         /* Do nothing: gnome.h defines strndup for us */
813 #   else
814 #       define strndup vlc_strndup
815         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
816 #   endif
817 #elif !defined(__PLUGIN__)
818 #   define vlc_strndup NULL
819 #endif
820
821 #ifndef HAVE_ATOF
822 #   define atof vlc_atof
823     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
824 #elif !defined(__PLUGIN__)
825 #   define vlc_atof NULL
826 #endif
827
828 #ifndef HAVE_STRTOF
829 #   ifdef HAVE_STRTOD
830 #       define strtof strtod
831 #   endif
832 #endif
833
834 #ifndef HAVE_ATOLL
835 #   define atoll vlc_atoll
836     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
837 #elif !defined(__PLUGIN__)
838 #   define vlc_atoll NULL
839 #endif
840
841 #ifndef HAVE_STRTOLL
842 #   define strtoll vlc_strtoll
843     VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
844 #elif !defined(__PLUGIN__)
845 #   define vlc_strtoll NULL
846 #endif
847
848 #ifndef HAVE_SCANDIR
849 #   define scandir vlc_scandir
850 #   define alphasort vlc_alphasort
851     struct dirent;
852     VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
853     VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
854 #elif !defined(__PLUGIN__)
855 #   define vlc_scandir NULL
856 #   define vlc_alphasort NULL
857 #endif
858
859 #ifndef HAVE_GETENV
860 #   define getenv vlc_getenv
861     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
862 #elif !defined(__PLUGIN__)
863 #   define vlc_getenv NULL
864 #endif
865
866 #ifndef HAVE_STRCASECMP
867 #   ifndef HAVE_STRICMP
868 #       define strcasecmp vlc_strcasecmp
869         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
870 #   else
871 #       define strcasecmp stricmp
872 #       if !defined(__PLUGIN__)
873 #           define vlc_strcasecmp NULL
874 #       endif
875 #   endif
876 #elif !defined(__PLUGIN__)
877 #   define vlc_strcasecmp NULL
878 #endif
879
880 #ifndef HAVE_STRNCASECMP
881 #   ifndef HAVE_STRNICMP
882 #       define strncasecmp vlc_strncasecmp
883         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
884 #   else
885 #       define strncasecmp strnicmp
886 #       if !defined(__PLUGIN__)
887 #           define vlc_strncasecmp NULL
888 #       endif
889 #   endif
890 #elif !defined(__PLUGIN__)
891 #   define vlc_strncasecmp NULL
892 #endif
893
894 #ifndef HAVE_STRCASESTR
895 #   ifndef HAVE_STRISTR
896 #       define strcasestr vlc_strcasestr
897         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
898 #   else
899 #       define strcasestr stristr
900 #       if !defined(__PLUGIN__)
901 #           define vlc_strcasestr NULL
902 #       endif
903 #   endif
904 #elif !defined(__PLUGIN__)
905 #   define vlc_strcasestr NULL
906 #endif
907
908 #ifndef HAVE_DIRENT_H
909     typedef void DIR;
910 #   ifndef FILENAME_MAX
911 #       define FILENAME_MAX (260)
912 #   endif
913     struct dirent
914     {
915         long            d_ino;          /* Always zero. */
916         unsigned short  d_reclen;       /* Always zero. */
917         unsigned short  d_namlen;       /* Length of name in d_name. */
918         char            d_name[FILENAME_MAX]; /* File name. */
919     };
920 #   define opendir vlc_opendir
921 #   define readdir vlc_readdir
922 #   define closedir vlc_closedir
923     VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
924     VLC_EXPORT( void *, vlc_readdir, ( void * ) );
925     VLC_EXPORT( int, vlc_closedir, ( void * ) );
926 #else
927     struct dirent;  /* forward declaration for vlc_symbols.h */
928 #   if !defined(__PLUGIN__)
929 #       define vlc_opendir  NULL
930 #       define vlc_readdir  NULL
931 #       define vlc_closedir NULL
932 #   endif
933 #endif
934
935     VLC_EXPORT( void *, vlc_opendir_wrapper, ( const char * ) );
936     VLC_EXPORT( struct dirent *, vlc_readdir_wrapper, ( void * ) );
937     VLC_EXPORT( int, vlc_closedir_wrapper, ( void * ) );
938
939 /* Format type specifiers for 64 bits numbers */
940 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
941 #   if defined(__WORDSIZE) && __WORDSIZE == 64
942 #       define I64Fd "%ld"
943 #       define I64Fi "%li"
944 #       define I64Fo "%lo"
945 #       define I64Fu "%lu"
946 #       define I64Fx "%lx"
947 #       define I64FX "%lX"
948 #   else
949 #       define I64Fd "%lld"
950 #       define I64Fi "%lli"
951 #       define I64Fo "%llo"
952 #       define I64Fu "%llu"
953 #       define I64Fx "%llx"
954 #       define I64FX "%llX"
955 #   endif
956 #else
957 #   define I64Fd "%I64d"
958 #   define I64Fi "%I64i"
959 #   define I64Fo "%I64o"
960 #   define I64Fu "%I64u"
961 #   define I64Fx "%I64x"
962 #   define I64FX "%I64X"
963 #endif /* defined(WIN32)||defined(UNDER_CE) */
964
965 /* 64 bits integer constant suffix */
966 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
967 #   if defined(__WORDSIZE) && __WORDSIZE == 64
968 #       define I64C(x)         x##L
969 #       define UI64C(x)        x##UL
970 #   else
971 #       define I64C(x)         x##LL
972 #       define UI64C(x)        x##ULL
973 #   endif
974 #else
975 #   define I64C(x)         x##i64
976 #   define UI64C(x)        x##ui64
977 #endif /* defined(WIN32)||defined(UNDER_CE) */
978
979 #if defined(WIN32) || defined(UNDER_CE)
980 /* win32, cl and icl support */
981 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
982 #       define __attribute__(x)
983 #       define __inline__      __inline
984 #       define S_IFBLK         0x3000  /* Block */
985 #       define S_ISBLK(m)      (0)
986 #       define S_ISCHR(m)      (0)
987 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
988 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
989 #   endif
990
991 /* several type definitions */
992 #   if defined( __MINGW32__ )
993 #       if !defined( _OFF_T_ )
994             typedef long long _off_t;
995             typedef _off_t off_t;
996 #           define _OFF_T_
997 #       else
998 #           ifdef off_t
999 #               undef off_t
1000 #           endif
1001 #           define off_t long long
1002 #       endif
1003 #   endif
1004
1005 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
1006 #       if !defined( _OFF_T_DEFINED )
1007             typedef __int64 off_t;
1008 #           define _OFF_T_DEFINED
1009 #       else
1010             /* for wx compatibility typedef long off_t; */
1011 #           define off_t __int64
1012 #       endif
1013 #   endif
1014
1015 #   if defined( __BORLANDC__ )
1016 #       undef off_t
1017 #       define off_t unsigned __int64
1018 #   endif
1019
1020 #   ifndef O_NONBLOCK
1021 #       define O_NONBLOCK 0
1022 #   endif
1023
1024 #   ifndef alloca
1025 #       define alloca _alloca
1026 #   endif
1027
1028     /* These two are not defined in mingw32 (bug?) */
1029 #   ifndef snprintf
1030 #       define snprintf _snprintf
1031 #   endif
1032 #   ifndef vsnprintf
1033 #       define vsnprintf _vsnprintf
1034 #   endif
1035
1036 #   include <tchar.h>
1037 #endif
1038
1039 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1040 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1041
1042 /* vlc_wraptext (defined in src/extras/libc.c) */
1043 #define wraptext vlc_wraptext
1044 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
1045
1046 /* iconv wrappers (defined in src/extras/libc.c) */
1047 typedef void *vlc_iconv_t;
1048 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1049 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) );
1050 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1051
1052 /* execve wrapper (defined in src/extras/libc.c) */
1053 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 ) );
1054 #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)
1055
1056 /*****************************************************************************
1057  * CPU capabilities
1058  *****************************************************************************/
1059 #define CPU_CAPABILITY_NONE    0
1060 #define CPU_CAPABILITY_486     (1<<0)
1061 #define CPU_CAPABILITY_586     (1<<1)
1062 #define CPU_CAPABILITY_PPRO    (1<<2)
1063 #define CPU_CAPABILITY_MMX     (1<<3)
1064 #define CPU_CAPABILITY_3DNOW   (1<<4)
1065 #define CPU_CAPABILITY_MMXEXT  (1<<5)
1066 #define CPU_CAPABILITY_SSE     (1<<6)
1067 #define CPU_CAPABILITY_SSE2    (1<<7)
1068 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1069 #define CPU_CAPABILITY_FPU     (1<<31)
1070
1071 /*****************************************************************************
1072  * I18n stuff
1073  *****************************************************************************/
1074 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1075
1076 #if defined( ENABLE_NLS ) && \
1077      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1078       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1079       defined(MODULE_NAME_IS_pda))
1080     /* Declare nothing: gnome.h will do it for us */
1081 #elif defined( ENABLE_NLS )
1082 #   if defined( HAVE_INCLUDED_GETTEXT )
1083 #       include "libintl.h"
1084 #   else
1085 #       include <libintl.h>
1086 #   endif
1087 #   undef _
1088 #   define _(String) vlc_dgettext (PACKAGE_NAME, String)
1089 #   define N_(String) ((char*)(String))
1090 #else
1091 #   define _(String) ((char*)(String))
1092 #   define N_(String) ((char*)(String))
1093 #endif
1094
1095 /*****************************************************************************
1096  * libvlc features
1097  *****************************************************************************/
1098 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1099 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1100 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1101 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1102 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1103 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1104 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1105
1106 /*****************************************************************************
1107  * Additional vlc stuff
1108  *****************************************************************************/
1109 #include "vlc_symbols.h"
1110 #include "os_specific.h"
1111 #include "vlc_messages.h"
1112 #include "variables.h"
1113 #include "vlc_objects.h"
1114 #include "vlc_threads_funcs.h"
1115 #include "mtime.h"
1116 #include "modules.h"
1117 #include "main.h"
1118 #include "configuration.h"
1119
1120 #if defined( __BORLANDC__ )
1121 #   undef PACKAGE
1122 #   define PACKAGE
1123 #endif
1124