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