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