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