]> git.sesse.net Git - vlc/blobdiff - include/vlc_messages.h
Merge branch 'master' into lpcm_encoder
[vlc] / include / vlc_messages.h
index 2828a26185e10f81753f3ab186ab0de9676d5d59..6bfd5dada59612929362cab58d6cc87e235d4d70 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#include <stdarg.h>
+#ifndef VLC_MESSAGES_H_
+#define VLC_MESSAGES_H_
+
+/**
+ * \file
+ * This file defines structures and functions to handle messages and statistics gathering
+ */
 
-int vlc_mutex_lock(  vlc_mutex_t * ) ;
-int vlc_mutex_unlock(  vlc_mutex_t * ) ;
+#include <stdarg.h>
 
 /**
  * \defgroup messages Messages
@@ -37,19 +42,20 @@ int vlc_mutex_unlock(  vlc_mutex_t * ) ;
  * @{
  */
 
-
 /**
- * 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 */
 
     mtime_t date;                               /**< Message date */
+    gc_object_t vlc_gc_data;
 } msg_item_t;
 
 /* Message types */
@@ -62,138 +68,59 @@ typedef struct
 /** debug messages */
 #define VLC_MSG_DBG   3
 
-#define MSG_QUEUE_NORMAL 0
-#define MSG_QUEUE_HTTPD_ACCESS 1
-
-/**
- * Store all data requiered by messages interfaces.
- */
-struct msg_bank_t
+static inline msg_item_t *msg_Hold (msg_item_t *msg)
 {
-    vlc_mutex_t             lock;
-    int                     i_queues;
-    msg_queue_t           **pp_queues;
-};
+    vlc_hold (&msg->vlc_gc_data);
+    return msg;
+}
 
-struct msg_queue_t
+static inline void msg_Release (msg_item_t *msg)
 {
-    int                     i_id;
-
-    /** Message queue lock */
-    vlc_mutex_t             lock;
-    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_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, int, const char *, const char *, ... ) ATTRIBUTE_FORMAT( 5, 6 ) );
-VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, int, const char *, const char *, va_list args ) );
-#define msg_GenericVa(a, b, c, d, e,f) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e,f)
-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 ) );
-
-#ifdef HAVE_VARIADIC_MACROS
-
-#   define msg_Info( p_this, psz_format, args... ) \
-      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING, \
-                     psz_format, ## args )
-
-#   define msg_Err( p_this, psz_format, args... ) \
-      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING, \
-                     psz_format, ## args )
-
-#   define msg_Warn( p_this, psz_format, args... ) \
-      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING, \
-                     psz_format, ## args )
-
-#   define msg_Dbg( p_this, psz_format, args... ) \
-      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING, \
-                     psz_format, ## args )
-
-#elif defined(_MSC_VER) /* To avoid warnings and even errors with c++ files */
-
-inline void msg_Info( void *p_this, const char *psz_format, ... )
-{
-  va_list ap;
-  va_start( ap, psz_format );
-  __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL,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,MSG_QUEUE_NORMAL, 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, MSG_QUEUE_NORMAL, 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, MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING,
-                   psz_format, ap );
-  va_end(ap);
-}
+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;
 
-#else /* _MSC_VER */
-
-#   define msg_Info __msg_Info
-#   define msg_Err __msg_Err
-#   define msg_Warn __msg_Warn
-#   define msg_Dbg __msg_Dbg
-
-#endif /* 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_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 * );
+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_Subscribe(a,b) __msg_Subscribe(VLC_OBJECT(a),b)
-#define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
-VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t *, int ) );
-VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
+/* 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)
 
 
 /**
@@ -206,13 +133,17 @@ VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
  * @{
  */
 
+/****************************
+ * Generic stats stuff
+ ****************************/
 enum
 {
     STATS_LAST,
     STATS_COUNTER,
     STATS_MAX,
     STATS_MIN,
-    STATS_DERIVATIVE
+    STATS_DERIVATIVE,
+    STATS_TIMER
 };
 
 struct counter_sample_t
@@ -223,10 +154,11 @@ struct counter_sample_t
 
 struct counter_t
 {
+    unsigned int        i_id;
     char              * psz_name;
-    int                 i_source_object;
-    int                 i_compute_type;
     int                 i_type;
+    void              * p_obj;
+    int                 i_compute_type;
     int                 i_samples;
     counter_sample_t ** pp_samples;
 
@@ -234,85 +166,60 @@ struct counter_t
     mtime_t             last_update;
 };
 
-struct stats_handler_t
+enum
 {
-    VLC_COMMON_MEMBERS
-
-    int         i_counters;
-    counter_t **pp_counters;
+    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 stats_Update( a,b,c) __stats_Update( VLC_OBJECT( a ), b, c )
-VLC_EXPORT( int, __stats_Update, (vlc_object_t*, char *, vlc_value_t) );
-#define stats_Create( a,b,c,d ) __stats_Create( VLC_OBJECT(a), b, c, d )
-VLC_EXPORT( int, __stats_Create, (vlc_object_t*, char *, int, int) );
-#define stats_Get( a,b,c,d ) __stats_Create( VLC_OBJECT(a), b, c, d )
-VLC_EXPORT( int, __stats_Get, (vlc_object_t*, int, char *, vlc_value_t*) );
-#define stats_CounterGet( a,b,c) __stats_CounterGet( VLC_OBJECT(a), b, c )
-VLC_EXPORT( counter_t*, __stats_CounterGet, (vlc_object_t*, int, char * ) );
-
-#define stats_GetInteger( a,b,c,d ) __stats_GetInteger( VLC_OBJECT(a), b, c, d )
-static inline int __stats_GetInteger( vlc_object_t *p_obj, int i_id,
-                                      char *psz_name, int *value )
-{
-    vlc_value_t val;
-    int i_ret = __stats_Get( p_obj, i_id, psz_name, &val );
-    *value = val.i_int;
-    return i_ret;
-}
-
-#define stats_GetFloat(a,b,c,d ) __stats_GetFloat( VLC_OBJECT(a), b, c, d )
-static inline int __stats_GetFloat( vlc_object_t *p_obj, int i_id,
-                                    char *psz_name, float *value )
-{
-    vlc_value_t val;
-    int i_ret = __stats_Get( p_obj, i_id, psz_name, &val );
-    *value = val.f_float;
-    return i_ret;
-}
-#define stats_UpdateInteger( a,b,c ) __stats_UpdateInteger( VLC_OBJECT(a),b,c )
-static inline int __stats_UpdateInteger( vlc_object_t *p_obj, char *psz_name,
-                                         int i )
-{
-    vlc_value_t val;
-    val.i_int = i;
-    return __stats_Update( p_obj, psz_name, val );
-}
-#define stats_UpdateFloat( a,b,c ) __stats_UpdateFloat( VLC_OBJECT(a),b,c )
-static inline int __stats_UpdateFloat( vlc_object_t *p_obj, char *psz_name,
-                                         float f )
-{
-    vlc_value_t val;
-    val.f_float = f;
-    return __stats_Update( p_obj, psz_name, val );
-}
-
-struct input_stats_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) )
 
-    vlc_mutex_t         lock;
+VLC_EXPORT( void, stats_TimersCleanAll, (vlc_object_t * ) );
+#define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) )
 
-    /* Input */
-    int i_read_packets;
-    int i_read_bytes;
-    float f_input_bitrate;
-    float f_average_input_bitrate;
+VLC_EXPORT( void, stats_TimerClean, (vlc_object_t *, unsigned int ) );
+#define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b )
 
-    /* Demux */
-    int i_demux_read_packets;
-    int i_demux_read_bytes;
-    float f_demux_bitrate;
-    float f_average_demux_bitrate;
-
-    /* Decoders */
-    int i_decoded_audio;
-    int i_decoded_video;
-
-    /* Vout */
-    int i_displayed_pictures;
-    int i_lost_pictures;
-};
-
-VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
-VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
-VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
+/**
+ * @}
+ */
+#endif