]> git.sesse.net Git - vlc/blobdiff - include/vlc_messages.h
Merge branch 'master' into lpcm_encoder
[vlc] / include / vlc_messages.h
index 4eee1dc7b4d254e32c504923858aaf29549ea55a..6bfd5dada59612929362cab58d6cc87e235d4d70 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#if !defined( __LIBVLC__ )
-  #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
+#ifndef VLC_MESSAGES_H_
+#define VLC_MESSAGES_H_
 
-#ifndef _VLC_MESSAGES_H_
-#define _VLC_MESSAGES_H_
+/**
+ * \file
+ * This file defines structures and functions to handle messages and statistics gathering
+ */
 
 #include <stdarg.h>
 
  * @{
  */
 
-/** Internal message stack context */
-typedef struct
-{
-    int i_code;
-    char * psz_message;
-} msg_context_t;
-
-void msg_StackSet ( int, const char*, ... );
-void msg_StackAdd ( const char*, ... );
-const char* msg_StackMsg ( void );
-
 /**
  * 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_header;                         /**< Additional header */
 
     mtime_t date;                               /**< Message date */
+    gc_object_t vlc_gc_data;
 } msg_item_t;
 
 /* Message types */
@@ -77,91 +68,60 @@ typedef struct
 /** debug messages */
 #define VLC_MSG_DBG   3
 
-#define MSG_QUEUE_NORMAL 0
-#define MSG_QUEUE_HTTPD_ACCESS 1
-#define NB_QUEUES 2
-
-struct msg_queue_t
+static inline msg_item_t *msg_Hold (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_hold (&msg->vlc_gc_data);
+    return msg;
+}
 
-/**
- * Store all data requiered by messages interfaces.
- */
-struct msg_bank_t
+static inline void msg_Release (msg_item_t *msg)
 {
-    vlc_mutex_t             lock;
-    msg_queue_t             queues[NB_QUEUES];
-};
+    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 ) );
+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), MSG_QUEUE_NORMAL, VLC_MSG_INFO, \
+        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
                      MODULE_STRING, __VA_ARGS__ )
 #define msg_Err( p_this, ... ) \
-      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, \
+        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
                      MODULE_STRING, __VA_ARGS__ )
 #define msg_Warn( p_this, ... ) \
-      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, \
+        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
                      MODULE_STRING, __VA_ARGS__ )
 #define msg_Dbg( p_this, ... ) \
-      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, \
+        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
                      MODULE_STRING, __VA_ARGS__ )
 
-#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 * );
+typedef struct msg_cb_data_t msg_cb_data_t;
 
-#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 * ) );
+/**
+ * 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);
+
+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) );
+
+/* 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)
 
-VLC_EXPORT(const char *, msg_GetObjectTypeName, (int i_object_type ));
 
 /**
  * @}
@@ -197,6 +157,7 @@ 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;
@@ -212,6 +173,8 @@ enum
     STATS_READ_PACKETS,
     STATS_DEMUX_READ,
     STATS_DEMUX_BITRATE,
+    STATS_DEMUX_CORRUPTED,
+    STATS_DEMUX_DISCONTINUITY,
     STATS_PLAYED_ABUFFERS,
     STATS_LOST_ABUFFERS,
     STATS_DECODED_AUDIO,
@@ -230,149 +193,33 @@ enum
     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*, counter_t *, vlc_value_t, vlc_value_t *) );
-#define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
-VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
-#define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
-VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
-
-VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
-
-#define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
-static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
-                                      int *value )
-{
-    int i_ret;
-    vlc_value_t val; val.i_int = 0;
-    if( !p_counter ) return VLC_EGENERIC;
-    i_ret = __stats_Get( p_obj, p_counter, &val );
-    *value = val.i_int;
-    return i_ret;
-}
-
-#define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
-static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
-                                    float *value )
-{
-    int i_ret;
-    vlc_value_t val; val.f_float = 0.0;
-    if( !p_counter ) return VLC_EGENERIC;
-    i_ret = __stats_Get( p_obj, p_counter, &val );
-    *value = val.f_float;
-    return i_ret;
-}
-#define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
-static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
-                                         int i, int *pi_new )
-{
-    int i_ret;
-    vlc_value_t val;
-    vlc_value_t new_val; new_val.i_int = 0;
-    if( !p_co ) return VLC_EGENERIC;
-    val.i_int = i;
-    i_ret = __stats_Update( p_obj, p_co, val, &new_val );
-    if( pi_new )
-        *pi_new = new_val.i_int;
-    return i_ret;
-}
-#define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
-static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
-                                       float f, float *pf_new )
-{
-    vlc_value_t val;
-    int i_ret;
-    vlc_value_t new_val;new_val.f_float = 0.0;
-    if( !p_co ) return VLC_EGENERIC;
-    val.f_float = f;
-    i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
-    if( pf_new )
-        *pf_new = new_val.f_float;
-    return i_ret;
-}
-
-/******************
- * Input stats
- ******************/
-struct input_stats_t
-{
-    vlc_mutex_t         lock;
-
-    /* Input */
-    int i_read_packets;
-    int i_read_bytes;
-    float f_input_bitrate;
-    float f_average_input_bitrate;
-
-    /* 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;
-
-    /* Sout */
-    int i_sent_packets;
-    int i_sent_bytes;
-    float f_send_bitrate;
-
-    /* Aout */
-    int i_played_abuffers;
-    int i_lost_abuffers;
-};
-
-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 *) );
-
-/********************
- * Global stats
- *******************/
-struct global_stats_t
-{
-    vlc_mutex_t lock;
-
-    float f_input_bitrate;
-    float f_demux_bitrate;
-    float f_output_bitrate;
-
-    int i_http_clients;
-};
-
-#define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
-VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
-
-
 /*********
  * Timing
  ********/
-#ifndef NDEBUG
-#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) )
-#else
-#define stats_TimerStart(a,b,c) {}
-#define stats_TimerStop(a,b) {}
-#define stats_TimerDump(a,b) {}
-#define stats_TimersDumpAll(a) {}
-#endif
-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_TimersClean(a) __stats_TimersClean( VLC_OBJECT(a) )
-VLC_EXPORT( void, __stats_TimersClean, (vlc_object_t * ) );
+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_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