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