/***************************************************************************** * 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 * $Id: 80fc1b3e2002b26b4b65a0841400dc9a52debec4 $ * * 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 * (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. * * 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. *****************************************************************************/ #ifndef VLC_MESSAGES_H_ #define VLC_MESSAGES_H_ /** * \file * This file defines structures and functions to handle messages and statistics gathering */ #include /** * \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 */ uintptr_t 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 */ gc_object_t vlc_gc_data; } 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 static inline msg_item_t *msg_Hold (msg_item_t *msg) { vlc_hold (&msg->vlc_gc_data); return msg; } static inline void msg_Release (msg_item_t *msg) { vlc_release (&msg->vlc_gc_data); } /** * 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 *, ... ) 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 * ) ); VLC_EXPORT( void, msg_Unsubscribe, ( msg_subscription_t * ) ); /* 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 * * @{ */ /**************************** * 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 { 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; }; 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