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
32 /*****************************************************************************
33 * Required vlc headers
34 *****************************************************************************/
35 #if defined( __BORLANDC__ )
43 # define PACKAGE_NAME PACKAGE
46 # undef PACKAGE_VERSION
47 # define PACKAGE_VERSION VERSION
50 #if defined( __BORLANDC__ )
51 # undef HAVE_VARIADIC_MACROS
53 # undef HAVE_INTTYPES_H
55 #elif defined( _MSC_VER )
56 # pragma warning( disable : 4244 )
59 #include "vlc_config.h"
61 /*****************************************************************************
62 * Required system headers
63 *****************************************************************************/
68 # include <string.h> /* strerror() */
71 #ifdef HAVE_SYS_TYPES_H
72 # include <sys/types.h>
75 /*****************************************************************************
76 * Basic types definitions
77 *****************************************************************************/
78 #if defined( HAVE_STDINT_H )
80 #elif defined( HAVE_INTTYPES_H )
81 # include <inttypes.h>
82 #elif defined( SYS_CYGWIN )
83 # include <sys/types.h>
84 /* Cygwin only defines half of these... */
85 typedef u_int8_t uint8_t;
86 typedef u_int16_t uint16_t;
87 typedef u_int32_t uint32_t;
88 typedef u_int64_t uint64_t;
90 /* Fallback types (very x86-centric, sorry) */
91 typedef unsigned char uint8_t;
92 typedef signed char int8_t;
93 typedef unsigned short uint16_t;
94 typedef signed short int16_t;
95 typedef unsigned int uint32_t;
96 typedef signed int int32_t;
97 # if defined( _MSC_VER ) \
98 || defined( UNDER_CE ) \
99 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
100 typedef unsigned __int64 uint64_t;
101 typedef signed __int64 int64_t;
103 typedef unsigned long long uint64_t;
104 typedef signed long long int64_t;
106 typedef uint32_t uintptr_t;
107 typedef int32_t intptr_t;
110 typedef uint8_t byte_t;
112 /* Systems that don't have stdint.h may not define INT64_MIN and
115 #define INT64_MIN (-9223372036854775807LL-1)
118 #define INT64_MAX (9223372036854775807LL)
121 /* ptrdiff_t definition */
128 /* Not portable in a 64-bit environment. */
129 typedef int ptrdiff_t;
133 #if defined( WIN32 ) || defined( UNDER_CE )
136 # define PATH_MAX MAX_PATH
140 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
144 /* Counter for statistics and profiling */
145 typedef unsigned long count_t;
147 /* DCT elements types */
148 typedef int16_t dctelem_t;
150 /* Video buffer types */
151 typedef uint8_t yuv_data_t;
154 typedef uint16_t audio_volume_t;
156 #ifndef HAVE_SOCKLEN_T
157 typedef int socklen_t;
161 * High precision date or time interval
163 * Store a high precision date or time interval. The maximum precision is the
164 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
165 * time interval is then 292271 years, which should be long enough for any
166 * video). Dates are stored as microseconds since a common date (usually the
167 * epoch). Note that date and time intervals can be manipulated using regular
168 * arithmetic operators, and that no special functions are required.
170 typedef int64_t mtime_t;
173 * The vlc_fourcc_t type.
175 * See http://www.webartz.com/fourcc/ for a very detailed list.
177 typedef uint32_t vlc_fourcc_t;
179 #ifdef WORDS_BIGENDIAN
180 # define VLC_FOURCC( a, b, c, d ) \
181 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
182 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
183 # define VLC_TWOCC( a, b ) \
184 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
187 # define VLC_FOURCC( a, b, c, d ) \
188 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
189 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
190 # define VLC_TWOCC( a, b ) \
191 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
195 /*****************************************************************************
196 * Classes declaration
197 *****************************************************************************/
200 typedef struct libvlc_global_data_t libvlc_global_data_t;
201 typedef struct libvlc_int_t libvlc_int_t;
202 typedef struct variable_t variable_t;
203 typedef struct date_t date_t;
204 typedef struct dict_entry_t dict_entry_t;
205 typedef struct dict_t dict_t;
206 typedef struct gc_object_t gc_object_t ;
209 typedef struct msg_bank_t msg_bank_t;
210 typedef struct msg_queue_t msg_queue_t;
211 typedef struct msg_subscription_t msg_subscription_t;
220 PLAYLIST_PLAY, /**< No arg. res=can fail*/
221 PLAYLIST_AUTOPLAY, /**< No arg. res=cant fail*/
222 PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
223 /** arg2 = playlist_item_t* , res=can fail */
224 PLAYLIST_PAUSE, /**< No arg res=can fail*/
225 PLAYLIST_STOP, /**< No arg res=can fail*/
226 PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
227 } playlist_command_t;
230 typedef struct playlist_t playlist_t;
231 typedef struct playlist_item_t playlist_item_t;
232 typedef struct playlist_view_t playlist_view_t;
233 typedef struct playlist_export_t playlist_export_t;
234 typedef struct services_discovery_t services_discovery_t;
235 typedef struct services_discovery_sys_t services_discovery_sys_t;
236 typedef struct playlist_add_t playlist_add_t;
237 typedef struct playlist_preparse_t playlist_preparse_t;
238 typedef struct playlist_fetcher_t playlist_fetcher_t;
241 typedef struct module_bank_t module_bank_t;
242 typedef struct module_t module_t;
243 typedef struct module_config_t module_config_t;
244 typedef struct module_symbols_t module_symbols_t;
245 typedef struct module_cache_t module_cache_t;
247 typedef struct config_category_t config_category_t;
250 typedef struct intf_thread_t intf_thread_t;
251 typedef struct intf_sys_t intf_sys_t;
252 typedef struct intf_console_t intf_console_t;
253 typedef struct intf_msg_t intf_msg_t;
254 typedef struct interaction_t interaction_t;
255 typedef struct interaction_dialog_t interaction_dialog_t;
256 typedef struct user_widget_t user_widget_t;
259 typedef struct input_thread_t input_thread_t;
260 typedef struct input_thread_sys_t input_thread_sys_t;
261 typedef struct input_item_t input_item_t;
262 typedef struct access_t access_t;
263 typedef struct access_sys_t access_sys_t;
264 typedef struct stream_t stream_t;
265 typedef struct stream_sys_t stream_sys_t;
266 typedef struct demux_t demux_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 vout_synchro_t vout_synchro_t;
298 typedef struct chroma_sys_t chroma_sys_t;
300 typedef video_format_t video_frame_format_t;
301 typedef struct picture_t picture_t;
302 typedef struct picture_sys_t picture_sys_t;
303 typedef struct picture_heap_t picture_heap_t;
306 typedef struct spu_t spu_t;
307 typedef struct subpicture_t subpicture_t;
308 typedef struct subpicture_sys_t subpicture_sys_t;
309 typedef struct subpicture_region_t subpicture_region_t;
310 typedef struct text_style_t text_style_t;
312 typedef struct image_handler_t image_handler_t;
315 typedef struct sout_instance_t sout_instance_t;
316 typedef struct sout_instance_sys_t sout_instance_sys_t;
318 typedef struct sout_input_t sout_input_t;
319 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
321 typedef struct sout_access_out_t sout_access_out_t;
322 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
324 typedef struct sout_mux_t sout_mux_t;
325 typedef struct sout_mux_sys_t sout_mux_sys_t;
327 typedef struct sout_stream_t sout_stream_t;
328 typedef struct sout_stream_sys_t sout_stream_sys_t;
330 typedef struct config_chain_t config_chain_t;
331 typedef struct sap_session_t sap_session_t;
332 typedef struct sap_address_t sap_address_t;
333 typedef struct session_descriptor_t session_descriptor_t;
334 typedef struct announce_method_t announce_method_t;
335 typedef struct announce_handler_t announce_handler_t;
336 typedef struct sap_handler_t sap_handler_t;
338 typedef struct sout_param_t sout_param_t;
339 typedef struct sout_pcat_t sout_pcat_t;
340 typedef struct sout_std_t sout_std_t;
341 typedef struct sout_display_t sout_display_t;
342 typedef struct sout_duplicate_t sout_duplicate_t;
343 typedef struct sout_transcode_t sout_transcode_t;
344 typedef struct sout_chain_t sout_chain_t;
345 typedef struct streaming_profile_t streaming_profile_t;
346 typedef struct sout_module_t sout_module_t;
347 typedef struct sout_gui_descr_t sout_gui_descr_t;
348 typedef struct profile_parser_t profile_parser_t;
351 typedef struct decoder_t decoder_t;
352 typedef struct decoder_sys_t decoder_sys_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;
370 typedef struct iso639_lang_t iso639_lang_t;
371 typedef struct device_t device_t;
372 typedef struct device_probe_t device_probe_t;
373 typedef struct probe_sys_t probe_sys_t;
376 typedef struct block_t block_t;
377 typedef struct block_fifo_t block_fifo_t;
380 typedef struct httpd_t httpd_t;
381 typedef struct httpd_host_t httpd_host_t;
382 typedef struct httpd_url_t httpd_url_t;
383 typedef struct httpd_client_t httpd_client_t;
384 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
385 typedef struct httpd_message_t httpd_message_t;
386 typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
387 typedef struct httpd_file_t httpd_file_t;
388 typedef struct httpd_file_sys_t httpd_file_sys_t;
389 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
390 typedef struct httpd_handler_t httpd_handler_t;
391 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
392 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 );
393 typedef struct httpd_redirect_t httpd_redirect_t;
394 typedef struct httpd_stream_t httpd_stream_t;
397 typedef struct tls_t tls_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 volatile int i_refcount; /**< usage count */ \
564 vlc_object_t * p_parent; /**< our parent */ \
565 vlc_object_t ** pp_children; /**< our children */ \
566 volatile int i_children; \
571 /** Just a reminder so that people don't cast garbage */ \
572 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
575 /* VLC_OBJECT: attempt at doing a clever cast */
576 #define VLC_OBJECT( x ) \
577 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
579 #define VLC_GC_MEMBERS \
580 /** \name VLC_GC_MEMBERS \
581 * these members are common to all objects that wish to be garbage-collected \
585 void (*pf_destructor) ( gc_object_t * ); \
586 void *p_destructor_arg; \
594 static inline void __vlc_gc_incref( gc_object_t * p_gc )
596 p_gc->i_gc_refcount ++;
599 static inline void __vlc_gc_decref( gc_object_t *p_gc )
601 p_gc->i_gc_refcount -- ;
603 if( p_gc->i_gc_refcount == 0 )
605 p_gc->pf_destructor( p_gc );
606 /* Do not use the p_gc pointer from now on ! */
610 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
611 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
612 #define vlc_gc_init( a,b,c ) { ((gc_object_t *)a)->i_gc_refcount = 0; \
613 ((gc_object_t *)a)->pf_destructor = b; \
614 ((gc_object_t *)a)->p_destructor_arg = c; }
617 /*****************************************************************************
618 * Macros and inline functions
619 *****************************************************************************/
620 #ifdef NTOHL_IN_SYS_PARAM_H
621 # include <sys/param.h>
623 #elif !defined(WIN32) && !defined( UNDER_CE )
624 # include <netinet/in.h>
626 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
628 /* CEIL: division with round to nearest greater integer */
629 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
631 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
632 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
634 /* __MAX and __MIN: self explanatory */
636 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
639 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
642 static int64_t GCD( int64_t a, int64_t b )
644 if( b ) return GCD( b, a % b );
648 /* function imported from libavutil/common.h */
649 static inline uint8_t clip_uint8_vlc( int32_t a )
651 if( a&(~255) ) return (-a)>>31;
655 /* Malloc with automatic error */
656 #define MALLOC_VOID( var, type ) { var = (type*)malloc( sizeof( type) ); \
658 #define MALLOC_NULL( var, type ) { var = (type*)malloc( sizeof( type) ); \
659 if( !var ) return NULL; }
660 #define MALLOC_ERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
661 if( !var ) return VLC_ENOMEM; }
662 #define MALLOC_GOTOERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
663 if( !var ) goto error; }
664 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
666 #define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
667 if( !var ) return VLC_ENOMEM;
668 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
669 if( !var ) return NULL;
671 #define FREENULL(a) if( a ) { free( a ); a = NULL; }
672 #define FREE(a) if( a ) { free( a ); }
674 #define EMPTY_STR(str) (!str || !*str)
676 VLC_EXPORT( char const *, vlc_error, ( int ) );
678 #include <vlc_arrays.h>
680 /* MSB (big endian)/LSB (little endian) conversions - network order is always
681 * MSB, and should be used for both network communications and files. Note that
682 * byte orders other than little and big endians are not supported, but only
683 * the VAX seems to have such exotic properties. */
684 static inline uint16_t U16_AT( const void * _p )
686 const uint8_t * p = (const uint8_t *)_p;
687 return ( ((uint16_t)p[0] << 8) | p[1] );
689 static inline uint32_t U32_AT( const void * _p )
691 const uint8_t * p = (const uint8_t *)_p;
692 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
693 | ((uint32_t)p[2] << 8) | p[3] );
695 static inline uint64_t U64_AT( const void * _p )
697 const uint8_t * p = (const uint8_t *)_p;
698 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
699 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
700 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
701 | ((uint64_t)p[6] << 8) | p[7] );
704 static inline uint16_t GetWLE( const void * _p )
706 const uint8_t * p = (const uint8_t *)_p;
707 return ( ((uint16_t)p[1] << 8) | p[0] );
709 static inline uint32_t GetDWLE( const void * _p )
711 const uint8_t * p = (const uint8_t *)_p;
712 return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
713 | ((uint32_t)p[1] << 8) | p[0] );
715 static inline uint64_t GetQWLE( const void * _p )
717 const uint8_t * p = (const uint8_t *)_p;
718 return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
719 | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
720 | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
721 | ((uint64_t)p[1] << 8) | p[0] );
724 #define GetWBE( p ) U16_AT( p )
725 #define GetDWBE( p ) U32_AT( p )
726 #define GetQWBE( p ) U64_AT( p )
728 /* Helper writer functions */
729 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
730 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
732 p[1] = ( i_dw >> 8 )&0xff;
733 p[0] = ( i_dw )&0xff;
736 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
737 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
739 p[3] = ( i_dw >> 24 )&0xff;
740 p[2] = ( i_dw >> 16 )&0xff;
741 p[1] = ( i_dw >> 8 )&0xff;
742 p[0] = ( i_dw )&0xff;
744 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
745 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
747 SetDWLE( p, i_qw&0xffffffff );
748 SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
750 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
751 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
753 p[0] = ( i_dw >> 8 )&0xff;
754 p[1] = ( i_dw )&0xff;
757 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
758 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
760 p[0] = ( i_dw >> 24 )&0xff;
761 p[1] = ( i_dw >> 16 )&0xff;
762 p[2] = ( i_dw >> 8 )&0xff;
763 p[3] = ( i_dw )&0xff;
765 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
766 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
768 SetDWBE( p+4, i_qw&0xffffffff );
769 SetDWBE( p, ( i_qw >> 32)&0xffffffff );
772 #ifdef WORDS_BIGENDIAN
773 # define hton16(i) ( i )
774 # define hton32(i) ( i )
775 # define hton64(i) ( i )
776 # define ntoh16(i) ( i )
777 # define ntoh32(i) ( i )
778 # define ntoh64(i) ( i )
780 # define hton16(i) U16_AT(&i)
781 # define hton32(i) U32_AT(&i)
782 # define hton64(i) U64_AT(&i)
783 # define ntoh16(i) U16_AT(&i)
784 # define ntoh32(i) U32_AT(&i)
785 # define ntoh64(i) U64_AT(&i)
788 /* Format string sanity checks */
789 #ifdef HAVE_ATTRIBUTE_FORMAT
790 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
792 # define ATTRIBUTE_FORMAT(x,y)
795 /* Alignment of critical static data structures */
796 #ifdef ATTRIBUTE_ALIGNED_MAX
797 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
799 # define ATTR_ALIGN(align)
802 /* Alignment of critical dynamic data structure
804 * Not all platforms support memalign so we provide a vlc_memalign wrapper
805 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
806 * *pp_orig is the pointer that has to be freed afterwards.
809 #ifdef HAVE_POSIX_MEMALIGN
810 # define vlc_memalign(align,size,pp_orig) \
811 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
815 /* Some systems have memalign() but no declaration for it */
816 void * memalign( size_t align, size_t size );
818 # define vlc_memalign(pp_orig,align,size) \
819 ( *(pp_orig) = memalign( align, size ) )
821 #else /* We don't have any choice but to align manually */
822 # define vlc_memalign(pp_orig,align,size) \
823 (( *(pp_orig) = malloc( size + align - 1 )) \
824 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
825 & (~(unsigned long)(align-1)) ) \
830 /* Stuff defined in src/extras/libc.c */
832 # define strdup vlc_strdup
833 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
834 #elif !defined(__PLUGIN__)
835 # define vlc_strdup NULL
838 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
839 # define vasprintf vlc_vasprintf
840 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
841 #elif !defined(__PLUGIN__)
842 # define vlc_vasprintf NULL
845 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
846 # define asprintf vlc_asprintf
847 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
848 #elif !defined(__PLUGIN__)
849 # define vlc_asprintf NULL
853 # if defined(STRNDUP_IN_GNOME_H) && \
854 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
855 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
856 /* Do nothing: gnome.h defines strndup for us */
858 # define strndup vlc_strndup
859 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
861 #elif !defined(__PLUGIN__)
862 # define vlc_strndup NULL
866 # define strnlen vlc_strnlen
867 VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
868 #elif !defined(__PLUGIN__)
869 # define vlc_strnlen NULL
873 # define strlcpy vlc_strlcpy
874 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
875 #elif !defined(__PLUGIN__)
876 # define vlc_strlcpy NULL
880 # define atof vlc_atof
881 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
882 #elif !defined(__PLUGIN__)
883 # define vlc_atof NULL
888 # define strtof strtod
893 # define atoll vlc_atoll
894 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
895 #elif !defined(__PLUGIN__)
896 # define vlc_atoll NULL
900 # define strtoll vlc_strtoll
901 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
902 #elif !defined(__PLUGIN__)
903 # define vlc_strtoll NULL
906 #if defined(SYS_BEOS) \
907 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
909 long long quot; /* Quotient. */
910 long long rem; /* Remainder. */
912 # define lldiv vlc_lldiv
913 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
914 #elif !defined(__PLUGIN__)
915 # define vlc_lldiv NULL
919 # define scandir vlc_scandir
920 # define alphasort vlc_alphasort
922 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
923 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
924 #elif !defined(__PLUGIN__)
925 # define vlc_scandir NULL
926 # define vlc_alphasort NULL
930 # define getenv vlc_getenv
931 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
932 #elif !defined(__PLUGIN__)
933 # define vlc_getenv NULL
936 #ifndef HAVE_STRCASECMP
937 # ifndef HAVE_STRICMP
938 # define strcasecmp vlc_strcasecmp
939 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
941 # define strcasecmp stricmp
942 # if !defined(__PLUGIN__)
943 # define vlc_strcasecmp NULL
946 #elif !defined(__PLUGIN__)
947 # define vlc_strcasecmp NULL
950 #ifndef HAVE_STRNCASECMP
951 # ifndef HAVE_STRNICMP
952 # define strncasecmp vlc_strncasecmp
953 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
955 # define strncasecmp strnicmp
956 # if !defined(__PLUGIN__)
957 # define vlc_strncasecmp NULL
960 #elif !defined(__PLUGIN__)
961 # define vlc_strncasecmp NULL
964 #ifndef HAVE_STRCASESTR
965 # ifndef HAVE_STRISTR
966 # define strcasestr vlc_strcasestr
967 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
969 # define strcasestr stristr
970 # if !defined(__PLUGIN__)
971 # define vlc_strcasestr NULL
974 #elif !defined(__PLUGIN__)
975 # define vlc_strcasestr NULL
978 #ifndef HAVE_DIRENT_H
980 # ifndef FILENAME_MAX
981 # define FILENAME_MAX (260)
985 long d_ino; /* Always zero. */
986 unsigned short d_reclen; /* Always zero. */
987 unsigned short d_namlen; /* Length of name in d_name. */
988 char d_name[FILENAME_MAX]; /* File name. */
990 # define opendir vlc_opendir
991 # define readdir vlc_readdir
992 # define closedir vlc_closedir
993 # define rewinddir vlc_rewindir
994 # define seekdir vlc_seekdir
995 # define telldir vlc_telldir
996 VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
997 VLC_EXPORT( void *, vlc_readdir, ( void * ) );
998 VLC_EXPORT( int, vlc_closedir, ( void * ) );
999 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1000 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1001 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1003 # if !defined(__PLUGIN__)
1004 # define vlc_opendir NULL
1005 # define vlc_readdir NULL
1006 # define vlc_closedir NULL
1011 # include <dirent.h>
1012 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
1013 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
1014 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
1015 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1016 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1017 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1018 # define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
1019 # define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
1020 # define closedir vlc_wclosedir
1021 # define _wopendir vlc_wopendir
1022 # define _wreaddir vlc_wreaddir
1023 # define _wclosedir vlc_wclosedir
1024 # define rewinddir vlc_rewinddir
1025 # define seekdir vlc_seekdir
1026 # define telldir vlc_telldir
1027 #elif !defined(__PLUGIN__)
1028 # define vlc_wclosedir NULL
1031 /* Format type specifiers for 64 bits numbers */
1032 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1033 # if defined(__WORDSIZE) && __WORDSIZE == 64
1034 # define I64Fd "%ld"
1035 # define I64Fi "%li"
1036 # define I64Fo "%lo"
1037 # define I64Fu "%lu"
1038 # define I64Fx "%lx"
1039 # define I64FX "%lX"
1041 # define I64Fd "%lld"
1042 # define I64Fi "%lli"
1043 # define I64Fo "%llo"
1044 # define I64Fu "%llu"
1045 # define I64Fx "%llx"
1046 # define I64FX "%llX"
1049 # define I64Fd "%I64d"
1050 # define I64Fi "%I64i"
1051 # define I64Fo "%I64o"
1052 # define I64Fu "%I64u"
1053 # define I64Fx "%I64x"
1054 # define I64FX "%I64X"
1055 #endif /* defined(WIN32)||defined(UNDER_CE) */
1057 /* 64 bits integer constant suffix */
1058 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1059 # if defined(__WORDSIZE) && __WORDSIZE == 64
1060 # define I64C(x) x##L
1061 # define UI64C(x) x##UL
1063 # define I64C(x) x##LL
1064 # define UI64C(x) x##ULL
1067 # define I64C(x) x##i64
1068 # define UI64C(x) x##ui64
1069 #endif /* defined(WIN32)||defined(UNDER_CE) */
1071 #if defined(WIN32) || defined(UNDER_CE)
1072 /* win32, cl and icl support */
1073 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
1074 # define __attribute__(x)
1075 # define __inline__ __inline
1076 # define S_IFBLK 0x3000 /* Block */
1077 # define S_ISBLK(m) (0)
1078 # define S_ISCHR(m) (0)
1079 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
1080 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
1083 /* several type definitions */
1084 # if defined( __MINGW32__ )
1085 # if !defined( _OFF_T_ )
1086 typedef long long _off_t;
1087 typedef _off_t off_t;
1093 # define off_t long long
1097 # if defined( _MSC_VER ) && !defined( __WXMSW__ )
1098 # if !defined( _OFF_T_DEFINED )
1099 typedef __int64 off_t;
1100 # define _OFF_T_DEFINED
1102 /* for wx compatibility typedef long off_t; */
1103 # define off_t __int64
1107 # if defined( __BORLANDC__ )
1109 # define off_t unsigned __int64
1113 # define O_NONBLOCK 0
1117 # define alloca _alloca
1120 /* These two are not defined in mingw32 (bug?) */
1122 # define snprintf _snprintf
1125 # define vsnprintf _vsnprintf
1131 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1132 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1134 /* vlc_wraptext (defined in src/extras/libc.c) */
1135 #define wraptext vlc_wraptext
1136 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1138 /* iconv wrappers (defined in src/extras/libc.c) */
1139 typedef void *vlc_iconv_t;
1140 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1141 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1142 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1144 /* execve wrapper (defined in src/extras/libc.c) */
1145 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 ) );
1146 #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)
1148 /*****************************************************************************
1150 *****************************************************************************/
1151 #define CPU_CAPABILITY_NONE 0
1152 #define CPU_CAPABILITY_486 (1<<0)
1153 #define CPU_CAPABILITY_586 (1<<1)
1154 #define CPU_CAPABILITY_PPRO (1<<2)
1155 #define CPU_CAPABILITY_MMX (1<<3)
1156 #define CPU_CAPABILITY_3DNOW (1<<4)
1157 #define CPU_CAPABILITY_MMXEXT (1<<5)
1158 #define CPU_CAPABILITY_SSE (1<<6)
1159 #define CPU_CAPABILITY_SSE2 (1<<7)
1160 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1161 #define CPU_CAPABILITY_FPU (1<<31)
1162 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1164 /*****************************************************************************
1166 *****************************************************************************/
1168 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1171 #if defined( ENABLE_NLS ) && \
1172 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1173 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1174 defined(MODULE_NAME_IS_pda))
1175 /* Declare nothing: gnome.h will do it for us */
1176 #elif defined( ENABLE_NLS )
1177 # if defined( HAVE_INCLUDED_GETTEXT )
1178 # include "libintl.h"
1180 # include <libintl.h>
1184 # define _(String) vlc_dgettext (PACKAGE_NAME, String)
1186 # define _(String) dgettext(PACKAGE_NAME, String)
1188 # define N_(String) (String)
1190 # define _(String) (String)
1191 # define N_(String) (String)
1194 /*****************************************************************************
1196 *****************************************************************************/
1197 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1198 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1199 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1200 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1201 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1202 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1203 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1205 /*****************************************************************************
1206 * Additional vlc stuff
1207 *****************************************************************************/
1208 #include "vlc_os_specific.h"
1209 #include "vlc_messages.h"
1210 #include "vlc_variables.h"
1211 #include "vlc_objects.h"
1212 #include "vlc_threads_funcs.h"
1213 #include "vlc_mtime.h"
1214 #include "vlc_modules.h"
1216 #include "vlc_configuration.h"
1218 /** The global thread var for msg stack context
1219 * We store this as a static global variable so we don't need a vlc_object_t
1221 * This key is created in vlc_threads_init and is therefore ready to use at
1222 * the very beginning of the universe */
1223 extern vlc_threadvar_t msg_context_global_key;
1226 #if defined( __BORLANDC__ )
1231 #if defined( WIN32 ) || defined( UNDER_CE )
1232 # define DIR_SEP_CHAR '\\'
1233 # define DIR_SEP "\\"
1235 # define DIR_SEP_CHAR '/'
1236 # define DIR_SEP "/"