]> git.sesse.net Git - vlc/blob - include/vlc_common.h
b49ed39ae083e8e65849cfc6823f91211b716bd1
[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: vlc_common.h,v 1.110 2004/02/29 13:08:56 gbazin Exp $
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_fifo_t sout_fifo_t;
270 typedef struct sout_input_t sout_input_t;
271 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
272 typedef struct sout_buffer_t sout_buffer_t;
273 typedef struct sout_access_out_t sout_access_out_t;
274 typedef struct sout_mux_t sout_mux_t;
275 typedef struct sout_stream_t    sout_stream_t;
276 typedef struct sout_cfg_t       sout_cfg_t;
277 /*typedef struct sap_session_t    sap_session_t;
278 typedef struct slp_session_t    slp_session_t;*/
279
280 /* Decoders */
281 typedef struct decoder_t      decoder_t;
282 typedef struct decoder_sys_t  decoder_sys_t;
283
284 /* Encoders */
285 typedef struct encoder_t      encoder_t;
286 typedef struct encoder_sys_t  encoder_sys_t;
287
288 /* Misc */
289 typedef struct data_packet_t data_packet_t;
290 typedef struct data_buffer_t data_buffer_t;
291 typedef struct stream_position_t stream_position_t;
292 typedef struct stream_ctrl_t stream_ctrl_t;
293 typedef struct pes_packet_t pes_packet_t;
294 typedef struct network_socket_t network_socket_t;
295 typedef struct iso639_lang_t iso639_lang_t;
296
297 /* block */
298 typedef struct block_t      block_t;
299 typedef struct block_fifo_t block_fifo_t;
300
301 /*****************************************************************************
302  * Variable callbacks
303  *****************************************************************************/
304 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
305                                    char const *,            /* variable name */
306                                    vlc_value_t,                 /* old value */
307                                    vlc_value_t,                 /* new value */
308                                    void * );                /* callback data */
309
310 /*****************************************************************************
311  * Plug-in stuff
312  *****************************************************************************/
313 #ifndef __PLUGIN__
314 #   define VLC_EXPORT( type, name, args ) type name args
315 #else
316 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
317     extern module_symbols_t* p_symbols;
318 #endif
319
320 /*****************************************************************************
321  * OS-specific headers and thread types
322  *****************************************************************************/
323 #if defined( WIN32 ) || defined( UNDER_CE )
324 #   define WIN32_LEAN_AND_MEAN
325 #   include <windows.h>
326 #   define IS_WINNT ( GetVersion() < 0x80000000 )
327 #endif
328
329 #include "vlc_threads.h"
330
331 /*****************************************************************************
332  * Common structure members
333  *****************************************************************************/
334
335 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
336 #define VLC_COMMON_MEMBERS                                                  \
337 /** \name VLC_COMMON_MEMBERS                                                \
338  * these members are common for all vlc objects                             \
339  */                                                                         \
340 /**@{*/                                                                     \
341     int   i_object_id;                                                      \
342     int   i_object_type;                                                    \
343     char *psz_object_type;                                                  \
344     char *psz_object_name;                                                  \
345                                                                             \
346     /* Thread properties, if any */                                         \
347     vlc_bool_t   b_thread;                                                  \
348     vlc_thread_t thread_id;                                                 \
349                                                                             \
350     /* Object access lock */                                                \
351     vlc_mutex_t  object_lock;                                               \
352     vlc_cond_t   object_wait;                                               \
353                                                                             \
354     /* Object properties */                                                 \
355     volatile vlc_bool_t b_error;                  /**< set by the object */ \
356     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
357     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
358     volatile vlc_bool_t b_attached;               /**< set by the object */ \
359                                                                             \
360     /* Object variables */                                                  \
361     vlc_mutex_t     var_lock;                                               \
362     int             i_vars;                                                 \
363     variable_t *    p_vars;                                                 \
364                                                                             \
365     /* Stuff related to the libvlc structure */                             \
366     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
367     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
368                                                                             \
369     volatile int    i_refcount;                         /**< usage count */ \
370     vlc_object_t *  p_parent;                            /**< our parent */ \
371     vlc_object_t ** pp_children;                       /**< our children */ \
372     volatile int    i_children;                                             \
373                                                                             \
374     /* Private data */                                                      \
375     void *          p_private;                                              \
376                                                                             \
377     /** Just a reminder so that people don't cast garbage */                \
378     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
379 /**@}*/                                                                     \
380
381 /* VLC_OBJECT: attempt at doing a clever cast */
382 #define VLC_OBJECT( x ) \
383     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
384
385 /*****************************************************************************
386  * Macros and inline functions
387  *****************************************************************************/
388 #ifdef NTOHL_IN_SYS_PARAM_H
389 #   include <sys/param.h>
390
391 #elif !defined(WIN32) && !defined( UNDER_CE )
392 #   include <netinet/in.h>
393
394 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
395
396 /* CEIL: division with round to nearest greater integer */
397 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
398
399 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
400 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
401
402 /* __MAX and __MIN: self explanatory */
403 #ifndef __MAX
404 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
405 #endif
406 #ifndef __MIN
407 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
408 #endif
409
410 /* Dynamic array handling: realloc array, move data, increment position */
411 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
412     do                                                                        \
413     {                                                                         \
414         if( i_oldsize )                                                       \
415         {                                                                     \
416             (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) );  \
417         }                                                                     \
418         else                                                                  \
419         {                                                                     \
420             (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) );         \
421         }                                                                     \
422         if( (i_oldsize) - (i_pos) )                                           \
423         {                                                                     \
424             memmove( (p_ar) + (i_pos) + 1,                                    \
425                      (p_ar) + (i_pos),                                        \
426                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
427         }                                                                     \
428         (p_ar)[i_pos] = elem;                                                 \
429         (i_oldsize)++;                                                        \
430     }                                                                         \
431     while( 0 )
432
433 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
434     do                                                                        \
435     {                                                                         \
436         if( (i_oldsize) - (i_pos) - 1 )                                       \
437         {                                                                     \
438             memmove( (p_ar) + (i_pos),                                        \
439                      (p_ar) + (i_pos) + 1,                                    \
440                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
441         }                                                                     \
442         if( i_oldsize > 1 )                                                   \
443         {                                                                     \
444             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
445         }                                                                     \
446         else                                                                  \
447         {                                                                     \
448             free( p_ar );                                                     \
449             (p_ar) = NULL;                                                    \
450         }                                                                     \
451         (i_oldsize)--;                                                        \
452     }                                                                         \
453     while( 0 )
454
455
456 #define TAB_APPEND( count, tab, p )             \
457     if( (count) > 0 )                           \
458     {                                           \
459         (void *)(tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
460     }                                           \
461     else                                        \
462     {                                           \
463         (void *)(tab) = malloc( sizeof( void ** ) );    \
464     }                                           \
465     ((void**)(tab))[count] = (void*)(p);        \
466     (count)++
467
468 #define TAB_FIND( count, tab, p, index )        \
469     {                                           \
470         int _i_;                                \
471         (index) = -1;                           \
472         for( _i_ = 0; _i_ < (count); _i_++ )    \
473         {                                       \
474             if( ((void**)(tab))[_i_] == (void*)(p) )  \
475             {                                   \
476                 (index) = _i_;                  \
477                 break;                          \
478             }                                   \
479         }                                       \
480     }
481
482 #define TAB_REMOVE( count, tab, p )             \
483     {                                           \
484         int _i_index_;                          \
485         TAB_FIND( count, tab, p, _i_index_ );   \
486         if( _i_index_ >= 0 )                    \
487         {                                       \
488             if( (count) > 1 )                     \
489             {                                   \
490                 memmove( ((void**)(tab) + _i_index_),    \
491                          ((void**)(tab) + _i_index_+1),  \
492                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
493             }                                   \
494             else                                \
495             {                                   \
496                 free( tab );                    \
497                 (tab) = NULL;                   \
498             }                                   \
499             (count)--;                          \
500         }                                       \
501     }
502
503 /* MSB (big endian)/LSB (little endian) conversions - network order is always
504  * MSB, and should be used for both network communications and files. Note that
505  * byte orders other than little and big endians are not supported, but only
506  * the VAX seems to have such exotic properties. */
507 static inline uint16_t U16_AT( void const * _p )
508 {
509     uint8_t * p = (uint8_t *)_p;
510     return ( ((uint16_t)p[0] << 8) | p[1] );
511 }
512 static inline uint32_t U32_AT( void const * _p )
513 {
514     uint8_t * p = (uint8_t *)_p;
515     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
516               | ((uint32_t)p[2] << 8) | p[3] );
517 }
518 static inline uint64_t U64_AT( void const * _p )
519 {
520     uint8_t * p = (uint8_t *)_p;
521     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
522               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
523               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
524               | ((uint64_t)p[6] << 8) | p[7] );
525 }
526
527 static inline uint16_t GetWLE( void const * _p )
528 {
529     uint8_t * p = (uint8_t *)_p;
530     return ( ((uint16_t)p[1] << 8) | p[0] );
531 }
532 static inline uint32_t GetDWLE( void const * _p )
533 {
534     uint8_t * p = (uint8_t *)_p;
535     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
536               | ((uint32_t)p[1] << 8) | p[0] );
537 }
538 static inline uint64_t GetQWLE( void const * _p )
539 {
540     uint8_t * p = (uint8_t *)_p;
541     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
542               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
543               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
544               | ((uint64_t)p[1] << 8) | p[0] );
545 }
546
547 #define GetWBE( p )     U16_AT( p )
548 #define GetDWBE( p )    U32_AT( p )
549 #define GetQWBE( p )    U64_AT( p )
550
551 /* Helper writer functions */
552
553 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
554 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
555 {
556     p[1] = ( i_dw >>  8 )&0xff;
557     p[0] = ( i_dw       )&0xff;
558 }
559
560 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
561 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
562 {
563     p[3] = ( i_dw >> 24 )&0xff;
564     p[2] = ( i_dw >> 16 )&0xff;
565     p[1] = ( i_dw >>  8 )&0xff;
566     p[0] = ( i_dw       )&0xff;
567 }
568 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
569 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
570 {
571     SetDWLE( p,   i_qw&0xffffffff );
572     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
573 }
574
575 #if WORDS_BIGENDIAN
576 #   define hton16(i)   ( i )
577 #   define hton32(i)   ( i )
578 #   define hton64(i)   ( i )
579 #   define ntoh16(i)   ( i )
580 #   define ntoh32(i)   ( i )
581 #   define ntoh64(i)   ( i )
582 #else
583 #   define hton16(i)   U16_AT(&i)
584 #   define hton32(i)   U32_AT(&i)
585 #   define hton64(i)   U64_AT(&i)
586 #   define ntoh16(i)   U16_AT(&i)
587 #   define ntoh32(i)   U32_AT(&i)
588 #   define ntoh64(i)   U64_AT(&i)
589 #endif
590
591 /* Format string sanity checks */
592 #ifdef HAVE_ATTRIBUTE_FORMAT
593 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
594 #else
595 #   define ATTRIBUTE_FORMAT(x,y)
596 #endif
597
598 /* Alignment of critical static data structures */
599 #ifdef ATTRIBUTE_ALIGNED_MAX
600 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
601 #else
602 #   define ATTR_ALIGN(align)
603 #endif
604
605 /* Alignment of critical dynamic data structure
606  *
607  * Not all platforms support memalign so we provide a vlc_memalign wrapper
608  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
609  * *pp_orig is the pointer that has to be freed afterwards.
610  */
611 #if 0
612 #ifdef HAVE_POSIX_MEMALIGN
613 #   define vlc_memalign(align,size,pp_orig) \
614     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
615 #endif
616 #endif
617 #ifdef HAVE_MEMALIGN
618     /* Some systems have memalign() but no declaration for it */
619     void * memalign( size_t align, size_t size );
620
621 #   define vlc_memalign(pp_orig,align,size) \
622     ( *(pp_orig) = memalign( align, size ) )
623
624 #else /* We don't have any choice but to align manually */
625 #   define vlc_memalign(pp_orig,align,size) \
626     (( *(pp_orig) = malloc( size + align - 1 )) \
627         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
628                        & (~(unsigned long)(align-1)) ) \
629         : NULL )
630
631 #endif
632
633 /* Stuff defined in src/extras/libc.c */
634 #ifndef HAVE_STRDUP
635 #   define strdup vlc_strdup
636     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
637 #elif !defined(__PLUGIN__)
638 #   define vlc_strdup NULL
639 #endif
640
641 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
642 #   define vasprintf vlc_vasprintf
643     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
644 #elif !defined(__PLUGIN__)
645 #   define vlc_vasprintf NULL
646 #endif
647
648 #if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
649 #   define asprintf vlc_asprintf
650     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
651 #elif !defined(__PLUGIN__)
652 #   define vlc_asprintf NULL
653 #endif
654
655 #ifndef HAVE_STRNDUP
656 #   if defined(STRNDUP_IN_GNOME_H) && \
657         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
658          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
659         /* Do nothing: gnome.h defines strndup for us */
660 #   else
661 #       define strndup vlc_strndup
662         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
663 #   endif
664 #elif !defined(__PLUGIN__)
665 #   define vlc_strndup NULL
666 #endif
667
668 #ifndef HAVE_ATOF
669 #   define atof vlc_atof
670     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
671 #elif !defined(__PLUGIN__)
672 #   define vlc_atof NULL
673 #endif
674
675 #ifndef HAVE_ATOLL
676 #   define atoll vlc_atoll
677     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
678 #elif !defined(__PLUGIN__)
679 #   define vlc_atoll NULL
680 #endif
681
682 #ifndef HAVE_GETENV
683 #   define getenv vlc_getenv
684     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
685 #elif !defined(__PLUGIN__)
686 #   define vlc_getenv NULL
687 #endif
688
689 #ifndef HAVE_STRCASECMP
690 #   ifdef HAVE_STRICMP
691 #       define strcasecmp stricmp
692 #       if !defined(__PLUGIN__)
693 #           define vlc_strcasecmp NULL
694 #       endif
695 #   elif !defined(__PLUGIN__)
696 #       define strcasecmp vlc_strcasecmp
697         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
698 #   endif
699 #elif !defined(__PLUGIN__)
700 #   define vlc_strcasecmp NULL
701 #endif
702
703 #ifndef HAVE_STRNCASECMP
704 #   ifdef HAVE_STRNICMP
705 #       define strncasecmp strnicmp
706 #       if !defined(__PLUGIN__)
707 #           define vlc_strncasecmp NULL
708 #       endif
709 #   elif !defined(__PLUGIN__)
710 #       define strncasecmp vlc_strncasecmp
711         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
712 #   endif
713 #elif !defined(__PLUGIN__)
714 #   define vlc_strncasecmp NULL
715 #endif
716
717 /* Format type specifiers for 64 bits numbers */
718 #if !defined(WIN32) && !defined(UNDER_CE)
719 #   define I64Fd "%lld"
720 #   define I64Fi "%lli"
721 #   define I64Fo "%llo"
722 #   define I64Fu "%llu"
723 #   define I64Fx "%llx"
724 #   define I64FX "%llX"
725 #else
726 #   define I64Fd "%I64d"
727 #   define I64Fi "%I64i"
728 #   define I64Fo "%I64o"
729 #   define I64Fu "%I64u"
730 #   define I64Fx "%I64x"
731 #   define I64FX "%I64X"
732 #endif /* defined(WIN32)||defined(UNDER_CE) */
733
734 /* 64 bits integer constant suffix */
735 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
736 #   define I64C(x)         x##LL
737 #   define UI64C(x)        x##ULL
738 #else
739 #   define I64C(x)         x##i64
740 #   define UI64C(x)        x##ui64
741 #endif /* defined(WIN32)||defined(UNDER_CE) */
742
743 #if defined(WIN32) || defined(UNDER_CE)
744 /* win32, cl and icl support */
745 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
746 #       define __attribute__(x)
747 #       define __inline__      __inline
748 #       define S_IFBLK         0x3000  /* Block */
749 #       define S_ISBLK(m)      (0)
750 #       define S_ISCHR(m)      (0)
751 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
752 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
753 #   endif
754
755 /* several type definitions */
756 #   if defined( __MINGW32__ )
757 #       if !defined( _OFF_T_ )
758 typedef long long _off_t;
759 typedef _off_t off_t;
760 #           define _OFF_T_
761 #       else
762 #           ifdef off_t
763 #               undef off_t
764 #           endif
765 #           define off_t long long
766 #       endif
767 #   endif
768
769 #   if defined( _MSC_VER )
770 #       if !defined( _OFF_T_DEFINED )
771 typedef __int64 off_t;
772 #           define _OFF_T_DEFINED
773 #       else
774 #           define off_t __int64
775 #       endif
776 #   endif
777
778 #   if defined( __BORLANDC__ )
779 #       undef off_t
780 #       define off_t unsigned __int64
781 #   endif
782
783 #   ifndef O_NONBLOCK
784 #       define O_NONBLOCK 0
785 #   endif
786
787 #   ifndef alloca
788 #       define alloca _alloca
789 #   endif
790
791     /* These two are not defined in mingw32 (bug?) */
792 #   ifndef snprintf
793 #       define snprintf _snprintf
794 #   endif
795 #   ifndef vsnprintf
796 #       define vsnprintf _vsnprintf
797 #   endif
798
799 #endif
800
801 /* lseek (defined in src/extras/libc.c) */
802 #ifndef HAVE_LSEEK
803 #   define lseek vlc_lseek
804     VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
805 #elif !defined(__PLUGIN__)
806 #   define vlc_lseek NULL
807 #endif
808
809 /* vlc_wraptext (defined in src/extras/libc.c) */
810 #define wraptext vlc_wraptext
811 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
812
813 /*****************************************************************************
814  * CPU capabilities
815  *****************************************************************************/
816 #define CPU_CAPABILITY_NONE    0
817 #define CPU_CAPABILITY_486     (1<<0)
818 #define CPU_CAPABILITY_586     (1<<1)
819 #define CPU_CAPABILITY_PPRO    (1<<2)
820 #define CPU_CAPABILITY_MMX     (1<<3)
821 #define CPU_CAPABILITY_3DNOW   (1<<4)
822 #define CPU_CAPABILITY_MMXEXT  (1<<5)
823 #define CPU_CAPABILITY_SSE     (1<<6)
824 #define CPU_CAPABILITY_SSE2    (1<<7)
825 #define CPU_CAPABILITY_ALTIVEC (1<<16)
826 #define CPU_CAPABILITY_FPU     (1<<31)
827
828 /*****************************************************************************
829  * I18n stuff
830  *****************************************************************************/
831 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
832
833 #if defined( ENABLE_NLS ) && \
834      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
835       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
836       defined(MODULE_NAME_IS_pda))
837     /* Declare nothing: gnome.h will do it for us */
838 #elif defined( ENABLE_NLS )
839 #if defined( HAVE_INCLUDED_GETTEXT )
840 #   include "libintl.h"
841 #else
842 #   include <libintl.h>
843 #endif
844 #   undef _
845 #if defined( __BORLANDC__ )
846 #define _(String) vlc_dgettext (PACKAGE_TARNAME, String)
847 #else
848 #   define _(String) vlc_dgettext (PACKAGE, String)
849 #endif
850 #   define N_(String) ((char*)(String))
851 #else
852 #   define _(String) ((char*)(String))
853 #   define N_(String) ((char*)(String))
854 #endif
855
856 /*****************************************************************************
857  * Additional vlc stuff
858  *****************************************************************************/
859 #include "vlc_symbols.h"
860 #include "os_specific.h"
861 #include "vlc_messages.h"
862 #include "variables.h"
863 #include "vlc_objects.h"
864 #include "vlc_threads_funcs.h"
865 #include "mtime.h"
866 #include "modules.h"
867 #include "main.h"
868 #include "configuration.h"
869
870 #if defined( __BORLANDC__ )
871 #   undef PACKAGE
872 #   define PACKAGE
873 #endif
874