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