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.
44 /** Internal message stack context */
51 void msg_StackSet ( int, const char*, ... );
52 void msg_StackAdd ( const char*, ... );
53 const char* msg_StackMsg ( void );
56 * Store a single message sent to user.
60 int i_type; /**< message type, see below */
62 const char *psz_object_type;
64 char * psz_msg; /**< the message itself */
65 char * psz_header; /**< Additional header */
67 mtime_t date; /**< Message date */
71 /** standard messages */
72 #define VLC_MSG_INFO 0
75 /** warning messages */
76 #define VLC_MSG_WARN 2
80 #define MSG_QUEUE_NORMAL 0
81 #define MSG_QUEUE_HTTPD_ACCESS 1
84 * Used by interface plugins which subscribe to the message bank.
86 struct msg_subscription_t
95 /*****************************************************************************
97 *****************************************************************************/
98 VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, int, const char *, const char *, ... ) ATTRIBUTE_FORMAT( 5, 6 ) );
99 VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, int, const char *, const char *, va_list args ) );
100 #define msg_GenericVa(a, b, c, d, e,f) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e,f)
101 VLC_EXPORT( void, __msg_Info, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
102 VLC_EXPORT( void, __msg_Err, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
103 VLC_EXPORT( void, __msg_Warn, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
104 VLC_EXPORT( void, __msg_Dbg, ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
106 #define msg_Info( p_this, ... ) \
107 __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_INFO, \
108 MODULE_STRING, __VA_ARGS__ )
109 #define msg_Err( p_this, ... ) \
110 __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, \
111 MODULE_STRING, __VA_ARGS__ )
112 #define msg_Warn( p_this, ... ) \
113 __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, \
114 MODULE_STRING, __VA_ARGS__ )
115 #define msg_Dbg( p_this, ... ) \
116 __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, \
117 MODULE_STRING, __VA_ARGS__ )
119 #define msg_Create(a) __msg_Create(VLC_OBJECT(a))
120 #define msg_Flush(a) __msg_Flush(VLC_OBJECT(a))
121 #define msg_Destroy(a) __msg_Destroy(VLC_OBJECT(a))
122 void __msg_Create ( vlc_object_t * );
123 void __msg_Flush ( vlc_object_t * );
124 void __msg_Destroy ( vlc_object_t * );
126 #define msg_Subscribe(a,b) __msg_Subscribe(VLC_OBJECT(a),b)
127 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
128 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t *, int ) );
129 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
136 * \defgroup statistics Statistics
141 /****************************
142 * Generic stats stuff
143 ****************************/
154 struct counter_sample_t
168 counter_sample_t ** pp_samples;
170 mtime_t update_interval;
181 STATS_PLAYED_ABUFFERS,
186 STATS_CLIENT_CONNECTIONS,
187 STATS_ACTIVE_CONNECTIONS,
188 STATS_SOUT_SENT_PACKETS,
189 STATS_SOUT_SENT_BYTES,
190 STATS_SOUT_SEND_BITRATE,
191 STATS_DISPLAYED_PICTURES,
194 STATS_TIMER_PLAYLIST_BUILD,
197 STATS_TIMER_INTERACTION,
198 STATS_TIMER_PREPARSE,
199 STATS_TIMER_INPUT_LAUNCHING,
200 STATS_TIMER_MODULE_NEED,
202 STATS_TIMER_SKINS_PLAYTREE_IMAGE,
205 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
206 VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
207 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
208 VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
209 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
210 VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
212 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
214 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
215 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
219 vlc_value_t val; val.i_int = 0;
220 if( !p_counter ) return VLC_EGENERIC;
221 i_ret = __stats_Get( p_obj, p_counter, &val );
226 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
227 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
231 vlc_value_t val; val.f_float = 0.0;
232 if( !p_counter ) return VLC_EGENERIC;
233 i_ret = __stats_Get( p_obj, p_counter, &val );
234 *value = val.f_float;
237 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
238 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
243 vlc_value_t new_val; new_val.i_int = 0;
244 if( !p_co ) return VLC_EGENERIC;
246 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
248 *pi_new = new_val.i_int;
251 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
252 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
253 float f, float *pf_new )
257 vlc_value_t new_val;new_val.f_float = 0.0;
258 if( !p_co ) return VLC_EGENERIC;
260 i_ret = __stats_Update( p_obj, p_co, val, &new_val );
262 *pf_new = new_val.f_float;
276 float f_input_bitrate;
277 float f_average_input_bitrate;
280 int i_demux_read_packets;
281 int i_demux_read_bytes;
282 float f_demux_bitrate;
283 float f_average_demux_bitrate;
290 int i_displayed_pictures;
296 float f_send_bitrate;
299 int i_played_abuffers;
303 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
304 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
305 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
307 /********************
310 struct global_stats_t
314 float f_input_bitrate;
315 float f_demux_bitrate;
316 float f_output_bitrate;
321 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
322 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
329 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
330 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
331 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
332 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
334 #define stats_TimerStart(a,b,c) (void)0
335 #define stats_TimerStop(a,b) (void)0
336 #define stats_TimerDump(a,b) (void)0
337 #define stats_TimersDumpAll(a) (void)0
339 VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
340 VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
341 VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
342 VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
343 #define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
344 VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) );
346 #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
347 VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );