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