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 *****************************************************************************/
30 * This file is a collection of common definitions and types
33 /*****************************************************************************
34 * Required vlc headers
35 *****************************************************************************/
36 #if defined( __BORLANDC__ )
44 # define PACKAGE_NAME PACKAGE
47 # undef PACKAGE_VERSION
48 # define PACKAGE_VERSION VERSION
51 #if defined( __BORLANDC__ )
52 # undef HAVE_VARIADIC_MACROS
54 # undef HAVE_INTTYPES_H
56 #elif defined( _MSC_VER )
57 # pragma warning( disable : 4244 )
60 #include "vlc_config.h"
61 #include "modules_inner.h"
63 /*****************************************************************************
64 * Required system headers
65 *****************************************************************************/
70 # include <string.h> /* strerror() */
73 #ifdef HAVE_SYS_TYPES_H
74 # include <sys/types.h>
77 /*****************************************************************************
78 * Basic types definitions
79 *****************************************************************************/
80 #if defined( HAVE_STDINT_H )
82 #elif defined( HAVE_INTTYPES_H )
83 # include <inttypes.h>
84 #elif defined( SYS_CYGWIN )
85 # include <sys/types.h>
86 /* Cygwin only defines half of these... */
87 typedef u_int8_t uint8_t;
88 typedef u_int16_t uint16_t;
89 typedef u_int32_t uint32_t;
90 typedef u_int64_t uint64_t;
92 /* Fallback types (very x86-centric, sorry) */
93 typedef unsigned char uint8_t;
94 typedef signed char int8_t;
95 typedef unsigned short uint16_t;
96 typedef signed short int16_t;
97 typedef unsigned int uint32_t;
98 typedef signed int int32_t;
99 # if defined( _MSC_VER ) \
100 || defined( UNDER_CE ) \
101 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
102 typedef unsigned __int64 uint64_t;
103 typedef signed __int64 int64_t;
105 typedef unsigned long long uint64_t;
106 typedef signed long long int64_t;
108 typedef uint32_t uintptr_t;
109 typedef int32_t intptr_t;
112 typedef uint8_t byte_t;
114 /* Systems that don't have stdint.h may not define INT64_MIN and
117 #define INT64_MIN (-9223372036854775807LL-1)
120 #define INT64_MAX (9223372036854775807LL)
123 /* ptrdiff_t definition */
130 /* Not portable in a 64-bit environment. */
131 typedef int ptrdiff_t;
135 #if defined( WIN32 ) || defined( UNDER_CE )
138 # define PATH_MAX MAX_PATH
142 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
146 /* Counter for statistics and profiling */
147 typedef unsigned long count_t;
149 /* DCT elements types */
150 typedef int16_t dctelem_t;
152 /* Video buffer types */
153 typedef uint8_t yuv_data_t;
156 typedef uint16_t audio_volume_t;
158 #ifndef HAVE_SOCKLEN_T
159 typedef int socklen_t;
163 * High precision date or time interval
165 * Store a high precision date or time interval. The maximum precision is the
166 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
167 * time interval is then 292271 years, which should be long enough for any
168 * video). Dates are stored as microseconds since a common date (usually the
169 * epoch). Note that date and time intervals can be manipulated using regular
170 * arithmetic operators, and that no special functions are required.
172 typedef int64_t mtime_t;
175 * The vlc_fourcc_t type.
177 * See http://www.webartz.com/fourcc/ for a very detailed list.
179 typedef uint32_t vlc_fourcc_t;
181 #ifdef WORDS_BIGENDIAN
182 # define VLC_FOURCC( a, b, c, d ) \
183 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
184 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
185 # define VLC_TWOCC( a, b ) \
186 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
189 # define VLC_FOURCC( a, b, c, d ) \
190 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
191 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
192 # define VLC_TWOCC( a, b ) \
193 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
197 /*****************************************************************************
198 * Classes declaration
199 *****************************************************************************/
202 typedef struct libvlc_global_data_t libvlc_global_data_t;
203 typedef struct libvlc_int_t libvlc_int_t;
204 typedef struct variable_t variable_t;
205 typedef struct date_t date_t;
206 typedef struct dict_entry_t dict_entry_t;
207 typedef struct dict_t dict_t;
208 typedef struct gc_object_t gc_object_t ;
211 typedef struct msg_bank_t msg_bank_t;
212 typedef struct msg_queue_t msg_queue_t;
213 typedef struct msg_subscription_t msg_subscription_t;
222 PLAYLIST_PLAY, /**< No arg. res=can fail*/
223 PLAYLIST_AUTOPLAY, /**< No arg. res=cant fail*/
224 PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
225 /** arg2 = playlist_item_t* , res=can fail */
226 PLAYLIST_PAUSE, /**< No arg res=can fail*/
227 PLAYLIST_STOP, /**< No arg res=can fail*/
228 PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
229 } playlist_command_t;
232 typedef struct playlist_t playlist_t;
233 typedef struct playlist_item_t playlist_item_t;
234 typedef struct playlist_view_t playlist_view_t;
235 typedef struct playlist_export_t playlist_export_t;
236 typedef struct services_discovery_t services_discovery_t;
237 typedef struct services_discovery_sys_t services_discovery_sys_t;
238 typedef struct playlist_add_t playlist_add_t;
239 typedef struct playlist_preparse_t playlist_preparse_t;
240 typedef struct playlist_secondary_preparse_t playlist_secondary_preparse_t;
243 typedef struct module_bank_t module_bank_t;
244 typedef struct module_t module_t;
245 typedef struct module_config_t module_config_t;
246 typedef struct module_symbols_t module_symbols_t;
247 typedef struct module_cache_t module_cache_t;
249 typedef struct config_category_t config_category_t;
252 typedef struct intf_thread_t intf_thread_t;
253 typedef struct intf_sys_t intf_sys_t;
254 typedef struct intf_console_t intf_console_t;
255 typedef struct intf_msg_t intf_msg_t;
256 typedef struct interaction_t interaction_t;
257 typedef struct interaction_dialog_t interaction_dialog_t;
258 typedef struct user_widget_t user_widget_t;
261 typedef struct input_thread_t input_thread_t;
262 typedef struct input_thread_sys_t input_thread_sys_t;
263 typedef struct input_item_t input_item_t;
264 typedef struct access_t access_t;
265 typedef struct access_sys_t access_sys_t;
266 typedef struct stream_t stream_t;
267 typedef struct stream_sys_t stream_sys_t;
268 typedef struct demux_t demux_t;
269 typedef struct demux_sys_t demux_sys_t;
270 typedef struct es_out_t es_out_t;
271 typedef struct es_out_id_t es_out_id_t;
272 typedef struct es_out_sys_t es_out_sys_t;
273 typedef struct es_descriptor_t es_descriptor_t;
274 typedef struct seekpoint_t seekpoint_t;
275 typedef struct info_t info_t;
276 typedef struct info_category_t info_category_t;
279 typedef struct audio_format_t audio_format_t;
280 typedef struct video_format_t video_format_t;
281 typedef struct subs_format_t subs_format_t;
282 typedef struct es_format_t es_format_t;
283 typedef struct video_palette_t video_palette_t;
286 typedef struct aout_instance_t aout_instance_t;
287 typedef struct aout_sys_t aout_sys_t;
288 typedef struct aout_fifo_t aout_fifo_t;
289 typedef struct aout_input_t aout_input_t;
290 typedef struct aout_buffer_t aout_buffer_t;
291 typedef audio_format_t audio_sample_format_t;
292 typedef struct audio_date_t audio_date_t;
293 typedef struct aout_filter_t aout_filter_t;
296 typedef struct vout_thread_t vout_thread_t;
297 typedef struct vout_sys_t vout_sys_t;
298 typedef struct vout_synchro_t vout_synchro_t;
299 typedef struct chroma_sys_t chroma_sys_t;
301 typedef video_format_t video_frame_format_t;
302 typedef struct picture_t picture_t;
303 typedef struct picture_sys_t picture_sys_t;
304 typedef struct picture_heap_t picture_heap_t;
307 typedef struct spu_t spu_t;
308 typedef struct subpicture_t subpicture_t;
309 typedef struct subpicture_sys_t subpicture_sys_t;
310 typedef struct subpicture_region_t subpicture_region_t;
311 typedef struct text_style_t text_style_t;
313 typedef struct image_handler_t image_handler_t;
316 typedef struct sout_instance_t sout_instance_t;
317 typedef struct sout_instance_sys_t sout_instance_sys_t;
319 typedef struct sout_input_t sout_input_t;
320 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
322 typedef struct sout_access_out_t sout_access_out_t;
323 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
325 typedef struct sout_mux_t sout_mux_t;
326 typedef struct sout_mux_sys_t sout_mux_sys_t;
328 typedef struct sout_stream_t sout_stream_t;
329 typedef struct sout_stream_sys_t sout_stream_sys_t;
331 typedef struct sout_cfg_t sout_cfg_t;
332 typedef struct sap_session_t sap_session_t;
333 typedef struct sap_address_t sap_address_t;
334 typedef struct session_descriptor_t session_descriptor_t;
335 typedef struct announce_method_t announce_method_t;
336 typedef struct announce_handler_t announce_handler_t;
337 typedef struct sap_handler_t sap_handler_t;
339 typedef struct sout_param_t sout_param_t;
340 typedef struct sout_pcat_t sout_pcat_t;
341 typedef struct sout_std_t sout_std_t;
342 typedef struct sout_display_t sout_display_t;
343 typedef struct sout_duplicate_t sout_duplicate_t;
344 typedef struct sout_transcode_t sout_transcode_t;
345 typedef struct sout_chain_t sout_chain_t;
346 typedef struct streaming_profile_t streaming_profile_t;
347 typedef struct sout_module_t sout_module_t;
348 typedef struct sout_gui_descr_t sout_gui_descr_t;
349 typedef struct profile_parser_t profile_parser_t;
352 typedef struct decoder_t decoder_t;
353 typedef struct decoder_sys_t decoder_sys_t;
356 typedef struct encoder_t encoder_t;
357 typedef struct encoder_sys_t encoder_sys_t;
360 typedef struct filter_t filter_t;
361 typedef struct filter_sys_t filter_sys_t;
364 typedef struct network_socket_t network_socket_t;
365 typedef struct virtual_socket_t v_socket_t;
366 typedef struct sockaddr sockaddr;
367 typedef struct addrinfo addrinfo;
368 typedef struct vlc_acl_t vlc_acl_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, 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_t tls_t;
399 typedef struct tls_server_t tls_server_t;
400 typedef struct tls_session_t tls_session_t;
403 typedef struct md5_s md5_t;
406 typedef struct xml_t xml_t;
407 typedef struct xml_sys_t xml_sys_t;
408 typedef struct xml_reader_t xml_reader_t;
409 typedef struct xml_reader_sys_t xml_reader_sys_t;
412 typedef struct vod_t vod_t;
413 typedef struct vod_sys_t vod_sys_t;
414 typedef struct vod_media_t vod_media_t;
417 typedef struct opengl_t opengl_t;
418 typedef struct opengl_sys_t opengl_sys_t;
421 typedef struct osd_menu_t osd_menu_t;
422 typedef struct osd_state_t osd_state_t;
423 typedef struct osd_event_t osd_event_t;
424 typedef struct osd_button_t osd_button_t;
425 typedef struct osd_menu_state_t osd_menu_state_t;
428 typedef struct vlm_t vlm_t;
429 typedef struct vlm_message_t vlm_message_t;
430 typedef struct vlm_media_t vlm_media_t;
431 typedef struct vlm_schedule_t vlm_schedule_t;
434 typedef struct vlc_meta_t vlc_meta_t;
435 typedef struct meta_export_t meta_export_t;
438 typedef struct counter_t counter_t;
439 typedef struct counter_sample_t counter_sample_t;
440 typedef struct stats_handler_t stats_handler_t;
441 typedef struct input_stats_t input_stats_t;
442 typedef struct global_stats_t global_stats_t;
445 typedef struct update_t update_t;
446 typedef struct update_iterator_t update_iterator_t;
449 typedef struct meta_engine_t meta_engine_t;
451 /*****************************************************************************
453 *****************************************************************************/
454 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
455 char const *, /* variable name */
456 vlc_value_t, /* old value */
457 vlc_value_t, /* new value */
458 void * ); /* callback data */
460 /*****************************************************************************
462 *****************************************************************************/
463 #if !defined (__PLUGIN__) || defined (HAVE_SHARED_LIBVLC)
465 # define VLC_EXPORT( type, name, args ) extern "C" type name args
467 # define VLC_EXPORT( type, name, args ) type name args
470 # define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
471 extern module_symbols_t* p_symbols;
474 /*****************************************************************************
475 * OS-specific headers and thread types
476 *****************************************************************************/
477 #if defined( WIN32 ) || defined( UNDER_CE )
478 # define WIN32_LEAN_AND_MEAN
479 # include <windows.h>
480 # if defined( UNDER_CE )
483 # define IS_WINNT ( GetVersion() < 0x80000000 )
487 #include "vlc_threads.h"
489 /*****************************************************************************
490 * Common structure members
491 *****************************************************************************/
493 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
494 #define VLC_COMMON_MEMBERS \
495 /** \name VLC_COMMON_MEMBERS \
496 * these members are common for all vlc objects \
501 const char *psz_object_type; \
502 char *psz_object_name; \
504 /* Messages header */ \
508 /* Thread properties, if any */ \
509 vlc_bool_t b_thread; \
510 vlc_thread_t thread_id; \
512 /* Object access lock */ \
513 vlc_mutex_t object_lock; \
514 vlc_cond_t object_wait; \
516 /* Object properties */ \
517 volatile vlc_bool_t b_error; /**< set by the object */ \
518 volatile vlc_bool_t b_die; /**< set by the outside */ \
519 volatile vlc_bool_t b_dead; /**< set by the object */ \
520 volatile vlc_bool_t b_attached; /**< set by the object */ \
521 vlc_bool_t b_force; /**< set by the outside (eg. module_Need()) */ \
523 /* Object variables */ \
524 vlc_mutex_t var_lock; \
526 variable_t * p_vars; \
528 /* Stuff related to the libvlc structure */ \
529 libvlc_global_data_t *p_libvlc_global; /**< root of all evil */ \
530 libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
532 volatile int i_refcount; /**< usage count */ \
533 vlc_object_t * p_parent; /**< our parent */ \
534 vlc_object_t ** pp_children; /**< our children */ \
535 volatile int i_children; \
540 /** Just a reminder so that people don't cast garbage */ \
541 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
544 /* VLC_OBJECT: attempt at doing a clever cast */
545 #define VLC_OBJECT( x ) \
546 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
548 #define VLC_GC_MEMBERS \
549 /** \name VLC_GC_MEMBERS \
550 * these members are common to all objects that wish to be garbage-collected \
554 void (*pf_destructor) ( gc_object_t * ); \
555 void *p_destructor_arg; \
563 static inline void __vlc_gc_incref( gc_object_t * p_gc )
565 p_gc->i_gc_refcount ++;
568 static inline void __vlc_gc_decref( gc_object_t *p_gc )
570 p_gc->i_gc_refcount -- ;
572 if( p_gc->i_gc_refcount == 0 )
574 p_gc->pf_destructor( p_gc );
575 /* Do not use the p_gc pointer from now on ! */
579 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
580 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
581 #define vlc_gc_init( a,b,c ) { ((gc_object_t *)a)->i_gc_refcount = 0; \
582 ((gc_object_t *)a)->pf_destructor = b; \
583 ((gc_object_t *)a)->p_destructor_arg = c; }
586 /*****************************************************************************
587 * Macros and inline functions
588 *****************************************************************************/
589 #ifdef NTOHL_IN_SYS_PARAM_H
590 # include <sys/param.h>
592 #elif !defined(WIN32) && !defined( UNDER_CE )
593 # include <netinet/in.h>
595 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
597 /* CEIL: division with round to nearest greater integer */
598 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
600 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
601 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
603 /* __MAX and __MIN: self explanatory */
605 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
608 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
611 static int64_t GCD( int64_t a, int64_t b )
613 if( b ) return GCD( b, a % b );
617 /* Malloc with automatic error */
618 #define MALLOC_VOID( var, type ) { var = (type*)malloc( sizeof( type) ); \
620 #define MALLOC_NULL( var, type ) { var = (type*)malloc( sizeof( type) ); \
621 if( !var ) return NULL; }
622 #define MALLOC_ERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
623 if( !var ) return VLC_ENOMEM; }
624 #define MALLOC_GOTOERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
625 if( !var ) goto error; }
626 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
628 #define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
629 if( !var ) return VLC_ENOMEM;
630 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
631 if( !var ) return NULL;
633 #define FREENULL(a) if( a ) { free( a ); a = NULL; }
634 #define FREE(a) if( a ) { free( a ); }
636 /* Dynamic array handling: realloc array, move data, increment position */
637 #if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
638 # define VLCCVP (void**) /* Work-around for broken compiler */
642 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
645 if( !i_oldsize ) (p_ar) = NULL; \
646 (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \
647 if( (i_oldsize) - (i_pos) ) \
649 memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos), \
650 ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
652 (p_ar)[i_pos] = elem; \
657 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
660 if( (i_oldsize) - (i_pos) - 1 ) \
662 memmove( (p_ar) + (i_pos), \
663 (p_ar) + (i_pos) + 1, \
664 ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
666 if( i_oldsize > 1 ) \
668 (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
680 #define TAB_APPEND( count, tab, p ) \
683 (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
687 (tab) = malloc( sizeof( void ** ) ); \
689 (tab)[count] = (p); \
692 #define TAB_FIND( count, tab, p, index ) \
696 for( _i_ = 0; _i_ < (count); _i_++ ) \
698 if( (tab)[_i_] == (p) ) \
706 #define TAB_REMOVE( count, tab, p ) \
709 TAB_FIND( count, tab, p, _i_index_ ); \
710 if( _i_index_ >= 0 ) \
714 memmove( ((void**)(tab) + _i_index_), \
715 ((void**)(tab) + _i_index_+1), \
716 ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
727 /* Binary search in an array */
728 #define BSEARCH( entries, count, elem, zetype, key, answer ) { \
729 int low = 0, high = count - 1; \
731 while( low <= high ) {\
732 int mid = (low + high ) / 2; /* Just don't care about 2^30 tables */ \
733 zetype mid_val = entries[mid] elem;\
734 if( mid_val < key ) \
736 else if ( mid_val > key ) \
740 answer = mid; break; \
745 /* Dictionnary handling */
756 dict_entry_t *p_entries;
760 VLC_EXPORT( dict_t *, vlc_DictNew, (void) );
761 VLC_EXPORT( void, vlc_DictClear, (dict_t * ) );
762 VLC_EXPORT( void, vlc_DictInsert, (dict_t *, int, const char *, void * ) );
763 VLC_EXPORT( void*, vlc_DictGet, (dict_t *, int, const char * ) );
764 VLC_EXPORT( int, vlc_DictLookup, (dict_t *, int, const char * ) );
766 /* MSB (big endian)/LSB (little endian) conversions - network order is always
767 * MSB, and should be used for both network communications and files. Note that
768 * byte orders other than little and big endians are not supported, but only
769 * the VAX seems to have such exotic properties. */
770 static inline uint16_t U16_AT( void const * _p )
772 uint8_t * p = (uint8_t *)_p;
773 return ( ((uint16_t)p[0] << 8) | p[1] );
775 static inline uint32_t U32_AT( void const * _p )
777 uint8_t * p = (uint8_t *)_p;
778 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
779 | ((uint32_t)p[2] << 8) | p[3] );
781 static inline uint64_t U64_AT( void const * _p )
783 uint8_t * p = (uint8_t *)_p;
784 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
785 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
786 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
787 | ((uint64_t)p[6] << 8) | p[7] );
790 static inline uint16_t GetWLE( void const * _p )
792 uint8_t * p = (uint8_t *)_p;
793 return ( ((uint16_t)p[1] << 8) | p[0] );
795 static inline uint32_t GetDWLE( void const * _p )
797 uint8_t * p = (uint8_t *)_p;
798 return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
799 | ((uint32_t)p[1] << 8) | p[0] );
801 static inline uint64_t GetQWLE( void const * _p )
803 uint8_t * p = (uint8_t *)_p;
804 return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
805 | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
806 | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
807 | ((uint64_t)p[1] << 8) | p[0] );
810 #define GetWBE( p ) U16_AT( p )
811 #define GetDWBE( p ) U32_AT( p )
812 #define GetQWBE( p ) U64_AT( p )
814 /* Helper writer functions */
815 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
816 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
818 p[1] = ( i_dw >> 8 )&0xff;
819 p[0] = ( i_dw )&0xff;
822 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
823 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
825 p[3] = ( i_dw >> 24 )&0xff;
826 p[2] = ( i_dw >> 16 )&0xff;
827 p[1] = ( i_dw >> 8 )&0xff;
828 p[0] = ( i_dw )&0xff;
830 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
831 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
833 SetDWLE( p, i_qw&0xffffffff );
834 SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
836 #define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
837 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
839 p[0] = ( i_dw >> 8 )&0xff;
840 p[1] = ( i_dw )&0xff;
843 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
844 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
846 p[0] = ( i_dw >> 24 )&0xff;
847 p[1] = ( i_dw >> 16 )&0xff;
848 p[2] = ( i_dw >> 8 )&0xff;
849 p[3] = ( i_dw )&0xff;
851 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
852 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
854 SetDWBE( p+4, i_qw&0xffffffff );
855 SetDWBE( p, ( i_qw >> 32)&0xffffffff );
859 # define hton16(i) ( i )
860 # define hton32(i) ( i )
861 # define hton64(i) ( i )
862 # define ntoh16(i) ( i )
863 # define ntoh32(i) ( i )
864 # define ntoh64(i) ( i )
866 # define hton16(i) U16_AT(&i)
867 # define hton32(i) U32_AT(&i)
868 # define hton64(i) U64_AT(&i)
869 # define ntoh16(i) U16_AT(&i)
870 # define ntoh32(i) U32_AT(&i)
871 # define ntoh64(i) U64_AT(&i)
874 /* Format string sanity checks */
875 #ifdef HAVE_ATTRIBUTE_FORMAT
876 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
878 # define ATTRIBUTE_FORMAT(x,y)
881 /* Alignment of critical static data structures */
882 #ifdef ATTRIBUTE_ALIGNED_MAX
883 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
885 # define ATTR_ALIGN(align)
888 /* Alignment of critical dynamic data structure
890 * Not all platforms support memalign so we provide a vlc_memalign wrapper
891 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
892 * *pp_orig is the pointer that has to be freed afterwards.
895 #ifdef HAVE_POSIX_MEMALIGN
896 # define vlc_memalign(align,size,pp_orig) \
897 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
901 /* Some systems have memalign() but no declaration for it */
902 void * memalign( size_t align, size_t size );
904 # define vlc_memalign(pp_orig,align,size) \
905 ( *(pp_orig) = memalign( align, size ) )
907 #else /* We don't have any choice but to align manually */
908 # define vlc_memalign(pp_orig,align,size) \
909 (( *(pp_orig) = malloc( size + align - 1 )) \
910 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
911 & (~(unsigned long)(align-1)) ) \
916 /* Stuff defined in src/extras/libc.c */
918 # define strdup vlc_strdup
919 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
920 #elif !defined(__PLUGIN__)
921 # define vlc_strdup NULL
924 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
925 # define vasprintf vlc_vasprintf
926 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
927 #elif !defined(__PLUGIN__)
928 # define vlc_vasprintf NULL
931 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
932 # define asprintf vlc_asprintf
933 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
934 #elif !defined(__PLUGIN__)
935 # define vlc_asprintf NULL
939 # if defined(STRNDUP_IN_GNOME_H) && \
940 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
941 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
942 /* Do nothing: gnome.h defines strndup for us */
944 # define strndup vlc_strndup
945 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
947 #elif !defined(__PLUGIN__)
948 # define vlc_strndup NULL
952 # define strlcpy vlc_strlcpy
953 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
954 #elif !defined(__PLUGIN__)
955 # define vlc_strlcpy NULL
959 # define atof vlc_atof
960 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
961 #elif !defined(__PLUGIN__)
962 # define vlc_atof NULL
967 # define strtof strtod
972 # define atoll vlc_atoll
973 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
974 #elif !defined(__PLUGIN__)
975 # define vlc_atoll NULL
979 # define strtoll vlc_strtoll
980 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
981 #elif !defined(__PLUGIN__)
982 # define vlc_strtoll NULL
985 #if defined(SYS_BEOS)
987 long long quot; /* Quotient. */
988 long long rem; /* Remainder. */
990 # define lldiv vlc_lldiv
991 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
992 #elif !defined(__PLUGIN__)
993 # define vlc_lldiv NULL
997 # define scandir vlc_scandir
998 # define alphasort vlc_alphasort
1000 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
1001 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
1002 #elif !defined(__PLUGIN__)
1003 # define vlc_scandir NULL
1004 # define vlc_alphasort NULL
1008 # define getenv vlc_getenv
1009 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
1010 #elif !defined(__PLUGIN__)
1011 # define vlc_getenv NULL
1014 #ifndef HAVE_STRCASECMP
1015 # ifndef HAVE_STRICMP
1016 # define strcasecmp vlc_strcasecmp
1017 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
1019 # define strcasecmp stricmp
1020 # if !defined(__PLUGIN__)
1021 # define vlc_strcasecmp NULL
1024 #elif !defined(__PLUGIN__)
1025 # define vlc_strcasecmp NULL
1028 #ifndef HAVE_STRNCASECMP
1029 # ifndef HAVE_STRNICMP
1030 # define strncasecmp vlc_strncasecmp
1031 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
1033 # define strncasecmp strnicmp
1034 # if !defined(__PLUGIN__)
1035 # define vlc_strncasecmp NULL
1038 #elif !defined(__PLUGIN__)
1039 # define vlc_strncasecmp NULL
1042 #ifndef HAVE_STRCASESTR
1043 # ifndef HAVE_STRISTR
1044 # define strcasestr vlc_strcasestr
1045 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
1047 # define strcasestr stristr
1048 # if !defined(__PLUGIN__)
1049 # define vlc_strcasestr NULL
1052 #elif !defined(__PLUGIN__)
1053 # define vlc_strcasestr NULL
1056 #ifndef HAVE_DIRENT_H
1058 # ifndef FILENAME_MAX
1059 # define FILENAME_MAX (260)
1063 long d_ino; /* Always zero. */
1064 unsigned short d_reclen; /* Always zero. */
1065 unsigned short d_namlen; /* Length of name in d_name. */
1066 char d_name[FILENAME_MAX]; /* File name. */
1068 # define opendir vlc_opendir
1069 # define readdir vlc_readdir
1070 # define closedir vlc_closedir
1071 VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
1072 VLC_EXPORT( void *, vlc_readdir, ( void * ) );
1073 VLC_EXPORT( int, vlc_closedir, ( void * ) );
1075 struct dirent; /* forward declaration for vlc_symbols.h */
1076 # if !defined(__PLUGIN__)
1077 # define vlc_opendir NULL
1078 # define vlc_readdir NULL
1079 # define vlc_closedir NULL
1083 VLC_EXPORT( void *, vlc_opendir_wrapper, ( const char * ) );
1084 VLC_EXPORT( struct dirent *, vlc_readdir_wrapper, ( void * ) );
1085 VLC_EXPORT( int, vlc_closedir_wrapper, ( void * ) );
1087 /* Format type specifiers for 64 bits numbers */
1088 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1089 # if defined(__WORDSIZE) && __WORDSIZE == 64
1090 # define I64Fd "%ld"
1091 # define I64Fi "%li"
1092 # define I64Fo "%lo"
1093 # define I64Fu "%lu"
1094 # define I64Fx "%lx"
1095 # define I64FX "%lX"
1097 # define I64Fd "%lld"
1098 # define I64Fi "%lli"
1099 # define I64Fo "%llo"
1100 # define I64Fu "%llu"
1101 # define I64Fx "%llx"
1102 # define I64FX "%llX"
1105 # define I64Fd "%I64d"
1106 # define I64Fi "%I64i"
1107 # define I64Fo "%I64o"
1108 # define I64Fu "%I64u"
1109 # define I64Fx "%I64x"
1110 # define I64FX "%I64X"
1111 #endif /* defined(WIN32)||defined(UNDER_CE) */
1113 /* 64 bits integer constant suffix */
1114 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1115 # if defined(__WORDSIZE) && __WORDSIZE == 64
1116 # define I64C(x) x##L
1117 # define UI64C(x) x##UL
1119 # define I64C(x) x##LL
1120 # define UI64C(x) x##ULL
1123 # define I64C(x) x##i64
1124 # define UI64C(x) x##ui64
1125 #endif /* defined(WIN32)||defined(UNDER_CE) */
1127 #if defined(WIN32) || defined(UNDER_CE)
1128 /* win32, cl and icl support */
1129 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
1130 # define __attribute__(x)
1131 # define __inline__ __inline
1132 # define S_IFBLK 0x3000 /* Block */
1133 # define S_ISBLK(m) (0)
1134 # define S_ISCHR(m) (0)
1135 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
1136 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
1139 /* several type definitions */
1140 # if defined( __MINGW32__ )
1141 # if !defined( _OFF_T_ )
1142 typedef long long _off_t;
1143 typedef _off_t off_t;
1149 # define off_t long long
1153 # if defined( _MSC_VER ) && !defined( __WXMSW__ )
1154 # if !defined( _OFF_T_DEFINED )
1155 typedef __int64 off_t;
1156 # define _OFF_T_DEFINED
1158 /* for wx compatibility typedef long off_t; */
1159 # define off_t __int64
1163 # if defined( __BORLANDC__ )
1165 # define off_t unsigned __int64
1169 # define O_NONBLOCK 0
1173 # define alloca _alloca
1176 /* These two are not defined in mingw32 (bug?) */
1178 # define snprintf _snprintf
1181 # define vsnprintf _vsnprintf
1187 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1188 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1190 /* vlc_wraptext (defined in src/extras/libc.c) */
1191 #define wraptext vlc_wraptext
1192 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1194 /* iconv wrappers (defined in src/extras/libc.c) */
1195 typedef void *vlc_iconv_t;
1196 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1197 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1198 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1200 /* execve wrapper (defined in src/extras/libc.c) */
1201 VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char **pp_argv, char **pp_env, char *psz_cwd, char *p_in, int i_in, char **pp_data, int *pi_data ) );
1202 #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)
1204 /*****************************************************************************
1206 *****************************************************************************/
1207 #define CPU_CAPABILITY_NONE 0
1208 #define CPU_CAPABILITY_486 (1<<0)
1209 #define CPU_CAPABILITY_586 (1<<1)
1210 #define CPU_CAPABILITY_PPRO (1<<2)
1211 #define CPU_CAPABILITY_MMX (1<<3)
1212 #define CPU_CAPABILITY_3DNOW (1<<4)
1213 #define CPU_CAPABILITY_MMXEXT (1<<5)
1214 #define CPU_CAPABILITY_SSE (1<<6)
1215 #define CPU_CAPABILITY_SSE2 (1<<7)
1216 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1217 #define CPU_CAPABILITY_FPU (1<<31)
1219 /*****************************************************************************
1221 *****************************************************************************/
1222 #if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC)
1223 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1226 #if defined( ENABLE_NLS ) && \
1227 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1228 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1229 defined(MODULE_NAME_IS_pda))
1230 /* Declare nothing: gnome.h will do it for us */
1231 #elif defined( ENABLE_NLS )
1232 # if defined( HAVE_INCLUDED_GETTEXT )
1233 # include "libintl.h"
1235 # include <libintl.h>
1238 # if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC)
1239 # define _(String) vlc_dgettext (PACKAGE_NAME, String)
1241 # define _(String) dgettext(PACKAGE_NAME, String)
1243 # define N_(String) (String)
1245 # define _(String) (String)
1246 # define N_(String) (String)
1249 /*****************************************************************************
1251 *****************************************************************************/
1252 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1253 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1254 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1255 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1256 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1257 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1259 /*****************************************************************************
1260 * Additional vlc stuff
1261 *****************************************************************************/
1262 #ifndef HAVE_SHARED_LIBVLC
1263 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1264 # include "vlc_symbols.h"
1266 # define VLC_Changeset( ) ("exported")
1268 #include "os_specific.h"
1269 #include "vlc_messages.h"
1270 #include "variables.h"
1271 #include "vlc_objects.h"
1272 #include "vlc_threads_funcs.h"
1274 #include "modules.h"
1276 #include "configuration.h"
1278 #if defined( __BORLANDC__ )
1283 #if defined( WIN32 ) || defined( UNDER_CE )
1284 # define DIR_SEP_CHAR '\\'
1285 # define DIR_SEP "\\"
1287 # define DIR_SEP_CHAR '/'
1288 # define DIR_SEP "/"