]> git.sesse.net Git - vlc/blobdiff - include/vlc_messages.h
Add facilities to report and enrich error messages.
[vlc] / include / vlc_messages.h
index f3b46a075a7cde069f431746d3d8821640e4381d..a08b12efb18d01a6d7181052472e987ee75b919f 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_
+
 #include <stdarg.h>
 
 int vlc_mutex_lock(  vlc_mutex_t * ) ;
@@ -37,9 +44,19 @@ int vlc_mutex_unlock(  vlc_mutex_t * ) ;
  * @{
  */
 
+/** Internal message stack context */
+typedef struct
+{
+    int i_code;
+    char * psz_message;
+} msg_context_t;
+
+VLC_EXPORT( void,  msg_StackSet, ( int, const char*, ... ) );
+VLC_EXPORT( void,  msg_StackAdd, ( const char*, ... ) );
+VLC_EXPORT( const char*, msg_StackMsg, ( void ) );
 
 /**
- * Store a single message.
+ * Store a single message sent to user.
  */
 typedef struct
 {
@@ -65,16 +82,7 @@ typedef struct
 
 #define MSG_QUEUE_NORMAL 0
 #define MSG_QUEUE_HTTPD_ACCESS 1
-
-/**
- * Store all data requiered by messages interfaces.
- */
-struct msg_bank_t
-{
-    vlc_mutex_t             lock;
-    int                     i_queues;
-    msg_queue_t           **pp_queues;
-};
+#define NB_QUEUES 2
 
 struct msg_queue_t
 {
@@ -99,6 +107,15 @@ struct msg_queue_t
 #endif
 };
 
+/**
+ * Store all data requiered by messages interfaces.
+ */
+struct msg_bank_t
+{
+    vlc_mutex_t             lock;
+    msg_queue_t             queues[NB_QUEUES];
+};
+
 /**
  * Used by interface plugins which subscribe to the message bank.
  */
@@ -196,6 +213,7 @@ void __msg_Destroy ( vlc_object_t * );
 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t *, int ) );
 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
 
+const char *msg_GetObjectTypeName(int i_object_type );
 
 /**
  * @}
@@ -228,8 +246,7 @@ struct counter_sample_t
 
 struct counter_t
 {
-    /* The list is *NOT* sorted at the moment, it could be ... */
-    uint64_t            i_index;
+    unsigned int        i_id;
     char              * psz_name;
     int                 i_type;
     int                 i_compute_type;
@@ -260,77 +277,71 @@ enum
     STATS_DISPLAYED_PICTURES,
     STATS_LOST_PICTURES,
 
-    STATS_TIMER_PLAYLIST_WALK,
+    STATS_TIMER_PLAYLIST_BUILD,
+    STATS_TIMER_ML_LOAD,
+    STATS_TIMER_ML_DUMP,
     STATS_TIMER_INTERACTION,
     STATS_TIMER_PREPARSE,
 
     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
 };
 
-struct stats_handler_t
-{
-    VLC_COMMON_MEMBERS
-
-    int                 i_counters;
-    counter_t         **pp_counters;
-};
+#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_HandlerDestroy, (stats_handler_t*) );
+VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
 
-#define stats_Update(a,b,c,d) __stats_Update( VLC_OBJECT( a ), b, c, d )
-VLC_EXPORT( int, __stats_Update, (vlc_object_t*, unsigned int, vlc_value_t, vlc_value_t *) );
-#define stats_Create(a,b,c,d,e) __stats_Create( VLC_OBJECT(a), b, c, d,e )
-VLC_EXPORT( int, __stats_Create, (vlc_object_t*, const char *, unsigned int, int, int) );
-#define stats_Get(a,b,c,d) __stats_Get( VLC_OBJECT(a), b, c, d )
-VLC_EXPORT( int, __stats_Get, (vlc_object_t*, int, unsigned int, 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, unsigned int ) );
-
-#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,
-                                      unsigned int i_counter, int *value )
+#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;
-    i_ret = __stats_Get( p_obj, i_id, i_counter, &val );
+    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,d) __stats_GetFloat( VLC_OBJECT(a), b, c, d )
-static inline int __stats_GetFloat( vlc_object_t *p_obj, int i_id,
-                                    unsigned int i_counter, float *value )
+#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;
-    i_ret = __stats_Get( p_obj, i_id, i_counter, &val );
+    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,
-                                         unsigned int i_counter, int i,
-                                         int *pi_new )
+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, i_counter, val , &new_val );
+    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,
-                                       unsigned int i_counter, float f,
-                                       float *pf_new )
+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, i_counter, val, &new_val );
+    i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
     if( pf_new )
         *pf_new = new_val.f_float;
     return i_ret;
@@ -413,3 +424,7 @@ 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 * ) );
+
+#endif