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