vlc_messages.h 9.68 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
#ifndef _VLC_MESSAGES_H_
#define _VLC_MESSAGES_H_

30
#include <stdarg.h>
31

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
 * Store a single message sent to user.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
42
 */
43 44
typedef struct
{
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
45
    int     i_type;                             /**< message type, see below */
46
    int     i_object_id;
47
    char *  psz_object;
48
    char *  psz_module;
49 50
    char *  psz_msg;                            /**< the message itself */
    char *  psz_header;                         /**< Additional header */
51

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

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

/**
66
 * Used by interface plugins which subscribe to the message bank.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
67
 */
68
struct msg_subscription_t
69 70 71 72 73 74 75 76 77 78 79
{
    int   i_start;
    int*  pi_stop;

    msg_item_t*  p_msg;
    vlc_mutex_t* p_lock;
};

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
80
VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
81 82
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)
83 84 85 86
VLC_EXPORT( void, __msg_Info,    ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
VLC_EXPORT( void, __msg_Err,     ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
VLC_EXPORT( void, __msg_Warn,    ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
VLC_EXPORT( void, __msg_Dbg,    ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
87

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

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

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
106 107 108
/**
 * @}
 */
109 110 111 112 113 114 115

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

116 117 118
/****************************
 * Generic stats stuff
 ****************************/
119 120 121 122 123 124
enum
{
    STATS_LAST,
    STATS_COUNTER,
    STATS_MAX,
    STATS_MIN,
125 126
    STATS_DERIVATIVE,
    STATS_TIMER
127 128 129 130 131 132 133 134 135 136
};

struct counter_sample_t
{
    vlc_value_t value;
    mtime_t     date;
};

struct counter_t
{
137
    unsigned int        i_id;
138 139
    char              * psz_name;
    int                 i_type;
140
    void              * p_obj;
141
    int                 i_compute_type;
142 143
    int                 i_samples;
    counter_sample_t ** pp_samples;
144 145 146

    mtime_t             update_interval;
    mtime_t             last_update;
147 148
};

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
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,

169
    STATS_TIMER_PLAYLIST_BUILD,
170 171
    STATS_TIMER_ML_LOAD,
    STATS_TIMER_ML_DUMP,
172
    STATS_TIMER_INTERACTION,
Clément Stenac's avatar
Clément Stenac committed
173
    STATS_TIMER_PREPARSE,
174
    STATS_TIMER_INPUT_LAUNCHING,
175
    STATS_TIMER_MODULE_NEED,
176 177
    STATS_TIMER_VIDEO_FRAME_ENCODING,
    STATS_TIMER_AUDIO_FRAME_ENCODING,
Clément Stenac's avatar
Clément Stenac committed
178 179

    STATS_TIMER_SKINS_PLAYTREE_IMAGE,
180 181
};

182 183 184 185 186 187
#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*) );
188

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

191 192 193
#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 )
194
{
Eric Petit's avatar
Eric Petit committed
195
    int i_ret;
Clément Stenac's avatar
Clément Stenac committed
196
    vlc_value_t val; val.i_int = 0;
Clément Stenac's avatar
Clément Stenac committed
197
    if( !p_counter ) return VLC_EGENERIC;
198
    i_ret = __stats_Get( p_obj, p_counter, &val );
199 200 201
    *value = val.i_int;
    return i_ret;
}
202

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

243 244 245
/******************
 * Input stats
 ******************/
246 247
struct input_stats_t
{
248 249
    vlc_mutex_t         lock;

250 251 252
    /* Input */
    int i_read_packets;
    int i_read_bytes;
253 254
    float f_input_bitrate;
    float f_average_input_bitrate;
255

256 257 258 259 260
    /* Demux */
    int i_demux_read_packets;
    int i_demux_read_bytes;
    float f_demux_bitrate;
    float f_average_demux_bitrate;
261 262

    /* Decoders */
263 264
    int i_decoded_audio;
    int i_decoded_video;
265 266 267 268

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

270 271 272 273 274
    /* Sout */
    int i_sent_packets;
    int i_sent_bytes;
    float f_send_bitrate;

Clément Stenac's avatar
Clément Stenac committed
275 276 277
    /* Aout */
    int i_played_abuffers;
    int i_lost_abuffers;
Clément Stenac's avatar
Clément Stenac committed
278
};
279 280 281 282

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 *) );
283 284 285 286 287 288 289 290 291

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

    float f_input_bitrate;
292
    float f_demux_bitrate;
293 294 295 296 297
    float f_output_bitrate;

    int i_http_clients;
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
298
#define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
299 300 301 302 303 304
VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));


/*********
 * Timing
 ********/
305
#define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
306 307 308
#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) )
309 310 311
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) );
312
VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
313 314 315 316
#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 )
317
VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );
318 319

#endif