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( _MSC_VER )
41 # pragma warning( disable : 4244 )
44 #include "vlc_config.h"
46 /*****************************************************************************
47 * Required system headers
48 *****************************************************************************/
55 #ifdef HAVE_SYS_TYPES_H
56 # include <sys/types.h>
59 /*****************************************************************************
60 * Basic types definitions
61 *****************************************************************************/
62 #if defined( HAVE_STDINT_H )
64 #elif defined( HAVE_INTTYPES_H )
65 # include <inttypes.h>
66 #elif defined( SYS_CYGWIN )
67 # include <sys/types.h>
68 /* Cygwin only defines half of these... */
69 typedef u_int8_t uint8_t;
70 typedef u_int16_t uint16_t;
71 typedef u_int32_t uint32_t;
72 typedef u_int64_t uint64_t;
74 /* Fallback types (very x86-centric, sorry) */
75 typedef unsigned char uint8_t;
76 typedef signed char int8_t;
77 typedef unsigned short uint16_t;
78 typedef signed short int16_t;
79 typedef unsigned int uint32_t;
80 typedef signed int int32_t;
81 # if defined( _MSC_VER ) \
82 || defined( UNDER_CE ) \
83 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
84 typedef unsigned __int64 uint64_t;
85 typedef signed __int64 int64_t;
87 typedef unsigned long long uint64_t;
88 typedef signed long long int64_t;
90 typedef uint32_t uintptr_t;
91 typedef int32_t intptr_t;
94 typedef uint8_t byte_t;
96 /* Systems that don't have stdint.h may not define INT64_MIN and
99 #define INT64_MIN (-9223372036854775807LL-1)
102 #define INT64_MAX (9223372036854775807LL)
105 #if defined( WIN32 ) || defined( UNDER_CE )
108 # define PATH_MAX MAX_PATH
112 /* Counter for statistics and profiling */
113 typedef unsigned long count_t;
115 /* DCT elements types */
116 typedef int16_t dctelem_t;
118 /* Video buffer types */
119 typedef uint8_t yuv_data_t;
122 typedef uint16_t audio_volume_t;
125 * High precision date or time interval
127 * Store a high precision date or time interval. The maximum precision is the
128 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
129 * time interval is then 292271 years, which should be long enough for any
130 * video). Dates are stored as microseconds since a common date (usually the
131 * epoch). Note that date and time intervals can be manipulated using regular
132 * arithmetic operators, and that no special functions are required.
134 typedef int64_t mtime_t;
137 * The vlc_fourcc_t type.
139 * See http://www.webartz.com/fourcc/ for a very detailed list.
141 typedef uint32_t vlc_fourcc_t;
143 #ifdef WORDS_BIGENDIAN
144 # define VLC_FOURCC( a, b, c, d ) \
145 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
146 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
147 # define VLC_TWOCC( a, b ) \
148 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
151 # define VLC_FOURCC( a, b, c, d ) \
152 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
153 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
154 # define VLC_TWOCC( a, b ) \
155 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
159 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
161 #ifdef WORDS_BIGENDIAN
162 psz_fourcc[0] = (uint32_t) (fcc >> 24);
163 psz_fourcc[1] = (uint32_t) (fcc >> 16);
164 psz_fourcc[2] = (uint32_t) (fcc >> 8);
165 psz_fourcc[3] = (uint32_t) (fcc);
167 psz_fourcc[3] = (uint32_t) (fcc >> 24);
168 psz_fourcc[2] = (uint32_t) (fcc >> 16);
169 psz_fourcc[1] = (uint32_t) (fcc >> 8);
170 psz_fourcc[0] = (uint32_t) (fcc);
174 #define vlc_fourcc_to_char( a, b ) \
175 __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
177 /*****************************************************************************
178 * Classes declaration
179 *****************************************************************************/
182 typedef struct libvlc_global_data_t libvlc_global_data_t;
183 typedef struct libvlc_int_t libvlc_int_t;
184 typedef struct variable_t variable_t;
185 typedef struct date_t date_t;
186 typedef struct dict_entry_t dict_entry_t;
187 typedef struct dict_t dict_t;
188 typedef struct gc_object_t gc_object_t ;
191 typedef struct msg_bank_t msg_bank_t;
192 typedef struct msg_queue_t msg_queue_t;
193 typedef struct msg_subscription_t msg_subscription_t;
202 PLAYLIST_PLAY, /**< No arg. res=can fail*/
203 PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
204 /** arg2 = playlist_item_t* , res=can fail */
205 PLAYLIST_PAUSE, /**< No arg res=can fail*/
206 PLAYLIST_STOP, /**< No arg res=can fail*/
207 PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
208 } playlist_command_t;
211 typedef struct playlist_t playlist_t;
212 typedef struct playlist_item_t playlist_item_t;
213 typedef struct playlist_view_t playlist_view_t;
214 typedef struct playlist_export_t playlist_export_t;
215 typedef struct services_discovery_t services_discovery_t;
216 typedef struct services_discovery_sys_t services_discovery_sys_t;
217 typedef struct playlist_add_t playlist_add_t;
218 typedef struct playlist_preparse_t playlist_preparse_t;
219 typedef struct playlist_fetcher_t playlist_fetcher_t;
222 typedef struct module_bank_t module_bank_t;
223 typedef struct module_t module_t;
224 typedef struct module_config_t module_config_t;
225 typedef struct module_symbols_t module_symbols_t;
226 typedef struct module_cache_t module_cache_t;
228 typedef struct config_category_t config_category_t;
231 typedef struct intf_thread_t intf_thread_t;
232 typedef struct intf_sys_t intf_sys_t;
233 typedef struct intf_console_t intf_console_t;
234 typedef struct intf_msg_t intf_msg_t;
235 typedef struct interaction_t interaction_t;
236 typedef struct interaction_dialog_t interaction_dialog_t;
237 typedef struct user_widget_t user_widget_t;
240 typedef struct input_thread_t input_thread_t;
241 typedef struct input_thread_sys_t input_thread_sys_t;
242 typedef struct input_item_t input_item_t;
243 typedef struct access_t access_t;
244 typedef struct access_sys_t access_sys_t;
245 typedef struct stream_t stream_t;
246 typedef struct stream_sys_t stream_sys_t;
247 typedef struct demux_t demux_t;
248 typedef struct demux_meta_t demux_meta_t;
249 typedef struct demux_sys_t demux_sys_t;
250 typedef struct es_out_t es_out_t;
251 typedef struct es_out_id_t es_out_id_t;
252 typedef struct es_out_sys_t es_out_sys_t;
253 typedef struct es_descriptor_t es_descriptor_t;
254 typedef struct seekpoint_t seekpoint_t;
255 typedef struct info_t info_t;
256 typedef struct info_category_t info_category_t;
257 typedef struct input_attachment_t input_attachment_t;
260 typedef struct audio_format_t audio_format_t;
261 typedef struct video_format_t video_format_t;
262 typedef struct subs_format_t subs_format_t;
263 typedef struct es_format_t es_format_t;
264 typedef struct video_palette_t video_palette_t;
267 typedef struct aout_instance_t aout_instance_t;
268 typedef struct aout_sys_t aout_sys_t;
269 typedef struct aout_fifo_t aout_fifo_t;
270 typedef struct aout_input_t aout_input_t;
271 typedef struct aout_buffer_t aout_buffer_t;
272 typedef audio_format_t audio_sample_format_t;
273 typedef struct audio_date_t audio_date_t;
274 typedef struct aout_filter_t aout_filter_t;
277 typedef struct vout_thread_t vout_thread_t;
278 typedef struct vout_sys_t vout_sys_t;
279 typedef struct chroma_sys_t chroma_sys_t;
281 typedef video_format_t video_frame_format_t;
282 typedef struct picture_t picture_t;
283 typedef struct picture_sys_t picture_sys_t;
284 typedef struct picture_heap_t picture_heap_t;
287 typedef struct spu_t spu_t;
288 typedef struct subpicture_t subpicture_t;
289 typedef struct subpicture_sys_t subpicture_sys_t;
290 typedef struct subpicture_region_t subpicture_region_t;
291 typedef struct text_style_t text_style_t;
293 typedef struct image_handler_t image_handler_t;
296 typedef struct sout_instance_t sout_instance_t;
297 typedef struct sout_instance_sys_t sout_instance_sys_t;
299 typedef struct sout_input_t sout_input_t;
300 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
302 typedef struct sout_access_out_t sout_access_out_t;
303 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
305 typedef struct sout_mux_t sout_mux_t;
306 typedef struct sout_mux_sys_t sout_mux_sys_t;
308 typedef struct sout_stream_t sout_stream_t;
309 typedef struct sout_stream_sys_t sout_stream_sys_t;
311 typedef struct config_chain_t config_chain_t;
312 typedef struct sap_session_t sap_session_t;
313 typedef struct sap_address_t sap_address_t;
314 typedef struct session_descriptor_t session_descriptor_t;
315 typedef struct announce_method_t announce_method_t;
316 typedef struct announce_handler_t announce_handler_t;
317 typedef struct sap_handler_t sap_handler_t;
319 typedef struct sout_param_t sout_param_t;
320 typedef struct sout_pcat_t sout_pcat_t;
321 typedef struct sout_std_t sout_std_t;
322 typedef struct sout_display_t sout_display_t;
323 typedef struct sout_duplicate_t sout_duplicate_t;
324 typedef struct sout_transcode_t sout_transcode_t;
325 typedef struct sout_chain_t sout_chain_t;
326 typedef struct streaming_profile_t streaming_profile_t;
327 typedef struct sout_module_t sout_module_t;
328 typedef struct sout_gui_descr_t sout_gui_descr_t;
329 typedef struct profile_parser_t profile_parser_t;
332 typedef struct decoder_t decoder_t;
333 typedef struct decoder_sys_t decoder_sys_t;
334 typedef struct decoder_synchro_t decoder_synchro_t;
337 typedef struct encoder_t encoder_t;
338 typedef struct encoder_sys_t encoder_sys_t;
341 typedef struct filter_t filter_t;
342 typedef struct filter_sys_t filter_sys_t;
345 typedef struct network_socket_t network_socket_t;
346 typedef struct virtual_socket_t v_socket_t;
347 typedef struct sockaddr sockaddr;
348 typedef struct addrinfo addrinfo;
349 typedef struct vlc_acl_t vlc_acl_t;
350 typedef struct vlc_url_t vlc_url_t;
353 typedef struct iso639_lang_t iso639_lang_t;
354 typedef struct device_t device_t;
355 typedef struct device_probe_t device_probe_t;
356 typedef struct probe_sys_t probe_sys_t;
359 typedef struct block_t block_t;
360 typedef struct block_fifo_t block_fifo_t;
363 typedef struct httpd_t httpd_t;
364 typedef struct httpd_host_t httpd_host_t;
365 typedef struct httpd_url_t httpd_url_t;
366 typedef struct httpd_client_t httpd_client_t;
367 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
368 typedef struct httpd_message_t httpd_message_t;
369 typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
370 typedef struct httpd_file_t httpd_file_t;
371 typedef struct httpd_file_sys_t httpd_file_sys_t;
372 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
373 typedef struct httpd_handler_t httpd_handler_t;
374 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
375 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 );
376 typedef struct httpd_redirect_t httpd_redirect_t;
377 typedef struct httpd_stream_t httpd_stream_t;
380 typedef struct tls_server_t tls_server_t;
381 typedef struct tls_session_t tls_session_t;
384 typedef struct md5_s md5_t;
387 typedef struct xml_t xml_t;
388 typedef struct xml_sys_t xml_sys_t;
389 typedef struct xml_reader_t xml_reader_t;
390 typedef struct xml_reader_sys_t xml_reader_sys_t;
393 typedef struct vod_t vod_t;
394 typedef struct vod_sys_t vod_sys_t;
395 typedef struct vod_media_t vod_media_t;
398 typedef struct opengl_t opengl_t;
399 typedef struct opengl_sys_t opengl_sys_t;
402 typedef struct osd_menu_t osd_menu_t;
403 typedef struct osd_state_t osd_state_t;
404 typedef struct osd_event_t osd_event_t;
405 typedef struct osd_button_t osd_button_t;
406 typedef struct osd_menu_state_t osd_menu_state_t;
409 typedef struct vlm_t vlm_t;
410 typedef struct vlm_message_t vlm_message_t;
413 typedef struct vlc_meta_t vlc_meta_t;
414 typedef struct meta_export_t meta_export_t;
417 typedef struct counter_t counter_t;
418 typedef struct counter_sample_t counter_sample_t;
419 typedef struct stats_handler_t stats_handler_t;
420 typedef struct input_stats_t input_stats_t;
421 typedef struct global_stats_t global_stats_t;
424 typedef struct update_t update_t;
425 typedef struct update_iterator_t update_iterator_t;
428 typedef struct meta_engine_t meta_engine_t;
430 /* stat/lstat/fstat */
432 #include <sys/stat.h>
434 #define stat _stati64
435 #define fstat _fstati64
436 /* You should otherwise use utf8_stat and utf8_lstat. */
441 /*****************************************************************************
443 *****************************************************************************/
444 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
445 char const *, /* variable name */
446 vlc_value_t, /* old value */
447 vlc_value_t, /* new value */
448 void * ); /* callback data */
450 /*****************************************************************************
452 *****************************************************************************/
454 #include "vlc_modules_macros.h"
456 #if defined (WIN32) && defined (DLL_EXPORT)
458 # define VLC_PUBLIC_API __declspec(dllexport)
459 # define VLC_PRIVATE_API __declspec(dllexport)
460 # define VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
461 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
463 # define VLC_PUBLIC_API extern __declspec(dllexport)
464 # define VLC_PRIVATE_API extern __declspec(dllexport)
465 # define VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
466 # define VLC_INTERNAL( type, name, args ) type name args
470 # ifdef HAVE_ATTRIBUTE_VISIBILITY
471 # define VLC_PUBLIC_API __attribute__((visibility("default")))
472 # define VLC_PRIVATE_API __attribute__((visibility("default")))
473 # define VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
474 # define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
476 # define VLC_PUBLIC_API
477 # define VLC_EXPORT( type, name, args ) extern "C" type name args
478 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
481 # ifdef HAVE_ATTRIBUTE_VISIBILITY
482 # define VLC_PUBLIC_API extern __attribute__((visibility("default")))
483 # define VLC_PRIVATE_API extern __attribute__((visibility("default")))
484 # define VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
485 # define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
487 # define VLC_PUBLIC_API extern
488 # define VLC_PRIVATE_API extern
489 # define VLC_EXPORT( type, name, args ) extern type name args
490 # define VLC_INTERNAL( type, name, args ) type name args
495 /*****************************************************************************
496 * OS-specific headers and thread types
497 *****************************************************************************/
498 #if defined( WIN32 ) || defined( UNDER_CE )
499 # define WIN32_LEAN_AND_MEAN
500 # include <windows.h>
501 # if defined( UNDER_CE )
504 # define IS_WINNT ( GetVersion() < 0x80000000 )
508 #include "vlc_threads.h"
510 typedef struct vlc_object_internals_t vlc_object_internals_t;
512 /*****************************************************************************
513 * Common structure members
514 *****************************************************************************/
516 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
517 #define VLC_COMMON_MEMBERS \
518 /** \name VLC_COMMON_MEMBERS \
519 * these members are common for all vlc objects \
522 vlc_object_internals_t *p_internals; \
525 const char *psz_object_type; \
526 const char *psz_object_name; \
528 /* Messages header */ \
532 /* Object access lock */ \
533 vlc_mutex_t object_lock; \
534 vlc_cond_t object_wait; \
536 /* Object properties */ \
537 volatile vlc_bool_t b_error; /**< set by the object */ \
538 volatile vlc_bool_t b_die; /**< set by the outside */ \
539 volatile vlc_bool_t b_dead; /**< set by the object */ \
540 vlc_bool_t b_force; /**< set by the outside (eg. module_Need()) */ \
542 /* Stuff related to the libvlc structure */ \
543 libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
545 vlc_object_t * p_parent; /**< our parent */ \
546 vlc_object_t ** pp_children; /**< our children */ \
547 volatile int i_children; \
552 /** Just a reminder so that people don't cast garbage */ \
553 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
556 /* VLC_OBJECT: attempt at doing a clever cast */
557 #define VLC_OBJECT( x ) \
558 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
560 #define VLC_GC_MEMBERS \
561 /** \name VLC_GC_MEMBERS \
562 * these members are common to all objects that wish to be garbage-collected \
566 void (*pf_destructor) ( gc_object_t * ); \
567 void *p_destructor_arg; \
575 #include <assert.h> /* FIXME: should not be included here */
577 static inline void __vlc_gc_incref( gc_object_t * p_gc )
579 assert( p_gc->i_gc_refcount > 0 );
581 p_gc->i_gc_refcount ++;
584 static inline void __vlc_gc_decref( gc_object_t *p_gc )
588 assert( p_gc->i_gc_refcount > 0 );
590 p_gc->i_gc_refcount -- ;
592 if( p_gc->i_gc_refcount == 0 )
594 p_gc->pf_destructor( p_gc );
595 /* Do not use the p_gc pointer from now on ! */
600 __vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
603 p_gc->i_gc_refcount = 1;
604 p_gc->pf_destructor = pf_destructor;
605 p_gc->p_destructor_arg = arg;
608 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
609 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
610 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
613 /*****************************************************************************
614 * Macros and inline functions
615 *****************************************************************************/
616 #ifdef NTOHL_IN_SYS_PARAM_H
617 # include <sys/param.h>
619 #elif !defined(WIN32) && !defined( UNDER_CE )
620 # include <netinet/in.h>
622 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
624 /* CEIL: division with round to nearest greater integer */
625 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
627 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
628 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
630 /* __MAX and __MIN: self explanatory */
632 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
635 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
638 static inline int64_t GCD( int64_t a, int64_t b )
649 /* function imported from libavutil/common.h */
650 static inline uint8_t clip_uint8_vlc( int32_t a )
652 if( a&(~255) ) return (-a)>>31;
656 /* Malloc with automatic error */
657 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
658 if( !var ) return; } while(0)
659 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
660 if( !var ) return NULL; } while(0)
661 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
662 if( !var ) return VLC_ENOMEM; } while(0)
663 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
664 if( !var ) goto error; } while(0)
665 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
667 #define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
668 if( !var ) return VLC_ENOMEM;
669 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
670 if( !var ) return NULL;
672 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
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)
803 #define VLC_UNUSED(x) (void)(x)
805 /* Stuff defined in src/extras/libc.c */
806 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
807 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
808 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
809 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
810 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
811 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
812 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
813 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
814 VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
816 #if defined(SYS_BEOS) \
817 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
819 long long quot; /* Quotient. */
820 long long rem; /* Remainder. */
823 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
826 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
827 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
829 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
831 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
832 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
833 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
835 #ifndef HAVE_DIRENT_H
837 # ifndef FILENAME_MAX
838 # define FILENAME_MAX (260)
842 long d_ino; /* Always zero. */
843 unsigned short d_reclen; /* Always zero. */
844 unsigned short d_namlen; /* Length of name in d_name. */
845 char d_name[FILENAME_MAX]; /* File name. */
847 # define opendir vlc_opendir
848 # define readdir vlc_readdir
849 # define closedir vlc_closedir
850 # define rewinddir vlc_rewindir
851 # define seekdir vlc_seekdir
852 # define telldir vlc_telldir
853 VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
854 VLC_EXPORT( void *, vlc_readdir, ( void * ) );
855 VLC_EXPORT( int, vlc_closedir, ( void * ) );
856 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
857 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
858 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
863 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
864 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
865 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
866 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
867 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
868 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
869 # define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
870 # define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
871 # define closedir vlc_wclosedir
872 # define _wopendir vlc_wopendir
873 # define _wreaddir vlc_wreaddir
874 # define _wclosedir vlc_wclosedir
875 # define rewinddir vlc_rewinddir
876 # define seekdir vlc_seekdir
877 # define telldir vlc_telldir
880 /* Format type specifiers for 64 bits numbers */
881 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
882 # if defined(__WORDSIZE) && __WORDSIZE == 64
890 # define I64Fd "%lld"
891 # define I64Fi "%lli"
892 # define I64Fo "%llo"
893 # define I64Fu "%llu"
894 # define I64Fx "%llx"
895 # define I64FX "%llX"
898 # define I64Fd "%I64d"
899 # define I64Fi "%I64i"
900 # define I64Fo "%I64o"
901 # define I64Fu "%I64u"
902 # define I64Fx "%I64x"
903 # define I64FX "%I64X"
904 #endif /* defined(WIN32)||defined(UNDER_CE) */
906 /* 64 bits integer constant suffix */
907 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
908 # if defined(__WORDSIZE) && __WORDSIZE == 64
909 # define I64C(x) x##L
910 # define UI64C(x) x##UL
912 # define I64C(x) x##LL
913 # define UI64C(x) x##ULL
916 # define I64C(x) x##i64
917 # define UI64C(x) x##ui64
918 #endif /* defined(WIN32)||defined(UNDER_CE) */
920 #if defined(WIN32) || defined(UNDER_CE)
921 /* win32, cl and icl support */
922 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
923 # define __attribute__(x)
924 # define __inline__ __inline
925 # define S_IFBLK 0x3000 /* Block */
926 # define S_ISBLK(m) (0)
927 # define S_ISCHR(m) (0)
928 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
929 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
932 /* several type definitions */
933 # if defined( __MINGW32__ )
934 # if !defined( _OFF_T_ )
935 typedef long long _off_t;
936 typedef _off_t off_t;
942 # define off_t long long
946 # if defined( _MSC_VER ) && !defined( __WXMSW__ )
947 # if !defined( _OFF_T_DEFINED )
948 typedef __int64 off_t;
949 # define _OFF_T_DEFINED
951 /* for wx compatibility typedef long off_t; */
952 # define off_t __int64
956 # if defined( __BORLANDC__ )
958 # define off_t unsigned __int64
962 # define O_NONBLOCK 0
966 # define alloca _alloca
969 /* These two are not defined in mingw32 (bug?) */
971 # define snprintf _snprintf
974 # define vsnprintf _vsnprintf
980 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
981 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
983 /* vlc_wraptext (defined in src/extras/libc.c) */
984 #define wraptext vlc_wraptext
985 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
987 /* iconv wrappers (defined in src/extras/libc.c) */
988 typedef void *vlc_iconv_t;
989 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
990 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
991 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
993 /* execve wrapper (defined in src/extras/libc.c) */
994 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 ) );
995 #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)
997 /*****************************************************************************
999 *****************************************************************************/
1000 #define CPU_CAPABILITY_NONE 0
1001 #define CPU_CAPABILITY_486 (1<<0)
1002 #define CPU_CAPABILITY_586 (1<<1)
1003 #define CPU_CAPABILITY_PPRO (1<<2)
1004 #define CPU_CAPABILITY_MMX (1<<3)
1005 #define CPU_CAPABILITY_3DNOW (1<<4)
1006 #define CPU_CAPABILITY_MMXEXT (1<<5)
1007 #define CPU_CAPABILITY_SSE (1<<6)
1008 #define CPU_CAPABILITY_SSE2 (1<<7)
1009 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1010 #define CPU_CAPABILITY_FPU (1<<31)
1011 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1013 /*****************************************************************************
1015 *****************************************************************************/
1017 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1020 #if defined( ENABLE_NLS ) && \
1021 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1022 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1023 defined(MODULE_NAME_IS_pda))
1024 /* Declare nothing: gnome.h will do it for us */
1025 #elif defined( ENABLE_NLS )
1026 # if defined( HAVE_INCLUDED_GETTEXT )
1027 # include "libintl.h"
1029 # include <libintl.h>
1033 # define _(String) vlc_dgettext (PACKAGE_NAME, String)
1035 # define _(String) dgettext(PACKAGE_NAME, String)
1037 # define N_(String) (String)
1039 # define _(String) (String)
1040 # define N_(String) (String)
1043 /*****************************************************************************
1045 *****************************************************************************/
1046 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1047 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1048 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1049 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1050 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1051 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1052 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1054 /*****************************************************************************
1055 * Additional vlc stuff
1056 *****************************************************************************/
1057 #include "vlc_messages.h"
1058 #include "vlc_variables.h"
1059 #include "vlc_objects.h"
1060 #include "vlc_mtime.h"
1061 #include "vlc_threads_funcs.h"
1062 #include "vlc_modules.h"
1064 #include "vlc_configuration.h"
1066 /** The global thread var for msg stack context
1067 * We store this as a static global variable so we don't need a vlc_object_t
1069 * This key is created in vlc_threads_init and is therefore ready to use at
1070 * the very beginning of the universe */
1071 extern vlc_threadvar_t msg_context_global_key;
1074 #if defined( WIN32 ) || defined( UNDER_CE )
1075 # define DIR_SEP_CHAR '\\'
1076 # define DIR_SEP "\\"
1078 # define DIR_SEP_CHAR '/'
1079 # define DIR_SEP "/"