]> git.sesse.net Git - vlc/blobdiff - src/misc/messages.c
picture: assert that there is a destroy callback
[vlc] / src / misc / messages.c
index 74aeabf6236f3adc6f890f13dc23daf4a178cd42..cc91a662fad795514554cf29fa88532401b015c6 100644 (file)
@@ -3,25 +3,25 @@
  * 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.
  *****************************************************************************/
 
 /*****************************************************************************
@@ -32,8 +32,7 @@
 # include "config.h"
 #endif
 
-#include <vlc_common.h>
-
+#include <stdlib.h>
 #include <stdarg.h>                                       /* va_list for BSD */
 #ifdef __APPLE__
 # include <xlocale.h>
 # include <locale.h>
 #endif
 #include <errno.h>                                                  /* errno */
+#include <assert.h>
+#include <unistd.h>
 
-#ifdef WIN32
+#include <vlc_common.h>
+#include <vlc_interface.h>
+#ifdef _WIN32
 #   include <vlc_network.h>          /* 'net_strerror' and 'WSAGetLastError' */
 #endif
-
-#include <assert.h>
-
 #include <vlc_charset.h>
 #include "../libvlc.h"
 
-/*****************************************************************************
- * Local prototypes
- *****************************************************************************/
-static void PrintMsg ( vlc_object_t *, const msg_item_t * );
-
-/**
- * Store all data required by messages interfaces.
- */
-vlc_rwlock_t msg_lock = VLC_STATIC_RWLOCK;
-msg_subscription_t *msg_head;
-
-struct msg_subscription_t
-{
-    msg_subscription_t *prev, *next;
-    msg_callback_t  func;
-    msg_cb_data_t  *opaque;
-};
-
-/**
- * Subscribe to the message queue.
- * Whenever a message is emitted, a callback will be called.
- * Callback invocation are serialized within a subscription.
- *
- * @param cb callback function
- * @param opaque data for the callback function
- * @return a subscription pointer, or NULL in case of failure
- */
-msg_subscription_t *vlc_Subscribe (msg_callback_t cb, msg_cb_data_t *opaque)
-{
-    msg_subscription_t *sub = malloc (sizeof (*sub));
-    if (sub == NULL)
-        return NULL;
-
-    sub->prev = NULL;
-    sub->func = cb;
-    sub->opaque = opaque;
-
-    vlc_rwlock_wrlock (&msg_lock);
-    sub->next = msg_head;
-    msg_head = sub;
-    vlc_rwlock_unlock (&msg_lock);
-
-    return sub;
-}
-
-/**
- * Unsubscribe from the message queue.
- * This function waits for the message callback to return if needed.
- */
-void vlc_Unsubscribe (msg_subscription_t *sub)
-{
-    vlc_rwlock_wrlock (&msg_lock);
-    if (sub->next != NULL)
-        sub->next->prev = sub->prev;
-    if (sub->prev != NULL)
-        sub->prev->next = sub->next;
-    else
-    {
-        assert (msg_head == sub);
-        msg_head = sub->next;
-    }
-    vlc_rwlock_unlock (&msg_lock);
-    free (sub);
-}
-
 /**
  * Emit a log message.
- * \param obj VLC object emitting the 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)
@@ -134,6 +69,11 @@ void vlc_Log (vlc_object_t *obj, int type, const char *module,
     va_end (args);
 }
 
+#ifdef _WIN32
+static void Win32DebugOutputMsg (void *, int , const vlc_log_t *,
+                                 const char *, va_list);
+#endif
+
 /**
  * Emit a log message. This function is the variable argument list equivalent
  * to vlc_Log().
@@ -141,9 +81,7 @@ void vlc_Log (vlc_object_t *obj, int type, const char *module,
 void vlc_vaLog (vlc_object_t *obj, int type, const char *module,
                 const char *format, va_list args)
 {
-    assert (obj != NULL);
-
-    if (obj->i_flags & OBJECT_FLAGS_QUIET)
+    if (obj != NULL && obj->i_flags & OBJECT_FLAGS_QUIET)
         return;
 
     /* C locale to get error messages in English in the logs */
@@ -168,7 +106,7 @@ void vlc_vaLog (vlc_object_t *obj, int type, const char *module,
             char errbuf[2001];
             size_t errlen;
 
-#ifndef WIN32
+#ifndef _WIN32
             strerror_r( errno, errbuf, 1001 );
 #else
             int sockerr = WSAGetLastError( );
@@ -206,24 +144,12 @@ void vlc_vaLog (vlc_object_t *obj, int type, const char *module,
     }
 #endif
 
-    /* Convert message to string  */
-    static const char nomemstr[] = "<not enough memory to format message>";
-    char *str;
-
-    if (unlikely(vasprintf (&str, format, args) == -1))
-        str = (char *)nomemstr;
-
-    uselocale (locale);
-    freelocale (c);
-
     /* Fill message information fields */
-    msg_item_t msg;
+    vlc_log_t msg;
 
-    msg.i_type = type;
     msg.i_object_id = (uintptr_t)obj;
-    msg.psz_object_type = obj->psz_object_type;
+    msg.psz_object_type = (obj != NULL) ? obj->psz_object_type : "generic";
     msg.psz_module = module;
-    msg.psz_msg = str;
     msg.psz_header = NULL;
 
     for (vlc_object_t *o = obj; o != NULL; o = o->p_parent)
@@ -233,59 +159,181 @@ void vlc_vaLog (vlc_object_t *obj, int type, const char *module,
             break;
         }
 
-    PrintMsg (obj, &msg);
+    /* Pass message to the callback */
+    libvlc_priv_t *priv = obj ? libvlc_priv (obj->p_libvlc) : NULL;
+
+#ifdef _WIN32
+    va_list ap;
 
-    vlc_rwlock_rdlock (&msg_lock);
-    for (msg_subscription_t *sub = msg_head; sub != NULL; sub = sub->next)
-        sub->func (sub->opaque, &msg);
-    vlc_rwlock_unlock (&msg_lock);
+    va_copy (ap, args);
+    Win32DebugOutputMsg (priv ? &priv->log.verbose : NULL, type, &msg, format, ap);
+    va_end (ap);
+#endif
 
-    if (likely(str != (char *)nomemstr))
-        free (str);
+    if (priv) {
+        vlc_rwlock_rdlock (&priv->log.lock);
+        priv->log.cb (priv->log.opaque, type, &msg, format, args);
+        vlc_rwlock_unlock (&priv->log.lock);
+    }
+
+    uselocale (locale);
+    freelocale (c);
 }
 
-/*****************************************************************************
- * 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 )
+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 };
+
+static void PrintColorMsg (void *d, int type, const vlc_log_t *p_item,
+                           const char *format, va_list ap)
 {
-#   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))
+    FILE *stream = stderr;
+    int verbose = (intptr_t)d;
+
+    if (verbose < 0 || verbose < (type - VLC_MSG_ERR))
         return;
 
-    /* Send the message to stderr */
+    int canc = vlc_savecancel ();
+
+    flockfile (stream);
+    fprintf (stream, "["GREEN"%p"GRAY"] ", (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: %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);
+}
+
+static void PrintMsg (void *d, int type, const vlc_log_t *p_item,
+                      const char *format, va_list ap)
+{
     FILE *stream = stderr;
+    int verbose = (intptr_t)d;
+
+    if (verbose < 0 || verbose < (type - VLC_MSG_ERR))
+        return;
+
     int canc = vlc_savecancel ();
 
     flockfile (stream);
-    fprintf (stream, priv->b_color ? "["GREEN"%p"GRAY"] " : "[%p] ",
-            (void *)p_item->i_object_id);
+    fprintf (stream, "[%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,
-                  p_item->psz_object_type, msgtype[type]);
-    if (priv->b_color)
-        fputs (msgcolor[type], stream);
-    fputs (p_item->psz_msg, stream);
-    if (priv->b_color)
-        fputs (GRAY, stream);
+                  p_item->psz_object_type, msg_type[type]);
+    utf8_vfprintf (stream, format, ap);
     putc_unlocked ('\n', stream);
-#if defined (WIN32) || defined (__OS2__)
+#if defined (_WIN32) || defined (__OS2__)
     fflush (stream);
 #endif
     funlockfile (stream);
     vlc_restorecancel (canc);
 }
+
+#ifdef _WIN32
+static void Win32DebugOutputMsg (void* d, int type, const vlc_log_t *p_item,
+                                 const char *format, va_list dol)
+{
+    VLC_UNUSED(p_item);
+
+    const signed char *pverbose = d;
+    if (pverbose && (*pverbose < 0 || *pverbose < (type - VLC_MSG_ERR)))
+        return;
+
+    va_list dol2;
+    va_copy (dol2, dol);
+    int msg_len = vsnprintf(NULL, 0, format, dol2);
+    va_end (dol2);
+
+    if(msg_len <= 0)
+        return;
+
+    char *msg = malloc(msg_len + 1 + 1);
+    if (!msg)
+        return;
+
+    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);
+        }
+    }
+    free(msg);
+}
+#endif
+
+/**
+ * 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);
+
+    if (cb == NULL)
+    {
+#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_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);
+}
+
+void vlc_LogInit (libvlc_int_t *vlc)
+{
+    libvlc_priv_t *priv = libvlc_priv (vlc);
+    const char *str;
+
+    if (var_InheritBool (vlc, "quiet"))
+        priv->log.verbose = -1;
+    else
+    if ((str = getenv ("VLC_VERBOSE")) != NULL)
+        priv->log.verbose = atoi (str);
+    else
+        priv->log.verbose = var_InheritInteger (vlc, "verbose");
+
+    vlc_rwlock_init (&priv->log.lock);
+    vlc_LogSet (vlc, NULL, NULL);
+}
+
+void vlc_LogDeinit (libvlc_int_t *vlc)
+{
+    libvlc_priv_t *priv = libvlc_priv (vlc);
+
+    vlc_rwlock_destroy (&priv->log.lock);
+}