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