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