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 *****************************************************************************/
71 #ifdef HAVE_SYS_TYPES_H
72 # include <sys/types.h>
75 /*****************************************************************************
76 * Basic types definitions
77 *****************************************************************************/
78 #if defined( HAVE_STDINT_H )
80 #elif defined( HAVE_INTTYPES_H )
81 # include <inttypes.h>
82 #elif defined( SYS_CYGWIN )
83 # include <sys/types.h>
84 /* Cygwin only defines half of these... */
85 typedef u_int8_t uint8_t;
86 typedef u_int16_t uint16_t;
87 typedef u_int32_t uint32_t;
88 typedef u_int64_t uint64_t;
90 /* Fallback types (very x86-centric, sorry) */
91 typedef unsigned char uint8_t;
92 typedef signed char int8_t;
93 typedef unsigned short uint16_t;
94 typedef signed short int16_t;
95 typedef unsigned int uint32_t;
96 typedef signed int int32_t;
97 # if defined( _MSC_VER ) \
98 || defined( UNDER_CE ) \
99 || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
100 typedef unsigned __int64 uint64_t;
101 typedef signed __int64 int64_t;
103 typedef unsigned long long uint64_t;
104 typedef signed long long int64_t;
106 typedef uint32_t uintptr_t;
107 typedef int32_t intptr_t;
110 typedef uint8_t byte_t;
112 /* Systems that don't have stdint.h may not define INT64_MIN and
115 #define INT64_MIN (-9223372036854775807LL-1)
118 #define INT64_MAX (9223372036854775807LL)
121 /* ptrdiff_t definition */
128 /* Not portable in a 64-bit environment. */
129 typedef int ptrdiff_t;
133 #if defined( WIN32 ) || defined( UNDER_CE )
136 # define PATH_MAX MAX_PATH
140 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
144 /* Counter for statistics and profiling */
145 typedef unsigned long count_t;
147 /* DCT elements types */
148 typedef int16_t dctelem_t;
150 /* Video buffer types */
151 typedef uint8_t yuv_data_t;
154 typedef uint16_t audio_volume_t;
156 #ifndef HAVE_SOCKLEN_T
157 typedef int socklen_t;
161 * High precision date or time interval
163 * Store a high precision date or time interval. The maximum precision is the
164 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
165 * time interval is then 292271 years, which should be long enough for any
166 * video). Dates are stored as microseconds since a common date (usually the
167 * epoch). Note that date and time intervals can be manipulated using regular
168 * arithmetic operators, and that no special functions are required.
170 typedef int64_t mtime_t;
173 * The vlc_fourcc_t type.
175 * See http://www.webartz.com/fourcc/ for a very detailed list.
177 typedef uint32_t vlc_fourcc_t;
179 #ifdef WORDS_BIGENDIAN
180 # define VLC_FOURCC( a, b, c, d ) \
181 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
182 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
183 # define VLC_TWOCC( a, b ) \
184 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
187 # define VLC_FOURCC( a, b, c, d ) \
188 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
189 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
190 # define VLC_TWOCC( a, b ) \
191 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
195 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
197 #ifdef WORDS_BIGENDIAN
198 psz_fourcc[0] = (uint32_t) (fcc >> 24);
199 psz_fourcc[1] = (uint32_t) (fcc >> 16);
200 psz_fourcc[2] = (uint32_t) (fcc >> 8);
201 psz_fourcc[3] = (uint32_t) (fcc);
203 psz_fourcc[3] = (uint32_t) (fcc >> 24);
204 psz_fourcc[2] = (uint32_t) (fcc >> 16);
205 psz_fourcc[1] = (uint32_t) (fcc >> 8);
206 psz_fourcc[0] = (uint32_t) (fcc);
210 #define vlc_fourcc_to_char( a, b ) \
211 __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
213 /*****************************************************************************
214 * Classes declaration
215 *****************************************************************************/
218 typedef struct libvlc_global_data_t libvlc_global_data_t;
219 typedef struct libvlc_int_t libvlc_int_t;
220 typedef struct variable_t variable_t;
221 typedef struct date_t date_t;
222 typedef struct dict_entry_t dict_entry_t;
223 typedef struct dict_t dict_t;
224 typedef struct gc_object_t gc_object_t ;
227 typedef struct msg_bank_t msg_bank_t;
228 typedef struct msg_queue_t msg_queue_t;
229 typedef struct msg_subscription_t msg_subscription_t;
238 PLAYLIST_PLAY, /**< No arg. res=can fail*/
239 PLAYLIST_AUTOPLAY, /**< No arg. res=cant fail*/
240 PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
241 /** arg2 = playlist_item_t* , res=can fail */
242 PLAYLIST_PAUSE, /**< No arg res=can fail*/
243 PLAYLIST_STOP, /**< No arg res=can fail*/
244 PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
245 } playlist_command_t;
248 typedef struct playlist_t playlist_t;
249 typedef struct playlist_item_t playlist_item_t;
250 typedef struct playlist_view_t playlist_view_t;
251 typedef struct playlist_export_t playlist_export_t;
252 typedef struct services_discovery_t services_discovery_t;
253 typedef struct services_discovery_sys_t services_discovery_sys_t;
254 typedef struct playlist_add_t playlist_add_t;
255 typedef struct playlist_preparse_t playlist_preparse_t;
256 typedef struct playlist_fetcher_t playlist_fetcher_t;
259 typedef struct module_bank_t module_bank_t;
260 typedef struct module_t module_t;
261 typedef struct module_config_t module_config_t;
262 typedef struct module_symbols_t module_symbols_t;
263 typedef struct module_cache_t module_cache_t;
265 typedef struct config_category_t config_category_t;
268 typedef struct intf_thread_t intf_thread_t;
269 typedef struct intf_sys_t intf_sys_t;
270 typedef struct intf_console_t intf_console_t;
271 typedef struct intf_msg_t intf_msg_t;
272 typedef struct interaction_t interaction_t;
273 typedef struct interaction_dialog_t interaction_dialog_t;
274 typedef struct user_widget_t user_widget_t;
277 typedef struct input_thread_t input_thread_t;
278 typedef struct input_thread_sys_t input_thread_sys_t;
279 typedef struct input_item_t input_item_t;
280 typedef struct access_t access_t;
281 typedef struct access_sys_t access_sys_t;
282 typedef struct stream_t stream_t;
283 typedef struct stream_sys_t stream_sys_t;
284 typedef struct demux_t demux_t;
285 typedef struct demux_meta_t demux_meta_t;
286 typedef struct demux_sys_t demux_sys_t;
287 typedef struct es_out_t es_out_t;
288 typedef struct es_out_id_t es_out_id_t;
289 typedef struct es_out_sys_t es_out_sys_t;
290 typedef struct es_descriptor_t es_descriptor_t;
291 typedef struct seekpoint_t seekpoint_t;
292 typedef struct info_t info_t;
293 typedef struct info_category_t info_category_t;
294 typedef struct input_attachment_t input_attachment_t;
297 typedef struct audio_format_t audio_format_t;
298 typedef struct video_format_t video_format_t;
299 typedef struct subs_format_t subs_format_t;
300 typedef struct es_format_t es_format_t;
301 typedef struct video_palette_t video_palette_t;
304 typedef struct aout_instance_t aout_instance_t;
305 typedef struct aout_sys_t aout_sys_t;
306 typedef struct aout_fifo_t aout_fifo_t;
307 typedef struct aout_input_t aout_input_t;
308 typedef struct aout_buffer_t aout_buffer_t;
309 typedef audio_format_t audio_sample_format_t;
310 typedef struct audio_date_t audio_date_t;
311 typedef struct aout_filter_t aout_filter_t;
314 typedef struct vout_thread_t vout_thread_t;
315 typedef struct vout_sys_t vout_sys_t;
316 typedef struct chroma_sys_t chroma_sys_t;
318 typedef video_format_t video_frame_format_t;
319 typedef struct picture_t picture_t;
320 typedef struct picture_sys_t picture_sys_t;
321 typedef struct picture_heap_t picture_heap_t;
324 typedef struct spu_t spu_t;
325 typedef struct subpicture_t subpicture_t;
326 typedef struct subpicture_sys_t subpicture_sys_t;
327 typedef struct subpicture_region_t subpicture_region_t;
328 typedef struct text_style_t text_style_t;
330 typedef struct image_handler_t image_handler_t;
333 typedef struct sout_instance_t sout_instance_t;
334 typedef struct sout_instance_sys_t sout_instance_sys_t;
336 typedef struct sout_input_t sout_input_t;
337 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
339 typedef struct sout_access_out_t sout_access_out_t;
340 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
342 typedef struct sout_mux_t sout_mux_t;
343 typedef struct sout_mux_sys_t sout_mux_sys_t;
345 typedef struct sout_stream_t sout_stream_t;
346 typedef struct sout_stream_sys_t sout_stream_sys_t;
348 typedef struct config_chain_t config_chain_t;
349 typedef struct sap_session_t sap_session_t;
350 typedef struct sap_address_t sap_address_t;
351 typedef struct session_descriptor_t session_descriptor_t;
352 typedef struct announce_method_t announce_method_t;
353 typedef struct announce_handler_t announce_handler_t;
354 typedef struct sap_handler_t sap_handler_t;
356 typedef struct sout_param_t sout_param_t;
357 typedef struct sout_pcat_t sout_pcat_t;
358 typedef struct sout_std_t sout_std_t;
359 typedef struct sout_display_t sout_display_t;
360 typedef struct sout_duplicate_t sout_duplicate_t;
361 typedef struct sout_transcode_t sout_transcode_t;
362 typedef struct sout_chain_t sout_chain_t;
363 typedef struct streaming_profile_t streaming_profile_t;
364 typedef struct sout_module_t sout_module_t;
365 typedef struct sout_gui_descr_t sout_gui_descr_t;
366 typedef struct profile_parser_t profile_parser_t;
369 typedef struct decoder_t decoder_t;
370 typedef struct decoder_sys_t decoder_sys_t;
371 typedef struct decoder_synchro_t decoder_synchro_t;
374 typedef struct encoder_t encoder_t;
375 typedef struct encoder_sys_t encoder_sys_t;
378 typedef struct filter_t filter_t;
379 typedef struct filter_sys_t filter_sys_t;
382 typedef struct network_socket_t network_socket_t;
383 typedef struct virtual_socket_t v_socket_t;
384 typedef struct sockaddr sockaddr;
385 typedef struct addrinfo addrinfo;
386 typedef struct vlc_acl_t vlc_acl_t;
387 typedef struct vlc_url_t vlc_url_t;
390 typedef struct iso639_lang_t iso639_lang_t;
391 typedef struct device_t device_t;
392 typedef struct device_probe_t device_probe_t;
393 typedef struct probe_sys_t probe_sys_t;
396 typedef struct block_t block_t;
397 typedef struct block_fifo_t block_fifo_t;
400 typedef struct httpd_t httpd_t;
401 typedef struct httpd_host_t httpd_host_t;
402 typedef struct httpd_url_t httpd_url_t;
403 typedef struct httpd_client_t httpd_client_t;
404 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
405 typedef struct httpd_message_t httpd_message_t;
406 typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
407 typedef struct httpd_file_t httpd_file_t;
408 typedef struct httpd_file_sys_t httpd_file_sys_t;
409 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
410 typedef struct httpd_handler_t httpd_handler_t;
411 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
412 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 );
413 typedef struct httpd_redirect_t httpd_redirect_t;
414 typedef struct httpd_stream_t httpd_stream_t;
417 typedef struct tls_server_t tls_server_t;
418 typedef struct tls_session_t tls_session_t;
421 typedef struct md5_s md5_t;
424 typedef struct xml_t xml_t;
425 typedef struct xml_sys_t xml_sys_t;
426 typedef struct xml_reader_t xml_reader_t;
427 typedef struct xml_reader_sys_t xml_reader_sys_t;
430 typedef struct vod_t vod_t;
431 typedef struct vod_sys_t vod_sys_t;
432 typedef struct vod_media_t vod_media_t;
435 typedef struct opengl_t opengl_t;
436 typedef struct opengl_sys_t opengl_sys_t;
439 typedef struct osd_menu_t osd_menu_t;
440 typedef struct osd_state_t osd_state_t;
441 typedef struct osd_event_t osd_event_t;
442 typedef struct osd_button_t osd_button_t;
443 typedef struct osd_menu_state_t osd_menu_state_t;
446 typedef struct vlm_t vlm_t;
447 typedef struct vlm_message_t vlm_message_t;
450 typedef struct vlc_meta_t vlc_meta_t;
451 typedef struct meta_export_t meta_export_t;
454 typedef struct counter_t counter_t;
455 typedef struct counter_sample_t counter_sample_t;
456 typedef struct stats_handler_t stats_handler_t;
457 typedef struct input_stats_t input_stats_t;
458 typedef struct global_stats_t global_stats_t;
461 typedef struct update_t update_t;
462 typedef struct update_iterator_t update_iterator_t;
465 typedef struct meta_engine_t meta_engine_t;
467 /* stat/lstat/fstat */
469 #include <sys/stat.h>
471 #define stat _stati64
472 #define fstat _fstati64
473 /* You should otherwise use utf8_stat and utf8_lstat. */
478 /*****************************************************************************
480 *****************************************************************************/
481 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
482 char const *, /* variable name */
483 vlc_value_t, /* old value */
484 vlc_value_t, /* new value */
485 void * ); /* callback data */
487 /*****************************************************************************
489 *****************************************************************************/
491 #include "vlc_modules_macros.h"
493 #if defined (WIN32) && defined (DLL_EXPORT)
495 # define VLC_PUBLIC_API __declspec(dllexport)
496 # define VLC_PRIVATE_API __declspec(dllexport)
497 # define VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
498 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
500 # define VLC_PUBLIC_API extern __declspec(dllexport)
501 # define VLC_PRIVATE_API extern __declspec(dllexport)
502 # define VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
503 # define VLC_INTERNAL( type, name, args ) type name args
507 # if HAVE_ATTRIBUTE_VISIBILITY
508 # define VLC_PUBLIC_API __attribute__((visibility("default")))
509 # define VLC_PRIVATE_API __attribute__((visibility("default")))
510 # define VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
511 # define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
513 # define VLC_PUBLIC_API
514 # define VLC_EXPORT( type, name, args ) extern "C" type name args
515 # define VLC_INTERNAL( type, name, args ) extern "C" type name args
518 # if HAVE_ATTRIBUTE_VISIBILITY
519 # define VLC_PUBLIC_API extern __attribute__((visibility("default")))
520 # define VLC_PRIVATE_API extern __attribute__((visibility("default")))
521 # define VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
522 # define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
524 # define VLC_PUBLIC_API extern
525 # define VLC_PRIVATE_API extern
526 # define VLC_EXPORT( type, name, args ) type name args
527 # define VLC_INTERNAL( type, name, args ) type name args
532 /*****************************************************************************
533 * OS-specific headers and thread types
534 *****************************************************************************/
535 #if defined( WIN32 ) || defined( UNDER_CE )
536 # define WIN32_LEAN_AND_MEAN
537 # include <windows.h>
538 # if defined( UNDER_CE )
541 # define IS_WINNT ( GetVersion() < 0x80000000 )
545 #include "vlc_threads.h"
547 typedef struct vlc_object_internals_t vlc_object_internals_t;
549 /*****************************************************************************
550 * Common structure members
551 *****************************************************************************/
553 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
554 #define VLC_COMMON_MEMBERS \
555 /** \name VLC_COMMON_MEMBERS \
556 * these members are common for all vlc objects \
559 vlc_object_internals_t *p_internals; \
562 const char *psz_object_type; \
563 const char *psz_object_name; \
565 /* Messages header */ \
569 /* Object access lock */ \
570 vlc_mutex_t object_lock; \
571 vlc_cond_t object_wait; \
573 /* Object properties */ \
574 volatile vlc_bool_t b_error; /**< set by the object */ \
575 volatile vlc_bool_t b_die; /**< set by the outside */ \
576 volatile vlc_bool_t b_dead; /**< set by the object */ \
577 vlc_bool_t b_force; /**< set by the outside (eg. module_Need()) */ \
579 /* Stuff related to the libvlc structure */ \
580 libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
582 vlc_object_t * p_parent; /**< our parent */ \
583 vlc_object_t ** pp_children; /**< our children */ \
584 volatile int i_children; \
589 /** Just a reminder so that people don't cast garbage */ \
590 int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
593 /* VLC_OBJECT: attempt at doing a clever cast */
594 #define VLC_OBJECT( x ) \
595 ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
597 #define VLC_GC_MEMBERS \
598 /** \name VLC_GC_MEMBERS \
599 * these members are common to all objects that wish to be garbage-collected \
603 void (*pf_destructor) ( gc_object_t * ); \
604 void *p_destructor_arg; \
612 static inline void __vlc_gc_incref( gc_object_t * p_gc )
614 assert( p_gc->i_gc_refcount > 0 );
616 p_gc->i_gc_refcount ++;
619 static inline void __vlc_gc_decref( gc_object_t *p_gc )
623 assert( p_gc->i_gc_refcount > 0 );
625 p_gc->i_gc_refcount -- ;
627 if( p_gc->i_gc_refcount == 0 )
629 p_gc->pf_destructor( p_gc );
630 /* Do not use the p_gc pointer from now on ! */
635 __vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
638 p_gc->i_gc_refcount = 1;
639 p_gc->pf_destructor = pf_destructor;
640 p_gc->p_destructor_arg = arg;
643 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
644 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
645 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
648 /*****************************************************************************
649 * Macros and inline functions
650 *****************************************************************************/
651 #ifdef NTOHL_IN_SYS_PARAM_H
652 # include <sys/param.h>
654 #elif !defined(WIN32) && !defined( UNDER_CE )
655 # include <netinet/in.h>
657 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
659 /* CEIL: division with round to nearest greater integer */
660 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
662 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
663 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
665 /* __MAX and __MIN: self explanatory */
667 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
670 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
673 static inline int64_t GCD( int64_t a, int64_t b )
684 /* function imported from libavutil/common.h */
685 static inline uint8_t clip_uint8_vlc( int32_t a )
687 if( a&(~255) ) return (-a)>>31;
691 /* Malloc with automatic error */
692 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
693 if( !var ) return; } while(0)
694 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
695 if( !var ) return NULL; } while(0)
696 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
697 if( !var ) return VLC_ENOMEM; } while(0)
698 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
699 if( !var ) goto error; } while(0)
700 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
702 #define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
703 if( !var ) return VLC_ENOMEM;
704 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
705 if( !var ) return NULL;
707 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
709 #define EMPTY_STR(str) (!str || !*str)
711 VLC_EXPORT( char const *, vlc_error, ( int ) );
713 #include <vlc_arrays.h>
715 /* MSB (big endian)/LSB (little endian) conversions - network order is always
716 * MSB, and should be used for both network communications and files. Note that
717 * byte orders other than little and big endians are not supported, but only
718 * the VAX seems to have such exotic properties. */
719 static inline uint16_t U16_AT( const void * _p )
721 const uint8_t * p = (const uint8_t *)_p;
722 return ( ((uint16_t)p[0] << 8) | p[1] );
724 static inline uint32_t U32_AT( const void * _p )
726 const uint8_t * p = (const uint8_t *)_p;
727 return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
728 | ((uint32_t)p[2] << 8) | p[3] );
730 static inline uint64_t U64_AT( const void * _p )
732 const uint8_t * p = (const uint8_t *)_p;
733 return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
734 | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
735 | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
736 | ((uint64_t)p[6] << 8) | p[7] );
739 static inline uint16_t GetWLE( const void * _p )
741 const uint8_t * p = (const uint8_t *)_p;
742 return ( ((uint16_t)p[1] << 8) | p[0] );
744 static inline uint32_t GetDWLE( const void * _p )
746 const uint8_t * p = (const uint8_t *)_p;
747 return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
748 | ((uint32_t)p[1] << 8) | p[0] );
750 static inline uint64_t GetQWLE( const void * _p )
752 const uint8_t * p = (const uint8_t *)_p;
753 return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
754 | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
755 | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
756 | ((uint64_t)p[1] << 8) | p[0] );
759 #define GetWBE( p ) U16_AT( p )
760 #define GetDWBE( p ) U32_AT( p )
761 #define GetQWBE( p ) U64_AT( p )
763 /* Helper writer functions */
764 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
765 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
767 p[1] = ( i_dw >> 8 )&0xff;
768 p[0] = ( i_dw )&0xff;
771 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
772 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
774 p[3] = ( i_dw >> 24 )&0xff;
775 p[2] = ( i_dw >> 16 )&0xff;
776 p[1] = ( i_dw >> 8 )&0xff;
777 p[0] = ( i_dw )&0xff;
779 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
780 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
782 SetDWLE( p, i_qw&0xffffffff );
783 SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
785 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
786 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
788 p[0] = ( i_dw >> 8 )&0xff;
789 p[1] = ( i_dw )&0xff;
792 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
793 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
795 p[0] = ( i_dw >> 24 )&0xff;
796 p[1] = ( i_dw >> 16 )&0xff;
797 p[2] = ( i_dw >> 8 )&0xff;
798 p[3] = ( i_dw )&0xff;
800 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
801 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
803 SetDWBE( p+4, i_qw&0xffffffff );
804 SetDWBE( p, ( i_qw >> 32)&0xffffffff );
807 #ifdef WORDS_BIGENDIAN
808 # define hton16(i) ( i )
809 # define hton32(i) ( i )
810 # define hton64(i) ( i )
811 # define ntoh16(i) ( i )
812 # define ntoh32(i) ( i )
813 # define ntoh64(i) ( i )
815 # define hton16(i) U16_AT(&i)
816 # define hton32(i) U32_AT(&i)
817 # define hton64(i) U64_AT(&i)
818 # define ntoh16(i) U16_AT(&i)
819 # define ntoh32(i) U32_AT(&i)
820 # define ntoh64(i) U64_AT(&i)
823 /* Format string sanity checks */
824 #ifdef HAVE_ATTRIBUTE_FORMAT
825 # define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
827 # define ATTRIBUTE_FORMAT(x,y)
830 /* Alignment of critical static data structures */
831 #ifdef ATTRIBUTE_ALIGNED_MAX
832 # define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
834 # define ATTR_ALIGN(align)
838 #define VLC_UNUSED(x) (void)(x)
840 /* Alignment of critical dynamic data structure
842 * Not all platforms support memalign so we provide a vlc_memalign wrapper
843 * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
844 * *pp_orig is the pointer that has to be freed afterwards.
847 #ifdef HAVE_POSIX_MEMALIGN
848 # define vlc_memalign(align,size,pp_orig) \
849 ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
853 /* Some systems have memalign() but no declaration for it */
854 void * memalign( size_t align, size_t size );
856 # define vlc_memalign(pp_orig,align,size) \
857 ( *(pp_orig) = memalign( align, size ) )
859 #else /* We don't have any choice but to align manually */
860 # define vlc_memalign(pp_orig,align,size) \
861 (( *(pp_orig) = malloc( size + align - 1 )) \
862 ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
863 & (~(unsigned long)(align-1)) ) \
868 /* Stuff defined in src/extras/libc.c */
870 # define strdup vlc_strdup
871 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
872 #elif !defined(__PLUGIN__)
873 # define vlc_strdup NULL
876 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
877 # define vasprintf vlc_vasprintf
878 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
879 #elif !defined(__PLUGIN__)
880 # define vlc_vasprintf NULL
883 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
884 # define asprintf vlc_asprintf
885 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
886 #elif !defined(__PLUGIN__)
887 # define vlc_asprintf NULL
891 # if defined(STRNDUP_IN_GNOME_H) && \
892 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
893 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
894 /* Do nothing: gnome.h defines strndup for us */
896 # define strndup vlc_strndup
897 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
899 #elif !defined(__PLUGIN__)
900 # define vlc_strndup NULL
904 # define strnlen vlc_strnlen
905 VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
906 #elif !defined(__PLUGIN__)
907 # define vlc_strnlen NULL
911 # define strlcpy vlc_strlcpy
912 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
913 #elif !defined(__PLUGIN__)
914 # define vlc_strlcpy NULL
918 # define atof vlc_atof
919 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
920 #elif !defined(__PLUGIN__)
921 # define vlc_atof NULL
926 # define strtof strtod
931 # define atoll vlc_atoll
932 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
933 #elif !defined(__PLUGIN__)
934 # define vlc_atoll NULL
938 # define strtoll vlc_strtoll
939 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
940 #elif !defined(__PLUGIN__)
941 # define vlc_strtoll NULL
944 #if defined(SYS_BEOS) \
945 || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
947 long long quot; /* Quotient. */
948 long long rem; /* Remainder. */
950 # define lldiv vlc_lldiv
951 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
952 #elif !defined(__PLUGIN__)
953 # define vlc_lldiv NULL
957 # define scandir vlc_scandir
958 # define alphasort vlc_alphasort
960 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
961 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
962 #elif !defined(__PLUGIN__)
963 # define vlc_scandir NULL
964 # define vlc_alphasort NULL
968 # define getenv vlc_getenv
969 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
970 #elif !defined(__PLUGIN__)
971 # define vlc_getenv NULL
974 #ifndef HAVE_STRCASECMP
975 # ifndef HAVE_STRICMP
976 # define strcasecmp vlc_strcasecmp
977 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
979 # define strcasecmp stricmp
980 # if !defined(__PLUGIN__)
981 # define vlc_strcasecmp NULL
984 #elif !defined(__PLUGIN__)
985 # define vlc_strcasecmp NULL
988 #ifndef HAVE_STRNCASECMP
989 # ifndef HAVE_STRNICMP
990 # define strncasecmp vlc_strncasecmp
991 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
993 # define strncasecmp strnicmp
994 # if !defined(__PLUGIN__)
995 # define vlc_strncasecmp NULL
998 #elif !defined(__PLUGIN__)
999 # define vlc_strncasecmp NULL
1002 #ifndef HAVE_STRCASESTR
1003 # ifndef HAVE_STRISTR
1004 # define strcasestr vlc_strcasestr
1005 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
1007 # define strcasestr stristr
1008 # if !defined(__PLUGIN__)
1009 # define vlc_strcasestr NULL
1012 #elif !defined(__PLUGIN__)
1013 # define vlc_strcasestr NULL
1016 #ifndef HAVE_DIRENT_H
1018 # ifndef FILENAME_MAX
1019 # define FILENAME_MAX (260)
1023 long d_ino; /* Always zero. */
1024 unsigned short d_reclen; /* Always zero. */
1025 unsigned short d_namlen; /* Length of name in d_name. */
1026 char d_name[FILENAME_MAX]; /* File name. */
1028 # define opendir vlc_opendir
1029 # define readdir vlc_readdir
1030 # define closedir vlc_closedir
1031 # define rewinddir vlc_rewindir
1032 # define seekdir vlc_seekdir
1033 # define telldir vlc_telldir
1034 VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
1035 VLC_EXPORT( void *, vlc_readdir, ( void * ) );
1036 VLC_EXPORT( int, vlc_closedir, ( void * ) );
1037 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1038 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1039 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1041 # if !defined(__PLUGIN__)
1042 # define vlc_opendir NULL
1043 # define vlc_readdir NULL
1044 # define vlc_closedir NULL
1049 # include <dirent.h>
1050 VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
1051 VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
1052 VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
1053 VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
1054 VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
1055 VLC_INTERNAL( long, vlc_telldir, ( void * ) );
1056 # define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
1057 # define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
1058 # define closedir vlc_wclosedir
1059 # define _wopendir vlc_wopendir
1060 # define _wreaddir vlc_wreaddir
1061 # define _wclosedir vlc_wclosedir
1062 # define rewinddir vlc_rewinddir
1063 # define seekdir vlc_seekdir
1064 # define telldir vlc_telldir
1065 #elif !defined(__PLUGIN__)
1066 # define vlc_wclosedir NULL
1069 /* Format type specifiers for 64 bits numbers */
1070 #if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE))
1071 # if defined(__WORDSIZE) && __WORDSIZE == 64
1072 # define I64Fd "%ld"
1073 # define I64Fi "%li"
1074 # define I64Fo "%lo"
1075 # define I64Fu "%lu"
1076 # define I64Fx "%lx"
1077 # define I64FX "%lX"
1079 # define I64Fd "%lld"
1080 # define I64Fi "%lli"
1081 # define I64Fo "%llo"
1082 # define I64Fu "%llu"
1083 # define I64Fx "%llx"
1084 # define I64FX "%llX"
1087 # define I64Fd "%I64d"
1088 # define I64Fi "%I64i"
1089 # define I64Fo "%I64o"
1090 # define I64Fu "%I64u"
1091 # define I64Fx "%I64x"
1092 # define I64FX "%I64X"
1093 #endif /* defined(WIN32)||defined(UNDER_CE) */
1095 /* 64 bits integer constant suffix */
1096 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
1097 # if defined(__WORDSIZE) && __WORDSIZE == 64
1098 # define I64C(x) x##L
1099 # define UI64C(x) x##UL
1101 # define I64C(x) x##LL
1102 # define UI64C(x) x##ULL
1105 # define I64C(x) x##i64
1106 # define UI64C(x) x##ui64
1107 #endif /* defined(WIN32)||defined(UNDER_CE) */
1109 #if defined(WIN32) || defined(UNDER_CE)
1110 /* win32, cl and icl support */
1111 # if defined( _MSC_VER ) || !defined( __MINGW32__ )
1112 # define __attribute__(x)
1113 # define __inline__ __inline
1114 # define S_IFBLK 0x3000 /* Block */
1115 # define S_ISBLK(m) (0)
1116 # define S_ISCHR(m) (0)
1117 # define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
1118 # define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
1121 /* several type definitions */
1122 # if defined( __MINGW32__ )
1123 # if !defined( _OFF_T_ )
1124 typedef long long _off_t;
1125 typedef _off_t off_t;
1131 # define off_t long long
1135 # if defined( _MSC_VER ) && !defined( __WXMSW__ )
1136 # if !defined( _OFF_T_DEFINED )
1137 typedef __int64 off_t;
1138 # define _OFF_T_DEFINED
1140 /* for wx compatibility typedef long off_t; */
1141 # define off_t __int64
1145 # if defined( __BORLANDC__ )
1147 # define off_t unsigned __int64
1151 # define O_NONBLOCK 0
1155 # define alloca _alloca
1158 /* These two are not defined in mingw32 (bug?) */
1160 # define snprintf _snprintf
1163 # define vsnprintf _vsnprintf
1169 VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
1170 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
1172 /* vlc_wraptext (defined in src/extras/libc.c) */
1173 #define wraptext vlc_wraptext
1174 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
1176 /* iconv wrappers (defined in src/extras/libc.c) */
1177 typedef void *vlc_iconv_t;
1178 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
1179 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
1180 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
1182 /* execve wrapper (defined in src/extras/libc.c) */
1183 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 ) );
1184 #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)
1186 /*****************************************************************************
1188 *****************************************************************************/
1189 #define CPU_CAPABILITY_NONE 0
1190 #define CPU_CAPABILITY_486 (1<<0)
1191 #define CPU_CAPABILITY_586 (1<<1)
1192 #define CPU_CAPABILITY_PPRO (1<<2)
1193 #define CPU_CAPABILITY_MMX (1<<3)
1194 #define CPU_CAPABILITY_3DNOW (1<<4)
1195 #define CPU_CAPABILITY_MMXEXT (1<<5)
1196 #define CPU_CAPABILITY_SSE (1<<6)
1197 #define CPU_CAPABILITY_SSE2 (1<<7)
1198 #define CPU_CAPABILITY_ALTIVEC (1<<16)
1199 #define CPU_CAPABILITY_FPU (1<<31)
1200 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
1202 /*****************************************************************************
1204 *****************************************************************************/
1206 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
1209 #if defined( ENABLE_NLS ) && \
1210 (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
1211 defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
1212 defined(MODULE_NAME_IS_pda))
1213 /* Declare nothing: gnome.h will do it for us */
1214 #elif defined( ENABLE_NLS )
1215 # if defined( HAVE_INCLUDED_GETTEXT )
1216 # include "libintl.h"
1218 # include <libintl.h>
1222 # define _(String) vlc_dgettext (PACKAGE_NAME, String)
1224 # define _(String) dgettext(PACKAGE_NAME, String)
1226 # define N_(String) (String)
1228 # define _(String) (String)
1229 # define N_(String) (String)
1232 /*****************************************************************************
1234 *****************************************************************************/
1235 VLC_EXPORT( const char *, VLC_Version, ( void ) );
1236 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
1237 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
1238 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
1239 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
1240 VLC_EXPORT( const char *, VLC_Error, ( int ) );
1241 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
1243 /*****************************************************************************
1244 * Additional vlc stuff
1245 *****************************************************************************/
1246 #include "vlc_os_specific.h"
1247 #include "vlc_messages.h"
1248 #include "vlc_variables.h"
1249 #include "vlc_objects.h"
1250 #include "vlc_mtime.h"
1251 #include "vlc_threads_funcs.h"
1252 #include "vlc_modules.h"
1254 #include "vlc_configuration.h"
1256 /** The global thread var for msg stack context
1257 * We store this as a static global variable so we don't need a vlc_object_t
1259 * This key is created in vlc_threads_init and is therefore ready to use at
1260 * the very beginning of the universe */
1261 extern vlc_threadvar_t msg_context_global_key;
1264 #if defined( __BORLANDC__ )
1269 #if defined( WIN32 ) || defined( UNDER_CE )
1270 # define DIR_SEP_CHAR '\\'
1271 # define DIR_SEP "\\"
1273 # define DIR_SEP_CHAR '/'
1274 # define DIR_SEP "/"