vlc_messages.h 11.3 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 68
#define MSG_QUEUE_NORMAL 0
#define MSG_QUEUE_HTTPD_ACCESS 1

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
69
/**
70
 * Store all data requiered by messages interfaces.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
71
 */
72
struct msg_bank_t
73
{
74 75 76 77 78 79 80 81 82
    vlc_mutex_t             lock;
    int                     i_queues;
    msg_queue_t           **pp_queues;
};

struct msg_queue_t
{
    int                     i_id;

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

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

    /* Subscribers */
    int i_sub;
    msg_subscription_t **pp_sub;
95 96 97 98 99

    /* Logfile for WinCE */
#ifdef UNDER_CE
    FILE *logfile;
#endif
100 101
};

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 * ) );

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
199 200 201 202

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

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

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

struct counter_sample_t
{
    vlc_value_t value;
    mtime_t     date;
};

struct counter_t
{
    char              * psz_name;
    int                 i_source_object;
    int                 i_compute_type;
    int                 i_type;
    int                 i_samples;
    counter_sample_t ** pp_samples;
237 238 239

    mtime_t             update_interval;
    mtime_t             last_update;
240 241 242 243 244 245
};

struct stats_handler_t
{
    VLC_COMMON_MEMBERS

246 247
    int                 i_counters;
    hashtable_entry_t * p_counters;
248 249
};

Clément Stenac's avatar
Clément Stenac committed
250 251
VLC_EXPORT( void, stats_HandlerDestroy, (stats_handler_t*) );

252 253
#define stats_Update( a,b,c, d) __stats_Update( VLC_OBJECT( a ), b, c, d )
VLC_EXPORT( int, __stats_Update, (vlc_object_t*, const char *, vlc_value_t, vlc_value_t *) );
254
#define stats_Create( a,b,c,d ) __stats_Create( VLC_OBJECT(a), b, c, d )
255
VLC_EXPORT( int, __stats_Create, (vlc_object_t*, const char *, int, int) );
256
#define stats_Get( a,b,c,d ) __stats_Create( VLC_OBJECT(a), b, c, d )
257
VLC_EXPORT( int, __stats_Get, (vlc_object_t*, int, const char *, vlc_value_t*) );
258
#define stats_CounterGet( a,b,c) __stats_CounterGet( VLC_OBJECT(a), b, c )
259
VLC_EXPORT( counter_t*, __stats_CounterGet, (vlc_object_t*, int, const char * ) );
260 261 262

#define stats_GetInteger( a,b,c,d ) __stats_GetInteger( VLC_OBJECT(a), b, c, d )
static inline int __stats_GetInteger( vlc_object_t *p_obj, int i_id,
263
                                      const char *psz_name, int *value )
264 265 266 267 268 269
{
    vlc_value_t val;
    int i_ret = __stats_Get( p_obj, i_id, psz_name, &val );
    *value = val.i_int;
    return i_ret;
}
270

271 272
#define stats_GetFloat(a,b,c,d ) __stats_GetFloat( VLC_OBJECT(a), b, c, d )
static inline int __stats_GetFloat( vlc_object_t *p_obj, int i_id,
273
                                    const char *psz_name, float *value )
274 275 276 277 278 279
{
    vlc_value_t val;
    int i_ret = __stats_Get( p_obj, i_id, psz_name, &val );
    *value = val.f_float;
    return i_ret;
}
280
#define stats_UpdateInteger( a,b,c,d ) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
281
static inline int __stats_UpdateInteger( vlc_object_t *p_obj,
282
                                         const char *psz_name, int i, int *pi_new )
283
{
284
    int i_ret;
285
    vlc_value_t val;
286
    vlc_value_t new_val;
287
    val.i_int = i;
288 289 290 291
    i_ret = __stats_Update( p_obj, psz_name, val , &new_val );
    if( pi_new )
        *pi_new = new_val.i_int;
    return i_ret;
292
}
293
#define stats_UpdateFloat( a,b,c,d ) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
294
static inline int __stats_UpdateFloat( vlc_object_t *p_obj,
295
                                       const char *psz_name, float f, float *pf_new )
296 297
{
    vlc_value_t val;
298 299
    int i_ret;
    vlc_value_t new_val;
300
    val.f_float = f;
301 302 303 304
    i_ret =  __stats_Update( p_obj, psz_name, val, &new_val );
    if( pf_new )
        *pf_new = new_val.f_float;
    return i_ret;
305
}
306

307 308 309
/******************
 * Input stats
 ******************/
310 311
struct input_stats_t
{
312 313 314

    vlc_mutex_t         lock;

315 316 317
    /* Input */
    int i_read_packets;
    int i_read_bytes;
318 319
    float f_input_bitrate;
    float f_average_input_bitrate;
320

321 322 323 324 325
    /* Demux */
    int i_demux_read_packets;
    int i_demux_read_bytes;
    float f_demux_bitrate;
    float f_average_demux_bitrate;
326 327

    /* Decoders */
328 329
    int i_decoded_audio;
    int i_decoded_video;
330 331 332 333

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

335 336 337 338 339
    /* Sout */
    int i_sent_packets;
    int i_sent_bytes;
    float f_send_bitrate;

Clément Stenac's avatar
Clément Stenac committed
340 341 342
    /* Aout */
    int i_played_abuffers;
    int i_lost_abuffers;
Clément Stenac's avatar
Clément Stenac committed
343
};
344 345 346 347

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 *) );
348 349 350 351 352 353 354 355 356

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

    float f_input_bitrate;
357
    float f_demux_bitrate;
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
    float f_output_bitrate;

    int i_http_clients;
};

#define stats_ComputeGlobalStats( a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));


/*********
 * Timing
 ********/
#ifdef DEBUG
#define stats_TimerStart(a,b) __stats_TimerStart( VLC_OBJECT(a), b )
#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
#define stats_TimerStart(a,b) {}
#define stats_TimerStop(a,b) {}
#define stats_TimerDump(a,b) {}
#define stats_TimersDumpAll(a) {}
#endif
VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *) );
VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, const char *) );
VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, const char *) );
VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );