]> git.sesse.net Git - vlc/blob - include/vlc_common.h
4d3f2f9bf426046fd1c65bc5fe5951c5b26e4abd
[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, 1999, 2000 VideoLAN
6  * $Id$
7  *
8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
9  *          Vincent Seguin <seguin@via.ecp.fr>
10  *          Gildas Bazin <gbazin@netcourrier.com>
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., 59 Temple Place - Suite 330, Boston, MA  02111, 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( __BORLANDC__ )
42 #   undef HAVE_VARIADIC_MACROS
43 #   undef HAVE_STDINT_H
44 #   undef HAVE_INTTYPES_H
45 #   undef off_t
46 #elif defined( _MSC_VER )
47 #   pragma warning( disable : 4244 )
48 #endif
49
50 #include "vlc_config.h"
51 #include "modules_inner.h"
52
53 /*****************************************************************************
54  * Required system headers
55  *****************************************************************************/
56 #include <stdlib.h>
57 #include <stdarg.h>
58
59 #ifdef HAVE_STRING_H
60 #   include <string.h>                                         /* strerror() */
61 #endif
62
63 #ifdef HAVE_SYS_TYPES_H
64 #   include <sys/types.h>
65 #endif
66
67 /*****************************************************************************
68  * Basic types definitions
69  *****************************************************************************/
70 #if defined( HAVE_STDINT_H )
71 #   include <stdint.h>
72 #elif defined( HAVE_INTTYPES_H )
73 #   include <inttypes.h>
74 #elif defined( SYS_CYGWIN )
75 #   include <sys/types.h>
76     /* Cygwin only defines half of these... */
77     typedef u_int8_t            uint8_t;
78     typedef u_int16_t           uint16_t;
79     typedef u_int32_t           uint32_t;
80     typedef u_int64_t           uint64_t;
81 #else
82     /* Fallback types (very x86-centric, sorry) */
83     typedef unsigned char       uint8_t;
84     typedef signed char         int8_t;
85     typedef unsigned short      uint16_t;
86     typedef signed short        int16_t;
87     typedef unsigned int        uint32_t;
88     typedef signed int          int32_t;
89 #   if defined( _MSC_VER ) \
90       || defined( UNDER_CE ) \
91       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
92     typedef unsigned __int64    uint64_t;
93     typedef signed __int64      int64_t;
94 #   else
95     typedef unsigned long long  uint64_t;
96     typedef signed long long    int64_t;
97 #   endif
98     typedef uint32_t            uintptr_t;
99     typedef int32_t             intptr_t;
100 #endif
101
102 typedef uint8_t                 byte_t;
103
104 /* ptrdiff_t definition */
105 #ifdef HAVE_STDDEF_H
106 #   include <stddef.h>
107 #else
108 #   include <malloc.h>
109 #   ifndef _PTRDIFF_T
110 #       define _PTRDIFF_T
111 /* Not portable in a 64-bit environment. */
112 typedef int                 ptrdiff_t;
113 #   endif
114 #endif
115
116 #if defined( WIN32 )
117 #   include <malloc.h>
118 #   ifndef PATH_MAX
119 #       define PATH_MAX MAX_PATH
120 #   endif
121 #endif
122
123 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
124 typedef int                 ssize_t;
125 #endif
126
127 /* Counter for statistics and profiling */
128 typedef unsigned long       count_t;
129
130 /* DCT elements types */
131 typedef int16_t             dctelem_t;
132
133 /* Video buffer types */
134 typedef uint8_t             yuv_data_t;
135
136 /* Audio volume */
137 typedef uint16_t            audio_volume_t;
138
139 #ifndef HAVE_SOCKLEN_T
140 typedef int                 socklen_t;
141 #endif
142
143 /**
144  * High precision date or time interval
145  *
146  * Store a high precision date or time interval. The maximum precision is the
147  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
148  * time interval is then 292271 years, which should be long enough for any
149  * video). Dates are stored as microseconds since a common date (usually the
150  * epoch). Note that date and time intervals can be manipulated using regular
151  * arithmetic operators, and that no special functions are required.
152  */
153 typedef int64_t mtime_t;
154
155 /**
156  * The vlc_fourcc_t type.
157  *
158  * See http://www.webartz.com/fourcc/ for a very detailed list.
159  */
160 typedef uint32_t vlc_fourcc_t;
161
162 #ifdef WORDS_BIGENDIAN
163 #   define VLC_FOURCC( a, b, c, d ) \
164         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
165            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
166 #   define VLC_TWOCC( a, b ) \
167         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
168
169 #else
170 #   define VLC_FOURCC( a, b, c, d ) \
171         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
172            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
173 #   define VLC_TWOCC( a, b ) \
174         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
175
176 #endif
177
178 /*****************************************************************************
179  * Classes declaration
180  *****************************************************************************/
181
182 /* Internal types */
183 typedef struct libvlc_t libvlc_t;
184 typedef struct vlc_t vlc_t;
185 typedef struct variable_t variable_t;
186
187 /* Messages */
188 typedef struct msg_bank_t msg_bank_t;
189 typedef struct msg_subscription_t msg_subscription_t;
190
191 /* Playlist */
192 typedef struct playlist_t playlist_t;
193 typedef struct playlist_item_t playlist_item_t;
194 typedef struct playlist_group_t playlist_group_t;
195 typedef struct item_info_t item_info_t;
196 typedef struct item_info_category_t item_info_category_t;
197 typedef struct playlist_export_t playlist_export_t;
198
199 /* Modules */
200 typedef struct module_bank_t module_bank_t;
201 typedef struct module_t module_t;
202 typedef struct module_config_t module_config_t;
203 typedef struct module_symbols_t module_symbols_t;
204
205 /* Interface */
206 typedef struct intf_thread_t intf_thread_t;
207 typedef struct intf_sys_t intf_sys_t;
208 typedef struct intf_console_t intf_console_t;
209 typedef struct intf_msg_t intf_msg_t;
210 typedef struct intf_channel_t intf_channel_t;
211
212 /* Input */
213 typedef struct input_thread_t input_thread_t;
214 typedef struct input_thread_sys_t input_thread_sys_t;
215 typedef struct input_area_t input_area_t;
216 typedef struct input_buffers_t input_buffers_t;
217 typedef struct input_socket_t input_socket_t;
218 typedef struct input_info_t input_info_t;
219 typedef struct input_info_category_t input_info_category_t;
220 typedef struct access_sys_t access_sys_t;
221 typedef struct demux_sys_t demux_sys_t;
222 typedef struct es_descriptor_t es_descriptor_t;
223 typedef struct es_sys_t es_sys_t;
224 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
225 typedef struct pgrm_sys_t pgrm_sys_t;
226 typedef struct stream_descriptor_t stream_descriptor_t;
227
228 /* Format */
229 typedef struct audio_format_t audio_format_t;
230 typedef struct video_format_t video_format_t;
231 typedef struct subs_format_t subs_format_t;
232 typedef struct es_format_t es_format_t;
233 typedef struct video_palette_t video_palette_t;
234
235 /* NInput */
236 typedef struct stream_sys_t stream_sys_t;
237 typedef struct stream_t     stream_t;
238 typedef struct es_out_t     es_out_t;
239 typedef struct es_out_id_t  es_out_id_t;
240 typedef struct es_out_sys_t es_out_sys_t;
241 typedef struct demux_t  demux_t;
242
243 /* Audio */
244 typedef struct aout_instance_t aout_instance_t;
245 typedef struct aout_sys_t aout_sys_t;
246 typedef struct aout_fifo_t aout_fifo_t;
247 typedef struct aout_input_t aout_input_t;
248 typedef struct aout_buffer_t aout_buffer_t;
249 typedef audio_format_t audio_sample_format_t;
250 typedef struct audio_date_t audio_date_t;
251 typedef struct aout_filter_t aout_filter_t;
252
253 /* Video */
254 typedef struct vout_thread_t vout_thread_t;
255 typedef struct vout_sys_t vout_sys_t;
256 typedef struct chroma_sys_t chroma_sys_t;
257 typedef video_format_t video_frame_format_t;
258 typedef struct picture_t picture_t;
259 typedef struct picture_sys_t picture_sys_t;
260 typedef struct picture_heap_t picture_heap_t;
261 typedef struct subpicture_t subpicture_t;
262 typedef struct subpicture_sys_t subpicture_sys_t;
263 typedef struct vout_synchro_t vout_synchro_t;
264 typedef struct text_renderer_sys_t text_renderer_sys_t;
265 typedef struct text_style_t text_style_t;
266
267 /* Stream output */
268 typedef struct sout_instance_t sout_instance_t;
269 typedef struct sout_input_t sout_input_t;
270 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
271 typedef struct sout_access_out_t sout_access_out_t;
272 typedef struct sout_mux_t sout_mux_t;
273 typedef struct sout_stream_t    sout_stream_t;
274 typedef struct sout_cfg_t       sout_cfg_t;
275 /*typedef struct sap_session_t    sap_session_t;
276 typedef struct slp_session_t    slp_session_t;*/
277
278 /* Decoders */
279 typedef struct decoder_t      decoder_t;
280 typedef struct decoder_sys_t  decoder_sys_t;
281
282 /* Encoders */
283 typedef struct encoder_t      encoder_t;
284 typedef struct encoder_sys_t  encoder_sys_t;
285
286 /* Misc */
287 typedef struct data_packet_t data_packet_t;
288 typedef struct data_buffer_t data_buffer_t;
289 typedef struct stream_position_t stream_position_t;
290 typedef struct stream_ctrl_t stream_ctrl_t;
291 typedef struct pes_packet_t pes_packet_t;
292 typedef struct network_socket_t network_socket_t;
293 typedef struct iso639_lang_t iso639_lang_t;
294
295 /* block */
296 typedef struct block_t      block_t;
297 typedef struct block_fifo_t block_fifo_t;
298
299 /* httpd */
300 typedef struct httpd_t          httpd_t;
301 typedef struct httpd_host_t     httpd_host_t;
302 typedef struct httpd_url_t      httpd_url_t;
303 typedef struct httpd_client_t   httpd_client_t;
304 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
305 typedef struct httpd_message_t  httpd_message_t;
306 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
307 typedef struct httpd_file_t     httpd_file_t;
308 typedef struct httpd_file_sys_t httpd_file_sys_t;
309 typedef int (*httpd_file_callback_t)( httpd_file_sys_t*, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
310 typedef struct httpd_redirect_t httpd_redirect_t;
311 typedef struct httpd_stream_t httpd_stream_t;
312
313 /* divers */
314 typedef struct vlc_meta_t    vlc_meta_t;
315
316 typedef struct vlm_t         vlm_t;
317 typedef struct vlm_message_t vlm_message_t;
318
319
320 /*****************************************************************************
321  * Variable callbacks
322  *****************************************************************************/
323 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
324                                    char const *,            /* variable name */
325                                    vlc_value_t,                 /* old value */
326                                    vlc_value_t,                 /* new value */
327                                    void * );                /* callback data */
328
329 /*****************************************************************************
330  * Plug-in stuff
331  *****************************************************************************/
332 #ifndef __PLUGIN__
333 #   define VLC_EXPORT( type, name, args ) type name args
334 #else
335 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
336     extern module_symbols_t* p_symbols;
337 #endif
338
339 /*****************************************************************************
340  * OS-specific headers and thread types
341  *****************************************************************************/
342 #if defined( WIN32 ) || defined( UNDER_CE )
343 #   define WIN32_LEAN_AND_MEAN
344 #   include <windows.h>
345 #   define IS_WINNT ( GetVersion() < 0x80000000 )
346 #endif
347
348 #include "vlc_threads.h"
349
350 /*****************************************************************************
351  * Common structure members
352  *****************************************************************************/
353
354 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
355 #define VLC_COMMON_MEMBERS                                                  \
356 /** \name VLC_COMMON_MEMBERS                                                \
357  * these members are common for all vlc objects                             \
358  */                                                                         \
359 /**@{*/                                                                     \
360     int   i_object_id;                                                      \
361     int   i_object_type;                                                    \
362     char *psz_object_type;                                                  \
363     char *psz_object_name;                                                  \
364                                                                             \
365     /* Thread properties, if any */                                         \
366     vlc_bool_t   b_thread;                                                  \
367     vlc_thread_t thread_id;                                                 \
368                                                                             \
369     /* Object access lock */                                                \
370     vlc_mutex_t  object_lock;                                               \
371     vlc_cond_t   object_wait;                                               \
372                                                                             \
373     /* Object properties */                                                 \
374     volatile vlc_bool_t b_error;                  /**< set by the object */ \
375     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
376     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
377     volatile vlc_bool_t b_attached;               /**< set by the object */ \
378                                                                             \
379     /* Object variables */                                                  \
380     vlc_mutex_t     var_lock;                                               \
381     int             i_vars;                                                 \
382     variable_t *    p_vars;                                                 \
383                                                                             \
384     /* Stuff related to the libvlc structure */                             \
385     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
386     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
387                                                                             \
388     volatile int    i_refcount;                         /**< usage count */ \
389     vlc_object_t *  p_parent;                            /**< our parent */ \
390     vlc_object_t ** pp_children;                       /**< our children */ \
391     volatile int    i_children;                                             \
392                                                                             \
393     /* Private data */                                                      \
394     void *          p_private;                                              \
395                                                                             \
396     /** Just a reminder so that people don't cast garbage */                \
397     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
398 /**@}*/                                                                     \
399
400 /* VLC_OBJECT: attempt at doing a clever cast */
401 #define VLC_OBJECT( x ) \
402     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
403
404 /*****************************************************************************
405  * Macros and inline functions
406  *****************************************************************************/
407 #ifdef NTOHL_IN_SYS_PARAM_H
408 #   include <sys/param.h>
409
410 #elif !defined(WIN32) && !defined( UNDER_CE )
411 #   include <netinet/in.h>
412
413 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
414
415 /* CEIL: division with round to nearest greater integer */
416 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
417
418 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
419 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
420
421 /* __MAX and __MIN: self explanatory */
422 #ifndef __MAX
423 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
424 #endif
425 #ifndef __MIN
426 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
427 #endif
428
429 /* Dynamic array handling: realloc array, move data, increment position */
430 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
431     do                                                                        \
432     {                                                                         \
433         if( i_oldsize )                                                       \
434         {                                                                     \
435             (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) );  \
436         }                                                                     \
437         else                                                                  \
438         {                                                                     \
439             (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) );         \
440         }                                                                     \
441         if( (i_oldsize) - (i_pos) )                                           \
442         {                                                                     \
443             memmove( (p_ar) + (i_pos) + 1,                                    \
444                      (p_ar) + (i_pos),                                        \
445                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
446         }                                                                     \
447         (p_ar)[i_pos] = elem;                                                 \
448         (i_oldsize)++;                                                        \
449     }                                                                         \
450     while( 0 )
451
452 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
453     do                                                                        \
454     {                                                                         \
455         if( (i_oldsize) - (i_pos) - 1 )                                       \
456         {                                                                     \
457             memmove( (p_ar) + (i_pos),                                        \
458                      (p_ar) + (i_pos) + 1,                                    \
459                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
460         }                                                                     \
461         if( i_oldsize > 1 )                                                   \
462         {                                                                     \
463             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
464         }                                                                     \
465         else                                                                  \
466         {                                                                     \
467             free( p_ar );                                                     \
468             (p_ar) = NULL;                                                    \
469         }                                                                     \
470         (i_oldsize)--;                                                        \
471     }                                                                         \
472     while( 0 )
473
474
475 #define TAB_APPEND( count, tab, p )             \
476     if( (count) > 0 )                           \
477     {                                           \
478         (void *)(tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
479     }                                           \
480     else                                        \
481     {                                           \
482         (void *)(tab) = malloc( sizeof( void ** ) );    \
483     }                                           \
484     ((void**)(tab))[count] = (void*)(p);        \
485     (count)++
486
487 #define TAB_FIND( count, tab, p, index )        \
488     {                                           \
489         int _i_;                                \
490         (index) = -1;                           \
491         for( _i_ = 0; _i_ < (count); _i_++ )    \
492         {                                       \
493             if( ((void**)(tab))[_i_] == (void*)(p) )  \
494             {                                   \
495                 (index) = _i_;                  \
496                 break;                          \
497             }                                   \
498         }                                       \
499     }
500
501 #define TAB_REMOVE( count, tab, p )             \
502     {                                           \
503         int _i_index_;                          \
504         TAB_FIND( count, tab, p, _i_index_ );   \
505         if( _i_index_ >= 0 )                    \
506         {                                       \
507             if( (count) > 1 )                     \
508             {                                   \
509                 memmove( ((void**)(tab) + _i_index_),    \
510                          ((void**)(tab) + _i_index_+1),  \
511                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
512             }                                   \
513             (count)--;                          \
514             if( (count) == 0 )                  \
515             {                                   \
516                 free( tab );                    \
517                 (tab) = NULL;                   \
518             }                                   \
519         }                                       \
520     }
521
522 /* MSB (big endian)/LSB (little endian) conversions - network order is always
523  * MSB, and should be used for both network communications and files. Note that
524  * byte orders other than little and big endians are not supported, but only
525  * the VAX seems to have such exotic properties. */
526 static inline uint16_t U16_AT( void const * _p )
527 {
528     uint8_t * p = (uint8_t *)_p;
529     return ( ((uint16_t)p[0] << 8) | p[1] );
530 }
531 static inline uint32_t U32_AT( void const * _p )
532 {
533     uint8_t * p = (uint8_t *)_p;
534     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
535               | ((uint32_t)p[2] << 8) | p[3] );
536 }
537 static inline uint64_t U64_AT( void const * _p )
538 {
539     uint8_t * p = (uint8_t *)_p;
540     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
541               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
542               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
543               | ((uint64_t)p[6] << 8) | p[7] );
544 }
545
546 static inline uint16_t GetWLE( void const * _p )
547 {
548     uint8_t * p = (uint8_t *)_p;
549     return ( ((uint16_t)p[1] << 8) | p[0] );
550 }
551 static inline uint32_t GetDWLE( void const * _p )
552 {
553     uint8_t * p = (uint8_t *)_p;
554     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
555               | ((uint32_t)p[1] << 8) | p[0] );
556 }
557 static inline uint64_t GetQWLE( void const * _p )
558 {
559     uint8_t * p = (uint8_t *)_p;
560     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
561               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
562               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
563               | ((uint64_t)p[1] << 8) | p[0] );
564 }
565
566 #define GetWBE( p )     U16_AT( p )
567 #define GetDWBE( p )    U32_AT( p )
568 #define GetQWBE( p )    U64_AT( p )
569
570 /* Helper writer functions */
571
572 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
573 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
574 {
575     p[1] = ( i_dw >>  8 )&0xff;
576     p[0] = ( i_dw       )&0xff;
577 }
578
579 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
580 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
581 {
582     p[3] = ( i_dw >> 24 )&0xff;
583     p[2] = ( i_dw >> 16 )&0xff;
584     p[1] = ( i_dw >>  8 )&0xff;
585     p[0] = ( i_dw       )&0xff;
586 }
587 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
588 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
589 {
590     SetDWLE( p,   i_qw&0xffffffff );
591     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
592 }
593
594 #if WORDS_BIGENDIAN
595 #   define hton16(i)   ( i )
596 #   define hton32(i)   ( i )
597 #   define hton64(i)   ( i )
598 #   define ntoh16(i)   ( i )
599 #   define ntoh32(i)   ( i )
600 #   define ntoh64(i)   ( i )
601 #else
602 #   define hton16(i)   U16_AT(&i)
603 #   define hton32(i)   U32_AT(&i)
604 #   define hton64(i)   U64_AT(&i)
605 #   define ntoh16(i)   U16_AT(&i)
606 #   define ntoh32(i)   U32_AT(&i)
607 #   define ntoh64(i)   U64_AT(&i)
608 #endif
609
610 /* Format string sanity checks */
611 #ifdef HAVE_ATTRIBUTE_FORMAT
612 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
613 #else
614 #   define ATTRIBUTE_FORMAT(x,y)
615 #endif
616
617 /* Alignment of critical static data structures */
618 #ifdef ATTRIBUTE_ALIGNED_MAX
619 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
620 #else
621 #   define ATTR_ALIGN(align)
622 #endif
623
624 /* Alignment of critical dynamic data structure
625  *
626  * Not all platforms support memalign so we provide a vlc_memalign wrapper
627  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
628  * *pp_orig is the pointer that has to be freed afterwards.
629  */
630 #if 0
631 #ifdef HAVE_POSIX_MEMALIGN
632 #   define vlc_memalign(align,size,pp_orig) \
633     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
634 #endif
635 #endif
636 #ifdef HAVE_MEMALIGN
637     /* Some systems have memalign() but no declaration for it */
638     void * memalign( size_t align, size_t size );
639
640 #   define vlc_memalign(pp_orig,align,size) \
641     ( *(pp_orig) = memalign( align, size ) )
642
643 #else /* We don't have any choice but to align manually */
644 #   define vlc_memalign(pp_orig,align,size) \
645     (( *(pp_orig) = malloc( size + align - 1 )) \
646         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
647                        & (~(unsigned long)(align-1)) ) \
648         : NULL )
649
650 #endif
651
652 /* Stuff defined in src/extras/libc.c */
653 #ifndef HAVE_STRDUP
654 #   define strdup vlc_strdup
655     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
656 #elif !defined(__PLUGIN__)
657 #   define vlc_strdup NULL
658 #endif
659
660 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
661 #   define vasprintf vlc_vasprintf
662     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
663 #elif !defined(__PLUGIN__)
664 #   define vlc_vasprintf NULL
665 #endif
666
667 #if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
668 #   define asprintf vlc_asprintf
669     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
670 #elif !defined(__PLUGIN__)
671 #   define vlc_asprintf NULL
672 #endif
673
674 #ifndef HAVE_STRNDUP
675 #   if defined(STRNDUP_IN_GNOME_H) && \
676         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
677          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
678         /* Do nothing: gnome.h defines strndup for us */
679 #   else
680 #       define strndup vlc_strndup
681         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
682 #   endif
683 #elif !defined(__PLUGIN__)
684 #   define vlc_strndup NULL
685 #endif
686
687 #ifndef HAVE_ATOF
688 #   define atof vlc_atof
689     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
690 #elif !defined(__PLUGIN__)
691 #   define vlc_atof NULL
692 #endif
693
694 #ifndef HAVE_ATOLL
695 #   define atoll vlc_atoll
696     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
697 #elif !defined(__PLUGIN__)
698 #   define vlc_atoll NULL
699 #endif
700
701 #ifndef HAVE_GETENV
702 #   define getenv vlc_getenv
703     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
704 #elif !defined(__PLUGIN__)
705 #   define vlc_getenv NULL
706 #endif
707
708 #ifndef HAVE_STRCASECMP
709 #   ifdef HAVE_STRICMP
710 #       define strcasecmp stricmp
711 #       if !defined(__PLUGIN__)
712 #           define vlc_strcasecmp NULL
713 #       endif
714 #   elif !defined(__PLUGIN__)
715 #       define strcasecmp vlc_strcasecmp
716         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
717 #   endif
718 #elif !defined(__PLUGIN__)
719 #   define vlc_strcasecmp NULL
720 #endif
721
722 #ifndef HAVE_STRNCASECMP
723 #   ifdef HAVE_STRNICMP
724 #       define strncasecmp strnicmp
725 #       if !defined(__PLUGIN__)
726 #           define vlc_strncasecmp NULL
727 #       endif
728 #   elif !defined(__PLUGIN__)
729 #       define strncasecmp vlc_strncasecmp
730         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
731 #   endif
732 #elif !defined(__PLUGIN__)
733 #   define vlc_strncasecmp NULL
734 #endif
735
736 /* Format type specifiers for 64 bits numbers */
737 #if !defined(WIN32) && !defined(UNDER_CE)
738 #   define I64Fd "%lld"
739 #   define I64Fi "%lli"
740 #   define I64Fo "%llo"
741 #   define I64Fu "%llu"
742 #   define I64Fx "%llx"
743 #   define I64FX "%llX"
744 #else
745 #   define I64Fd "%I64d"
746 #   define I64Fi "%I64i"
747 #   define I64Fo "%I64o"
748 #   define I64Fu "%I64u"
749 #   define I64Fx "%I64x"
750 #   define I64FX "%I64X"
751 #endif /* defined(WIN32)||defined(UNDER_CE) */
752
753 /* 64 bits integer constant suffix */
754 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
755 #   define I64C(x)         x##LL
756 #   define UI64C(x)        x##ULL
757 #else
758 #   define I64C(x)         x##i64
759 #   define UI64C(x)        x##ui64
760 #endif /* defined(WIN32)||defined(UNDER_CE) */
761
762 #if defined(WIN32) || defined(UNDER_CE)
763 /* win32, cl and icl support */
764 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
765 #       define __attribute__(x)
766 #       define __inline__      __inline
767 #       define S_IFBLK         0x3000  /* Block */
768 #       define S_ISBLK(m)      (0)
769 #       define S_ISCHR(m)      (0)
770 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
771 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
772 #   endif
773
774 /* several type definitions */
775 #   if defined( __MINGW32__ )
776 #       if !defined( _OFF_T_ )
777 typedef long long _off_t;
778 typedef _off_t off_t;
779 #           define _OFF_T_
780 #       else
781 #           ifdef off_t
782 #               undef off_t
783 #           endif
784 #           define off_t long long
785 #       endif
786 #   endif
787
788 #   if defined( _MSC_VER )
789 #       if !defined( _OFF_T_DEFINED )
790 typedef __int64 off_t;
791 #           define _OFF_T_DEFINED
792 #       else
793 #           define off_t __int64
794 #       endif
795 #   endif
796
797 #   if defined( __BORLANDC__ )
798 #       undef off_t
799 #       define off_t unsigned __int64
800 #   endif
801
802 #   ifndef O_NONBLOCK
803 #       define O_NONBLOCK 0
804 #   endif
805
806 #   ifndef alloca
807 #       define alloca _alloca
808 #   endif
809
810     /* These two are not defined in mingw32 (bug?) */
811 #   ifndef snprintf
812 #       define snprintf _snprintf
813 #   endif
814 #   ifndef vsnprintf
815 #       define vsnprintf _vsnprintf
816 #   endif
817
818 #endif
819
820 /* lseek (defined in src/extras/libc.c) */
821 #ifndef HAVE_LSEEK
822 #   define lseek vlc_lseek
823     VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
824 #elif !defined(__PLUGIN__)
825 #   define vlc_lseek NULL
826 #endif
827
828 /* vlc_wraptext (defined in src/extras/libc.c) */
829 #define wraptext vlc_wraptext
830 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
831
832 /*****************************************************************************
833  * CPU capabilities
834  *****************************************************************************/
835 #define CPU_CAPABILITY_NONE    0
836 #define CPU_CAPABILITY_486     (1<<0)
837 #define CPU_CAPABILITY_586     (1<<1)
838 #define CPU_CAPABILITY_PPRO    (1<<2)
839 #define CPU_CAPABILITY_MMX     (1<<3)
840 #define CPU_CAPABILITY_3DNOW   (1<<4)
841 #define CPU_CAPABILITY_MMXEXT  (1<<5)
842 #define CPU_CAPABILITY_SSE     (1<<6)
843 #define CPU_CAPABILITY_SSE2    (1<<7)
844 #define CPU_CAPABILITY_ALTIVEC (1<<16)
845 #define CPU_CAPABILITY_FPU     (1<<31)
846
847 /*****************************************************************************
848  * I18n stuff
849  *****************************************************************************/
850 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
851
852 #if defined( ENABLE_NLS ) && \
853      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
854       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
855       defined(MODULE_NAME_IS_pda))
856     /* Declare nothing: gnome.h will do it for us */
857 #elif defined( ENABLE_NLS )
858 #if defined( HAVE_INCLUDED_GETTEXT )
859 #   include "libintl.h"
860 #else
861 #   include <libintl.h>
862 #endif
863 #   undef _
864 #if defined( __BORLANDC__ )
865 #define _(String) vlc_dgettext (PACKAGE_TARNAME, String)
866 #else
867 #   define _(String) vlc_dgettext (PACKAGE, String)
868 #endif
869 #   define N_(String) ((char*)(String))
870 #else
871 #   define _(String) ((char*)(String))
872 #   define N_(String) ((char*)(String))
873 #endif
874
875 /*****************************************************************************
876  * Additional vlc stuff
877  *****************************************************************************/
878 #include "vlc_symbols.h"
879 #include "os_specific.h"
880 #include "vlc_messages.h"
881 #include "variables.h"
882 #include "vlc_objects.h"
883 #include "vlc_threads_funcs.h"
884 #include "mtime.h"
885 #include "modules.h"
886 #include "main.h"
887 #include "configuration.h"
888
889 #if defined( __BORLANDC__ )
890 #   undef PACKAGE
891 #   define PACKAGE
892 #endif
893