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 int vlc_mutex_lock(  vlc_mutex_t * ) ;
  37 int vlc_mutex_unlock(  vlc_mutex_t * ) ;
  38
  39 /**
  40  * \defgroup messages Messages
  41  * This library provides basic functions for threads to interact with user
  42  * interface, such as message output.
  43  *
  44  * @{
  45  */
  46
  47
  48 /**
  49  * Store a single message.
  50  */
  51 typedef struct
  52 {
  53     int     i_type;                             /**< message type, see below */
  54     int     i_object_id;
  55     int     i_object_type;
  56     char *  psz_module;
  57     char *  psz_msg;                            /**< the message itself */
  58     char *  psz_header;                         /**< Additional header */
  59
  60     mtime_t date;                               /**< Message date */
  61 } msg_item_t;
  62
  63 /* Message types */
  64 /** standard messages */
  65 #define VLC_MSG_INFO  0
  66 /** error messages */
  67 #define VLC_MSG_ERR   1
  68 /** warning messages */
  69 #define VLC_MSG_WARN  2
  70 /** debug messages */
  71 #define VLC_MSG_DBG   3
  72
  73 #define MSG_QUEUE_NORMAL 0
  74 #define MSG_QUEUE_HTTPD_ACCESS 1
  75 #define NB_QUEUES 2
  76
  77 struct msg_queue_t
  78 {
  79     int                     i_id;
  80
  81     /** Message queue lock */
  82     vlc_mutex_t             lock;
  83     vlc_bool_t              b_overflow;
  84
  85     /* Message queue */
  86     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
  87     int i_start;
  88     int i_stop;
  89
  90     /* Subscribers */
  91     int i_sub;
  92     msg_subscription_t **pp_sub;
  93
  94     /* Logfile for WinCE */
  95 #ifdef UNDER_CE
  96     FILE *logfile;
  97 #endif
  98 };
  99
 100 /**
 101  * Store all data requiered by messages interfaces.
 102  */
 103 struct msg_bank_t
 104 {
 105     vlc_mutex_t             lock;
 106     msg_queue_t             queues[NB_QUEUES];
 107 };
 108
 109 /**
 110  * Used by interface plugins which subscribe to the message bank.
 111  */
 112 struct msg_subscription_t
 113 {
 114     int   i_start;
 115     int*  pi_stop;
 116
 117     msg_item_t*  p_msg;
 118     vlc_mutex_t* p_lock;
 119 };
 120
 121 /*****************************************************************************
 122  * Prototypes
 123  *****************************************************************************/
 124 VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, int, const char *, const char *, ... ) ATTRIBUTE_FORMAT( 5, 6 ) );
 125 VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, int, const char *, const char *, va_list args ) );
 126 #define msg_GenericVa(a, b, c, d, e,f) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e,f)
 127 VLC_EXPORT( void, __msg_Info,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
 128 VLC_EXPORT( void, __msg_Err,     ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
 129 VLC_EXPORT( void, __msg_Warn,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
 130 VLC_EXPORT( void, __msg_Dbg,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
 131
 132 #ifdef HAVE_VARIADIC_MACROS
 133
 134 #   define msg_Info( p_this, psz_format, args... ) \
 135       __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING, \
 136                      psz_format, ## args )
 137
 138 #   define msg_Err( p_this, psz_format, args... ) \
 139       __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING, \
 140                      psz_format, ## args )
 141
 142 #   define msg_Warn( p_this, psz_format, args... ) \
 143       __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING, \
 144                      psz_format, ## args )
 145
 146 #   define msg_Dbg( p_this, psz_format, args... ) \
 147       __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING, \
 148                      psz_format, ## args )
 149
 150 #elif defined(_MSC_VER) /* To avoid warnings and even errors with c++ files */
 151
 152 inline void msg_Info( void *p_this, const char *psz_format, ... )
 153 {
 154   va_list ap;
 155   va_start( ap, psz_format );
 156   __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING,
 157                    psz_format, ap );
 158   va_end(ap);
 159 }
 160 inline void msg_Err( void *p_this, const char *psz_format, ... )
 161 {
 162   va_list ap;
 163   va_start( ap, psz_format );
 164   __msg_GenericVa( ( vlc_object_t *)p_this,MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING,
 165                    psz_format, ap );
 166   va_end(ap);
 167 }
 168 inline void msg_Warn( void *p_this, const char *psz_format, ... )
 169 {
 170   va_list ap;
 171   va_start( ap, psz_format );
 172   __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING,
 173                    psz_format, ap );
 174   va_end(ap);
 175 }
 176 inline void msg_Dbg( void *p_this, const char *psz_format, ... )
 177 {
 178   va_list ap;
 179   va_start( ap, psz_format );
 180   __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING,
 181                    psz_format, ap );
 182   va_end(ap);
 183 }
 184
 185 #else /* _MSC_VER */
 186
 187 #   define msg_Info __msg_Info
 188 #   define msg_Err __msg_Err
 189 #   define msg_Warn __msg_Warn
 190 #   define msg_Dbg __msg_Dbg
 191
 192 #endif /* HAVE_VARIADIC_MACROS */
 193
 194 #define msg_Create(a) __msg_Create(VLC_OBJECT(a))
 195 #define msg_Flush(a) __msg_Flush(VLC_OBJECT(a))
 196 #define msg_Destroy(a) __msg_Destroy(VLC_OBJECT(a))
 197 void __msg_Create  ( vlc_object_t * );
 198 void __msg_Flush   ( vlc_object_t * );
 199 void __msg_Destroy ( vlc_object_t * );
 200
 201 #define msg_Subscribe(a,b) __msg_Subscribe(VLC_OBJECT(a),b)
 202 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
 203 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t *, int ) );
 204 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
 205
 206 const char *msg_GetObjectTypeName(int i_object_type );
 207
 208 /**
 209  * @}
 210  */
 211
 212 /**
 213  * \defgroup statistics Statistics
 214  *
 215  * @{
 216  */
 217
 218 /****************************
 219  * Generic stats stuff
 220  ****************************/
 221 enum
 222 {
 223     STATS_LAST,
 224     STATS_COUNTER,
 225     STATS_MAX,
 226     STATS_MIN,
 227     STATS_DERIVATIVE,
 228     STATS_TIMER
 229 };
 230
 231 struct counter_sample_t
 232 {
 233     vlc_value_t value;
 234     mtime_t     date;
 235 };
 236
 237 struct counter_t
 238 {
 239     unsigned int        i_id;
 240     char              * psz_name;
 241     int                 i_type;
 242     int                 i_compute_type;
 243     int                 i_samples;
 244     counter_sample_t ** pp_samples;
 245
 246     mtime_t             update_interval;
 247     mtime_t             last_update;
 248 };
 249
 250 enum
 251 {
 252     STATS_INPUT_BITRATE,
 253     STATS_READ_BYTES,
 254     STATS_READ_PACKETS,
 255     STATS_DEMUX_READ,
 256     STATS_DEMUX_BITRATE,
 257     STATS_PLAYED_ABUFFERS,
 258     STATS_LOST_ABUFFERS,
 259     STATS_DECODED_AUDIO,
 260     STATS_DECODED_VIDEO,
 261     STATS_DECODED_SUB,
 262     STATS_CLIENT_CONNECTIONS,
 263     STATS_ACTIVE_CONNECTIONS,
 264     STATS_SOUT_SENT_PACKETS,
 265     STATS_SOUT_SENT_BYTES,
 266     STATS_SOUT_SEND_BITRATE,
 267     STATS_DISPLAYED_PICTURES,
 268     STATS_LOST_PICTURES,
 269
 270     STATS_TIMER_PLAYLIST_BUILD,
 271     STATS_TIMER_ML_LOAD,
 272     STATS_TIMER_ML_DUMP,
 273     STATS_TIMER_INTERACTION,
 274     STATS_TIMER_PREPARSE,
 275
 276     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
 277 };
 278
 279 #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
 280 VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
 281 #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
 282 VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
 283 #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
 284 VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
 285
 286 VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
 287
 288 #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
 289 static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
 290                                       int *value )
 291 {
 292     int i_ret;
 293     vlc_value_t val; val.i_int = 0;
 294     if( !p_counter ) return VLC_EGENERIC;
 295     i_ret = __stats_Get( p_obj, p_counter, &val );
 296     *value = val.i_int;
 297     return i_ret;
 298 }
 299
 300 #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
 301 static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
 302                                     float *value )
 303 {
 304     int i_ret;
 305     vlc_value_t val; val.f_float = 0.0;
 306     if( !p_counter ) return VLC_EGENERIC;
 307     i_ret = __stats_Get( p_obj, p_counter, &val );
 308     *value = val.f_float;
 309     return i_ret;
 310 }
 311 #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
 312 static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
 313                                          int i, int *pi_new )
 314 {
 315     int i_ret;
 316     vlc_value_t val;
 317     vlc_value_t new_val; new_val.i_int = 0;
 318     if( !p_co ) return VLC_EGENERIC;
 319     val.i_int = i;
 320     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
 321     if( pi_new )
 322         *pi_new = new_val.i_int;
 323     return i_ret;
 324 }
 325 #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
 326 static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
 327                                        float f, float *pf_new )
 328 {
 329     vlc_value_t val;
 330     int i_ret;
 331     vlc_value_t new_val;new_val.f_float = 0.0;
 332     if( !p_co ) return VLC_EGENERIC;
 333     val.f_float = f;
 334     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
 335     if( pf_new )
 336         *pf_new = new_val.f_float;
 337     return i_ret;
 338 }
 339
 340 /******************
 341  * Input stats
 342  ******************/
 343 struct input_stats_t
 344 {
 345     vlc_mutex_t         lock;
 346
 347     /* Input */
 348     int i_read_packets;
 349     int i_read_bytes;
 350     float f_input_bitrate;
 351     float f_average_input_bitrate;
 352
 353     /* Demux */
 354     int i_demux_read_packets;
 355     int i_demux_read_bytes;
 356     float f_demux_bitrate;
 357     float f_average_demux_bitrate;
 358
 359     /* Decoders */
 360     int i_decoded_audio;
 361     int i_decoded_video;
 362
 363     /* Vout */
 364     int i_displayed_pictures;
 365     int i_lost_pictures;
 366
 367     /* Sout */
 368     int i_sent_packets;
 369     int i_sent_bytes;
 370     float f_send_bitrate;
 371
 372     /* Aout */
 373     int i_played_abuffers;
 374     int i_lost_abuffers;
 375 };
 376
 377 VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
 378 VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
 379 VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
 380
 381 /********************
 382  * Global stats
 383  *******************/
 384 struct global_stats_t
 385 {
 386     vlc_mutex_t lock;
 387
 388     float f_input_bitrate;
 389     float f_demux_bitrate;
 390     float f_output_bitrate;
 391
 392     int i_http_clients;
 393 };
 394
 395 #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
 396 VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
 397
 398
 399 /*********
 400  * Timing
 401  ********/
 402 #ifdef DEBUG
 403 #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
 404 #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
 405 #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
 406 #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
 407 #else
 408 #define stats_TimerStart(a,b,c) {}
 409 #define stats_TimerStop(a,b) {}
 410 #define stats_TimerDump(a,b) {}
 411 #define stats_TimersDumpAll(a) {}
 412 #endif
 413 VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
 414 VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
 415 VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
 416 VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
 417 #define stats_TimersClean(a) __stats_TimersClean( VLC_OBJECT(a) )
 418 VLC_EXPORT( void, __stats_TimersClean, (vlc_object_t * ) );
 419
 420 #endif