1 /*****************************************************************************
2 * common.h: common definitions
3 * Collection of useful common types and macros definitions
4 *****************************************************************************
5 * Copyright (C) 1998-2005 the VideoLAN team
8 * Authors: Samuel Hocevar <sam@via.ecp.fr>
9 * Vincent Seguin <seguin@via.ecp.fr>
10 * Gildas Bazin <gbazin@videolan.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
29 * This file is a collection of common definitions and types
32 /*****************************************************************************
33 * Required vlc headers
34 *****************************************************************************/
35 #if defined( __BORLANDC__ )
43 # define PACKAGE_NAME PACKAGE
46 # undef PACKAGE_VERSION
47 # define PACKAGE_VERSION VERSION
50 #if defined( __BORLANDC__ )
51 # undef HAVE_VARIADIC_MACROS
53 # undef HAVE_INTTYPES_H
55 #elif defined( _MSC_VER )
56 # pragma warning( disable : 4244 )
59 #include "vlc_config.h"
61 /*****************************************************************************
62 * Required system headers
63 *****************************************************************************/
67 #include <string.h> /* strerror() */
70 #ifdef HAVE_SYS_TYPES_H
71 # include <sys/types.h>
74 /*****************************************************************************
75 * Basic types definitions
76 *****************************************************************************/
77 #if defined( HAVE_STDINT_H )
79 #elif defined( HAVE_INTTYPES_H )
80 # include <inttypes.h>
81 #elif defined( SYS_CYGWIN )
82 # include <sys/types.h>
83 /* Cygwin only defines half of these... */
84 typedef u_int8_t uint8_t;
85 typedef u_int16_t uint16_t;
86 typedef u_int32_t uint32_t;
87 typedef u_int64_t uint64_t;
89 /* Fallback types (very x86-centric, sorry) */
90 typedef unsigned char uint8_t;
91 typedef signed char int8_t;
92 typedef unsigned short uint16_t;
93 typedef signed short int16_t;
94 typedef unsigned int uint32_t;
95 typedef signed int int32_t;
96 # if defined( _MSC_VER ) \
97 || defined( UNDER_CE ) \
98 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
99 typedef unsigned __int64 uint64_t;
100 typedef signed __int64 int64_t;
102 typedef unsigned long long uint64_t;
103 typedef signed long long int64_t;
105 typedef uint32_t uintptr_t;
106 typedef int32_t intptr_t;
109 typedef uint8_t byte_t;
111 /* Systems that don't have stdint.h may not define INT64_MIN and
114 #define INT64_MIN (-9223372036854775807LL-1)
117 #define INT64_MAX (9223372036854775807LL)
120 /* ptrdiff_t definition */
127 /* Not portable in a 64-bit environment. */
128 typedef int ptrdiff_t;
132 #if defined( WIN32 ) || defined( UNDER_CE )
135 # define PATH_MAX MAX_PATH
139 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
143 /* Counter for statistics and profiling */
144 typedef unsigned long count_t;
146 /* DCT elements types */
147 typedef int16_t dctelem_t;
149 /* Video buffer types */
150 typedef uint8_t yuv_data_t;
153 typedef uint16_t audio_volume_t;
155 #ifndef HAVE_SOCKLEN_T
156 typedef int socklen_t;
160 * High precision date or time interval
162 * Store a high precision date or time interval. The maximum precision is the
163 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
164 * time interval is then 292271 years, which should be long enough for any
165 * video). Dates are stored as microseconds since a common date (usually the
166 * epoch). Note that date and time intervals can be manipulated using regular
167 * arithmetic operators, and that no special functions are required.
169 typedef int64_t mtime_t;
172 * The vlc_fourcc_t type.
174 * See http://www.webartz.com/fourcc/ for a very detailed list.
176 typedef uint32_t vlc_fourcc_t;
178 #ifdef WORDS_BIGENDIAN
179 # define VLC_FOURCC( a, b, c, d ) \
180 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
181 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
182 # define VLC_TWOCC( a, b ) \
183 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
186 # define VLC_FOURCC( a, b, c, d ) \
187 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
188 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
189 # define VLC_TWOCC( a, b ) \
190 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
194 /*****************************************************************************
195 * Classes declaration
196 *****************************************************************************/
199 typedef struct libvlc_global_data_t libvlc_global_data_t;
200 typedef struct libvlc_int_t libvlc_int_t;
201 typedef struct variable_t variable_t;
202 typedef struct date_t date_t;
203 typedef struct dict_entry_t dict_entry_t;
204 typedef struct dict_t dict_t;
205 typedef struct gc_object_t gc_object_t ;
208 typedef struct msg_bank_t msg_bank_t;
209 typedef struct msg_queue_t msg_queue_t;
210 typedef struct msg_subscription_t msg_subscription_t;
219 PLAYLIST_PLAY, /**< No arg. res=can fail*/
220 PLAYLIST_AUTOPLAY, /**< No arg. res=cant fail*/
221 PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
222 /** arg2 = playlist_item_t* , res=can fail */
223 PLAYLIST_PAUSE, /**< No arg res=can fail*/
224 PLAYLIST_STOP, /**< No arg res=can fail*/
225 PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
226 } playlist_command_t;
229 typedef struct playlist_t playlist_t;
230 typedef struct playlist_item_t playlist_item_t;
231 typedef struct playlist_view_t playlist_view_t;
232 typedef struct playlist_export_t playlist_export_t;
233 typedef struct services_discovery_t services_discovery_t;
234 typedef struct services_discovery_sys_t services_discovery_sys_t;
235 typedef struct playlist_add_t playlist_add_t;
236 typedef struct playlist_preparse_t playlist_preparse_t;
237 typedef struct playlist_fetcher_t playlist_fetcher_t;
240 typedef struct module_bank_t module_bank_t;
241 typedef struct module_t module_t;
242 typedef struct module_config_t module_config_t;
243 typedef struct module_symbols_t module_symbols_t;
244 typedef struct module_cache_t module_cache_t;
246 typedef struct config_category_t config_category_t;
249 typedef struct intf_thread_t intf_thread_t;
250 typedef struct intf_sys_t intf_sys_t;
251 typedef struct intf_console_t intf_console_t;
252 typedef struct intf_msg_t intf_msg_t;
253 typedef struct interaction_t interaction_t;
254 typedef struct interaction_dialog_t interaction_dialog_t;
255 typedef struct user_widget_t user_widget_t;
258 typedef struct input_thread_t input_thread_t;
259 typedef struct input_thread_sys_t input_thread_sys_t;
260 typedef struct input_item_t input_item_t;
261 typedef struct access_t access_t;
262 typedef struct access_sys_t access_sys_t;
263 typedef struct stream_t stream_t;
264 typedef struct stream_sys_t stream_sys_t;
265 typedef struct demux_t demux_t;
266 typedef struct demux_sys_t demux_sys_t;
267 typedef struct es_out_t es_out_t;
268 typedef struct es_out_id_t es_out_id_t;
269 typedef struct es_out_sys_t es_out_sys_t;
270 typedef struct es_descriptor_t es_descriptor_t;
271 typedef struct seekpoint_t seekpoint_t;
272 typedef struct info_t info_t;
273 typedef struct info_category_t info_category_t;
274 typedef struct input_attachment_t input_attachment_t;
277 typedef struct audio_format_t audio_format_t;
278 typedef struct video_format_t video_format_t;
279 typedef struct subs_format_t subs_format_t;
280 typedef struct es_format_t es_format_t;
281 typedef struct video_palette_t video_palette_t;
284 typedef struct aout_instance_t aout_instance_t;
285 typedef struct aout_sys_t aout_sys_t;
286 typedef struct aout_fifo_t aout_fifo_t;
287 typedef struct aout_input_t aout_input_t;
288 typedef struct aout_buffer_t aout_buffer_t;
289 typedef audio_format_t audio_sample_format_t;
290 typedef struct audio_date_t audio_date_t;
291 typedef struct aout_filter_t aout_filter_t;
294 typedef struct vout_thread_t vout_thread_t;
295 typedef struct vout_sys_t vout_sys_t;
296 typedef struct vout_synchro_t vout_synchro_t;
297 typedef struct chroma_sys_t chroma_sys_t;
299 typedef video_format_t video_frame_format_t;
300 typedef struct picture_t picture_t;
301 typedef struct picture_sys_t picture_sys_t;
302 typedef struct picture_heap_t picture_heap_t;
305 typedef struct spu_t spu_t;
306 typedef struct subpicture_t subpicture_t;
307 typedef struct subpicture_sys_t subpicture_sys_t;
308 typedef struct subpicture_region_t subpicture_region_t;
309 typedef struct text_style_t text_style_t;
311 typedef struct image_handler_t image_handler_t;
314 typedef struct sout_instance_t sout_instance_t;
315 typedef struct sout_instance_sys_t sout_instance_sys_t;
317 typedef struct sout_input_t sout_input_t;
318 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
320 typedef struct sout_access_out_t sout_access_out_t;
321 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
323 typedef struct sout_mux_t sout_mux_t;
324 typedef struct sout_mux_sys_t sout_mux_sys_t;
326 typedef struct sout_stream_t sout_stream_t;
327 typedef struct sout_stream_sys_t sout_stream_sys_t;
329 typedef struct config_chain_t config_chain_t;
330 typedef struct sap_session_t sap_session_t;
331 typedef struct sap_address_t sap_address_t;
332 typedef struct session_descriptor_t session_descriptor_t;
333 typedef struct announce_method_t announce_method_t;
334 typedef struct announce_handler_t announce_handler_t;
335 typedef struct sap_handler_t sap_handler_t;
337 typedef struct sout_param_t sout_param_t;
338 typedef struct sout_pcat_t sout_pcat_t;
339 typedef struct sout_std_t sout_std_t;
340 typedef struct sout_display_t sout_display_t;
341 typedef struct sout_duplicate_t sout_duplicate_t;
342 typedef struct sout_transcode_t sout_transcode_t;
343 typedef struct sout_chain_t sout_chain_t;
344 typedef struct streaming_profile_t streaming_profile_t;
345 typedef struct sout_module_t sout_module_t;
346 typedef struct sout_gui_descr_t sout_gui_descr_t;
347 typedef struct profile_parser_t profile_parser_t;
350 typedef struct decoder_t decoder_t;
351 typedef struct decoder_sys_t decoder_sys_t;
354 typedef struct encoder_t encoder_t;
355 typedef struct encoder_sys_t encoder_sys_t;
358 typedef struct filter_t filter_t;
359 typedef struct filter_sys_t filter_sys_t;
362 typedef struct network_socket_t network_socket_t;
363 typedef struct virtual_socket_t v_socket_t;
364 typedef struct sockaddr sockaddr;
365 typedef struct addrinfo addrinfo;
366 typedef struct vlc_acl_t vlc_acl_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, 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_t tls_t;
397 typedef struct tls_server_t tls_server_t;
398 typedef struct tls_session_t tls_session_t;
401 typedef struct md5_s md5_t;
404 typedef struct xml_t xml_t;
405 typedef struct xml_sys_t xml_sys_t;
406 typedef struct xml_reader_t xml_reader_t;
407 typedef struct xml_reader_sys_t xml_reader_sys_t;
410 typedef struct vod_t vod_t;
411 typedef struct vod_sys_t vod_sys_t;
412 typedef struct vod_media_t vod_media_t;
415 typedef struct opengl_t opengl_t;
416 typedef struct opengl_sys_t opengl_sys_t;
419 typedef struct osd_menu_t osd_menu_t;
420 typedef struct osd_state_t osd_state_t;
421 typedef struct osd_event_t osd_event_t;
422 typedef struct osd_button_t osd_button_t;
423 typedef struct osd_menu_state_t osd_menu_state_t;
426 typedef struct vlm_t vlm_t;
427 typedef struct vlm_message_t vlm_message_t;
430 typedef struct vlc_meta_t vlc_meta_t;
431 typedef struct meta_export_t meta_export_t;
434 typedef struct counter_t counter_t;
435 typedef struct counter_sample_t counter_sample_t;
436 typedef struct stats_handler_t stats_handler_t;
437 typedef struct input_stats_t input_stats_t;
438 typedef struct global_stats_t global_stats_t;
441 typedef struct update_t update_t;
442 typedef struct update_iterator_t update_iterator_t;
445 typedef struct meta_engine_t meta_engine_t;
447 /* stat/lstat/fstat */
449 #include <sys/stat.h>
451 #define stat _stati64
452 #define fstat _fstati64
453 /* You should otherwise use utf8_stat and utf8_lstat. */
458 /*****************************************************************************
460 *****************************************************************************/
461 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
462 char const *, /* variable name */
463 vlc_value_t, /* old value */
464 vlc_value_t, /* new value */
465 void * ); /* callback data */
467 /*****************************************************************************
469 *****************************************************************************/
471 #include "vlc_modules_macros.h"
473 #if defined (WIN32) && defined (DLL_EXPORT)
475 # define VLC_PUBLIC_API __declspec(dllexport)
476 # define VLC_PRIVATE_API __declspec(dllexport)
477 # define VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
478 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
480 # define VLC_PUBLIC_API extern __declspec(dllexport)
481 # define VLC_PRIVATE_API extern __declspec(dllexport)
482 # define VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
483 # define VLC_INTERNAL( type, name, args ) type name args
487 # if HAVE_ATTRIBUTE_VISIBILITY
488 # define VLC_PUBLIC_API __attribute__((visibility("default")))
489 # define VLC_PRIVATE_API __attribute__((visibility("default")))
490 # define VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
491 # define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
493 # define VLC_PUBLIC_API
494 # define VLC_EXPORT( type, name, args ) extern "C" type name args
495 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
498 # if HAVE_ATTRIBUTE_VISIBILITY
499 # define VLC_PUBLIC_API extern __attribute__((visibility("default")))
500 # define VLC_PRIVATE_API extern __attribute__((visibility("default")))
501 # define VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
502 # define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
504 # define VLC_PUBLIC_API extern
505 # define VLC_PRIVATE_API extern
506 # define VLC_EXPORT( type, name, args ) type name args
507 # define VLC_INTERNAL( type, name, args ) type name args
512 /*****************************************************************************
513 * OS-specific headers and thread types
514 *****************************************************************************/
515 #if defined( WIN32 ) || defined( UNDER_CE )
516 # define WIN32_LEAN_AND_MEAN
517 # include <windows.h>
518 # if defined( UNDER_CE )
521 # define IS_WINNT ( GetVersion() < 0x80000000 )
525 #include "vlc_threads.h"
527 typedef struct vlc_object_internals_t vlc_object_internals_t;
529 /*****************************************************************************
530 * Common structure members
531 *****************************************************************************/
533 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
534 #define VLC_COMMON_MEMBERS \
535 /** \name VLC_COMMON_MEMBERS \
536 * these members are common for all vlc objects \
539 vlc_object_internals_t *p_internals; \
542 const char *psz_object_type; \
543 const char *psz_object_name; \
545 /* Messages header */ \
549 /* Object access lock */ \
550 vlc_mutex_t object_lock; \
551 vlc_cond_t object_wait; \
553 /* Object properties */ \
554 volatile vlc_bool_t b_error; /**< set by the object */ \
555 volatile vlc_bool_t b_die; /**< set by the outside */ \
556 volatile vlc_bool_t b_dead; /**< set by the object */ \
557 vlc_bool_t b_force; /**< set by the outside (eg. module_Need()) */ \
559 /* Stuff related to the libvlc structure */ \
560 libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
562 volatile int i_refcount; /**< usage count */ \
563 vlc_object_t * p_parent; /**< our parent */ \
564 vlc_object_t ** pp_children; /**< our children */ \
565 volatile int i_children; \
570 /** Just a reminder so that people don't cast garbage */ \
571 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
574 /* VLC_OBJECT: attempt at doing a clever cast */
575 #define VLC_OBJECT( x ) \
576 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
578 #define VLC_GC_MEMBERS \
579 /** \name VLC_GC_MEMBERS \
580 * these members are common to all objects that wish to be garbage-collected \
584 void (*pf_destructor) ( gc_object_t * ); \
585 void *p_destructor_arg; \
593 static inline void __vlc_gc_incref( gc_object_t * p_gc )
595 p_gc->i_gc_refcount ++;
598 static inline void __vlc_gc_decref( gc_object_t *p_gc )
600 p_gc->i_gc_refcount -- ;
602 if( p_gc->i_gc_refcount == 0 )
604 p_gc->pf_destructor( p_gc );
605 /* Do not use the p_gc pointer from now on ! */
609 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
610 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
611 #define vlc_gc_init( a,b,c ) { ((gc_object_t *)a)->i_gc_refcount = 0; \
612 ((gc_object_t *)a)->pf_destructor = b; \
613 ((gc_object_t *)a)->p_destructor_arg = c; }
616 /*****************************************************************************
617 * Macros and inline functions
618 *****************************************************************************/
619 #ifdef NTOHL_IN_SYS_PARAM_H
620 # include <sys/param.h>
622 #elif !defined(WIN32) && !defined( UNDER_CE )
623 # include <netinet/in.h>
625 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
627 /* CEIL: division with round to nearest greater integer */
628 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
630 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
631 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
633 /* __MAX and __MIN: self explanatory */
635 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
638 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
641 static int64_t GCD( int64_t a, int64_t b )
643 if( b ) return GCD( b, a % b );
647 /* function imported from libavutil/common.h */
648 static inline uint8_t clip_uint8_vlc( int32_t a )
650 if( a&(~255) ) return (-a)>>31;
654 /* Malloc with automatic error */
655 #define MALLOC_VOID( var, type ) { var = (type*)malloc( sizeof( type) ); \
657 #define MALLOC_NULL( var, type ) { var = (type*)malloc( sizeof( type) ); \
658 if( !var ) return NULL; }
659 #define MALLOC_ERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
660 if( !var ) return VLC_ENOMEM; }
661 #define MALLOC_GOTOERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
662 if( !var ) goto error; }
663 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
665 #define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
666 if( !var ) return VLC_ENOMEM;
667 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
668 if( !var ) return NULL;
670 #define FREENULL(a) if( a ) { free( a ); a = NULL; }
671 #define FREE(a) if( a ) { free( a ); }
673 #define EMPTY_STR(str) (!str || !*str)
675 VLC_EXPORT( char const *, vlc_error, ( int ) );
677 #include <vlc_arrays.h>
679 /* MSB (big endian)/LSB (little endian) conversions - network order is always
680 * MSB, and should be used for both network communications and files. Note that
681 * byte orders other than little and big endians are not supported, but only
682 * the VAX seems to have such exotic properties. */
683 static inline uint16_t U16_AT( const void * _p )
685 const uint8_t * p = (const uint8_t *)_p;
686 return ( ((uint16_t)p[0] << 8) | p[1] );
688 static inline uint32_t U32_AT( const void * _p )
690 const uint8_t * p = (const uint8_t *)_p;
691 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
692 | ((uint32_t)p[2] << 8) | p[3] );
694 static inline uint64_t U64_AT( const void * _p )
696 const uint8_t * p = (const uint8_t *)_p;
697 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
698 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
699 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
700 | ((uint64_t)p[6] << 8) | p[7] );
703 static inline uint16_t GetWLE( const void * _p )
705 const uint8_t * p = (const uint8_t *)_p;
706 return ( ((uint16_t)p[1] << 8) | p[0] );
708 static inline uint32_t GetDWLE( const void * _p )
710 const uint8_t * p = (const uint8_t *)_p;
711 return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
712 | ((uint32_t)p[1] << 8) | p[0] );
714 static inline uint64_t GetQWLE( const void * _p )
716 const uint8_t * p = (const uint8_t *)_p;
717 return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
718 | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
719 | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
720 | ((uint64_t)p[1] << 8) | p[0] );
723 #define GetWBE( p ) U16_AT( p )
724 #define GetDWBE( p ) U32_AT( p )
725 #define GetQWBE( p ) U64_AT( p )
727 /* Helper writer functions */
728 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
729 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
731 p[1] = ( i_dw >> 8 )&0xff;
732 p[0] = ( i_dw )&0xff;
735 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
736 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
738 p[3] = ( i_dw >> 24 )&0xff;
739 p[2] = ( i_dw >> 16 )&0xff;
740 p[1] = ( i_dw >> 8 )&0xff;
741 p[0] = ( i_dw )&0xff;
743 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
744 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
746 SetDWLE( p, i_qw&0xffffffff );
747 SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
749 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
750 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
752 p[0] = ( i_dw >> 8 )&0xff;
753 p[1] = ( i_dw )&0xff;
756 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
757 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
759 p[0] = ( i_dw >> 24 )&0xff;
760 p[1] = ( i_dw >> 16 )&0xff;
761 p[2] = ( i_dw >> 8 )&0xff;
762 p[3] = ( i_dw )&0xff;
764 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
765 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
767 SetDWBE( p+4, i_qw&0xffffffff );
768 SetDWBE( p, ( i_qw >> 32)&0xffffffff );
771 #ifdef WORDS_BIGENDIAN
772 # define hton16(i) ( i )
773 # define hton32(i) ( i )
774 # define hton64(i) ( i )
775 # define ntoh16(i) ( i )
776 # define ntoh32(i) ( i )
777 # define ntoh64(i) ( i )
779 # define hton16(i) U16_AT(&i)
780 # define hton32(i) U32_AT(&i)
781 # define hton64(i) U64_AT(&i)
782 # define ntoh16(i) U16_AT(&i)
783 # define ntoh32(i) U32_AT(&i)
784 # define ntoh64(i) U64_AT(&i)
787 /* Format string sanity checks */
788 #ifdef HAVE_ATTRIBUTE_FORMAT
789 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
791 # define ATTRIBUTE_FORMAT(x,y)
794 /* Alignment of critical static data structures */
795 #ifdef ATTRIBUTE_ALIGNED_MAX
796 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
798 # define ATTR_ALIGN(align)
801 /* Alignment of critical dynamic data structure
803 * Not all platforms support memalign so we provide a vlc_memalign wrapper
804 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
805 * *pp_orig is the pointer that has to be freed afterwards.
808 #ifdef HAVE_POSIX_MEMALIGN
809 # define vlc_memalign(align,size,pp_orig) \
810 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
814 /* Some systems have memalign() but no declaration for it */
815 void * memalign( size_t align, size_t size );
817 # define vlc_memalign(pp_orig,align,size) \
818 ( *(pp_orig) = memalign( align, size ) )
820 #else /* We don't have any choice but to align manually */
821 # define vlc_memalign(pp_orig,align,size) \
822 (( *(pp_orig) = malloc( size + align - 1 )) \
823 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
824 & (~(unsigned long)(align-1)) ) \
829 /* Stuff defined in src/extras/libc.c */
831 # define strdup vlc_strdup
832 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
833 #elif !defined(__PLUGIN__)
834 # define vlc_strdup NULL
837 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
838 # define vasprintf vlc_vasprintf
839 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
840 #elif !defined(__PLUGIN__)
841 # define vlc_vasprintf NULL
844 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
845 # define asprintf vlc_asprintf
846 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
847 #elif !defined(__PLUGIN__)
848 # define vlc_asprintf NULL
852 # if defined(STRNDUP_IN_GNOME_H) && \
853 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
854 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
855 /* Do nothing: gnome.h defines strndup for us */
857 # define strndup vlc_strndup
858 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
860 #elif !defined(__PLUGIN__)
861 # define vlc_strndup NULL
865 # define strnlen vlc_strnlen
866 VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
867 #elif !defined(__PLUGIN__)
868 # define vlc_strnlen NULL
872 # define strlcpy vlc_strlcpy
873 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
874 #elif !defined(__PLUGIN__)
875 # define vlc_strlcpy NULL
879 # define atof vlc_atof
880 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
881 #elif !defined(__PLUGIN__)
882 # define vlc_atof NULL
887 # define strtof strtod
892 # define atoll vlc_atoll
893 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
894 #elif !defined(__PLUGIN__)
895 # define vlc_atoll NULL
899 # define strtoll vlc_strtoll
900 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
901 #elif !defined(__PLUGIN__)
902 # define vlc_strtoll NULL
905 #if defined(SYS_BEOS) \
906 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
908 long long quot; /* Quotient. */
909 long long rem; /* Remainder. */
911 # define lldiv vlc_lldiv
912 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
913 #elif !defined(__PLUGIN__)
914 # define vlc_lldiv NULL
918 # define scandir vlc_scandir
919 # define alphasort vlc_alphasort
921 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
922 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
923 #elif !defined(__PLUGIN__)
924 # define vlc_scandir NULL
925 # define vlc_alphasort NULL
929 # define getenv vlc_getenv
930 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
931 #elif !defined(__PLUGIN__)
932 # define vlc_getenv NULL
935 #ifndef HAVE_STRCASECMP
936 # ifndef HAVE_STRICMP
937 # define strcasecmp vlc_strcasecmp
938 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
940 # define strcasecmp stricmp
941 # if !defined(__PLUGIN__)
942 # define vlc_strcasecmp NULL
945 #elif !defined(__PLUGIN__)
946 # define vlc_strcasecmp NULL
949 #ifndef HAVE_STRNCASECMP
950 # ifndef HAVE_STRNICMP
951 # define strncasecmp vlc_strncasecmp
952 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
954 # define strncasecmp strnicmp
955 # if !defined(__PLUGIN__)
956 # define vlc_strncasecmp NULL
959 #elif !defined(__PLUGIN__)
960 # define vlc_strncasecmp NULL
963 #ifndef HAVE_STRCASESTR
964 # ifndef HAVE_STRISTR
965 # define strcasestr vlc_strcasestr
966 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
968 # define strcasestr stristr
969 # if !defined(__PLUGIN__)
970 # define vlc_strcasestr NULL
973 #elif !defined(__PLUGIN__)
974 # define vlc_strcasestr NULL
977 #ifndef HAVE_DIRENT_H
979 # ifndef FILENAME_MAX
980 # define FILENAME_MAX (260)
984 long d_ino; /* Always zero. */
985 unsigned short d_reclen; /* Always zero. */
986 unsigned short d_namlen; /* Length of name in d_name. */
987 char d_name[FILENAME_MAX]; /* File name. */
989 # define opendir vlc_opendir
990 # define readdir vlc_readdir
991 # define closedir vlc_closedir
992 # define rewinddir vlc_rewindir
993 # define seekdir vlc_seekdir
994 # define telldir vlc_telldir
995 VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
996 VLC_EXPORT( void *, vlc_readdir, ( void * ) );
997 VLC_EXPORT( int, vlc_closedir, ( void * ) );
998 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
999 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1000 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1002 # if !defined(__PLUGIN__)
1003 # define vlc_opendir NULL
1004 # define vlc_readdir NULL
1005 # define vlc_closedir NULL
1010 # include <dirent.h>
1011 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
1012 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
1013 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
1014 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1015 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1016 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1017 # define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
1018 # define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
1019 # define closedir vlc_wclosedir
1020 # define _wopendir vlc_wopendir
1021 # define _wreaddir vlc_wreaddir
1022 # define _wclosedir vlc_wclosedir
1023 # define rewinddir vlc_rewinddir
1024 # define seekdir vlc_seekdir
1025 # define telldir vlc_telldir
1026 #elif !defined(__PLUGIN__)
1027 # define vlc_wclosedir NULL
1030 /* Format type specifiers for 64 bits numbers */
1031 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1032 # if defined(__WORDSIZE) && __WORDSIZE == 64
1033 # define I64Fd "%ld"
1034 # define I64Fi "%li"
1035 # define I64Fo "%lo"
1036 # define I64Fu "%lu"
1037 # define I64Fx "%lx"
1038 # define I64FX "%lX"
1040 # define I64Fd "%lld"
1041 # define I64Fi "%lli"
1042 # define I64Fo "%llo"
1043 # define I64Fu "%llu"
1044 # define I64Fx "%llx"
1045 # define I64FX "%llX"
1048 # define I64Fd "%I64d"
1049 # define I64Fi "%I64i"
1050 # define I64Fo "%I64o"
1051 # define I64Fu "%I64u"
1052 # define I64Fx "%I64x"
1053 # define I64FX "%I64X"
1054 #endif /* defined(WIN32)||defined(UNDER_CE) */
1056 /* 64 bits integer constant suffix */
1057 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1058 # if defined(__WORDSIZE) && __WORDSIZE == 64
1059 # define I64C(x) x##L
1060 # define UI64C(x) x##UL
1062 # define I64C(x) x##LL
1063 # define UI64C(x) x##ULL
1066 # define I64C(x) x##i64
1067 # define UI64C(x) x##ui64
1068 #endif /* defined(WIN32)||defined(UNDER_CE) */
1070 #if defined(WIN32) || defined(UNDER_CE)
1071 /* win32, cl and icl support */
1072 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
1073 # define __attribute__(x)
1074 # define __inline__ __inline
1075 # define S_IFBLK 0x3000 /* Block */
1076 # define S_ISBLK(m) (0)
1077 # define S_ISCHR(m) (0)
1078 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
1079 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
1082 /* several type definitions */
1083 # if defined( __MINGW32__ )
1084 # if !defined( _OFF_T_ )
1085 typedef long long _off_t;
1086 typedef _off_t off_t;
1092 # define off_t long long
1096 # if defined( _MSC_VER ) && !defined( __WXMSW__ )
1097 # if !defined( _OFF_T_DEFINED )
1098 typedef __int64 off_t;
1099 # define _OFF_T_DEFINED
1101 /* for wx compatibility typedef long off_t; */
1102 # define off_t __int64
1106 # if defined( __BORLANDC__ )
1108 # define off_t unsigned __int64
1112 # define O_NONBLOCK 0
1116 # define alloca _alloca
1119 /* These two are not defined in mingw32 (bug?) */
1121 # define snprintf _snprintf
1124 # define vsnprintf _vsnprintf
1130 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1131 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1133 /* vlc_wraptext (defined in src/extras/libc.c) */
1134 #define wraptext vlc_wraptext
1135 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1137 /* iconv wrappers (defined in src/extras/libc.c) */
1138 typedef void *vlc_iconv_t;
1139 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1140 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1141 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1143 /* execve wrapper (defined in src/extras/libc.c) */
1144 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 ) );
1145 #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)
1147 /*****************************************************************************
1149 *****************************************************************************/
1150 #define CPU_CAPABILITY_NONE 0
1151 #define CPU_CAPABILITY_486 (1<<0)
1152 #define CPU_CAPABILITY_586 (1<<1)
1153 #define CPU_CAPABILITY_PPRO (1<<2)
1154 #define CPU_CAPABILITY_MMX (1<<3)
1155 #define CPU_CAPABILITY_3DNOW (1<<4)
1156 #define CPU_CAPABILITY_MMXEXT (1<<5)
1157 #define CPU_CAPABILITY_SSE (1<<6)
1158 #define CPU_CAPABILITY_SSE2 (1<<7)
1159 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1160 #define CPU_CAPABILITY_FPU (1<<31)
1161 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1163 /*****************************************************************************
1165 *****************************************************************************/
1167 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1170 #if defined( ENABLE_NLS ) && \
1171 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1172 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1173 defined(MODULE_NAME_IS_pda))
1174 /* Declare nothing: gnome.h will do it for us */
1175 #elif defined( ENABLE_NLS )
1176 # if defined( HAVE_INCLUDED_GETTEXT )
1177 # include "libintl.h"
1179 # include <libintl.h>
1183 # define _(String) vlc_dgettext (PACKAGE_NAME, String)
1185 # define _(String) dgettext(PACKAGE_NAME, String)
1187 # define N_(String) (String)
1189 # define _(String) (String)
1190 # define N_(String) (String)
1193 /*****************************************************************************
1195 *****************************************************************************/
1196 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1197 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1198 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1199 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1200 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1201 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1202 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1204 /*****************************************************************************
1205 * Additional vlc stuff
1206 *****************************************************************************/
1207 #include "vlc_os_specific.h"
1208 #include "vlc_messages.h"
1209 #include "vlc_variables.h"
1210 #include "vlc_objects.h"
1211 #include "vlc_threads_funcs.h"
1212 #include "vlc_mtime.h"
1213 #include "vlc_modules.h"
1215 #include "vlc_configuration.h"
1217 /** The global thread var for msg stack context
1218 * We store this as a static global variable so we don't need a vlc_object_t
1220 * This key is created in vlc_threads_init and is therefore ready to use at
1221 * the very beginning of the universe */
1222 extern vlc_threadvar_t msg_context_global_key;
1225 #if defined( __BORLANDC__ )
1230 #if defined( WIN32 ) || defined( UNDER_CE )
1231 # define DIR_SEP_CHAR '\\'
1232 # define DIR_SEP "\\"
1234 # define DIR_SEP_CHAR '/'
1235 # define DIR_SEP "/"