vlc_messages.h 12 KB
Newer Older
1 2 3 4 5
/*****************************************************************************
 * messages.h: messages interface
 * This library provides basic functions for threads to interact with user
 * interface, such as message output.
 *****************************************************************************
6
 * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
7
 * $Id$
8 9 10 11 12 13 14 15
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
16
 *
17 18 19 20 21 22 23
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 26 27
 *****************************************************************************/

#include <stdarg.h>
28 29 30 31

int vlc_mutex_lock(  vlc_mutex_t * ) ;
int vlc_mutex_unlock(  vlc_mutex_t * ) ;

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
32 33 34 35 36 37 38
/**
 * \defgroup messages Messages
 * This library provides basic functions for threads to interact with user
 * interface, such as message output.
 *
 * @{
 */
39

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
40 41

/**
42
 * Store a single message.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
43
 */
44 45
typedef struct
{
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
46
    int     i_type;                             /**< message type, see below */
47
    int     i_object_id;
48
    int     i_object_type;
49
    char *  psz_module;
50 51
    char *  psz_msg;                            /**< the message itself */
    char *  psz_header;                         /**< Additional header */
52

53
    mtime_t date;                               /**< Message date */
54 55 56
} msg_item_t;

/* Message types */
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
57
/** standard messages */
58
#define VLC_MSG_INFO  0
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
59
/** error messages */
60
#define VLC_MSG_ERR   1
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
61 62 63 64 65
/** warning messages */
#define VLC_MSG_WARN  2
/** debug messages */
#define VLC_MSG_DBG   3

66 67
#define MSG_QUEUE_NORMAL 0
#define MSG_QUEUE_HTTPD_ACCESS 1
68
#define NB_QUEUES 2
69 70 71 72 73

struct msg_queue_t
{
    int                     i_id;

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
74
    /** Message queue lock */
75
    vlc_mutex_t             lock;
76
    vlc_bool_t              b_overflow;
77 78

    /* Message queue */
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
79
    msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
80 81 82 83 84 85
    int i_start;
    int i_stop;

    /* Subscribers */
    int i_sub;
    msg_subscription_t **pp_sub;
86 87 88 89 90

    /* Logfile for WinCE */
#ifdef UNDER_CE
    FILE *logfile;
#endif
91 92
};

93 94 95 96 97 98 99 100 101
/**
 * Store all data requiered by messages interfaces.
 */
struct msg_bank_t
{
    vlc_mutex_t             lock;
    msg_queue_t             queues[NB_QUEUES];
};

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
102
/**
103
 * Used by interface plugins which subscribe to the message bank.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
104
 */
105
struct msg_subscription_t
106 107 108 109 110 111 112 113 114 115 116
{
    int   i_start;
    int*  pi_stop;

    msg_item_t*  p_msg;
    vlc_mutex_t* p_lock;
};

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
117 118
VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, int, const char *, const char *, ... ) ATTRIBUTE_FORMAT( 5, 6 ) );
VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, int, const char *, const char *, va_list args ) );
Clément Stenac's avatar
Clément Stenac committed
119
#define msg_GenericVa(a, b, c, d, e,f) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e,f)
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
120 121 122 123
VLC_EXPORT( void, __msg_Info,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
VLC_EXPORT( void, __msg_Err,     ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
VLC_EXPORT( void, __msg_Warn,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
VLC_EXPORT( void, __msg_Dbg,    ( vlc_object_t *, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
124 125 126 127

#ifdef HAVE_VARIADIC_MACROS

#   define msg_Info( p_this, psz_format, args... ) \
128
      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING, \
129 130 131
                     psz_format, ## args )

#   define msg_Err( p_this, psz_format, args... ) \
132
      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING, \
133 134 135
                     psz_format, ## args )

#   define msg_Warn( p_this, psz_format, args... ) \
136
      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING, \
137 138 139
                     psz_format, ## args )

#   define msg_Dbg( p_this, psz_format, args... ) \
140
      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING, \
141 142
                     psz_format, ## args )

143 144 145 146 147 148
#elif defined(_MSC_VER) /* To avoid warnings and even errors with c++ files */

inline void msg_Info( void *p_this, const char *psz_format, ... )
{
  va_list ap;
  va_start( ap, psz_format );
149
  __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING,
150 151 152 153 154 155 156
                   psz_format, ap );
  va_end(ap);
}
inline void msg_Err( void *p_this, const char *psz_format, ... )
{
  va_list ap;
  va_start( ap, psz_format );
157
  __msg_GenericVa( ( vlc_object_t *)p_this,MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING,
158 159 160 161 162 163 164
                   psz_format, ap );
  va_end(ap);
}
inline void msg_Warn( void *p_this, const char *psz_format, ... )
{
  va_list ap;
  va_start( ap, psz_format );
165
  __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING,
166 167 168 169 170 171 172
                   psz_format, ap );
  va_end(ap);
}
inline void msg_Dbg( void *p_this, const char *psz_format, ... )
{
  va_list ap;
  va_start( ap, psz_format );
173
  __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING,
174 175 176 177 178
                   psz_format, ap );
  va_end(ap);
}

#else /* _MSC_VER */
179 180 181 182 183 184 185 186

#   define msg_Info __msg_Info
#   define msg_Err __msg_Err
#   define msg_Warn __msg_Warn
#   define msg_Dbg __msg_Dbg

#endif /* HAVE_VARIADIC_MACROS */

187 188 189
#define msg_Create(a) __msg_Create(VLC_OBJECT(a))
#define msg_Flush(a) __msg_Flush(VLC_OBJECT(a))
#define msg_Destroy(a) __msg_Destroy(VLC_OBJECT(a))
190
void __msg_Create  ( vlc_object_t * );
191
void __msg_Flush   ( vlc_object_t * );
192 193
void __msg_Destroy ( vlc_object_t * );

194
#define msg_Subscribe(a,b) __msg_Subscribe(VLC_OBJECT(a),b)
195
#define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
196
VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t *, int ) );
197 198
VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );

199
const char *msg_GetObjectTypeName(int i_object_type );
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
200 201 202 203

/**
 * @}
 */
204 205 206 207 208 209 210

/**
 * \defgroup statistics Statistics
 *
 * @{
 */

211 212 213
/****************************
 * Generic stats stuff
 ****************************/
214 215 216 217 218 219
enum
{
    STATS_LAST,
    STATS_COUNTER,
    STATS_MAX,
    STATS_MIN,
220 221
    STATS_DERIVATIVE,
    STATS_TIMER
222 223 224 225 226 227 228 229 230 231
};

struct counter_sample_t
{
    vlc_value_t value;
    mtime_t     date;
};

struct counter_t
{
232
    unsigned int        i_id;
233 234
    char              * psz_name;
    int                 i_type;
235
    int                 i_compute_type;
236 237
    int                 i_samples;
    counter_sample_t ** pp_samples;
238 239 240

    mtime_t             update_interval;
    mtime_t             last_update;
241 242
};

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
enum
{
    STATS_INPUT_BITRATE,
    STATS_READ_BYTES,
    STATS_READ_PACKETS,
    STATS_DEMUX_READ,
    STATS_DEMUX_BITRATE,
    STATS_PLAYED_ABUFFERS,
    STATS_LOST_ABUFFERS,
    STATS_DECODED_AUDIO,
    STATS_DECODED_VIDEO,
    STATS_DECODED_SUB,
    STATS_CLIENT_CONNECTIONS,
    STATS_ACTIVE_CONNECTIONS,
    STATS_SOUT_SENT_PACKETS,
    STATS_SOUT_SENT_BYTES,
    STATS_SOUT_SEND_BITRATE,
    STATS_DISPLAYED_PICTURES,
    STATS_LOST_PICTURES,

263
    STATS_TIMER_PLAYLIST_BUILD,
264 265
    STATS_TIMER_ML_LOAD,
    STATS_TIMER_ML_DUMP,
266
    STATS_TIMER_INTERACTION,
Clément Stenac's avatar
Clément Stenac committed
267 268 269
    STATS_TIMER_PREPARSE,

    STATS_TIMER_SKINS_PLAYTREE_IMAGE,
270 271
};

272 273 274 275 276 277
#define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
#define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
#define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
278

279
VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
Clément Stenac's avatar
Clément Stenac committed
280

281 282 283
#define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
                                      int *value )
284
{
Eric Petit's avatar
Eric Petit committed
285
    int i_ret;
Clément Stenac's avatar
Clément Stenac committed
286
    vlc_value_t val; val.i_int = 0;
Clément Stenac's avatar
Clément Stenac committed
287
    if( !p_counter ) return VLC_EGENERIC;
288
    i_ret = __stats_Get( p_obj, p_counter, &val );
289 290 291
    *value = val.i_int;
    return i_ret;
}
292

293 294 295
#define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
                                    float *value )
296
{
297
    int i_ret;
298
    vlc_value_t val; val.f_float = 0.0;
Clément Stenac's avatar
Clément Stenac committed
299
    if( !p_counter ) return VLC_EGENERIC;
300
    i_ret = __stats_Get( p_obj, p_counter, &val );
301 302 303
    *value = val.f_float;
    return i_ret;
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
304
#define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
305 306
static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
                                         int i, int *pi_new )
307
{
308
    int i_ret;
309
    vlc_value_t val;
Clément Stenac's avatar
Clément Stenac committed
310
    vlc_value_t new_val; new_val.i_int = 0;
Clément Stenac's avatar
Clément Stenac committed
311
    if( !p_co ) return VLC_EGENERIC;
312
    val.i_int = i;
313
    i_ret = __stats_Update( p_obj, p_co, val, &new_val );
314 315 316
    if( pi_new )
        *pi_new = new_val.i_int;
    return i_ret;
317
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
318
#define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
319 320
static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
                                       float f, float *pf_new )
321 322
{
    vlc_value_t val;
323
    int i_ret;
Clément Stenac's avatar
Clément Stenac committed
324
    vlc_value_t new_val;new_val.f_float = 0.0;
Clément Stenac's avatar
Clément Stenac committed
325
    if( !p_co ) return VLC_EGENERIC;
326
    val.f_float = f;
327
    i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
328 329 330
    if( pf_new )
        *pf_new = new_val.f_float;
    return i_ret;
331
}
332

333 334 335
/******************
 * Input stats
 ******************/
336 337
struct input_stats_t
{
338 339
    vlc_mutex_t         lock;

340 341 342
    /* Input */
    int i_read_packets;
    int i_read_bytes;
343 344
    float f_input_bitrate;
    float f_average_input_bitrate;
345

346 347 348 349 350
    /* Demux */
    int i_demux_read_packets;
    int i_demux_read_bytes;
    float f_demux_bitrate;
    float f_average_demux_bitrate;
351 352

    /* Decoders */
353 354
    int i_decoded_audio;
    int i_decoded_video;
355 356 357 358

    /* Vout */
    int i_displayed_pictures;
    int i_lost_pictures;
Clément Stenac's avatar
Clément Stenac committed
359

360 361 362 363 364
    /* Sout */
    int i_sent_packets;
    int i_sent_bytes;
    float f_send_bitrate;

Clément Stenac's avatar
Clément Stenac committed
365 366 367
    /* Aout */
    int i_played_abuffers;
    int i_lost_abuffers;
Clément Stenac's avatar
Clément Stenac committed
368
};
369 370 371 372

VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
373 374 375 376 377 378 379 380 381

/********************
 * Global stats
 *******************/
struct global_stats_t
{
    vlc_mutex_t lock;

    float f_input_bitrate;
382
    float f_demux_bitrate;
383 384 385 386 387
    float f_output_bitrate;

    int i_http_clients;
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
388
#define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
389 390 391 392 393 394 395
VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));


/*********
 * Timing
 ********/
#ifdef DEBUG
396
#define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
397 398 399 400
#define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
#define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
#define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
#else
Clément Stenac's avatar
Clément Stenac committed
401
#define stats_TimerStart(a,b,c) {}
402 403 404 405
#define stats_TimerStop(a,b) {}
#define stats_TimerDump(a,b) {}
#define stats_TimersDumpAll(a) {}
#endif
406 407 408
VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
409
VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
410 411
#define stats_TimersClean(a) __stats_TimersClean( VLC_OBJECT(a) )
VLC_EXPORT( void, __stats_TimersClean, (vlc_object_t * ) );