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