X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_messages.h;h=6bfd5dada59612929362cab58d6cc87e235d4d70;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=20d85f3ed20e7c983432c3aad026581b7c085c58;hpb=b69c9ce1279a154a8bbbe35b16a7bc7480cd967b;p=vlc diff --git a/include/vlc_messages.h b/include/vlc_messages.h index 20d85f3ed2..6bfd5dada5 100644 --- a/include/vlc_messages.h +++ b/include/vlc_messages.h @@ -3,8 +3,8 @@ * This library provides basic functions for threads to interact with user * interface, such as message output. ***************************************************************************** - * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN - * $Id: vlc_messages.h,v 1.6 2002/08/26 09:12:46 sam Exp $ + * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team + * $Id$ * * Authors: Vincent Seguin * Samuel Hocevar @@ -13,7 +13,7 @@ * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 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 @@ -21,119 +21,205 @@ * * 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., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ +#ifndef VLC_MESSAGES_H_ +#define VLC_MESSAGES_H_ + +/** + * \file + * This file defines structures and functions to handle messages and statistics gathering + */ + #include -/***************************************************************************** - * msg_item_t - ***************************************************************************** - * Store a single message. - *****************************************************************************/ +/** + * \defgroup messages Messages + * This library provides basic functions for threads to interact with user + * interface, such as message output. + * + * @{ + */ + +/** + * Store a single message sent to user. + */ typedef struct { - int i_type; /* message type, see below */ - int i_object_id; - int i_object_type; + int i_type; /**< message type, see below */ + uintptr_t i_object_id; + const char *psz_object_type; char * psz_module; - char * psz_msg; /* the message itself */ + char * psz_msg; /**< the message itself */ + char * psz_header; /**< Additional header */ -#if 0 - mtime_t date; /* date of the message */ - char * psz_file; /* file in which the function was called */ - char * psz_function; /* function from which the function was called */ - int i_line; /* line at which the function was called */ -#endif + mtime_t date; /**< Message date */ + gc_object_t vlc_gc_data; } msg_item_t; /* Message types */ -#define VLC_MSG_INFO 0 /* standard messages */ -#define VLC_MSG_ERR 1 /* error messages */ -#define VLC_MSG_WARN 2 /* warning messages */ -#define VLC_MSG_DBG 3 /* debug messages */ - -/***************************************************************************** - * msg_bank_t - ***************************************************************************** - * Store all data requiered by messages interfaces. - *****************************************************************************/ -struct msg_bank_t +/** 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 + +static inline msg_item_t *msg_Hold (msg_item_t *msg) { - /* Message queue lock */ - vlc_mutex_t lock; - vlc_bool_t b_configured; - 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; -}; + vlc_hold (&msg->vlc_gc_data); + return msg; +} -/***************************************************************************** - * msg_subscription_t - ***************************************************************************** - * Used by interface plugins which subscribe to the message bank. - *****************************************************************************/ -struct msg_subscription_t +static inline void msg_Release (msg_item_t *msg) { - int i_start; - int* pi_stop; + vlc_release (&msg->vlc_gc_data); +} - msg_item_t* p_msg; - vlc_mutex_t* p_lock; -}; +/** + * Used by interface plugins which subscribe to the message bank. + */ +typedef struct msg_subscription_t msg_subscription_t; /***************************************************************************** * Prototypes *****************************************************************************/ -VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) ); -VLC_EXPORT( void, __msg_Info, ( void *, const char *, ... ) ); -VLC_EXPORT( void, __msg_Err, ( void *, const char *, ... ) ); -VLC_EXPORT( void, __msg_Warn, ( void *, const char *, ... ) ); -VLC_EXPORT( void, __msg_Dbg, ( void *, const char *, ... ) ); - -#ifdef HAVE_VARIADIC_MACROS - -# define msg_Info( p_this, psz_format, args... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, \ - psz_format, ## args ) - -# define msg_Err( p_this, psz_format, args... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, MODULE_STRING, \ - psz_format, ## args ) - -# define msg_Warn( p_this, psz_format, args... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, \ - psz_format, ## args ) - -# define msg_Dbg( p_this, psz_format, args... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, MODULE_STRING, \ - psz_format, ## args ) - -#else /* HAVE_VARIADIC_MACROS */ +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) + +#define msg_Info( p_this, ... ) \ + msg_Generic( 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__ ) +#define msg_Warn( p_this, ... ) \ + msg_Generic( 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__ ) + +typedef struct msg_cb_data_t msg_cb_data_t; + +/** + * Message logging callback signature. + * Accepts one private data pointer, the message, and an overrun counter. + */ +typedef void (*msg_callback_t) (msg_cb_data_t *, msg_item_t *, unsigned); + +VLC_EXPORT( msg_subscription_t*, msg_Subscribe, ( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) LIBVLC_USED ); +VLC_EXPORT( void, msg_Unsubscribe, ( msg_subscription_t * ) ); +VLC_EXPORT( void, msg_SubscriptionSetVerbosity, ( msg_subscription_t *, const int) ); + +/* Enable or disable a certain object debug messages */ +VLC_EXPORT( void, msg_EnableObjectPrinting, ( vlc_object_t *, const char * psz_object ) ); +#define msg_EnableObjectPrinting(a,b) msg_EnableObjectPrinting(VLC_OBJECT(a),b) +VLC_EXPORT( void, msg_DisableObjectPrinting, ( vlc_object_t *, const char * psz_object ) ); +#define msg_DisableObjectPrinting(a,b) msg_DisableObjectPrinting(VLC_OBJECT(a),b) + + +/** + * @} + */ + +/** + * \defgroup statistics Statistics + * + * @{ + */ -# define msg_Info __msg_Info -# define msg_Err __msg_Err -# define msg_Warn __msg_Warn -# define msg_Dbg __msg_Dbg +/**************************** + * Generic stats stuff + ****************************/ +enum +{ + STATS_LAST, + STATS_COUNTER, + STATS_MAX, + STATS_MIN, + STATS_DERIVATIVE, + STATS_TIMER +}; -#endif /* HAVE_VARIADIC_MACROS */ +struct counter_sample_t +{ + vlc_value_t value; + mtime_t date; +}; -#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 * ); +struct counter_t +{ + unsigned int i_id; + char * psz_name; + int i_type; + void * p_obj; + int i_compute_type; + int i_samples; + counter_sample_t ** pp_samples; + + mtime_t update_interval; + mtime_t last_update; +}; -#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 * ) ); +enum +{ + STATS_INPUT_BITRATE, + STATS_READ_BYTES, + STATS_READ_PACKETS, + STATS_DEMUX_READ, + STATS_DEMUX_BITRATE, + STATS_DEMUX_CORRUPTED, + STATS_DEMUX_DISCONTINUITY, + 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_BUILD, + STATS_TIMER_ML_LOAD, + STATS_TIMER_ML_DUMP, + STATS_TIMER_INTERACTION, + STATS_TIMER_PREPARSE, + STATS_TIMER_INPUT_LAUNCHING, + STATS_TIMER_MODULE_NEED, + STATS_TIMER_VIDEO_FRAME_ENCODING, + STATS_TIMER_AUDIO_FRAME_ENCODING, + + STATS_TIMER_SKINS_PLAYTREE_IMAGE, +}; +/********* + * Timing + ********/ +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_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_TimersCleanAll, (vlc_object_t * ) ); +#define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) ) + +VLC_EXPORT( void, stats_TimerClean, (vlc_object_t *, unsigned int ) ); +#define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b ) + +/** + * @} + */ +#endif