X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_messages.h;h=8460bff1ed6e9c3e1ea0e638782b730d9df45d25;hb=aeb72005975cfc84cfca6c3d660cdf0b84d54efb;hp=76c0882aea66612d0bcd443610b8755a0b4c563f;hpb=9d85c35d50b34f3b7d54f12555ab268c73cb95bc;p=vlc diff --git a/include/vlc_messages.h b/include/vlc_messages.h index 76c0882aea..8460bff1ed 100644 --- a/include/vlc_messages.h +++ b/include/vlc_messages.h @@ -24,12 +24,13 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif +#ifndef VLC_MESSAGES_H_ +#define VLC_MESSAGES_H_ -#ifndef _VLC_MESSAGES_H_ -#define _VLC_MESSAGES_H_ +/** + * \file + * This file defines structures and functions to handle messages and statistics gathering + */ #include @@ -41,71 +42,58 @@ * @{ */ +/** Message types */ +enum msg_item_type +{ + VLC_MSG_INFO=0, /**< Important information */ + VLC_MSG_ERR, /**< Error */ + VLC_MSG_WARN, /**< Warning */ + VLC_MSG_DBG, /**< Debug */ +}; + /** - * Store a single message sent to user. + * Log message */ typedef struct { - int i_type; /**< message type, see below */ - int i_object_id; - const char *psz_object_type; - char * psz_module; - char * psz_msg; /**< the message itself */ - char * psz_header; /**< Additional header */ - - mtime_t date; /**< Message date */ + uintptr_t i_object_id; /**< Emitter (temporaly) unique object ID or 0 */ + const char *psz_object_type; /**< Emitter object type name */ + const char *psz_module; /**< Emitter module (source code) */ + const char *psz_header; /**< Additional header (used by VLM media) */ } msg_item_t; -/* Message types */ -/** standard messages */ -#define VLC_MSG_INFO 0 -/** error messages */ -#define VLC_MSG_ERR 1 -/** warning messages */ -#define VLC_MSG_WARN 2 -/** debug messages */ -#define VLC_MSG_DBG 3 - /** * Used by interface plugins which subscribe to the message bank. */ -struct msg_subscription_t -{ - int i_start; - int* pi_stop; - - msg_item_t* p_msg; - vlc_mutex_t* p_lock; -}; +typedef struct msg_subscription_t msg_subscription_t; /***************************************************************************** * Prototypes *****************************************************************************/ -VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) ); -VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) ); -#define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e) -VLC_EXPORT( void, __msg_Info, ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) ); -VLC_EXPORT( void, __msg_Err, ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) ); -VLC_EXPORT( void, __msg_Warn, ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) ); -VLC_EXPORT( void, __msg_Dbg, ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) ); +VLC_API void vlc_Log(vlc_object_t *, int, + const char *, const char *, ...) VLC_FORMAT( 4, 5 ); +VLC_API void vlc_vaLog(vlc_object_t *, int, + const char *, const char *, va_list); +#define msg_GenericVa(a, b, c, d, e) vlc_vaLog(VLC_OBJECT(a), b, c, d, e) #define msg_Info( p_this, ... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \ - MODULE_STRING, __VA_ARGS__ ) + vlc_Log( VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, __VA_ARGS__ ) #define msg_Err( p_this, ... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \ - MODULE_STRING, __VA_ARGS__ ) + vlc_Log( VLC_OBJECT(p_this), VLC_MSG_ERR, MODULE_STRING, __VA_ARGS__ ) #define msg_Warn( p_this, ... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \ - MODULE_STRING, __VA_ARGS__ ) + vlc_Log( VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, __VA_ARGS__ ) #define msg_Dbg( p_this, ... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \ - MODULE_STRING, __VA_ARGS__ ) + vlc_Log( VLC_OBJECT(p_this), VLC_MSG_DBG, MODULE_STRING, __VA_ARGS__ ) -#define msg_Subscribe(a) __msg_Subscribe(VLC_OBJECT(a)) -#define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b) -VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t * ) ); -VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) ); +/** + * Message logging callback signature. + * Accepts one private data pointer, the message, and an overrun counter. + */ +typedef void (*msg_callback_t) (void *, int, const msg_item_t *, + const char *, va_list); + +VLC_API msg_subscription_t *vlc_Subscribe(msg_callback_t, void *) VLC_USED; +VLC_API void vlc_Unsubscribe(msg_subscription_t *); /** * @} @@ -157,6 +145,8 @@ enum STATS_READ_PACKETS, STATS_DEMUX_READ, STATS_DEMUX_BITRATE, + STATS_DEMUX_CORRUPTED, + STATS_DEMUX_DISCONTINUITY, STATS_PLAYED_ABUFFERS, STATS_LOST_ABUFFERS, STATS_DECODED_AUDIO, @@ -183,141 +173,25 @@ enum STATS_TIMER_SKINS_PLAYTREE_IMAGE, }; -#define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c ) -VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) ); -#define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c ) -VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) ); -#define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c) -VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) ); - -VLC_EXPORT (void, stats_CounterClean, (counter_t * ) ); - -#define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c ) -static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter, - int *value ) -{ - int i_ret; - vlc_value_t val; val.i_int = 0; - if( !p_counter ) return VLC_EGENERIC; - i_ret = __stats_Get( p_obj, p_counter, &val ); - *value = val.i_int; - return i_ret; -} - -#define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c ) -static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter, - float *value ) -{ - int i_ret; - vlc_value_t val; val.f_float = 0.0; - if( !p_counter ) return VLC_EGENERIC; - i_ret = __stats_Get( p_obj, p_counter, &val ); - *value = val.f_float; - return i_ret; -} -#define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d ) -static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co, - int i, int *pi_new ) -{ - int i_ret; - vlc_value_t val; - vlc_value_t new_val; new_val.i_int = 0; - if( !p_co ) return VLC_EGENERIC; - val.i_int = i; - i_ret = __stats_Update( p_obj, p_co, val, &new_val ); - if( pi_new ) - *pi_new = new_val.i_int; - return i_ret; -} -#define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d ) -static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co, - float f, float *pf_new ) -{ - vlc_value_t val; - int i_ret; - vlc_value_t new_val;new_val.f_float = 0.0; - if( !p_co ) return VLC_EGENERIC; - val.f_float = f; - i_ret = __stats_Update( p_obj, p_co, val, &new_val ); - if( pf_new ) - *pf_new = new_val.f_float; - return i_ret; -} - -/****************** - * Input stats - ******************/ -struct input_stats_t -{ - vlc_mutex_t lock; - - /* Input */ - int i_read_packets; - int i_read_bytes; - float f_input_bitrate; - float f_average_input_bitrate; - - /* Demux */ - int i_demux_read_packets; - int i_demux_read_bytes; - float f_demux_bitrate; - float f_average_demux_bitrate; - - /* Decoders */ - int i_decoded_audio; - int i_decoded_video; - - /* Vout */ - int i_displayed_pictures; - int i_lost_pictures; - - /* Sout */ - int i_sent_packets; - int i_sent_bytes; - float f_send_bitrate; - - /* Aout */ - int i_played_abuffers; - int i_lost_abuffers; -}; - -VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) ); -VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) ); -VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) ); - -/******************** - * Global stats - *******************/ -struct global_stats_t -{ - vlc_mutex_t lock; - - float f_input_bitrate; - float f_demux_bitrate; - float f_output_bitrate; - - int i_http_clients; -}; - -#define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b) -VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*)); - - /********* * Timing ********/ -#define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c ) -#define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b ) -#define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b ) -#define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) ) -VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) ); -VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) ); -VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) ); -VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) ); -#define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) ) -VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) ); +VLC_API void stats_TimerStart(vlc_object_t*, const char *, unsigned int ); +VLC_API void stats_TimerStop(vlc_object_t*, unsigned int); +VLC_API void stats_TimerDump(vlc_object_t*, unsigned int); +VLC_API void stats_TimersDumpAll(vlc_object_t*); +#define stats_TimerStart(a,b,c) stats_TimerStart( VLC_OBJECT(a), b,c ) +#define stats_TimerStop(a,b) stats_TimerStop( VLC_OBJECT(a), b ) +#define stats_TimerDump(a,b) stats_TimerDump( VLC_OBJECT(a), b ) +#define stats_TimersDumpAll(a) stats_TimersDumpAll( VLC_OBJECT(a) ) + +VLC_API void stats_TimersCleanAll(vlc_object_t * ); +#define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) ) -#define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b ) -VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) ); +VLC_API void stats_TimerClean(vlc_object_t *, unsigned int ); +#define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b ) +/** + * @} + */ #endif