1 /*****************************************************************************
2 * common.h: common definitions
3 * Collection of useful common types and macros definitions
4 *****************************************************************************
5 * Copyright (C) 1998-2005 the VideoLAN team
8 * Authors: Samuel Hocevar <sam@via.ecp.fr>
9 * Vincent Seguin <seguin@via.ecp.fr>
10 * Gildas Bazin <gbazin@videolan.org>
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
29 * This file is a collection of common definitions and types
33 /* Temporary regression test */
34 #error You probably forgot to include config.h!!
37 /*****************************************************************************
38 * Required vlc headers
39 *****************************************************************************/
40 #if defined( __BORLANDC__ )
41 # undef HAVE_VARIADIC_MACROS
43 # undef HAVE_INTTYPES_H
45 #elif defined( _MSC_VER )
46 # pragma warning( disable : 4244 )
49 #include "vlc_config.h"
51 /*****************************************************************************
52 * Required system headers
53 *****************************************************************************/
60 #ifdef HAVE_SYS_TYPES_H
61 # include <sys/types.h>
64 /*****************************************************************************
65 * Basic types definitions
66 *****************************************************************************/
67 #if defined( HAVE_STDINT_H )
69 #elif defined( HAVE_INTTYPES_H )
70 # include <inttypes.h>
71 #elif defined( SYS_CYGWIN )
72 # include <sys/types.h>
73 /* Cygwin only defines half of these... */
74 typedef u_int8_t uint8_t;
75 typedef u_int16_t uint16_t;
76 typedef u_int32_t uint32_t;
77 typedef u_int64_t uint64_t;
79 /* Fallback types (very x86-centric, sorry) */
80 typedef unsigned char uint8_t;
81 typedef signed char int8_t;
82 typedef unsigned short uint16_t;
83 typedef signed short int16_t;
84 typedef unsigned int uint32_t;
85 typedef signed int int32_t;
86 # if defined( _MSC_VER ) \
87 || defined( UNDER_CE ) \
88 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
89 typedef unsigned __int64 uint64_t;
90 typedef signed __int64 int64_t;
92 typedef unsigned long long uint64_t;
93 typedef signed long long int64_t;
95 typedef uint32_t uintptr_t;
96 typedef int32_t intptr_t;
99 typedef uint8_t byte_t;
101 /* Systems that don't have stdint.h may not define INT64_MIN and
104 #define INT64_MIN (-9223372036854775807LL-1)
107 #define INT64_MAX (9223372036854775807LL)
110 /* ptrdiff_t definition */
117 /* Not portable in a 64-bit environment. */
118 typedef int ptrdiff_t;
122 #if defined( WIN32 ) || defined( UNDER_CE )
125 # define PATH_MAX MAX_PATH
129 /* Counter for statistics and profiling */
130 typedef unsigned long count_t;
132 /* DCT elements types */
133 typedef int16_t dctelem_t;
135 /* Video buffer types */
136 typedef uint8_t yuv_data_t;
139 typedef uint16_t audio_volume_t;
142 * High precision date or time interval
144 * Store a high precision date or time interval. The maximum precision is the
145 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
146 * time interval is then 292271 years, which should be long enough for any
147 * video). Dates are stored as microseconds since a common date (usually the
148 * epoch). Note that date and time intervals can be manipulated using regular
149 * arithmetic operators, and that no special functions are required.
151 typedef int64_t mtime_t;
154 * The vlc_fourcc_t type.
156 * See http://www.webartz.com/fourcc/ for a very detailed list.
158 typedef uint32_t vlc_fourcc_t;
160 #ifdef WORDS_BIGENDIAN
161 # define VLC_FOURCC( a, b, c, d ) \
162 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
163 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
164 # define VLC_TWOCC( a, b ) \
165 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
168 # define VLC_FOURCC( a, b, c, d ) \
169 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
170 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
171 # define VLC_TWOCC( a, b ) \
172 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
176 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
178 #ifdef WORDS_BIGENDIAN
179 psz_fourcc[0] = (uint32_t) (fcc >> 24);
180 psz_fourcc[1] = (uint32_t) (fcc >> 16);
181 psz_fourcc[2] = (uint32_t) (fcc >> 8);
182 psz_fourcc[3] = (uint32_t) (fcc);
184 psz_fourcc[3] = (uint32_t) (fcc >> 24);
185 psz_fourcc[2] = (uint32_t) (fcc >> 16);
186 psz_fourcc[1] = (uint32_t) (fcc >> 8);
187 psz_fourcc[0] = (uint32_t) (fcc);
191 #define vlc_fourcc_to_char( a, b ) \
192 __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
194 /*****************************************************************************
195 * Classes declaration
196 *****************************************************************************/
199 typedef struct libvlc_global_data_t libvlc_global_data_t;
200 typedef struct libvlc_int_t libvlc_int_t;
201 typedef struct variable_t variable_t;
202 typedef struct date_t date_t;
203 typedef struct dict_entry_t dict_entry_t;
204 typedef struct dict_t dict_t;
205 typedef struct gc_object_t gc_object_t ;
208 typedef struct msg_bank_t msg_bank_t;
209 typedef struct msg_queue_t msg_queue_t;
210 typedef struct msg_subscription_t msg_subscription_t;
219 PLAYLIST_PLAY, /**< No arg. res=can fail*/
220 PLAYLIST_AUTOPLAY, /**< No arg. res=cant fail*/
221 PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
222 /** arg2 = playlist_item_t* , res=can fail */
223 PLAYLIST_PAUSE, /**< No arg res=can fail*/
224 PLAYLIST_STOP, /**< No arg res=can fail*/
225 PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
226 } playlist_command_t;
229 typedef struct playlist_t playlist_t;
230 typedef struct playlist_item_t playlist_item_t;
231 typedef struct playlist_view_t playlist_view_t;
232 typedef struct playlist_export_t playlist_export_t;
233 typedef struct services_discovery_t services_discovery_t;
234 typedef struct services_discovery_sys_t services_discovery_sys_t;
235 typedef struct playlist_add_t playlist_add_t;
236 typedef struct playlist_preparse_t playlist_preparse_t;
237 typedef struct playlist_fetcher_t playlist_fetcher_t;
240 typedef struct module_bank_t module_bank_t;
241 typedef struct module_t module_t;
242 typedef struct module_config_t module_config_t;
243 typedef struct module_symbols_t module_symbols_t;
244 typedef struct module_cache_t module_cache_t;
246 typedef struct config_category_t config_category_t;
249 typedef struct intf_thread_t intf_thread_t;
250 typedef struct intf_sys_t intf_sys_t;
251 typedef struct intf_console_t intf_console_t;
252 typedef struct intf_msg_t intf_msg_t;
253 typedef struct interaction_t interaction_t;
254 typedef struct interaction_dialog_t interaction_dialog_t;
255 typedef struct user_widget_t user_widget_t;
258 typedef struct input_thread_t input_thread_t;
259 typedef struct input_thread_sys_t input_thread_sys_t;
260 typedef struct input_item_t input_item_t;
261 typedef struct access_t access_t;
262 typedef struct access_sys_t access_sys_t;
263 typedef struct stream_t stream_t;
264 typedef struct stream_sys_t stream_sys_t;
265 typedef struct demux_t demux_t;
266 typedef struct demux_meta_t demux_meta_t;
267 typedef struct demux_sys_t demux_sys_t;
268 typedef struct es_out_t es_out_t;
269 typedef struct es_out_id_t es_out_id_t;
270 typedef struct es_out_sys_t es_out_sys_t;
271 typedef struct es_descriptor_t es_descriptor_t;
272 typedef struct seekpoint_t seekpoint_t;
273 typedef struct info_t info_t;
274 typedef struct info_category_t info_category_t;
275 typedef struct input_attachment_t input_attachment_t;
278 typedef struct audio_format_t audio_format_t;
279 typedef struct video_format_t video_format_t;
280 typedef struct subs_format_t subs_format_t;
281 typedef struct es_format_t es_format_t;
282 typedef struct video_palette_t video_palette_t;
285 typedef struct aout_instance_t aout_instance_t;
286 typedef struct aout_sys_t aout_sys_t;
287 typedef struct aout_fifo_t aout_fifo_t;
288 typedef struct aout_input_t aout_input_t;
289 typedef struct aout_buffer_t aout_buffer_t;
290 typedef audio_format_t audio_sample_format_t;
291 typedef struct audio_date_t audio_date_t;
292 typedef struct aout_filter_t aout_filter_t;
295 typedef struct vout_thread_t vout_thread_t;
296 typedef struct vout_sys_t vout_sys_t;
297 typedef struct chroma_sys_t chroma_sys_t;
299 typedef video_format_t video_frame_format_t;
300 typedef struct picture_t picture_t;
301 typedef struct picture_sys_t picture_sys_t;
302 typedef struct picture_heap_t picture_heap_t;
305 typedef struct spu_t spu_t;
306 typedef struct subpicture_t subpicture_t;
307 typedef struct subpicture_sys_t subpicture_sys_t;
308 typedef struct subpicture_region_t subpicture_region_t;
309 typedef struct text_style_t text_style_t;
311 typedef struct image_handler_t image_handler_t;
314 typedef struct sout_instance_t sout_instance_t;
315 typedef struct sout_instance_sys_t sout_instance_sys_t;
317 typedef struct sout_input_t sout_input_t;
318 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
320 typedef struct sout_access_out_t sout_access_out_t;
321 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
323 typedef struct sout_mux_t sout_mux_t;
324 typedef struct sout_mux_sys_t sout_mux_sys_t;
326 typedef struct sout_stream_t sout_stream_t;
327 typedef struct sout_stream_sys_t sout_stream_sys_t;
329 typedef struct config_chain_t config_chain_t;
330 typedef struct sap_session_t sap_session_t;
331 typedef struct sap_address_t sap_address_t;
332 typedef struct session_descriptor_t session_descriptor_t;
333 typedef struct announce_method_t announce_method_t;
334 typedef struct announce_handler_t announce_handler_t;
335 typedef struct sap_handler_t sap_handler_t;
337 typedef struct sout_param_t sout_param_t;
338 typedef struct sout_pcat_t sout_pcat_t;
339 typedef struct sout_std_t sout_std_t;
340 typedef struct sout_display_t sout_display_t;
341 typedef struct sout_duplicate_t sout_duplicate_t;
342 typedef struct sout_transcode_t sout_transcode_t;
343 typedef struct sout_chain_t sout_chain_t;
344 typedef struct streaming_profile_t streaming_profile_t;
345 typedef struct sout_module_t sout_module_t;
346 typedef struct sout_gui_descr_t sout_gui_descr_t;
347 typedef struct profile_parser_t profile_parser_t;
350 typedef struct decoder_t decoder_t;
351 typedef struct decoder_sys_t decoder_sys_t;
352 typedef struct decoder_synchro_t decoder_synchro_t;
355 typedef struct encoder_t encoder_t;
356 typedef struct encoder_sys_t encoder_sys_t;
359 typedef struct filter_t filter_t;
360 typedef struct filter_sys_t filter_sys_t;
363 typedef struct network_socket_t network_socket_t;
364 typedef struct virtual_socket_t v_socket_t;
365 typedef struct sockaddr sockaddr;
366 typedef struct addrinfo addrinfo;
367 typedef struct vlc_acl_t vlc_acl_t;
368 typedef struct vlc_url_t vlc_url_t;
371 typedef struct iso639_lang_t iso639_lang_t;
372 typedef struct device_t device_t;
373 typedef struct device_probe_t device_probe_t;
374 typedef struct probe_sys_t probe_sys_t;
377 typedef struct block_t block_t;
378 typedef struct block_fifo_t block_fifo_t;
381 typedef struct httpd_t httpd_t;
382 typedef struct httpd_host_t httpd_host_t;
383 typedef struct httpd_url_t httpd_url_t;
384 typedef struct httpd_client_t httpd_client_t;
385 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
386 typedef struct httpd_message_t httpd_message_t;
387 typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
388 typedef struct httpd_file_t httpd_file_t;
389 typedef struct httpd_file_sys_t httpd_file_sys_t;
390 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
391 typedef struct httpd_handler_t httpd_handler_t;
392 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
393 typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data );
394 typedef struct httpd_redirect_t httpd_redirect_t;
395 typedef struct httpd_stream_t httpd_stream_t;
398 typedef struct tls_server_t tls_server_t;
399 typedef struct tls_session_t tls_session_t;
402 typedef struct md5_s md5_t;
405 typedef struct xml_t xml_t;
406 typedef struct xml_sys_t xml_sys_t;
407 typedef struct xml_reader_t xml_reader_t;
408 typedef struct xml_reader_sys_t xml_reader_sys_t;
411 typedef struct vod_t vod_t;
412 typedef struct vod_sys_t vod_sys_t;
413 typedef struct vod_media_t vod_media_t;
416 typedef struct opengl_t opengl_t;
417 typedef struct opengl_sys_t opengl_sys_t;
420 typedef struct osd_menu_t osd_menu_t;
421 typedef struct osd_state_t osd_state_t;
422 typedef struct osd_event_t osd_event_t;
423 typedef struct osd_button_t osd_button_t;
424 typedef struct osd_menu_state_t osd_menu_state_t;
427 typedef struct vlm_t vlm_t;
428 typedef struct vlm_message_t vlm_message_t;
431 typedef struct vlc_meta_t vlc_meta_t;
432 typedef struct meta_export_t meta_export_t;
435 typedef struct counter_t counter_t;
436 typedef struct counter_sample_t counter_sample_t;
437 typedef struct stats_handler_t stats_handler_t;
438 typedef struct input_stats_t input_stats_t;
439 typedef struct global_stats_t global_stats_t;
442 typedef struct update_t update_t;
443 typedef struct update_iterator_t update_iterator_t;
446 typedef struct meta_engine_t meta_engine_t;
448 /* stat/lstat/fstat */
450 #include <sys/stat.h>
452 #define stat _stati64
453 #define fstat _fstati64
454 /* You should otherwise use utf8_stat and utf8_lstat. */
459 /*****************************************************************************
461 *****************************************************************************/
462 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
463 char const *, /* variable name */
464 vlc_value_t, /* old value */
465 vlc_value_t, /* new value */
466 void * ); /* callback data */
468 /*****************************************************************************
470 *****************************************************************************/
472 #include "vlc_modules_macros.h"
474 #if defined (WIN32) && defined (DLL_EXPORT)
476 # define VLC_PUBLIC_API __declspec(dllexport)
477 # define VLC_PRIVATE_API __declspec(dllexport)
478 # define VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
479 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
481 # define VLC_PUBLIC_API extern __declspec(dllexport)
482 # define VLC_PRIVATE_API extern __declspec(dllexport)
483 # define VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
484 # define VLC_INTERNAL( type, name, args ) type name args
488 # if HAVE_ATTRIBUTE_VISIBILITY
489 # define VLC_PUBLIC_API __attribute__((visibility("default")))
490 # define VLC_PRIVATE_API __attribute__((visibility("default")))
491 # define VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
492 # define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
494 # define VLC_PUBLIC_API
495 # define VLC_EXPORT( type, name, args ) extern "C" type name args
496 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
499 # if HAVE_ATTRIBUTE_VISIBILITY
500 # define VLC_PUBLIC_API extern __attribute__((visibility("default")))
501 # define VLC_PRIVATE_API extern __attribute__((visibility("default")))
502 # define VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
503 # define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
505 # define VLC_PUBLIC_API extern
506 # define VLC_PRIVATE_API extern
507 # define VLC_EXPORT( type, name, args ) type name args
508 # define VLC_INTERNAL( type, name, args ) type name args
513 /*****************************************************************************
514 * OS-specific headers and thread types
515 *****************************************************************************/
516 #if defined( WIN32 ) || defined( UNDER_CE )
517 # define WIN32_LEAN_AND_MEAN
518 # include <windows.h>
519 # if defined( UNDER_CE )
522 # define IS_WINNT ( GetVersion() < 0x80000000 )
526 #include "vlc_threads.h"
528 typedef struct vlc_object_internals_t vlc_object_internals_t;
530 /*****************************************************************************
531 * Common structure members
532 *****************************************************************************/
534 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
535 #define VLC_COMMON_MEMBERS \
536 /** \name VLC_COMMON_MEMBERS \
537 * these members are common for all vlc objects \
540 vlc_object_internals_t *p_internals; \
543 const char *psz_object_type; \
544 const char *psz_object_name; \
546 /* Messages header */ \
550 /* Object access lock */ \
551 vlc_mutex_t object_lock; \
552 vlc_cond_t object_wait; \
554 /* Object properties */ \
555 volatile vlc_bool_t b_error; /**< set by the object */ \
556 volatile vlc_bool_t b_die; /**< set by the outside */ \
557 volatile vlc_bool_t b_dead; /**< set by the object */ \
558 vlc_bool_t b_force; /**< set by the outside (eg. module_Need()) */ \
560 /* Stuff related to the libvlc structure */ \
561 libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
563 vlc_object_t * p_parent; /**< our parent */ \
564 vlc_object_t ** pp_children; /**< our children */ \
565 volatile int i_children; \
570 /** Just a reminder so that people don't cast garbage */ \
571 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
574 /* VLC_OBJECT: attempt at doing a clever cast */
575 #define VLC_OBJECT( x ) \
576 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
578 #define VLC_GC_MEMBERS \
579 /** \name VLC_GC_MEMBERS \
580 * these members are common to all objects that wish to be garbage-collected \
584 void (*pf_destructor) ( gc_object_t * ); \
585 void *p_destructor_arg; \
593 #include <assert.h> /* FIXME: should not be included here */
595 static inline void __vlc_gc_incref( gc_object_t * p_gc )
597 assert( p_gc->i_gc_refcount > 0 );
599 p_gc->i_gc_refcount ++;
602 static inline void __vlc_gc_decref( gc_object_t *p_gc )
606 assert( p_gc->i_gc_refcount > 0 );
608 p_gc->i_gc_refcount -- ;
610 if( p_gc->i_gc_refcount == 0 )
612 p_gc->pf_destructor( p_gc );
613 /* Do not use the p_gc pointer from now on ! */
618 __vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
621 p_gc->i_gc_refcount = 1;
622 p_gc->pf_destructor = pf_destructor;
623 p_gc->p_destructor_arg = arg;
626 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
627 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
628 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
631 /*****************************************************************************
632 * Macros and inline functions
633 *****************************************************************************/
634 #ifdef NTOHL_IN_SYS_PARAM_H
635 # include <sys/param.h>
637 #elif !defined(WIN32) && !defined( UNDER_CE )
638 # include <netinet/in.h>
640 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
642 /* CEIL: division with round to nearest greater integer */
643 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
645 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
646 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
648 /* __MAX and __MIN: self explanatory */
650 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
653 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
656 static inline int64_t GCD( int64_t a, int64_t b )
667 /* function imported from libavutil/common.h */
668 static inline uint8_t clip_uint8_vlc( int32_t a )
670 if( a&(~255) ) return (-a)>>31;
674 /* Malloc with automatic error */
675 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
676 if( !var ) return; } while(0)
677 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
678 if( !var ) return NULL; } while(0)
679 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
680 if( !var ) return VLC_ENOMEM; } while(0)
681 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
682 if( !var ) goto error; } while(0)
683 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
685 #define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
686 if( !var ) return VLC_ENOMEM;
687 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
688 if( !var ) return NULL;
690 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
692 #define EMPTY_STR(str) (!str || !*str)
694 VLC_EXPORT( char const *, vlc_error, ( int ) );
696 #include <vlc_arrays.h>
698 /* MSB (big endian)/LSB (little endian) conversions - network order is always
699 * MSB, and should be used for both network communications and files. Note that
700 * byte orders other than little and big endians are not supported, but only
701 * the VAX seems to have such exotic properties. */
702 static inline uint16_t U16_AT( const void * _p )
704 const uint8_t * p = (const uint8_t *)_p;
705 return ( ((uint16_t)p[0] << 8) | p[1] );
707 static inline uint32_t U32_AT( const void * _p )
709 const uint8_t * p = (const uint8_t *)_p;
710 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
711 | ((uint32_t)p[2] << 8) | p[3] );
713 static inline uint64_t U64_AT( const void * _p )
715 const uint8_t * p = (const uint8_t *)_p;
716 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
717 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
718 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
719 | ((uint64_t)p[6] << 8) | p[7] );
722 static inline uint16_t GetWLE( const void * _p )
724 const uint8_t * p = (const uint8_t *)_p;
725 return ( ((uint16_t)p[1] << 8) | p[0] );
727 static inline uint32_t GetDWLE( const void * _p )
729 const uint8_t * p = (const uint8_t *)_p;
730 return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
731 | ((uint32_t)p[1] << 8) | p[0] );
733 static inline uint64_t GetQWLE( const void * _p )
735 const uint8_t * p = (const uint8_t *)_p;
736 return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
737 | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
738 | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
739 | ((uint64_t)p[1] << 8) | p[0] );
742 #define GetWBE( p ) U16_AT( p )
743 #define GetDWBE( p ) U32_AT( p )
744 #define GetQWBE( p ) U64_AT( p )
746 /* Helper writer functions */
747 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
748 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
750 p[1] = ( i_dw >> 8 )&0xff;
751 p[0] = ( i_dw )&0xff;
754 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
755 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
757 p[3] = ( i_dw >> 24 )&0xff;
758 p[2] = ( i_dw >> 16 )&0xff;
759 p[1] = ( i_dw >> 8 )&0xff;
760 p[0] = ( i_dw )&0xff;
762 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
763 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
765 SetDWLE( p, i_qw&0xffffffff );
766 SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
768 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
769 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
771 p[0] = ( i_dw >> 8 )&0xff;
772 p[1] = ( i_dw )&0xff;
775 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
776 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
778 p[0] = ( i_dw >> 24 )&0xff;
779 p[1] = ( i_dw >> 16 )&0xff;
780 p[2] = ( i_dw >> 8 )&0xff;
781 p[3] = ( i_dw )&0xff;
783 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
784 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
786 SetDWBE( p+4, i_qw&0xffffffff );
787 SetDWBE( p, ( i_qw >> 32)&0xffffffff );
790 #ifdef WORDS_BIGENDIAN
791 # define hton16(i) ( i )
792 # define hton32(i) ( i )
793 # define hton64(i) ( i )
794 # define ntoh16(i) ( i )
795 # define ntoh32(i) ( i )
796 # define ntoh64(i) ( i )
798 # define hton16(i) U16_AT(&i)
799 # define hton32(i) U32_AT(&i)
800 # define hton64(i) U64_AT(&i)
801 # define ntoh16(i) U16_AT(&i)
802 # define ntoh32(i) U32_AT(&i)
803 # define ntoh64(i) U64_AT(&i)
806 /* Format string sanity checks */
807 #ifdef HAVE_ATTRIBUTE_FORMAT
808 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
810 # define ATTRIBUTE_FORMAT(x,y)
813 /* Alignment of critical static data structures */
814 #ifdef ATTRIBUTE_ALIGNED_MAX
815 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
817 # define ATTR_ALIGN(align)
821 #define VLC_UNUSED(x) (void)(x)
823 /* Alignment of critical dynamic data structure
825 * Not all platforms support memalign so we provide a vlc_memalign wrapper
826 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
827 * *pp_orig is the pointer that has to be freed afterwards.
830 #ifdef HAVE_POSIX_MEMALIGN
831 # define vlc_memalign(align,size,pp_orig) \
832 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
836 /* Some systems have memalign() but no declaration for it */
837 void * memalign( size_t align, size_t size );
839 # define vlc_memalign(pp_orig,align,size) \
840 ( *(pp_orig) = memalign( align, size ) )
842 #else /* We don't have any choice but to align manually */
843 # define vlc_memalign(pp_orig,align,size) \
844 (( *(pp_orig) = malloc( size + align - 1 )) \
845 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
846 & (~(unsigned long)(align-1)) ) \
851 /* Stuff defined in src/extras/libc.c */
853 # define strdup vlc_strdup
854 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
855 #elif !defined(__PLUGIN__)
856 # define vlc_strdup NULL
859 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
860 # define vasprintf vlc_vasprintf
861 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
862 #elif !defined(__PLUGIN__)
863 # define vlc_vasprintf NULL
866 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
867 # define asprintf vlc_asprintf
868 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
869 #elif !defined(__PLUGIN__)
870 # define vlc_asprintf NULL
874 # if defined(STRNDUP_IN_GNOME_H) && \
875 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
876 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
877 /* Do nothing: gnome.h defines strndup for us */
879 # define strndup vlc_strndup
880 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
882 #elif !defined(__PLUGIN__)
883 # define vlc_strndup NULL
887 # define strnlen vlc_strnlen
888 VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
889 #elif !defined(__PLUGIN__)
890 # define vlc_strnlen NULL
894 # define strlcpy vlc_strlcpy
895 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
896 #elif !defined(__PLUGIN__)
897 # define vlc_strlcpy NULL
901 # define atof vlc_atof
902 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
903 #elif !defined(__PLUGIN__)
904 # define vlc_atof NULL
909 # define strtof strtod
914 # define atoll vlc_atoll
915 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
916 #elif !defined(__PLUGIN__)
917 # define vlc_atoll NULL
921 # define strtoll vlc_strtoll
922 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
923 #elif !defined(__PLUGIN__)
924 # define vlc_strtoll NULL
927 #if defined(SYS_BEOS) \
928 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
930 long long quot; /* Quotient. */
931 long long rem; /* Remainder. */
933 # define lldiv vlc_lldiv
934 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
935 #elif !defined(__PLUGIN__)
936 # define vlc_lldiv NULL
940 # define scandir vlc_scandir
941 # define alphasort vlc_alphasort
943 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
944 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
945 #elif !defined(__PLUGIN__)
946 # define vlc_scandir NULL
947 # define vlc_alphasort NULL
951 # define getenv vlc_getenv
952 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
953 #elif !defined(__PLUGIN__)
954 # define vlc_getenv NULL
957 #ifndef HAVE_STRCASECMP
958 # ifndef HAVE_STRICMP
959 # define strcasecmp vlc_strcasecmp
960 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
962 # define strcasecmp stricmp
963 # if !defined(__PLUGIN__)
964 # define vlc_strcasecmp NULL
967 #elif !defined(__PLUGIN__)
968 # define vlc_strcasecmp NULL
971 #ifndef HAVE_STRNCASECMP
972 # ifndef HAVE_STRNICMP
973 # define strncasecmp vlc_strncasecmp
974 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
976 # define strncasecmp strnicmp
977 # if !defined(__PLUGIN__)
978 # define vlc_strncasecmp NULL
981 #elif !defined(__PLUGIN__)
982 # define vlc_strncasecmp NULL
985 #ifndef HAVE_STRCASESTR
986 # ifndef HAVE_STRISTR
987 # define strcasestr vlc_strcasestr
988 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
990 # define strcasestr stristr
991 # if !defined(__PLUGIN__)
992 # define vlc_strcasestr NULL
995 #elif !defined(__PLUGIN__)
996 # define vlc_strcasestr NULL
999 #ifndef HAVE_DIRENT_H
1001 # ifndef FILENAME_MAX
1002 # define FILENAME_MAX (260)
1006 long d_ino; /* Always zero. */
1007 unsigned short d_reclen; /* Always zero. */
1008 unsigned short d_namlen; /* Length of name in d_name. */
1009 char d_name[FILENAME_MAX]; /* File name. */
1011 # define opendir vlc_opendir
1012 # define readdir vlc_readdir
1013 # define closedir vlc_closedir
1014 # define rewinddir vlc_rewindir
1015 # define seekdir vlc_seekdir
1016 # define telldir vlc_telldir
1017 VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
1018 VLC_EXPORT( void *, vlc_readdir, ( void * ) );
1019 VLC_EXPORT( int, vlc_closedir, ( void * ) );
1020 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1021 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1022 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1024 # if !defined(__PLUGIN__)
1025 # define vlc_opendir NULL
1026 # define vlc_readdir NULL
1027 # define vlc_closedir NULL
1032 # include <dirent.h>
1033 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
1034 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
1035 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
1036 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1037 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1038 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1039 # define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
1040 # define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
1041 # define closedir vlc_wclosedir
1042 # define _wopendir vlc_wopendir
1043 # define _wreaddir vlc_wreaddir
1044 # define _wclosedir vlc_wclosedir
1045 # define rewinddir vlc_rewinddir
1046 # define seekdir vlc_seekdir
1047 # define telldir vlc_telldir
1048 #elif !defined(__PLUGIN__)
1049 # define vlc_wclosedir NULL
1052 /* Format type specifiers for 64 bits numbers */
1053 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1054 # if defined(__WORDSIZE) && __WORDSIZE == 64
1055 # define I64Fd "%ld"
1056 # define I64Fi "%li"
1057 # define I64Fo "%lo"
1058 # define I64Fu "%lu"
1059 # define I64Fx "%lx"
1060 # define I64FX "%lX"
1062 # define I64Fd "%lld"
1063 # define I64Fi "%lli"
1064 # define I64Fo "%llo"
1065 # define I64Fu "%llu"
1066 # define I64Fx "%llx"
1067 # define I64FX "%llX"
1070 # define I64Fd "%I64d"
1071 # define I64Fi "%I64i"
1072 # define I64Fo "%I64o"
1073 # define I64Fu "%I64u"
1074 # define I64Fx "%I64x"
1075 # define I64FX "%I64X"
1076 #endif /* defined(WIN32)||defined(UNDER_CE) */
1078 /* 64 bits integer constant suffix */
1079 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1080 # if defined(__WORDSIZE) && __WORDSIZE == 64
1081 # define I64C(x) x##L
1082 # define UI64C(x) x##UL
1084 # define I64C(x) x##LL
1085 # define UI64C(x) x##ULL
1088 # define I64C(x) x##i64
1089 # define UI64C(x) x##ui64
1090 #endif /* defined(WIN32)||defined(UNDER_CE) */
1092 #if defined(WIN32) || defined(UNDER_CE)
1093 /* win32, cl and icl support */
1094 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
1095 # define __attribute__(x)
1096 # define __inline__ __inline
1097 # define S_IFBLK 0x3000 /* Block */
1098 # define S_ISBLK(m) (0)
1099 # define S_ISCHR(m) (0)
1100 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
1101 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
1104 /* several type definitions */
1105 # if defined( __MINGW32__ )
1106 # if !defined( _OFF_T_ )
1107 typedef long long _off_t;
1108 typedef _off_t off_t;
1114 # define off_t long long
1118 # if defined( _MSC_VER ) && !defined( __WXMSW__ )
1119 # if !defined( _OFF_T_DEFINED )
1120 typedef __int64 off_t;
1121 # define _OFF_T_DEFINED
1123 /* for wx compatibility typedef long off_t; */
1124 # define off_t __int64
1128 # if defined( __BORLANDC__ )
1130 # define off_t unsigned __int64
1134 # define O_NONBLOCK 0
1138 # define alloca _alloca
1141 /* These two are not defined in mingw32 (bug?) */
1143 # define snprintf _snprintf
1146 # define vsnprintf _vsnprintf
1152 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1153 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1155 /* vlc_wraptext (defined in src/extras/libc.c) */
1156 #define wraptext vlc_wraptext
1157 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1159 /* iconv wrappers (defined in src/extras/libc.c) */
1160 typedef void *vlc_iconv_t;
1161 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1162 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1163 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1165 /* execve wrapper (defined in src/extras/libc.c) */
1166 VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const *pp_argv, char *const *pp_env, const char *psz_cwd, const char *p_in, size_t i_in, char **pp_data, size_t *pi_data ) );
1167 #define vlc_execve(a,b,c,d,e,f,g,h,i) __vlc_execve(VLC_OBJECT(a),b,c,d,e,f,g,h,i)
1169 /*****************************************************************************
1171 *****************************************************************************/
1172 #define CPU_CAPABILITY_NONE 0
1173 #define CPU_CAPABILITY_486 (1<<0)
1174 #define CPU_CAPABILITY_586 (1<<1)
1175 #define CPU_CAPABILITY_PPRO (1<<2)
1176 #define CPU_CAPABILITY_MMX (1<<3)
1177 #define CPU_CAPABILITY_3DNOW (1<<4)
1178 #define CPU_CAPABILITY_MMXEXT (1<<5)
1179 #define CPU_CAPABILITY_SSE (1<<6)
1180 #define CPU_CAPABILITY_SSE2 (1<<7)
1181 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1182 #define CPU_CAPABILITY_FPU (1<<31)
1183 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1185 /*****************************************************************************
1187 *****************************************************************************/
1189 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1192 #if defined( ENABLE_NLS ) && \
1193 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1194 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1195 defined(MODULE_NAME_IS_pda))
1196 /* Declare nothing: gnome.h will do it for us */
1197 #elif defined( ENABLE_NLS )
1198 # if defined( HAVE_INCLUDED_GETTEXT )
1199 # include "libintl.h"
1201 # include <libintl.h>
1205 # define _(String) vlc_dgettext (PACKAGE_NAME, String)
1207 # define _(String) dgettext(PACKAGE_NAME, String)
1209 # define N_(String) (String)
1211 # define _(String) (String)
1212 # define N_(String) (String)
1215 /*****************************************************************************
1217 *****************************************************************************/
1218 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1219 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1220 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1221 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1222 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1223 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1224 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1226 /*****************************************************************************
1227 * Additional vlc stuff
1228 *****************************************************************************/
1229 #include "vlc_os_specific.h"
1230 #include "vlc_messages.h"
1231 #include "vlc_variables.h"
1232 #include "vlc_objects.h"
1233 #include "vlc_mtime.h"
1234 #include "vlc_threads_funcs.h"
1235 #include "vlc_modules.h"
1237 #include "vlc_configuration.h"
1239 /** The global thread var for msg stack context
1240 * We store this as a static global variable so we don't need a vlc_object_t
1242 * This key is created in vlc_threads_init and is therefore ready to use at
1243 * the very beginning of the universe */
1244 extern vlc_threadvar_t msg_context_global_key;
1247 #if defined( __BORLANDC__ )
1252 #if defined( WIN32 ) || defined( UNDER_CE )
1253 # define DIR_SEP_CHAR '\\'
1254 # define DIR_SEP "\\"
1256 # define DIR_SEP_CHAR '/'
1257 # define DIR_SEP "/"