X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_messages.h;h=f746f61c09afd91f89dee61340a1d090bd96416c;hb=1723d7e97f421c27ed4c99159e70c3fafb8fdaee;hp=578f4cb1ec1552ff3182542579e5b6ea24dc0fa1;hpb=ed0b72e3714ad87cb4e10b9a7239e19b9ef0724e;p=vlc diff --git a/include/vlc_messages.h b/include/vlc_messages.h index 578f4cb1ec..f746f61c09 100644 --- a/include/vlc_messages.h +++ b/include/vlc_messages.h @@ -1,33 +1,38 @@ /***************************************************************************** - * messages.h: messages interface + * vlc_messages.h: messages interface * This library provides basic functions for threads to interact with user * interface, such as message output. ***************************************************************************** - * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team + * Copyright (C) 1999, 2000, 2001, 2002 VLC authors and VideoLAN * $Id$ * * Authors: Vincent Seguin * Samuel Hocevar * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#include +#ifndef VLC_MESSAGES_H_ +#define VLC_MESSAGES_H_ + +/** + * \file + * This file defines structures and functions to handle messages and statistics gathering + */ -int vlc_mutex_lock( vlc_mutex_t * ) ; -int vlc_mutex_unlock( vlc_mutex_t * ) ; +#include /** * \defgroup messages Messages @@ -37,378 +42,49 @@ int vlc_mutex_unlock( vlc_mutex_t * ) ; * @{ */ - -/** - * Store a single message. - */ -typedef struct -{ - int i_type; /**< message type, see below */ - int i_object_id; - int i_object_type; - char * psz_module; - char * psz_msg; /**< the message itself */ - char * psz_header; /**< Additional header */ - - mtime_t date; /**< Message date */ -} 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 - -#define MSG_QUEUE_NORMAL 0 -#define MSG_QUEUE_HTTPD_ACCESS 1 - -/** - * Store all data requiered by messages interfaces. - */ -struct msg_bank_t -{ - vlc_mutex_t lock; - int i_queues; - msg_queue_t **pp_queues; -}; - -struct msg_queue_t +/** Message types */ +enum vlc_log_type { - int i_id; - - /** Message queue lock */ - vlc_mutex_t lock; - vlc_bool_t b_overflow; - - /* Message queue */ - msg_item_t msg[VLC_MSG_QSIZE]; /**< message queue */ - int i_start; - int i_stop; - - /* Subscribers */ - int i_sub; - msg_subscription_t **pp_sub; - - /* Logfile for WinCE */ -#ifdef UNDER_CE - FILE *logfile; -#endif + VLC_MSG_INFO=0, /**< Important information */ + VLC_MSG_ERR, /**< Error */ + VLC_MSG_WARN, /**< Warning */ + VLC_MSG_DBG, /**< Debug */ }; /** - * Used by interface plugins which subscribe to the message bank. + * Log message */ -struct msg_subscription_t -{ - int i_start; - int* pi_stop; - - msg_item_t* p_msg; - vlc_mutex_t* p_lock; -}; - -/***************************************************************************** - * Prototypes - *****************************************************************************/ -VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, int, const char *, const char *, ... ) ATTRIBUTE_FORMAT( 5, 6 ) ); -VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, int, const char *, const char *, va_list args ) ); -#define msg_GenericVa(a, b, c, d, e,f) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e,f) -VLC_EXPORT( void, __msg_Info, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) ); -VLC_EXPORT( void, __msg_Err, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) ); -VLC_EXPORT( void, __msg_Warn, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) ); -VLC_EXPORT( void, __msg_Dbg, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) ); - -#ifdef HAVE_VARIADIC_MACROS - -# define msg_Info( p_this, psz_format, args... ) \ - __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING, \ - psz_format, ## args ) - -# define msg_Err( p_this, psz_format, args... ) \ - __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING, \ - psz_format, ## args ) - -# define msg_Warn( p_this, psz_format, args... ) \ - __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING, \ - psz_format, ## args ) - -# define msg_Dbg( p_this, psz_format, args... ) \ - __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING, \ - psz_format, ## args ) - -#elif defined(_MSC_VER) /* To avoid warnings and even errors with c++ files */ - -inline void msg_Info( void *p_this, const char *psz_format, ... ) -{ - va_list ap; - va_start( ap, psz_format ); - __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING, - psz_format, ap ); - va_end(ap); -} -inline void msg_Err( void *p_this, const char *psz_format, ... ) -{ - va_list ap; - va_start( ap, psz_format ); - __msg_GenericVa( ( vlc_object_t *)p_this,MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING, - psz_format, ap ); - va_end(ap); -} -inline void msg_Warn( void *p_this, const char *psz_format, ... ) -{ - va_list ap; - va_start( ap, psz_format ); - __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING, - psz_format, ap ); - va_end(ap); -} -inline void msg_Dbg( void *p_this, const char *psz_format, ... ) -{ - va_list ap; - va_start( ap, psz_format ); - __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING, - psz_format, ap ); - va_end(ap); -} - -#else /* _MSC_VER */ - -# define msg_Info __msg_Info -# define msg_Err __msg_Err -# define msg_Warn __msg_Warn -# define msg_Dbg __msg_Dbg - -#endif /* HAVE_VARIADIC_MACROS */ - -#define msg_Create(a) __msg_Create(VLC_OBJECT(a)) -#define msg_Flush(a) __msg_Flush(VLC_OBJECT(a)) -#define msg_Destroy(a) __msg_Destroy(VLC_OBJECT(a)) -void __msg_Create ( vlc_object_t * ); -void __msg_Flush ( vlc_object_t * ); -void __msg_Destroy ( vlc_object_t * ); - -#define msg_Subscribe(a,b) __msg_Subscribe(VLC_OBJECT(a),b) -#define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b) -VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t *, int ) ); -VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) ); +typedef struct vlc_log_t +{ + 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) */ +} vlc_log_t; + +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, ... ) \ + vlc_Log( VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, __VA_ARGS__ ) +#define msg_Err( p_this, ... ) \ + vlc_Log( VLC_OBJECT(p_this), VLC_MSG_ERR, MODULE_STRING, __VA_ARGS__ ) +#define msg_Warn( p_this, ... ) \ + vlc_Log( VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, __VA_ARGS__ ) +#define msg_Dbg( p_this, ... ) \ + vlc_Log( VLC_OBJECT(p_this), VLC_MSG_DBG, MODULE_STRING, __VA_ARGS__ ) + +#ifndef MODULE_STRING +# define MODULE_STRING __FILE__ +#endif +VLC_API const char *vlc_strerror(int); +VLC_API const char *vlc_strerror_c(int); /** * @} */ - -/** - * \defgroup statistics Statistics - * - * @{ - */ - -/**************************** - * Generic stats stuff - ****************************/ -enum -{ - STATS_LAST, - STATS_COUNTER, - STATS_MAX, - STATS_MIN, - STATS_DERIVATIVE, - STATS_TIMER -}; - -struct counter_sample_t -{ - vlc_value_t value; - mtime_t date; -}; - -struct counter_t -{ - /* The list is *NOT* sorted at the moment, it could be ... */ - uint64_t i_index; - char * psz_name; - int i_type; - int i_compute_type; - int i_samples; - counter_sample_t ** pp_samples; - - mtime_t update_interval; - mtime_t last_update; -}; - -enum -{ - STATS_INPUT_BITRATE, - STATS_READ_BYTES, - STATS_READ_PACKETS, - STATS_DEMUX_READ, - STATS_DEMUX_BITRATE, - STATS_PLAYED_ABUFFERS, - STATS_LOST_ABUFFERS, - STATS_DECODED_AUDIO, - STATS_DECODED_VIDEO, - STATS_DECODED_SUB, - STATS_CLIENT_CONNECTIONS, - STATS_ACTIVE_CONNECTIONS, - STATS_SOUT_SENT_PACKETS, - STATS_SOUT_SENT_BYTES, - STATS_SOUT_SEND_BITRATE, - STATS_DISPLAYED_PICTURES, - STATS_LOST_PICTURES, - - STATS_TIMER_PLAYLIST_WALK, - STATS_TIMER_INTERACTION, - STATS_TIMER_PREPARSE, - - STATS_TIMER_SKINS_PLAYTREE_IMAGE, -}; - -struct stats_handler_t -{ - VLC_COMMON_MEMBERS - - int i_counters; - counter_t **pp_counters; -}; - -VLC_EXPORT( void, stats_HandlerDestroy, (stats_handler_t*) ); - -#define stats_Update(a,b,c,d) __stats_Update( VLC_OBJECT( a ), b, c, d ) -VLC_EXPORT( int, __stats_Update, (vlc_object_t*, unsigned int, vlc_value_t, vlc_value_t *) ); -#define stats_Create(a,b,c,d,e) __stats_Create( VLC_OBJECT(a), b, c, d,e ) -VLC_EXPORT( int, __stats_Create, (vlc_object_t*, const char *, unsigned int, int, int) ); -#define stats_Get(a,b,c,d) __stats_Get( VLC_OBJECT(a), b, c, d ) -VLC_EXPORT( int, __stats_Get, (vlc_object_t*, int, unsigned int, vlc_value_t*) ); -#define stats_CounterGet(a,b,c) __stats_CounterGet( VLC_OBJECT(a), b, c ) -VLC_EXPORT( counter_t*, __stats_CounterGet, (vlc_object_t*, int, unsigned int ) ); - -#define stats_GetInteger(a,b,c,d) __stats_GetInteger( VLC_OBJECT(a), b, c, d ) -static inline int __stats_GetInteger( vlc_object_t *p_obj, int i_id, - unsigned int i_counter, int *value ) -{ - int i_ret; - vlc_value_t val; val.i_int = 0; - i_ret = __stats_Get( p_obj, i_id, i_counter, &val ); - *value = val.i_int; - return i_ret; -} - -#define stats_GetFloat(a,b,c,d) __stats_GetFloat( VLC_OBJECT(a), b, c, d ) -static inline int __stats_GetFloat( vlc_object_t *p_obj, int i_id, - unsigned int i_counter, float *value ) -{ - vlc_value_t val;val.f_float = 0.0; - int i_ret = __stats_Get( p_obj, i_id, i_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, - unsigned int i_counter, int i, - int *pi_new ) -{ - int i_ret; - vlc_value_t val; - vlc_value_t new_val; new_val.i_int = 0; - val.i_int = i; - i_ret = __stats_Update( p_obj, i_counter, 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, - unsigned int i_counter, float f, - float *pf_new ) -{ - vlc_value_t val; - int i_ret; - vlc_value_t new_val;new_val.f_float = 0.0; - val.f_float = f; - i_ret = __stats_Update( p_obj, i_counter, 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 - ********/ -#ifdef DEBUG -#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) ) -#else -#define stats_TimerStart(a,b,c) {} -#define stats_TimerStop(a,b) {} -#define stats_TimerDump(a,b) {} -#define stats_TimersDumpAll(a) {} #endif -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*) );