92b57d4e6595e9920df8051f90b708fd03ccdf51
[vlc.git] / include / vlc_messages.h
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
7  * $Id$
8  *
9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
10  *          Samuel Hocevar <sam@zoy.org>
11  *
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.
16  *
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.
21  *
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  *****************************************************************************/
26
27 #ifndef VLC_MESSAGES_H_
28 #define VLC_MESSAGES_H_
29
30 /**
31  * \file
32  * This file defines structures and functions to handle messages and statistics gathering
33  */
34
35 #include <stdarg.h>
36
37 /**
38  * \defgroup messages Messages
39  * This library provides basic functions for threads to interact with user
40  * interface, such as message output.
41  *
42  * @{
43  */
44
45 /**
46  * Store a single message sent to user.
47  */
48 typedef struct
49 {
50     int     i_type;                             /**< message type, see below */
51     uintptr_t   i_object_id;
52     const char *psz_object_type;
53     char *  psz_module;
54     char *  psz_msg;                            /**< the message itself */
55     char *  psz_header;                         /**< Additional header */
56
57     mtime_t date;                               /**< Message date */
58 } msg_item_t;
59
60 /* Message types */
61 /** standard messages */
62 #define VLC_MSG_INFO  0
63 /** error messages */
64 #define VLC_MSG_ERR   1
65 /** warning messages */
66 #define VLC_MSG_WARN  2
67 /** debug messages */
68 #define VLC_MSG_DBG   3
69
70 /**
71  * Used by interface plugins which subscribe to the message bank.
72  */
73 typedef struct msg_subscription_t msg_subscription_t;
74 struct msg_subscription_t
75 {
76     int   i_start;
77     int*  pi_stop;
78
79     msg_item_t*  p_msg;
80     vlc_mutex_t* p_lock;
81 };
82
83 /*****************************************************************************
84  * Prototypes
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 ) );
93
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__ )
106
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 * ) );
111
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 ) );
117
118 /**
119  * @}
120  */
121
122 /**
123  * \defgroup statistics Statistics
124  *
125  * @{
126  */
127
128 /****************************
129  * Generic stats stuff
130  ****************************/
131 enum
132 {
133     STATS_LAST,
134     STATS_COUNTER,
135     STATS_MAX,
136     STATS_MIN,
137     STATS_DERIVATIVE,
138     STATS_TIMER
139 };
140
141 struct counter_sample_t
142 {
143     vlc_value_t value;
144     mtime_t     date;
145 };
146
147 struct counter_t
148 {
149     unsigned int        i_id;
150     char              * psz_name;
151     int                 i_type;
152     void              * p_obj;
153     int                 i_compute_type;
154     int                 i_samples;
155     counter_sample_t ** pp_samples;
156
157     mtime_t             update_interval;
158     mtime_t             last_update;
159 };
160
161 enum
162 {
163     STATS_INPUT_BITRATE,
164     STATS_READ_BYTES,
165     STATS_READ_PACKETS,
166     STATS_DEMUX_READ,
167     STATS_DEMUX_BITRATE,
168     STATS_PLAYED_ABUFFERS,
169     STATS_LOST_ABUFFERS,
170     STATS_DECODED_AUDIO,
171     STATS_DECODED_VIDEO,
172     STATS_DECODED_SUB,
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,
179     STATS_LOST_PICTURES,
180
181     STATS_TIMER_PLAYLIST_BUILD,
182     STATS_TIMER_ML_LOAD,
183     STATS_TIMER_ML_DUMP,
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,
190
191     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
192 };
193
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*) );
200
201 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
202
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,
205                                       int *value )
206 {
207     int i_ret;
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 );
211     *value = val.i_int;
212     return i_ret;
213 }
214
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,
217                                     float *value )
218 {
219     int i_ret;
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;
224     return i_ret;
225 }
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,
228                                          int i, int *pi_new )
229 {
230     int i_ret;
231     vlc_value_t val;
232     vlc_value_t new_val; new_val.i_int = 0;
233     if( !p_co ) return VLC_EGENERIC;
234     val.i_int = i;
235     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
236     if( pi_new )
237         *pi_new = new_val.i_int;
238     return i_ret;
239 }
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 )
243 {
244     vlc_value_t val;
245     int i_ret;
246     vlc_value_t new_val;new_val.f_float = 0.0;
247     if( !p_co ) return VLC_EGENERIC;
248     val.f_float = f;
249     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
250     if( pf_new )
251         *pf_new = new_val.f_float;
252     return i_ret;
253 }
254
255 /******************
256  * Input stats
257  ******************/
258 struct input_stats_t
259 {
260     vlc_mutex_t         lock;
261
262     /* Input */
263     int i_read_packets;
264     int i_read_bytes;
265     float f_input_bitrate;
266     float f_average_input_bitrate;
267
268     /* Demux */
269     int i_demux_read_packets;
270     int i_demux_read_bytes;
271     float f_demux_bitrate;
272     float f_average_demux_bitrate;
273
274     /* Decoders */
275     int i_decoded_audio;
276     int i_decoded_video;
277
278     /* Vout */
279     int i_displayed_pictures;
280     int i_lost_pictures;
281
282     /* Sout */
283     int i_sent_packets;
284     int i_sent_bytes;
285     float f_send_bitrate;
286
287     /* Aout */
288     int i_played_abuffers;
289     int i_lost_abuffers;
290 };
291
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 *) );
295
296 /********************
297  * Global stats
298  *******************/
299 struct global_stats_t
300 {
301     vlc_mutex_t lock;
302
303     float f_input_bitrate;
304     float f_demux_bitrate;
305     float f_output_bitrate;
306
307     int i_http_clients;
308 };
309
310 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
311 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
312
313
314 /*********
315  * Timing
316  ********/
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 * ) );
327
328 #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
329 VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );
330
331 #endif