log.h 4.86 KB
Newer Older
1 2 3
/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * Libav is distributed in the hope that it will be useful,
12 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with Libav; if not, write to the Free Software
18 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21 22
#ifndef AVUTIL_LOG_H
#define AVUTIL_LOG_H
23 24

#include <stdarg.h>
25
#include "avutil.h"
26 27

/**
28
 * Describe the class of an AVClass context structure. That is an
29 30
 * arbitrary struct of which the first field is a pointer to an
 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
31
 */
32
typedef struct {
33
    /**
Diego Biurrun's avatar
Diego Biurrun committed
34
     * The name of the class; usually it is the same name as the
Diego Biurrun's avatar
Diego Biurrun committed
35
     * context structure type to which the AVClass is associated.
36
     */
37
    const char* class_name;
38 39

    /**
40
     * A pointer to a function which returns the name of a context
41
     * instance ctx associated with the class.
42 43 44 45 46 47 48 49
     */
    const char* (*item_name)(void* ctx);

    /**
     * a pointer to the first option specified in the class if any or NULL
     *
     * @see av_set_default_options()
     */
50
    const struct AVOption *option;
51 52 53

    /**
     * LIBAVUTIL_VERSION with which this structure was created.
Jai Menon's avatar
Jai Menon committed
54
     * This is used to allow fields to be added without requiring major
55 56 57 58
     * version bumps everywhere.
     */

    int version;
59 60 61 62 63 64

    /**
     * Offset in the structure where log_level_offset is stored.
     * 0 means there is no such variable
     */
    int log_level_offset_offset;
65 66 67 68 69 70 71 72

    /**
     * Offset in the structure where a pointer to the parent context for loging is stored.
     * for example a decoder that uses eval.c could pass its AVCodecContext to eval as such
     * parent context. And a av_log() implementation could then display the parent context
     * can be NULL of course
     */
    int parent_log_context_offset;
73
} AVClass;
74 75 76

/* av_log API */

77 78 79
#define AV_LOG_QUIET    -8

/**
80
 * Something went really wrong and we will crash now.
81 82 83 84
 */
#define AV_LOG_PANIC     0

/**
85 86 87
 * Something went wrong and recovery is not possible.
 * For example, no header was found for a format which depends
 * on headers or an illegal combination of parameters is used.
88 89 90 91
 */
#define AV_LOG_FATAL     8

/**
92 93
 * Something went wrong and cannot losslessly be recovered.
 * However, not all future data is affected.
94 95 96 97
 */
#define AV_LOG_ERROR    16

/**
98 99
 * Something somehow does not look correct. This may or may not
 * lead to problems. An example would be the use of '-vstrict -2'.
100 101 102 103 104 105 106
 */
#define AV_LOG_WARNING  24

#define AV_LOG_INFO     32
#define AV_LOG_VERBOSE  40

/**
107
 * Stuff which is only useful for libav* developers.
108 109
 */
#define AV_LOG_DEBUG    48
110

111
/**
112
 * Send the specified message to the log if the level is less than or equal
113
 * to the current av_log_level. By default, all logging messages are sent to
114 115 116 117 118 119 120 121 122 123 124
 * stderr. This behavior can be altered by setting a different av_vlog callback
 * function.
 *
 * @param avcl A pointer to an arbitrary struct of which the first field is a
 * pointer to an AVClass struct.
 * @param level The importance level of the message, lower values signifying
 * higher importance.
 * @param fmt The format string (printf-compatible) that specifies how
 * subsequent arguments are converted to output.
 * @see av_vlog
 */
125
#ifdef __GNUC__
126
void av_log(void *avcl, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
127
#else
128
void av_log(void *avcl, int level, const char *fmt, ...);
129 130
#endif

131
void av_vlog(void *avcl, int level, const char *fmt, va_list);
132 133 134 135
int av_log_get_level(void);
void av_log_set_level(int);
void av_log_set_callback(void (*)(void*, int, const char*, va_list));
void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
136
const char* av_default_item_name(void* ctx);
137

138 139 140 141 142 143 144 145 146 147 148
/**
 * av_dlog macros
 * Useful to print debug messages that shouldn't get compiled in normally.
 */

#ifdef DEBUG
#    define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
#else
#    define av_dlog(pctx, ...)
#endif

149 150 151 152 153 154 155 156 157 158 159
/**
 * Skip repeated messages, this requires the user app to use av_log() instead of
 * (f)printf as the 2 would otherwise interfere and lead to
 * "Last message repeated x times" messages below (f)printf messages with some
 * bad luck.
 * Also to receive the last, "last repeated" line if any, the user app must
 * call av_log(NULL, AV_LOG_QUIET, ""); at the end
 */
#define AV_LOG_SKIP_REPEATED 1
void av_log_set_flags(int arg);

160
#endif /* AVUTIL_LOG_H */