2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * 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 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include "attributes.h"
29 AV_CLASS_CATEGORY_NA = 0,
30 AV_CLASS_CATEGORY_INPUT,
31 AV_CLASS_CATEGORY_OUTPUT,
32 AV_CLASS_CATEGORY_MUXER,
33 AV_CLASS_CATEGORY_DEMUXER,
34 AV_CLASS_CATEGORY_ENCODER,
35 AV_CLASS_CATEGORY_DECODER,
36 AV_CLASS_CATEGORY_FILTER,
37 AV_CLASS_CATEGORY_BITSTREAM_FILTER,
38 AV_CLASS_CATEGORY_NB, ///< not part of ABI/API
42 * Describe the class of an AVClass context structure. That is an
43 * arbitrary struct of which the first field is a pointer to an
44 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
46 typedef struct AVClass {
48 * The name of the class; usually it is the same name as the
49 * context structure type to which the AVClass is associated.
51 const char* class_name;
54 * A pointer to a function which returns the name of a context
55 * instance ctx associated with the class.
57 const char* (*item_name)(void* ctx);
60 * a pointer to the first option specified in the class if any or NULL
62 * @see av_set_default_options()
64 const struct AVOption *option;
67 * LIBAVUTIL_VERSION with which this structure was created.
68 * This is used to allow fields to be added without requiring major
69 * version bumps everywhere.
75 * Offset in the structure where log_level_offset is stored.
76 * 0 means there is no such variable
78 int log_level_offset_offset;
81 * Offset in the structure where a pointer to the parent context for loging is stored.
82 * for example a decoder that uses eval.c could pass its AVCodecContext to eval as such
83 * parent context. And a av_log() implementation could then display the parent context
84 * can be NULL of course
86 int parent_log_context_offset;
89 * Return next AVOptions-enabled child or NULL
91 void* (*child_next)(void *obj, void *prev);
94 * Return an AVClass corresponding to next potential
95 * AVOptions-enabled child.
97 * The difference between child_next and this is that
98 * child_next iterates over _already existing_ objects, while
99 * child_class_next iterates over _all possible_ children.
101 const struct AVClass* (*child_class_next)(const struct AVClass *prev);
104 * Category used for visualization (like color)
105 * This is only set if the category is equal for all objects using this class.
106 * available since version (51 << 16 | 56 << 8 | 100)
108 AVClassCategory category;
111 * Callback to return the category.
112 * available since version (51 << 16 | 59 << 8 | 100)
114 AVClassCategory (*get_category)(void* ctx);
119 #define AV_LOG_QUIET -8
122 * Something went really wrong and we will crash now.
124 #define AV_LOG_PANIC 0
127 * Something went wrong and recovery is not possible.
128 * For example, no header was found for a format which depends
129 * on headers or an illegal combination of parameters is used.
131 #define AV_LOG_FATAL 8
134 * Something went wrong and cannot losslessly be recovered.
135 * However, not all future data is affected.
137 #define AV_LOG_ERROR 16
140 * Something somehow does not look correct. This may or may not
141 * lead to problems. An example would be the use of '-vstrict -2'.
143 #define AV_LOG_WARNING 24
145 #define AV_LOG_INFO 32
146 #define AV_LOG_VERBOSE 40
149 * Stuff which is only useful for libav* developers.
151 #define AV_LOG_DEBUG 48
153 #define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET)
156 * Send the specified message to the log if the level is less than or equal
157 * to the current av_log_level. By default, all logging messages are sent to
158 * stderr. This behavior can be altered by setting a different av_vlog callback
161 * @param avcl A pointer to an arbitrary struct of which the first field is a
162 * pointer to an AVClass struct.
163 * @param level The importance level of the message, lower values signifying
165 * @param fmt The format string (printf-compatible) that specifies how
166 * subsequent arguments are converted to output.
169 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
171 void av_vlog(void *avcl, int level, const char *fmt, va_list);
172 int av_log_get_level(void);
173 void av_log_set_level(int);
174 void av_log_set_callback(void (*)(void*, int, const char*, va_list));
175 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
176 const char* av_default_item_name(void* ctx);
177 AVClassCategory av_default_get_category(void *ptr);
180 * Format a line of log the same way as the default callback.
181 * @param line buffer to receive the formated line
182 * @param line_size size of the buffer
183 * @param print_prefix used to store whether the prefix must be printed;
184 * must point to a persistent integer initially set to 1
186 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
187 char *line, int line_size, int *print_prefix);
191 * Useful to print debug messages that shouldn't get compiled in normally.
195 # define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
197 # define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
201 * Skip repeated messages, this requires the user app to use av_log() instead of
202 * (f)printf as the 2 would otherwise interfere and lead to
203 * "Last message repeated x times" messages below (f)printf messages with some
205 * Also to receive the last, "last repeated" line if any, the user app must
206 * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end
208 #define AV_LOG_SKIP_REPEATED 1
209 void av_log_set_flags(int arg);
211 #endif /* AVUTIL_LOG_H */