vlc_messages.h 6.58 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

45 46 47 48 49 50 51 52 53
/** Message types */
enum msg_item_type
{
    VLC_MSG_INFO=0, /**< Important information */
    VLC_MSG_ERR,    /**< Error */
    VLC_MSG_WARN,   /**< Warning */
    VLC_MSG_DBG,    /**< Debug */
};

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
54
/**
55
 * Log message
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
56
 */
57 58
typedef struct
{
59 60 61 62 63 64
    unsigned    i_type;  /**< Message type, see @ref msg_item_type */
    uintptr_t   i_object_id; /**< Emitter (temporaly) unique object ID or 0 */
    const char *psz_object_type; /**< Emitter object type name */
    const char *psz_module; /**< Emitter module (source code) */
    const char *psz_header; /**< Additional header (used by VLM media) */
    char       *psz_msg; /**< Message text */
65 66
} msg_item_t;

67 68
VLC_MALLOC VLC_USED
static inline msg_item_t *msg_Copy (const msg_item_t *msg)
69
{
70 71 72 73 74 75
    msg_item_t *copy = (msg_item_t *)xmalloc (sizeof (*copy));
    copy->i_type = msg->i_type;
    copy->i_object_id = msg->i_object_id;
    copy->psz_object_type = msg->psz_object_type;
    copy->psz_module = strdup (msg->psz_module);
    copy->psz_msg = strdup (msg->psz_msg);
76
    copy->psz_header = msg->psz_header ? strdup (msg->psz_header) : NULL;
77
    return copy;
78 79
}

80
static inline void msg_Free (msg_item_t *msg)
81
{
82
    free ((char *)msg->psz_module);
83
    free ((char *)msg->psz_header);
84 85
    free (msg->psz_msg);
    free (msg);
86 87
}

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
88
/**
89
 * Used by interface plugins which subscribe to the message bank.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
90
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
91
typedef struct msg_subscription_t msg_subscription_t;
92 93 94 95

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
96
VLC_API void msg_Generic( vlc_object_t *, int, const char *, const char *, ... ) VLC_FORMAT( 4, 5 );
97
VLC_API void msg_GenericVa( vlc_object_t *, int, const char *, const char *, va_list args );
98
#define msg_GenericVa(a, b, c, d, e) msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
99

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
100
#define msg_Info( p_this, ... ) \
101
        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
102 103
                     MODULE_STRING, __VA_ARGS__ )
#define msg_Err( p_this, ... ) \
104
        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
105 106
                     MODULE_STRING, __VA_ARGS__ )
#define msg_Warn( p_this, ... ) \
107
        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
108 109
                     MODULE_STRING, __VA_ARGS__ )
#define msg_Dbg( p_this, ... ) \
110
        msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
111
                     MODULE_STRING, __VA_ARGS__ )
112

113 114 115 116 117 118
typedef struct msg_cb_data_t msg_cb_data_t;

/**
 * Message logging callback signature.
 * Accepts one private data pointer, the message, and an overrun counter.
 */
119
typedef void (*msg_callback_t) (msg_cb_data_t *, const msg_item_t *);
120

121
VLC_API msg_subscription_t* msg_Subscribe( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) VLC_USED;
122
VLC_API void msg_Unsubscribe( msg_subscription_t * );
123

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
124 125 126
/**
 * @}
 */
127 128 129 130 131 132 133

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

134 135 136
/****************************
 * Generic stats stuff
 ****************************/
137 138 139 140 141 142
enum
{
    STATS_LAST,
    STATS_COUNTER,
    STATS_MAX,
    STATS_MIN,
143 144
    STATS_DERIVATIVE,
    STATS_TIMER
145 146 147 148 149 150 151 152 153 154
};

struct counter_sample_t
{
    vlc_value_t value;
    mtime_t     date;
};

struct counter_t
{
155
    unsigned int        i_id;
156 157
    char              * psz_name;
    int                 i_type;
158
    void              * p_obj;
159
    int                 i_compute_type;
160 161
    int                 i_samples;
    counter_sample_t ** pp_samples;
162 163 164

    mtime_t             update_interval;
    mtime_t             last_update;
165 166
};

167 168 169 170 171 172 173
enum
{
    STATS_INPUT_BITRATE,
    STATS_READ_BYTES,
    STATS_READ_PACKETS,
    STATS_DEMUX_READ,
    STATS_DEMUX_BITRATE,
174 175
    STATS_DEMUX_CORRUPTED,
    STATS_DEMUX_DISCONTINUITY,
176 177 178 179 180 181 182 183 184 185 186 187 188
    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,

189
    STATS_TIMER_PLAYLIST_BUILD,
190 191
    STATS_TIMER_ML_LOAD,
    STATS_TIMER_ML_DUMP,
192
    STATS_TIMER_INTERACTION,
Clément Stenac's avatar
Clément Stenac committed
193
    STATS_TIMER_PREPARSE,
194
    STATS_TIMER_INPUT_LAUNCHING,
195
    STATS_TIMER_MODULE_NEED,
196 197
    STATS_TIMER_VIDEO_FRAME_ENCODING,
    STATS_TIMER_AUDIO_FRAME_ENCODING,
Clément Stenac's avatar
Clément Stenac committed
198 199

    STATS_TIMER_SKINS_PLAYTREE_IMAGE,
200 201
};

202 203 204
/*********
 * Timing
 ********/
205 206 207 208
VLC_API void stats_TimerStart(vlc_object_t*, const char *, unsigned int );
VLC_API void stats_TimerStop(vlc_object_t*, unsigned int);
VLC_API void stats_TimerDump(vlc_object_t*, unsigned int);
VLC_API void stats_TimersDumpAll(vlc_object_t*);
209 210 211 212 213
#define stats_TimerStart(a,b,c) stats_TimerStart( VLC_OBJECT(a), b,c )
#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) )

214
VLC_API void stats_TimersCleanAll(vlc_object_t * );
215 216
#define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) )

217
VLC_API void stats_TimerClean(vlc_object_t *, unsigned int );
218
#define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b )
219

220 221 222
/**
 * @}
 */
223
#endif