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