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