* This library provides an interface to the message queue to be used by other
* modules, especially intf modules. See vlc_config.h for output configuration.
*****************************************************************************
- * Copyright (C) 1998-2005 the VideoLAN team
+ * Copyright (C) 1998-2005 VLC authors and VideoLAN
* $Id$
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
* Samuel Hocevar <sam@zoy.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
# include "config.h"
#endif
-#include <vlc_common.h>
-
+#include <stdlib.h>
#include <stdarg.h> /* va_list for BSD */
-#ifdef __APPLE__
-# include <xlocale.h>
-#elif defined(HAVE_LOCALE_H)
-# include <locale.h>
-#endif
-#include <errno.h> /* errno */
-
-#ifdef WIN32
-# include <vlc_network.h> /* 'net_strerror' and 'WSAGetLastError' */
-#endif
-
-#include <assert.h>
+#include <unistd.h>
+#include <vlc_common.h>
+#include <vlc_interface.h>
#include <vlc_charset.h>
#include "../libvlc.h"
-static inline msg_bank_t *libvlc_bank (libvlc_int_t *inst)
-{
- return (libvlc_priv (inst))->msg_bank;
-}
-
-/*****************************************************************************
- * Local prototypes
- *****************************************************************************/
-static void PrintMsg ( vlc_object_t *, const msg_item_t * );
-
/**
- * Store all data required by messages interfaces.
+ * Emit a log message.
+ * \param obj VLC object emitting the message or NULL
+ * \param type VLC_MSG_* message type (info, error, warning or debug)
+ * \param module name of module from which the message come
+ * (normally MODULE_STRING)
+ * \param format printf-like message format
*/
-struct msg_bank_t
+void vlc_Log (vlc_object_t *obj, int type, const char *module,
+ const char *format, ... )
{
- /** Message queue lock */
- vlc_rwlock_t lock;
+ va_list args;
- /* Subscribers */
- int i_sub;
- msg_subscription_t **pp_sub;
+ va_start (args, format);
+ vlc_vaLog (obj, type, module, format, args);
+ va_end (args);
+}
- vlc_dictionary_t enabled_objects; ///< Enabled objects
- bool all_objects_enabled; ///< Should we print all objects?
-};
+#ifdef _WIN32
+static void Win32DebugOutputMsg (void *, int , const vlc_log_t *,
+ const char *, va_list);
+#endif
/**
- * Initialize messages queues
- * This function initializes all message queues
+ * Emit a log message. This function is the variable argument list equivalent
+ * to vlc_Log().
*/
-msg_bank_t *msg_Create (void)
+void vlc_vaLog (vlc_object_t *obj, int type, const char *module,
+ const char *format, va_list args)
{
- msg_bank_t *bank = malloc (sizeof (*bank));
+ if (obj != NULL && obj->i_flags & OBJECT_FLAGS_QUIET)
+ return;
- vlc_rwlock_init (&bank->lock);
- vlc_dictionary_init (&bank->enabled_objects, 0);
- bank->all_objects_enabled = true;
+ /* Get basename from the module filename */
+ char *p = strrchr(module, '/');
+ if (p != NULL)
+ module = p;
+ p = strchr(module, '.');
- bank->i_sub = 0;
- bank->pp_sub = NULL;
+ size_t modlen = (p != NULL) ? (p - module) : 0;
+ char modulebuf[modlen + 1];
+ if (p != NULL)
+ {
+ memcpy(modulebuf, module, modlen);
+ modulebuf[modlen] = '\0';
+ module = modulebuf;
+ }
- return bank;
-}
+ /* Fill message information fields */
+ vlc_log_t msg;
-/**
- * Object Printing selection
- */
-static void const * kObjectPrintingEnabled = &kObjectPrintingEnabled;
-static void const * kObjectPrintingDisabled = &kObjectPrintingDisabled;
+ msg.i_object_id = (uintptr_t)obj;
+ msg.psz_object_type = (obj != NULL) ? obj->psz_object_type : "generic";
+ msg.psz_module = module;
+ msg.psz_header = NULL;
+ for (vlc_object_t *o = obj; o != NULL; o = o->p_parent)
+ if (o->psz_header != NULL)
+ {
+ msg.psz_header = o->psz_header;
+ break;
+ }
-#undef msg_EnableObjectPrinting
-void msg_EnableObjectPrinting (vlc_object_t *obj, const char * psz_object)
-{
- msg_bank_t *bank = libvlc_bank (obj->p_libvlc);
+ /* Pass message to the callback */
+ libvlc_priv_t *priv = obj ? libvlc_priv (obj->p_libvlc) : NULL;
- vlc_rwlock_wrlock (&bank->lock);
- if( !strcmp(psz_object, "all") )
- bank->all_objects_enabled = true;
- else
- vlc_dictionary_insert (&bank->enabled_objects, psz_object,
- (void *)kObjectPrintingEnabled);
- vlc_rwlock_unlock (&bank->lock);
-}
+#ifdef _WIN32
+ va_list ap;
-#undef msg_DisableObjectPrinting
-void msg_DisableObjectPrinting (vlc_object_t *obj, const char * psz_object)
-{
- msg_bank_t *bank = libvlc_bank (obj->p_libvlc);
+ va_copy (ap, args);
+ Win32DebugOutputMsg (priv ? &priv->log.verbose : NULL, type, &msg, format, ap);
+ va_end (ap);
+#endif
- vlc_rwlock_wrlock (&bank->lock);
- if( !strcmp(psz_object, "all") )
- bank->all_objects_enabled = false;
- else
- vlc_dictionary_insert (&bank->enabled_objects, psz_object,
- (void *)kObjectPrintingDisabled);
- vlc_rwlock_unlock (&bank->lock);
+ if (priv) {
+ vlc_rwlock_rdlock (&priv->log.lock);
+ priv->log.cb (priv->log.opaque, type, &msg, format, args);
+ vlc_rwlock_unlock (&priv->log.lock);
+ }
}
-/**
- * Destroy the message queues
- *
- * This functions prints all messages remaining in the queues,
- * then frees all the allocated resources
- * No other messages interface functions should be called after this one.
- */
-void msg_Destroy (msg_bank_t *bank)
-{
- if (unlikely(bank->i_sub != 0))
- fputs ("stale interface subscribers (LibVLC might crash)\n", stderr);
-
- vlc_dictionary_clear (&bank->enabled_objects, NULL, NULL);
+static const char msg_type[4][9] = { "", " error", " warning", " debug" };
+#define COL(x,y) "\033[" #x ";" #y "m"
+#define RED COL(31,1)
+#define GREEN COL(32,1)
+#define YELLOW COL(0,33)
+#define WHITE COL(0,1)
+#define GRAY "\033[0m"
+static const char msg_color[4][8] = { WHITE, RED, YELLOW, GRAY };
- vlc_rwlock_destroy (&bank->lock);
- free (bank);
-}
-
-struct msg_subscription_t
-{
- libvlc_int_t *instance;
- msg_callback_t func;
- msg_cb_data_t *opaque;
-};
+/* Display size of a pointer */
+static const int ptr_width = 2 * /* hex digits */ sizeof(uintptr_t);
-/**
- * Subscribe to the message queue.
- * Whenever a message is emitted, a callback will be called.
- * Callback invocation are serialized within a subscription.
- *
- * @param instance LibVLC instance to get messages from
- * @param cb callback function
- * @param opaque data for the callback function
- * @return a subscription pointer, or NULL in case of failure
- */
-msg_subscription_t *msg_Subscribe (libvlc_int_t *instance, msg_callback_t cb,
- msg_cb_data_t *opaque)
+static void PrintColorMsg (void *d, int type, const vlc_log_t *p_item,
+ const char *format, va_list ap)
{
- msg_subscription_t *sub = malloc (sizeof (*sub));
- if (sub == NULL)
- return NULL;
+ FILE *stream = stderr;
+ int verbose = (intptr_t)d;
- sub->instance = instance;
- sub->func = cb;
- sub->opaque = opaque;
+ if (verbose < 0 || verbose < (type - VLC_MSG_ERR))
+ return;
- msg_bank_t *bank = libvlc_bank (instance);
- vlc_rwlock_wrlock (&bank->lock);
- TAB_APPEND (bank->i_sub, bank->pp_sub, sub);
- vlc_rwlock_unlock (&bank->lock);
+ int canc = vlc_savecancel ();
- return sub;
+ flockfile (stream);
+ utf8_fprintf (stream, "["GREEN"%0*"PRIxPTR""GRAY"] ", ptr_width, p_item->i_object_id);
+ if (p_item->psz_header != NULL)
+ utf8_fprintf (stream, "[%s] ", p_item->psz_header);
+ utf8_fprintf (stream, "%s %s%s: %s", p_item->psz_module,
+ p_item->psz_object_type, msg_type[type], msg_color[type]);
+ utf8_vfprintf (stream, format, ap);
+ fputs (GRAY"\n", stream);
+#if defined (_WIN32) || defined (__OS2__)
+ fflush (stream);
+#endif
+ funlockfile (stream);
+ vlc_restorecancel (canc);
}
-/**
- * Unsubscribe from the message queue.
- * This function waits for the message callback to return if needed.
- */
-void msg_Unsubscribe (msg_subscription_t *sub)
+static void PrintMsg (void *d, int type, const vlc_log_t *p_item,
+ const char *format, va_list ap)
{
- msg_bank_t *bank = libvlc_bank (sub->instance);
+ FILE *stream = stderr;
+ int verbose = (intptr_t)d;
- vlc_rwlock_wrlock (&bank->lock);
- TAB_REMOVE (bank->i_sub, bank->pp_sub, sub);
- vlc_rwlock_unlock (&bank->lock);
- free (sub);
-}
+ if (verbose < 0 || verbose < (type - VLC_MSG_ERR))
+ return;
-/*****************************************************************************
- * msg_*: print a message
- *****************************************************************************
- * These functions queue a message for later printing.
- *****************************************************************************/
-void msg_Generic( vlc_object_t *p_this, int i_type, const char *psz_module,
- const char *psz_format, ... )
-{
- va_list args;
+ int canc = vlc_savecancel ();
- va_start( args, psz_format );
- msg_GenericVa (p_this, i_type, psz_module, psz_format, args);
- va_end( args );
+ flockfile (stream);
+ utf8_fprintf (stream, "[%0*"PRIxPTR"] ", ptr_width, p_item->i_object_id);
+ if (p_item->psz_header != NULL)
+ utf8_fprintf (stream, "[%s] ", p_item->psz_header);
+ utf8_fprintf (stream, "%s %s%s: ", p_item->psz_module,
+ p_item->psz_object_type, msg_type[type]);
+ utf8_vfprintf (stream, format, ap);
+ putc_unlocked ('\n', stream);
+#if defined (_WIN32) || defined (__OS2__)
+ fflush (stream);
+#endif
+ funlockfile (stream);
+ vlc_restorecancel (canc);
}
-#undef msg_GenericVa
-/**
- * Add a message to a queue
- *
- * This function provides basic functionnalities to other msg_* functions.
- * It adds a message to a queue (after having printed all stored messages if it
- * is full). If the message can't be converted to string in memory, it issues
- * a warning.
- */
-void msg_GenericVa (vlc_object_t *p_this, int i_type, const char *psz_module,
- const char *psz_format, va_list args)
+#ifdef _WIN32
+static void Win32DebugOutputMsg (void* d, int type, const vlc_log_t *p_item,
+ const char *format, va_list dol)
{
- assert (p_this);
+ VLC_UNUSED(p_item);
- if( p_this->i_flags & OBJECT_FLAGS_QUIET )
+ const signed char *pverbose = d;
+ if (pverbose && (*pverbose < 0 || *pverbose < (type - VLC_MSG_ERR)))
return;
- msg_bank_t *bank = libvlc_bank (p_this->p_libvlc);
-
- /* C locale to get error messages in English in the logs */
- locale_t c = newlocale (LC_MESSAGES_MASK, "C", (locale_t)0);
- locale_t locale = uselocale (c);
+ va_list dol2;
+ va_copy (dol2, dol);
+ int msg_len = vsnprintf(NULL, 0, format, dol2);
+ va_end (dol2);
-#ifndef __GLIBC__
- /* Expand %m to strerror(errno) - only once */
- char buf[strlen( psz_format ) + 2001], *ptr;
- strcpy( buf, psz_format );
- ptr = (char*)buf;
- psz_format = (const char*) buf;
+ if(msg_len <= 0)
+ return;
- for( ;; )
- {
- ptr = strchr( ptr, '%' );
- if( ptr == NULL )
- break;
+ char *msg = malloc(msg_len + 1 + 1);
+ if (!msg)
+ return;
- if( ptr[1] == 'm' )
- {
- char errbuf[2001];
- size_t errlen;
-
-#ifndef WIN32
- strerror_r( errno, errbuf, 1001 );
-#else
- int sockerr = WSAGetLastError( );
- if( sockerr )
- {
- strncpy( errbuf, net_strerror( sockerr ), 1001 );
- WSASetLastError( sockerr );
- }
- if ((sockerr == 0)
- || (strcmp ("Unknown network stack error", errbuf) == 0))
- strncpy( errbuf, strerror( errno ), 1001 );
-#endif
- errbuf[1000] = 0;
-
- /* Escape '%' from the error string */
- for( char *percent = strchr( errbuf, '%' );
- percent != NULL;
- percent = strchr( percent + 2, '%' ) )
- {
- memmove( percent + 1, percent, strlen( percent ) + 1 );
- }
-
- errlen = strlen( errbuf );
- memmove( ptr + errlen, ptr + 2, strlen( ptr + 2 ) + 1 );
- memcpy( ptr, errbuf, errlen );
- break; /* Only once, so we don't overflow */
+ msg_len = vsnprintf(msg, msg_len+1, format, dol);
+ if (msg_len > 0){
+ if(msg[msg_len-1] != '\n'){
+ msg[msg_len] = '\n';
+ msg[msg_len + 1] = '\0';
+ }
+ char* psz_msg = NULL;
+ if(asprintf(&psz_msg, "%s %s%s: %s", p_item->psz_module,
+ p_item->psz_object_type, msg_type[type], msg) > 0) {
+ wchar_t* wmsg = ToWide(psz_msg);
+ OutputDebugStringW(wmsg);
+ free(wmsg);
+ free(psz_msg);
}
-
- /* Looks for conversion specifier... */
- do
- ptr++;
- while( *ptr && ( strchr( "diouxXeEfFgGaAcspn%", *ptr ) == NULL ) );
- if( *ptr )
- ptr++; /* ...and skip it */
}
+ free(msg);
+}
#endif
- /* Convert message to string */
- static const char nomemstr[] = "<not enough memory to format message>";
- char *str;
-
- if (unlikely(vasprintf (&str, psz_format, args) == -1))
- str = (char *)nomemstr;
-
- uselocale (locale);
- freelocale (c);
-
- /* Fill message information fields */
- msg_item_t msg;
-
- msg.i_type = i_type;
- msg.i_object_id = (uintptr_t)p_this;
- msg.psz_object_type = p_this->psz_object_type;
- msg.psz_module = psz_module;
- msg.psz_msg = str;
- msg.psz_header = NULL;
-
- for (vlc_object_t *o = p_this; o != NULL; o = o->p_parent)
- if (o->psz_header != NULL)
- {
- msg.psz_header = o->psz_header;
- break;
- }
-
- PrintMsg( p_this, &msg );
+/**
+ * Sets the message logging callback.
+ * \param cb message callback, or NULL to reset
+ * \param data data pointer for the message callback
+ */
+void vlc_LogSet (libvlc_int_t *vlc, vlc_log_cb cb, void *opaque)
+{
+ libvlc_priv_t *priv = libvlc_priv (vlc);
- vlc_rwlock_rdlock (&bank->lock);
- for (int i = 0; i < bank->i_sub; i++)
+ if (cb == NULL)
{
- msg_subscription_t *sub = bank->pp_sub[i];
- libvlc_priv_t *priv = libvlc_priv( sub->instance );
- msg_bank_t *bank = priv->msg_bank;
- void *val = vlc_dictionary_value_for_key( &bank->enabled_objects,
- msg.psz_module );
- if( val == kObjectPrintingDisabled ) continue;
- if( val != kObjectPrintingEnabled ) /*if not allowed */
- {
- val = vlc_dictionary_value_for_key( &bank->enabled_objects,
- msg.psz_object_type );
- if( val == kObjectPrintingDisabled ) continue;
- if( val == kObjectPrintingEnabled ); /* Allowed */
- else if( !bank->all_objects_enabled ) continue;
- }
- sub->func (sub->opaque, &msg);
+#if defined (HAVE_ISATTY) && !defined (_WIN32)
+ if (isatty (STDERR_FILENO) && var_InheritBool (vlc, "color"))
+ cb = PrintColorMsg;
+ else
+#endif
+ cb = PrintMsg;
+ opaque = (void *)(intptr_t)priv->log.verbose;
}
- vlc_rwlock_unlock (&bank->lock);
- if (likely(str != (char *)nomemstr))
- free (str);
+ vlc_rwlock_wrlock (&priv->log.lock);
+ priv->log.cb = cb;
+ priv->log.opaque = opaque;
+ vlc_rwlock_unlock (&priv->log.lock);
+
+ /* Announce who we are */
+ msg_Dbg (vlc, "VLC media player - %s", VERSION_MESSAGE);
+ msg_Dbg (vlc, "%s", COPYRIGHT_MESSAGE);
+ msg_Dbg (vlc, "revision %s", psz_vlc_changeset);
+ msg_Dbg (vlc, "configured with %s", CONFIGURE_LINE);
}
-/*****************************************************************************
- * PrintMsg: output a standard message item to stderr
- *****************************************************************************
- * Print a message to stderr, with colour formatting if needed.
- *****************************************************************************/
-static void PrintMsg ( vlc_object_t *p_this, const msg_item_t *p_item )
+void vlc_LogInit (libvlc_int_t *vlc)
{
-# define COL(x,y) "\033[" #x ";" #y "m"
-# define RED COL(31,1)
-# define GREEN COL(32,1)
-# define YELLOW COL(0,33)
-# define WHITE COL(0,1)
-# define GRAY "\033[0m"
- static const char msgtype[4][9] = { "", " error", " warning", " debug" };
- static const char msgcolor[4][8] = { WHITE, RED, YELLOW, GRAY };
-
- libvlc_priv_t *priv = libvlc_priv (p_this->p_libvlc);
- int type = p_item->i_type;
-
- if (priv->i_verbose < 0 || priv->i_verbose < (type - VLC_MSG_ERR))
- return;
+ libvlc_priv_t *priv = libvlc_priv (vlc);
+ const char *str;
- const char *objtype = p_item->psz_object_type;
- msg_bank_t *bank = priv->msg_bank;
- void * val = vlc_dictionary_value_for_key (&bank->enabled_objects,
- p_item->psz_module);
- if( val == kObjectPrintingDisabled )
- return;
- if( val == kObjectPrintingEnabled )
- /* Allowed */;
+ if (var_InheritBool (vlc, "quiet"))
+ priv->log.verbose = -1;
else
- {
- val = vlc_dictionary_value_for_key (&bank->enabled_objects,
- objtype);
- if( val == kObjectPrintingDisabled )
- return;
- if( val == kObjectPrintingEnabled )
- /* Allowed */;
- else if( !bank->all_objects_enabled )
- return;
- }
+ if ((str = getenv ("VLC_VERBOSE")) != NULL)
+ priv->log.verbose = atoi (str);
+ else
+ priv->log.verbose = var_InheritInteger (vlc, "verbose");
- /* Send the message to stderr */
- FILE *stream = stderr;
- int canc = vlc_savecancel ();
+ vlc_rwlock_init (&priv->log.lock);
+ vlc_LogSet (vlc, NULL, NULL);
+}
- flockfile (stream);
- fprintf (stream, priv->b_color ? "["GREEN"%p"GRAY"] " : "[%p] ",
- (void *)p_item->i_object_id);
- if (p_item->psz_header != NULL)
- utf8_fprintf (stream, "[%s] ", p_item->psz_header);
- utf8_fprintf (stream, "%s %s%s: ", p_item->psz_module, objtype,
- msgtype[type]);
- if (priv->b_color)
- fputs (msgcolor[type], stream);
- fputs (p_item->psz_msg, stream);
- if (priv->b_color)
- fputs (GRAY, stream);
- putc_unlocked ('\n', stream);
-#if defined (WIN32) || defined (__OS2__)
- fflush (stream);
-#endif
- funlockfile (stream);
- vlc_restorecancel (canc);
+void vlc_LogDeinit (libvlc_int_t *vlc)
+{
+ libvlc_priv_t *priv = libvlc_priv (vlc);
+
+ vlc_rwlock_destroy (&priv->log.lock);
}
projects / vlc / blobdiff