]> git.sesse.net Git - vlc/blob - include/vlc_common.h
3f16671f93a89ebfe85d0cc8f3d217da96588a01
[vlc] / include / vlc_common.h
1 /*****************************************************************************
2  * common.h: common definitions
3  * Collection of useful common types and macros definitions
4  *****************************************************************************
5  * Copyright (C) 1998-2005 the VideoLAN team
6  * $Id$
7  *
8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
9  *          Vincent Seguin <seguin@via.ecp.fr>
10  *          Gildas Bazin <gbazin@videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /**
28  * \file
29  * This file is a collection of common definitions and types
30  */
31
32 /*****************************************************************************
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 #include "modules_inner.h"
61
62 /*****************************************************************************
63  * Required system headers
64  *****************************************************************************/
65 #include <stdlib.h>
66 #include <stdarg.h>
67
68 #ifdef HAVE_STRING_H
69 #   include <string.h>                                         /* strerror() */
70 #endif
71
72 #ifdef HAVE_SYS_TYPES_H
73 #   include <sys/types.h>
74 #endif
75
76 /*****************************************************************************
77  * Basic types definitions
78  *****************************************************************************/
79 #if defined( HAVE_STDINT_H )
80 #   include <stdint.h>
81 #elif defined( HAVE_INTTYPES_H )
82 #   include <inttypes.h>
83 #elif defined( SYS_CYGWIN )
84 #   include <sys/types.h>
85     /* Cygwin only defines half of these... */
86     typedef u_int8_t            uint8_t;
87     typedef u_int16_t           uint16_t;
88     typedef u_int32_t           uint32_t;
89     typedef u_int64_t           uint64_t;
90 #else
91     /* Fallback types (very x86-centric, sorry) */
92     typedef unsigned char       uint8_t;
93     typedef signed char         int8_t;
94     typedef unsigned short      uint16_t;
95     typedef signed short        int16_t;
96     typedef unsigned int        uint32_t;
97     typedef signed int          int32_t;
98 #   if defined( _MSC_VER ) \
99       || defined( UNDER_CE ) \
100       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
101     typedef unsigned __int64    uint64_t;
102     typedef signed __int64      int64_t;
103 #   else
104     typedef unsigned long long  uint64_t;
105     typedef signed long long    int64_t;
106 #   endif
107     typedef uint32_t            uintptr_t;
108     typedef int32_t             intptr_t;
109 #endif
110
111 typedef uint8_t                 byte_t;
112
113 /* Systems that don't have stdint.h may not define INT64_MIN and
114    INT64_MAX */
115 #ifndef INT64_MIN
116 #define INT64_MIN (-9223372036854775807LL-1)
117 #endif
118 #ifndef INT64_MAX
119 #define INT64_MAX (9223372036854775807LL)
120 #endif
121
122 /* ptrdiff_t definition */
123 #ifdef HAVE_STDDEF_H
124 #   include <stddef.h>
125 #else
126 #   include <malloc.h>
127 #   ifndef _PTRDIFF_T
128 #       define _PTRDIFF_T
129 /* Not portable in a 64-bit environment. */
130 typedef int                 ptrdiff_t;
131 #   endif
132 #endif
133
134 #if defined( WIN32 ) || defined( UNDER_CE )
135 #   include <malloc.h>
136 #   ifndef PATH_MAX
137 #       define PATH_MAX MAX_PATH
138 #   endif
139 #endif
140
141 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
142 typedef int                 ssize_t;
143 #endif
144
145 /* Counter for statistics and profiling */
146 typedef unsigned long       count_t;
147
148 /* DCT elements types */
149 typedef int16_t             dctelem_t;
150
151 /* Video buffer types */
152 typedef uint8_t             yuv_data_t;
153
154 /* Audio volume */
155 typedef uint16_t            audio_volume_t;
156
157 #ifndef HAVE_SOCKLEN_T
158 typedef int                 socklen_t;
159 #endif
160
161 /**
162  * High precision date or time interval
163  *
164  * Store a high precision date or time interval. The maximum precision is the
165  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
166  * time interval is then 292271 years, which should be long enough for any
167  * video). Dates are stored as microseconds since a common date (usually the
168  * epoch). Note that date and time intervals can be manipulated using regular
169  * arithmetic operators, and that no special functions are required.
170  */
171 typedef int64_t mtime_t;
172
173 /**
174  * The vlc_fourcc_t type.
175  *
176  * See http://www.webartz.com/fourcc/ for a very detailed list.
177  */
178 typedef uint32_t vlc_fourcc_t;
179
180 #ifdef WORDS_BIGENDIAN
181 #   define VLC_FOURCC( a, b, c, d ) \
182         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
183            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
184 #   define VLC_TWOCC( a, b ) \
185         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
186
187 #else
188 #   define VLC_FOURCC( a, b, c, d ) \
189         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
190            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
191 #   define VLC_TWOCC( a, b ) \
192         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
193
194 #endif
195
196 /*****************************************************************************
197  * Classes declaration
198  *****************************************************************************/
199
200 /* Internal types */
201 typedef struct libvlc_t libvlc_t;
202 typedef struct vlc_t vlc_t;
203 typedef struct variable_t variable_t;
204 typedef struct date_t date_t;
205
206 /* Messages */
207 typedef struct msg_bank_t msg_bank_t;
208 typedef struct msg_queue_t msg_queue_t;
209 typedef struct msg_subscription_t msg_subscription_t;
210
211 /* Playlist */
212
213 /* FIXME */
214 /**
215  * Playlist commands
216  */
217 typedef enum {
218     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
219     PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
220     PLAYLIST_VIEWPLAY,  /**< arg1= int, arg2= playlist_item_t*,*/
221                         /**  arg3 = playlist_item_t*          , res=can fail */
222     PLAYLIST_ITEMPLAY,  /** <arg1 = playlist_item_t *         , res=can fail */
223     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
224     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
225     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
226     PLAYLIST_GOTO,      /**< arg1=int                           res=can fail */
227     PLAYLIST_VIEWGOTO   /**< arg1=int                           res=can fail */
228 } playlist_command_t;
229
230
231 typedef struct playlist_t playlist_t;
232 typedef struct playlist_item_t playlist_item_t;
233 typedef struct playlist_view_t playlist_view_t;
234 typedef struct playlist_export_t playlist_export_t;
235 typedef struct services_discovery_t services_discovery_t;
236 typedef struct services_discovery_sys_t services_discovery_sys_t;
237 typedef struct playlist_add_t playlist_add_t;
238 typedef struct playlist_preparse_t playlist_preparse_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 sout_cfg_t       sout_cfg_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 /* Decoders */
338 typedef struct decoder_t      decoder_t;
339 typedef struct decoder_sys_t  decoder_sys_t;
340
341 /* Encoders */
342 typedef struct encoder_t      encoder_t;
343 typedef struct encoder_sys_t  encoder_sys_t;
344
345 /* Filters */
346 typedef struct filter_t filter_t;
347 typedef struct filter_sys_t filter_sys_t;
348
349 /* Network */
350 typedef struct network_socket_t network_socket_t;
351 typedef struct virtual_socket_t v_socket_t;
352 typedef struct sockaddr sockaddr;
353 typedef struct addrinfo addrinfo;
354 typedef struct vlc_acl_t vlc_acl_t;
355
356 /* Misc */
357 typedef struct iso639_lang_t iso639_lang_t;
358
359 /* block */
360 typedef struct block_t      block_t;
361 typedef struct block_fifo_t block_fifo_t;
362
363 /* httpd */
364 typedef struct httpd_t          httpd_t;
365 typedef struct httpd_host_t     httpd_host_t;
366 typedef struct httpd_url_t      httpd_url_t;
367 typedef struct httpd_client_t   httpd_client_t;
368 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
369 typedef struct httpd_message_t  httpd_message_t;
370 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
371 typedef struct httpd_file_t     httpd_file_t;
372 typedef struct httpd_file_sys_t httpd_file_sys_t;
373 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
374 typedef struct httpd_handler_t  httpd_handler_t;
375 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
376 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 );
377 typedef struct httpd_redirect_t httpd_redirect_t;
378 typedef struct httpd_stream_t httpd_stream_t;
379
380 /* TLS support */
381 typedef struct tls_t tls_t;
382 typedef struct tls_server_t tls_server_t;
383 typedef struct tls_session_t tls_session_t;
384
385 /* Hashing */
386 typedef struct md5_s md5_t;
387
388 /* XML */
389 typedef struct xml_t xml_t;
390 typedef struct xml_sys_t xml_sys_t;
391 typedef struct xml_reader_t xml_reader_t;
392 typedef struct xml_reader_sys_t xml_reader_sys_t;
393
394 /* vod server */
395 typedef struct vod_t     vod_t;
396 typedef struct vod_sys_t vod_sys_t;
397 typedef struct vod_media_t vod_media_t;
398
399 /* opengl */
400 typedef struct opengl_t     opengl_t;
401 typedef struct opengl_sys_t opengl_sys_t;
402
403 /* osdmenu */
404 typedef struct osd_menu_t   osd_menu_t;
405 typedef struct osd_state_t  osd_state_t;
406 typedef struct osd_event_t  osd_event_t;
407 typedef struct osd_button_t osd_button_t;
408 typedef struct osd_menu_state_t osd_menu_state_t;
409
410 /* VLM */
411 typedef struct vlm_t         vlm_t;
412 typedef struct vlm_message_t vlm_message_t;
413 typedef struct vlm_media_t   vlm_media_t;
414 typedef struct vlm_schedule_t vlm_schedule_t;
415
416 /* divers */
417 typedef struct vlc_meta_t    vlc_meta_t;
418
419 /* Stats */
420 typedef struct counter_t     counter_t;
421 typedef struct counter_sample_t counter_sample_t;
422 typedef struct stats_handler_t stats_handler_t;
423 typedef struct input_stats_t input_stats_t;
424 typedef struct global_stats_t global_stats_t;
425
426 /* Update */
427 typedef struct update_t update_t;
428 typedef struct update_iterator_t update_iterator_t;
429
430 /*****************************************************************************
431  * Variable callbacks
432  *****************************************************************************/
433 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
434                                    char const *,            /* variable name */
435                                    vlc_value_t,                 /* old value */
436                                    vlc_value_t,                 /* new value */
437                                    void * );                /* callback data */
438
439 /*****************************************************************************
440  * Plug-in stuff
441  *****************************************************************************/
442 #ifndef __PLUGIN__
443 #   define VLC_EXPORT( type, name, args ) type name args
444 #else
445 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
446     extern module_symbols_t* p_symbols;
447 #endif
448
449 /*****************************************************************************
450  * OS-specific headers and thread types
451  *****************************************************************************/
452 #if defined( WIN32 ) || defined( UNDER_CE )
453 #   define WIN32_LEAN_AND_MEAN
454 #   include <windows.h>
455 #   if defined( UNDER_CE )
456 #      define IS_WINNT 0
457 #   else
458 #      define IS_WINNT ( GetVersion() < 0x80000000 )
459 #   endif
460 #endif
461
462 #include "vlc_threads.h"
463
464 /*****************************************************************************
465  * Common structure members
466  *****************************************************************************/
467
468 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
469 #define VLC_COMMON_MEMBERS                                                  \
470 /** \name VLC_COMMON_MEMBERS                                                \
471  * these members are common for all vlc objects                             \
472  */                                                                         \
473 /**@{*/                                                                     \
474     int   i_object_id;                                                      \
475     int   i_object_type;                                                    \
476     char *psz_object_type;                                                  \
477     char *psz_object_name;                                                  \
478                                                                             \
479     /* Messages header */                                                   \
480     char *psz_header;                                                       \
481     int  i_flags;                                                           \
482                                                                             \
483     /* Thread properties, if any */                                         \
484     vlc_bool_t   b_thread;                                                  \
485     vlc_thread_t thread_id;                                                 \
486                                                                             \
487     /* Object access lock */                                                \
488     vlc_mutex_t  object_lock;                                               \
489     vlc_cond_t   object_wait;                                               \
490                                                                             \
491     /* Object properties */                                                 \
492     volatile vlc_bool_t b_error;                  /**< set by the object */ \
493     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
494     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
495     volatile vlc_bool_t b_attached;               /**< set by the object */ \
496     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
497                                                                             \
498     /* Object variables */                                                  \
499     vlc_mutex_t     var_lock;                                               \
500     int             i_vars;                                                 \
501     variable_t *    p_vars;                                                 \
502                                                                             \
503     /* Stuff related to the libvlc structure */                             \
504     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
505     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
506                                                                             \
507     volatile int    i_refcount;                         /**< usage count */ \
508     vlc_object_t *  p_parent;                            /**< our parent */ \
509     vlc_object_t ** pp_children;                       /**< our children */ \
510     volatile int    i_children;                                             \
511                                                                             \
512     /* Private data */                                                      \
513     void *          p_private;                                              \
514                                                                             \
515     /** Just a reminder so that people don't cast garbage */                \
516     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
517 /**@}*/                                                                     \
518
519 /* VLC_OBJECT: attempt at doing a clever cast */
520 #define VLC_OBJECT( x ) \
521     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
522
523 /*****************************************************************************
524  * Macros and inline functions
525  *****************************************************************************/
526 #ifdef NTOHL_IN_SYS_PARAM_H
527 #   include <sys/param.h>
528
529 #elif !defined(WIN32) && !defined( UNDER_CE )
530 #   include <netinet/in.h>
531
532 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
533
534 /* CEIL: division with round to nearest greater integer */
535 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
536
537 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
538 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
539
540 /* __MAX and __MIN: self explanatory */
541 #ifndef __MAX
542 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
543 #endif
544 #ifndef __MIN
545 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
546 #endif
547
548 static int64_t GCD( int64_t a, int64_t b )
549 {
550     if( b ) return GCD( b, a % b );
551     else return a;
552 }
553
554 /* Dynamic array handling: realloc array, move data, increment position */
555 #if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
556 #   define VLCCVP (void**) /* Work-around for broken compiler */
557 #else
558 #   define VLCCVP
559 #endif
560 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
561     do                                                                        \
562     {                                                                         \
563         if( !i_oldsize ) (p_ar) = NULL;                                       \
564         (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
565         if( (i_oldsize) - (i_pos) )                                           \
566         {                                                                     \
567             memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos),                  \
568                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
569         }                                                                     \
570         (p_ar)[i_pos] = elem;                                                 \
571         (i_oldsize)++;                                                        \
572     }                                                                         \
573     while( 0 )
574
575 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
576     do                                                                        \
577     {                                                                         \
578         if( (i_oldsize) - (i_pos) - 1 )                                       \
579         {                                                                     \
580             memmove( (p_ar) + (i_pos),                                        \
581                      (p_ar) + (i_pos) + 1,                                    \
582                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
583         }                                                                     \
584         if( i_oldsize > 1 )                                                   \
585         {                                                                     \
586             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
587         }                                                                     \
588         else                                                                  \
589         {                                                                     \
590             free( p_ar );                                                     \
591             (p_ar) = NULL;                                                    \
592         }                                                                     \
593         (i_oldsize)--;                                                        \
594     }                                                                         \
595     while( 0 )
596
597
598 #define TAB_APPEND( count, tab, p )             \
599     if( (count) > 0 )                           \
600     {                                           \
601         (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
602     }                                           \
603     else                                        \
604     {                                           \
605         (tab) = malloc( sizeof( void ** ) );    \
606     }                                           \
607     (tab)[count] = (p);        \
608     (count)++
609
610 #define TAB_FIND( count, tab, p, index )        \
611     {                                           \
612         int _i_;                                \
613         (index) = -1;                           \
614         for( _i_ = 0; _i_ < (count); _i_++ )    \
615         {                                       \
616             if( (tab)[_i_] == (p) )  \
617             {                                   \
618                 (index) = _i_;                  \
619                 break;                          \
620             }                                   \
621         }                                       \
622     }
623
624 #define TAB_REMOVE( count, tab, p )             \
625     {                                           \
626         int _i_index_;                          \
627         TAB_FIND( count, tab, p, _i_index_ );   \
628         if( _i_index_ >= 0 )                    \
629         {                                       \
630             if( (count) > 1 )                     \
631             {                                   \
632                 memmove( ((void**)(tab) + _i_index_),    \
633                          ((void**)(tab) + _i_index_+1),  \
634                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
635             }                                   \
636             (count)--;                          \
637             if( (count) == 0 )                  \
638             {                                   \
639                 free( tab );                    \
640                 (tab) = NULL;                   \
641             }                                   \
642         }                                       \
643     }
644
645 /* MSB (big endian)/LSB (little endian) conversions - network order is always
646  * MSB, and should be used for both network communications and files. Note that
647  * byte orders other than little and big endians are not supported, but only
648  * the VAX seems to have such exotic properties. */
649 static inline uint16_t U16_AT( void const * _p )
650 {
651     uint8_t * p = (uint8_t *)_p;
652     return ( ((uint16_t)p[0] << 8) | p[1] );
653 }
654 static inline uint32_t U32_AT( void const * _p )
655 {
656     uint8_t * p = (uint8_t *)_p;
657     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
658               | ((uint32_t)p[2] << 8) | p[3] );
659 }
660 static inline uint64_t U64_AT( void const * _p )
661 {
662     uint8_t * p = (uint8_t *)_p;
663     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
664               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
665               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
666               | ((uint64_t)p[6] << 8) | p[7] );
667 }
668
669 static inline uint16_t GetWLE( void const * _p )
670 {
671     uint8_t * p = (uint8_t *)_p;
672     return ( ((uint16_t)p[1] << 8) | p[0] );
673 }
674 static inline uint32_t GetDWLE( void const * _p )
675 {
676     uint8_t * p = (uint8_t *)_p;
677     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
678               | ((uint32_t)p[1] << 8) | p[0] );
679 }
680 static inline uint64_t GetQWLE( void const * _p )
681 {
682     uint8_t * p = (uint8_t *)_p;
683     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
684               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
685               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
686               | ((uint64_t)p[1] << 8) | p[0] );
687 }
688
689 #define GetWBE( p )     U16_AT( p )
690 #define GetDWBE( p )    U32_AT( p )
691 #define GetQWBE( p )    U64_AT( p )
692
693 /* Helper writer functions */
694 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
695 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
696 {
697     p[1] = ( i_dw >>  8 )&0xff;
698     p[0] = ( i_dw       )&0xff;
699 }
700
701 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
702 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
703 {
704     p[3] = ( i_dw >> 24 )&0xff;
705     p[2] = ( i_dw >> 16 )&0xff;
706     p[1] = ( i_dw >>  8 )&0xff;
707     p[0] = ( i_dw       )&0xff;
708 }
709 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
710 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
711 {
712     SetDWLE( p,   i_qw&0xffffffff );
713     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
714 }
715 #define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
716 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
717 {
718     p[0] = ( i_dw >>  8 )&0xff;
719     p[1] = ( i_dw       )&0xff;
720 }
721
722 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
723 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
724 {
725     p[0] = ( i_dw >> 24 )&0xff;
726     p[1] = ( i_dw >> 16 )&0xff;
727     p[2] = ( i_dw >>  8 )&0xff;
728     p[3] = ( i_dw       )&0xff;
729 }
730 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
731 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
732 {
733     SetDWBE( p+4,   i_qw&0xffffffff );
734     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
735 }
736
737 #if WORDS_BIGENDIAN
738 #   define hton16(i)   ( i )
739 #   define hton32(i)   ( i )
740 #   define hton64(i)   ( i )
741 #   define ntoh16(i)   ( i )
742 #   define ntoh32(i)   ( i )
743 #   define ntoh64(i)   ( i )
744 #else
745 #   define hton16(i)   U16_AT(&i)
746 #   define hton32(i)   U32_AT(&i)
747 #   define hton64(i)   U64_AT(&i)
748 #   define ntoh16(i)   U16_AT(&i)
749 #   define ntoh32(i)   U32_AT(&i)
750 #   define ntoh64(i)   U64_AT(&i)
751 #endif
752
753 /* Format string sanity checks */
754 #ifdef HAVE_ATTRIBUTE_FORMAT
755 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
756 #else
757 #   define ATTRIBUTE_FORMAT(x,y)
758 #endif
759
760 /* Alignment of critical static data structures */
761 #ifdef ATTRIBUTE_ALIGNED_MAX
762 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
763 #else
764 #   define ATTR_ALIGN(align)
765 #endif
766
767 /* Alignment of critical dynamic data structure
768  *
769  * Not all platforms support memalign so we provide a vlc_memalign wrapper
770  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
771  * *pp_orig is the pointer that has to be freed afterwards.
772  */
773 #if 0
774 #ifdef HAVE_POSIX_MEMALIGN
775 #   define vlc_memalign(align,size,pp_orig) \
776     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
777 #endif
778 #endif
779 #ifdef HAVE_MEMALIGN
780     /* Some systems have memalign() but no declaration for it */
781     void * memalign( size_t align, size_t size );
782
783 #   define vlc_memalign(pp_orig,align,size) \
784     ( *(pp_orig) = memalign( align, size ) )
785
786 #else /* We don't have any choice but to align manually */
787 #   define vlc_memalign(pp_orig,align,size) \
788     (( *(pp_orig) = malloc( size + align - 1 )) \
789         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
790                        & (~(unsigned long)(align-1)) ) \
791         : NULL )
792
793 #endif
794
795 /* Stuff defined in src/extras/libc.c */
796 #ifndef HAVE_STRDUP
797 #   define strdup vlc_strdup
798     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
799 #elif !defined(__PLUGIN__)
800 #   define vlc_strdup NULL
801 #endif
802
803 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
804 #   define vasprintf vlc_vasprintf
805     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
806 #elif !defined(__PLUGIN__)
807 #   define vlc_vasprintf NULL
808 #endif
809
810 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
811 #   define asprintf vlc_asprintf
812     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
813 #elif !defined(__PLUGIN__)
814 #   define vlc_asprintf NULL
815 #endif
816
817 #ifndef HAVE_STRNDUP
818 #   if defined(STRNDUP_IN_GNOME_H) && \
819         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
820          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
821         /* Do nothing: gnome.h defines strndup for us */
822 #   else
823 #       define strndup vlc_strndup
824         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
825 #   endif
826 #elif !defined(__PLUGIN__)
827 #   define vlc_strndup 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 #ifndef HAVE_SCANDIR
858 #   define scandir vlc_scandir
859 #   define alphasort vlc_alphasort
860     struct dirent;
861     VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
862     VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
863 #elif !defined(__PLUGIN__)
864 #   define vlc_scandir NULL
865 #   define vlc_alphasort NULL
866 #endif
867
868 #ifndef HAVE_GETENV
869 #   define getenv vlc_getenv
870     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
871 #elif !defined(__PLUGIN__)
872 #   define vlc_getenv NULL
873 #endif
874
875 #ifndef HAVE_STRCASECMP
876 #   ifndef HAVE_STRICMP
877 #       define strcasecmp vlc_strcasecmp
878         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
879 #   else
880 #       define strcasecmp stricmp
881 #       if !defined(__PLUGIN__)
882 #           define vlc_strcasecmp NULL
883 #       endif
884 #   endif
885 #elif !defined(__PLUGIN__)
886 #   define vlc_strcasecmp NULL
887 #endif
888
889 #ifndef HAVE_STRNCASECMP
890 #   ifndef HAVE_STRNICMP
891 #       define strncasecmp vlc_strncasecmp
892         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
893 #   else
894 #       define strncasecmp strnicmp
895 #       if !defined(__PLUGIN__)
896 #           define vlc_strncasecmp NULL
897 #       endif
898 #   endif
899 #elif !defined(__PLUGIN__)
900 #   define vlc_strncasecmp NULL
901 #endif
902
903 #ifndef HAVE_STRCASESTR
904 #   ifndef HAVE_STRISTR
905 #       define strcasestr vlc_strcasestr
906         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
907 #   else
908 #       define strcasestr stristr
909 #       if !defined(__PLUGIN__)
910 #           define vlc_strcasestr NULL
911 #       endif
912 #   endif
913 #elif !defined(__PLUGIN__)
914 #   define vlc_strcasestr NULL
915 #endif
916
917 #ifndef HAVE_DIRENT_H
918     typedef void DIR;
919 #   ifndef FILENAME_MAX
920 #       define FILENAME_MAX (260)
921 #   endif
922     struct dirent
923     {
924         long            d_ino;          /* Always zero. */
925         unsigned short  d_reclen;       /* Always zero. */
926         unsigned short  d_namlen;       /* Length of name in d_name. */
927         char            d_name[FILENAME_MAX]; /* File name. */
928     };
929 #   define opendir vlc_opendir
930 #   define readdir vlc_readdir
931 #   define closedir vlc_closedir
932     VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
933     VLC_EXPORT( void *, vlc_readdir, ( void * ) );
934     VLC_EXPORT( int, vlc_closedir, ( void * ) );
935 #else
936     struct dirent;  /* forward declaration for vlc_symbols.h */
937 #   if !defined(__PLUGIN__)
938 #       define vlc_opendir  NULL
939 #       define vlc_readdir  NULL
940 #       define vlc_closedir NULL
941 #   endif
942 #endif
943
944     VLC_EXPORT( void *, vlc_opendir_wrapper, ( const char * ) );
945     VLC_EXPORT( struct dirent *, vlc_readdir_wrapper, ( void * ) );
946     VLC_EXPORT( int, vlc_closedir_wrapper, ( void * ) );
947
948 /* Format type specifiers for 64 bits numbers */
949 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
950 #   if defined(__WORDSIZE) && __WORDSIZE == 64
951 #       define I64Fd "%ld"
952 #       define I64Fi "%li"
953 #       define I64Fo "%lo"
954 #       define I64Fu "%lu"
955 #       define I64Fx "%lx"
956 #       define I64FX "%lX"
957 #   else
958 #       define I64Fd "%lld"
959 #       define I64Fi "%lli"
960 #       define I64Fo "%llo"
961 #       define I64Fu "%llu"
962 #       define I64Fx "%llx"
963 #       define I64FX "%llX"
964 #   endif
965 #else
966 #   define I64Fd "%I64d"
967 #   define I64Fi "%I64i"
968 #   define I64Fo "%I64o"
969 #   define I64Fu "%I64u"
970 #   define I64Fx "%I64x"
971 #   define I64FX "%I64X"
972 #endif /* defined(WIN32)||defined(UNDER_CE) */
973
974 /* 64 bits integer constant suffix */
975 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
976 #   if defined(__WORDSIZE) && __WORDSIZE == 64
977 #       define I64C(x)         x##L
978 #       define UI64C(x)        x##UL
979 #   else
980 #       define I64C(x)         x##LL
981 #       define UI64C(x)        x##ULL
982 #   endif
983 #else
984 #   define I64C(x)         x##i64
985 #   define UI64C(x)        x##ui64
986 #endif /* defined(WIN32)||defined(UNDER_CE) */
987
988 #if defined(WIN32) || defined(UNDER_CE)
989 /* win32, cl and icl support */
990 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
991 #       define __attribute__(x)
992 #       define __inline__      __inline
993 #       define S_IFBLK         0x3000  /* Block */
994 #       define S_ISBLK(m)      (0)
995 #       define S_ISCHR(m)      (0)
996 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
997 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
998 #   endif
999
1000 /* several type definitions */
1001 #   if defined( __MINGW32__ )
1002 #       if !defined( _OFF_T_ )
1003             typedef long long _off_t;
1004             typedef _off_t off_t;
1005 #           define _OFF_T_
1006 #       else
1007 #           ifdef off_t
1008 #               undef off_t
1009 #           endif
1010 #           define off_t long long
1011 #       endif
1012 #   endif
1013
1014 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
1015 #       if !defined( _OFF_T_DEFINED )
1016             typedef __int64 off_t;
1017 #           define _OFF_T_DEFINED
1018 #       else
1019             /* for wx compatibility typedef long off_t; */
1020 #           define off_t __int64
1021 #       endif
1022 #   endif
1023
1024 #   if defined( __BORLANDC__ )
1025 #       undef off_t
1026 #       define off_t unsigned __int64
1027 #   endif
1028
1029 #   ifndef O_NONBLOCK
1030 #       define O_NONBLOCK 0
1031 #   endif
1032
1033 #   ifndef alloca
1034 #       define alloca _alloca
1035 #   endif
1036
1037     /* These two are not defined in mingw32 (bug?) */
1038 #   ifndef snprintf
1039 #       define snprintf _snprintf
1040 #   endif
1041 #   ifndef vsnprintf
1042 #       define vsnprintf _vsnprintf
1043 #   endif
1044
1045 #   include <tchar.h>
1046 #endif
1047
1048 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1049 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1050
1051 /* vlc_wraptext (defined in src/extras/libc.c) */
1052 #define wraptext vlc_wraptext
1053 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
1054
1055 /* iconv wrappers (defined in src/extras/libc.c) */
1056 typedef void *vlc_iconv_t;
1057 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1058 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) );
1059 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1060
1061 /* execve wrapper (defined in src/extras/libc.c) */
1062 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 ) );
1063 #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)
1064
1065 /*****************************************************************************
1066  * CPU capabilities
1067  *****************************************************************************/
1068 #define CPU_CAPABILITY_NONE    0
1069 #define CPU_CAPABILITY_486     (1<<0)
1070 #define CPU_CAPABILITY_586     (1<<1)
1071 #define CPU_CAPABILITY_PPRO    (1<<2)
1072 #define CPU_CAPABILITY_MMX     (1<<3)
1073 #define CPU_CAPABILITY_3DNOW   (1<<4)
1074 #define CPU_CAPABILITY_MMXEXT  (1<<5)
1075 #define CPU_CAPABILITY_SSE     (1<<6)
1076 #define CPU_CAPABILITY_SSE2    (1<<7)
1077 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1078 #define CPU_CAPABILITY_FPU     (1<<31)
1079
1080 /*****************************************************************************
1081  * I18n stuff
1082  *****************************************************************************/
1083 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1084
1085 #if defined( ENABLE_NLS ) && \
1086      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1087       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1088       defined(MODULE_NAME_IS_pda))
1089     /* Declare nothing: gnome.h will do it for us */
1090 #elif defined( ENABLE_NLS )
1091 #   if defined( HAVE_INCLUDED_GETTEXT )
1092 #       include "libintl.h"
1093 #   else
1094 #       include <libintl.h>
1095 #   endif
1096 #   undef _
1097 #   define _(String) vlc_dgettext (PACKAGE_NAME, String)
1098 #   define N_(String) ((char*)(String))
1099 #else
1100 #   define _(String) ((char*)(String))
1101 #   define N_(String) ((char*)(String))
1102 #endif
1103
1104 /*****************************************************************************
1105  * libvlc features
1106  *****************************************************************************/
1107 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1108 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1109 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1110 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1111 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1112 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1113 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1114
1115 /*****************************************************************************
1116  * Additional vlc stuff
1117  *****************************************************************************/
1118 #include "vlc_symbols.h"
1119 #include "os_specific.h"
1120 #include "vlc_messages.h"
1121 #include "variables.h"
1122 #include "vlc_objects.h"
1123 #include "vlc_threads_funcs.h"
1124 #include "mtime.h"
1125 #include "modules.h"
1126 #include "main.h"
1127 #include "configuration.h"
1128
1129 #if defined( __BORLANDC__ )
1130 #   undef PACKAGE
1131 #   define PACKAGE
1132 #endif
1133