log.h 6.95 KB
Newer Older
1 2 3
/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg 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
 * FFmpeg 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 FFmpeg; 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
#include "attributes.h"
27

28 29 30 31 32 33 34 35 36 37
typedef enum {
    AV_CLASS_CATEGORY_NA = 0,
    AV_CLASS_CATEGORY_INPUT,
    AV_CLASS_CATEGORY_OUTPUT,
    AV_CLASS_CATEGORY_MUXER,
    AV_CLASS_CATEGORY_DEMUXER,
    AV_CLASS_CATEGORY_ENCODER,
    AV_CLASS_CATEGORY_DECODER,
    AV_CLASS_CATEGORY_FILTER,
    AV_CLASS_CATEGORY_BITSTREAM_FILTER,
Paul B Mahol's avatar
Paul B Mahol committed
38 39
    AV_CLASS_CATEGORY_SWSCALER,
    AV_CLASS_CATEGORY_SWRESAMPLER,
40
    AV_CLASS_CATEGORY_NB, ///< not part of ABI/API
41 42
}AVClassCategory;

43 44
struct AVOptionRanges;

45
/**
46
 * Describe the class of an AVClass context structure. That is an
47 48
 * arbitrary struct of which the first field is a pointer to an
 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
49
 */
50
typedef struct AVClass {
51
    /**
Diego Biurrun's avatar
Diego Biurrun committed
52
     * The name of the class; usually it is the same name as the
Diego Biurrun's avatar
Diego Biurrun committed
53
     * context structure type to which the AVClass is associated.
54
     */
55
    const char* class_name;
56 57

    /**
58
     * A pointer to a function which returns the name of a context
59
     * instance ctx associated with the class.
60 61 62 63 64 65 66 67
     */
    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()
     */
68
    const struct AVOption *option;
69 70 71

    /**
     * LIBAVUTIL_VERSION with which this structure was created.
Jai Menon's avatar
Jai Menon committed
72
     * This is used to allow fields to be added without requiring major
73 74 75 76
     * version bumps everywhere.
     */

    int version;
77 78 79 80 81 82

    /**
     * Offset in the structure where log_level_offset is stored.
     * 0 means there is no such variable
     */
    int log_level_offset_offset;
83 84

    /**
85 86 87 88 89
     * Offset in the structure where a pointer to the parent context for
     * logging is stored. For example a decoder could pass its AVCodecContext
     * to eval as such a parent context, which an av_log() implementation
     * could then leverage to display the parent context.
     * The offset can be NULL.
90 91
     */
    int parent_log_context_offset;
92 93

    /**
94
     * Return next AVOptions-enabled child or NULL
95
     */
96 97 98
    void* (*child_next)(void *obj, void *prev);

    /**
99
     * Return an AVClass corresponding to the next potential
100 101 102 103 104 105 106
     * AVOptions-enabled child.
     *
     * The difference between child_next and this is that
     * child_next iterates over _already existing_ objects, while
     * child_class_next iterates over _all possible_ children.
     */
    const struct AVClass* (*child_class_next)(const struct AVClass *prev);
107 108 109

    /**
     * Category used for visualization (like color)
110
     * This is only set if the category is equal for all objects using this class.
111 112 113
     * available since version (51 << 16 | 56 << 8 | 100)
     */
    AVClassCategory category;
114 115 116 117 118 119

    /**
     * Callback to return the category.
     * available since version (51 << 16 | 59 << 8 | 100)
     */
    AVClassCategory (*get_category)(void* ctx);
120 121 122 123 124 125

    /**
     * Callback to return the supported/allowed ranges.
     * available since version (52.12)
     */
    int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags);
126
} AVClass;
127 128 129

/* av_log API */

130 131 132
#define AV_LOG_QUIET    -8

/**
133
 * Something went really wrong and we will crash now.
134 135 136 137
 */
#define AV_LOG_PANIC     0

/**
138 139 140
 * 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.
141 142 143 144
 */
#define AV_LOG_FATAL     8

/**
145 146
 * Something went wrong and cannot losslessly be recovered.
 * However, not all future data is affected.
147 148 149 150
 */
#define AV_LOG_ERROR    16

/**
151 152
 * Something somehow does not look correct. This may or may not
 * lead to problems. An example would be the use of '-vstrict -2'.
153 154 155 156 157 158 159
 */
#define AV_LOG_WARNING  24

#define AV_LOG_INFO     32
#define AV_LOG_VERBOSE  40

/**
160
 * Stuff which is only useful for libav* developers.
161 162
 */
#define AV_LOG_DEBUG    48
163

164 165
#define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET)

166
/**
167
 * Send the specified message to the log if the level is less than or equal
168
 * to the current av_log_level. By default, all logging messages are sent to
169 170 171 172 173 174 175 176 177 178 179
 * 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
 */
180
void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
181

182
void av_vlog(void *avcl, int level, const char *fmt, va_list);
183 184 185 186
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);
187
const char* av_default_item_name(void* ctx);
188
AVClassCategory av_default_get_category(void *ptr);
189

190 191 192 193 194 195 196 197 198 199
/**
 * Format a line of log the same way as the default callback.
 * @param line          buffer to receive the formated line
 * @param line_size     size of the buffer
 * @param print_prefix  used to store whether the prefix must be printed;
 *                      must point to a persistent integer initially set to 1
 */
void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
                        char *line, int line_size, int *print_prefix);

200 201 202 203 204 205 206 207
/**
 * 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
208
#    define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
209 210
#endif

211 212 213 214 215 216
/**
 * 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
217
 * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end
218 219 220 221
 */
#define AV_LOG_SKIP_REPEATED 1
void av_log_set_flags(int arg);

222
#endif /* AVUTIL_LOG_H */