]> git.sesse.net Git - vlc/blob - src/misc/messages.c
Remember not to include anything before vlc/vlc.h
[vlc] / 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 vlc_config.h for output configuration.
5  *****************************************************************************
6  * Copyright (C) 1998-2005 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 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30
31 #include <vlc/vlc.h>
32
33 #include <stdarg.h>                                       /* va_list for BSD */
34
35 #ifdef HAVE_FCNTL_H
36 #   include <fcntl.h>                  /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
37 #endif
38
39 #include <errno.h>                                                  /* errno */
40
41 #ifdef HAVE_UNISTD_H
42 #   include <unistd.h>                                   /* close(), write() */
43 #endif
44
45 #include <assert.h>
46
47 #include <vlc_charset.h>
48
49 /*****************************************************************************
50  * Local macros
51  *****************************************************************************/
52 #if defined(HAVE_VA_COPY)
53 #   define vlc_va_copy(dest,src) va_copy(dest,src)
54 #elif defined(HAVE___VA_COPY)
55 #   define vlc_va_copy(dest,src) __va_copy(dest,src)
56 #else
57 #   define vlc_va_copy(dest,src) (dest)=(src)
58 #endif
59
60 #define QUEUE(i) p_this->p_libvlc->msg_bank.queues[i]
61 #define LOCK_BANK vlc_mutex_lock( &p_this->p_libvlc->msg_bank.lock );
62 #define UNLOCK_BANK vlc_mutex_unlock( &p_this->p_libvlc->msg_bank.lock );
63
64 /*****************************************************************************
65  * Local prototypes
66  *****************************************************************************/
67 static void QueueMsg ( vlc_object_t *, int, int , const char *,
68                        const char *, va_list );
69 static void FlushMsg ( msg_queue_t * );
70 static void PrintMsg ( vlc_object_t *, msg_item_t * );
71
72 /**
73  * Initialize messages queues
74  * This function initializes all message queues
75  */
76 void __msg_Create( vlc_object_t *p_this )
77 {
78     int i;
79     vlc_mutex_init( p_this, &(p_this->p_libvlc->msg_bank.lock) );
80
81     for( i = 0; i < 2; i++ )
82     {
83          vlc_mutex_init( p_this, &QUEUE(i).lock );
84          QUEUE(i).b_overflow = VLC_FALSE;
85          QUEUE(i).i_id = i;
86          QUEUE(i).i_start = 0;
87          QUEUE(i).i_stop = 0;
88          QUEUE(i).i_sub = 0;
89          QUEUE(i).pp_sub = 0;
90     }
91
92 #ifdef UNDER_CE
93     QUEUE(MSG_QUEUE_NORMAL).logfile =
94         CreateFile( L"vlc-log.txt", GENERIC_WRITE,
95                     FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
96                     CREATE_ALWAYS, 0, NULL );
97     SetFilePointer( QUEUE(MSG_QUEUE_NORMAL).logfile, 0, NULL, FILE_END );
98 #endif
99 }
100
101 /**
102  * Flush all message queues
103  */
104 void __msg_Flush( vlc_object_t *p_this )
105 {
106     int i;
107     for( i = 0 ; i < NB_QUEUES ; i++ )
108     {
109         vlc_mutex_lock( &QUEUE(i).lock );
110         FlushMsg( &QUEUE(i) );
111         vlc_mutex_unlock( &QUEUE(i).lock );
112     }
113 }
114
115 /**
116  * Destroy the message queues
117  *
118  * This functions prints all messages remaining in the queues,
119  * then frees all the allocated ressources
120  * No other messages interface functions should be called after this one.
121  */
122 void __msg_Destroy( vlc_object_t *p_this )
123 {
124     int i;
125     for( i = NB_QUEUES -1 ; i >= 0;  i-- )
126     {
127         if( QUEUE(i).i_sub )
128             msg_Err( p_this, "stale interface subscribers" );
129
130         FlushMsg( &QUEUE(i) );
131
132 #ifdef UNDER_CE
133         if( i == MSG_QUEUE_NORMAL )
134             CloseHandle( QUEUE(MSG_QUEUE_NORMAL).logfile );
135 #endif
136         /* Destroy lock */
137         vlc_mutex_destroy( &QUEUE(i).lock );
138     }
139     vlc_mutex_destroy( &(p_this->p_libvlc->msg_bank.lock) );
140 }
141
142 /**
143  * Subscribe to a message queue.
144  */
145 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this, int i )
146 {
147     msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
148
149     assert( i < NB_QUEUES );
150
151     LOCK_BANK;
152     vlc_mutex_lock( &QUEUE(i).lock );
153
154     TAB_APPEND( QUEUE(i).i_sub, QUEUE(i).pp_sub, p_sub );
155
156     p_sub->i_start = QUEUE(i).i_start;
157     p_sub->pi_stop = &QUEUE(i).i_stop;
158     p_sub->p_msg   = QUEUE(i).msg;
159     p_sub->p_lock  = &QUEUE(i).lock;
160
161     vlc_mutex_unlock( &QUEUE(i).lock );
162     UNLOCK_BANK;
163
164     return p_sub;
165 }
166
167 /**
168  * Unsubscribe from a message queue.
169  */
170 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
171 {
172     int i,j;
173
174     LOCK_BANK;
175     for( i = 0 ; i< NB_QUEUES ; i++ )
176     {
177         vlc_mutex_lock( &QUEUE(i).lock );
178         for( j = 0 ; j< QUEUE(i).i_sub ; j++ )
179         {
180             if( QUEUE(i).pp_sub[j] == p_sub )
181             {
182                 REMOVE_ELEM( QUEUE(i).pp_sub, QUEUE(i).i_sub, j );
183                 if( p_sub ) free( p_sub );
184             }
185         }
186         vlc_mutex_unlock( & QUEUE(i).lock );
187     }
188     UNLOCK_BANK;
189 }
190
191 const char *msg_GetObjectTypeName(int i_object_type )
192 {
193     switch( i_object_type )
194     {
195         case VLC_OBJECT_GLOBAL: return "global";
196         case VLC_OBJECT_LIBVLC: return "libvlc";
197         case VLC_OBJECT_MODULE: return "module";
198         case VLC_OBJECT_INTF: return "interface";
199         case VLC_OBJECT_PLAYLIST: return "playlist";
200         case VLC_OBJECT_ITEM: return "item";
201         case VLC_OBJECT_INPUT: return "input";
202         case VLC_OBJECT_DECODER: return "decoder";
203         case VLC_OBJECT_PACKETIZER: return "packetizer";
204         case VLC_OBJECT_ENCODER: return "encoder";
205         case VLC_OBJECT_VOUT: return "video output";
206         case VLC_OBJECT_AOUT: return "audio output";
207         case VLC_OBJECT_SOUT: return "stream output";
208         case VLC_OBJECT_HTTPD: return "http server";
209         case VLC_OBJECT_HTTPD_HOST: return "http server";
210         case VLC_OBJECT_DIALOGS: return "dialogs provider";
211         case VLC_OBJECT_VLM: return "vlm";
212         case VLC_OBJECT_ANNOUNCE: return "announce handler";
213         case VLC_OBJECT_DEMUX: return "demuxer";
214         case VLC_OBJECT_ACCESS: return "access";
215         case VLC_OBJECT_META_ENGINE: return "meta engine";
216         default: return "private";
217     }
218 }
219
220 /*****************************************************************************
221  * __msg_*: print a message
222  *****************************************************************************
223  * These functions queue a message for later printing.
224  *****************************************************************************/
225 void __msg_Generic( vlc_object_t *p_this, int i_queue, int i_type,
226                     const char *psz_module,
227                     const char *psz_format, ... )
228 {
229     va_list args;
230
231     va_start( args, psz_format );
232     QueueMsg( p_this, i_queue, i_type, psz_module, psz_format, args );
233     va_end( args );
234 }
235
236 void __msg_GenericVa( vlc_object_t *p_this, int i_queue,
237                       int i_type, const char *psz_module,
238                       const char *psz_format, va_list args )
239 {
240     QueueMsg( p_this, i_queue, i_type, psz_module, psz_format, args );
241 }
242
243 /* Generic functions used when variadic macros are not available. */
244 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
245     void FN_NAME( vlc_object_t *p_this, const char *psz_format, ... ) \
246     { \
247         va_list args; \
248         va_start( args, psz_format ); \
249         QueueMsg( (vlc_object_t *)p_this,MSG_QUEUE_NORMAL, FN_TYPE, "unknown", \
250                   psz_format, args ); \
251         va_end( args ); \
252     } \
253     struct _
254 /**
255  * Output an informational message.
256  * \note Do not use this for debug messages
257  * \see input_AddInfo
258  */
259 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
260 /**
261  * Output an error message.
262  */
263 DECLARE_MSG_FN( __msg_Err,  VLC_MSG_ERR );
264 /**
265  * Output a waring message
266  */
267 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
268 /**
269  * Output a debug message
270  */
271 DECLARE_MSG_FN( __msg_Dbg,  VLC_MSG_DBG );
272
273 /**
274  * Add a message to a queue
275  *
276  * This function provides basic functionnalities to other msg_* functions.
277  * It adds a message to a queue (after having printed all stored messages if it
278  * is full). If the message can't be converted to string in memory, it issues
279  * a warning.
280  */
281 static void QueueMsg( vlc_object_t *p_this, int i_queue, int i_type,
282                       const char *psz_module,
283                       const char *psz_format, va_list _args )
284 {
285     int         i_header_size;             /* Size of the additionnal header */
286     vlc_object_t *p_obj;
287     char *       psz_str = NULL;                 /* formatted message string */
288     char *       psz_header = NULL;
289     va_list      args;
290     msg_item_t * p_item = NULL;                        /* pointer to message */
291     msg_item_t   item;                    /* message in case of a full queue */
292     msg_queue_t *p_queue;
293
294 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
295     int          i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
296 #endif
297
298     if( p_this == NULL || p_this->i_flags & OBJECT_FLAGS_QUIET ||
299         (p_this->i_flags & OBJECT_FLAGS_NODBG && i_type == VLC_MSG_DBG) )
300     {
301         return;
302     }
303
304     /* Convert message to string  */
305 #if defined(HAVE_VASPRINTF) && !defined(__APPLE__) && !defined( SYS_BEOS )
306     vlc_va_copy( args, _args );
307     if( vasprintf( &psz_str, psz_format, args ) == -1 )
308         psz_str = NULL;
309     va_end( args );
310 #else
311     psz_str = (char*) malloc( i_size );
312 #endif
313
314     if( psz_str == NULL )
315     {
316         fprintf( stderr, "main warning: can't store message (%s): ",
317                  strerror(errno) );
318         vlc_va_copy( args, _args );
319         /* We should use utf8_vfprintf - but it calls malloc()... */
320         vfprintf( stderr, psz_format, args );
321         va_end( args );
322         fputs( "\n", stderr );
323         return;
324     }
325
326     i_header_size = 0;
327     p_obj = p_this;
328     while( p_obj != NULL )
329     {
330         char *psz_old = NULL;
331         if( p_obj->psz_header )
332         {
333             i_header_size += strlen( p_obj->psz_header ) + 4;
334             if( psz_header )
335             {
336                 psz_old = strdup( psz_header );
337                 psz_header = (char*)realloc( psz_header, i_header_size );
338                 snprintf( psz_header, i_header_size , "[%s] %s",
339                           p_obj->psz_header, psz_old );
340             }
341             else
342             {
343                 psz_header = (char *)malloc( i_header_size );
344                 snprintf( psz_header, i_header_size, "[%s]",
345                           p_obj->psz_header );
346             }
347         }
348         if( psz_old ) free( psz_old );
349         p_obj = p_obj->p_parent;
350     }
351
352 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
353     vlc_va_copy( args, _args );
354     vsnprintf( psz_str, i_size, psz_format, args );
355     va_end( args );
356     psz_str[ i_size - 1 ] = 0; /* Just in case */
357 #endif
358
359     assert( i_queue < NB_QUEUES );
360     LOCK_BANK;
361     p_queue = &QUEUE(i_queue) ;
362     vlc_mutex_lock( &p_queue->lock );
363
364     /* Check there is room in the queue for our message */
365     if( p_queue->b_overflow )
366     {
367         FlushMsg( p_queue );
368
369         if( ((p_queue->i_stop - p_queue->i_start + 1) % VLC_MSG_QSIZE) == 0 )
370         {
371             /* Still in overflow mode, print from a dummy item */
372             p_item = &item;
373         }
374         else
375         {
376             /* Pheeew, at last, there is room in the queue! */
377             p_queue->b_overflow = VLC_FALSE;
378         }
379     }
380     else if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
381     {
382         FlushMsg( p_queue );
383
384         if( ((p_queue->i_stop - p_queue->i_start + 2) % VLC_MSG_QSIZE) == 0 )
385         {
386             p_queue->b_overflow = VLC_TRUE;
387
388             if( p_queue->i_id == MSG_QUEUE_NORMAL )
389             {
390                /* Put the overflow message in the queue */
391                 p_item = p_queue->msg + p_queue->i_stop;
392                 p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
393
394                 p_item->i_type =        VLC_MSG_WARN;
395                 p_item->i_object_id =   p_this->i_object_id;
396                 p_item->i_object_type = p_this->i_object_type;
397                 p_item->psz_module =    strdup( "message" );
398                 p_item->psz_msg =       strdup( "message queue overflowed" );
399                 p_item->psz_header =    NULL;
400
401                PrintMsg( p_this, p_item );
402                /* We print from a dummy item */
403                p_item = &item;
404             }
405         }
406     }
407
408     if( !p_queue->b_overflow )
409     {
410         /* Put the message in the queue */
411         p_item = p_queue->msg + p_queue->i_stop;
412         p_queue->i_stop = (p_queue->i_stop + 1) % VLC_MSG_QSIZE;
413     }
414
415     /* Fill message information fields */
416     p_item->i_type =        i_type;
417     p_item->i_object_id =   p_this->i_object_id;
418     p_item->i_object_type = p_this->i_object_type;
419     p_item->psz_module =    strdup( psz_module );
420     p_item->psz_msg =       psz_str;
421     p_item->psz_header =    psz_header;
422
423     if( p_queue->i_id == MSG_QUEUE_NORMAL )
424         PrintMsg( p_this, p_item );
425
426     if( p_queue->b_overflow )
427     {
428         if( p_item->psz_module )
429             free( p_item->psz_module );
430         if( p_item->psz_msg )
431             free( p_item->psz_msg );
432         if( p_item->psz_header )
433             free( p_item->psz_header );
434     }
435
436     vlc_mutex_unlock ( &p_queue->lock );
437     UNLOCK_BANK;
438 }
439
440 /* following functions are local */
441
442 /*****************************************************************************
443  * FlushMsg
444  *****************************************************************************
445  * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
446  * this function does not check the lock.
447  *****************************************************************************/
448 static void FlushMsg ( msg_queue_t *p_queue )
449 {
450     int i_index, i_start, i_stop;
451
452     /* Get the maximum message index that can be freed */
453     i_stop = p_queue->i_stop;
454
455     /* Check until which value we can free messages */
456     for( i_index = 0; i_index < p_queue->i_sub; i_index++ )
457     {
458         i_start = p_queue->pp_sub[ i_index ]->i_start;
459
460         /* If this subscriber is late, we don't free messages before
461          * his i_start value, otherwise he'll miss messages */
462         if(   ( i_start < i_stop
463                && (p_queue->i_stop <= i_start || i_stop <= p_queue->i_stop) )
464            || ( i_stop < i_start
465                && (i_stop <= p_queue->i_stop && p_queue->i_stop <= i_start) ) )
466         {
467             i_stop = i_start;
468         }
469     }
470
471     /* Free message data */
472     for( i_index = p_queue->i_start;
473          i_index != i_stop;
474          i_index = (i_index+1) % VLC_MSG_QSIZE )
475     {
476         if( p_queue->msg[i_index].psz_msg )
477             free( p_queue->msg[i_index].psz_msg );
478         if( p_queue->msg[i_index].psz_module )
479             free( p_queue->msg[i_index].psz_module );
480         if( p_queue->msg[i_index].psz_header )
481             free( p_queue->msg[i_index].psz_header );
482     }
483
484     /* Update the new start value */
485     p_queue->i_start = i_index;
486 }
487
488 /*****************************************************************************
489  * PrintMsg: output a standard message item to stderr
490  *****************************************************************************
491  * Print a message to stderr, with colour formatting if needed.
492  *****************************************************************************/
493 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
494 {
495 #   define COL(x)  "\033[" #x ";1m"
496 #   define RED     COL(31)
497 #   define GREEN   COL(32)
498 #   define YELLOW  COL(33)
499 #   define WHITE   COL(37)
500 #   define GRAY    "\033[0m"
501
502 #ifdef UNDER_CE
503     int i_dummy;
504 #endif
505     static const char * ppsz_type[4] = { "", " error", " warning", " debug" };
506     static const char *ppsz_color[4] = { WHITE, RED, YELLOW, GRAY };
507     const char *psz_object;
508     int i_type = p_item->i_type;
509
510     switch( i_type )
511     {
512         case VLC_MSG_ERR:
513             if( p_this->p_libvlc->i_verbose < 0 ) return;
514             break;
515         case VLC_MSG_INFO:
516             if( p_this->p_libvlc->i_verbose < 0 ) return;
517             break;
518         case VLC_MSG_WARN:
519             if( p_this->p_libvlc->i_verbose < 1 ) return;
520             break;
521         case VLC_MSG_DBG:
522             if( p_this->p_libvlc->i_verbose < 2 ) return;
523             break;
524     }
525
526     psz_object = msg_GetObjectTypeName(p_item->i_object_type);
527
528 #ifdef UNDER_CE
529 #   define CE_WRITE(str) WriteFile( QUEUE(MSG_QUEUE_NORMAL).logfile, \
530                                     str, strlen(str), &i_dummy, NULL );
531     CE_WRITE( p_item->psz_module );
532     CE_WRITE( " " );
533     CE_WRITE( psz_object );
534     CE_WRITE( ppsz_type[i_type] );
535     CE_WRITE( ": " );
536     CE_WRITE( p_item->psz_msg );
537     CE_WRITE( "\r\n" );
538     FlushFileBuffers( QUEUE(MSG_QUEUE_NORMAL).logfile );
539
540 #else
541     /* Send the message to stderr */
542     if( p_this->p_libvlc->b_color )
543     {
544         if( p_item->psz_header )
545         {
546             utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s %s%s: %s%s" GRAY
547                               "\n",
548                          p_item->i_object_id, p_item->psz_header,
549                          p_item->psz_module, psz_object,
550                          ppsz_type[i_type], ppsz_color[i_type],
551                          p_item->psz_msg );
552         }
553         else
554         {
555              utf8_fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s%s: %s%s" GRAY "\n",
556                          p_item->i_object_id, p_item->psz_module, psz_object,
557                          ppsz_type[i_type], ppsz_color[i_type],
558                          p_item->psz_msg );
559         }
560     }
561     else
562     {
563         if( p_item->psz_header )
564         {
565             utf8_fprintf( stderr, "[%.8i] %s %s %s%s: %s\n", p_item->i_object_id,
566                          p_item->psz_header, p_item->psz_module,
567                          psz_object, ppsz_type[i_type], p_item->psz_msg );
568         }
569         else
570         {
571             utf8_fprintf( stderr, "[%.8i] %s %s%s: %s\n", p_item->i_object_id,
572                          p_item->psz_module, psz_object, ppsz_type[i_type],
573                          p_item->psz_msg );
574         }
575     }
576
577 #   if defined(WIN32)
578     fflush( stderr );
579 #   endif
580 #endif
581 }
582
583 static msg_context_t* GetContext(void)
584 {
585     msg_context_t *p_ctx = vlc_threadvar_get( &msg_context_global_key );
586     if( p_ctx == NULL )
587     {
588         MALLOC_NULL( p_ctx, msg_context_t );
589         p_ctx->psz_message = NULL;
590         vlc_threadvar_set( &msg_context_global_key, p_ctx );
591     }
592     return p_ctx;
593 }
594
595 void msg_StackSet( int i_code, const char *psz_message, ... )
596 {
597     va_list ap;
598     msg_context_t *p_ctx = GetContext();
599     assert( p_ctx );
600
601     va_start( ap, psz_message );
602     free( p_ctx->psz_message );
603
604     if( vasprintf( &p_ctx->psz_message, psz_message, ap ) == -1 )
605         p_ctx->psz_message = NULL;
606     va_end( ap );
607
608     p_ctx->i_code = i_code;
609 }
610
611 void msg_StackAdd( const char *psz_message, ... )
612 {
613     char *psz_tmp;
614     va_list ap;
615     msg_context_t *p_ctx = GetContext();
616     assert( p_ctx );
617
618     va_start( ap, psz_message );
619     if( vasprintf( &psz_tmp, psz_message, ap ) == -1 )
620         psz_tmp = NULL;
621     va_end( ap );
622
623     if( !p_ctx->psz_message )
624         p_ctx->psz_message = psz_tmp;
625     else
626     {
627         char *psz_old = malloc( strlen( p_ctx->psz_message ) + 1 );
628         memcpy( psz_old, p_ctx->psz_message, strlen( p_ctx->psz_message ) + 1 );
629         p_ctx->psz_message = realloc( p_ctx->psz_message,
630                                       strlen( p_ctx->psz_message ) +
631                                       /* ':', ' ', '0' */
632                                       strlen( psz_tmp ) + 3 );
633         sprintf( p_ctx->psz_message, "%s: %s", psz_tmp, psz_old );
634         free( psz_tmp ); free( psz_old );
635     }
636 }
637
638 const char* msg_StackMsg( void )
639 {
640     msg_context_t *p_ctx = GetContext();
641     assert( p_ctx );
642     return p_ctx->psz_message;
643 }