X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_common.h;h=e4b1cc5d4eb68f17b56a1d6677e6992d420362a9;hb=d1474ca68eea4f60f63a851687eedde8e34ffd6c;hp=f2405990673f99f080cd09a6b052708071ebfc30;hpb=71d9f0d028f4dc9fa4fc1adc56c5bc1c5229c5fd;p=vlc diff --git a/include/vlc_common.h b/include/vlc_common.h index f240599067..e4b1cc5d4e 100644 --- a/include/vlc_common.h +++ b/include/vlc_common.h @@ -50,6 +50,7 @@ #include #include #include +#include #ifndef __cplusplus # include @@ -58,10 +59,14 @@ /* Format string sanity checks */ #ifdef __GNUC__ # define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y))) +# define LIBVLC_FORMAT_ARG(x) __attribute__ ((format_arg(x))) # define LIBVLC_USED __attribute__ ((warn_unused_result)) +# define LIBVLC_MALLOC __attribute__ ((malloc)) #else # define LIBVLC_FORMAT(x,y) +# define LIBVLC_FORMAT_ARG(x) # define LIBVLC_USED +# define LIBVLC_MALLOC #endif /***************************************************************************** @@ -138,14 +143,9 @@ static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc ) 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_subscription_t msg_subscription_t; /* Playlist */ @@ -166,12 +166,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; @@ -182,15 +179,6 @@ 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; @@ -200,7 +188,6 @@ 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; @@ -223,7 +210,7 @@ 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; @@ -263,12 +250,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; @@ -363,16 +346,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; @@ -383,18 +364,14 @@ typedef struct meta_engine_t meta_engine_t; /* stat/lstat/fstat */ #ifdef WIN32 -# ifdef UNDER_CE -# undef _STAT_DEFINED -# endif #include + # ifndef UNDER_CE struct _stati64; #define stat _stati64 #define fstat _fstati64 -# else -# define stat _stat -# define fstat _fstat -# endif +#endif + /* You should otherwise use utf8_stat and utf8_lstat. */ #else struct stat; @@ -458,7 +435,6 @@ struct vlc_list_t *****************************************************************************/ #define VLC_SUCCESS -0 /* No error */ #define VLC_ENOMEM -1 /* Not enough memory */ -#define VLC_ETHREAD -2 /* Thread error */ #define VLC_ETIMEOUT -3 /* Timeout */ #define VLC_ENOMOD -10 /* Module not found */ @@ -509,18 +485,11 @@ 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; - /***************************************************************************** * Common structure members *****************************************************************************/ @@ -531,10 +500,7 @@ typedef struct vlc_object_internals_t vlc_object_internals_t; * these members are common for all vlc objects \ */ \ /**@{*/ \ - int i_object_id; \ - int i_object_type; \ const char *psz_object_type; \ - char *psz_object_name; \ \ /* Messages header */ \ char *psz_header; \ @@ -543,53 +509,46 @@ typedef struct vlc_object_internals_t vlc_object_internals_t; /* Object properties */ \ volatile bool b_error; /**< set by the object */ \ volatile bool b_die; /**< set by the outside */ \ - volatile bool b_dead; /**< set by the object */ \ - bool b_force; /**< set by the outside (eg. module_Need()) */ \ + bool b_force; /**< set by the outside (eg. module_need()) */ \ + \ + /** Just a reminder so that people don't cast garbage */ \ + bool be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \ \ /* Stuff related to the libvlc structure */ \ libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \ \ vlc_object_t * p_parent; /**< our parent */ \ \ - /* 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 */ #ifdef __GNUC__ # define VLC_OBJECT( x ) \ - (((vlc_object_t *)(x))+0*(((typeof(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct)) + (((vlc_object_t *)(x))+0*(((__typeof__(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct)) #else # define VLC_OBJECT( x ) ((vlc_object_t *)(x)) #endif -#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 +typedef struct gc_object_t { - VLC_GC_MEMBERS -}; + vlc_spinlock_t spin; + uintptr_t refs; + void (*pf_destructor) (struct gc_object_t *); +} gc_object_t; -VLC_EXPORT(void, __vlc_gc_incref, ( gc_object_t * p_gc )); -VLC_EXPORT(void, __vlc_gc_decref, ( gc_object_t * p_gc )); -VLC_EXPORT(void, __vlc_gc_init, ( gc_object_t * p_gc, - void (*pf_destructor)( gc_object_t * ), void * arg)); +/** + * 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 ) __vlc_gc_init( (gc_object_t *)a,b,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 @@ -629,22 +588,7 @@ static inline uint8_t clip_uint8_vlc( int32_t a ) 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; - +/* Free and set set the variable to NULL */ #define FREENULL(a) do { free( a ); a = NULL; } while(0) #define EMPTY_STR(str) (!str || !*str) @@ -777,11 +721,6 @@ static inline uint64_t ntoh64 (uint64_t ll) #define VLC_UNUSED(x) (void)(x) /* Stuff defined in src/extras/libc.c */ -VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) ); -VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) LIBVLC_USED ); - -VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) LIBVLC_USED ); -char *vlc_strsep( char **, const char * ); #if defined(WIN32) || defined(UNDER_CE) /* win32, cl and icl support */ @@ -830,14 +769,6 @@ char *vlc_strsep( char **, const char * ); # 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 @@ -845,10 +776,6 @@ char *vlc_strsep( char **, const char * ); 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 ) 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 * ) LIBVLC_USED ); @@ -862,33 +789,21 @@ VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const /* dir wrappers (defined in src/extras/libc.c) */ VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir )); -/***************************************************************************** - * CPU capabilities - *****************************************************************************/ -#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 ) ); - -typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n); -typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n); - -VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) ); +/* 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 ) ); /***************************************************************************** * I18n stuff *****************************************************************************/ -VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_USED ); +VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_FORMAT_ARG(1) ); + +LIBVLC_FORMAT_ARG(2) +static inline const char *vlc_pgettext( const char *ctx, const char *id ) +{ + const char *tr = vlc_gettext( id ); + return (tr == ctx) ? id : tr; +} /***************************************************************************** * libvlc features @@ -898,8 +813,6 @@ VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED ); VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED ); VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) LIBVLC_USED ); VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED ); -VLC_EXPORT( const char *, VLC_Error, ( int ) LIBVLC_USED ); -VLC_EXPORT( const char *, VLC_Changeset, ( void ) LIBVLC_USED ); /***************************************************************************** * Additional vlc stuff