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