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     const char *psz_module;
  54     const char *psz_header;                     /**< Additional header */
  55     char *  psz_msg;                            /**< the message itself */
  56 } msg_item_t;
  57
  58 /* Message types */
  59 /** standard messages */
  60 #define VLC_MSG_INFO  0
  61 /** error messages */
  62 #define VLC_MSG_ERR   1
  63 /** warning messages */
  64 #define VLC_MSG_WARN  2
  65 /** debug messages */
  66 #define VLC_MSG_DBG   3
  67
  68 VLC_MALLOC VLC_USED
  69 static inline msg_item_t *msg_Copy (const msg_item_t *msg)
  70 {
  71     msg_item_t *copy = (msg_item_t *)xmalloc (sizeof (*copy));
  72     copy->i_type = msg->i_type;
  73     copy->i_object_id = msg->i_object_id;
  74     copy->psz_object_type = msg->psz_object_type;
  75     copy->psz_module = strdup (msg->psz_module);
  76     copy->psz_msg = strdup (msg->psz_msg);
  77     copy->psz_header = msg->psz_header ? strdup (msg->psz_header) : NULL;
  78     return copy;
  79 }
  80
  81 static inline void msg_Free (msg_item_t *msg)
  82 {
  83     free ((char *)msg->psz_module);
  84     free ((char *)msg->psz_header);
  85     free (msg->psz_msg);
  86     free (msg);
  87 }
  88
  89 /**
  90  * Used by interface plugins which subscribe to the message bank.
  91  */
  92 typedef struct msg_subscription_t msg_subscription_t;
  93
  94 /*****************************************************************************
  95  * Prototypes
  96  *****************************************************************************/
  97 VLC_API void msg_Generic( vlc_object_t *, int, const char *, const char *, ... ) VLC_FORMAT( 4, 5 );
  98 VLC_API void msg_GenericVa( vlc_object_t *, int, const char *, const char *, va_list args );
  99 #define msg_GenericVa(a, b, c, d, e) msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
 100
 101 #define msg_Info( p_this, ... ) \
 102         msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
 103                      MODULE_STRING, __VA_ARGS__ )
 104 #define msg_Err( p_this, ... ) \
 105         msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
 106                      MODULE_STRING, __VA_ARGS__ )
 107 #define msg_Warn( p_this, ... ) \
 108         msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
 109                      MODULE_STRING, __VA_ARGS__ )
 110 #define msg_Dbg( p_this, ... ) \
 111         msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
 112                      MODULE_STRING, __VA_ARGS__ )
 113
 114 typedef struct msg_cb_data_t msg_cb_data_t;
 115
 116 /**
 117  * Message logging callback signature.
 118  * Accepts one private data pointer, the message, and an overrun counter.
 119  */
 120 typedef void (*msg_callback_t) (msg_cb_data_t *, const msg_item_t *);
 121
 122 VLC_API msg_subscription_t* msg_Subscribe( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) VLC_USED;
 123 VLC_API void msg_Unsubscribe( msg_subscription_t * );
 124 VLC_API void msg_SubscriptionSetVerbosity( msg_subscription_t *, const int);
 125
 126 /* Enable or disable a certain object debug messages */
 127 VLC_API void msg_EnableObjectPrinting( vlc_object_t *, const char * psz_object );
 128 #define msg_EnableObjectPrinting(a,b) msg_EnableObjectPrinting(VLC_OBJECT(a),b)
 129 VLC_API void msg_DisableObjectPrinting( vlc_object_t *, const char * psz_object );
 130 #define msg_DisableObjectPrinting(a,b) msg_DisableObjectPrinting(VLC_OBJECT(a),b)
 131
 132
 133 /**
 134  * @}
 135  */
 136
 137 /**
 138  * \defgroup statistics Statistics
 139  *
 140  * @{
 141  */
 142
 143 /****************************
 144  * Generic stats stuff
 145  ****************************/
 146 enum
 147 {
 148     STATS_LAST,
 149     STATS_COUNTER,
 150     STATS_MAX,
 151     STATS_MIN,
 152     STATS_DERIVATIVE,
 153     STATS_TIMER
 154 };
 155
 156 struct counter_sample_t
 157 {
 158     vlc_value_t value;
 159     mtime_t     date;
 160 };
 161
 162 struct counter_t
 163 {
 164     unsigned int        i_id;
 165     char              * psz_name;
 166     int                 i_type;
 167     void              * p_obj;
 168     int                 i_compute_type;
 169     int                 i_samples;
 170     counter_sample_t ** pp_samples;
 171
 172     mtime_t             update_interval;
 173     mtime_t             last_update;
 174 };
 175
 176 enum
 177 {
 178     STATS_INPUT_BITRATE,
 179     STATS_READ_BYTES,
 180     STATS_READ_PACKETS,
 181     STATS_DEMUX_READ,
 182     STATS_DEMUX_BITRATE,
 183     STATS_DEMUX_CORRUPTED,
 184     STATS_DEMUX_DISCONTINUITY,
 185     STATS_PLAYED_ABUFFERS,
 186     STATS_LOST_ABUFFERS,
 187     STATS_DECODED_AUDIO,
 188     STATS_DECODED_VIDEO,
 189     STATS_DECODED_SUB,
 190     STATS_CLIENT_CONNECTIONS,
 191     STATS_ACTIVE_CONNECTIONS,
 192     STATS_SOUT_SENT_PACKETS,
 193     STATS_SOUT_SENT_BYTES,
 194     STATS_SOUT_SEND_BITRATE,
 195     STATS_DISPLAYED_PICTURES,
 196     STATS_LOST_PICTURES,
 197
 198     STATS_TIMER_PLAYLIST_BUILD,
 199     STATS_TIMER_ML_LOAD,
 200     STATS_TIMER_ML_DUMP,
 201     STATS_TIMER_INTERACTION,
 202     STATS_TIMER_PREPARSE,
 203     STATS_TIMER_INPUT_LAUNCHING,
 204     STATS_TIMER_MODULE_NEED,
 205     STATS_TIMER_VIDEO_FRAME_ENCODING,
 206     STATS_TIMER_AUDIO_FRAME_ENCODING,
 207
 208     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
 209 };
 210
 211 /*********
 212  * Timing
 213  ********/
 214 VLC_API void stats_TimerStart(vlc_object_t*, const char *, unsigned int );
 215 VLC_API void stats_TimerStop(vlc_object_t*, unsigned int);
 216 VLC_API void stats_TimerDump(vlc_object_t*, unsigned int);
 217 VLC_API void stats_TimersDumpAll(vlc_object_t*);
 218 #define stats_TimerStart(a,b,c) stats_TimerStart( VLC_OBJECT(a), b,c )
 219 #define stats_TimerStop(a,b) stats_TimerStop( VLC_OBJECT(a), b )
 220 #define stats_TimerDump(a,b) stats_TimerDump( VLC_OBJECT(a), b )
 221 #define stats_TimersDumpAll(a) stats_TimersDumpAll( VLC_OBJECT(a) )
 222
 223 VLC_API void stats_TimersCleanAll(vlc_object_t * );
 224 #define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) )
 225
 226 VLC_API void stats_TimerClean(vlc_object_t *, unsigned int );
 227 #define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b )
 228
 229 /**
 230  * @}
 231  */
 232 #endif