* ALL: fixed a few include directories.
[vlc.git] / src / misc / messages.c
1 /*****************************************************************************
2  * messages.c: messages interface
3  * This library provides an interface to the message queue to be used by other
4  * modules, especially intf modules. See config.h for output configuration.
5  *****************************************************************************
6  * Copyright (C) 1998-2002 VideoLAN
7  * $Id: messages.c,v 1.9 2002/08/20 18:25:42 sam Exp $
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include <errno.h>                                                  /* errno */
31 #include <fcntl.h>                     /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
32 #include <stdio.h>                                               /* required */
33 #include <stdarg.h>                                       /* va_list for BSD */
34 #include <stdlib.h>                                              /* malloc() */
35 #include <string.h>                                            /* strerror() */
36
37 #include <vlc/vlc.h>
38
39 #ifdef HAVE_UNISTD_H
40 #include <unistd.h>                                      /* close(), write() */
41 #endif
42
43 #include "interface.h"
44
45 /*****************************************************************************
46  * Local prototypes
47  *****************************************************************************/
48 static void QueueMsg ( vlc_object_t *, int , const char *,
49                        const char *, va_list );
50 static void FlushMsg ( msg_bank_t * );
51 static void PrintMsg ( vlc_object_t *, msg_item_t * );
52
53 #if defined( WIN32 )
54 static char *ConvertPrintfFormatString ( const char *psz_format );
55 #endif
56
57 /*****************************************************************************
58  * msg_Create: initialize messages interface
59  *****************************************************************************
60  * This functions has to be called before any call to other msg_* functions.
61  * It set up the locks and the message queue if it is used.
62  *****************************************************************************/
63 void __msg_Create( vlc_object_t *p_this )
64 {
65     /* Message queue initialization */
66     vlc_mutex_init( p_this, &p_this->p_vlc->msg_bank.lock );
67
68     p_this->p_vlc->msg_bank.b_configured = VLC_FALSE;
69     p_this->p_vlc->msg_bank.b_overflow = VLC_FALSE;
70
71     p_this->p_vlc->msg_bank.i_start = 0;
72     p_this->p_vlc->msg_bank.i_stop = 0;
73
74     p_this->p_vlc->msg_bank.i_sub = 0;
75     p_this->p_vlc->msg_bank.pp_sub = NULL;
76 }
77
78 /*****************************************************************************
79  * msg_Flush: flush the message queue
80  *****************************************************************************/
81 void __msg_Flush( vlc_object_t *p_this )
82 {
83     int i_index;
84
85     vlc_mutex_lock( &p_this->p_vlc->msg_bank.lock );
86
87     p_this->p_vlc->msg_bank.b_configured = VLC_TRUE;
88
89     for( i_index = p_this->p_vlc->msg_bank.i_start;
90          i_index != p_this->p_vlc->msg_bank.i_stop;
91          i_index = (i_index+1) % VLC_MSG_QSIZE )
92     {
93         PrintMsg( p_this, &p_this->p_vlc->msg_bank.msg[i_index] );
94     }
95
96     FlushMsg( &p_this->p_vlc->msg_bank );
97
98     vlc_mutex_unlock( &p_this->p_vlc->msg_bank.lock );
99 }
100
101 /*****************************************************************************
102  * msg_Destroy: free resources allocated by msg_Create
103  *****************************************************************************
104  * This functions prints all messages remaining in queue, then free all the
105  * resources allocated by msg_Create.
106  * No other messages interface functions should be called after this one.
107  *****************************************************************************/
108 void __msg_Destroy( vlc_object_t *p_this )
109 {
110     if( p_this->p_vlc->msg_bank.i_sub )
111     {
112         msg_Err( p_this, "stale interface subscribers" );
113     }
114
115     /* Flush the queue */
116     if( !p_this->p_vlc->msg_bank.b_configured )
117     {
118         msg_Flush( p_this );
119     }
120     else
121     {
122         FlushMsg( &p_this->p_vlc->msg_bank );
123     }
124
125     /* Destroy lock */
126     vlc_mutex_destroy( &p_this->p_vlc->msg_bank.lock );
127 }
128
129 /*****************************************************************************
130  * msg_Subscribe: subscribe to the message queue.
131  *****************************************************************************/
132 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this )
133 {
134     msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
135
136     vlc_mutex_lock( &p_this->p_vlc->msg_bank.lock );
137
138     /* Add subscription to the list */
139     p_this->p_vlc->msg_bank.i_sub++;
140     p_this->p_vlc->msg_bank.pp_sub = realloc( p_this->p_vlc->msg_bank.pp_sub,
141         p_this->p_vlc->msg_bank.i_sub * sizeof( msg_subscription_t* ) );
142
143     p_this->p_vlc->msg_bank.pp_sub[ p_this->p_vlc->msg_bank.i_sub - 1 ] = p_sub;
144
145     p_sub->i_start = p_this->p_vlc->msg_bank.i_start;
146     p_sub->pi_stop = &p_this->p_vlc->msg_bank.i_stop;
147
148     p_sub->p_msg   = p_this->p_vlc->msg_bank.msg;
149     p_sub->p_lock  = &p_this->p_vlc->msg_bank.lock;
150
151     vlc_mutex_unlock( &p_this->p_vlc->msg_bank.lock );
152
153     return p_sub;
154 }
155
156 /*****************************************************************************
157  * msg_Unsubscribe: unsubscribe from the message queue.
158  *****************************************************************************/
159 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
160 {
161     int i_index;
162
163     vlc_mutex_lock( &p_this->p_vlc->msg_bank.lock );
164
165     /* Sanity check */
166     if( !p_this->p_vlc->msg_bank.i_sub )
167     {
168         msg_Err( p_this, "no subscriber in the list" );
169         return;
170     }
171
172     /* Look for the appropriate subscription */
173     for( i_index = 0; i_index < p_this->p_vlc->msg_bank.i_sub; i_index++ )
174     {
175         if( p_this->p_vlc->msg_bank.pp_sub[ i_index ] == p_sub )
176         {
177             break;
178         }
179     }
180
181     if( p_this->p_vlc->msg_bank.pp_sub[ i_index ] != p_sub )
182     {
183         msg_Err( p_this, "subscriber not found" );
184         vlc_mutex_unlock( &p_this->p_vlc->msg_bank.lock );
185         return;
186     }
187
188     /* Remove this subscription */
189     for( ; i_index < (p_this->p_vlc->msg_bank.i_sub - 1); i_index++ )
190     {
191         p_this->p_vlc->msg_bank.pp_sub[ i_index ] = p_this->p_vlc->msg_bank.pp_sub[ i_index+1 ];
192     }
193
194     p_this->p_vlc->msg_bank.i_sub--;
195     if( p_this->p_vlc->msg_bank.i_sub )
196     {
197         p_this->p_vlc->msg_bank.pp_sub = realloc( p_this->p_vlc->msg_bank.pp_sub,
198             p_this->p_vlc->msg_bank.i_sub * sizeof( msg_subscription_t* ) );
199     }
200     else
201     {
202         free( p_this->p_vlc->msg_bank.pp_sub );
203         p_this->p_vlc->msg_bank.pp_sub = NULL;
204     }
205
206
207     vlc_mutex_unlock( &p_this->p_vlc->msg_bank.lock );
208 }
209
210 /*****************************************************************************
211  * __msg_*: print a message
212  *****************************************************************************
213  * These functions queue a message for later printing.
214  *****************************************************************************/
215 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
216                     const char *psz_format, ... )
217 {
218     va_list args;
219
220     va_start( args, psz_format );
221     QueueMsg( p_this, i_type, psz_module, psz_format, args );
222     va_end( args );
223 }
224
225 /* Generic functions used when variadic macros are not available. */
226 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
227     void FN_NAME( void *p_this, const char *psz_format, ... ) \
228     { \
229         va_list args; \
230         va_start( args, psz_format ); \
231         QueueMsg( (vlc_object_t *)p_this, FN_TYPE, "unknown", \
232                   psz_format, args ); \
233         va_end( args ); \
234     } \
235     struct _
236
237 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
238 DECLARE_MSG_FN( __msg_Err,  VLC_MSG_ERR );
239 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
240 DECLARE_MSG_FN( __msg_Dbg,  VLC_MSG_DBG );
241
242 /*****************************************************************************
243  * QueueMsg: add a message to a queue
244  *****************************************************************************
245  * This function provides basic functionnalities to other msg_* functions.
246  * It adds a message to a queue (after having printed all stored messages if it
247  * is full). If the message can't be converted to string in memory, it issues
248  * a warning.
249  *****************************************************************************/
250 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
251                       const char *psz_format, va_list args )
252 {
253     msg_bank_t *        p_bank = &p_this->p_vlc->msg_bank;   /* message bank */
254     char *              psz_str = NULL;          /* formatted message string */
255     msg_item_t *        p_item = NULL;                 /* pointer to message */
256     msg_item_t          item;             /* message in case of a full queue */
257 #ifdef WIN32
258     char *              psz_temp;
259 #endif
260 #ifndef HAVE_VASPRINTF
261     int                 i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
262 #endif
263
264     /*
265      * Convert message to string
266      */
267 #ifdef HAVE_VASPRINTF
268     vasprintf( &psz_str, psz_format, args );
269 #else
270     psz_str = (char*) malloc( i_size * sizeof(char) );
271 #endif
272
273     if( psz_str == NULL )
274     {
275         fprintf( stderr, "main warning: can't store message (%s): ",
276                  strerror(errno) );
277         vfprintf( stderr, psz_format, args );
278         fprintf( stderr, "\n" );
279         return;
280     }
281
282 #ifndef HAVE_VASPRINTF
283 #   ifdef WIN32
284     psz_temp = ConvertPrintfFormatString( psz_format );
285     if( !psz_temp )
286     {
287         fprintf( stderr, "main warning: couldn't print message\n" );
288         return;
289     }
290     vsnprintf( psz_str, i_size, psz_temp, args );
291     free( psz_temp );
292 #   else
293     vsnprintf( psz_str, i_size, psz_format, args );
294 #   endif
295     psz_str[ i_size - 1 ] = 0; /* Just in case */
296 #endif
297
298     /* Put message in queue */
299     vlc_mutex_lock( &p_bank->lock );
300
301     /* Check there is room in the queue for our message */
302     if( p_bank->b_overflow )
303     {
304         FlushMsg( &p_this->p_vlc->msg_bank );
305
306         if( ((p_bank->i_stop - p_bank->i_start + 1) % VLC_MSG_QSIZE) == 0 )
307         {
308             /* Still in overflow mode, print from a dummy item */
309             p_item = &item;
310         }
311         else
312         {
313             /* Pheeew, at last, there is room in the queue! */
314             p_bank->b_overflow = VLC_FALSE;
315         }
316     }
317     else if( ((p_bank->i_stop - p_bank->i_start + 2) % VLC_MSG_QSIZE) == 0 )
318     {
319         FlushMsg( &p_this->p_vlc->msg_bank );
320
321         if( ((p_bank->i_stop - p_bank->i_start + 2) % VLC_MSG_QSIZE) == 0 )
322         {
323             p_bank->b_overflow = VLC_TRUE;
324
325             /* Put the overflow message in the queue */
326             p_item = p_bank->msg + p_bank->i_stop;
327             p_bank->i_stop = (p_bank->i_stop + 1) % VLC_MSG_QSIZE;
328
329             p_item->i_type =      VLC_MSG_ERR;
330             p_item->i_object_id = p_this->i_object_id;
331             p_item->psz_module =  strdup( "message" );
332             p_item->psz_msg =     strdup( "message queue overflowed" );
333
334             PrintMsg( p_this, p_item );
335
336             /* We print from a dummy item */
337             p_item = &item;
338         }
339     }
340
341     if( !p_bank->b_overflow )
342     {
343         /* Put the message in the queue */
344         p_item = p_bank->msg + p_bank->i_stop;
345         p_bank->i_stop = (p_bank->i_stop + 1) % VLC_MSG_QSIZE;
346     }
347
348     /* Fill message information fields */
349     p_item->i_type =      i_type;
350     p_item->i_object_id = p_this->i_object_id;
351     p_item->psz_module =  strdup( psz_module );
352     p_item->psz_msg =     psz_str;
353
354     PrintMsg( p_this, p_item );
355
356     if( p_bank->b_overflow )
357     {
358         free( p_item->psz_module );
359         free( p_item->psz_msg );
360     }
361
362     vlc_mutex_unlock( &p_bank->lock );
363 }
364
365 /* following functions are local */
366
367 /*****************************************************************************
368  * FlushMsg
369  *****************************************************************************
370  * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
371  * this function does not check the lock.
372  *****************************************************************************/
373 static void FlushMsg ( msg_bank_t *p_bank )
374 {
375     int i_index, i_start, i_stop;
376
377     /* Only flush the queue if it has been properly configured */
378     if( !p_bank->b_configured )
379     {
380         return;
381     }
382
383     /* Get the maximum message index that can be freed */
384     i_stop = p_bank->i_stop;
385
386     /* Check until which value we can free messages */
387     for( i_index = 0; i_index < p_bank->i_sub; i_index++ )
388     {
389         i_start = p_bank->pp_sub[ i_index ]->i_start;
390
391         /* If this subscriber is late, we don't free messages before
392          * his i_start value, otherwise he'll miss messages */
393         if(   ( i_start < i_stop
394                && (p_bank->i_stop <= i_start || i_stop <= p_bank->i_stop) )
395            || ( i_stop < i_start
396                && (i_stop <= p_bank->i_stop && p_bank->i_stop <= i_start) ) )
397         {
398             i_stop = i_start;
399         }
400     }
401
402     /* Free message data */
403     for( i_index = p_bank->i_start;
404          i_index != i_stop;
405          i_index = (i_index+1) % VLC_MSG_QSIZE )
406     {
407         free( p_bank->msg[i_index].psz_msg );
408         free( p_bank->msg[i_index].psz_module );
409     }
410
411     /* Update the new start value */
412     p_bank->i_start = i_index;
413 }
414
415 /*****************************************************************************
416  * PrintMsg: output a message item to stderr
417  *****************************************************************************
418  * Print a message to stderr, with colour formatting if needed.
419  *****************************************************************************/
420 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
421 {
422 #   define COL(x)  "\033[" #x ";1m"
423 #   define RED     COL(31)
424 #   define GREEN   COL(32)
425 #   define YELLOW  COL(33)
426 #   define WHITE   COL(37)
427 #   define GRAY    "\033[0m"
428
429     static const char * ppsz_type[4] = { "", " error", " warning", " debug" };
430     static const char *ppsz_color[4] = { WHITE, RED, YELLOW, GRAY };
431     int i_type = p_item->i_type;
432
433     if( p_this->p_vlc->b_quiet || !p_this->p_vlc->msg_bank.b_configured )
434     {
435         return;
436     }
437
438     if( !p_this->p_vlc->b_verbose &&
439          ( (i_type == VLC_MSG_WARN) || (i_type == VLC_MSG_DBG) ) )
440     {
441         return;
442     }
443
444     /* Send the message to stderr */
445     if( p_this->p_vlc->b_color )
446     {
447         fprintf( stderr, "[" GREEN "%.2x" GRAY ":" GREEN "%.6x" GRAY "] "
448                          "%s%s: %s%s" GRAY "\n", p_this->p_vlc->i_instance,
449                          p_item->i_object_id, p_item->psz_module,
450                          ppsz_type[i_type], ppsz_color[i_type],
451                          p_item->psz_msg );
452     }
453     else
454     {
455         fprintf( stderr, "[%.2x:%.6x] %s%s: %s\n",
456                          p_this->p_vlc->i_instance, p_item->i_object_id,
457                          p_item->psz_module, ppsz_type[i_type],
458                          p_item->psz_msg );
459     }
460 }
461
462 /*****************************************************************************
463  * ConvertPrintfFormatString: replace all occurrences of %ll with %I64 in the
464  *                            printf format string.
465  *****************************************************************************
466  * Win32 doesn't recognize the "%ll" format in a printf string, so we have
467  * to convert this string to something that win32 can handle.
468  * This is a REALLY UGLY HACK which won't even work in every situation,
469  * but hey I don't want to put an ifdef WIN32 each time I use printf with
470  * a "long long" type!!!
471  * By the way, if we don't do this we can sometimes end up with segfaults.
472  *****************************************************************************/
473 #if defined( WIN32 )
474 static char *ConvertPrintfFormatString( const char *psz_format )
475 {
476   int i, i_counter=0, i_pos=0;
477   char *psz_dest;
478
479   /* We first need to check how many occurences of %ll there are in the
480    * psz_format string. Once we'll know that we'll be able to malloc the
481    * destination string */
482
483   if( strlen( psz_format ) <= 3 )
484       return strdup( psz_format );
485
486   for( i=0; i <= (strlen(psz_format) - 3); i++ )
487   {
488       if( !strncmp( (char *)(psz_format + i), "%ll", 3 ) )
489       {
490           i_counter++;
491       }
492   }
493
494   /* malloc the destination string */
495   psz_dest = malloc( strlen(psz_format) + i_counter + 1 );
496   if( psz_dest == NULL )
497   {
498       fprintf( stderr, "main warning: ConvertPrintfFormatString failed\n" );
499       return NULL;
500   }
501
502   /* Now build the modified string */
503   i_counter = 0;
504   for( i=0; i <= (strlen(psz_format) - 3); i++ )
505   {
506       if( !strncmp( (char *)(psz_format + i), "%ll", 3 ) )
507       {
508           memcpy( psz_dest+i_pos+i_counter, psz_format+i_pos, i-i_pos+1);
509           *(psz_dest+i+i_counter+1)='I';
510           *(psz_dest+i+i_counter+2)='6';
511           *(psz_dest+i+i_counter+3)='4';
512           i_pos = i+3;
513           i_counter++;
514       }
515   }
516   strcpy( psz_dest+i_pos+i_counter, psz_format+i_pos );
517
518   return psz_dest;
519 }
520 #endif