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