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