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_SWSCALER,
39 AV_CLASS_CATEGORY_SWRESAMPLER,
40 AV_CLASS_CATEGORY_NB, ///< not part of ABI/API
43 struct AVOptionRanges;
46 * Describe the class of an AVClass context structure. That is an
47 * arbitrary struct of which the first field is a pointer to an
48 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
50 typedef struct AVClass {
52 * The name of the class; usually it is the same name as the
53 * context structure type to which the AVClass is associated.
55 const char* class_name;
58 * A pointer to a function which returns the name of a context
59 * instance ctx associated with the class.
61 const char* (*item_name)(void* ctx);
64 * a pointer to the first option specified in the class if any or NULL
66 * @see av_set_default_options()
68 const struct AVOption *option;
71 * LIBAVUTIL_VERSION with which this structure was created.
72 * This is used to allow fields to be added without requiring major
73 * version bumps everywhere.
79 * Offset in the structure where log_level_offset is stored.
80 * 0 means there is no such variable
82 int log_level_offset_offset;
85 * Offset in the structure where a pointer to the parent context for
86 * logging is stored. For example a decoder could pass its AVCodecContext
87 * to eval as such a parent context, which an av_log() implementation
88 * could then leverage to display the parent context.
89 * The offset can be NULL.
91 int parent_log_context_offset;
94 * Return next AVOptions-enabled child or NULL
96 void* (*child_next)(void *obj, void *prev);
99 * Return an AVClass corresponding to the next potential
100 * AVOptions-enabled child.
102 * The difference between child_next and this is that
103 * child_next iterates over _already existing_ objects, while
104 * child_class_next iterates over _all possible_ children.
106 const struct AVClass* (*child_class_next)(const struct AVClass *prev);
109 * Category used for visualization (like color)
110 * This is only set if the category is equal for all objects using this class.
111 * available since version (51 << 16 | 56 << 8 | 100)
113 AVClassCategory category;
116 * Callback to return the category.
117 * available since version (51 << 16 | 59 << 8 | 100)
119 AVClassCategory (*get_category)(void* ctx);
122 * Callback to return the supported/allowed ranges.
123 * available since version (52.12)
125 int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags);
129 * @addtogroup lavu_log
133 * @defgroup lavu_log_constants Logging Constants
141 #define AV_LOG_QUIET -8
144 * Something went really wrong and we will crash now.
146 #define AV_LOG_PANIC 0
149 * Something went wrong and recovery is not possible.
150 * For example, no header was found for a format which depends
151 * on headers or an illegal combination of parameters is used.
153 #define AV_LOG_FATAL 8
156 * Something went wrong and cannot losslessly be recovered.
157 * However, not all future data is affected.
159 #define AV_LOG_ERROR 16
162 * Something somehow does not look correct. This may or may not
163 * lead to problems. An example would be the use of '-vstrict -2'.
165 #define AV_LOG_WARNING 24
168 * Standard information.
170 #define AV_LOG_INFO 32
173 * Detailed information.
175 #define AV_LOG_VERBOSE 40
178 * Stuff which is only useful for libav* developers.
180 #define AV_LOG_DEBUG 48
182 #define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET)
189 * Send the specified message to the log if the level is less than or equal
190 * to the current av_log_level. By default, all logging messages are sent to
191 * stderr. This behavior can be altered by setting a different logging callback
193 * @see av_log_set_callback
195 * @param avcl A pointer to an arbitrary struct of which the first field is a
196 * pointer to an AVClass struct.
197 * @param level The importance level of the message expressed using a @ref
198 * lavu_log_constants "Logging Constant".
199 * @param fmt The format string (printf-compatible) that specifies how
200 * subsequent arguments are converted to output.
202 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
206 * Send the specified message to the log if the level is less than or equal
207 * to the current av_log_level. By default, all logging messages are sent to
208 * stderr. This behavior can be altered by setting a different logging callback
210 * @see av_log_set_callback
212 * @param avcl A pointer to an arbitrary struct of which the first field is a
213 * pointer to an AVClass struct.
214 * @param level The importance level of the message expressed using a @ref
215 * lavu_log_constants "Logging Constant".
216 * @param fmt The format string (printf-compatible) that specifies how
217 * subsequent arguments are converted to output.
218 * @param vl The arguments referenced by the format string.
220 void av_vlog(void *avcl, int level, const char *fmt, va_list vl);
223 * Get the current log level
225 * @see lavu_log_constants
227 * @return Current log level
229 int av_log_get_level(void);
234 * @see lavu_log_constants
236 * @param level Logging level
238 void av_log_set_level(int level);
241 * Set the logging callback
243 * @note The callback must be thread safe, even if the application does not use
244 * threads itself as some codecs are multithreaded.
246 * @see av_log_default_callback
248 * @param callback A logging function with a compatible signature.
250 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list));
253 * Default logging callback
255 * It prints the message to stderr, optionally colorizing it.
257 * @param avcl A pointer to an arbitrary struct of which the first field is a
258 * pointer to an AVClass struct.
259 * @param level The importance level of the message expressed using a @ref
260 * lavu_log_constants "Logging Constant".
261 * @param fmt The format string (printf-compatible) that specifies how
262 * subsequent arguments are converted to output.
263 * @param vl The arguments referenced by the format string.
265 void av_log_default_callback(void *avcl, int level, const char *fmt,
269 * Return the context name
271 * @param ctx The AVClass context
273 * @return The AVClass class_name
275 const char* av_default_item_name(void* ctx);
276 AVClassCategory av_default_get_category(void *ptr);
279 * Format a line of log the same way as the default callback.
280 * @param line buffer to receive the formated line
281 * @param line_size size of the buffer
282 * @param print_prefix used to store whether the prefix must be printed;
283 * must point to a persistent integer initially set to 1
285 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
286 char *line, int line_size, int *print_prefix);
290 * Useful to print debug messages that shouldn't get compiled in normally.
294 # define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
296 # define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
300 * Skip repeated messages, this requires the user app to use av_log() instead of
301 * (f)printf as the 2 would otherwise interfere and lead to
302 * "Last message repeated x times" messages below (f)printf messages with some
304 * Also to receive the last, "last repeated" line if any, the user app must
305 * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end
307 #define AV_LOG_SKIP_REPEATED 1
308 void av_log_set_flags(int arg);
314 #endif /* AVUTIL_LOG_H */