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-2004 VideoLAN
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 * Samuel Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
30 #include <stdio.h> /* required */
31 #include <stdarg.h> /* va_list for BSD */
32 #include <stdlib.h> /* malloc() */
33 #include <string.h> /* strerror() */
38 # include <fcntl.h> /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
41 #include <errno.h> /* errno */
44 # include <unistd.h> /* close(), write() */
47 #include "vlc_interface.h"
49 /*****************************************************************************
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)
57 # define vlc_va_copy(dest,src) (dest)=(src)
60 /*****************************************************************************
62 *****************************************************************************/
63 static void QueueMsg ( vlc_object_t *, int , const char *,
64 const char *, va_list );
65 static void FlushMsg ( msg_bank_t * );
66 static void PrintMsg ( vlc_object_t *, msg_item_t * );
69 * Initialize messages interface
71 * This functions has to be called before any call to other msg_* functions.
72 * It set up the locks and the message queue if it is used.
74 void __msg_Create( vlc_object_t *p_this )
76 /* Message queue initialization */
77 vlc_mutex_init( p_this, &p_this->p_libvlc->msg_bank.lock );
79 p_this->p_libvlc->msg_bank.b_configured = VLC_FALSE;
80 p_this->p_libvlc->msg_bank.b_overflow = VLC_FALSE;
82 p_this->p_libvlc->msg_bank.i_start = 0;
83 p_this->p_libvlc->msg_bank.i_stop = 0;
85 p_this->p_libvlc->msg_bank.i_sub = 0;
86 p_this->p_libvlc->msg_bank.pp_sub = NULL;
89 p_this->p_libvlc->msg_bank.logfile =
90 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
91 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
92 CREATE_ALWAYS, 0, NULL );
93 SetFilePointer( p_this->p_libvlc->msg_bank.logfile, 0, NULL, FILE_END );
98 * Flush the message queue
100 void __msg_Flush( vlc_object_t *p_this )
104 vlc_mutex_lock( &p_this->p_libvlc->msg_bank.lock );
106 p_this->p_libvlc->msg_bank.b_configured = VLC_TRUE;
108 for( i_index = p_this->p_libvlc->msg_bank.i_start;
109 i_index != p_this->p_libvlc->msg_bank.i_stop;
110 i_index = (i_index+1) % VLC_MSG_QSIZE )
112 PrintMsg( p_this, &p_this->p_libvlc->msg_bank.msg[i_index] );
115 FlushMsg( &p_this->p_libvlc->msg_bank );
117 vlc_mutex_unlock( &p_this->p_libvlc->msg_bank.lock );
121 * Free resources allocated by msg_Create
123 * This functions prints all messages remaining in queue, then free all the
124 * resources allocated by msg_Create.
125 * No other messages interface functions should be called after this one.
127 void __msg_Destroy( vlc_object_t *p_this )
129 if( p_this->p_libvlc->msg_bank.i_sub )
131 msg_Err( p_this, "stale interface subscribers" );
134 /* Flush the queue */
135 if( !p_this->p_libvlc->msg_bank.b_configured )
141 FlushMsg( &p_this->p_libvlc->msg_bank );
145 CloseHandle( p_this->p_libvlc->msg_bank.logfile );
149 vlc_mutex_destroy( &p_this->p_libvlc->msg_bank.lock );
153 * Subscribe to the message queue.
155 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this )
157 msg_bank_t *p_bank = &p_this->p_libvlc->msg_bank;
158 msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
160 vlc_mutex_lock( &p_bank->lock );
162 /* Add subscription to the list */
163 INSERT_ELEM( p_bank->pp_sub, p_bank->i_sub, p_bank->i_sub, p_sub );
165 p_sub->i_start = p_bank->i_start;
166 p_sub->pi_stop = &p_bank->i_stop;
168 p_sub->p_msg = p_bank->msg;
169 p_sub->p_lock = &p_bank->lock;
171 vlc_mutex_unlock( &p_bank->lock );
177 * Unsubscribe from the message queue.
179 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
181 msg_bank_t *p_bank = &p_this->p_libvlc->msg_bank;
184 vlc_mutex_lock( &p_bank->lock );
189 msg_Err( p_this, "no subscriber in the list" );
193 /* Look for the appropriate subscription */
194 for( i_index = 0; i_index < p_bank->i_sub; i_index++ )
196 if( p_bank->pp_sub[ i_index ] == p_sub )
202 if( p_bank->pp_sub[ i_index ] != p_sub )
204 msg_Err( p_this, "subscriber not found" );
205 vlc_mutex_unlock( &p_bank->lock );
209 /* Remove this subscription */
210 REMOVE_ELEM( p_bank->pp_sub, p_bank->i_sub, i_index );
212 vlc_mutex_unlock( &p_bank->lock );
215 /*****************************************************************************
216 * __msg_*: print a message
217 *****************************************************************************
218 * These functions queue a message for later printing.
219 *****************************************************************************/
220 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
221 const char *psz_format, ... )
225 va_start( args, psz_format );
226 QueueMsg( p_this, i_type, psz_module, psz_format, args );
230 void __msg_GenericVa( vlc_object_t *p_this, int i_type, const char *psz_module,
231 const char *psz_format, va_list args )
233 QueueMsg( p_this, i_type, psz_module, psz_format, args );
236 /* Generic functions used when variadic macros are not available. */
237 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
238 void FN_NAME( vlc_object_t *p_this, const char *psz_format, ... ) \
241 va_start( args, psz_format ); \
242 QueueMsg( (vlc_object_t *)p_this, FN_TYPE, "unknown", \
243 psz_format, args ); \
248 * Output an informational message.
249 * \note Do not use this for debug messages
252 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
254 * Output an error message.
256 DECLARE_MSG_FN( __msg_Err, VLC_MSG_ERR );
258 * Output a waring message
260 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
262 * Output a debug message
264 DECLARE_MSG_FN( __msg_Dbg, VLC_MSG_DBG );
267 * Add a message to a queue
269 * This function provides basic functionnalities to other msg_* functions.
270 * It adds a message to a queue (after having printed all stored messages if it
271 * is full). If the message can't be converted to string in memory, it issues
274 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
275 const char *psz_format, va_list _args )
277 msg_bank_t * p_bank = &p_this->p_libvlc->msg_bank; /* message bank */
278 char * psz_str = NULL; /* formatted message string */
280 msg_item_t * p_item = NULL; /* pointer to message */
281 msg_item_t item; /* message in case of a full queue */
283 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
284 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
288 * Convert message to string
290 #if defined(HAVE_VASPRINTF) && !defined(SYS_DARWIN) && !defined( SYS_BEOS )
291 vlc_va_copy( args, _args );
292 vasprintf( &psz_str, psz_format, args );
295 psz_str = (char*) malloc( i_size * sizeof(char) );
298 if( psz_str == NULL )
300 fprintf( stderr, "main warning: can't store message (%s): ",
302 vlc_va_copy( args, _args );
303 vfprintf( stderr, psz_format, args );
305 fprintf( stderr, "\n" );
309 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
310 vlc_va_copy( args, _args );
311 vsnprintf( psz_str, i_size, psz_format, args );
313 psz_str[ i_size - 1 ] = 0; /* Just in case */
316 /* Put message in queue */
317 vlc_mutex_lock( &p_bank->lock );
319 /* Check there is room in the queue for our message */
320 if( p_bank->b_overflow )
324 if( ((p_bank->i_stop - p_bank->i_start + 1) % VLC_MSG_QSIZE) == 0 )
326 /* Still in overflow mode, print from a dummy item */
331 /* Pheeew, at last, there is room in the queue! */
332 p_bank->b_overflow = VLC_FALSE;
335 else if( ((p_bank->i_stop - p_bank->i_start + 2) % VLC_MSG_QSIZE) == 0 )
339 if( ((p_bank->i_stop - p_bank->i_start + 2) % VLC_MSG_QSIZE) == 0 )
341 p_bank->b_overflow = VLC_TRUE;
343 /* Put the overflow 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;
347 p_item->i_type = VLC_MSG_WARN;
348 p_item->i_object_id = p_this->i_object_id;
349 p_item->i_object_type = p_this->i_object_type;
350 p_item->psz_module = strdup( "message" );
351 p_item->psz_msg = strdup( "message queue overflowed" );
353 PrintMsg( p_this, p_item );
355 /* We print from a dummy item */
360 if( !p_bank->b_overflow )
362 /* Put the message in the queue */
363 p_item = p_bank->msg + p_bank->i_stop;
364 p_bank->i_stop = (p_bank->i_stop + 1) % VLC_MSG_QSIZE;
367 /* Fill message information fields */
368 p_item->i_type = i_type;
369 p_item->i_object_id = p_this->i_object_id;
370 p_item->i_object_type = p_this->i_object_type;
371 p_item->psz_module = strdup( psz_module );
372 p_item->psz_msg = psz_str;
374 PrintMsg( p_this, p_item );
376 if( p_bank->b_overflow )
378 free( p_item->psz_module );
379 free( p_item->psz_msg );
382 vlc_mutex_unlock( &p_bank->lock );
385 /* following functions are local */
387 /*****************************************************************************
389 *****************************************************************************
390 * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
391 * this function does not check the lock.
392 *****************************************************************************/
393 static void FlushMsg ( msg_bank_t *p_bank )
395 int i_index, i_start, i_stop;
397 /* Only flush the queue if it has been properly configured */
398 if( !p_bank->b_configured )
403 /* Get the maximum message index that can be freed */
404 i_stop = p_bank->i_stop;
406 /* Check until which value we can free messages */
407 for( i_index = 0; i_index < p_bank->i_sub; i_index++ )
409 i_start = p_bank->pp_sub[ i_index ]->i_start;
411 /* If this subscriber is late, we don't free messages before
412 * his i_start value, otherwise he'll miss messages */
413 if( ( i_start < i_stop
414 && (p_bank->i_stop <= i_start || i_stop <= p_bank->i_stop) )
415 || ( i_stop < i_start
416 && (i_stop <= p_bank->i_stop && p_bank->i_stop <= i_start) ) )
422 /* Free message data */
423 for( i_index = p_bank->i_start;
425 i_index = (i_index+1) % VLC_MSG_QSIZE )
427 free( p_bank->msg[i_index].psz_msg );
428 free( p_bank->msg[i_index].psz_module );
431 /* Update the new start value */
432 p_bank->i_start = i_index;
435 /*****************************************************************************
436 * PrintMsg: output a message item to stderr
437 *****************************************************************************
438 * Print a message to stderr, with colour formatting if needed.
439 *****************************************************************************/
440 static void PrintMsg ( vlc_object_t * p_this, msg_item_t * p_item )
442 # define COL(x) "\033[" #x ";1m"
444 # define GREEN COL(32)
445 # define YELLOW COL(33)
446 # define WHITE COL(37)
447 # define GRAY "\033[0m"
452 static const char * ppsz_type[4] = { "", " error", " warning", " debug" };
453 static const char *ppsz_color[4] = { WHITE, RED, YELLOW, GRAY };
454 char *psz_object = "private";
455 int i_type = p_item->i_type;
460 if( p_this->p_libvlc->i_verbose < 0 ) return;
463 if( p_this->p_libvlc->i_verbose < 0 ) return;
466 if( p_this->p_libvlc->i_verbose < 1 ) return;
469 if( p_this->p_libvlc->i_verbose < 2 ) return;
473 switch( p_item->i_object_type )
475 case VLC_OBJECT_ROOT: psz_object = "root"; break;
476 case VLC_OBJECT_VLC: psz_object = "vlc"; break;
477 case VLC_OBJECT_MODULE: psz_object = "module"; break;
478 case VLC_OBJECT_INTF: psz_object = "interface"; break;
479 case VLC_OBJECT_PLAYLIST: psz_object = "playlist"; break;
480 case VLC_OBJECT_ITEM: psz_object = "item"; break;
481 case VLC_OBJECT_INPUT: psz_object = "input"; break;
482 case VLC_OBJECT_DECODER: psz_object = "decoder"; break;
483 case VLC_OBJECT_PACKETIZER: psz_object = "packetizer"; break;
484 case VLC_OBJECT_ENCODER: psz_object = "encoder"; break;
485 case VLC_OBJECT_VOUT: psz_object = "video output"; break;
486 case VLC_OBJECT_AOUT: psz_object = "audio output"; break;
487 case VLC_OBJECT_SOUT: psz_object = "stream output"; break;
488 case VLC_OBJECT_HTTPD: psz_object = "http daemon"; break;
489 case VLC_OBJECT_DIALOGS: psz_object = "dialogs provider"; break;
490 case VLC_OBJECT_VLM: psz_object = "vlm"; break;
491 case VLC_OBJECT_ANNOUNCE: psz_object = "announce handler"; break;
492 case VLC_OBJECT_DEMUX: psz_object = "demuxer"; break;
493 case VLC_OBJECT_ACCESS: psz_object = "access"; break;
497 # define CE_WRITE(str) WriteFile( p_this->p_libvlc->msg_bank.logfile, \
498 str, strlen(str), &i_dummy, NULL );
499 CE_WRITE( p_item->psz_module );
501 CE_WRITE( psz_object );
502 CE_WRITE( ppsz_type[i_type] );
504 CE_WRITE( p_item->psz_msg );
506 FlushFileBuffers( p_this->p_libvlc->msg_bank.logfile );
509 /* Send the message to stderr */
510 if( p_this->p_libvlc->b_color )
512 fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s%s: %s%s" GRAY "\n",
513 p_item->i_object_id, p_item->psz_module, psz_object,
514 ppsz_type[i_type], ppsz_color[i_type],
519 fprintf( stderr, "[%.8i] %s %s%s: %s\n", p_item->i_object_id,
520 p_item->psz_module, psz_object, ppsz_type[i_type],