1 /*****************************************************************************
2 * messages.h: messages interface
3 * This library provides basic functions for threads to interact with user
4 * interface, such as message output.
5 *****************************************************************************
6 * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 * Samuel Hocevar <sam@zoy.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 #ifndef VLC_MESSAGES_H_
28 #define VLC_MESSAGES_H_
32 * This file defines structures and functions to handle messages and statistics gathering
38 * \defgroup messages Messages
39 * This library provides basic functions for threads to interact with user
40 * interface, such as message output.
46 * Store a single message sent to user.
50 int i_type; /**< message type, see below */
51 uintptr_t i_object_id;
52 const char *psz_object_type;
54 char * psz_msg; /**< the message itself */
55 char * psz_header; /**< Additional header */
57 mtime_t date; /**< Message date */
61 /** standard messages */
62 #define VLC_MSG_INFO 0
65 /** warning messages */
66 #define VLC_MSG_WARN 2
71 * Used by interface plugins which subscribe to the message bank.
73 typedef struct msg_subscription_t msg_subscription_t;
74 struct msg_subscription_t
83 /*****************************************************************************
85 *****************************************************************************/
86 VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
87 VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
88 #define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
89 VLC_EXPORT( void, __msg_Info, ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
90 VLC_EXPORT( void, __msg_Err, ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
91 VLC_EXPORT( void, __msg_Warn, ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
92 VLC_EXPORT( void, __msg_Dbg, ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
94 #define msg_Info( p_this, ... ) \
95 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
96 MODULE_STRING, __VA_ARGS__ )
97 #define msg_Err( p_this, ... ) \
98 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
99 MODULE_STRING, __VA_ARGS__ )
100 #define msg_Warn( p_this, ... ) \
101 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
102 MODULE_STRING, __VA_ARGS__ )
103 #define msg_Dbg( p_this, ... ) \
104 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
105 MODULE_STRING, __VA_ARGS__ )
107 #define msg_Subscribe(a) __msg_Subscribe(VLC_OBJECT(a))
108 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
109 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t * ) );
110 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
112 /* Enable or disable a certain object debug messages */
113 #define msg_EnableObjectPrinting(a,b) __msg_EnableObjectPrinting(VLC_OBJECT(a),b)
114 #define msg_DisableObjectPrinting(a,b) __msg_DisableObjectPrinting(VLC_OBJECT(a),b)
115 VLC_EXPORT( void, __msg_EnableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
116 VLC_EXPORT( void, __msg_DisableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
123 * \defgroup statistics Statistics
128 /****************************
129 * Generic stats stuff
130 ****************************/
141 struct counter_sample_t
155 counter_sample_t ** pp_samples;
157 mtime_t update_interval;
168 STATS_PLAYED_ABUFFERS,
173 STATS_CLIENT_CONNECTIONS,
174 STATS_ACTIVE_CONNECTIONS,
175 STATS_SOUT_SENT_PACKETS,
176 STATS_SOUT_SENT_BYTES,
177 STATS_SOUT_SEND_BITRATE,
178 STATS_DISPLAYED_PICTURES,
181 STATS_TIMER_PLAYLIST_BUILD,
184 STATS_TIMER_INTERACTION,
185 STATS_TIMER_PREPARSE,
186 STATS_TIMER_INPUT_LAUNCHING,
187 STATS_TIMER_MODULE_NEED,
188 STATS_TIMER_VIDEO_FRAME_ENCODING,
189 STATS_TIMER_AUDIO_FRAME_ENCODING,
191 STATS_TIMER_SKINS_PLAYTREE_IMAGE,
194 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
195 VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
196 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
197 VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
198 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
199 VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
201 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
203 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
204 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
208 vlc_value_t val; val.i_int = 0;
209 if( !p_counter ) return VLC_EGENERIC;
210 i_ret = __stats_Get( p_obj, p_counter, &val );
215 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
216 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
220 vlc_value_t val; val.f_float = 0.0;
221 if( !p_counter ) return VLC_EGENERIC;
222 i_ret = __stats_Get( p_obj, p_counter, &val );
223 *value = val.f_float;
226 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
227 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
232 vlc_value_t new_val; new_val.i_int = 0;
233 if( !p_co ) return VLC_EGENERIC;
235 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
237 *pi_new = new_val.i_int;
240 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
241 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
242 float f, float *pf_new )
246 vlc_value_t new_val;new_val.f_float = 0.0;
247 if( !p_co ) return VLC_EGENERIC;
249 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
251 *pf_new = new_val.f_float;
265 float f_input_bitrate;
266 float f_average_input_bitrate;
269 int i_demux_read_packets;
270 int i_demux_read_bytes;
271 float f_demux_bitrate;
272 float f_average_demux_bitrate;
279 int i_displayed_pictures;
285 float f_send_bitrate;
288 int i_played_abuffers;
292 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
293 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
294 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
296 /********************
299 struct global_stats_t
303 float f_input_bitrate;
304 float f_demux_bitrate;
305 float f_output_bitrate;
310 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
311 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
317 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
318 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
319 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
320 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
321 VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
322 VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
323 VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
324 VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
325 #define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
326 VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) );
328 #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
329 VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );