vlc_messages.h 3.52 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.
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
6
 * Copyright (C) 1999, 2000, 2001, 2002 VLC authors and VideoLAN
7
 * $Id$
8 9 10 11
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
12 13 14
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
15
 * (at your option) any later version.
16
 *
17 18
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
21
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
22 23 24
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 26
 *****************************************************************************/

27 28
#ifndef VLC_MESSAGES_H_
#define VLC_MESSAGES_H_
Clément Stenac's avatar
Clément Stenac committed
29

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

35
#include <stdarg.h>
Clément Stenac's avatar
Clément Stenac committed
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
    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) */
63 64
} msg_item_t;

Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
65
/**
66
 * Used by interface plugins which subscribe to the message bank.
Sigmund Augdal Helberg's avatar
all:  
Sigmund Augdal Helberg committed
67
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
68
typedef struct msg_subscription_t msg_subscription_t;
69 70 71 72

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
73 74 75 76 77
VLC_API void vlc_Log(vlc_object_t *, int,
                     const char *, const char *, ...) VLC_FORMAT( 4, 5 );
VLC_API void vlc_vaLog(vlc_object_t *, int,
                       const char *, const char *, va_list);
#define msg_GenericVa(a, b, c, d, e) vlc_vaLog(VLC_OBJECT(a), b, c, d, e)
78

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
79
#define msg_Info( p_this, ... ) \
80
    vlc_Log( VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, __VA_ARGS__ )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
81
#define msg_Err( p_this, ... ) \
82
    vlc_Log( VLC_OBJECT(p_this), VLC_MSG_ERR,  MODULE_STRING, __VA_ARGS__ )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
83
#define msg_Warn( p_this, ... ) \
84
    vlc_Log( VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, __VA_ARGS__ )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
85
#define msg_Dbg( p_this, ... ) \
86
    vlc_Log( VLC_OBJECT(p_this), VLC_MSG_DBG,  MODULE_STRING, __VA_ARGS__ )
87

88 89 90 91
/**
 * Message logging callback signature.
 * Accepts one private data pointer, the message, and an overrun counter.
 */
92 93
typedef void (*msg_callback_t) (void *, int, const msg_item_t *,
                                const char *, va_list);
94

95
VLC_API msg_subscription_t *vlc_Subscribe(msg_callback_t, void *) VLC_USED;
96
VLC_API void vlc_Unsubscribe(msg_subscription_t *);
97

Rémi Duraffort's avatar
Rémi Duraffort committed
98 99 100
/**
 * @}
 */
Clément Stenac's avatar
Clément Stenac committed
101
#endif