8ca7ff0c4a0f15faf7fb9d601df5ae4a81ca9cc1
[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 #if !defined( __LIBVLC__ )
28   #error You are not libvlc or one of its plugins. You cannot include this file
29 #endif
30
31 #ifndef _VLC_MESSAGES_H_
32 #define _VLC_MESSAGES_H_
33
34 #include <stdarg.h>
35
36 /**
37  * \defgroup messages Messages
38  * This library provides basic functions for threads to interact with user
39  * interface, such as message output.
40  *
41  * @{
42  */
43
44 /** Internal message stack context */
45 typedef struct
46 {
47     int i_code;
48     char * psz_message;
49 } msg_context_t;
50
51 void msg_StackSet ( int, const char*, ... );
52 void msg_StackAdd ( const char*, ... );
53 const char* msg_StackMsg ( void );
54
55 /**
56  * Store a single message sent to user.
57  */
58 typedef struct
59 {
60     int     i_type;                             /**< message type, see below */
61     int     i_object_id;
62     int     i_object_type;
63     char *  psz_module;
64     char *  psz_msg;                            /**< the message itself */
65     char *  psz_header;                         /**< Additional header */
66
67     mtime_t date;                               /**< Message date */
68 } msg_item_t;
69
70 /* Message types */
71 /** standard messages */
72 #define VLC_MSG_INFO  0
73 /** error messages */
74 #define VLC_MSG_ERR   1
75 /** warning messages */
76 #define VLC_MSG_WARN  2
77 /** debug messages */
78 #define VLC_MSG_DBG   3
79
80 #define MSG_QUEUE_NORMAL 0
81 #define MSG_QUEUE_HTTPD_ACCESS 1
82 #define NB_QUEUES 2
83
84 struct msg_queue_t
85 {
86     int                     i_id;
87
88     /** Message queue lock */
89     vlc_mutex_t             lock;
90     vlc_bool_t              b_overflow;
91
92     /* Message queue */
93     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
94     int i_start;
95     int i_stop;
96
97     /* Subscribers */
98     int i_sub;
99     msg_subscription_t **pp_sub;
100
101     /* Logfile for WinCE */
102 #ifdef UNDER_CE
103     FILE *logfile;
104 #endif
105 };
106
107 /**
108  * Store all data requiered by messages interfaces.
109  */
110 struct msg_bank_t
111 {
112     vlc_mutex_t             lock;
113     msg_queue_t             queues[NB_QUEUES];
114 };
115
116 /**
117  * Used by interface plugins which subscribe to the message bank.
118  */
119 struct msg_subscription_t
120 {
121     int   i_start;
122     int*  pi_stop;
123
124     msg_item_t*  p_msg;
125     vlc_mutex_t* p_lock;
126 };
127
128 /*****************************************************************************
129  * Prototypes
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 ) );
138
139 #ifdef HAVE_VARIADIC_MACROS
140
141 #   define msg_Info( p_this, psz_format, args... ) \
142       __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING, \
143                      psz_format, ## args )
144
145 #   define msg_Err( p_this, psz_format, args... ) \
146       __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING, \
147                      psz_format, ## args )
148
149 #   define msg_Warn( p_this, psz_format, args... ) \
150       __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING, \
151                      psz_format, ## args )
152
153 #   define msg_Dbg( p_this, psz_format, args... ) \
154       __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING, \
155                      psz_format, ## args )
156
157 #elif defined(_MSC_VER) /* To avoid warnings and even errors with c++ files */
158
159 inline void msg_Info( void *p_this, const char *psz_format, ... )
160 {
161   va_list ap;
162   va_start( ap, psz_format );
163   __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING,
164                    psz_format, ap );
165   va_end(ap);
166 }
167 inline void msg_Err( void *p_this, const char *psz_format, ... )
168 {
169   va_list ap;
170   va_start( ap, psz_format );
171   __msg_GenericVa( ( vlc_object_t *)p_this,MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING,
172                    psz_format, ap );
173   va_end(ap);
174 }
175 inline void msg_Warn( void *p_this, const char *psz_format, ... )
176 {
177   va_list ap;
178   va_start( ap, psz_format );
179   __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING,
180                    psz_format, ap );
181   va_end(ap);
182 }
183 inline void msg_Dbg( void *p_this, const char *psz_format, ... )
184 {
185   va_list ap;
186   va_start( ap, psz_format );
187   __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING,
188                    psz_format, ap );
189   va_end(ap);
190 }
191
192 #else /* _MSC_VER */
193
194 #   define msg_Info __msg_Info
195 #   define msg_Err __msg_Err
196 #   define msg_Warn __msg_Warn
197 #   define msg_Dbg __msg_Dbg
198
199 #endif /* HAVE_VARIADIC_MACROS */
200
201 #define msg_Create(a) __msg_Create(VLC_OBJECT(a))
202 #define msg_Flush(a) __msg_Flush(VLC_OBJECT(a))
203 #define msg_Destroy(a) __msg_Destroy(VLC_OBJECT(a))
204 void __msg_Create  ( vlc_object_t * );
205 void __msg_Flush   ( vlc_object_t * );
206 void __msg_Destroy ( vlc_object_t * );
207
208 #define msg_Subscribe(a,b) __msg_Subscribe(VLC_OBJECT(a),b)
209 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
210 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t *, int ) );
211 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
212
213 VLC_EXPORT(const char *, msg_GetObjectTypeName, (int i_object_type ));
214
215 /**
216  * @}
217  */
218
219 /**
220  * \defgroup statistics Statistics
221  *
222  * @{
223  */
224
225 /****************************
226  * Generic stats stuff
227  ****************************/
228 enum
229 {
230     STATS_LAST,
231     STATS_COUNTER,
232     STATS_MAX,
233     STATS_MIN,
234     STATS_DERIVATIVE,
235     STATS_TIMER
236 };
237
238 struct counter_sample_t
239 {
240     vlc_value_t value;
241     mtime_t     date;
242 };
243
244 struct counter_t
245 {
246     unsigned int        i_id;
247     char              * psz_name;
248     int                 i_type;
249     int                 i_compute_type;
250     int                 i_samples;
251     counter_sample_t ** pp_samples;
252
253     mtime_t             update_interval;
254     mtime_t             last_update;
255 };
256
257 enum
258 {
259     STATS_INPUT_BITRATE,
260     STATS_READ_BYTES,
261     STATS_READ_PACKETS,
262     STATS_DEMUX_READ,
263     STATS_DEMUX_BITRATE,
264     STATS_PLAYED_ABUFFERS,
265     STATS_LOST_ABUFFERS,
266     STATS_DECODED_AUDIO,
267     STATS_DECODED_VIDEO,
268     STATS_DECODED_SUB,
269     STATS_CLIENT_CONNECTIONS,
270     STATS_ACTIVE_CONNECTIONS,
271     STATS_SOUT_SENT_PACKETS,
272     STATS_SOUT_SENT_BYTES,
273     STATS_SOUT_SEND_BITRATE,
274     STATS_DISPLAYED_PICTURES,
275     STATS_LOST_PICTURES,
276
277     STATS_TIMER_PLAYLIST_BUILD,
278     STATS_TIMER_ML_LOAD,
279     STATS_TIMER_ML_DUMP,
280     STATS_TIMER_INTERACTION,
281     STATS_TIMER_PREPARSE,
282
283     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
284 };
285
286 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
287 VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
288 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
289 VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
290 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
291 VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
292
293 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
294
295 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
296 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
297                                       int *value )
298 {
299     int i_ret;
300     vlc_value_t val; val.i_int = 0;
301     if( !p_counter ) return VLC_EGENERIC;
302     i_ret = __stats_Get( p_obj, p_counter, &val );
303     *value = val.i_int;
304     return i_ret;
305 }
306
307 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
308 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
309                                     float *value )
310 {
311     int i_ret;
312     vlc_value_t val; val.f_float = 0.0;
313     if( !p_counter ) return VLC_EGENERIC;
314     i_ret = __stats_Get( p_obj, p_counter, &val );
315     *value = val.f_float;
316     return i_ret;
317 }
318 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
319 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
320                                          int i, int *pi_new )
321 {
322     int i_ret;
323     vlc_value_t val;
324     vlc_value_t new_val; new_val.i_int = 0;
325     if( !p_co ) return VLC_EGENERIC;
326     val.i_int = i;
327     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
328     if( pi_new )
329         *pi_new = new_val.i_int;
330     return i_ret;
331 }
332 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
333 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
334                                        float f, float *pf_new )
335 {
336     vlc_value_t val;
337     int i_ret;
338     vlc_value_t new_val;new_val.f_float = 0.0;
339     if( !p_co ) return VLC_EGENERIC;
340     val.f_float = f;
341     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
342     if( pf_new )
343         *pf_new = new_val.f_float;
344     return i_ret;
345 }
346
347 /******************
348  * Input stats
349  ******************/
350 struct input_stats_t
351 {
352     vlc_mutex_t         lock;
353
354     /* Input */
355     int i_read_packets;
356     int i_read_bytes;
357     float f_input_bitrate;
358     float f_average_input_bitrate;
359
360     /* Demux */
361     int i_demux_read_packets;
362     int i_demux_read_bytes;
363     float f_demux_bitrate;
364     float f_average_demux_bitrate;
365
366     /* Decoders */
367     int i_decoded_audio;
368     int i_decoded_video;
369
370     /* Vout */
371     int i_displayed_pictures;
372     int i_lost_pictures;
373
374     /* Sout */
375     int i_sent_packets;
376     int i_sent_bytes;
377     float f_send_bitrate;
378
379     /* Aout */
380     int i_played_abuffers;
381     int i_lost_abuffers;
382 };
383
384 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
385 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
386 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
387
388 /********************
389  * Global stats
390  *******************/
391 struct global_stats_t
392 {
393     vlc_mutex_t lock;
394
395     float f_input_bitrate;
396     float f_demux_bitrate;
397     float f_output_bitrate;
398
399     int i_http_clients;
400 };
401
402 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
403 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
404
405
406 /*********
407  * Timing
408  ********/
409 #ifdef DEBUG
410 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
411 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
412 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
413 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
414 #else
415 #define stats_TimerStart(a,b,c) {}
416 #define stats_TimerStop(a,b) {}
417 #define stats_TimerDump(a,b) {}
418 #define stats_TimersDumpAll(a) {}
419 #endif
420 VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
421 VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
422 VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
423 VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
424 #define stats_TimersClean(a) __stats_TimersClean( VLC_OBJECT(a) )
425 VLC_EXPORT( void, __stats_TimersClean, (vlc_object_t * ) );
426
427 #endif