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_
33 * \defgroup messages Messages
34 * This library provides basic functions for threads to interact with user
35 * interface, such as message output.
41 * Store a single message sent to user.
45 int i_type
; /**< message type, see below */
47 const char *psz_object_type
;
49 char * psz_msg
; /**< the message itself */
50 char * psz_header
; /**< Additional header */
52 mtime_t date
; /**< Message date */
56 /** standard messages */
57 #define VLC_MSG_INFO 0
60 /** warning messages */
61 #define VLC_MSG_WARN 2
66 * Used by interface plugins which subscribe to the message bank.
68 struct msg_subscription_t
77 /*****************************************************************************
79 *****************************************************************************/
80 VLC_EXPORT( void, __msg_Generic
, ( vlc_object_t
*, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
81 VLC_EXPORT( void, __msg_GenericVa
, ( vlc_object_t
*, int, const char *, const char *, va_list args
) );
82 #define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
83 VLC_EXPORT( void, __msg_Info
, ( vlc_object_t
*, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
84 VLC_EXPORT( void, __msg_Err
, ( vlc_object_t
*, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
85 VLC_EXPORT( void, __msg_Warn
, ( vlc_object_t
*, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
86 VLC_EXPORT( void, __msg_Dbg
, ( vlc_object_t
*, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
88 #define msg_Info( p_this, ... ) \
89 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
90 MODULE_STRING, __VA_ARGS__ )
91 #define msg_Err( p_this, ... ) \
92 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
93 MODULE_STRING, __VA_ARGS__ )
94 #define msg_Warn( p_this, ... ) \
95 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
96 MODULE_STRING, __VA_ARGS__ )
97 #define msg_Dbg( p_this, ... ) \
98 __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
99 MODULE_STRING, __VA_ARGS__ )
101 #define msg_Subscribe(a) __msg_Subscribe(VLC_OBJECT(a))
102 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
103 VLC_EXPORT( msg_subscription_t
*, __msg_Subscribe
, ( vlc_object_t
* ) );
104 VLC_EXPORT( void, __msg_Unsubscribe
, ( vlc_object_t
*, msg_subscription_t
* ) );
111 * \defgroup statistics Statistics
116 /****************************
117 * Generic stats stuff
118 ****************************/
129 struct counter_sample_t
143 counter_sample_t
** pp_samples
;
145 mtime_t update_interval
;
156 STATS_PLAYED_ABUFFERS
,
161 STATS_CLIENT_CONNECTIONS
,
162 STATS_ACTIVE_CONNECTIONS
,
163 STATS_SOUT_SENT_PACKETS
,
164 STATS_SOUT_SENT_BYTES
,
165 STATS_SOUT_SEND_BITRATE
,
166 STATS_DISPLAYED_PICTURES
,
169 STATS_TIMER_PLAYLIST_BUILD
,
172 STATS_TIMER_INTERACTION
,
173 STATS_TIMER_PREPARSE
,
174 STATS_TIMER_INPUT_LAUNCHING
,
175 STATS_TIMER_MODULE_NEED
,
176 STATS_TIMER_VIDEO_FRAME_ENCODING
,
177 STATS_TIMER_AUDIO_FRAME_ENCODING
,
179 STATS_TIMER_SKINS_PLAYTREE_IMAGE
,
182 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
183 VLC_EXPORT( int, __stats_Update
, (vlc_object_t
*, counter_t
*, vlc_value_t
, vlc_value_t
*) );
184 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
185 VLC_EXPORT( counter_t
*, __stats_CounterCreate
, (vlc_object_t
*, int, int) );
186 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
187 VLC_EXPORT( int, __stats_Get
, (vlc_object_t
*, counter_t
*, vlc_value_t
*) );
189 VLC_EXPORT (void, stats_CounterClean
, (counter_t
* ) );
191 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
192 static inline int __stats_GetInteger( vlc_object_t
*p_obj
, counter_t
*p_counter
,
196 vlc_value_t val
; val
.i_int
= 0;
197 if( !p_counter
) return VLC_EGENERIC
;
198 i_ret
= __stats_Get( p_obj
, p_counter
, &val
);
203 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
204 static inline int __stats_GetFloat( vlc_object_t
*p_obj
, counter_t
*p_counter
,
208 vlc_value_t val
; val
.f_float
= 0.0;
209 if( !p_counter
) return VLC_EGENERIC
;
210 i_ret
= __stats_Get( p_obj
, p_counter
, &val
);
211 *value
= val
.f_float
;
214 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
215 static inline int __stats_UpdateInteger( vlc_object_t
*p_obj
,counter_t
*p_co
,
220 vlc_value_t new_val
; new_val
.i_int
= 0;
221 if( !p_co
) return VLC_EGENERIC
;
223 i_ret
= __stats_Update( p_obj
, p_co
, val
, &new_val
);
225 *pi_new
= new_val
.i_int
;
228 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
229 static inline int __stats_UpdateFloat( vlc_object_t
*p_obj
, counter_t
*p_co
,
230 float f
, float *pf_new
)
234 vlc_value_t new_val
;new_val
.f_float
= 0.0;
235 if( !p_co
) return VLC_EGENERIC
;
237 i_ret
= __stats_Update( p_obj
, p_co
, val
, &new_val
);
239 *pf_new
= new_val
.f_float
;
253 float f_input_bitrate
;
254 float f_average_input_bitrate
;
257 int i_demux_read_packets
;
258 int i_demux_read_bytes
;
259 float f_demux_bitrate
;
260 float f_average_demux_bitrate
;
267 int i_displayed_pictures
;
273 float f_send_bitrate
;
276 int i_played_abuffers
;
280 VLC_EXPORT( void, stats_ComputeInputStats
, (input_thread_t
*, input_stats_t
*) );
281 VLC_EXPORT( void, stats_ReinitInputStats
, (input_stats_t
*) );
282 VLC_EXPORT( void, stats_DumpInputStats
, (input_stats_t
*) );
284 /********************
287 struct global_stats_t
291 float f_input_bitrate
;
292 float f_demux_bitrate
;
293 float f_output_bitrate
;
298 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
299 VLC_EXPORT( void, __stats_ComputeGlobalStats
, (vlc_object_t
*,global_stats_t
*));
305 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
306 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
307 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
308 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
309 VLC_EXPORT( void,__stats_TimerStart
, (vlc_object_t
*, const char *, unsigned int ) );
310 VLC_EXPORT( void,__stats_TimerStop
, (vlc_object_t
*, unsigned int) );
311 VLC_EXPORT( void,__stats_TimerDump
, (vlc_object_t
*, unsigned int) );
312 VLC_EXPORT( void,__stats_TimersDumpAll
, (vlc_object_t
*) );
313 #define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
314 VLC_EXPORT( void, __stats_TimersCleanAll
, (vlc_object_t
* ) );
316 #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
317 VLC_EXPORT( void, __stats_TimerClean
, (vlc_object_t
*, unsigned int ) );