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