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__ )
42 # undef HAVE_INTTYPES_H
43 #elif defined( _MSC_VER )
44 # pragma warning( disable : 4244 )
47 #include "vlc_config.h"
49 /*****************************************************************************
50 * Required system headers
51 *****************************************************************************/
58 #ifdef HAVE_SYS_TYPES_H
59 # include <sys/types.h>
62 /*****************************************************************************
63 * Basic types definitions
64 *****************************************************************************/
65 #if defined( HAVE_STDINT_H )
67 #elif defined( HAVE_INTTYPES_H )
68 # include <inttypes.h>
69 #elif defined( SYS_CYGWIN )
70 # include <sys/types.h>
71 /* Cygwin only defines half of these... */
72 typedef u_int8_t uint8_t;
73 typedef u_int16_t uint16_t;
74 typedef u_int32_t uint32_t;
75 typedef u_int64_t uint64_t;
77 /* Fallback types (very x86-centric, sorry) */
78 typedef unsigned char uint8_t;
79 typedef signed char int8_t;
80 typedef unsigned short uint16_t;
81 typedef signed short int16_t;
82 typedef unsigned int uint32_t;
83 typedef signed int int32_t;
84 # if defined( _MSC_VER ) \
85 || defined( UNDER_CE ) \
86 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
87 typedef unsigned __int64 uint64_t;
88 typedef signed __int64 int64_t;
90 typedef unsigned long long uint64_t;
91 typedef signed long long int64_t;
93 typedef uint32_t uintptr_t;
94 typedef int32_t intptr_t;
97 typedef uint8_t byte_t;
99 /* Systems that don't have stdint.h may not define INT64_MIN and
102 #define INT64_MIN (-9223372036854775807LL-1)
105 #define INT64_MAX (9223372036854775807LL)
108 /* ptrdiff_t definition */
115 /* Not portable in a 64-bit environment. */
116 typedef int ptrdiff_t;
120 #if defined( WIN32 ) || defined( UNDER_CE )
123 # define PATH_MAX MAX_PATH
127 /* Counter for statistics and profiling */
128 typedef unsigned long count_t;
130 /* DCT elements types */
131 typedef int16_t dctelem_t;
133 /* Video buffer types */
134 typedef uint8_t yuv_data_t;
137 typedef uint16_t audio_volume_t;
140 * High precision date or time interval
142 * Store a high precision date or time interval. The maximum precision is the
143 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
144 * time interval is then 292271 years, which should be long enough for any
145 * video). Dates are stored as microseconds since a common date (usually the
146 * epoch). Note that date and time intervals can be manipulated using regular
147 * arithmetic operators, and that no special functions are required.
149 typedef int64_t mtime_t;
152 * The vlc_fourcc_t type.
154 * See http://www.webartz.com/fourcc/ for a very detailed list.
156 typedef uint32_t vlc_fourcc_t;
158 #ifdef WORDS_BIGENDIAN
159 # define VLC_FOURCC( a, b, c, d ) \
160 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
161 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
162 # define VLC_TWOCC( a, b ) \
163 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
166 # define VLC_FOURCC( a, b, c, d ) \
167 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
168 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
169 # define VLC_TWOCC( a, b ) \
170 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
174 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
176 #ifdef WORDS_BIGENDIAN
177 psz_fourcc[0] = (uint32_t) (fcc >> 24);
178 psz_fourcc[1] = (uint32_t) (fcc >> 16);
179 psz_fourcc[2] = (uint32_t) (fcc >> 8);
180 psz_fourcc[3] = (uint32_t) (fcc);
182 psz_fourcc[3] = (uint32_t) (fcc >> 24);
183 psz_fourcc[2] = (uint32_t) (fcc >> 16);
184 psz_fourcc[1] = (uint32_t) (fcc >> 8);
185 psz_fourcc[0] = (uint32_t) (fcc);
189 #define vlc_fourcc_to_char( a, b ) \
190 __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
192 /*****************************************************************************
193 * Classes declaration
194 *****************************************************************************/
197 typedef struct libvlc_global_data_t libvlc_global_data_t;
198 typedef struct libvlc_int_t libvlc_int_t;
199 typedef struct variable_t variable_t;
200 typedef struct date_t date_t;
201 typedef struct dict_entry_t dict_entry_t;
202 typedef struct dict_t dict_t;
203 typedef struct gc_object_t gc_object_t ;
206 typedef struct msg_bank_t msg_bank_t;
207 typedef struct msg_queue_t msg_queue_t;
208 typedef struct msg_subscription_t msg_subscription_t;
217 PLAYLIST_PLAY, /**< No arg. res=can fail*/
218 PLAYLIST_AUTOPLAY, /**< No arg. res=cant fail*/
219 PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
220 /** arg2 = playlist_item_t* , res=can fail */
221 PLAYLIST_PAUSE, /**< No arg res=can fail*/
222 PLAYLIST_STOP, /**< No arg res=can fail*/
223 PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
224 } playlist_command_t;
227 typedef struct playlist_t playlist_t;
228 typedef struct playlist_item_t playlist_item_t;
229 typedef struct playlist_view_t playlist_view_t;
230 typedef struct playlist_export_t playlist_export_t;
231 typedef struct services_discovery_t services_discovery_t;
232 typedef struct services_discovery_sys_t services_discovery_sys_t;
233 typedef struct playlist_add_t playlist_add_t;
234 typedef struct playlist_preparse_t playlist_preparse_t;
235 typedef struct playlist_fetcher_t playlist_fetcher_t;
238 typedef struct module_bank_t module_bank_t;
239 typedef struct module_t module_t;
240 typedef struct module_config_t module_config_t;
241 typedef struct module_symbols_t module_symbols_t;
242 typedef struct module_cache_t module_cache_t;
244 typedef struct config_category_t config_category_t;
247 typedef struct intf_thread_t intf_thread_t;
248 typedef struct intf_sys_t intf_sys_t;
249 typedef struct intf_console_t intf_console_t;
250 typedef struct intf_msg_t intf_msg_t;
251 typedef struct interaction_t interaction_t;
252 typedef struct interaction_dialog_t interaction_dialog_t;
253 typedef struct user_widget_t user_widget_t;
256 typedef struct input_thread_t input_thread_t;
257 typedef struct input_thread_sys_t input_thread_sys_t;
258 typedef struct input_item_t input_item_t;
259 typedef struct access_t access_t;
260 typedef struct access_sys_t access_sys_t;
261 typedef struct stream_t stream_t;
262 typedef struct stream_sys_t stream_sys_t;
263 typedef struct demux_t demux_t;
264 typedef struct demux_meta_t demux_meta_t;
265 typedef struct demux_sys_t demux_sys_t;
266 typedef struct es_out_t es_out_t;
267 typedef struct es_out_id_t es_out_id_t;
268 typedef struct es_out_sys_t es_out_sys_t;
269 typedef struct es_descriptor_t es_descriptor_t;
270 typedef struct seekpoint_t seekpoint_t;
271 typedef struct info_t info_t;
272 typedef struct info_category_t info_category_t;
273 typedef struct input_attachment_t input_attachment_t;
276 typedef struct audio_format_t audio_format_t;
277 typedef struct video_format_t video_format_t;
278 typedef struct subs_format_t subs_format_t;
279 typedef struct es_format_t es_format_t;
280 typedef struct video_palette_t video_palette_t;
283 typedef struct aout_instance_t aout_instance_t;
284 typedef struct aout_sys_t aout_sys_t;
285 typedef struct aout_fifo_t aout_fifo_t;
286 typedef struct aout_input_t aout_input_t;
287 typedef struct aout_buffer_t aout_buffer_t;
288 typedef audio_format_t audio_sample_format_t;
289 typedef struct audio_date_t audio_date_t;
290 typedef struct aout_filter_t aout_filter_t;
293 typedef struct vout_thread_t vout_thread_t;
294 typedef struct vout_sys_t vout_sys_t;
295 typedef struct chroma_sys_t chroma_sys_t;
297 typedef video_format_t video_frame_format_t;
298 typedef struct picture_t picture_t;
299 typedef struct picture_sys_t picture_sys_t;
300 typedef struct picture_heap_t picture_heap_t;
303 typedef struct spu_t spu_t;
304 typedef struct subpicture_t subpicture_t;
305 typedef struct subpicture_sys_t subpicture_sys_t;
306 typedef struct subpicture_region_t subpicture_region_t;
307 typedef struct text_style_t text_style_t;
309 typedef struct image_handler_t image_handler_t;
312 typedef struct sout_instance_t sout_instance_t;
313 typedef struct sout_instance_sys_t sout_instance_sys_t;
315 typedef struct sout_input_t sout_input_t;
316 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
318 typedef struct sout_access_out_t sout_access_out_t;
319 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
321 typedef struct sout_mux_t sout_mux_t;
322 typedef struct sout_mux_sys_t sout_mux_sys_t;
324 typedef struct sout_stream_t sout_stream_t;
325 typedef struct sout_stream_sys_t sout_stream_sys_t;
327 typedef struct config_chain_t config_chain_t;
328 typedef struct sap_session_t sap_session_t;
329 typedef struct sap_address_t sap_address_t;
330 typedef struct session_descriptor_t session_descriptor_t;
331 typedef struct announce_method_t announce_method_t;
332 typedef struct announce_handler_t announce_handler_t;
333 typedef struct sap_handler_t sap_handler_t;
335 typedef struct sout_param_t sout_param_t;
336 typedef struct sout_pcat_t sout_pcat_t;
337 typedef struct sout_std_t sout_std_t;
338 typedef struct sout_display_t sout_display_t;
339 typedef struct sout_duplicate_t sout_duplicate_t;
340 typedef struct sout_transcode_t sout_transcode_t;
341 typedef struct sout_chain_t sout_chain_t;
342 typedef struct streaming_profile_t streaming_profile_t;
343 typedef struct sout_module_t sout_module_t;
344 typedef struct sout_gui_descr_t sout_gui_descr_t;
345 typedef struct profile_parser_t profile_parser_t;
348 typedef struct decoder_t decoder_t;
349 typedef struct decoder_sys_t decoder_sys_t;
350 typedef struct decoder_synchro_t decoder_synchro_t;
353 typedef struct encoder_t encoder_t;
354 typedef struct encoder_sys_t encoder_sys_t;
357 typedef struct filter_t filter_t;
358 typedef struct filter_sys_t filter_sys_t;
361 typedef struct network_socket_t network_socket_t;
362 typedef struct virtual_socket_t v_socket_t;
363 typedef struct sockaddr sockaddr;
364 typedef struct addrinfo addrinfo;
365 typedef struct vlc_acl_t vlc_acl_t;
366 typedef struct vlc_url_t vlc_url_t;
369 typedef struct iso639_lang_t iso639_lang_t;
370 typedef struct device_t device_t;
371 typedef struct device_probe_t device_probe_t;
372 typedef struct probe_sys_t probe_sys_t;
375 typedef struct block_t block_t;
376 typedef struct block_fifo_t block_fifo_t;
379 typedef struct httpd_t httpd_t;
380 typedef struct httpd_host_t httpd_host_t;
381 typedef struct httpd_url_t httpd_url_t;
382 typedef struct httpd_client_t httpd_client_t;
383 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
384 typedef struct httpd_message_t httpd_message_t;
385 typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
386 typedef struct httpd_file_t httpd_file_t;
387 typedef struct httpd_file_sys_t httpd_file_sys_t;
388 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
389 typedef struct httpd_handler_t httpd_handler_t;
390 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
391 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 );
392 typedef struct httpd_redirect_t httpd_redirect_t;
393 typedef struct httpd_stream_t httpd_stream_t;
396 typedef struct tls_server_t tls_server_t;
397 typedef struct tls_session_t tls_session_t;
400 typedef struct md5_s md5_t;
403 typedef struct xml_t xml_t;
404 typedef struct xml_sys_t xml_sys_t;
405 typedef struct xml_reader_t xml_reader_t;
406 typedef struct xml_reader_sys_t xml_reader_sys_t;
409 typedef struct vod_t vod_t;
410 typedef struct vod_sys_t vod_sys_t;
411 typedef struct vod_media_t vod_media_t;
414 typedef struct opengl_t opengl_t;
415 typedef struct opengl_sys_t opengl_sys_t;
418 typedef struct osd_menu_t osd_menu_t;
419 typedef struct osd_state_t osd_state_t;
420 typedef struct osd_event_t osd_event_t;
421 typedef struct osd_button_t osd_button_t;
422 typedef struct osd_menu_state_t osd_menu_state_t;
425 typedef struct vlm_t vlm_t;
426 typedef struct vlm_message_t vlm_message_t;
429 typedef struct vlc_meta_t vlc_meta_t;
430 typedef struct meta_export_t meta_export_t;
433 typedef struct counter_t counter_t;
434 typedef struct counter_sample_t counter_sample_t;
435 typedef struct stats_handler_t stats_handler_t;
436 typedef struct input_stats_t input_stats_t;
437 typedef struct global_stats_t global_stats_t;
440 typedef struct update_t update_t;
441 typedef struct update_iterator_t update_iterator_t;
444 typedef struct meta_engine_t meta_engine_t;
446 /* stat/lstat/fstat */
448 #include <sys/stat.h>
450 #define stat _stati64
451 #define fstat _fstati64
452 /* You should otherwise use utf8_stat and utf8_lstat. */
457 /*****************************************************************************
459 *****************************************************************************/
460 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
461 char const *, /* variable name */
462 vlc_value_t, /* old value */
463 vlc_value_t, /* new value */
464 void * ); /* callback data */
466 /*****************************************************************************
468 *****************************************************************************/
470 #include "vlc_modules_macros.h"
472 #if defined (WIN32) && defined (DLL_EXPORT)
474 # define VLC_PUBLIC_API __declspec(dllexport)
475 # define VLC_PRIVATE_API __declspec(dllexport)
476 # define VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
477 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
479 # define VLC_PUBLIC_API extern __declspec(dllexport)
480 # define VLC_PRIVATE_API extern __declspec(dllexport)
481 # define VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
482 # define VLC_INTERNAL( type, name, args ) type name args
486 # if HAVE_ATTRIBUTE_VISIBILITY
487 # define VLC_PUBLIC_API __attribute__((visibility("default")))
488 # define VLC_PRIVATE_API __attribute__((visibility("default")))
489 # define VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
490 # define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
492 # define VLC_PUBLIC_API
493 # define VLC_EXPORT( type, name, args ) extern "C" type name args
494 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
497 # if HAVE_ATTRIBUTE_VISIBILITY
498 # define VLC_PUBLIC_API extern __attribute__((visibility("default")))
499 # define VLC_PRIVATE_API extern __attribute__((visibility("default")))
500 # define VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
501 # define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
503 # define VLC_PUBLIC_API extern
504 # define VLC_PRIVATE_API extern
505 # define VLC_EXPORT( type, name, args ) type name args
506 # define VLC_INTERNAL( type, name, args ) type name args
511 /*****************************************************************************
512 * OS-specific headers and thread types
513 *****************************************************************************/
514 #if defined( WIN32 ) || defined( UNDER_CE )
515 # define WIN32_LEAN_AND_MEAN
516 # include <windows.h>
517 # if defined( UNDER_CE )
520 # define IS_WINNT ( GetVersion() < 0x80000000 )
524 #include "vlc_threads.h"
526 typedef struct vlc_object_internals_t vlc_object_internals_t;
528 /*****************************************************************************
529 * Common structure members
530 *****************************************************************************/
532 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
533 #define VLC_COMMON_MEMBERS \
534 /** \name VLC_COMMON_MEMBERS \
535 * these members are common for all vlc objects \
538 vlc_object_internals_t *p_internals; \
541 const char *psz_object_type; \
542 const char *psz_object_name; \
544 /* Messages header */ \
548 /* Object access lock */ \
549 vlc_mutex_t object_lock; \
550 vlc_cond_t object_wait; \
552 /* Object properties */ \
553 volatile vlc_bool_t b_error; /**< set by the object */ \
554 volatile vlc_bool_t b_die; /**< set by the outside */ \
555 volatile vlc_bool_t b_dead; /**< set by the object */ \
556 vlc_bool_t b_force; /**< set by the outside (eg. module_Need()) */ \
558 /* Stuff related to the libvlc structure */ \
559 libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
561 vlc_object_t * p_parent; /**< our parent */ \
562 vlc_object_t ** pp_children; /**< our children */ \
563 volatile int i_children; \
568 /** Just a reminder so that people don't cast garbage */ \
569 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
572 /* VLC_OBJECT: attempt at doing a clever cast */
573 #define VLC_OBJECT( x ) \
574 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
576 #define VLC_GC_MEMBERS \
577 /** \name VLC_GC_MEMBERS \
578 * these members are common to all objects that wish to be garbage-collected \
582 void (*pf_destructor) ( gc_object_t * ); \
583 void *p_destructor_arg; \
591 #include <assert.h> /* FIXME: should not be included here */
593 static inline void __vlc_gc_incref( gc_object_t * p_gc )
595 assert( p_gc->i_gc_refcount > 0 );
597 p_gc->i_gc_refcount ++;
600 static inline void __vlc_gc_decref( gc_object_t *p_gc )
604 assert( p_gc->i_gc_refcount > 0 );
606 p_gc->i_gc_refcount -- ;
608 if( p_gc->i_gc_refcount == 0 )
610 p_gc->pf_destructor( p_gc );
611 /* Do not use the p_gc pointer from now on ! */
616 __vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
619 p_gc->i_gc_refcount = 1;
620 p_gc->pf_destructor = pf_destructor;
621 p_gc->p_destructor_arg = arg;
624 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
625 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
626 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
629 /*****************************************************************************
630 * Macros and inline functions
631 *****************************************************************************/
632 #ifdef NTOHL_IN_SYS_PARAM_H
633 # include <sys/param.h>
635 #elif !defined(WIN32) && !defined( UNDER_CE )
636 # include <netinet/in.h>
638 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
640 /* CEIL: division with round to nearest greater integer */
641 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
643 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
644 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
646 /* __MAX and __MIN: self explanatory */
648 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
651 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
654 static inline int64_t GCD( int64_t a, int64_t b )
665 /* function imported from libavutil/common.h */
666 static inline uint8_t clip_uint8_vlc( int32_t a )
668 if( a&(~255) ) return (-a)>>31;
672 /* Malloc with automatic error */
673 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
674 if( !var ) return; } while(0)
675 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
676 if( !var ) return NULL; } while(0)
677 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
678 if( !var ) return VLC_ENOMEM; } while(0)
679 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
680 if( !var ) goto error; } while(0)
681 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
683 #define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
684 if( !var ) return VLC_ENOMEM;
685 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
686 if( !var ) return NULL;
688 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
690 #define EMPTY_STR(str) (!str || !*str)
692 VLC_EXPORT( char const *, vlc_error, ( int ) );
694 #include <vlc_arrays.h>
696 /* MSB (big endian)/LSB (little endian) conversions - network order is always
697 * MSB, and should be used for both network communications and files. Note that
698 * byte orders other than little and big endians are not supported, but only
699 * the VAX seems to have such exotic properties. */
700 static inline uint16_t U16_AT( const void * _p )
702 const uint8_t * p = (const uint8_t *)_p;
703 return ( ((uint16_t)p[0] << 8) | p[1] );
705 static inline uint32_t U32_AT( const void * _p )
707 const uint8_t * p = (const uint8_t *)_p;
708 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
709 | ((uint32_t)p[2] << 8) | p[3] );
711 static inline uint64_t U64_AT( const void * _p )
713 const uint8_t * p = (const uint8_t *)_p;
714 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
715 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
716 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
717 | ((uint64_t)p[6] << 8) | p[7] );
720 static inline uint16_t GetWLE( const void * _p )
722 const uint8_t * p = (const uint8_t *)_p;
723 return ( ((uint16_t)p[1] << 8) | p[0] );
725 static inline uint32_t GetDWLE( const void * _p )
727 const uint8_t * p = (const uint8_t *)_p;
728 return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
729 | ((uint32_t)p[1] << 8) | p[0] );
731 static inline uint64_t GetQWLE( const void * _p )
733 const uint8_t * p = (const uint8_t *)_p;
734 return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
735 | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
736 | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
737 | ((uint64_t)p[1] << 8) | p[0] );
740 #define GetWBE( p ) U16_AT( p )
741 #define GetDWBE( p ) U32_AT( p )
742 #define GetQWBE( p ) U64_AT( p )
744 /* Helper writer functions */
745 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
746 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
748 p[1] = ( i_dw >> 8 )&0xff;
749 p[0] = ( i_dw )&0xff;
752 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
753 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
755 p[3] = ( i_dw >> 24 )&0xff;
756 p[2] = ( i_dw >> 16 )&0xff;
757 p[1] = ( i_dw >> 8 )&0xff;
758 p[0] = ( i_dw )&0xff;
760 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
761 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
763 SetDWLE( p, i_qw&0xffffffff );
764 SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
766 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
767 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
769 p[0] = ( i_dw >> 8 )&0xff;
770 p[1] = ( i_dw )&0xff;
773 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
774 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
776 p[0] = ( i_dw >> 24 )&0xff;
777 p[1] = ( i_dw >> 16 )&0xff;
778 p[2] = ( i_dw >> 8 )&0xff;
779 p[3] = ( i_dw )&0xff;
781 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
782 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
784 SetDWBE( p+4, i_qw&0xffffffff );
785 SetDWBE( p, ( i_qw >> 32)&0xffffffff );
788 #ifdef WORDS_BIGENDIAN
789 # define hton16(i) ( i )
790 # define hton32(i) ( i )
791 # define hton64(i) ( i )
792 # define ntoh16(i) ( i )
793 # define ntoh32(i) ( i )
794 # define ntoh64(i) ( i )
796 # define hton16(i) U16_AT(&i)
797 # define hton32(i) U32_AT(&i)
798 # define hton64(i) U64_AT(&i)
799 # define ntoh16(i) U16_AT(&i)
800 # define ntoh32(i) U32_AT(&i)
801 # define ntoh64(i) U64_AT(&i)
804 /* Format string sanity checks */
805 #ifdef HAVE_ATTRIBUTE_FORMAT
806 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
808 # define ATTRIBUTE_FORMAT(x,y)
811 /* Alignment of critical static data structures */
812 #ifdef ATTRIBUTE_ALIGNED_MAX
813 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
815 # define ATTR_ALIGN(align)
819 #define VLC_UNUSED(x) (void)(x)
821 /* Stuff defined in src/extras/libc.c */
823 # define strdup vlc_strdup
824 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
825 #elif !defined(__PLUGIN__)
826 # define vlc_strdup NULL
829 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
830 # define vasprintf vlc_vasprintf
831 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
832 #elif !defined(__PLUGIN__)
833 # define vlc_vasprintf NULL
836 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
837 # define asprintf vlc_asprintf
838 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
839 #elif !defined(__PLUGIN__)
840 # define vlc_asprintf NULL
844 # if defined(STRNDUP_IN_GNOME_H) && \
845 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
846 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
847 /* Do nothing: gnome.h defines strndup for us */
849 # define strndup vlc_strndup
850 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
852 #elif !defined(__PLUGIN__)
853 # define vlc_strndup NULL
857 # define strnlen vlc_strnlen
858 VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
859 #elif !defined(__PLUGIN__)
860 # define vlc_strnlen NULL
864 # define strlcpy vlc_strlcpy
865 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
866 #elif !defined(__PLUGIN__)
867 # define vlc_strlcpy NULL
871 # define atof vlc_atof
872 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
873 #elif !defined(__PLUGIN__)
874 # define vlc_atof NULL
879 # define strtof strtod
884 # define atoll vlc_atoll
885 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
886 #elif !defined(__PLUGIN__)
887 # define vlc_atoll NULL
891 # define strtoll vlc_strtoll
892 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
893 #elif !defined(__PLUGIN__)
894 # define vlc_strtoll NULL
897 #if defined(SYS_BEOS) \
898 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
900 long long quot; /* Quotient. */
901 long long rem; /* Remainder. */
903 # define lldiv vlc_lldiv
904 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
905 #elif !defined(__PLUGIN__)
906 # define vlc_lldiv NULL
910 # define scandir vlc_scandir
911 # define alphasort vlc_alphasort
913 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
914 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
915 #elif !defined(__PLUGIN__)
916 # define vlc_scandir NULL
917 # define vlc_alphasort NULL
921 # define getenv vlc_getenv
922 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
923 #elif !defined(__PLUGIN__)
924 # define vlc_getenv NULL
927 #ifndef HAVE_STRCASECMP
928 # ifndef HAVE_STRICMP
929 # define strcasecmp vlc_strcasecmp
930 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
932 # define strcasecmp stricmp
933 # if !defined(__PLUGIN__)
934 # define vlc_strcasecmp NULL
937 #elif !defined(__PLUGIN__)
938 # define vlc_strcasecmp NULL
941 #ifndef HAVE_STRNCASECMP
942 # ifndef HAVE_STRNICMP
943 # define strncasecmp vlc_strncasecmp
944 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
946 # define strncasecmp strnicmp
947 # if !defined(__PLUGIN__)
948 # define vlc_strncasecmp NULL
951 #elif !defined(__PLUGIN__)
952 # define vlc_strncasecmp NULL
955 #ifndef HAVE_STRCASESTR
956 # ifndef HAVE_STRISTR
957 # define strcasestr vlc_strcasestr
958 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
960 # define strcasestr stristr
961 # if !defined(__PLUGIN__)
962 # define vlc_strcasestr NULL
965 #elif !defined(__PLUGIN__)
966 # define vlc_strcasestr NULL
969 #ifndef HAVE_DIRENT_H
971 # ifndef FILENAME_MAX
972 # define FILENAME_MAX (260)
976 long d_ino; /* Always zero. */
977 unsigned short d_reclen; /* Always zero. */
978 unsigned short d_namlen; /* Length of name in d_name. */
979 char d_name[FILENAME_MAX]; /* File name. */
981 # define opendir vlc_opendir
982 # define readdir vlc_readdir
983 # define closedir vlc_closedir
984 # define rewinddir vlc_rewindir
985 # define seekdir vlc_seekdir
986 # define telldir vlc_telldir
987 VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
988 VLC_EXPORT( void *, vlc_readdir, ( void * ) );
989 VLC_EXPORT( int, vlc_closedir, ( void * ) );
990 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
991 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
992 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
994 # if !defined(__PLUGIN__)
995 # define vlc_opendir NULL
996 # define vlc_readdir NULL
997 # define vlc_closedir NULL
1002 # include <dirent.h>
1003 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
1004 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
1005 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
1006 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1007 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1008 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1009 # define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
1010 # define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
1011 # define closedir vlc_wclosedir
1012 # define _wopendir vlc_wopendir
1013 # define _wreaddir vlc_wreaddir
1014 # define _wclosedir vlc_wclosedir
1015 # define rewinddir vlc_rewinddir
1016 # define seekdir vlc_seekdir
1017 # define telldir vlc_telldir
1018 #elif !defined(__PLUGIN__)
1019 # define vlc_wclosedir NULL
1022 /* Format type specifiers for 64 bits numbers */
1023 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1024 # if defined(__WORDSIZE) && __WORDSIZE == 64
1025 # define I64Fd "%ld"
1026 # define I64Fi "%li"
1027 # define I64Fo "%lo"
1028 # define I64Fu "%lu"
1029 # define I64Fx "%lx"
1030 # define I64FX "%lX"
1032 # define I64Fd "%lld"
1033 # define I64Fi "%lli"
1034 # define I64Fo "%llo"
1035 # define I64Fu "%llu"
1036 # define I64Fx "%llx"
1037 # define I64FX "%llX"
1040 # define I64Fd "%I64d"
1041 # define I64Fi "%I64i"
1042 # define I64Fo "%I64o"
1043 # define I64Fu "%I64u"
1044 # define I64Fx "%I64x"
1045 # define I64FX "%I64X"
1046 #endif /* defined(WIN32)||defined(UNDER_CE) */
1048 /* 64 bits integer constant suffix */
1049 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1050 # if defined(__WORDSIZE) && __WORDSIZE == 64
1051 # define I64C(x) x##L
1052 # define UI64C(x) x##UL
1054 # define I64C(x) x##LL
1055 # define UI64C(x) x##ULL
1058 # define I64C(x) x##i64
1059 # define UI64C(x) x##ui64
1060 #endif /* defined(WIN32)||defined(UNDER_CE) */
1062 #if defined(WIN32) || defined(UNDER_CE)
1063 /* win32, cl and icl support */
1064 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
1065 # define __attribute__(x)
1066 # define __inline__ __inline
1067 # define S_IFBLK 0x3000 /* Block */
1068 # define S_ISBLK(m) (0)
1069 # define S_ISCHR(m) (0)
1070 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
1071 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
1074 /* several type definitions */
1075 # if defined( __MINGW32__ )
1076 # if !defined( _OFF_T_ )
1077 typedef long long _off_t;
1078 typedef _off_t off_t;
1084 # define off_t long long
1088 # if defined( _MSC_VER ) && !defined( __WXMSW__ )
1089 # if !defined( _OFF_T_DEFINED )
1090 typedef __int64 off_t;
1091 # define _OFF_T_DEFINED
1093 /* for wx compatibility typedef long off_t; */
1094 # define off_t __int64
1098 # if defined( __BORLANDC__ )
1100 # define off_t unsigned __int64
1104 # define O_NONBLOCK 0
1108 # define alloca _alloca
1111 /* These two are not defined in mingw32 (bug?) */
1113 # define snprintf _snprintf
1116 # define vsnprintf _vsnprintf
1122 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1123 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1125 /* vlc_wraptext (defined in src/extras/libc.c) */
1126 #define wraptext vlc_wraptext
1127 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1129 /* iconv wrappers (defined in src/extras/libc.c) */
1130 typedef void *vlc_iconv_t;
1131 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1132 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1133 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1135 /* execve wrapper (defined in src/extras/libc.c) */
1136 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 ) );
1137 #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)
1139 /*****************************************************************************
1141 *****************************************************************************/
1142 #define CPU_CAPABILITY_NONE 0
1143 #define CPU_CAPABILITY_486 (1<<0)
1144 #define CPU_CAPABILITY_586 (1<<1)
1145 #define CPU_CAPABILITY_PPRO (1<<2)
1146 #define CPU_CAPABILITY_MMX (1<<3)
1147 #define CPU_CAPABILITY_3DNOW (1<<4)
1148 #define CPU_CAPABILITY_MMXEXT (1<<5)
1149 #define CPU_CAPABILITY_SSE (1<<6)
1150 #define CPU_CAPABILITY_SSE2 (1<<7)
1151 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1152 #define CPU_CAPABILITY_FPU (1<<31)
1153 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1155 /*****************************************************************************
1157 *****************************************************************************/
1159 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1162 #if defined( ENABLE_NLS ) && \
1163 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1164 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1165 defined(MODULE_NAME_IS_pda))
1166 /* Declare nothing: gnome.h will do it for us */
1167 #elif defined( ENABLE_NLS )
1168 # if defined( HAVE_INCLUDED_GETTEXT )
1169 # include "libintl.h"
1171 # include <libintl.h>
1175 # define _(String) vlc_dgettext (PACKAGE_NAME, String)
1177 # define _(String) dgettext(PACKAGE_NAME, String)
1179 # define N_(String) (String)
1181 # define _(String) (String)
1182 # define N_(String) (String)
1185 /*****************************************************************************
1187 *****************************************************************************/
1188 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1189 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1190 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1191 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1192 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1193 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1194 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1196 /*****************************************************************************
1197 * Additional vlc stuff
1198 *****************************************************************************/
1199 #include "vlc_os_specific.h"
1200 #include "vlc_messages.h"
1201 #include "vlc_variables.h"
1202 #include "vlc_objects.h"
1203 #include "vlc_mtime.h"
1204 #include "vlc_threads_funcs.h"
1205 #include "vlc_modules.h"
1207 #include "vlc_configuration.h"
1209 /** The global thread var for msg stack context
1210 * We store this as a static global variable so we don't need a vlc_object_t
1212 * This key is created in vlc_threads_init and is therefore ready to use at
1213 * the very beginning of the universe */
1214 extern vlc_threadvar_t msg_context_global_key;
1217 #if defined( WIN32 ) || defined( UNDER_CE )
1218 # define DIR_SEP_CHAR '\\'
1219 # define DIR_SEP "\\"
1221 # define DIR_SEP_CHAR '/'
1222 # define DIR_SEP "/"