include/vlc_messages.h

   1 /*****************************************************************************
   2  * messages.h: messages interface
   3  * This library provides basic functions for threads to interact with user
   4  * interface, such as message output.
   5  *****************************************************************************
   6  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
   7  * $Id$
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *          Samuel Hocevar <sam@zoy.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifndef VLC_MESSAGES_H_
  28 #define VLC_MESSAGES_H_
  29
  30 /**
  31  * \file
  32  * This file defines structures and functions to handle messages and statistics gathering
  33  */
  34
  35 #include <stdarg.h>
  36
  37 /**
  38  * \defgroup messages Messages
  39  * This library provides basic functions for threads to interact with user
  40  * interface, such as message output.
  41  *
  42  * @{
  43  */
  44
  45 /**
  46  * Store a single message sent to user.
  47  */
  48 typedef struct
  49 {
  50     int     i_type;                             /**< message type, see below */
  51     uintptr_t   i_object_id;
  52     const char *psz_object_type;
  53     char *  psz_module;
  54     char *  psz_msg;                            /**< the message itself */
  55     char *  psz_header;                         /**< Additional header */
  56
  57     mtime_t date;                               /**< Message date */
  58     gc_object_t vlc_gc_data;
  59 } msg_item_t;
  60
  61 /* Message types */
  62 /** standard messages */
  63 #define VLC_MSG_INFO  0
  64 /** error messages */
  65 #define VLC_MSG_ERR   1
  66 /** warning messages */
  67 #define VLC_MSG_WARN  2
  68 /** debug messages */
  69 #define VLC_MSG_DBG   3
  70
  71 static inline msg_item_t *msg_Hold (msg_item_t *msg)
  72 {
  73     vlc_hold (&msg->vlc_gc_data);
  74     return msg;
  75 }
  76
  77 static inline void msg_Release (msg_item_t *msg)
  78 {
  79     vlc_release (&msg->vlc_gc_data);
  80 }
  81
  82 /**
  83  * Used by interface plugins which subscribe to the message bank.
  84  */
  85 typedef struct msg_subscription_t msg_subscription_t;
  86
  87 /*****************************************************************************
  88  * Prototypes
  89  *****************************************************************************/
  90 VLC_EXPORT( void, msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
  91 VLC_EXPORT( void, msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
  92 #define msg_GenericVa(a, b, c, d, e) msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
  93
  94 #define msg_Info( p_this, ... ) \
  95         msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
  96                      MODULE_STRING, __VA_ARGS__ )
  97 #define msg_Err( p_this, ... ) \
  98         msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
  99                      MODULE_STRING, __VA_ARGS__ )
 100 #define msg_Warn( p_this, ... ) \
 101         msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
 102                      MODULE_STRING, __VA_ARGS__ )
 103 #define msg_Dbg( p_this, ... ) \
 104         msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
 105                      MODULE_STRING, __VA_ARGS__ )
 106
 107 typedef struct msg_cb_data_t msg_cb_data_t;
 108
 109 /**
 110  * Message logging callback signature.
 111  * Accepts one private data pointer, the message, and an overrun counter.
 112  */
 113 typedef void (*msg_callback_t) (msg_cb_data_t *, msg_item_t *, unsigned);
 114
 115 VLC_EXPORT( msg_subscription_t*, msg_Subscribe, ( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) LIBVLC_USED );
 116 VLC_EXPORT( void, msg_Unsubscribe, ( msg_subscription_t * ) );
 117 VLC_EXPORT( void, msg_SubscriptionSetVerbosity, ( msg_subscription_t *, const int) );
 118
 119 /* Enable or disable a certain object debug messages */
 120 VLC_EXPORT( void, msg_EnableObjectPrinting, ( vlc_object_t *, const char * psz_object ) );
 121 #define msg_EnableObjectPrinting(a,b) msg_EnableObjectPrinting(VLC_OBJECT(a),b)
 122 VLC_EXPORT( void, msg_DisableObjectPrinting, ( vlc_object_t *, const char * psz_object ) );
 123 #define msg_DisableObjectPrinting(a,b) msg_DisableObjectPrinting(VLC_OBJECT(a),b)
 124
 125
 126 /**
 127  * @}
 128  */
 129
 130 /**
 131  * \defgroup statistics Statistics
 132  *
 133  * @{
 134  */
 135
 136 /****************************
 137  * Generic stats stuff
 138  ****************************/
 139 enum
 140 {
 141     STATS_LAST,
 142     STATS_COUNTER,
 143     STATS_MAX,
 144     STATS_MIN,
 145     STATS_DERIVATIVE,
 146     STATS_TIMER
 147 };
 148
 149 struct counter_sample_t
 150 {
 151     vlc_value_t value;
 152     mtime_t     date;
 153 };
 154
 155 struct counter_t
 156 {
 157     unsigned int        i_id;
 158     char              * psz_name;
 159     int                 i_type;
 160     void              * p_obj;
 161     int                 i_compute_type;
 162     int                 i_samples;
 163     counter_sample_t ** pp_samples;
 164
 165     mtime_t             update_interval;
 166     mtime_t             last_update;
 167 };
 168
 169 enum
 170 {
 171     STATS_INPUT_BITRATE,
 172     STATS_READ_BYTES,
 173     STATS_READ_PACKETS,
 174     STATS_DEMUX_READ,
 175     STATS_DEMUX_BITRATE,
 176     STATS_DEMUX_CORRUPTED,
 177     STATS_DEMUX_DISCONTINUITY,
 178     STATS_PLAYED_ABUFFERS,
 179     STATS_LOST_ABUFFERS,
 180     STATS_DECODED_AUDIO,
 181     STATS_DECODED_VIDEO,
 182     STATS_DECODED_SUB,
 183     STATS_CLIENT_CONNECTIONS,
 184     STATS_ACTIVE_CONNECTIONS,
 185     STATS_SOUT_SENT_PACKETS,
 186     STATS_SOUT_SENT_BYTES,
 187     STATS_SOUT_SEND_BITRATE,
 188     STATS_DISPLAYED_PICTURES,
 189     STATS_LOST_PICTURES,
 190
 191     STATS_TIMER_PLAYLIST_BUILD,
 192     STATS_TIMER_ML_LOAD,
 193     STATS_TIMER_ML_DUMP,
 194     STATS_TIMER_INTERACTION,
 195     STATS_TIMER_PREPARSE,
 196     STATS_TIMER_INPUT_LAUNCHING,
 197     STATS_TIMER_MODULE_NEED,
 198     STATS_TIMER_VIDEO_FRAME_ENCODING,
 199     STATS_TIMER_AUDIO_FRAME_ENCODING,
 200
 201     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
 202 };
 203
 204 /*********
 205  * Timing
 206  ********/
 207 VLC_EXPORT( void, stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
 208 VLC_EXPORT( void, stats_TimerStop, (vlc_object_t*, unsigned int) );
 209 VLC_EXPORT( void, stats_TimerDump, (vlc_object_t*, unsigned int) );
 210 VLC_EXPORT( void, stats_TimersDumpAll, (vlc_object_t*) );
 211 #define stats_TimerStart(a,b,c) stats_TimerStart( VLC_OBJECT(a), b,c )
 212 #define stats_TimerStop(a,b) stats_TimerStop( VLC_OBJECT(a), b )
 213 #define stats_TimerDump(a,b) stats_TimerDump( VLC_OBJECT(a), b )
 214 #define stats_TimersDumpAll(a) stats_TimersDumpAll( VLC_OBJECT(a) )
 215
 216 VLC_EXPORT( void, stats_TimersCleanAll, (vlc_object_t * ) );
 217 #define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) )
 218
 219 VLC_EXPORT( void, stats_TimerClean, (vlc_object_t *, unsigned int ) );
 220 #define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b )
 221
 222 /**
 223  * @}
 224  */
 225 #endif