git.sesse.net Git - vlc/blob - 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 } msg_item_t;
  59
  60 /* Message types */
  61 /** standard messages */
  62 #define VLC_MSG_INFO  0
  63 /** error messages */
  64 #define VLC_MSG_ERR   1
  65 /** warning messages */
  66 #define VLC_MSG_WARN  2
  67 /** debug messages */
  68 #define VLC_MSG_DBG   3
  69
  70 /**
  71  * Used by interface plugins which subscribe to the message bank.
  72  */
  73 typedef struct msg_subscription_t msg_subscription_t;
  74
  75 /*****************************************************************************
  76  * Prototypes
  77  *****************************************************************************/
  78 VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
  79 VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
  80 #define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
  81
  82 #define msg_Info( p_this, ... ) \
  83       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
  84                      MODULE_STRING, __VA_ARGS__ )
  85 #define msg_Err( p_this, ... ) \
  86       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
  87                      MODULE_STRING, __VA_ARGS__ )
  88 #define msg_Warn( p_this, ... ) \
  89       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
  90                      MODULE_STRING, __VA_ARGS__ )
  91 #define msg_Dbg( p_this, ... ) \
  92       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
  93                      MODULE_STRING, __VA_ARGS__ )
  94
  95 typedef struct msg_cb_data_t msg_cb_data_t;
  96
  97 /**
  98  * Message logging callback signature.
  99  * Accepts one private data pointer, the message, and an overrun counter.
 100  */
 101 typedef void (*msg_callback_t) (msg_cb_data_t *, msg_item_t *, unsigned);
 102
 103 VLC_EXPORT( msg_subscription_t*, msg_Subscribe, ( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) );
 104 VLC_EXPORT( void, msg_Unsubscribe, ( msg_subscription_t * ) );
 105
 106 /* Enable or disable a certain object debug messages */
 107 #define msg_EnableObjectPrinting(a,b) __msg_EnableObjectPrinting(VLC_OBJECT(a),b)
 108 #define msg_DisableObjectPrinting(a,b) __msg_DisableObjectPrinting(VLC_OBJECT(a),b)
 109 VLC_EXPORT( void, __msg_EnableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
 110 VLC_EXPORT( void, __msg_DisableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
 111
 112 /**
 113  * @}
 114  */
 115
 116 /**
 117  * \defgroup statistics Statistics
 118  *
 119  * @{
 120  */
 121
 122 /****************************
 123  * Generic stats stuff
 124  ****************************/
 125 enum
 126 {
 127     STATS_LAST,
 128     STATS_COUNTER,
 129     STATS_MAX,
 130     STATS_MIN,
 131     STATS_DERIVATIVE,
 132     STATS_TIMER
 133 };
 134
 135 struct counter_sample_t
 136 {
 137     vlc_value_t value;
 138     mtime_t     date;
 139 };
 140
 141 struct counter_t
 142 {
 143     unsigned int        i_id;
 144     char              * psz_name;
 145     int                 i_type;
 146     void              * p_obj;
 147     int                 i_compute_type;
 148     int                 i_samples;
 149     counter_sample_t ** pp_samples;
 150
 151     mtime_t             update_interval;
 152     mtime_t             last_update;
 153 };
 154
 155 enum
 156 {
 157     STATS_INPUT_BITRATE,
 158     STATS_READ_BYTES,
 159     STATS_READ_PACKETS,
 160     STATS_DEMUX_READ,
 161     STATS_DEMUX_BITRATE,
 162     STATS_PLAYED_ABUFFERS,
 163     STATS_LOST_ABUFFERS,
 164     STATS_DECODED_AUDIO,
 165     STATS_DECODED_VIDEO,
 166     STATS_DECODED_SUB,
 167     STATS_CLIENT_CONNECTIONS,
 168     STATS_ACTIVE_CONNECTIONS,
 169     STATS_SOUT_SENT_PACKETS,
 170     STATS_SOUT_SENT_BYTES,
 171     STATS_SOUT_SEND_BITRATE,
 172     STATS_DISPLAYED_PICTURES,
 173     STATS_LOST_PICTURES,
 174
 175     STATS_TIMER_PLAYLIST_BUILD,
 176     STATS_TIMER_ML_LOAD,
 177     STATS_TIMER_ML_DUMP,
 178     STATS_TIMER_INTERACTION,
 179     STATS_TIMER_PREPARSE,
 180     STATS_TIMER_INPUT_LAUNCHING,
 181     STATS_TIMER_MODULE_NEED,
 182     STATS_TIMER_VIDEO_FRAME_ENCODING,
 183     STATS_TIMER_AUDIO_FRAME_ENCODING,
 184
 185     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
 186 };
 187
 188 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
 189 VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
 190 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
 191 VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
 192 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
 193 VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
 194
 195 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
 196
 197 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
 198 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
 199                                       int *value )
 200 {
 201     int i_ret;
 202     vlc_value_t val; val.i_int = 0;
 203     if( !p_counter ) return VLC_EGENERIC;
 204     i_ret = __stats_Get( p_obj, p_counter, &val );
 205     *value = val.i_int;
 206     return i_ret;
 207 }
 208
 209 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
 210 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
 211                                     float *value )
 212 {
 213     int i_ret;
 214     vlc_value_t val; val.f_float = 0.0;
 215     if( !p_counter ) return VLC_EGENERIC;
 216     i_ret = __stats_Get( p_obj, p_counter, &val );
 217     *value = val.f_float;
 218     return i_ret;
 219 }
 220 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
 221 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
 222                                          int i, int *pi_new )
 223 {
 224     int i_ret;
 225     vlc_value_t val;
 226     vlc_value_t new_val; new_val.i_int = 0;
 227     if( !p_co ) return VLC_EGENERIC;
 228     val.i_int = i;
 229     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
 230     if( pi_new )
 231         *pi_new = new_val.i_int;
 232     return i_ret;
 233 }
 234 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
 235 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
 236                                        float f, float *pf_new )
 237 {
 238     vlc_value_t val;
 239     int i_ret;
 240     vlc_value_t new_val;new_val.f_float = 0.0;
 241     if( !p_co ) return VLC_EGENERIC;
 242     val.f_float = f;
 243     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
 244     if( pf_new )
 245         *pf_new = new_val.f_float;
 246     return i_ret;
 247 }
 248
 249 /******************
 250  * Input stats
 251  ******************/
 252 struct input_stats_t
 253 {
 254     vlc_mutex_t         lock;
 255
 256     /* Input */
 257     int i_read_packets;
 258     int i_read_bytes;
 259     float f_input_bitrate;
 260     float f_average_input_bitrate;
 261
 262     /* Demux */
 263     int i_demux_read_packets;
 264     int i_demux_read_bytes;
 265     float f_demux_bitrate;
 266     float f_average_demux_bitrate;
 267
 268     /* Decoders */
 269     int i_decoded_audio;
 270     int i_decoded_video;
 271
 272     /* Vout */
 273     int i_displayed_pictures;
 274     int i_lost_pictures;
 275
 276     /* Sout */
 277     int i_sent_packets;
 278     int i_sent_bytes;
 279     float f_send_bitrate;
 280
 281     /* Aout */
 282     int i_played_abuffers;
 283     int i_lost_abuffers;
 284 };
 285
 286 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
 287 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
 288 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
 289
 290 /********************
 291  * Global stats
 292  *******************/
 293 struct global_stats_t
 294 {
 295     vlc_mutex_t lock;
 296
 297     float f_input_bitrate;
 298     float f_demux_bitrate;
 299     float f_output_bitrate;
 300
 301     int i_http_clients;
 302 };
 303
 304 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
 305 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
 306
 307
 308 /*********
 309  * Timing
 310  ********/
 311 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
 312 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
 313 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
 314 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
 315 VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
 316 VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
 317 VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
 318 VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
 319 #define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
 320 VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) );
 321
 322 #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
 323 VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );
 324
 325 #endif