vlc_messages.h 6.98 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
    const char *psz_module;
54
    const char *psz_header;                     /**< Additional header */
55
    char *  psz_msg;                            /**< the message itself */
56 57 58
} msg_item_t;

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

68 69
VLC_MALLOC VLC_USED
static inline msg_item_t *msg_Copy (const msg_item_t *msg)
70
{
71 72 73 74 75 76
    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);
77
    copy->psz_header = msg->psz_header ? strdup (msg->psz_header) : NULL;
78
    return copy;
79 80
}

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

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

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

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

114 115 116 117 118 119
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.
 */
120
typedef void (*msg_callback_t) (msg_cb_data_t *, const msg_item_t *);
121

122
VLC_API msg_subscription_t* msg_Subscribe( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) VLC_USED;
123 124
VLC_API void msg_Unsubscribe( msg_subscription_t * );
VLC_API void msg_SubscriptionSetVerbosity( msg_subscription_t *, const int);
125

126
/* Enable or disable a certain object debug messages */
127
VLC_API void msg_EnableObjectPrinting( vlc_object_t *, const char * psz_object );
128
#define msg_EnableObjectPrinting(a,b) msg_EnableObjectPrinting(VLC_OBJECT(a),b)
129
VLC_API void msg_DisableObjectPrinting( vlc_object_t *, const char * psz_object );
130 131
#define msg_DisableObjectPrinting(a,b) msg_DisableObjectPrinting(VLC_OBJECT(a),b)

132

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
133 134 135
/**
 * @}
 */
136 137 138 139 140 141 142

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

143 144 145
/****************************
 * Generic stats stuff
 ****************************/
146 147 148 149 150 151
enum
{
    STATS_LAST,
    STATS_COUNTER,
    STATS_MAX,
    STATS_MIN,
152 153
    STATS_DERIVATIVE,
    STATS_TIMER
154 155 156 157 158 159 160 161 162 163
};

struct counter_sample_t
{
    vlc_value_t value;
    mtime_t     date;
};

struct counter_t
{
164
    unsigned int        i_id;
165 166
    char              * psz_name;
    int                 i_type;
167
    void              * p_obj;
168
    int                 i_compute_type;
169 170
    int                 i_samples;
    counter_sample_t ** pp_samples;
171 172 173

    mtime_t             update_interval;
    mtime_t             last_update;
174 175
};

176 177 178 179 180 181 182
enum
{
    STATS_INPUT_BITRATE,
    STATS_READ_BYTES,
    STATS_READ_PACKETS,
    STATS_DEMUX_READ,
    STATS_DEMUX_BITRATE,
183 184
    STATS_DEMUX_CORRUPTED,
    STATS_DEMUX_DISCONTINUITY,
185 186 187 188 189 190 191 192 193 194 195 196 197
    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,

198
    STATS_TIMER_PLAYLIST_BUILD,
199 200
    STATS_TIMER_ML_LOAD,
    STATS_TIMER_ML_DUMP,
201
    STATS_TIMER_INTERACTION,
Clément Stenac's avatar
Clément Stenac committed
202
    STATS_TIMER_PREPARSE,
203
    STATS_TIMER_INPUT_LAUNCHING,
204
    STATS_TIMER_MODULE_NEED,
205 206
    STATS_TIMER_VIDEO_FRAME_ENCODING,
    STATS_TIMER_AUDIO_FRAME_ENCODING,
Clément Stenac's avatar
Clément Stenac committed
207 208

    STATS_TIMER_SKINS_PLAYTREE_IMAGE,
209 210
};

211 212 213
/*********
 * Timing
 ********/
214 215 216 217
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*);
218 219 220 221 222
#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) )

223
VLC_API void stats_TimersCleanAll(vlc_object_t * );
224 225
#define stats_TimersCleanAll(a) stats_TimersCleanAll( VLC_OBJECT(a) )

226
VLC_API void stats_TimerClean(vlc_object_t *, unsigned int );
227
#define stats_TimerClean(a,b) stats_TimerClean( VLC_OBJECT(a), b )
228

229 230 231
/**
 * @}
 */
232
#endif