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