Remove some GCCisms.
[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 #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__ )
151
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 * );
158
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 * ) );
163
164 VLC_EXPORT(const char *, msg_GetObjectTypeName, (int i_object_type ));
165
166 /**
167  * @}
168  */
169
170 /**
171  * \defgroup statistics Statistics
172  *
173  * @{
174  */
175
176 /****************************
177  * Generic stats stuff
178  ****************************/
179 enum
180 {
181     STATS_LAST,
182     STATS_COUNTER,
183     STATS_MAX,
184     STATS_MIN,
185     STATS_DERIVATIVE,
186     STATS_TIMER
187 };
188
189 struct counter_sample_t
190 {
191     vlc_value_t value;
192     mtime_t     date;
193 };
194
195 struct counter_t
196 {
197     unsigned int        i_id;
198     char              * psz_name;
199     int                 i_type;
200     int                 i_compute_type;
201     int                 i_samples;
202     counter_sample_t ** pp_samples;
203
204     mtime_t             update_interval;
205     mtime_t             last_update;
206 };
207
208 enum
209 {
210     STATS_INPUT_BITRATE,
211     STATS_READ_BYTES,
212     STATS_READ_PACKETS,
213     STATS_DEMUX_READ,
214     STATS_DEMUX_BITRATE,
215     STATS_PLAYED_ABUFFERS,
216     STATS_LOST_ABUFFERS,
217     STATS_DECODED_AUDIO,
218     STATS_DECODED_VIDEO,
219     STATS_DECODED_SUB,
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,
226     STATS_LOST_PICTURES,
227
228     STATS_TIMER_PLAYLIST_BUILD,
229     STATS_TIMER_ML_LOAD,
230     STATS_TIMER_ML_DUMP,
231     STATS_TIMER_INTERACTION,
232     STATS_TIMER_PREPARSE,
233
234     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
235 };
236
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*) );
243
244 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
245
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,
248                                       int *value )
249 {
250     int i_ret;
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 );
254     *value = val.i_int;
255     return i_ret;
256 }
257
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,
260                                     float *value )
261 {
262     int i_ret;
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;
267     return i_ret;
268 }
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,
271                                          int i, int *pi_new )
272 {
273     int i_ret;
274     vlc_value_t val;
275     vlc_value_t new_val; new_val.i_int = 0;
276     if( !p_co ) return VLC_EGENERIC;
277     val.i_int = i;
278     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
279     if( pi_new )
280         *pi_new = new_val.i_int;
281     return i_ret;
282 }
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 )
286 {
287     vlc_value_t val;
288     int i_ret;
289     vlc_value_t new_val;new_val.f_float = 0.0;
290     if( !p_co ) return VLC_EGENERIC;
291     val.f_float = f;
292     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
293     if( pf_new )
294         *pf_new = new_val.f_float;
295     return i_ret;
296 }
297
298 /******************
299  * Input stats
300  ******************/
301 struct input_stats_t
302 {
303     vlc_mutex_t         lock;
304
305     /* Input */
306     int i_read_packets;
307     int i_read_bytes;
308     float f_input_bitrate;
309     float f_average_input_bitrate;
310
311     /* Demux */
312     int i_demux_read_packets;
313     int i_demux_read_bytes;
314     float f_demux_bitrate;
315     float f_average_demux_bitrate;
316
317     /* Decoders */
318     int i_decoded_audio;
319     int i_decoded_video;
320
321     /* Vout */
322     int i_displayed_pictures;
323     int i_lost_pictures;
324
325     /* Sout */
326     int i_sent_packets;
327     int i_sent_bytes;
328     float f_send_bitrate;
329
330     /* Aout */
331     int i_played_abuffers;
332     int i_lost_abuffers;
333 };
334
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 *) );
338
339 /********************
340  * Global stats
341  *******************/
342 struct global_stats_t
343 {
344     vlc_mutex_t lock;
345
346     float f_input_bitrate;
347     float f_demux_bitrate;
348     float f_output_bitrate;
349
350     int i_http_clients;
351 };
352
353 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
354 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
355
356
357 /*********
358  * Timing
359  ********/
360 #ifdef DEBUG
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) )
365 #else
366 #define stats_TimerStart(a,b,c) {}
367 #define stats_TimerStop(a,b) {}
368 #define stats_TimerDump(a,b) {}
369 #define stats_TimersDumpAll(a) {}
370 #endif
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 * ) );
377
378 #endif