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.36 2003/12/03 23:01:48 sigmunau Exp $
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 */
42 # include <errno.h> /* errno */
46 # include <unistd.h> /* close(), write() */
49 #include "vlc_interface.h"
51 /*****************************************************************************
53 *****************************************************************************/
54 #if defined(HAVE_VA_COPY)
55 # define vlc_va_copy(dest,src) va_copy(dest,src)
56 #elif defined(HAVE___VA_COPY)
57 # define vlc_va_copy(dest,src) __va_copy(dest,src)
59 # define vlc_va_copy(dest,src) (dest)=(src)
62 /*****************************************************************************
64 *****************************************************************************/
65 static void QueueMsg ( vlc_object_t *, int , const char *,
66 const char *, va_list );
67 static void FlushMsg ( msg_bank_t * );
68 static void PrintMsg ( vlc_object_t *, msg_item_t * );
71 * Initialize messages interface
73 * This functions has to be called before any call to other msg_* functions.
74 * It set up the locks and the message queue if it is used.
76 void __msg_Create( vlc_object_t *p_this )
78 /* Message queue initialization */
79 vlc_mutex_init( p_this, &p_this->p_libvlc->msg_bank.lock );
81 p_this->p_libvlc->msg_bank.b_configured = VLC_FALSE;
82 p_this->p_libvlc->msg_bank.b_overflow = VLC_FALSE;
84 p_this->p_libvlc->msg_bank.i_start = 0;
85 p_this->p_libvlc->msg_bank.i_stop = 0;
87 p_this->p_libvlc->msg_bank.i_sub = 0;
88 p_this->p_libvlc->msg_bank.pp_sub = NULL;
91 p_this->p_libvlc->msg_bank.logfile =
92 CreateFile( L"vlc-log.txt", GENERIC_WRITE,
93 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
94 CREATE_ALWAYS, 0, NULL );
95 SetFilePointer( p_this->p_libvlc->msg_bank.logfile, 0, NULL, FILE_END );
100 * Flush the message queue
102 void __msg_Flush( vlc_object_t *p_this )
106 vlc_mutex_lock( &p_this->p_libvlc->msg_bank.lock );
108 p_this->p_libvlc->msg_bank.b_configured = VLC_TRUE;
110 for( i_index = p_this->p_libvlc->msg_bank.i_start;
111 i_index != p_this->p_libvlc->msg_bank.i_stop;
112 i_index = (i_index+1) % VLC_MSG_QSIZE )
114 PrintMsg( p_this, &p_this->p_libvlc->msg_bank.msg[i_index] );
117 FlushMsg( &p_this->p_libvlc->msg_bank );
119 vlc_mutex_unlock( &p_this->p_libvlc->msg_bank.lock );
123 * Free resources allocated by msg_Create
125 * This functions prints all messages remaining in queue, then free all the
126 * resources allocated by msg_Create.
127 * No other messages interface functions should be called after this one.
129 void __msg_Destroy( vlc_object_t *p_this )
131 if( p_this->p_libvlc->msg_bank.i_sub )
133 msg_Err( p_this, "stale interface subscribers" );
136 /* Flush the queue */
137 if( !p_this->p_libvlc->msg_bank.b_configured )
143 FlushMsg( &p_this->p_libvlc->msg_bank );
147 CloseHandle( p_this->p_libvlc->msg_bank.logfile );
151 vlc_mutex_destroy( &p_this->p_libvlc->msg_bank.lock );
155 * Subscribe to the message queue.
157 msg_subscription_t *__msg_Subscribe( vlc_object_t *p_this )
159 msg_bank_t *p_bank = &p_this->p_libvlc->msg_bank;
160 msg_subscription_t *p_sub = malloc( sizeof( msg_subscription_t ) );
162 vlc_mutex_lock( &p_bank->lock );
164 /* Add subscription to the list */
165 INSERT_ELEM( p_bank->pp_sub, p_bank->i_sub, p_bank->i_sub, p_sub );
167 p_sub->i_start = p_bank->i_start;
168 p_sub->pi_stop = &p_bank->i_stop;
170 p_sub->p_msg = p_bank->msg;
171 p_sub->p_lock = &p_bank->lock;
173 vlc_mutex_unlock( &p_bank->lock );
179 * Unsubscribe from the message queue.
181 void __msg_Unsubscribe( vlc_object_t *p_this, msg_subscription_t *p_sub )
183 msg_bank_t *p_bank = &p_this->p_libvlc->msg_bank;
186 vlc_mutex_lock( &p_bank->lock );
191 msg_Err( p_this, "no subscriber in the list" );
195 /* Look for the appropriate subscription */
196 for( i_index = 0; i_index < p_bank->i_sub; i_index++ )
198 if( p_bank->pp_sub[ i_index ] == p_sub )
204 if( p_bank->pp_sub[ i_index ] != p_sub )
206 msg_Err( p_this, "subscriber not found" );
207 vlc_mutex_unlock( &p_bank->lock );
211 /* Remove this subscription */
212 REMOVE_ELEM( p_bank->pp_sub, p_bank->i_sub, i_index );
214 vlc_mutex_unlock( &p_bank->lock );
217 /*****************************************************************************
218 * __msg_*: print a message
219 *****************************************************************************
220 * These functions queue a message for later printing.
221 *****************************************************************************/
222 void __msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
223 const char *psz_format, ... )
227 va_start( args, psz_format );
228 QueueMsg( p_this, i_type, psz_module, psz_format, args );
232 /* Generic functions used when variadic macros are not available. */
233 #define DECLARE_MSG_FN( FN_NAME, FN_TYPE ) \
234 void FN_NAME( vlc_object_t *p_this, const char *psz_format, ... ) \
237 va_start( args, psz_format ); \
238 QueueMsg( (vlc_object_t *)p_this, FN_TYPE, "unknown", \
239 psz_format, args ); \
244 * Output an informational message.
245 * \note Do not use this for debug messages
248 DECLARE_MSG_FN( __msg_Info, VLC_MSG_INFO );
250 * Output an error message.
252 DECLARE_MSG_FN( __msg_Err, VLC_MSG_ERR );
254 * Output a waring message
256 DECLARE_MSG_FN( __msg_Warn, VLC_MSG_WARN );
258 * Output a debug message
260 DECLARE_MSG_FN( __msg_Dbg, VLC_MSG_DBG );
263 * Add a message to a queue
265 * This function provides basic functionnalities to other msg_* functions.
266 * It adds a message to a queue (after having printed all stored messages if it
267 * is full). If the message can't be converted to string in memory, it issues
270 static void QueueMsg( vlc_object_t *p_this, int i_type, const char *psz_module,
271 const char *psz_format, va_list _args )
273 msg_bank_t * p_bank = &p_this->p_libvlc->msg_bank; /* message bank */
274 char * psz_str = NULL; /* formatted message string */
276 msg_item_t * p_item = NULL; /* pointer to message */
277 msg_item_t item; /* message in case of a full queue */
279 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
280 int i_size = strlen(psz_format) + INTF_MAX_MSG_SIZE;
284 * Convert message to string
286 #if defined(HAVE_VASPRINTF) && !defined(SYS_DARWIN) && !defined( SYS_BEOS )
287 vlc_va_copy( args, _args );
288 vasprintf( &psz_str, psz_format, args );
291 psz_str = (char*) malloc( i_size * sizeof(char) );
294 if( psz_str == NULL )
297 fprintf( stderr, "main warning: can't store message (%s): ",
300 fprintf( stderr, "main warning: can't store message: " );
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;
491 # define CE_WRITE(str) WriteFile( p_this->p_libvlc->msg_bank.logfile, \
492 str, strlen(str), &i_dummy, NULL );
493 CE_WRITE( p_item->psz_module );
495 CE_WRITE( psz_object );
496 CE_WRITE( ppsz_type[i_type] );
498 CE_WRITE( p_item->psz_msg );
500 FlushFileBuffers( p_this->p_libvlc->msg_bank.logfile );
503 /* Send the message to stderr */
504 if( p_this->p_libvlc->b_color )
506 fprintf( stderr, "[" GREEN "%.8i" GRAY "] %s %s%s: %s%s" GRAY "\n",
507 p_item->i_object_id, p_item->psz_module, psz_object,
508 ppsz_type[i_type], ppsz_color[i_type],
513 fprintf( stderr, "[%.8i] %s %s%s: %s\n", p_item->i_object_id,
514 p_item->psz_module, psz_object, ppsz_type[i_type],