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