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