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