X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_common.h;h=7e16c13d6978d3292c5f54429741aaeef04f1e63;hb=aedd2db49bd6d4f26b5dc6113f1cb6e92e50ff50;hp=aaf9814bd4984914bc32d8b4723f90cebca05cae;hpb=ed5205fe93f276d92c8571c43551d7e0a8c05bab;p=vlc diff --git a/include/vlc_common.h b/include/vlc_common.h index aaf9814bd4..7e16c13d69 100644 --- a/include/vlc_common.h +++ b/include/vlc_common.h @@ -29,30 +29,13 @@ * This file is a collection of common definitions and types */ +#ifndef VLC_COMMON_H +# define VLC_COMMON_H 1 + /***************************************************************************** * Required vlc headers *****************************************************************************/ -#if defined( __BORLANDC__ ) -# undef PACKAGE -#endif - -#include "config.h" - -#if defined(PACKAGE) -# undef PACKAGE_NAME -# define PACKAGE_NAME PACKAGE -#endif -#if defined(VERSION) -# undef PACKAGE_VERSION -# define PACKAGE_VERSION VERSION -#endif - -#if defined( __BORLANDC__ ) -# undef HAVE_VARIADIC_MACROS -# undef HAVE_STDINT_H -# undef HAVE_INTTYPES_H -# undef off_t -#elif defined( _MSC_VER ) +#if defined( _MSC_VER ) # pragma warning( disable : 4244 ) #endif @@ -66,69 +49,62 @@ #include #include +#include +#include -#ifdef HAVE_SYS_TYPES_H -# include +#ifndef __cplusplus +# include #endif -/***************************************************************************** - * Basic types definitions - *****************************************************************************/ -#if defined( HAVE_STDINT_H ) -# include -#elif defined( HAVE_INTTYPES_H ) -# include -#elif defined( SYS_CYGWIN ) -# include - /* Cygwin only defines half of these... */ - typedef u_int8_t uint8_t; - typedef u_int16_t uint16_t; - typedef u_int32_t uint32_t; - typedef u_int64_t uint64_t; -#else - /* Fallback types (very x86-centric, sorry) */ - typedef unsigned char uint8_t; - typedef signed char int8_t; - typedef unsigned short uint16_t; - typedef signed short int16_t; - typedef unsigned int uint32_t; - typedef signed int int32_t; -# if defined( _MSC_VER ) \ - || defined( UNDER_CE ) \ - || ( defined( WIN32 ) && !defined( __MINGW32__ ) ) - typedef unsigned __int64 uint64_t; - typedef signed __int64 int64_t; -# else - typedef unsigned long long uint64_t; - typedef signed long long int64_t; -# endif - typedef uint32_t uintptr_t; - typedef int32_t intptr_t; +/* Try to fix format strings for all versions of mingw and mingw64 */ +#if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO ) + #undef PRId64 + #define PRId64 "lld" + #undef PRIi64 + #define PRIi64 "lli" + #undef PRIu64 + #define PRIu64 "llu" + #undef PRIo64 + #define PRIo64 "llo" + #undef PRIx64 + #define PRIx64 "llx" + #define snprintf __mingw_snprintf + #define vsnprintf __mingw_vsnprintf #endif -typedef uint8_t byte_t; - -/* Systems that don't have stdint.h may not define INT64_MIN and - INT64_MAX */ -#ifndef INT64_MIN -#define INT64_MIN (-9223372036854775807LL-1) -#endif -#ifndef INT64_MAX -#define INT64_MAX (9223372036854775807LL) +/* Format string sanity checks */ +#ifdef __GNUC__ +# if defined( _WIN32 ) && (__GNUC__ > 4 || ( __GNUC__ == 4 && __GNUC_MINOR__ >= 4 ) ) +# define LIBVLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y))) +# else +# define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y))) +# endif +# define LIBVLC_FORMAT_ARG(x) __attribute__ ((format_arg(x))) +# if __GNUC__ > 3 || (__GNUC__ == 3 && (__GNUC_MINOR__ >= 4)) +# define LIBVLC_USED __attribute__ ((warn_unused_result)) +# else +# define LIBVLC_USED +# endif +# define LIBVLC_MALLOC __attribute__ ((malloc)) +#else +# define LIBVLC_FORMAT(x,y) +# define LIBVLC_FORMAT_ARG(x) +# define LIBVLC_USED +# define LIBVLC_MALLOC #endif -/* ptrdiff_t definition */ -#ifdef HAVE_STDDEF_H -# include +/* Branch prediction */ +#ifdef __GNUC__ +# define likely(p) __builtin_expect(!!(p), 1) +# define unlikely(p) __builtin_expect(!!(p), 0) #else -# include -# ifndef _PTRDIFF_T -# define _PTRDIFF_T -/* Not portable in a 64-bit environment. */ -typedef int ptrdiff_t; -# endif +# define likely(p) (!!(p)) +# define unlikely(p) (!!(p)) #endif +/***************************************************************************** + * Basic types definitions + *****************************************************************************/ #if defined( WIN32 ) || defined( UNDER_CE ) # include # ifndef PATH_MAX @@ -136,26 +112,12 @@ typedef int ptrdiff_t; # endif #endif -#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ ) -typedef int ssize_t; -#endif - /* Counter for statistics and profiling */ typedef unsigned long count_t; -/* DCT elements types */ -typedef int16_t dctelem_t; - -/* Video buffer types */ -typedef uint8_t yuv_data_t; - /* Audio volume */ typedef uint16_t audio_volume_t; -#ifndef HAVE_SOCKLEN_T -typedef int socklen_t; -#endif - /** * High precision date or time interval * @@ -191,41 +153,32 @@ typedef uint32_t vlc_fourcc_t; #endif -static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc ) +/** + * Translate a vlc_fourcc into its string representation. This function + * assumes there is enough room in psz_fourcc to store 4 characters in. + * + * \param fcc a vlc_fourcc_t + * \param psz_fourcc string to store string representation of vlc_fourcc in + */ +static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc ) { -#ifdef WORDS_BIGENDIAN - psz_fourcc[0] = (uint32_t) (fcc >> 24); - psz_fourcc[1] = (uint32_t) (fcc >> 16); - psz_fourcc[2] = (uint32_t) (fcc >> 8); - psz_fourcc[3] = (uint32_t) (fcc); -#else - psz_fourcc[3] = (uint32_t) (fcc >> 24); - psz_fourcc[2] = (uint32_t) (fcc >> 16); - psz_fourcc[1] = (uint32_t) (fcc >> 8); - psz_fourcc[0] = (uint32_t) (fcc); -#endif + memcpy( psz_fourcc, &fcc, 4 ); } #define vlc_fourcc_to_char( a, b ) \ - __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) ) + vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) ) /***************************************************************************** * Classes declaration *****************************************************************************/ /* Internal types */ -typedef struct libvlc_global_data_t libvlc_global_data_t; +typedef struct vlc_list_t vlc_list_t; +typedef struct vlc_object_t vlc_object_t; typedef struct libvlc_int_t libvlc_int_t; -typedef struct variable_t variable_t; typedef struct date_t date_t; typedef struct dict_entry_t dict_entry_t; typedef struct dict_t dict_t; -typedef struct gc_object_t gc_object_t ; - -/* Messages */ -typedef struct msg_bank_t msg_bank_t; -typedef struct msg_queue_t msg_queue_t; -typedef struct msg_subscription_t msg_subscription_t; /* Playlist */ @@ -235,7 +188,6 @@ typedef struct msg_subscription_t msg_subscription_t; */ typedef enum { PLAYLIST_PLAY, /**< No arg. res=can fail*/ - PLAYLIST_AUTOPLAY, /**< No arg. res=cant fail*/ PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/ /** arg2 = playlist_item_t* , res=can fail */ PLAYLIST_PAUSE, /**< No arg res=can fail*/ @@ -247,12 +199,9 @@ typedef enum { typedef struct playlist_t playlist_t; typedef struct playlist_item_t playlist_item_t; typedef struct playlist_view_t playlist_view_t; -typedef struct playlist_export_t playlist_export_t; typedef struct services_discovery_t services_discovery_t; typedef struct services_discovery_sys_t services_discovery_sys_t; typedef struct playlist_add_t playlist_add_t; -typedef struct playlist_preparse_t playlist_preparse_t; -typedef struct playlist_fetcher_t playlist_fetcher_t; /* Modules */ typedef struct module_bank_t module_bank_t; @@ -263,25 +212,16 @@ typedef struct module_cache_t module_cache_t; typedef struct config_category_t config_category_t; -/* Interface */ -typedef struct intf_thread_t intf_thread_t; -typedef struct intf_sys_t intf_sys_t; -typedef struct intf_console_t intf_console_t; -typedef struct intf_msg_t intf_msg_t; -typedef struct interaction_t interaction_t; -typedef struct interaction_dialog_t interaction_dialog_t; -typedef struct user_widget_t user_widget_t; - /* Input */ typedef struct input_thread_t input_thread_t; typedef struct input_thread_sys_t input_thread_sys_t; typedef struct input_item_t input_item_t; +typedef struct input_item_node_t input_item_node_t; typedef struct access_t access_t; typedef struct access_sys_t access_sys_t; typedef struct stream_t stream_t; typedef struct stream_sys_t stream_sys_t; typedef struct demux_t demux_t; -typedef struct demux_meta_t demux_meta_t; typedef struct demux_sys_t demux_sys_t; typedef struct es_out_t es_out_t; typedef struct es_out_id_t es_out_id_t; @@ -304,27 +244,23 @@ typedef struct aout_instance_t aout_instance_t; typedef struct aout_sys_t aout_sys_t; typedef struct aout_fifo_t aout_fifo_t; typedef struct aout_input_t aout_input_t; -typedef struct aout_buffer_t aout_buffer_t; +typedef struct block_t aout_buffer_t; typedef audio_format_t audio_sample_format_t; typedef struct audio_date_t audio_date_t; typedef struct aout_filter_t aout_filter_t; /* Video */ typedef struct vout_thread_t vout_thread_t; -typedef struct vout_sys_t vout_sys_t; -typedef struct chroma_sys_t chroma_sys_t; typedef video_format_t video_frame_format_t; typedef struct picture_t picture_t; typedef struct picture_sys_t picture_sys_t; -typedef struct picture_heap_t picture_heap_t; /* Subpictures */ typedef struct spu_t spu_t; typedef struct subpicture_t subpicture_t; typedef struct subpicture_sys_t subpicture_sys_t; typedef struct subpicture_region_t subpicture_region_t; -typedef struct text_style_t text_style_t; typedef struct image_handler_t image_handler_t; @@ -345,12 +281,8 @@ typedef struct sout_stream_t sout_stream_t; typedef struct sout_stream_sys_t sout_stream_sys_t; typedef struct config_chain_t config_chain_t; -typedef struct sap_session_t sap_session_t; -typedef struct sap_address_t sap_address_t; typedef struct session_descriptor_t session_descriptor_t; typedef struct announce_method_t announce_method_t; -typedef struct announce_handler_t announce_handler_t; -typedef struct sap_handler_t sap_handler_t; typedef struct sout_param_t sout_param_t; typedef struct sout_pcat_t sout_pcat_t; @@ -445,16 +377,14 @@ typedef struct osd_menu_state_t osd_menu_state_t; typedef struct vlm_t vlm_t; typedef struct vlm_message_t vlm_message_t; -/* divers */ +/* misc */ typedef struct vlc_meta_t vlc_meta_t; -typedef struct meta_export_t meta_export_t; /* Stats */ typedef struct counter_t counter_t; typedef struct counter_sample_t counter_sample_t; typedef struct stats_handler_t stats_handler_t; typedef struct input_stats_t input_stats_t; -typedef struct global_stats_t global_stats_t; /* Update */ typedef struct update_t update_t; @@ -466,14 +396,87 @@ typedef struct meta_engine_t meta_engine_t; /* stat/lstat/fstat */ #ifdef WIN32 #include + +# ifndef UNDER_CE struct _stati64; #define stat _stati64 #define fstat _fstati64 -/* You should otherwise use utf8_stat and utf8_lstat. */ +#endif + +/* You should otherwise use vlc_stat and vlc_lstat. */ #else struct stat; #endif +/** + * VLC value structure + */ +typedef union +{ + int64_t i_int; + bool b_bool; + float f_float; + char * psz_string; + void * p_address; + vlc_object_t * p_object; + vlc_list_t * p_list; + mtime_t i_time; + struct { int32_t x; int32_t y; } coords; + +} vlc_value_t; + +/** + * VLC list structure + */ +struct vlc_list_t +{ + int i_count; + vlc_value_t * p_values; + int * pi_types; + +}; + +/** + * \defgroup var_type Variable types + * These are the different types a vlc variable can have. + * @{ + */ +#define VLC_VAR_VOID 0x0010 +#define VLC_VAR_BOOL 0x0020 +#define VLC_VAR_INTEGER 0x0030 +#define VLC_VAR_HOTKEY 0x0031 +#define VLC_VAR_STRING 0x0040 +#define VLC_VAR_MODULE 0x0041 +#define VLC_VAR_FILE 0x0042 +#define VLC_VAR_DIRECTORY 0x0043 +#define VLC_VAR_VARIABLE 0x0044 +#define VLC_VAR_FLOAT 0x0050 +#define VLC_VAR_TIME 0x0060 +#define VLC_VAR_ADDRESS 0x0070 +#define VLC_VAR_MUTEX 0x0080 +#define VLC_VAR_COORDS 0x00A0 +/**@}*/ + +/***************************************************************************** + * Error values (shouldn't be exposed) + *****************************************************************************/ +#define VLC_SUCCESS -0 /* No error */ +#define VLC_ENOMEM -1 /* Not enough memory */ +#define VLC_ETIMEOUT -3 /* Timeout */ + +#define VLC_ENOMOD -10 /* Module not found */ + +#define VLC_ENOOBJ -20 /* Object not found */ + +#define VLC_ENOVAR -30 /* Variable not found */ +#define VLC_EBADVAR -31 /* Bad variable value */ + +#define VLC_ENOITEM -40 /**< Item not found */ + +#define VLC_EEXIT -255 /* Program exited */ +#define VLC_EEXITSUCCESS -999 /* Program exited successfully */ +#define VLC_EGENERIC -666 /* Generic error */ + /***************************************************************************** * Variable callbacks *****************************************************************************/ @@ -487,46 +490,21 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */ * Plug-in stuff *****************************************************************************/ -#include "vlc_modules_macros.h" - +#ifdef __cplusplus +# define LIBVLC_EXTERN extern "C" +#else +# define LIBVLC_EXTERN extern +#endif #if defined (WIN32) && defined (DLL_EXPORT) -# ifdef __cplusplus -# define VLC_PUBLIC_API __declspec(dllexport) -# define VLC_PRIVATE_API __declspec(dllexport) -# define VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args -# define VLC_INTERNAL( type, name, args ) extern "C" type name args -# else -# define VLC_PUBLIC_API extern __declspec(dllexport) -# define VLC_PRIVATE_API extern __declspec(dllexport) -# define VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args -# define VLC_INTERNAL( type, name, args ) type name args -# endif +#if defined (UNDER_CE) +# include +#endif +# define LIBVLC_EXPORT __declspec(dllexport) #else -# ifdef __cplusplus -# if HAVE_ATTRIBUTE_VISIBILITY -# define VLC_PUBLIC_API __attribute__((visibility("default"))) -# define VLC_PRIVATE_API __attribute__((visibility("default"))) -# define VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args -# define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args -# else -# define VLC_PUBLIC_API -# define VLC_EXPORT( type, name, args ) extern "C" type name args -# define VLC_INTERNAL( type, name, args ) extern "C" type name args -# endif -# else -# if HAVE_ATTRIBUTE_VISIBILITY -# define VLC_PUBLIC_API extern __attribute__((visibility("default"))) -# define VLC_PRIVATE_API extern __attribute__((visibility("default"))) -# define VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args -# define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args -# else -# define VLC_PUBLIC_API extern -# define VLC_PRIVATE_API extern -# define VLC_EXPORT( type, name, args ) type name args -# define VLC_INTERNAL( type, name, args ) type name args -# endif -# endif +# define LIBVLC_EXPORT #endif +#define VLC_EXPORT( type, name, args ) \ + LIBVLC_EXTERN LIBVLC_EXPORT type name args /***************************************************************************** * OS-specific headers and thread types @@ -534,16 +512,19 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */ #if defined( WIN32 ) || defined( UNDER_CE ) # define WIN32_LEAN_AND_MEAN # include -# if defined( UNDER_CE ) -# define IS_WINNT 0 -# else -# define IS_WINNT ( GetVersion() < 0x80000000 ) -# endif #endif +#include "vlc_mtime.h" #include "vlc_threads.h" -typedef struct vlc_object_internals_t vlc_object_internals_t; +/** + * Memory storage space for an atom. Never access it directly. + */ +typedef union +{ + volatile uintptr_t u; + volatile intptr_t s; +} vlc_atomic_t; /***************************************************************************** * Common structure members @@ -555,92 +536,61 @@ typedef struct vlc_object_internals_t vlc_object_internals_t; * these members are common for all vlc objects \ */ \ /**@{*/ \ - vlc_object_internals_t *p_internals; \ - int i_object_id; \ - int i_object_type; \ const char *psz_object_type; \ - const char *psz_object_name; \ \ /* Messages header */ \ char *psz_header; \ int i_flags; \ \ - /* Object access lock */ \ - vlc_mutex_t object_lock; \ - vlc_cond_t object_wait; \ - \ /* Object properties */ \ - volatile vlc_bool_t b_error; /**< set by the object */ \ - volatile vlc_bool_t b_die; /**< set by the outside */ \ - volatile vlc_bool_t b_dead; /**< set by the object */ \ - vlc_bool_t b_force; /**< set by the outside (eg. module_Need()) */ \ + volatile bool b_die; /**< set by the outside */ \ + bool b_force; /**< set by the outside (eg. module_need()) */ \ \ /* Stuff related to the libvlc structure */ \ libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \ \ vlc_object_t * p_parent; /**< our parent */ \ - vlc_object_t ** pp_children; /**< our children */ \ - volatile int i_children; \ - \ - /* Private data */ \ - void * p_private; \ \ - /** Just a reminder so that people don't cast garbage */ \ - int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \ /**@}*/ \ /* VLC_OBJECT: attempt at doing a clever cast */ -#define VLC_OBJECT( x ) \ - ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct - -#define VLC_GC_MEMBERS \ -/** \name VLC_GC_MEMBERS \ - * these members are common to all objects that wish to be garbage-collected \ - */ \ -/**@{*/ \ - int i_gc_refcount; \ - void (*pf_destructor) ( gc_object_t * ); \ - void *p_destructor_arg; \ -/**@}*/ - -struct gc_object_t -{ - VLC_GC_MEMBERS -}; - -static inline void __vlc_gc_incref( gc_object_t * p_gc ) -{ - p_gc->i_gc_refcount ++; -}; +#if defined( __GNUC__ ) && __GNUC__ > 3 +# ifndef __cplusplus +# define VLC_OBJECT( x ) \ + __builtin_choose_expr(__builtin_offsetof(__typeof__(*x), psz_object_type), \ + (void)0 /* screw you */, (vlc_object_t *)(x)) +# else +# define VLC_OBJECT( x ) \ + ((vlc_object_t *)(x) \ + + 0 * __builtin_offsetof(__typeof__(*x), psz_object_type)) +# endif +#else +# define VLC_OBJECT( x ) ((vlc_object_t *)(x)) +#endif -static inline void __vlc_gc_decref( gc_object_t *p_gc ) +typedef struct gc_object_t { - p_gc->i_gc_refcount -- ; + vlc_atomic_t refs; + void (*pf_destructor) (struct gc_object_t *); +} gc_object_t; - if( p_gc->i_gc_refcount == 0 ) - { - p_gc->pf_destructor( p_gc ); - /* Do not use the p_gc pointer from now on ! */ - } -} +/** + * These members are common to all objects that wish to be garbage-collected. + */ +#define VLC_GC_MEMBERS gc_object_t vlc_gc_data; -#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a ) -#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a ) -#define vlc_gc_init( a,b,c ) { ((gc_object_t *)a)->i_gc_refcount = 0; \ - ((gc_object_t *)a)->pf_destructor = b; \ - ((gc_object_t *)a)->p_destructor_arg = c; } +VLC_EXPORT(void *, vlc_gc_init, (gc_object_t *, void (*)(gc_object_t *))); +VLC_EXPORT(void *, vlc_hold, (gc_object_t *)); +VLC_EXPORT(void, vlc_release, (gc_object_t *)); +#define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) ) +#define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data ) +#define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data ) +#define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data))) /***************************************************************************** * Macros and inline functions *****************************************************************************/ -#ifdef NTOHL_IN_SYS_PARAM_H -# include - -#elif !defined(WIN32) && !defined( UNDER_CE ) -# include - -#endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */ /* CEIL: division with round to nearest greater integer */ #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) ) @@ -656,58 +606,76 @@ static inline void __vlc_gc_decref( gc_object_t *p_gc ) # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) ) #endif -static int64_t GCD( int64_t a, int64_t b ) +LIBVLC_USED +static inline int64_t GCD ( int64_t a, int64_t b ) { - if( b ) return GCD( b, a % b ); - else return a; + while( b ) + { + int64_t c = a % b; + a = b; + b = c; + } + return a; } /* function imported from libavutil/common.h */ +LIBVLC_USED static inline uint8_t clip_uint8_vlc( int32_t a ) { if( a&(~255) ) return (-a)>>31; else return a; } -/* Malloc with automatic error */ -#define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \ - if( !var ) return; } while(0) -#define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \ - if( !var ) return NULL; } while(0) -#define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \ - if( !var ) return VLC_ENOMEM; } while(0) -#define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \ - if( !var ) goto error; } while(0) -#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\ - if( !var ) return; -#define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\ - if( !var ) return VLC_ENOMEM; -#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\ - if( !var ) return NULL; +/* Count leading zeroes */ +LIBVLC_USED +static inline unsigned clz (unsigned x) +{ +#ifdef __GNUC_ + return __builtin_clz (x); +#else + unsigned i = sizeof (x) * 8; + + while (x) + { + x = x >> 1; + i--; + } + return i; +#endif +} + +#define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8)) +#define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8)) +/* XXX: this assumes that int is 32-bits or more */ +#define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8)) +/* Free and set set the variable to NULL */ #define FREENULL(a) do { free( a ); a = NULL; } while(0) #define EMPTY_STR(str) (!str || !*str) -VLC_EXPORT( char const *, vlc_error, ( int ) ); +VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED ); #include /* MSB (big endian)/LSB (little endian) conversions - network order is always - * MSB, and should be used for both network communications and files. Note that - * byte orders other than little and big endians are not supported, but only - * the VAX seems to have such exotic properties. */ + * MSB, and should be used for both network communications and files. */ +LIBVLC_USED static inline uint16_t U16_AT( const void * _p ) { const uint8_t * p = (const uint8_t *)_p; return ( ((uint16_t)p[0] << 8) | p[1] ); } + +LIBVLC_USED static inline uint32_t U32_AT( const void * _p ) { const uint8_t * p = (const uint8_t *)_p; return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16) | ((uint32_t)p[2] << 8) | p[3] ); } + +LIBVLC_USED static inline uint64_t U64_AT( const void * _p ) { const uint8_t * p = (const uint8_t *)_p; @@ -717,17 +685,22 @@ static inline uint64_t U64_AT( const void * _p ) | ((uint64_t)p[6] << 8) | p[7] ); } +LIBVLC_USED static inline uint16_t GetWLE( const void * _p ) { const uint8_t * p = (const uint8_t *)_p; return ( ((uint16_t)p[1] << 8) | p[0] ); } + +LIBVLC_USED static inline uint32_t GetDWLE( const void * _p ) { const uint8_t * p = (const uint8_t *)_p; return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16) | ((uint32_t)p[1] << 8) | p[0] ); } + +LIBVLC_USED static inline uint64_t GetQWLE( const void * _p ) { const uint8_t * p = (const uint8_t *)_p; @@ -785,307 +758,30 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw ) SetDWBE( p, ( i_qw >> 32)&0xffffffff ); } -#ifdef WORDS_BIGENDIAN -# define hton16(i) ( i ) -# define hton32(i) ( i ) -# define hton64(i) ( i ) -# define ntoh16(i) ( i ) -# define ntoh32(i) ( i ) -# define ntoh64(i) ( i ) -#else -# define hton16(i) U16_AT(&i) -# define hton32(i) U32_AT(&i) -# define hton64(i) U64_AT(&i) -# define ntoh16(i) U16_AT(&i) -# define ntoh32(i) U32_AT(&i) -# define ntoh64(i) U64_AT(&i) -#endif - -/* Format string sanity checks */ -#ifdef HAVE_ATTRIBUTE_FORMAT -# define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y))) -#else -# define ATTRIBUTE_FORMAT(x,y) -#endif +#define hton16(i) htons(i) +#define hton32(i) htonl(i) +#define ntoh16(i) ntohs(i) +#define ntoh32(i) ntohl(i) -/* Alignment of critical static data structures */ -#ifdef ATTRIBUTE_ALIGNED_MAX -# define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align))) -#else -# define ATTR_ALIGN(align) -#endif +LIBVLC_USED +static inline uint64_t ntoh64 (uint64_t ll) +{ + union { uint64_t qw; uint8_t b[16]; } v = { ll }; + return ((uint64_t)v.b[0] << 56) + | ((uint64_t)v.b[1] << 48) + | ((uint64_t)v.b[2] << 40) + | ((uint64_t)v.b[3] << 32) + | ((uint64_t)v.b[4] << 24) + | ((uint64_t)v.b[5] << 16) + | ((uint64_t)v.b[6] << 8) + | ((uint64_t)v.b[7] << 0); +} +#define hton64(i) ntoh64(i) /* */ #define VLC_UNUSED(x) (void)(x) -/* Alignment of critical dynamic data structure - * - * Not all platforms support memalign so we provide a vlc_memalign wrapper - * void *vlc_memalign( size_t align, size_t size, void **pp_orig ) - * *pp_orig is the pointer that has to be freed afterwards. - */ -#if 0 -#ifdef HAVE_POSIX_MEMALIGN -# define vlc_memalign(align,size,pp_orig) \ - ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL ) -#endif -#endif -#ifdef HAVE_MEMALIGN - /* Some systems have memalign() but no declaration for it */ - void * memalign( size_t align, size_t size ); - -# define vlc_memalign(pp_orig,align,size) \ - ( *(pp_orig) = memalign( align, size ) ) - -#else /* We don't have any choice but to align manually */ -# define vlc_memalign(pp_orig,align,size) \ - (( *(pp_orig) = malloc( size + align - 1 )) \ - ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \ - & (~(unsigned long)(align-1)) ) \ - : NULL ) - -#endif - /* Stuff defined in src/extras/libc.c */ -#ifndef HAVE_STRDUP -# define strdup vlc_strdup - VLC_EXPORT( char *, vlc_strdup, ( const char *s ) ); -#elif !defined(__PLUGIN__) -# define vlc_strdup NULL -#endif - -#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS) -# define vasprintf vlc_vasprintf - VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) ); -#elif !defined(__PLUGIN__) -# define vlc_vasprintf NULL -#endif - -#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS) -# define asprintf vlc_asprintf - VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) ); -#elif !defined(__PLUGIN__) -# define vlc_asprintf NULL -#endif - -#ifndef HAVE_STRNDUP -# if defined(STRNDUP_IN_GNOME_H) && \ - (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\ - defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)) - /* Do nothing: gnome.h defines strndup for us */ -# else -# define strndup vlc_strndup - VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) ); -# endif -#elif !defined(__PLUGIN__) -# define vlc_strndup NULL -#endif - -#ifndef HAVE_STRNLEN -# define strnlen vlc_strnlen - VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) ); -#elif !defined(__PLUGIN__) -# define vlc_strnlen NULL -#endif - -#ifndef HAVE_STRLCPY -# define strlcpy vlc_strlcpy - VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) ); -#elif !defined(__PLUGIN__) -# define vlc_strlcpy NULL -#endif - -#ifndef HAVE_ATOF -# define atof vlc_atof - VLC_EXPORT( double, vlc_atof, ( const char *nptr ) ); -#elif !defined(__PLUGIN__) -# define vlc_atof NULL -#endif - -#ifndef HAVE_STRTOF -# ifdef HAVE_STRTOD -# define strtof strtod -# endif -#endif - -#ifndef HAVE_ATOLL -# define atoll vlc_atoll - VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) ); -#elif !defined(__PLUGIN__) -# define vlc_atoll NULL -#endif - -#ifndef HAVE_STRTOLL -# define strtoll vlc_strtoll - VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) ); -#elif !defined(__PLUGIN__) -# define vlc_strtoll NULL -#endif - -#if defined(SYS_BEOS) \ - || (defined (__FreeBSD__) && (__FreeBSD__ < 5)) - typedef struct { - long long quot; /* Quotient. */ - long long rem; /* Remainder. */ - } lldiv_t; -# define lldiv vlc_lldiv - VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) ); -#elif !defined(__PLUGIN__) -# define vlc_lldiv NULL -#endif - -#ifndef HAVE_SCANDIR -# define scandir vlc_scandir -# define alphasort vlc_alphasort - struct dirent; - VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) ); - VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) ); -#elif !defined(__PLUGIN__) -# define vlc_scandir NULL -# define vlc_alphasort NULL -#endif - -#ifndef HAVE_GETENV -# define getenv vlc_getenv - VLC_EXPORT( char *, vlc_getenv, ( const char *name ) ); -#elif !defined(__PLUGIN__) -# define vlc_getenv NULL -#endif - -#ifndef HAVE_STRCASECMP -# ifndef HAVE_STRICMP -# define strcasecmp vlc_strcasecmp - VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) ); -# else -# define strcasecmp stricmp -# if !defined(__PLUGIN__) -# define vlc_strcasecmp NULL -# endif -# endif -#elif !defined(__PLUGIN__) -# define vlc_strcasecmp NULL -#endif - -#ifndef HAVE_STRNCASECMP -# ifndef HAVE_STRNICMP -# define strncasecmp vlc_strncasecmp - VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) ); -# else -# define strncasecmp strnicmp -# if !defined(__PLUGIN__) -# define vlc_strncasecmp NULL -# endif -# endif -#elif !defined(__PLUGIN__) -# define vlc_strncasecmp NULL -#endif - -#ifndef HAVE_STRCASESTR -# ifndef HAVE_STRISTR -# define strcasestr vlc_strcasestr - VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) ); -# else -# define strcasestr stristr -# if !defined(__PLUGIN__) -# define vlc_strcasestr NULL -# endif -# endif -#elif !defined(__PLUGIN__) -# define vlc_strcasestr NULL -#endif - -#ifndef HAVE_DIRENT_H - typedef void DIR; -# ifndef FILENAME_MAX -# define FILENAME_MAX (260) -# endif - struct dirent - { - long d_ino; /* Always zero. */ - unsigned short d_reclen; /* Always zero. */ - unsigned short d_namlen; /* Length of name in d_name. */ - char d_name[FILENAME_MAX]; /* File name. */ - }; -# define opendir vlc_opendir -# define readdir vlc_readdir -# define closedir vlc_closedir -# define rewinddir vlc_rewindir -# define seekdir vlc_seekdir -# define telldir vlc_telldir - VLC_EXPORT( void *, vlc_opendir, ( const char * ) ); - VLC_EXPORT( void *, vlc_readdir, ( void * ) ); - VLC_EXPORT( int, vlc_closedir, ( void * ) ); - VLC_INTERNAL( void, vlc_rewinddir, ( void * ) ); - VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) ); - VLC_INTERNAL( long, vlc_telldir, ( void * ) ); -#else -# if !defined(__PLUGIN__) -# define vlc_opendir NULL -# define vlc_readdir NULL -# define vlc_closedir NULL -# endif -#endif - -#if defined (WIN32) -# include - VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) ); - VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) ); - VLC_EXPORT( int, vlc_wclosedir, ( void * ) ); - VLC_INTERNAL( void, vlc_rewinddir, ( void * ) ); - VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) ); - VLC_INTERNAL( long, vlc_telldir, ( void * ) ); -# define opendir Use_utf8_opendir_or_vlc_wopendir_instead! -# define readdir Use_utf8_readdir_or_vlc_wreaddir_instead! -# define closedir vlc_wclosedir -# define _wopendir vlc_wopendir -# define _wreaddir vlc_wreaddir -# define _wclosedir vlc_wclosedir -# define rewinddir vlc_rewinddir -# define seekdir vlc_seekdir -# define telldir vlc_telldir -#elif !defined(__PLUGIN__) -# define vlc_wclosedir NULL -#endif - -/* Format type specifiers for 64 bits numbers */ -#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE)) -# if defined(__WORDSIZE) && __WORDSIZE == 64 -# define I64Fd "%ld" -# define I64Fi "%li" -# define I64Fo "%lo" -# define I64Fu "%lu" -# define I64Fx "%lx" -# define I64FX "%lX" -# else -# define I64Fd "%lld" -# define I64Fi "%lli" -# define I64Fo "%llo" -# define I64Fu "%llu" -# define I64Fx "%llx" -# define I64FX "%llX" -# endif -#else -# define I64Fd "%I64d" -# define I64Fi "%I64i" -# define I64Fo "%I64o" -# define I64Fu "%I64u" -# define I64Fx "%I64x" -# define I64FX "%I64X" -#endif /* defined(WIN32)||defined(UNDER_CE) */ - -/* 64 bits integer constant suffix */ -#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE)) -# if defined(__WORDSIZE) && __WORDSIZE == 64 -# define I64C(x) x##L -# define UI64C(x) x##UL -# else -# define I64C(x) x##LL -# define UI64C(x) x##ULL -# endif -#else -# define I64C(x) x##i64 -# define UI64C(x) x##ui64 -#endif /* defined(WIN32)||defined(UNDER_CE) */ #if defined(WIN32) || defined(UNDER_CE) /* win32, cl and icl support */ @@ -1134,123 +830,98 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw ) # ifndef alloca # define alloca _alloca -# endif - - /* These two are not defined in mingw32 (bug?) */ -# ifndef snprintf -# define snprintf _snprintf -# endif -# ifndef vsnprintf -# define vsnprintf _vsnprintf # endif # include #endif -VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) ); -VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) ); +VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) ); -/* vlc_wraptext (defined in src/extras/libc.c) */ -#define wraptext vlc_wraptext -VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) ); +VLC_EXPORT( void *, vlc_memalign, ( void **base, size_t alignment, size_t size ) LIBVLC_USED ); /* iconv wrappers (defined in src/extras/libc.c) */ typedef void *vlc_iconv_t; -VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) ); -VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) ); +VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) LIBVLC_USED ); +VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) LIBVLC_USED ); VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) ); /* execve wrapper (defined in src/extras/libc.c) */ -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 ) ); -#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) +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 ) LIBVLC_USED ); +#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) + +VLC_EXPORT( void, vlc_tdestroy, ( void *, void (*)(void *) ) ); + +/* Fast large memory copy and memory set */ +VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) ); +VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) ); /***************************************************************************** - * CPU capabilities + * I18n stuff *****************************************************************************/ -#define CPU_CAPABILITY_NONE 0 -#define CPU_CAPABILITY_486 (1<<0) -#define CPU_CAPABILITY_586 (1<<1) -#define CPU_CAPABILITY_PPRO (1<<2) -#define CPU_CAPABILITY_MMX (1<<3) -#define CPU_CAPABILITY_3DNOW (1<<4) -#define CPU_CAPABILITY_MMXEXT (1<<5) -#define CPU_CAPABILITY_SSE (1<<6) -#define CPU_CAPABILITY_SSE2 (1<<7) -#define CPU_CAPABILITY_ALTIVEC (1<<16) -#define CPU_CAPABILITY_FPU (1<<31) -VLC_EXPORT( unsigned, vlc_CPU, ( void ) ); +VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_FORMAT_ARG(1) ); + +#define vlc_pgettext( ctx, id ) \ + vlc_pgettext_aux( ctx "\004" id, id ) + +LIBVLC_FORMAT_ARG(2) +static inline const char *vlc_pgettext_aux( const char *ctx, const char *id ) +{ + const char *tr = vlc_gettext( ctx ); + return (tr == ctx) ? id : tr; +} /***************************************************************************** - * I18n stuff + * Loosy memory allocation functions. Do not use in new code. *****************************************************************************/ -#ifdef WIN32 - VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) ); -#endif +static inline void *xmalloc (size_t len) +{ + void *ptr = malloc (len); + if (unlikely (ptr == NULL)) + abort (); + return ptr; +} -#if defined( ENABLE_NLS ) && \ - (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\ - defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\ - defined(MODULE_NAME_IS_pda)) - /* Declare nothing: gnome.h will do it for us */ -#elif defined( ENABLE_NLS ) -# if defined( HAVE_INCLUDED_GETTEXT ) -# include "libintl.h" -# else -# include -# endif -# undef _ -# ifdef WIN32 -# define _(String) vlc_dgettext (PACKAGE_NAME, String) -# else -# define _(String) dgettext(PACKAGE_NAME, String) -# endif -# define N_(String) (String) -#else -# define _(String) (String) -# define N_(String) (String) -#endif +static inline void *xrealloc (void *ptr, size_t len) +{ + void *nptr = realloc (ptr, len); + if (unlikely (nptr == NULL)) + abort (); + return nptr; +} /***************************************************************************** * libvlc features *****************************************************************************/ -VLC_EXPORT( const char *, VLC_Version, ( void ) ); -VLC_EXPORT( const char *, VLC_CompileBy, ( void ) ); -VLC_EXPORT( const char *, VLC_CompileHost, ( void ) ); -VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) ); -VLC_EXPORT( const char *, VLC_Compiler, ( void ) ); -VLC_EXPORT( const char *, VLC_Error, ( int ) ); -VLC_EXPORT( const char *, VLC_Changeset, ( void ) ); +VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED ); +VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED ); +VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED ); +VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED ); /***************************************************************************** * Additional vlc stuff *****************************************************************************/ -#include "vlc_os_specific.h" #include "vlc_messages.h" -#include "vlc_variables.h" #include "vlc_objects.h" -#include "vlc_mtime.h" -#include "vlc_threads_funcs.h" -#include "vlc_modules.h" -#include "main.h" +#include "vlc_variables.h" +#include "vlc_main.h" #include "vlc_configuration.h" -/** The global thread var for msg stack context - * We store this as a static global variable so we don't need a vlc_object_t - * everywhere. - * This key is created in vlc_threads_init and is therefore ready to use at - * the very beginning of the universe */ -extern vlc_threadvar_t msg_context_global_key; - - -#if defined( __BORLANDC__ ) -# undef PACKAGE -# define PACKAGE -#endif - #if defined( WIN32 ) || defined( UNDER_CE ) # define DIR_SEP_CHAR '\\' # define DIR_SEP "\\" +# define PATH_SEP_CHAR ';' +# define PATH_SEP ";" #else # define DIR_SEP_CHAR '/' # define DIR_SEP "/" +# define PATH_SEP_CHAR ':' +# define PATH_SEP ":" #endif + +#define LICENSE_MSG \ + _("This program comes with NO WARRANTY, to the extent permitted by " \ + "law.\nYou may redistribute it under the terms of the GNU General " \ + "Public License;\nsee the file named COPYING for details.\n" \ + "Written by the VideoLAN team; see the AUTHORS file.\n") + +#endif /* !VLC_COMMON_H */