* 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.6 2002/08/26 09:12:46 sam Exp $
+ * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
+ * $Id$
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
* Samuel Hocevar <sam@zoy.org>
* 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>
+#ifndef VLC_MESSAGES_H_
+#define VLC_MESSAGES_H_
-/*****************************************************************************
- * msg_item_t
- *****************************************************************************
- * Store a single message.
- *****************************************************************************/
-typedef struct
-{
- int i_type; /* message type, see below */
- int i_object_id;
- int i_object_type;
- char * psz_module;
- char * psz_msg; /* the message itself */
-
-#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
-} msg_item_t;
+/**
+ * \file
+ * This file defines structures and functions to handle messages and statistics gathering
+ */
-/* 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 */
+#include <stdarg.h>
-/*****************************************************************************
- * msg_bank_t
- *****************************************************************************
- * Store all data requiered by messages interfaces.
- *****************************************************************************/
-struct msg_bank_t
+/**
+ * \defgroup messages Messages
+ * This library provides basic functions for threads to interact with user
+ * interface, such as message output.
+ *
+ * @{
+ */
+
+/** Message types */
+enum msg_item_type
{
- /* 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;
+ VLC_MSG_INFO=0, /**< Important information */
+ VLC_MSG_ERR, /**< Error */
+ VLC_MSG_WARN, /**< Warning */
+ VLC_MSG_DBG, /**< Debug */
};
-/*****************************************************************************
- * msg_subscription_t
- *****************************************************************************
- * Used by interface plugins which subscribe to the message bank.
- *****************************************************************************/
-struct msg_subscription_t
+/**
+ * Log message
+ */
+typedef struct
{
- int i_start;
- int* pi_stop;
+ uintptr_t i_object_id; /**< Emitter (temporaly) unique object ID or 0 */
+ const char *psz_object_type; /**< Emitter object type name */
+ const char *psz_module; /**< Emitter module (source code) */
+ const char *psz_header; /**< Additional header (used by VLM media) */
+} msg_item_t;
- msg_item_t* p_msg;
- vlc_mutex_t* p_lock;
-};
+/**
+ * Used by interface plugins which subscribe to the message bank.
+ */
+typedef struct msg_subscription_t msg_subscription_t;
/*****************************************************************************
* 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 *, ... ) );
-
-#ifdef HAVE_VARIADIC_MACROS
-
-# define msg_Info( p_this, psz_format, args... ) \
- __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, \
- psz_format, ## args )
-
-# define msg_Err( p_this, psz_format, args... ) \
- __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, MODULE_STRING, \
- psz_format, ## args )
-
-# 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 )
-
-#else /* HAVE_VARIADIC_MACROS */
+VLC_API void vlc_Log(vlc_object_t *, int,
+ const char *, const char *, ...) VLC_FORMAT( 4, 5 );
+VLC_API void vlc_vaLog(vlc_object_t *, int,
+ const char *, const char *, va_list);
+#define msg_GenericVa(a, b, c, d, e) vlc_vaLog(VLC_OBJECT(a), b, c, d, e)
+
+#define msg_Info( p_this, ... ) \
+ vlc_Log( VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, __VA_ARGS__ )
+#define msg_Err( p_this, ... ) \
+ vlc_Log( VLC_OBJECT(p_this), VLC_MSG_ERR, MODULE_STRING, __VA_ARGS__ )
+#define msg_Warn( p_this, ... ) \
+ vlc_Log( VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, __VA_ARGS__ )
+#define msg_Dbg( p_this, ... ) \
+ vlc_Log( VLC_OBJECT(p_this), VLC_MSG_DBG, MODULE_STRING, __VA_ARGS__ )
+
+/**
+ * Message logging callback signature.
+ * Accepts one private data pointer, the message, and an overrun counter.
+ */
+typedef void (*msg_callback_t) (void *, int, const msg_item_t *,
+ const char *, va_list);
+
+VLC_API msg_subscription_t *vlc_Subscribe(msg_callback_t, void *) VLC_USED;
+VLC_API void vlc_Unsubscribe(msg_subscription_t *);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup statistics Statistics
+ *
+ * @{
+ */
-# define msg_Info __msg_Info
-# define msg_Err __msg_Err
-# define msg_Warn __msg_Warn
-# define msg_Dbg __msg_Dbg
+/****************************
+ * Generic stats stuff
+ ****************************/
+enum
+{
+ STATS_LAST,
+ STATS_COUNTER,
+ STATS_MAX,
+ STATS_MIN,
+ STATS_DERIVATIVE,
+ STATS_TIMER
+};
-#endif /* HAVE_VARIADIC_MACROS */
+struct counter_sample_t
+{
+ vlc_value_t value;
+ mtime_t date;
+};
-#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 * );
+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;
+};
-#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 * ) );
+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,
+};
+/*********
+ * Timing
+ ********/
+VLC_API void stats_TimerStart(vlc_object_t*, const char *, unsigned int );
+VLC_API void stats_TimerStop(vlc_object_t*, unsigned int);
+VLC_API void stats_TimerDump(vlc_object_t*, unsigned int);
+VLC_API 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_API void stats_TimersCleanAll(vlc_object_t * );
+#define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) )
+
+VLC_API void stats_TimerClean(vlc_object_t *, unsigned int );
+#define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b )
+
+/**
+ * @}
+ */
+#endif
projects / vlc / blobdiff