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 #if !defined( __LIBVLC__ )
28 #error You are not libvlc or one of its plugins. You cannot include this file
31 #ifndef _VLC_MESSAGES_H_
32 #define _VLC_MESSAGES_H_
37 * \defgroup messages Messages
38 * This library provides basic functions for threads to interact with user
39 * interface, such as message output.
45 * Store a single message sent to user.
49 int i_type; /**< message type, see below */
51 const char *psz_object_type;
53 char * psz_msg; /**< the message itself */
54 char * psz_header; /**< Additional header */
56 mtime_t date; /**< Message date */
60 /** standard messages */
61 #define VLC_MSG_INFO 0
64 /** warning messages */
65 #define VLC_MSG_WARN 2
70 * Used by interface plugins which subscribe to the message bank.
72 struct msg_subscription_t
81 /*****************************************************************************
83 *****************************************************************************/
84 VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) ATTRIBUTE_FORMAT( 4, 5 ) );
85 VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
86 #define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
87 VLC_EXPORT( void, __msg_Info, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
88 VLC_EXPORT( void, __msg_Err, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
89 VLC_EXPORT( void, __msg_Warn, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
90 VLC_EXPORT( void, __msg_Dbg, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
92 #define msg_Info( p_this, ... ) \
93 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
94 MODULE_STRING, __VA_ARGS__ )
95 #define msg_Err( p_this, ... ) \
96 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
97 MODULE_STRING, __VA_ARGS__ )
98 #define msg_Warn( p_this, ... ) \
99 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
100 MODULE_STRING, __VA_ARGS__ )
101 #define msg_Dbg( p_this, ... ) \
102 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
103 MODULE_STRING, __VA_ARGS__ )
105 #define msg_Subscribe(a) __msg_Subscribe(VLC_OBJECT(a))
106 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
107 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t * ) );
108 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
115 * \defgroup statistics Statistics
120 /****************************
121 * Generic stats stuff
122 ****************************/
133 struct counter_sample_t
147 counter_sample_t ** pp_samples;
149 mtime_t update_interval;
160 STATS_PLAYED_ABUFFERS,
165 STATS_CLIENT_CONNECTIONS,
166 STATS_ACTIVE_CONNECTIONS,
167 STATS_SOUT_SENT_PACKETS,
168 STATS_SOUT_SENT_BYTES,
169 STATS_SOUT_SEND_BITRATE,
170 STATS_DISPLAYED_PICTURES,
173 STATS_TIMER_PLAYLIST_BUILD,
176 STATS_TIMER_INTERACTION,
177 STATS_TIMER_PREPARSE,
178 STATS_TIMER_INPUT_LAUNCHING,
179 STATS_TIMER_MODULE_NEED,
181 STATS_TIMER_SKINS_PLAYTREE_IMAGE,
184 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
185 VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
186 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
187 VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
188 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
189 VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
191 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
193 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
194 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
198 vlc_value_t val; val.i_int = 0;
199 if( !p_counter ) return VLC_EGENERIC;
200 i_ret = __stats_Get( p_obj, p_counter, &val );
205 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
206 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
210 vlc_value_t val; val.f_float = 0.0;
211 if( !p_counter ) return VLC_EGENERIC;
212 i_ret = __stats_Get( p_obj, p_counter, &val );
213 *value = val.f_float;
216 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
217 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
222 vlc_value_t new_val; new_val.i_int = 0;
223 if( !p_co ) return VLC_EGENERIC;
225 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
227 *pi_new = new_val.i_int;
230 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
231 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
232 float f, float *pf_new )
236 vlc_value_t new_val;new_val.f_float = 0.0;
237 if( !p_co ) return VLC_EGENERIC;
239 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
241 *pf_new = new_val.f_float;
255 float f_input_bitrate;
256 float f_average_input_bitrate;
259 int i_demux_read_packets;
260 int i_demux_read_bytes;
261 float f_demux_bitrate;
262 float f_average_demux_bitrate;
269 int i_displayed_pictures;
275 float f_send_bitrate;
278 int i_played_abuffers;
282 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
283 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
284 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
286 /********************
289 struct global_stats_t
293 float f_input_bitrate;
294 float f_demux_bitrate;
295 float f_output_bitrate;
300 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
301 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
308 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
309 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
310 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
311 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
313 #define stats_TimerStart(a,b,c) (void)0
314 #define stats_TimerStop(a,b) (void)0
315 #define stats_TimerDump(a,b) (void)0
316 #define stats_TimersDumpAll(a) (void)0
318 VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
319 VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
320 VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
321 VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
322 #define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
323 VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) );
325 #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
326 VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );