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 */
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
88 /** Message queue lock */
90 vlc_bool_t b_overflow
;
93 msg_item_t msg
[VLC_MSG_QSIZE
]; /**< message queue */
99 msg_subscription_t
**pp_sub
;
101 /* Logfile for WinCE */
108 * Store all data requiered by messages interfaces.
113 msg_queue_t queues
[NB_QUEUES
];
117 * Used by interface plugins which subscribe to the message bank.
119 struct msg_subscription_t
128 /*****************************************************************************
130 *****************************************************************************/
131 VLC_EXPORT( void, __msg_Generic
, ( vlc_object_t
*, int, int, const char *, const char *, ... ) ATTRIBUTE_FORMAT( 5, 6 ) );
132 VLC_EXPORT( void, __msg_GenericVa
, ( vlc_object_t
*, int, int, const char *, const char *, va_list args
) );
133 #define msg_GenericVa(a, b, c, d, e,f) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e,f)
134 VLC_EXPORT( void, __msg_Info
, ( vlc_object_t
*, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
135 VLC_EXPORT( void, __msg_Err
, ( vlc_object_t
*, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
136 VLC_EXPORT( void, __msg_Warn
, ( vlc_object_t
*, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
137 VLC_EXPORT( void, __msg_Dbg
, ( vlc_object_t
*, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
139 #define msg_Info( p_this, ... ) \
140 __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_INFO, \
141 MODULE_STRING, __VA_ARGS__ )
142 #define msg_Err( p_this, ... ) \
143 __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, \
144 MODULE_STRING, __VA_ARGS__ )
145 #define msg_Warn( p_this, ... ) \
146 __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, \
147 MODULE_STRING, __VA_ARGS__ )
148 #define msg_Dbg( p_this, ... ) \
149 __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, \
150 MODULE_STRING, __VA_ARGS__ )
152 #define msg_Create(a) __msg_Create(VLC_OBJECT(a))
153 #define msg_Flush(a) __msg_Flush(VLC_OBJECT(a))
154 #define msg_Destroy(a) __msg_Destroy(VLC_OBJECT(a))
155 void __msg_Create ( vlc_object_t
* );
156 void __msg_Flush ( vlc_object_t
* );
157 void __msg_Destroy ( vlc_object_t
* );
159 #define msg_Subscribe(a,b) __msg_Subscribe(VLC_OBJECT(a),b)
160 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
161 VLC_EXPORT( msg_subscription_t
*, __msg_Subscribe
, ( vlc_object_t
*, int ) );
162 VLC_EXPORT( void, __msg_Unsubscribe
, ( vlc_object_t
*, msg_subscription_t
* ) );
164 VLC_EXPORT(const char *, msg_GetObjectTypeName
, (int i_object_type
));
171 * \defgroup statistics Statistics
176 /****************************
177 * Generic stats stuff
178 ****************************/
189 struct counter_sample_t
202 counter_sample_t
** pp_samples
;
204 mtime_t update_interval
;
215 STATS_PLAYED_ABUFFERS
,
220 STATS_CLIENT_CONNECTIONS
,
221 STATS_ACTIVE_CONNECTIONS
,
222 STATS_SOUT_SENT_PACKETS
,
223 STATS_SOUT_SENT_BYTES
,
224 STATS_SOUT_SEND_BITRATE
,
225 STATS_DISPLAYED_PICTURES
,
228 STATS_TIMER_PLAYLIST_BUILD
,
231 STATS_TIMER_INTERACTION
,
232 STATS_TIMER_PREPARSE
,
234 STATS_TIMER_SKINS_PLAYTREE_IMAGE
,
237 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
238 VLC_EXPORT( int, __stats_Update
, (vlc_object_t
*, counter_t
*, vlc_value_t
, vlc_value_t
*) );
239 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
240 VLC_EXPORT( counter_t
*, __stats_CounterCreate
, (vlc_object_t
*, int, int) );
241 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
242 VLC_EXPORT( int, __stats_Get
, (vlc_object_t
*, counter_t
*, vlc_value_t
*) );
244 VLC_EXPORT (void, stats_CounterClean
, (counter_t
* ) );
246 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
247 static inline int __stats_GetInteger( vlc_object_t
*p_obj
, counter_t
*p_counter
,
251 vlc_value_t val
; val
.i_int
= 0;
252 if( !p_counter
) return VLC_EGENERIC
;
253 i_ret
= __stats_Get( p_obj
, p_counter
, &val
);
258 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
259 static inline int __stats_GetFloat( vlc_object_t
*p_obj
, counter_t
*p_counter
,
263 vlc_value_t val
; val
.f_float
= 0.0;
264 if( !p_counter
) return VLC_EGENERIC
;
265 i_ret
= __stats_Get( p_obj
, p_counter
, &val
);
266 *value
= val
.f_float
;
269 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
270 static inline int __stats_UpdateInteger( vlc_object_t
*p_obj
,counter_t
*p_co
,
275 vlc_value_t new_val
; new_val
.i_int
= 0;
276 if( !p_co
) return VLC_EGENERIC
;
278 i_ret
= __stats_Update( p_obj
, p_co
, val
, &new_val
);
280 *pi_new
= new_val
.i_int
;
283 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
284 static inline int __stats_UpdateFloat( vlc_object_t
*p_obj
, counter_t
*p_co
,
285 float f
, float *pf_new
)
289 vlc_value_t new_val
;new_val
.f_float
= 0.0;
290 if( !p_co
) return VLC_EGENERIC
;
292 i_ret
= __stats_Update( p_obj
, p_co
, val
, &new_val
);
294 *pf_new
= new_val
.f_float
;
308 float f_input_bitrate
;
309 float f_average_input_bitrate
;
312 int i_demux_read_packets
;
313 int i_demux_read_bytes
;
314 float f_demux_bitrate
;
315 float f_average_demux_bitrate
;
322 int i_displayed_pictures
;
328 float f_send_bitrate
;
331 int i_played_abuffers
;
335 VLC_EXPORT( void, stats_ComputeInputStats
, (input_thread_t
*, input_stats_t
*) );
336 VLC_EXPORT( void, stats_ReinitInputStats
, (input_stats_t
*) );
337 VLC_EXPORT( void, stats_DumpInputStats
, (input_stats_t
*) );
339 /********************
342 struct global_stats_t
346 float f_input_bitrate
;
347 float f_demux_bitrate
;
348 float f_output_bitrate
;
353 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
354 VLC_EXPORT( void, __stats_ComputeGlobalStats
, (vlc_object_t
*,global_stats_t
*));
361 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
362 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
363 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
364 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
366 #define stats_TimerStart(a,b,c) {}
367 #define stats_TimerStop(a,b) {}
368 #define stats_TimerDump(a,b) {}
369 #define stats_TimersDumpAll(a) {}
371 VLC_EXPORT( void,__stats_TimerStart
, (vlc_object_t
*, const char *, unsigned int ) );
372 VLC_EXPORT( void,__stats_TimerStop
, (vlc_object_t
*, unsigned int) );
373 VLC_EXPORT( void,__stats_TimerDump
, (vlc_object_t
*, unsigned int) );
374 VLC_EXPORT( void,__stats_TimersDumpAll
, (vlc_object_t
*) );
375 #define stats_TimersClean(a) __stats_TimersClean( VLC_OBJECT(a) )
376 VLC_EXPORT( void, __stats_TimersClean
, (vlc_object_t
* ) );