Remove dead functions
[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
90 #define msg_Info( p_this, ... ) \
91       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
92                      MODULE_STRING, __VA_ARGS__ )
93 #define msg_Err( p_this, ... ) \
94       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
95                      MODULE_STRING, __VA_ARGS__ )
96 #define msg_Warn( p_this, ... ) \
97       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
98                      MODULE_STRING, __VA_ARGS__ )
99 #define msg_Dbg( p_this, ... ) \
100       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
101                      MODULE_STRING, __VA_ARGS__ )
102
103 #define msg_Subscribe(a) __msg_Subscribe(VLC_OBJECT(a))
104 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
105 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t * ) );
106 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
107
108 /* Enable or disable a certain object debug messages */
109 #define msg_EnableObjectPrinting(a,b) __msg_EnableObjectPrinting(VLC_OBJECT(a),b)
110 #define msg_DisableObjectPrinting(a,b) __msg_DisableObjectPrinting(VLC_OBJECT(a),b)
111 VLC_EXPORT( void, __msg_EnableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
112 VLC_EXPORT( void, __msg_DisableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
113
114 /**
115  * @}
116  */
117
118 /**
119  * \defgroup statistics Statistics
120  *
121  * @{
122  */
123
124 /****************************
125  * Generic stats stuff
126  ****************************/
127 enum
128 {
129     STATS_LAST,
130     STATS_COUNTER,
131     STATS_MAX,
132     STATS_MIN,
133     STATS_DERIVATIVE,
134     STATS_TIMER
135 };
136
137 struct counter_sample_t
138 {
139     vlc_value_t value;
140     mtime_t     date;
141 };
142
143 struct counter_t
144 {
145     unsigned int        i_id;
146     char              * psz_name;
147     int                 i_type;
148     void              * p_obj;
149     int                 i_compute_type;
150     int                 i_samples;
151     counter_sample_t ** pp_samples;
152
153     mtime_t             update_interval;
154     mtime_t             last_update;
155 };
156
157 enum
158 {
159     STATS_INPUT_BITRATE,
160     STATS_READ_BYTES,
161     STATS_READ_PACKETS,
162     STATS_DEMUX_READ,
163     STATS_DEMUX_BITRATE,
164     STATS_PLAYED_ABUFFERS,
165     STATS_LOST_ABUFFERS,
166     STATS_DECODED_AUDIO,
167     STATS_DECODED_VIDEO,
168     STATS_DECODED_SUB,
169     STATS_CLIENT_CONNECTIONS,
170     STATS_ACTIVE_CONNECTIONS,
171     STATS_SOUT_SENT_PACKETS,
172     STATS_SOUT_SENT_BYTES,
173     STATS_SOUT_SEND_BITRATE,
174     STATS_DISPLAYED_PICTURES,
175     STATS_LOST_PICTURES,
176
177     STATS_TIMER_PLAYLIST_BUILD,
178     STATS_TIMER_ML_LOAD,
179     STATS_TIMER_ML_DUMP,
180     STATS_TIMER_INTERACTION,
181     STATS_TIMER_PREPARSE,
182     STATS_TIMER_INPUT_LAUNCHING,
183     STATS_TIMER_MODULE_NEED,
184     STATS_TIMER_VIDEO_FRAME_ENCODING,
185     STATS_TIMER_AUDIO_FRAME_ENCODING,
186
187     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
188 };
189
190 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
191 VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
192 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
193 VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
194 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
195 VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
196
197 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
198
199 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
200 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
201                                       int *value )
202 {
203     int i_ret;
204     vlc_value_t val; val.i_int = 0;
205     if( !p_counter ) return VLC_EGENERIC;
206     i_ret = __stats_Get( p_obj, p_counter, &val );
207     *value = val.i_int;
208     return i_ret;
209 }
210
211 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
212 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
213                                     float *value )
214 {
215     int i_ret;
216     vlc_value_t val; val.f_float = 0.0;
217     if( !p_counter ) return VLC_EGENERIC;
218     i_ret = __stats_Get( p_obj, p_counter, &val );
219     *value = val.f_float;
220     return i_ret;
221 }
222 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
223 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
224                                          int i, int *pi_new )
225 {
226     int i_ret;
227     vlc_value_t val;
228     vlc_value_t new_val; new_val.i_int = 0;
229     if( !p_co ) return VLC_EGENERIC;
230     val.i_int = i;
231     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
232     if( pi_new )
233         *pi_new = new_val.i_int;
234     return i_ret;
235 }
236 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
237 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
238                                        float f, float *pf_new )
239 {
240     vlc_value_t val;
241     int i_ret;
242     vlc_value_t new_val;new_val.f_float = 0.0;
243     if( !p_co ) return VLC_EGENERIC;
244     val.f_float = f;
245     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
246     if( pf_new )
247         *pf_new = new_val.f_float;
248     return i_ret;
249 }
250
251 /******************
252  * Input stats
253  ******************/
254 struct input_stats_t
255 {
256     vlc_mutex_t         lock;
257
258     /* Input */
259     int i_read_packets;
260     int i_read_bytes;
261     float f_input_bitrate;
262     float f_average_input_bitrate;
263
264     /* Demux */
265     int i_demux_read_packets;
266     int i_demux_read_bytes;
267     float f_demux_bitrate;
268     float f_average_demux_bitrate;
269
270     /* Decoders */
271     int i_decoded_audio;
272     int i_decoded_video;
273
274     /* Vout */
275     int i_displayed_pictures;
276     int i_lost_pictures;
277
278     /* Sout */
279     int i_sent_packets;
280     int i_sent_bytes;
281     float f_send_bitrate;
282
283     /* Aout */
284     int i_played_abuffers;
285     int i_lost_abuffers;
286 };
287
288 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
289 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
290 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
291
292 /********************
293  * Global stats
294  *******************/
295 struct global_stats_t
296 {
297     vlc_mutex_t lock;
298
299     float f_input_bitrate;
300     float f_demux_bitrate;
301     float f_output_bitrate;
302
303     int i_http_clients;
304 };
305
306 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
307 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
308
309
310 /*********
311  * Timing
312  ********/
313 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
314 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
315 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
316 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
317 VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
318 VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
319 VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
320 VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
321 #define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
322 VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) );
323
324 #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
325 VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );
326
327 #endif