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