vlc_messages.h 9.87 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
#ifndef VLC_MESSAGES_H_
#define VLC_MESSAGES_H_
29

30 31 32 33 34
/**
 * \file
 * This file defines structures and functions to handle messages and statistics gathering
 */

35
#include <stdarg.h>
36

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

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
45
/**
46
 * Store a single message sent to user.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
47
 */
48 49
typedef struct
{
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
50
    int     i_type;                             /**< message type, see below */
51
    uintptr_t   i_object_id;
52
    const char *psz_object_type;
53
    char *  psz_module;
54 55
    char *  psz_msg;                            /**< the message itself */
    char *  psz_header;                         /**< Additional header */
56

57
    mtime_t date;                               /**< Message date */
58 59 60
} msg_item_t;

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

/**
71
 * Used by interface plugins which subscribe to the message bank.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
72
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
73
typedef struct msg_subscription_t msg_subscription_t;
74
struct msg_subscription_t
75 76 77 78 79 80 81 82 83 84 85
{
    int   i_start;
    int*  pi_stop;

    msg_item_t*  p_msg;
    vlc_mutex_t* p_lock;
};

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
86
VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
87 88
VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
#define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
89

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
90
#define msg_Info( p_this, ... ) \
91
      __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
92 93
                     MODULE_STRING, __VA_ARGS__ )
#define msg_Err( p_this, ... ) \
94
      __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
95 96
                     MODULE_STRING, __VA_ARGS__ )
#define msg_Warn( p_this, ... ) \
97
      __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
98 99
                     MODULE_STRING, __VA_ARGS__ )
#define msg_Dbg( p_this, ... ) \
100
      __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
101
                     MODULE_STRING, __VA_ARGS__ )
102

103
#define msg_Subscribe(a) __msg_Subscribe(VLC_OBJECT(a))
104
#define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
105
VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t * ) );
106 107
VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );

108 109 110 111 112 113
/* Enable or disable a certain object debug messages */
#define msg_EnableObjectPrinting(a,b) __msg_EnableObjectPrinting(VLC_OBJECT(a),b)
#define msg_DisableObjectPrinting(a,b) __msg_DisableObjectPrinting(VLC_OBJECT(a),b)
VLC_EXPORT( void, __msg_EnableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
VLC_EXPORT( void, __msg_DisableObjectPrinting, ( vlc_object_t *, char * psz_object ) );

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
114 115 116
/**
 * @}
 */
117 118 119 120 121 122 123

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

124 125 126
/****************************
 * Generic stats stuff
 ****************************/
127 128 129 130 131 132
enum
{
    STATS_LAST,
    STATS_COUNTER,
    STATS_MAX,
    STATS_MIN,
133 134
    STATS_DERIVATIVE,
    STATS_TIMER
135 136 137 138 139 140 141 142 143 144
};

struct counter_sample_t
{
    vlc_value_t value;
    mtime_t     date;
};

struct counter_t
{
145
    unsigned int        i_id;
146 147
    char              * psz_name;
    int                 i_type;
148
    void              * p_obj;
149
    int                 i_compute_type;
150 151
    int                 i_samples;
    counter_sample_t ** pp_samples;
152 153 154

    mtime_t             update_interval;
    mtime_t             last_update;
155 156
};

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
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,

177
    STATS_TIMER_PLAYLIST_BUILD,
178 179
    STATS_TIMER_ML_LOAD,
    STATS_TIMER_ML_DUMP,
180
    STATS_TIMER_INTERACTION,
Clément Stenac's avatar
Clément Stenac committed
181
    STATS_TIMER_PREPARSE,
182
    STATS_TIMER_INPUT_LAUNCHING,
183
    STATS_TIMER_MODULE_NEED,
184 185
    STATS_TIMER_VIDEO_FRAME_ENCODING,
    STATS_TIMER_AUDIO_FRAME_ENCODING,
Clément Stenac's avatar
Clément Stenac committed
186 187

    STATS_TIMER_SKINS_PLAYTREE_IMAGE,
188 189
};

190 191 192 193 194 195
#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*) );
196

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

199 200 201
#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 )
202
{
Eric Petit's avatar
Eric Petit committed
203
    int i_ret;
Clément Stenac's avatar
Clément Stenac committed
204
    vlc_value_t val; val.i_int = 0;
Clément Stenac's avatar
Clément Stenac committed
205
    if( !p_counter ) return VLC_EGENERIC;
206
    i_ret = __stats_Get( p_obj, p_counter, &val );
207 208 209
    *value = val.i_int;
    return i_ret;
}
210

211 212 213
#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 )
214
{
215
    int i_ret;
216
    vlc_value_t val; val.f_float = 0.0;
Clément Stenac's avatar
Clément Stenac committed
217
    if( !p_counter ) return VLC_EGENERIC;
218
    i_ret = __stats_Get( p_obj, p_counter, &val );
219 220 221
    *value = val.f_float;
    return i_ret;
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
222
#define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
223 224
static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
                                         int i, int *pi_new )
225
{
226
    int i_ret;
227
    vlc_value_t val;
Clément Stenac's avatar
Clément Stenac committed
228
    vlc_value_t new_val; new_val.i_int = 0;
Clément Stenac's avatar
Clément Stenac committed
229
    if( !p_co ) return VLC_EGENERIC;
230
    val.i_int = i;
231
    i_ret = __stats_Update( p_obj, p_co, val, &new_val );
232 233 234
    if( pi_new )
        *pi_new = new_val.i_int;
    return i_ret;
235
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
236
#define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
237 238
static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
                                       float f, float *pf_new )
239 240
{
    vlc_value_t val;
241
    int i_ret;
Clément Stenac's avatar
Clément Stenac committed
242
    vlc_value_t new_val;new_val.f_float = 0.0;
Clément Stenac's avatar
Clément Stenac committed
243
    if( !p_co ) return VLC_EGENERIC;
244
    val.f_float = f;
245
    i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
246 247 248
    if( pf_new )
        *pf_new = new_val.f_float;
    return i_ret;
249
}
250

251 252 253
/******************
 * Input stats
 ******************/
254 255
struct input_stats_t
{
256 257
    vlc_mutex_t         lock;

258 259 260
    /* Input */
    int i_read_packets;
    int i_read_bytes;
261 262
    float f_input_bitrate;
    float f_average_input_bitrate;
263

264 265 266 267 268
    /* Demux */
    int i_demux_read_packets;
    int i_demux_read_bytes;
    float f_demux_bitrate;
    float f_average_demux_bitrate;
269 270

    /* Decoders */
271 272
    int i_decoded_audio;
    int i_decoded_video;
273 274 275 276

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

278 279 280 281 282
    /* Sout */
    int i_sent_packets;
    int i_sent_bytes;
    float f_send_bitrate;

Clément Stenac's avatar
Clément Stenac committed
283 284 285
    /* Aout */
    int i_played_abuffers;
    int i_lost_abuffers;
Clément Stenac's avatar
Clément Stenac committed
286
};
287 288 289 290

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 *) );
291 292 293 294 295 296 297 298 299

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

    float f_input_bitrate;
300
    float f_demux_bitrate;
301 302 303 304 305
    float f_output_bitrate;

    int i_http_clients;
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
306
#define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
307 308 309 310 311 312
VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));


/*********
 * Timing
 ********/
313
#define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
314 315 316
#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) )
317 318 319
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) );
320
VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
321 322 323 324
#define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) );

#define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
325
VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );
326 327

#endif