]> git.sesse.net Git - vlc/blobdiff - include/vlc_messages.h
Add a timing facility (Refs:#473)
[vlc] / include / vlc_messages.h
index 1e3371e7cdc976b99e7605262b6b3659becd0892..4eba79c8b9e2d107fa05ba3af6566f3909dcf644 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.3 2002/07/15 19:15:05 sam Exp $
+ * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
+ * $Id$
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  *          Samuel Hocevar <sam@zoy.org>
@@ -13,7 +13,7 @@
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 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
  *
  * 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.
  *****************************************************************************/
 
 #include <stdarg.h>
 
-/*****************************************************************************
- * msg_item_t
- *****************************************************************************
+int vlc_mutex_lock(  vlc_mutex_t * ) ;
+int vlc_mutex_unlock(  vlc_mutex_t * ) ;
+
+/**
+ * \defgroup messages Messages
+ * This library provides basic functions for threads to interact with user
+ * interface, such as message output.
+ *
+ * @{
+ */
+
+
+/**
  * Store a single message.
- *****************************************************************************/
+ */
 typedef struct
 {
-    int     i_type;                               /* message type, see below */
+    int     i_type;                             /**< message type, see below */
     int     i_object_id;
+    int     i_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 */
 } msg_item_t;
 
 /* Message types */
-#define VLC_MSG_INFO  0                                 /* standard messages */
-#define VLC_MSG_ERR   1                                    /* error messages */
-#define VLC_MSG_WARN  2                                  /* warning messages */
-#define VLC_MSG_DBG   3                                    /* debug messages */
+/** standard messages */
+#define VLC_MSG_INFO  0
+/** error messages */
+#define VLC_MSG_ERR   1
+/** warning messages */
+#define VLC_MSG_WARN  2
+/** debug messages */
+#define VLC_MSG_DBG   3
 
-/*****************************************************************************
- * msg_bank_t
- *****************************************************************************
+#define MSG_QUEUE_NORMAL 0
+#define MSG_QUEUE_HTTPD_ACCESS 1
+
+/**
  * Store all data requiered by messages interfaces.
- *****************************************************************************/
-struct msg_bank_s
+ */
+struct msg_bank_t
+{
+    vlc_mutex_t             lock;
+    int                     i_queues;
+    msg_queue_t           **pp_queues;
+};
+
+struct msg_queue_t
 {
-    /* Message queue lock */
+    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 */
+    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
 };
 
-/*****************************************************************************
- * msg_subscription_t
- *****************************************************************************
+/**
  * Used by interface plugins which subscribe to the message bank.
- *****************************************************************************/
-struct msg_subscription_s
+ */
+struct msg_subscription_t
 {
     int   i_start;
     int*  pi_stop;
@@ -89,31 +114,68 @@ struct msg_subscription_s
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) );
-VLC_EXPORT( void, __msg_Info,    ( void *, const char *, ... ) );
-VLC_EXPORT( void, __msg_Err,     ( void *, const char *, ... ) );
-VLC_EXPORT( void, __msg_Warn,    ( void *, const char *, ... ) );
-VLC_EXPORT( void, __msg_Dbg,    ( void *, const char *, ... ) );
+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( CAST_TO_VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, \
+      __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( CAST_TO_VLC_OBJECT(p_this), VLC_MSG_ERR, MODULE_STRING, \
+      __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( CAST_TO_VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, \
+      __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( CAST_TO_VLC_OBJECT(p_this), VLC_MSG_DBG, MODULE_STRING, \
+      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING, \
                      psz_format, ## args )
 
-#else /* HAVE_VARIADIC_MACROS */
+#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);
+}
+
+#else /* _MSC_VER */
 
 #   define msg_Info __msg_Info
 #   define msg_Err __msg_Err
@@ -122,15 +184,190 @@ VLC_EXPORT( void, __msg_Dbg,    ( void *, const char *, ... ) );
 
 #endif /* HAVE_VARIADIC_MACROS */
 
-#define msg_Create(a) __msg_Create(CAST_TO_VLC_OBJECT(a))
-#define msg_Flush(a) __msg_Flush(CAST_TO_VLC_OBJECT(a))
-#define msg_Destroy(a) __msg_Destroy(CAST_TO_VLC_OBJECT(a))
+#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 * );
 
-#define msg_Subscribe(a) __msg_Subscribe(CAST_TO_VLC_OBJECT(a))
-#define msg_Unsubscribe(a,b) __msg_Unsubscribe(CAST_TO_VLC_OBJECT(a),b)
-VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_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 * ) );
 
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup statistics Statistics
+ *
+ * @{
+ */
+
+/****************************
+ * Generic stats stuff
+ ****************************/
+enum
+{
+    STATS_LAST,
+    STATS_COUNTER,
+    STATS_MAX,
+    STATS_MIN,
+    STATS_DERIVATIVE,
+    STATS_TIMER
+};
+
+struct counter_sample_t
+{
+    vlc_value_t value;
+    mtime_t     date;
+};
+
+struct counter_t
+{
+    char              * psz_name;
+    int                 i_source_object;
+    int                 i_compute_type;
+    int                 i_type;
+    int                 i_samples;
+    counter_sample_t ** pp_samples;
+
+    mtime_t             update_interval;
+    mtime_t             last_update;
+};
+
+struct stats_handler_t
+{
+    VLC_COMMON_MEMBERS
+
+    int         i_counters;
+    counter_t **pp_counters;
+};
+
+VLC_EXPORT( void, stats_HandlerDestroy, (stats_handler_t*) );
+
+#define stats_Update( a,b,c) __stats_Update( VLC_OBJECT( a ), b, c )
+VLC_EXPORT( int, __stats_Update, (vlc_object_t*, const 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*, const 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, const 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, const 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,
+                                      const 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,
+                                    const 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,
+                                         const 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,
+                                       const char *psz_name, float f )
+{
+    vlc_value_t val;
+    val.f_float = f;
+    return __stats_Update( p_obj, psz_name, val );
+}
+
+/******************
+ * 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_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
+ ********/
+#ifdef DEBUG
+#define stats_TimerStart(a,b) __stats_TimerStart( VLC_OBJECT(a), b )
+#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) {}
+#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 *) );
+VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, const char *) );
+VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, const char *) );
+VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );