b00424a3d4ed38bffc3184cf71b603f37f89cf21
[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
387 /* Misc */
388 typedef struct iso639_lang_t iso639_lang_t;
389 typedef struct device_t device_t;
390 typedef struct device_probe_t device_probe_t;
391 typedef struct probe_sys_t probe_sys_t;
392
393 /* block */
394 typedef struct block_t      block_t;
395 typedef struct block_fifo_t block_fifo_t;
396
397 /* httpd */
398 typedef struct httpd_t          httpd_t;
399 typedef struct httpd_host_t     httpd_host_t;
400 typedef struct httpd_url_t      httpd_url_t;
401 typedef struct httpd_client_t   httpd_client_t;
402 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
403 typedef struct httpd_message_t  httpd_message_t;
404 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
405 typedef struct httpd_file_t     httpd_file_t;
406 typedef struct httpd_file_sys_t httpd_file_sys_t;
407 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
408 typedef struct httpd_handler_t  httpd_handler_t;
409 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
410 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 );
411 typedef struct httpd_redirect_t httpd_redirect_t;
412 typedef struct httpd_stream_t httpd_stream_t;
413
414 /* TLS support */
415 typedef struct tls_server_t tls_server_t;
416 typedef struct tls_session_t tls_session_t;
417
418 /* Hashing */
419 typedef struct md5_s md5_t;
420
421 /* XML */
422 typedef struct xml_t xml_t;
423 typedef struct xml_sys_t xml_sys_t;
424 typedef struct xml_reader_t xml_reader_t;
425 typedef struct xml_reader_sys_t xml_reader_sys_t;
426
427 /* vod server */
428 typedef struct vod_t     vod_t;
429 typedef struct vod_sys_t vod_sys_t;
430 typedef struct vod_media_t vod_media_t;
431
432 /* opengl */
433 typedef struct opengl_t     opengl_t;
434 typedef struct opengl_sys_t opengl_sys_t;
435
436 /* osdmenu */
437 typedef struct osd_menu_t   osd_menu_t;
438 typedef struct osd_state_t  osd_state_t;
439 typedef struct osd_event_t  osd_event_t;
440 typedef struct osd_button_t osd_button_t;
441 typedef struct osd_menu_state_t osd_menu_state_t;
442
443 /* VLM */
444 typedef struct vlm_t         vlm_t;
445 typedef struct vlm_message_t vlm_message_t;
446
447 /* divers */
448 typedef struct vlc_meta_t    vlc_meta_t;
449 typedef struct meta_export_t meta_export_t;
450
451 /* Stats */
452 typedef struct counter_t     counter_t;
453 typedef struct counter_sample_t counter_sample_t;
454 typedef struct stats_handler_t stats_handler_t;
455 typedef struct input_stats_t input_stats_t;
456 typedef struct global_stats_t global_stats_t;
457
458 /* Update */
459 typedef struct update_t update_t;
460 typedef struct update_iterator_t update_iterator_t;
461
462 /* Meta engine */
463 typedef struct meta_engine_t meta_engine_t;
464
465 /* stat/lstat/fstat */
466 #ifdef WIN32
467 #include <sys/stat.h>
468 struct _stati64;
469 #define stat _stati64
470 #define fstat _fstati64
471 /* You should otherwise use utf8_stat and utf8_lstat. */
472 #else
473 struct stat;
474 #endif
475
476 /*****************************************************************************
477  * Variable callbacks
478  *****************************************************************************/
479 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
480                                    char const *,            /* variable name */
481                                    vlc_value_t,                 /* old value */
482                                    vlc_value_t,                 /* new value */
483                                    void * );                /* callback data */
484
485 /*****************************************************************************
486  * Plug-in stuff
487  *****************************************************************************/
488
489 #include "vlc_modules_macros.h"
490
491 #if defined (WIN32) && defined (DLL_EXPORT)
492 #  ifdef __cplusplus
493 #    define VLC_PUBLIC_API __declspec(dllexport)
494 #    define VLC_PRIVATE_API __declspec(dllexport)
495 #    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
496 #    define VLC_INTERNAL( type, name, args ) extern "C" type name args
497 #  else
498 #    define VLC_PUBLIC_API extern __declspec(dllexport)
499 #    define VLC_PRIVATE_API extern __declspec(dllexport)
500 #    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
501 #    define VLC_INTERNAL( type, name, args ) type name args
502 #  endif
503 #else
504 #  ifdef __cplusplus
505 #    if HAVE_ATTRIBUTE_VISIBILITY
506 #      define VLC_PUBLIC_API __attribute__((visibility("default")))
507 #      define VLC_PRIVATE_API __attribute__((visibility("default")))
508 #      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
509 #      define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
510 #    else
511 #      define VLC_PUBLIC_API
512 #      define   VLC_EXPORT( type, name, args ) extern "C" type name args
513 #      define VLC_INTERNAL( type, name, args ) extern "C" type name args
514 #    endif
515 #  else
516 #    if HAVE_ATTRIBUTE_VISIBILITY
517 #      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
518 #      define VLC_PRIVATE_API extern __attribute__((visibility("default")))
519 #      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
520 #      define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
521 #    else
522 #      define VLC_PUBLIC_API extern
523 #      define VLC_PRIVATE_API extern
524 #      define   VLC_EXPORT( type, name, args ) type name args
525 #      define VLC_INTERNAL( type, name, args ) type name args
526 #    endif
527 #  endif
528 #endif
529
530 /*****************************************************************************
531  * OS-specific headers and thread types
532  *****************************************************************************/
533 #if defined( WIN32 ) || defined( UNDER_CE )
534 #   define WIN32_LEAN_AND_MEAN
535 #   include <windows.h>
536 #   if defined( UNDER_CE )
537 #      define IS_WINNT 0
538 #   else
539 #      define IS_WINNT ( GetVersion() < 0x80000000 )
540 #   endif
541 #endif
542
543 #include "vlc_threads.h"
544
545 typedef struct vlc_object_internals_t vlc_object_internals_t;
546
547 /*****************************************************************************
548  * Common structure members
549  *****************************************************************************/
550
551 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
552 #define VLC_COMMON_MEMBERS                                                  \
553 /** \name VLC_COMMON_MEMBERS                                                \
554  * these members are common for all vlc objects                             \
555  */                                                                         \
556 /**@{*/                                                                     \
557     vlc_object_internals_t *p_internals;                                    \
558     int   i_object_id;                                                      \
559     int   i_object_type;                                                    \
560     const char *psz_object_type;                                            \
561     const char *psz_object_name;                                            \
562                                                                             \
563     /* Messages header */                                                   \
564     char *psz_header;                                                       \
565     int  i_flags;                                                           \
566                                                                             \
567     /* Object access lock */                                                \
568     vlc_mutex_t  object_lock;                                               \
569     vlc_cond_t   object_wait;                                               \
570                                                                             \
571     /* Object properties */                                                 \
572     volatile vlc_bool_t b_error;                  /**< set by the object */ \
573     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
574     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
575     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
576                                                                             \
577     /* Stuff related to the libvlc structure */                             \
578     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
579                                                                             \
580     vlc_object_t *  p_parent;                            /**< our parent */ \
581     vlc_object_t ** pp_children;                       /**< our children */ \
582     volatile int    i_children;                                             \
583                                                                             \
584     /* Private data */                                                      \
585     void *          p_private;                                              \
586                                                                             \
587     /** Just a reminder so that people don't cast garbage */                \
588     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
589 /**@}*/                                                                     \
590
591 /* VLC_OBJECT: attempt at doing a clever cast */
592 #define VLC_OBJECT( x ) \
593     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
594
595 #define VLC_GC_MEMBERS                                                       \
596 /** \name VLC_GC_MEMBERS                                                     \
597  * these members are common to all objects that wish to be garbage-collected \
598  */                                                                          \
599 /**@{*/                                                                      \
600     int i_gc_refcount;                                                       \
601     void (*pf_destructor) ( gc_object_t * );                                 \
602     void *p_destructor_arg;                                                  \
603 /**@}*/
604
605 struct gc_object_t
606 {
607             VLC_GC_MEMBERS
608 };
609
610 static inline void __vlc_gc_incref( gc_object_t * p_gc )
611 {
612     p_gc->i_gc_refcount ++;
613 };
614
615 static inline void __vlc_gc_decref( gc_object_t *p_gc )
616 {
617     p_gc->i_gc_refcount -- ;
618
619     if( p_gc->i_gc_refcount == 0 )
620     {
621         p_gc->pf_destructor( p_gc );
622         /* Do not use the p_gc pointer from now on ! */
623      }
624 }
625
626 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
627 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
628 #define vlc_gc_init( a,b,c ) {  ((gc_object_t *)a)->i_gc_refcount = 0; \
629                               ((gc_object_t *)a)->pf_destructor = b; \
630                               ((gc_object_t *)a)->p_destructor_arg = c; }
631
632
633 /*****************************************************************************
634  * Macros and inline functions
635  *****************************************************************************/
636 #ifdef NTOHL_IN_SYS_PARAM_H
637 #   include <sys/param.h>
638
639 #elif !defined(WIN32) && !defined( UNDER_CE )
640 #   include <netinet/in.h>
641
642 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
643
644 /* CEIL: division with round to nearest greater integer */
645 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
646
647 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
648 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
649
650 /* __MAX and __MIN: self explanatory */
651 #ifndef __MAX
652 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
653 #endif
654 #ifndef __MIN
655 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
656 #endif
657
658 static int64_t GCD( int64_t a, int64_t b )
659 {
660     if( b ) return GCD( b, a % b );
661     else return a;
662 }
663
664 /* function imported from libavutil/common.h */
665 static inline uint8_t clip_uint8_vlc( int32_t a )
666 {
667     if( a&(~255) ) return (-a)>>31;
668     else           return a;
669 }
670
671 /* Malloc with automatic error */
672 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
673                                    if( !var ) return; } while(0)
674 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
675                                    if( !var ) return NULL; } while(0)
676 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
677                                    if( !var ) return VLC_ENOMEM; } while(0)
678 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
679                                       if( !var ) goto error; } while(0)
680 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
681                                     if( !var ) return;
682 #define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
683                                     if( !var ) return VLC_ENOMEM;
684 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
685                                     if( !var ) return NULL;
686
687 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
688
689 #define EMPTY_STR(str) (!str || !*str)
690
691 VLC_EXPORT( char const *, vlc_error, ( int ) );
692
693 #include <vlc_arrays.h>
694
695 /* MSB (big endian)/LSB (little endian) conversions - network order is always
696  * MSB, and should be used for both network communications and files. Note that
697  * byte orders other than little and big endians are not supported, but only
698  * the VAX seems to have such exotic properties. */
699 static inline uint16_t U16_AT( const void * _p )
700 {
701     const uint8_t * p = (const uint8_t *)_p;
702     return ( ((uint16_t)p[0] << 8) | p[1] );
703 }
704 static inline uint32_t U32_AT( const void * _p )
705 {
706     const uint8_t * p = (const uint8_t *)_p;
707     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
708               | ((uint32_t)p[2] << 8) | p[3] );
709 }
710 static inline uint64_t U64_AT( const void * _p )
711 {
712     const uint8_t * p = (const uint8_t *)_p;
713     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
714               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
715               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
716               | ((uint64_t)p[6] << 8) | p[7] );
717 }
718
719 static inline uint16_t GetWLE( const void * _p )
720 {
721     const uint8_t * p = (const uint8_t *)_p;
722     return ( ((uint16_t)p[1] << 8) | p[0] );
723 }
724 static inline uint32_t GetDWLE( const void * _p )
725 {
726     const uint8_t * p = (const uint8_t *)_p;
727     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
728               | ((uint32_t)p[1] << 8) | p[0] );
729 }
730 static inline uint64_t GetQWLE( const void * _p )
731 {
732     const uint8_t * p = (const uint8_t *)_p;
733     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
734               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
735               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
736               | ((uint64_t)p[1] << 8) | p[0] );
737 }
738
739 #define GetWBE( p )     U16_AT( p )
740 #define GetDWBE( p )    U32_AT( p )
741 #define GetQWBE( p )    U64_AT( p )
742
743 /* Helper writer functions */
744 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
745 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
746 {
747     p[1] = ( i_dw >>  8 )&0xff;
748     p[0] = ( i_dw       )&0xff;
749 }
750
751 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
752 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
753 {
754     p[3] = ( i_dw >> 24 )&0xff;
755     p[2] = ( i_dw >> 16 )&0xff;
756     p[1] = ( i_dw >>  8 )&0xff;
757     p[0] = ( i_dw       )&0xff;
758 }
759 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
760 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
761 {
762     SetDWLE( p,   i_qw&0xffffffff );
763     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
764 }
765 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
766 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
767 {
768     p[0] = ( i_dw >>  8 )&0xff;
769     p[1] = ( i_dw       )&0xff;
770 }
771
772 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
773 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
774 {
775     p[0] = ( i_dw >> 24 )&0xff;
776     p[1] = ( i_dw >> 16 )&0xff;
777     p[2] = ( i_dw >>  8 )&0xff;
778     p[3] = ( i_dw       )&0xff;
779 }
780 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
781 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
782 {
783     SetDWBE( p+4,   i_qw&0xffffffff );
784     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
785 }
786
787 #ifdef WORDS_BIGENDIAN
788 #   define hton16(i)   ( i )
789 #   define hton32(i)   ( i )
790 #   define hton64(i)   ( i )
791 #   define ntoh16(i)   ( i )
792 #   define ntoh32(i)   ( i )
793 #   define ntoh64(i)   ( i )
794 #else
795 #   define hton16(i)   U16_AT(&i)
796 #   define hton32(i)   U32_AT(&i)
797 #   define hton64(i)   U64_AT(&i)
798 #   define ntoh16(i)   U16_AT(&i)
799 #   define ntoh32(i)   U32_AT(&i)
800 #   define ntoh64(i)   U64_AT(&i)
801 #endif
802
803 /* Format string sanity checks */
804 #ifdef HAVE_ATTRIBUTE_FORMAT
805 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
806 #else
807 #   define ATTRIBUTE_FORMAT(x,y)
808 #endif
809
810 /* Alignment of critical static data structures */
811 #ifdef ATTRIBUTE_ALIGNED_MAX
812 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
813 #else
814 #   define ATTR_ALIGN(align)
815 #endif
816
817 /* */
818 #define VLC_UNUSED(x) (void)(x)
819
820 /* Alignment of critical dynamic data structure
821  *
822  * Not all platforms support memalign so we provide a vlc_memalign wrapper
823  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
824  * *pp_orig is the pointer that has to be freed afterwards.
825  */
826 #if 0
827 #ifdef HAVE_POSIX_MEMALIGN
828 #   define vlc_memalign(align,size,pp_orig) \
829     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
830 #endif
831 #endif
832 #ifdef HAVE_MEMALIGN
833     /* Some systems have memalign() but no declaration for it */
834     void * memalign( size_t align, size_t size );
835
836 #   define vlc_memalign(pp_orig,align,size) \
837     ( *(pp_orig) = memalign( align, size ) )
838
839 #else /* We don't have any choice but to align manually */
840 #   define vlc_memalign(pp_orig,align,size) \
841     (( *(pp_orig) = malloc( size + align - 1 )) \
842         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
843                        & (~(unsigned long)(align-1)) ) \
844         : NULL )
845
846 #endif
847
848 /* Stuff defined in src/extras/libc.c */
849 #ifndef HAVE_STRDUP
850 #   define strdup vlc_strdup
851     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
852 #elif !defined(__PLUGIN__)
853 #   define vlc_strdup NULL
854 #endif
855
856 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
857 #   define vasprintf vlc_vasprintf
858     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
859 #elif !defined(__PLUGIN__)
860 #   define vlc_vasprintf NULL
861 #endif
862
863 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
864 #   define asprintf vlc_asprintf
865     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
866 #elif !defined(__PLUGIN__)
867 #   define vlc_asprintf NULL
868 #endif
869
870 #ifndef HAVE_STRNDUP
871 #   if defined(STRNDUP_IN_GNOME_H) && \
872         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
873          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
874         /* Do nothing: gnome.h defines strndup for us */
875 #   else
876 #       define strndup vlc_strndup
877         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
878 #   endif
879 #elif !defined(__PLUGIN__)
880 #   define vlc_strndup NULL
881 #endif
882
883 #ifndef HAVE_STRNLEN
884 #   define strnlen vlc_strnlen
885     VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
886 #elif !defined(__PLUGIN__)
887 #   define vlc_strnlen NULL
888 #endif
889
890 #ifndef HAVE_STRLCPY
891 #   define strlcpy vlc_strlcpy
892     VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
893 #elif !defined(__PLUGIN__)
894 #   define vlc_strlcpy NULL
895 #endif
896
897 #ifndef HAVE_ATOF
898 #   define atof vlc_atof
899     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
900 #elif !defined(__PLUGIN__)
901 #   define vlc_atof NULL
902 #endif
903
904 #ifndef HAVE_STRTOF
905 #   ifdef HAVE_STRTOD
906 #       define strtof strtod
907 #   endif
908 #endif
909
910 #ifndef HAVE_ATOLL
911 #   define atoll vlc_atoll
912     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
913 #elif !defined(__PLUGIN__)
914 #   define vlc_atoll NULL
915 #endif
916
917 #ifndef HAVE_STRTOLL
918 #   define strtoll vlc_strtoll
919     VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
920 #elif !defined(__PLUGIN__)
921 #   define vlc_strtoll NULL
922 #endif
923
924 #if defined(SYS_BEOS) \
925  || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
926     typedef struct {
927         long long quot; /* Quotient. */
928         long long rem;  /* Remainder. */
929     } lldiv_t;
930 #   define lldiv vlc_lldiv
931     VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
932 #elif !defined(__PLUGIN__)
933 #   define vlc_lldiv NULL
934 #endif
935
936 #ifndef HAVE_SCANDIR
937 #   define scandir vlc_scandir
938 #   define alphasort vlc_alphasort
939     struct dirent;
940     VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
941     VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
942 #elif !defined(__PLUGIN__)
943 #   define vlc_scandir NULL
944 #   define vlc_alphasort NULL
945 #endif
946
947 #ifndef HAVE_GETENV
948 #   define getenv vlc_getenv
949     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
950 #elif !defined(__PLUGIN__)
951 #   define vlc_getenv NULL
952 #endif
953
954 #ifndef HAVE_STRCASECMP
955 #   ifndef HAVE_STRICMP
956 #       define strcasecmp vlc_strcasecmp
957         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
958 #   else
959 #       define strcasecmp stricmp
960 #       if !defined(__PLUGIN__)
961 #           define vlc_strcasecmp NULL
962 #       endif
963 #   endif
964 #elif !defined(__PLUGIN__)
965 #   define vlc_strcasecmp NULL
966 #endif
967
968 #ifndef HAVE_STRNCASECMP
969 #   ifndef HAVE_STRNICMP
970 #       define strncasecmp vlc_strncasecmp
971         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
972 #   else
973 #       define strncasecmp strnicmp
974 #       if !defined(__PLUGIN__)
975 #           define vlc_strncasecmp NULL
976 #       endif
977 #   endif
978 #elif !defined(__PLUGIN__)
979 #   define vlc_strncasecmp NULL
980 #endif
981
982 #ifndef HAVE_STRCASESTR
983 #   ifndef HAVE_STRISTR
984 #       define strcasestr vlc_strcasestr
985         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
986 #   else
987 #       define strcasestr stristr
988 #       if !defined(__PLUGIN__)
989 #           define vlc_strcasestr NULL
990 #       endif
991 #   endif
992 #elif !defined(__PLUGIN__)
993 #   define vlc_strcasestr NULL
994 #endif
995
996 #ifndef HAVE_DIRENT_H
997     typedef void DIR;
998 #   ifndef FILENAME_MAX
999 #       define FILENAME_MAX (260)
1000 #   endif
1001     struct dirent
1002     {
1003         long            d_ino;          /* Always zero. */
1004         unsigned short  d_reclen;       /* Always zero. */
1005         unsigned short  d_namlen;       /* Length of name in d_name. */
1006         char            d_name[FILENAME_MAX]; /* File name. */
1007     };
1008 #   define opendir vlc_opendir
1009 #   define readdir vlc_readdir
1010 #   define closedir vlc_closedir
1011 #   define rewinddir vlc_rewindir
1012 #   define seekdir vlc_seekdir
1013 #   define telldir vlc_telldir
1014     VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
1015     VLC_EXPORT( void *, vlc_readdir, ( void * ) );
1016     VLC_EXPORT( int, vlc_closedir, ( void * ) );
1017     VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1018     VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1019     VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1020 #else
1021 #   if !defined(__PLUGIN__)
1022 #       define vlc_opendir  NULL
1023 #       define vlc_readdir  NULL
1024 #       define vlc_closedir NULL
1025 #   endif
1026 #endif
1027
1028 #if defined (WIN32)
1029 #   include <dirent.h>
1030 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
1031 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
1032 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
1033 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1034 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1035 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1036 #   define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
1037 #   define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
1038 #   define closedir vlc_wclosedir
1039 #   define _wopendir vlc_wopendir
1040 #   define _wreaddir vlc_wreaddir
1041 #   define _wclosedir vlc_wclosedir
1042 #   define rewinddir vlc_rewinddir
1043 #   define seekdir vlc_seekdir
1044 #   define telldir vlc_telldir
1045 #elif !defined(__PLUGIN__)
1046 #   define vlc_wclosedir NULL
1047 #endif
1048
1049 /* Format type specifiers for 64 bits numbers */
1050 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1051 #   if defined(__WORDSIZE) && __WORDSIZE == 64
1052 #       define I64Fd "%ld"
1053 #       define I64Fi "%li"
1054 #       define I64Fo "%lo"
1055 #       define I64Fu "%lu"
1056 #       define I64Fx "%lx"
1057 #       define I64FX "%lX"
1058 #   else
1059 #       define I64Fd "%lld"
1060 #       define I64Fi "%lli"
1061 #       define I64Fo "%llo"
1062 #       define I64Fu "%llu"
1063 #       define I64Fx "%llx"
1064 #       define I64FX "%llX"
1065 #   endif
1066 #else
1067 #   define I64Fd "%I64d"
1068 #   define I64Fi "%I64i"
1069 #   define I64Fo "%I64o"
1070 #   define I64Fu "%I64u"
1071 #   define I64Fx "%I64x"
1072 #   define I64FX "%I64X"
1073 #endif /* defined(WIN32)||defined(UNDER_CE) */
1074
1075 /* 64 bits integer constant suffix */
1076 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1077 #   if defined(__WORDSIZE) && __WORDSIZE == 64
1078 #       define I64C(x)         x##L
1079 #       define UI64C(x)        x##UL
1080 #   else
1081 #       define I64C(x)         x##LL
1082 #       define UI64C(x)        x##ULL
1083 #   endif
1084 #else
1085 #   define I64C(x)         x##i64
1086 #   define UI64C(x)        x##ui64
1087 #endif /* defined(WIN32)||defined(UNDER_CE) */
1088
1089 #if defined(WIN32) || defined(UNDER_CE)
1090 /* win32, cl and icl support */
1091 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
1092 #       define __attribute__(x)
1093 #       define __inline__      __inline
1094 #       define S_IFBLK         0x3000  /* Block */
1095 #       define S_ISBLK(m)      (0)
1096 #       define S_ISCHR(m)      (0)
1097 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
1098 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
1099 #   endif
1100
1101 /* several type definitions */
1102 #   if defined( __MINGW32__ )
1103 #       if !defined( _OFF_T_ )
1104             typedef long long _off_t;
1105             typedef _off_t off_t;
1106 #           define _OFF_T_
1107 #       else
1108 #           ifdef off_t
1109 #               undef off_t
1110 #           endif
1111 #           define off_t long long
1112 #       endif
1113 #   endif
1114
1115 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
1116 #       if !defined( _OFF_T_DEFINED )
1117             typedef __int64 off_t;
1118 #           define _OFF_T_DEFINED
1119 #       else
1120             /* for wx compatibility typedef long off_t; */
1121 #           define off_t __int64
1122 #       endif
1123 #   endif
1124
1125 #   if defined( __BORLANDC__ )
1126 #       undef off_t
1127 #       define off_t unsigned __int64
1128 #   endif
1129
1130 #   ifndef O_NONBLOCK
1131 #       define O_NONBLOCK 0
1132 #   endif
1133
1134 #   ifndef alloca
1135 #       define alloca _alloca
1136 #   endif
1137
1138     /* These two are not defined in mingw32 (bug?) */
1139 #   ifndef snprintf
1140 #       define snprintf _snprintf
1141 #   endif
1142 #   ifndef vsnprintf
1143 #       define vsnprintf _vsnprintf
1144 #   endif
1145
1146 #   include <tchar.h>
1147 #endif
1148
1149 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1150 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1151
1152 /* vlc_wraptext (defined in src/extras/libc.c) */
1153 #define wraptext vlc_wraptext
1154 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1155
1156 /* iconv wrappers (defined in src/extras/libc.c) */
1157 typedef void *vlc_iconv_t;
1158 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1159 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1160 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1161
1162 /* execve wrapper (defined in src/extras/libc.c) */
1163 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 ) );
1164 #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)
1165
1166 /*****************************************************************************
1167  * CPU capabilities
1168  *****************************************************************************/
1169 #define CPU_CAPABILITY_NONE    0
1170 #define CPU_CAPABILITY_486     (1<<0)
1171 #define CPU_CAPABILITY_586     (1<<1)
1172 #define CPU_CAPABILITY_PPRO    (1<<2)
1173 #define CPU_CAPABILITY_MMX     (1<<3)
1174 #define CPU_CAPABILITY_3DNOW   (1<<4)
1175 #define CPU_CAPABILITY_MMXEXT  (1<<5)
1176 #define CPU_CAPABILITY_SSE     (1<<6)
1177 #define CPU_CAPABILITY_SSE2    (1<<7)
1178 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1179 #define CPU_CAPABILITY_FPU     (1<<31)
1180 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1181
1182 /*****************************************************************************
1183  * I18n stuff
1184  *****************************************************************************/
1185 #ifdef WIN32
1186 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1187 #endif
1188
1189 #if defined( ENABLE_NLS ) && \
1190      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1191       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1192       defined(MODULE_NAME_IS_pda))
1193     /* Declare nothing: gnome.h will do it for us */
1194 #elif defined( ENABLE_NLS )
1195 #   if defined( HAVE_INCLUDED_GETTEXT )
1196 #       include "libintl.h"
1197 #   else
1198 #       include <libintl.h>
1199 #   endif
1200 #   undef _
1201 #   ifdef WIN32
1202 #       define _(String) vlc_dgettext (PACKAGE_NAME, String)
1203 #   else
1204 #       define _(String) dgettext(PACKAGE_NAME, String)
1205 #   endif
1206 #   define N_(String) (String)
1207 #else
1208 #   define _(String) (String)
1209 #   define N_(String) (String)
1210 #endif
1211
1212 /*****************************************************************************
1213  * libvlc features
1214  *****************************************************************************/
1215 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1216 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1217 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1218 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1219 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1220 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1221 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1222
1223 /*****************************************************************************
1224  * Additional vlc stuff
1225  *****************************************************************************/
1226 #include "vlc_os_specific.h"
1227 #include "vlc_messages.h"
1228 #include "vlc_variables.h"
1229 #include "vlc_objects.h"
1230 #include "vlc_mtime.h"
1231 #include "vlc_threads_funcs.h"
1232 #include "vlc_modules.h"
1233 #include "main.h"
1234 #include "vlc_configuration.h"
1235
1236 /** The global thread var for msg stack context
1237  *  We store this as a static global variable so we don't need a vlc_object_t
1238  *  everywhere.
1239  *  This key is created in vlc_threads_init and is therefore ready to use at
1240  *  the very beginning of the universe */
1241 extern vlc_threadvar_t msg_context_global_key;
1242
1243
1244 #if defined( __BORLANDC__ )
1245 #   undef PACKAGE
1246 #   define PACKAGE
1247 #endif
1248
1249 #if defined( WIN32 ) || defined( UNDER_CE )
1250 #   define DIR_SEP_CHAR '\\'
1251 #   define DIR_SEP "\\"
1252 #else
1253 #   define DIR_SEP_CHAR '/'
1254 #   define DIR_SEP "/"
1255 #endif