]> git.sesse.net Git - vlc/blobdiff - include/vlc_messages.h
Merge branch 'master' into lpcm_encoder
[vlc] / include / vlc_messages.h
index 537c624b5549e7a6277b7d3e4639a6f0f24772e3..6bfd5dada59612929362cab58d6cc87e235d4d70 100644 (file)
@@ -3,8 +3,8 @@
  * This library provides basic functions for threads to interact with user
  * interface, such as message output.
  *****************************************************************************
- * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
- * $Id: vlc_messages.h,v 1.11 2004/01/25 18:17:08 zorglub Exp $
+ * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
+ * $Id$
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  *          Samuel Hocevar <sam@zoy.org>
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+#ifndef VLC_MESSAGES_H_
+#define VLC_MESSAGES_H_
+
+/**
+ * \file
+ * This file defines structures and functions to handle messages and statistics gathering
+ */
+
 #include <stdarg.h>
+
 /**
  * \defgroup messages Messages
  * This library provides basic functions for threads to interact with user
  * @{
  */
 
-
 /**
- * Store a single message.
+ * Store a single message sent to user.
  */
 typedef struct
 {
     int     i_type;                             /**< message type, see below */
-    int     i_object_id;
-    int     i_object_type;
+    uintptr_t   i_object_id;
+    const char *psz_object_type;
     char *  psz_module;
-    char *  psz_msg;                                 /**< the message itself */
+    char *  psz_msg;                            /**< the message itself */
+    char *  psz_header;                         /**< Additional header */
 
-#if 0
-    mtime_t date;                                     /* date of the message */
-    char *  psz_file;               /* file in which the function was called */
-    char *  psz_function;     /* function from which the function was called */
-    int     i_line;                 /* line at which the function was called */
-#endif
+    mtime_t date;                               /**< Message date */
+    gc_object_t vlc_gc_data;
 } msg_item_t;
 
 /* Message types */
@@ -63,128 +68,158 @@ typedef struct
 /** debug messages */
 #define VLC_MSG_DBG   3
 
-/**
- * Store all data requiered by messages interfaces.
- */
-struct msg_bank_t
+static inline msg_item_t *msg_Hold (msg_item_t *msg)
 {
-    /** Message queue lock */
-    vlc_mutex_t             lock;
-    vlc_bool_t              b_configured;
-    vlc_bool_t              b_overflow;
-
-    /* Message queue */
-    msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
-    int i_start;
-    int i_stop;
-
-    /* Subscribers */
-    int i_sub;
-    msg_subscription_t **pp_sub;
-
-    /* Logfile for WinCE */
-#ifdef UNDER_CE
-    FILE *logfile;
-#endif
-};
+    vlc_hold (&msg->vlc_gc_data);
+    return msg;
+}
+
+static inline void msg_Release (msg_item_t *msg)
+{
+    vlc_release (&msg->vlc_gc_data);
+}
 
 /**
  * Used by interface plugins which subscribe to the message bank.
  */
-struct msg_subscription_t
-{
-    int   i_start;
-    int*  pi_stop;
-
-    msg_item_t*  p_msg;
-    vlc_mutex_t* p_lock;
-};
+typedef struct msg_subscription_t msg_subscription_t;
 
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) ATTRIBUTE_FORMAT( 4, 5 ) );
-VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
-VLC_EXPORT( void, __msg_Info,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
-VLC_EXPORT( void, __msg_Err,     ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
-VLC_EXPORT( void, __msg_Warn,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
-VLC_EXPORT( void, __msg_Dbg,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
+VLC_EXPORT( void, msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
+VLC_EXPORT( void, msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
+#define msg_GenericVa(a, b, c, d, e) msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
+
+#define msg_Info( p_this, ... ) \
+        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
+                     MODULE_STRING, __VA_ARGS__ )
+#define msg_Err( p_this, ... ) \
+        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
+                     MODULE_STRING, __VA_ARGS__ )
+#define msg_Warn( p_this, ... ) \
+        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
+                     MODULE_STRING, __VA_ARGS__ )
+#define msg_Dbg( p_this, ... ) \
+        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
+                     MODULE_STRING, __VA_ARGS__ )
+
+typedef struct msg_cb_data_t msg_cb_data_t;
 
-#ifdef HAVE_VARIADIC_MACROS
+/**
+ * Message logging callback signature.
+ * Accepts one private data pointer, the message, and an overrun counter.
+ */
+typedef void (*msg_callback_t) (msg_cb_data_t *, msg_item_t *, unsigned);
 
-#   define msg_Info( p_this, psz_format, args... ) \
-      __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, \
-                     psz_format, ## args )
+VLC_EXPORT( msg_subscription_t*, msg_Subscribe, ( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) LIBVLC_USED );
+VLC_EXPORT( void, msg_Unsubscribe, ( msg_subscription_t * ) );
+VLC_EXPORT( void, msg_SubscriptionSetVerbosity, ( msg_subscription_t *, const int) );
 
-#   define msg_Err( p_this, psz_format, args... ) \
-      __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, MODULE_STRING, \
-                     psz_format, ## args )
+/* Enable or disable a certain object debug messages */
+VLC_EXPORT( void, msg_EnableObjectPrinting, ( vlc_object_t *, const char * psz_object ) );
+#define msg_EnableObjectPrinting(a,b) msg_EnableObjectPrinting(VLC_OBJECT(a),b)
+VLC_EXPORT( void, msg_DisableObjectPrinting, ( vlc_object_t *, const char * psz_object ) );
+#define msg_DisableObjectPrinting(a,b) msg_DisableObjectPrinting(VLC_OBJECT(a),b)
 
-#   define msg_Warn( p_this, psz_format, args... ) \
-      __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, \
-                     psz_format, ## args )
 
-#   define msg_Dbg( p_this, psz_format, args... ) \
-      __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, MODULE_STRING, \
-                     psz_format, ## args )
+/**
+ * @}
+ */
 
-#elif defined(_MSC_VER) /* To avoid warnings and even errors with c++ files */
+/**
+ * \defgroup statistics Statistics
+ *
+ * @{
+ */
 
-inline void msg_Info( void *p_this, const char *psz_format, ... )
+/****************************
+ * Generic stats stuff
+ ****************************/
+enum
 {
-  va_list ap;
-  va_start( ap, psz_format );
-  __msg_GenericVa( ( vlc_object_t *)p_this, VLC_MSG_INFO, MODULE_STRING,
-                   psz_format, ap );
-  va_end(ap);
-}
-inline void msg_Err( void *p_this, const char *psz_format, ... )
-{
-  va_list ap;
-  va_start( ap, psz_format );
-  __msg_GenericVa( ( vlc_object_t *)p_this, VLC_MSG_ERR, MODULE_STRING,
-                   psz_format, ap );
-  va_end(ap);
-}
-inline void msg_Warn( void *p_this, const char *psz_format, ... )
-{
-  va_list ap;
-  va_start( ap, psz_format );
-  __msg_GenericVa( ( vlc_object_t *)p_this, VLC_MSG_WARN, MODULE_STRING,
-                   psz_format, ap );
-  va_end(ap);
-}
-inline void msg_Dbg( void *p_this, const char *psz_format, ... )
-{
-  va_list ap;
-  va_start( ap, psz_format );
-  __msg_GenericVa( ( vlc_object_t *)p_this, VLC_MSG_DBG, MODULE_STRING,
-                   psz_format, ap );
-  va_end(ap);
-}
+    STATS_LAST,
+    STATS_COUNTER,
+    STATS_MAX,
+    STATS_MIN,
+    STATS_DERIVATIVE,
+    STATS_TIMER
+};
 
-#else /* _MSC_VER */
+struct counter_sample_t
+{
+    vlc_value_t value;
+    mtime_t     date;
+};
 
-#   define msg_Info __msg_Info
-#   define msg_Err __msg_Err
-#   define msg_Warn __msg_Warn
-#   define msg_Dbg __msg_Dbg
+struct counter_t
+{
+    unsigned int        i_id;
+    char              * psz_name;
+    int                 i_type;
+    void              * p_obj;
+    int                 i_compute_type;
+    int                 i_samples;
+    counter_sample_t ** pp_samples;
+
+    mtime_t             update_interval;
+    mtime_t             last_update;
+};
 
-#endif /* HAVE_VARIADIC_MACROS */
+enum
+{
+    STATS_INPUT_BITRATE,
+    STATS_READ_BYTES,
+    STATS_READ_PACKETS,
+    STATS_DEMUX_READ,
+    STATS_DEMUX_BITRATE,
+    STATS_DEMUX_CORRUPTED,
+    STATS_DEMUX_DISCONTINUITY,
+    STATS_PLAYED_ABUFFERS,
+    STATS_LOST_ABUFFERS,
+    STATS_DECODED_AUDIO,
+    STATS_DECODED_VIDEO,
+    STATS_DECODED_SUB,
+    STATS_CLIENT_CONNECTIONS,
+    STATS_ACTIVE_CONNECTIONS,
+    STATS_SOUT_SENT_PACKETS,
+    STATS_SOUT_SENT_BYTES,
+    STATS_SOUT_SEND_BITRATE,
+    STATS_DISPLAYED_PICTURES,
+    STATS_LOST_PICTURES,
+
+    STATS_TIMER_PLAYLIST_BUILD,
+    STATS_TIMER_ML_LOAD,
+    STATS_TIMER_ML_DUMP,
+    STATS_TIMER_INTERACTION,
+    STATS_TIMER_PREPARSE,
+    STATS_TIMER_INPUT_LAUNCHING,
+    STATS_TIMER_MODULE_NEED,
+    STATS_TIMER_VIDEO_FRAME_ENCODING,
+    STATS_TIMER_AUDIO_FRAME_ENCODING,
+
+    STATS_TIMER_SKINS_PLAYTREE_IMAGE,
+};
 
-#define msg_Create(a) __msg_Create(VLC_OBJECT(a))
-#define msg_Flush(a) __msg_Flush(VLC_OBJECT(a))
-#define msg_Destroy(a) __msg_Destroy(VLC_OBJECT(a))
-void __msg_Create  ( vlc_object_t * );
-void __msg_Flush   ( vlc_object_t * );
-void __msg_Destroy ( vlc_object_t * );
+/*********
+ * Timing
+ ********/
+VLC_EXPORT( void, stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
+VLC_EXPORT( void, stats_TimerStop, (vlc_object_t*, unsigned int) );
+VLC_EXPORT( void, stats_TimerDump, (vlc_object_t*, unsigned int) );
+VLC_EXPORT( void, stats_TimersDumpAll, (vlc_object_t*) );
+#define stats_TimerStart(a,b,c) stats_TimerStart( VLC_OBJECT(a), b,c )
+#define stats_TimerStop(a,b) stats_TimerStop( VLC_OBJECT(a), b )
+#define stats_TimerDump(a,b) stats_TimerDump( VLC_OBJECT(a), b )
+#define stats_TimersDumpAll(a) stats_TimersDumpAll( VLC_OBJECT(a) )
 
-#define msg_Subscribe(a) __msg_Subscribe(VLC_OBJECT(a))
-#define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
-VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t * ) );
-VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
+VLC_EXPORT( void, stats_TimersCleanAll, (vlc_object_t * ) );
+#define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) )
 
+VLC_EXPORT( void, stats_TimerClean, (vlc_object_t *, unsigned int ) );
+#define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b )
 
 /**
  * @}
  */
+#endif