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