Forward declare vlc_url_t
[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
61 /*****************************************************************************
62  * Required system headers
63  *****************************************************************************/
64 #include <stdlib.h>
65 #include <stdarg.h>
66
67 #include <string.h>
68 #include <stdio.h>
69
70 #ifdef HAVE_SYS_TYPES_H
71 #   include <sys/types.h>
72 #endif
73
74 /*****************************************************************************
75  * Basic types definitions
76  *****************************************************************************/
77 #if defined( HAVE_STDINT_H )
78 #   include <stdint.h>
79 #elif defined( HAVE_INTTYPES_H )
80 #   include <inttypes.h>
81 #elif defined( SYS_CYGWIN )
82 #   include <sys/types.h>
83     /* Cygwin only defines half of these... */
84     typedef u_int8_t            uint8_t;
85     typedef u_int16_t           uint16_t;
86     typedef u_int32_t           uint32_t;
87     typedef u_int64_t           uint64_t;
88 #else
89     /* Fallback types (very x86-centric, sorry) */
90     typedef unsigned char       uint8_t;
91     typedef signed char         int8_t;
92     typedef unsigned short      uint16_t;
93     typedef signed short        int16_t;
94     typedef unsigned int        uint32_t;
95     typedef signed int          int32_t;
96 #   if defined( _MSC_VER ) \
97       || defined( UNDER_CE ) \
98       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
99     typedef unsigned __int64    uint64_t;
100     typedef signed __int64      int64_t;
101 #   else
102     typedef unsigned long long  uint64_t;
103     typedef signed long long    int64_t;
104 #   endif
105     typedef uint32_t            uintptr_t;
106     typedef int32_t             intptr_t;
107 #endif
108
109 typedef uint8_t                 byte_t;
110
111 /* Systems that don't have stdint.h may not define INT64_MIN and
112    INT64_MAX */
113 #ifndef INT64_MIN
114 #define INT64_MIN (-9223372036854775807LL-1)
115 #endif
116 #ifndef INT64_MAX
117 #define INT64_MAX (9223372036854775807LL)
118 #endif
119
120 /* ptrdiff_t definition */
121 #ifdef HAVE_STDDEF_H
122 #   include <stddef.h>
123 #else
124 #   include <malloc.h>
125 #   ifndef _PTRDIFF_T
126 #       define _PTRDIFF_T
127 /* Not portable in a 64-bit environment. */
128 typedef int                 ptrdiff_t;
129 #   endif
130 #endif
131
132 #if defined( WIN32 ) || defined( UNDER_CE )
133 #   include <malloc.h>
134 #   ifndef PATH_MAX
135 #       define PATH_MAX MAX_PATH
136 #   endif
137 #endif
138
139 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
140 typedef int                 ssize_t;
141 #endif
142
143 /* Counter for statistics and profiling */
144 typedef unsigned long       count_t;
145
146 /* DCT elements types */
147 typedef int16_t             dctelem_t;
148
149 /* Video buffer types */
150 typedef uint8_t             yuv_data_t;
151
152 /* Audio volume */
153 typedef uint16_t            audio_volume_t;
154
155 #ifndef HAVE_SOCKLEN_T
156 typedef int                 socklen_t;
157 #endif
158
159 /**
160  * High precision date or time interval
161  *
162  * Store a high precision date or time interval. The maximum precision is the
163  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
164  * time interval is then 292271 years, which should be long enough for any
165  * video). Dates are stored as microseconds since a common date (usually the
166  * epoch). Note that date and time intervals can be manipulated using regular
167  * arithmetic operators, and that no special functions are required.
168  */
169 typedef int64_t mtime_t;
170
171 /**
172  * The vlc_fourcc_t type.
173  *
174  * See http://www.webartz.com/fourcc/ for a very detailed list.
175  */
176 typedef uint32_t vlc_fourcc_t;
177
178 #ifdef WORDS_BIGENDIAN
179 #   define VLC_FOURCC( a, b, c, d ) \
180         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
181            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
182 #   define VLC_TWOCC( a, b ) \
183         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
184
185 #else
186 #   define VLC_FOURCC( a, b, c, d ) \
187         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
188            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
189 #   define VLC_TWOCC( a, b ) \
190         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
191
192 #endif
193
194 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
195 {
196 #ifdef WORDS_BIGENDIAN
197     psz_fourcc[0] = (uint32_t) (fcc >> 24);
198     psz_fourcc[1] = (uint32_t) (fcc >> 16);
199     psz_fourcc[2] = (uint32_t) (fcc >> 8);
200     psz_fourcc[3] = (uint32_t) (fcc);
201 #else
202     psz_fourcc[3] = (uint32_t) (fcc >> 24);
203     psz_fourcc[2] = (uint32_t) (fcc >> 16);
204     psz_fourcc[1] = (uint32_t) (fcc >> 8);
205     psz_fourcc[0] = (uint32_t) (fcc);
206 #endif
207 }
208
209 #define vlc_fourcc_to_char( a, b ) \
210     __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
211
212 /*****************************************************************************
213  * Classes declaration
214  *****************************************************************************/
215
216 /* Internal types */
217 typedef struct libvlc_global_data_t libvlc_global_data_t;
218 typedef struct libvlc_int_t libvlc_int_t;
219 typedef struct variable_t variable_t;
220 typedef struct date_t date_t;
221 typedef struct dict_entry_t dict_entry_t;
222 typedef struct dict_t dict_t;
223 typedef struct gc_object_t gc_object_t ;
224
225 /* Messages */
226 typedef struct msg_bank_t msg_bank_t;
227 typedef struct msg_queue_t msg_queue_t;
228 typedef struct msg_subscription_t msg_subscription_t;
229
230 /* Playlist */
231
232 /* FIXME */
233 /**
234  * Playlist commands
235  */
236 typedef enum {
237     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
238     PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
239     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
240                         /**  arg2 = playlist_item_t*          , res=can fail */
241     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
242     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
243     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
244 } playlist_command_t;
245
246
247 typedef struct playlist_t playlist_t;
248 typedef struct playlist_item_t playlist_item_t;
249 typedef struct playlist_view_t playlist_view_t;
250 typedef struct playlist_export_t playlist_export_t;
251 typedef struct services_discovery_t services_discovery_t;
252 typedef struct services_discovery_sys_t services_discovery_sys_t;
253 typedef struct playlist_add_t playlist_add_t;
254 typedef struct playlist_preparse_t playlist_preparse_t;
255 typedef struct playlist_fetcher_t playlist_fetcher_t;
256
257 /* Modules */
258 typedef struct module_bank_t module_bank_t;
259 typedef struct module_t module_t;
260 typedef struct module_config_t module_config_t;
261 typedef struct module_symbols_t module_symbols_t;
262 typedef struct module_cache_t module_cache_t;
263
264 typedef struct config_category_t config_category_t;
265
266 /* Interface */
267 typedef struct intf_thread_t intf_thread_t;
268 typedef struct intf_sys_t intf_sys_t;
269 typedef struct intf_console_t intf_console_t;
270 typedef struct intf_msg_t intf_msg_t;
271 typedef struct interaction_t interaction_t;
272 typedef struct interaction_dialog_t interaction_dialog_t;
273 typedef struct user_widget_t user_widget_t;
274
275 /* Input */
276 typedef struct input_thread_t input_thread_t;
277 typedef struct input_thread_sys_t input_thread_sys_t;
278 typedef struct input_item_t input_item_t;
279 typedef struct access_t access_t;
280 typedef struct access_sys_t access_sys_t;
281 typedef struct stream_t     stream_t;
282 typedef struct stream_sys_t stream_sys_t;
283 typedef struct demux_t  demux_t;
284 typedef struct demux_meta_t demux_meta_t;
285 typedef struct demux_sys_t demux_sys_t;
286 typedef struct es_out_t     es_out_t;
287 typedef struct es_out_id_t  es_out_id_t;
288 typedef struct es_out_sys_t es_out_sys_t;
289 typedef struct es_descriptor_t es_descriptor_t;
290 typedef struct seekpoint_t seekpoint_t;
291 typedef struct info_t info_t;
292 typedef struct info_category_t info_category_t;
293 typedef struct input_attachment_t input_attachment_t;
294
295 /* Format */
296 typedef struct audio_format_t audio_format_t;
297 typedef struct video_format_t video_format_t;
298 typedef struct subs_format_t subs_format_t;
299 typedef struct es_format_t es_format_t;
300 typedef struct video_palette_t video_palette_t;
301
302 /* Audio */
303 typedef struct aout_instance_t aout_instance_t;
304 typedef struct aout_sys_t aout_sys_t;
305 typedef struct aout_fifo_t aout_fifo_t;
306 typedef struct aout_input_t aout_input_t;
307 typedef struct aout_buffer_t aout_buffer_t;
308 typedef audio_format_t audio_sample_format_t;
309 typedef struct audio_date_t audio_date_t;
310 typedef struct aout_filter_t aout_filter_t;
311
312 /* Video */
313 typedef struct vout_thread_t vout_thread_t;
314 typedef struct vout_sys_t vout_sys_t;
315 typedef struct chroma_sys_t chroma_sys_t;
316
317 typedef video_format_t video_frame_format_t;
318 typedef struct picture_t picture_t;
319 typedef struct picture_sys_t picture_sys_t;
320 typedef struct picture_heap_t picture_heap_t;
321
322 /* Subpictures */
323 typedef struct spu_t spu_t;
324 typedef struct subpicture_t subpicture_t;
325 typedef struct subpicture_sys_t subpicture_sys_t;
326 typedef struct subpicture_region_t subpicture_region_t;
327 typedef struct text_style_t text_style_t;
328
329 typedef struct image_handler_t image_handler_t;
330
331 /* Stream output */
332 typedef struct sout_instance_t sout_instance_t;
333 typedef struct sout_instance_sys_t sout_instance_sys_t;
334
335 typedef struct sout_input_t sout_input_t;
336 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
337
338 typedef struct sout_access_out_t sout_access_out_t;
339 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
340
341 typedef struct sout_mux_t sout_mux_t;
342 typedef struct sout_mux_sys_t sout_mux_sys_t;
343
344 typedef struct sout_stream_t    sout_stream_t;
345 typedef struct sout_stream_sys_t sout_stream_sys_t;
346
347 typedef struct config_chain_t       config_chain_t;
348 typedef struct sap_session_t    sap_session_t;
349 typedef struct sap_address_t sap_address_t;
350 typedef struct session_descriptor_t session_descriptor_t;
351 typedef struct announce_method_t announce_method_t;
352 typedef struct announce_handler_t announce_handler_t;
353 typedef struct sap_handler_t sap_handler_t;
354
355 typedef struct sout_param_t sout_param_t;
356 typedef struct sout_pcat_t sout_pcat_t;
357 typedef struct sout_std_t sout_std_t;
358 typedef struct sout_display_t sout_display_t;
359 typedef struct sout_duplicate_t sout_duplicate_t;
360 typedef struct sout_transcode_t sout_transcode_t;
361 typedef struct sout_chain_t sout_chain_t;
362 typedef struct streaming_profile_t streaming_profile_t;
363 typedef struct sout_module_t sout_module_t;
364 typedef struct sout_gui_descr_t sout_gui_descr_t;
365 typedef struct profile_parser_t profile_parser_t;
366
367 /* Decoders */
368 typedef struct decoder_t         decoder_t;
369 typedef struct decoder_sys_t     decoder_sys_t;
370 typedef struct decoder_synchro_t decoder_synchro_t;
371
372 /* Encoders */
373 typedef struct encoder_t      encoder_t;
374 typedef struct encoder_sys_t  encoder_sys_t;
375
376 /* Filters */
377 typedef struct filter_t filter_t;
378 typedef struct filter_sys_t filter_sys_t;
379
380 /* Network */
381 typedef struct network_socket_t network_socket_t;
382 typedef struct virtual_socket_t v_socket_t;
383 typedef struct sockaddr sockaddr;
384 typedef struct addrinfo addrinfo;
385 typedef struct vlc_acl_t vlc_acl_t;
386 typedef struct vlc_url_t vlc_url_t;
387
388 /* Misc */
389 typedef struct iso639_lang_t iso639_lang_t;
390 typedef struct device_t device_t;
391 typedef struct device_probe_t device_probe_t;
392 typedef struct probe_sys_t probe_sys_t;
393
394 /* block */
395 typedef struct block_t      block_t;
396 typedef struct block_fifo_t block_fifo_t;
397
398 /* httpd */
399 typedef struct httpd_t          httpd_t;
400 typedef struct httpd_host_t     httpd_host_t;
401 typedef struct httpd_url_t      httpd_url_t;
402 typedef struct httpd_client_t   httpd_client_t;
403 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
404 typedef struct httpd_message_t  httpd_message_t;
405 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
406 typedef struct httpd_file_t     httpd_file_t;
407 typedef struct httpd_file_sys_t httpd_file_sys_t;
408 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
409 typedef struct httpd_handler_t  httpd_handler_t;
410 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
411 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 );
412 typedef struct httpd_redirect_t httpd_redirect_t;
413 typedef struct httpd_stream_t httpd_stream_t;
414
415 /* TLS support */
416 typedef struct tls_server_t tls_server_t;
417 typedef struct tls_session_t tls_session_t;
418
419 /* Hashing */
420 typedef struct md5_s md5_t;
421
422 /* XML */
423 typedef struct xml_t xml_t;
424 typedef struct xml_sys_t xml_sys_t;
425 typedef struct xml_reader_t xml_reader_t;
426 typedef struct xml_reader_sys_t xml_reader_sys_t;
427
428 /* vod server */
429 typedef struct vod_t     vod_t;
430 typedef struct vod_sys_t vod_sys_t;
431 typedef struct vod_media_t vod_media_t;
432
433 /* opengl */
434 typedef struct opengl_t     opengl_t;
435 typedef struct opengl_sys_t opengl_sys_t;
436
437 /* osdmenu */
438 typedef struct osd_menu_t   osd_menu_t;
439 typedef struct osd_state_t  osd_state_t;
440 typedef struct osd_event_t  osd_event_t;
441 typedef struct osd_button_t osd_button_t;
442 typedef struct osd_menu_state_t osd_menu_state_t;
443
444 /* VLM */
445 typedef struct vlm_t         vlm_t;
446 typedef struct vlm_message_t vlm_message_t;
447
448 /* divers */
449 typedef struct vlc_meta_t    vlc_meta_t;
450 typedef struct meta_export_t meta_export_t;
451
452 /* Stats */
453 typedef struct counter_t     counter_t;
454 typedef struct counter_sample_t counter_sample_t;
455 typedef struct stats_handler_t stats_handler_t;
456 typedef struct input_stats_t input_stats_t;
457 typedef struct global_stats_t global_stats_t;
458
459 /* Update */
460 typedef struct update_t update_t;
461 typedef struct update_iterator_t update_iterator_t;
462
463 /* Meta engine */
464 typedef struct meta_engine_t meta_engine_t;
465
466 /* stat/lstat/fstat */
467 #ifdef WIN32
468 #include <sys/stat.h>
469 struct _stati64;
470 #define stat _stati64
471 #define fstat _fstati64
472 /* You should otherwise use utf8_stat and utf8_lstat. */
473 #else
474 struct stat;
475 #endif
476
477 /*****************************************************************************
478  * Variable callbacks
479  *****************************************************************************/
480 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
481                                    char const *,            /* variable name */
482                                    vlc_value_t,                 /* old value */
483                                    vlc_value_t,                 /* new value */
484                                    void * );                /* callback data */
485
486 /*****************************************************************************
487  * Plug-in stuff
488  *****************************************************************************/
489
490 #include "vlc_modules_macros.h"
491
492 #if defined (WIN32) && defined (DLL_EXPORT)
493 #  ifdef __cplusplus
494 #    define VLC_PUBLIC_API __declspec(dllexport)
495 #    define VLC_PRIVATE_API __declspec(dllexport)
496 #    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
497 #    define VLC_INTERNAL( type, name, args ) extern "C" type name args
498 #  else
499 #    define VLC_PUBLIC_API extern __declspec(dllexport)
500 #    define VLC_PRIVATE_API extern __declspec(dllexport)
501 #    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
502 #    define VLC_INTERNAL( type, name, args ) type name args
503 #  endif
504 #else
505 #  ifdef __cplusplus
506 #    if HAVE_ATTRIBUTE_VISIBILITY
507 #      define VLC_PUBLIC_API __attribute__((visibility("default")))
508 #      define VLC_PRIVATE_API __attribute__((visibility("default")))
509 #      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
510 #      define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
511 #    else
512 #      define VLC_PUBLIC_API
513 #      define   VLC_EXPORT( type, name, args ) extern "C" type name args
514 #      define VLC_INTERNAL( type, name, args ) extern "C" type name args
515 #    endif
516 #  else
517 #    if HAVE_ATTRIBUTE_VISIBILITY
518 #      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
519 #      define VLC_PRIVATE_API extern __attribute__((visibility("default")))
520 #      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
521 #      define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
522 #    else
523 #      define VLC_PUBLIC_API extern
524 #      define VLC_PRIVATE_API extern
525 #      define   VLC_EXPORT( type, name, args ) type name args
526 #      define VLC_INTERNAL( type, name, args ) type name args
527 #    endif
528 #  endif
529 #endif
530
531 /*****************************************************************************
532  * OS-specific headers and thread types
533  *****************************************************************************/
534 #if defined( WIN32 ) || defined( UNDER_CE )
535 #   define WIN32_LEAN_AND_MEAN
536 #   include <windows.h>
537 #   if defined( UNDER_CE )
538 #      define IS_WINNT 0
539 #   else
540 #      define IS_WINNT ( GetVersion() < 0x80000000 )
541 #   endif
542 #endif
543
544 #include "vlc_threads.h"
545
546 typedef struct vlc_object_internals_t vlc_object_internals_t;
547
548 /*****************************************************************************
549  * Common structure members
550  *****************************************************************************/
551
552 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
553 #define VLC_COMMON_MEMBERS                                                  \
554 /** \name VLC_COMMON_MEMBERS                                                \
555  * these members are common for all vlc objects                             \
556  */                                                                         \
557 /**@{*/                                                                     \
558     vlc_object_internals_t *p_internals;                                    \
559     int   i_object_id;                                                      \
560     int   i_object_type;                                                    \
561     const char *psz_object_type;                                            \
562     const char *psz_object_name;                                            \
563                                                                             \
564     /* Messages header */                                                   \
565     char *psz_header;                                                       \
566     int  i_flags;                                                           \
567                                                                             \
568     /* Object access lock */                                                \
569     vlc_mutex_t  object_lock;                                               \
570     vlc_cond_t   object_wait;                                               \
571                                                                             \
572     /* Object properties */                                                 \
573     volatile vlc_bool_t b_error;                  /**< set by the object */ \
574     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
575     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
576     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
577                                                                             \
578     /* Stuff related to the libvlc structure */                             \
579     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
580                                                                             \
581     vlc_object_t *  p_parent;                            /**< our parent */ \
582     vlc_object_t ** pp_children;                       /**< our children */ \
583     volatile int    i_children;                                             \
584                                                                             \
585     /* Private data */                                                      \
586     void *          p_private;                                              \
587                                                                             \
588     /** Just a reminder so that people don't cast garbage */                \
589     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
590 /**@}*/                                                                     \
591
592 /* VLC_OBJECT: attempt at doing a clever cast */
593 #define VLC_OBJECT( x ) \
594     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
595
596 #define VLC_GC_MEMBERS                                                       \
597 /** \name VLC_GC_MEMBERS                                                     \
598  * these members are common to all objects that wish to be garbage-collected \
599  */                                                                          \
600 /**@{*/                                                                      \
601     int i_gc_refcount;                                                       \
602     void (*pf_destructor) ( gc_object_t * );                                 \
603     void *p_destructor_arg;                                                  \
604 /**@}*/
605
606 struct gc_object_t
607 {
608             VLC_GC_MEMBERS
609 };
610
611 static inline void __vlc_gc_incref( gc_object_t * p_gc )
612 {
613     p_gc->i_gc_refcount ++;
614 };
615
616 static inline void __vlc_gc_decref( gc_object_t *p_gc )
617 {
618     p_gc->i_gc_refcount -- ;
619
620     if( p_gc->i_gc_refcount == 0 )
621     {
622         p_gc->pf_destructor( p_gc );
623         /* Do not use the p_gc pointer from now on ! */
624      }
625 }
626
627 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
628 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
629 #define vlc_gc_init( a,b,c ) {  ((gc_object_t *)a)->i_gc_refcount = 0; \
630                               ((gc_object_t *)a)->pf_destructor = b; \
631                               ((gc_object_t *)a)->p_destructor_arg = c; }
632
633
634 /*****************************************************************************
635  * Macros and inline functions
636  *****************************************************************************/
637 #ifdef NTOHL_IN_SYS_PARAM_H
638 #   include <sys/param.h>
639
640 #elif !defined(WIN32) && !defined( UNDER_CE )
641 #   include <netinet/in.h>
642
643 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
644
645 /* CEIL: division with round to nearest greater integer */
646 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
647
648 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
649 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
650
651 /* __MAX and __MIN: self explanatory */
652 #ifndef __MAX
653 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
654 #endif
655 #ifndef __MIN
656 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
657 #endif
658
659 static int64_t GCD( int64_t a, int64_t b )
660 {
661     if( b ) return GCD( b, a % b );
662     else return a;
663 }
664
665 /* function imported from libavutil/common.h */
666 static inline uint8_t clip_uint8_vlc( int32_t a )
667 {
668     if( a&(~255) ) return (-a)>>31;
669     else           return a;
670 }
671
672 /* Malloc with automatic error */
673 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
674                                    if( !var ) return; } while(0)
675 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
676                                    if( !var ) return NULL; } while(0)
677 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
678                                    if( !var ) return VLC_ENOMEM; } while(0)
679 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
680                                       if( !var ) goto error; } while(0)
681 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
682                                     if( !var ) return;
683 #define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
684                                     if( !var ) return VLC_ENOMEM;
685 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
686                                     if( !var ) return NULL;
687
688 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
689
690 #define EMPTY_STR(str) (!str || !*str)
691
692 VLC_EXPORT( char const *, vlc_error, ( int ) );
693
694 #include <vlc_arrays.h>
695
696 /* MSB (big endian)/LSB (little endian) conversions - network order is always
697  * MSB, and should be used for both network communications and files. Note that
698  * byte orders other than little and big endians are not supported, but only
699  * the VAX seems to have such exotic properties. */
700 static inline uint16_t U16_AT( const void * _p )
701 {
702     const uint8_t * p = (const uint8_t *)_p;
703     return ( ((uint16_t)p[0] << 8) | p[1] );
704 }
705 static inline uint32_t U32_AT( const void * _p )
706 {
707     const uint8_t * p = (const uint8_t *)_p;
708     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
709               | ((uint32_t)p[2] << 8) | p[3] );
710 }
711 static inline uint64_t U64_AT( const void * _p )
712 {
713     const uint8_t * p = (const uint8_t *)_p;
714     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
715               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
716               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
717               | ((uint64_t)p[6] << 8) | p[7] );
718 }
719
720 static inline uint16_t GetWLE( const void * _p )
721 {
722     const uint8_t * p = (const uint8_t *)_p;
723     return ( ((uint16_t)p[1] << 8) | p[0] );
724 }
725 static inline uint32_t GetDWLE( const void * _p )
726 {
727     const uint8_t * p = (const uint8_t *)_p;
728     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
729               | ((uint32_t)p[1] << 8) | p[0] );
730 }
731 static inline uint64_t GetQWLE( const void * _p )
732 {
733     const uint8_t * p = (const uint8_t *)_p;
734     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
735               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
736               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
737               | ((uint64_t)p[1] << 8) | p[0] );
738 }
739
740 #define GetWBE( p )     U16_AT( p )
741 #define GetDWBE( p )    U32_AT( p )
742 #define GetQWBE( p )    U64_AT( p )
743
744 /* Helper writer functions */
745 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
746 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
747 {
748     p[1] = ( i_dw >>  8 )&0xff;
749     p[0] = ( i_dw       )&0xff;
750 }
751
752 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
753 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
754 {
755     p[3] = ( i_dw >> 24 )&0xff;
756     p[2] = ( i_dw >> 16 )&0xff;
757     p[1] = ( i_dw >>  8 )&0xff;
758     p[0] = ( i_dw       )&0xff;
759 }
760 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
761 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
762 {
763     SetDWLE( p,   i_qw&0xffffffff );
764     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
765 }
766 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
767 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
768 {
769     p[0] = ( i_dw >>  8 )&0xff;
770     p[1] = ( i_dw       )&0xff;
771 }
772
773 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
774 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
775 {
776     p[0] = ( i_dw >> 24 )&0xff;
777     p[1] = ( i_dw >> 16 )&0xff;
778     p[2] = ( i_dw >>  8 )&0xff;
779     p[3] = ( i_dw       )&0xff;
780 }
781 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
782 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
783 {
784     SetDWBE( p+4,   i_qw&0xffffffff );
785     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
786 }
787
788 #ifdef WORDS_BIGENDIAN
789 #   define hton16(i)   ( i )
790 #   define hton32(i)   ( i )
791 #   define hton64(i)   ( i )
792 #   define ntoh16(i)   ( i )
793 #   define ntoh32(i)   ( i )
794 #   define ntoh64(i)   ( i )
795 #else
796 #   define hton16(i)   U16_AT(&i)
797 #   define hton32(i)   U32_AT(&i)
798 #   define hton64(i)   U64_AT(&i)
799 #   define ntoh16(i)   U16_AT(&i)
800 #   define ntoh32(i)   U32_AT(&i)
801 #   define ntoh64(i)   U64_AT(&i)
802 #endif
803
804 /* Format string sanity checks */
805 #ifdef HAVE_ATTRIBUTE_FORMAT
806 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
807 #else
808 #   define ATTRIBUTE_FORMAT(x,y)
809 #endif
810
811 /* Alignment of critical static data structures */
812 #ifdef ATTRIBUTE_ALIGNED_MAX
813 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
814 #else
815 #   define ATTR_ALIGN(align)
816 #endif
817
818 /* */
819 #define VLC_UNUSED(x) (void)(x)
820
821 /* Alignment of critical dynamic data structure
822  *
823  * Not all platforms support memalign so we provide a vlc_memalign wrapper
824  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
825  * *pp_orig is the pointer that has to be freed afterwards.
826  */
827 #if 0
828 #ifdef HAVE_POSIX_MEMALIGN
829 #   define vlc_memalign(align,size,pp_orig) \
830     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
831 #endif
832 #endif
833 #ifdef HAVE_MEMALIGN
834     /* Some systems have memalign() but no declaration for it */
835     void * memalign( size_t align, size_t size );
836
837 #   define vlc_memalign(pp_orig,align,size) \
838     ( *(pp_orig) = memalign( align, size ) )
839
840 #else /* We don't have any choice but to align manually */
841 #   define vlc_memalign(pp_orig,align,size) \
842     (( *(pp_orig) = malloc( size + align - 1 )) \
843         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
844                        & (~(unsigned long)(align-1)) ) \
845         : NULL )
846
847 #endif
848
849 /* Stuff defined in src/extras/libc.c */
850 #ifndef HAVE_STRDUP
851 #   define strdup vlc_strdup
852     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
853 #elif !defined(__PLUGIN__)
854 #   define vlc_strdup NULL
855 #endif
856
857 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
858 #   define vasprintf vlc_vasprintf
859     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
860 #elif !defined(__PLUGIN__)
861 #   define vlc_vasprintf NULL
862 #endif
863
864 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
865 #   define asprintf vlc_asprintf
866     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
867 #elif !defined(__PLUGIN__)
868 #   define vlc_asprintf NULL
869 #endif
870
871 #ifndef HAVE_STRNDUP
872 #   if defined(STRNDUP_IN_GNOME_H) && \
873         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
874          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
875         /* Do nothing: gnome.h defines strndup for us */
876 #   else
877 #       define strndup vlc_strndup
878         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
879 #   endif
880 #elif !defined(__PLUGIN__)
881 #   define vlc_strndup NULL
882 #endif
883
884 #ifndef HAVE_STRNLEN
885 #   define strnlen vlc_strnlen
886     VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
887 #elif !defined(__PLUGIN__)
888 #   define vlc_strnlen NULL
889 #endif
890
891 #ifndef HAVE_STRLCPY
892 #   define strlcpy vlc_strlcpy
893     VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
894 #elif !defined(__PLUGIN__)
895 #   define vlc_strlcpy NULL
896 #endif
897
898 #ifndef HAVE_ATOF
899 #   define atof vlc_atof
900     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
901 #elif !defined(__PLUGIN__)
902 #   define vlc_atof NULL
903 #endif
904
905 #ifndef HAVE_STRTOF
906 #   ifdef HAVE_STRTOD
907 #       define strtof strtod
908 #   endif
909 #endif
910
911 #ifndef HAVE_ATOLL
912 #   define atoll vlc_atoll
913     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
914 #elif !defined(__PLUGIN__)
915 #   define vlc_atoll NULL
916 #endif
917
918 #ifndef HAVE_STRTOLL
919 #   define strtoll vlc_strtoll
920     VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
921 #elif !defined(__PLUGIN__)
922 #   define vlc_strtoll NULL
923 #endif
924
925 #if defined(SYS_BEOS) \
926  || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
927     typedef struct {
928         long long quot; /* Quotient. */
929         long long rem;  /* Remainder. */
930     } lldiv_t;
931 #   define lldiv vlc_lldiv
932     VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
933 #elif !defined(__PLUGIN__)
934 #   define vlc_lldiv NULL
935 #endif
936
937 #ifndef HAVE_SCANDIR
938 #   define scandir vlc_scandir
939 #   define alphasort vlc_alphasort
940     struct dirent;
941     VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
942     VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
943 #elif !defined(__PLUGIN__)
944 #   define vlc_scandir NULL
945 #   define vlc_alphasort NULL
946 #endif
947
948 #ifndef HAVE_GETENV
949 #   define getenv vlc_getenv
950     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
951 #elif !defined(__PLUGIN__)
952 #   define vlc_getenv NULL
953 #endif
954
955 #ifndef HAVE_STRCASECMP
956 #   ifndef HAVE_STRICMP
957 #       define strcasecmp vlc_strcasecmp
958         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
959 #   else
960 #       define strcasecmp stricmp
961 #       if !defined(__PLUGIN__)
962 #           define vlc_strcasecmp NULL
963 #       endif
964 #   endif
965 #elif !defined(__PLUGIN__)
966 #   define vlc_strcasecmp NULL
967 #endif
968
969 #ifndef HAVE_STRNCASECMP
970 #   ifndef HAVE_STRNICMP
971 #       define strncasecmp vlc_strncasecmp
972         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
973 #   else
974 #       define strncasecmp strnicmp
975 #       if !defined(__PLUGIN__)
976 #           define vlc_strncasecmp NULL
977 #       endif
978 #   endif
979 #elif !defined(__PLUGIN__)
980 #   define vlc_strncasecmp NULL
981 #endif
982
983 #ifndef HAVE_STRCASESTR
984 #   ifndef HAVE_STRISTR
985 #       define strcasestr vlc_strcasestr
986         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
987 #   else
988 #       define strcasestr stristr
989 #       if !defined(__PLUGIN__)
990 #           define vlc_strcasestr NULL
991 #       endif
992 #   endif
993 #elif !defined(__PLUGIN__)
994 #   define vlc_strcasestr NULL
995 #endif
996
997 #ifndef HAVE_DIRENT_H
998     typedef void DIR;
999 #   ifndef FILENAME_MAX
1000 #       define FILENAME_MAX (260)
1001 #   endif
1002     struct dirent
1003     {
1004         long            d_ino;          /* Always zero. */
1005         unsigned short  d_reclen;       /* Always zero. */
1006         unsigned short  d_namlen;       /* Length of name in d_name. */
1007         char            d_name[FILENAME_MAX]; /* File name. */
1008     };
1009 #   define opendir vlc_opendir
1010 #   define readdir vlc_readdir
1011 #   define closedir vlc_closedir
1012 #   define rewinddir vlc_rewindir
1013 #   define seekdir vlc_seekdir
1014 #   define telldir vlc_telldir
1015     VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
1016     VLC_EXPORT( void *, vlc_readdir, ( void * ) );
1017     VLC_EXPORT( int, vlc_closedir, ( void * ) );
1018     VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1019     VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1020     VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1021 #else
1022 #   if !defined(__PLUGIN__)
1023 #       define vlc_opendir  NULL
1024 #       define vlc_readdir  NULL
1025 #       define vlc_closedir NULL
1026 #   endif
1027 #endif
1028
1029 #if defined (WIN32)
1030 #   include <dirent.h>
1031  VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
1032  VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
1033  VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
1034  VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1035  VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1036  VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1037 #   define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
1038 #   define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
1039 #   define closedir vlc_wclosedir
1040 #   define _wopendir vlc_wopendir
1041 #   define _wreaddir vlc_wreaddir
1042 #   define _wclosedir vlc_wclosedir
1043 #   define rewinddir vlc_rewinddir
1044 #   define seekdir vlc_seekdir
1045 #   define telldir vlc_telldir
1046 #elif !defined(__PLUGIN__)
1047 #   define vlc_wclosedir NULL
1048 #endif
1049
1050 /* Format type specifiers for 64 bits numbers */
1051 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1052 #   if defined(__WORDSIZE) && __WORDSIZE == 64
1053 #       define I64Fd "%ld"
1054 #       define I64Fi "%li"
1055 #       define I64Fo "%lo"
1056 #       define I64Fu "%lu"
1057 #       define I64Fx "%lx"
1058 #       define I64FX "%lX"
1059 #   else
1060 #       define I64Fd "%lld"
1061 #       define I64Fi "%lli"
1062 #       define I64Fo "%llo"
1063 #       define I64Fu "%llu"
1064 #       define I64Fx "%llx"
1065 #       define I64FX "%llX"
1066 #   endif
1067 #else
1068 #   define I64Fd "%I64d"
1069 #   define I64Fi "%I64i"
1070 #   define I64Fo "%I64o"
1071 #   define I64Fu "%I64u"
1072 #   define I64Fx "%I64x"
1073 #   define I64FX "%I64X"
1074 #endif /* defined(WIN32)||defined(UNDER_CE) */
1075
1076 /* 64 bits integer constant suffix */
1077 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1078 #   if defined(__WORDSIZE) && __WORDSIZE == 64
1079 #       define I64C(x)         x##L
1080 #       define UI64C(x)        x##UL
1081 #   else
1082 #       define I64C(x)         x##LL
1083 #       define UI64C(x)        x##ULL
1084 #   endif
1085 #else
1086 #   define I64C(x)         x##i64
1087 #   define UI64C(x)        x##ui64
1088 #endif /* defined(WIN32)||defined(UNDER_CE) */
1089
1090 #if defined(WIN32) || defined(UNDER_CE)
1091 /* win32, cl and icl support */
1092 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
1093 #       define __attribute__(x)
1094 #       define __inline__      __inline
1095 #       define S_IFBLK         0x3000  /* Block */
1096 #       define S_ISBLK(m)      (0)
1097 #       define S_ISCHR(m)      (0)
1098 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
1099 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
1100 #   endif
1101
1102 /* several type definitions */
1103 #   if defined( __MINGW32__ )
1104 #       if !defined( _OFF_T_ )
1105             typedef long long _off_t;
1106             typedef _off_t off_t;
1107 #           define _OFF_T_
1108 #       else
1109 #           ifdef off_t
1110 #               undef off_t
1111 #           endif
1112 #           define off_t long long
1113 #       endif
1114 #   endif
1115
1116 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
1117 #       if !defined( _OFF_T_DEFINED )
1118             typedef __int64 off_t;
1119 #           define _OFF_T_DEFINED
1120 #       else
1121             /* for wx compatibility typedef long off_t; */
1122 #           define off_t __int64
1123 #       endif
1124 #   endif
1125
1126 #   if defined( __BORLANDC__ )
1127 #       undef off_t
1128 #       define off_t unsigned __int64
1129 #   endif
1130
1131 #   ifndef O_NONBLOCK
1132 #       define O_NONBLOCK 0
1133 #   endif
1134
1135 #   ifndef alloca
1136 #       define alloca _alloca
1137 #   endif
1138
1139     /* These two are not defined in mingw32 (bug?) */
1140 #   ifndef snprintf
1141 #       define snprintf _snprintf
1142 #   endif
1143 #   ifndef vsnprintf
1144 #       define vsnprintf _vsnprintf
1145 #   endif
1146
1147 #   include <tchar.h>
1148 #endif
1149
1150 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1151 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1152
1153 /* vlc_wraptext (defined in src/extras/libc.c) */
1154 #define wraptext vlc_wraptext
1155 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1156
1157 /* iconv wrappers (defined in src/extras/libc.c) */
1158 typedef void *vlc_iconv_t;
1159 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1160 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1161 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1162
1163 /* execve wrapper (defined in src/extras/libc.c) */
1164 VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const *pp_argv, char *const *pp_env, const char *psz_cwd, const char *p_in, size_t i_in, char **pp_data, size_t *pi_data ) );
1165 #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)
1166
1167 /*****************************************************************************
1168  * CPU capabilities
1169  *****************************************************************************/
1170 #define CPU_CAPABILITY_NONE    0
1171 #define CPU_CAPABILITY_486     (1<<0)
1172 #define CPU_CAPABILITY_586     (1<<1)
1173 #define CPU_CAPABILITY_PPRO    (1<<2)
1174 #define CPU_CAPABILITY_MMX     (1<<3)
1175 #define CPU_CAPABILITY_3DNOW   (1<<4)
1176 #define CPU_CAPABILITY_MMXEXT  (1<<5)
1177 #define CPU_CAPABILITY_SSE     (1<<6)
1178 #define CPU_CAPABILITY_SSE2    (1<<7)
1179 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1180 #define CPU_CAPABILITY_FPU     (1<<31)
1181 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1182
1183 /*****************************************************************************
1184  * I18n stuff
1185  *****************************************************************************/
1186 #ifdef WIN32
1187     VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1188 #endif
1189
1190 #if defined( ENABLE_NLS ) && \
1191      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1192       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1193       defined(MODULE_NAME_IS_pda))
1194     /* Declare nothing: gnome.h will do it for us */
1195 #elif defined( ENABLE_NLS )
1196 #   if defined( HAVE_INCLUDED_GETTEXT )
1197 #       include "libintl.h"
1198 #   else
1199 #       include <libintl.h>
1200 #   endif
1201 #   undef _
1202 #   ifdef WIN32
1203 #       define _(String) vlc_dgettext (PACKAGE_NAME, String)
1204 #   else
1205 #       define _(String) dgettext(PACKAGE_NAME, String)
1206 #   endif
1207 #   define N_(String) (String)
1208 #else
1209 #   define _(String) (String)
1210 #   define N_(String) (String)
1211 #endif
1212
1213 /*****************************************************************************
1214  * libvlc features
1215  *****************************************************************************/
1216 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1217 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1218 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1219 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1220 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1221 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1222 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1223
1224 /*****************************************************************************
1225  * Additional vlc stuff
1226  *****************************************************************************/
1227 #include "vlc_os_specific.h"
1228 #include "vlc_messages.h"
1229 #include "vlc_variables.h"
1230 #include "vlc_objects.h"
1231 #include "vlc_mtime.h"
1232 #include "vlc_threads_funcs.h"
1233 #include "vlc_modules.h"
1234 #include "main.h"
1235 #include "vlc_configuration.h"
1236
1237 /** The global thread var for msg stack context
1238  *  We store this as a static global variable so we don't need a vlc_object_t
1239  *  everywhere.
1240  *  This key is created in vlc_threads_init and is therefore ready to use at
1241  *  the very beginning of the universe */
1242 extern vlc_threadvar_t msg_context_global_key;
1243
1244
1245 #if defined( __BORLANDC__ )
1246 #   undef PACKAGE
1247 #   define PACKAGE
1248 #endif
1249
1250 #if defined( WIN32 ) || defined( UNDER_CE )
1251 #   define DIR_SEP_CHAR '\\'
1252 #   define DIR_SEP "\\"
1253 #else
1254 #   define DIR_SEP_CHAR '/'
1255 #   define DIR_SEP "/"
1256 #endif