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