vlc_messages.h 12.2 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 28 29 30 31 32 33
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

#ifndef _VLC_MESSAGES_H_
#define _VLC_MESSAGES_H_

34
#include <stdarg.h>
35 36 37 38

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

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
39 40 41 42 43 44 45
/**
 * \defgroup messages Messages
 * This library provides basic functions for threads to interact with user
 * interface, such as message output.
 *
 * @{
 */
46

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
47 48

/**
49
 * Store a single message.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
50
 */
51 52
typedef struct
{
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
53
    int     i_type;                             /**< message type, see below */
54
    int     i_object_id;
55
    int     i_object_type;
56
    char *  psz_module;
57 58
    char *  psz_msg;                            /**< the message itself */
    char *  psz_header;                         /**< Additional header */
59

60
    mtime_t date;                               /**< Message date */
61 62 63
} msg_item_t;

/* Message types */
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
64
/** standard messages */
65
#define VLC_MSG_INFO  0
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
66
/** error messages */
67
#define VLC_MSG_ERR   1
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
68 69 70 71 72
/** warning messages */
#define VLC_MSG_WARN  2
/** debug messages */
#define VLC_MSG_DBG   3

73 74
#define MSG_QUEUE_NORMAL 0
#define MSG_QUEUE_HTTPD_ACCESS 1
75
#define NB_QUEUES 2
76 77 78 79 80

struct msg_queue_t
{
    int                     i_id;

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
81
    /** Message queue lock */
82
    vlc_mutex_t             lock;
83
    vlc_bool_t              b_overflow;
84 85

    /* Message queue */
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
86
    msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
87 88 89 90 91 92
    int i_start;
    int i_stop;

    /* Subscribers */
    int i_sub;
    msg_subscription_t **pp_sub;
93 94 95 96 97

    /* Logfile for WinCE */
#ifdef UNDER_CE
    FILE *logfile;
#endif
98 99
};

100 101 102 103 104 105 106 107 108
/**
 * 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
109
/**
110
 * Used by interface plugins which subscribe to the message bank.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
111
 */
112
struct msg_subscription_t
113 114 115 116 117 118 119 120 121 122 123
{
    int   i_start;
    int*  pi_stop;

    msg_item_t*  p_msg;
    vlc_mutex_t* p_lock;
};

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
124 125
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
126
#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
127 128 129 130
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 ) );
131 132 133 134

#ifdef HAVE_VARIADIC_MACROS

#   define msg_Info( p_this, psz_format, args... ) \
135
      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING, \
136 137 138
                     psz_format, ## args )

#   define msg_Err( p_this, psz_format, args... ) \
139
      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING, \
140 141 142
                     psz_format, ## args )

#   define msg_Warn( p_this, psz_format, args... ) \
143
      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING, \
144 145 146
                     psz_format, ## args )

#   define msg_Dbg( p_this, psz_format, args... ) \
147
      __msg_Generic( VLC_OBJECT(p_this), MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING, \
148 149
                     psz_format, ## args )

150 151 152 153 154 155
#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 );
156
  __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL,VLC_MSG_INFO, MODULE_STRING,
157 158 159 160 161 162 163
                   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 );
164
  __msg_GenericVa( ( vlc_object_t *)p_this,MSG_QUEUE_NORMAL, VLC_MSG_ERR, MODULE_STRING,
165 166 167 168 169 170 171
                   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 );
172
  __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_WARN, MODULE_STRING,
173 174 175 176 177 178 179
                   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 );
180
  __msg_GenericVa( ( vlc_object_t *)p_this, MSG_QUEUE_NORMAL, VLC_MSG_DBG, MODULE_STRING,
181 182 183 184 185
                   psz_format, ap );
  va_end(ap);
}

#else /* _MSC_VER */
186 187 188 189 190 191 192 193

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

#endif /* HAVE_VARIADIC_MACROS */

194 195 196
#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))
197
void __msg_Create  ( vlc_object_t * );
198
void __msg_Flush   ( vlc_object_t * );
199 200
void __msg_Destroy ( vlc_object_t * );

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 205
VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );

206
const char *msg_GetObjectTypeName(int i_object_type );
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
207 208 209 210

/**
 * @}
 */
211 212 213 214 215 216 217

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

218 219 220
/****************************
 * Generic stats stuff
 ****************************/
221 222 223 224 225 226
enum
{
    STATS_LAST,
    STATS_COUNTER,
    STATS_MAX,
    STATS_MIN,
227 228
    STATS_DERIVATIVE,
    STATS_TIMER
229 230 231 232 233 234 235 236 237 238
};

struct counter_sample_t
{
    vlc_value_t value;
    mtime_t     date;
};

struct counter_t
{
239
    unsigned int        i_id;
240 241
    char              * psz_name;
    int                 i_type;
242
    int                 i_compute_type;
243 244
    int                 i_samples;
    counter_sample_t ** pp_samples;
245 246 247

    mtime_t             update_interval;
    mtime_t             last_update;
248 249
};

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
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,

270
    STATS_TIMER_PLAYLIST_BUILD,
271 272
    STATS_TIMER_ML_LOAD,
    STATS_TIMER_ML_DUMP,
273
    STATS_TIMER_INTERACTION,
Clément Stenac's avatar
Clément Stenac committed
274 275 276
    STATS_TIMER_PREPARSE,

    STATS_TIMER_SKINS_PLAYTREE_IMAGE,
277 278
};

279 280 281 282 283 284
#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*) );
285

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

288 289 290
#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 )
291
{
Eric Petit's avatar
Eric Petit committed
292
    int i_ret;
Clément Stenac's avatar
Clément Stenac committed
293
    vlc_value_t val; val.i_int = 0;
Clément Stenac's avatar
Clément Stenac committed
294
    if( !p_counter ) return VLC_EGENERIC;
295
    i_ret = __stats_Get( p_obj, p_counter, &val );
296 297 298
    *value = val.i_int;
    return i_ret;
}
299

300 301 302
#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 )
303
{
304
    int i_ret;
305
    vlc_value_t val; val.f_float = 0.0;
Clément Stenac's avatar
Clément Stenac committed
306
    if( !p_counter ) return VLC_EGENERIC;
307
    i_ret = __stats_Get( p_obj, p_counter, &val );
308 309 310
    *value = val.f_float;
    return i_ret;
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
311
#define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
312 313
static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
                                         int i, int *pi_new )
314
{
315
    int i_ret;
316
    vlc_value_t val;
Clément Stenac's avatar
Clément Stenac committed
317
    vlc_value_t new_val; new_val.i_int = 0;
Clément Stenac's avatar
Clément Stenac committed
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 322 323
    if( pi_new )
        *pi_new = new_val.i_int;
    return i_ret;
324
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
325
#define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
326 327
static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
                                       float f, float *pf_new )
328 329
{
    vlc_value_t val;
330
    int i_ret;
Clément Stenac's avatar
Clément Stenac committed
331
    vlc_value_t new_val;new_val.f_float = 0.0;
Clément Stenac's avatar
Clément Stenac committed
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 336 337
    if( pf_new )
        *pf_new = new_val.f_float;
    return i_ret;
338
}
339

340 341 342
/******************
 * Input stats
 ******************/
343 344
struct input_stats_t
{
345 346
    vlc_mutex_t         lock;

347 348 349
    /* Input */
    int i_read_packets;
    int i_read_bytes;
350 351
    float f_input_bitrate;
    float f_average_input_bitrate;
352

353 354 355 356 357
    /* Demux */
    int i_demux_read_packets;
    int i_demux_read_bytes;
    float f_demux_bitrate;
    float f_average_demux_bitrate;
358 359

    /* Decoders */
360 361
    int i_decoded_audio;
    int i_decoded_video;
362 363 364 365

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

367 368 369 370 371
    /* Sout */
    int i_sent_packets;
    int i_sent_bytes;
    float f_send_bitrate;

Clément Stenac's avatar
Clément Stenac committed
372 373 374
    /* Aout */
    int i_played_abuffers;
    int i_lost_abuffers;
Clément Stenac's avatar
Clément Stenac committed
375
};
376 377 378 379

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 *) );
380 381 382 383 384 385 386 387 388

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

    float f_input_bitrate;
389
    float f_demux_bitrate;
390 391 392 393 394
    float f_output_bitrate;

    int i_http_clients;
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
395
#define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
396 397 398 399 400 401 402
VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));


/*********
 * Timing
 ********/
#ifdef DEBUG
403
#define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
404 405 406 407
#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
408
#define stats_TimerStart(a,b,c) {}
409 410 411 412
#define stats_TimerStop(a,b) {}
#define stats_TimerDump(a,b) {}
#define stats_TimersDumpAll(a) {}
#endif
413 414 415
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) );
416
VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
417 418
#define stats_TimersClean(a) __stats_TimersClean( VLC_OBJECT(a) )
VLC_EXPORT( void, __stats_TimersClean, (vlc_object_t * ) );
419 420

#endif