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