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_DEVICE_VIDEO_OUTPUT = 40,
41 AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT,
42 AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT,
43 AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT,
44 AV_CLASS_CATEGORY_DEVICE_OUTPUT,
45 AV_CLASS_CATEGORY_DEVICE_INPUT,
46 AV_CLASS_CATEGORY_NB, ///< not part of ABI/API
49 struct AVOptionRanges;
52 * Describe the class of an AVClass context structure. That is an
53 * arbitrary struct of which the first field is a pointer to an
54 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
56 typedef struct AVClass {
58 * The name of the class; usually it is the same name as the
59 * context structure type to which the AVClass is associated.
61 const char* class_name;
64 * A pointer to a function which returns the name of a context
65 * instance ctx associated with the class.
67 const char* (*item_name)(void* ctx);
70 * a pointer to the first option specified in the class if any or NULL
72 * @see av_set_default_options()
74 const struct AVOption *option;
77 * LIBAVUTIL_VERSION with which this structure was created.
78 * This is used to allow fields to be added without requiring major
79 * version bumps everywhere.
85 * Offset in the structure where log_level_offset is stored.
86 * 0 means there is no such variable
88 int log_level_offset_offset;
91 * Offset in the structure where a pointer to the parent context for
92 * logging is stored. For example a decoder could pass its AVCodecContext
93 * to eval as such a parent context, which an av_log() implementation
94 * could then leverage to display the parent context.
95 * The offset can be NULL.
97 int parent_log_context_offset;
100 * Return next AVOptions-enabled child or NULL
102 void* (*child_next)(void *obj, void *prev);
105 * Return an AVClass corresponding to the next potential
106 * AVOptions-enabled child.
108 * The difference between child_next and this is that
109 * child_next iterates over _already existing_ objects, while
110 * child_class_next iterates over _all possible_ children.
112 const struct AVClass* (*child_class_next)(const struct AVClass *prev);
115 * Category used for visualization (like color)
116 * This is only set if the category is equal for all objects using this class.
117 * available since version (51 << 16 | 56 << 8 | 100)
119 AVClassCategory category;
122 * Callback to return the category.
123 * available since version (51 << 16 | 59 << 8 | 100)
125 AVClassCategory (*get_category)(void* ctx);
128 * Callback to return the supported/allowed ranges.
129 * available since version (52.12)
131 int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags);
135 * @addtogroup lavu_log
139 * @defgroup lavu_log_constants Logging Constants
147 #define AV_LOG_QUIET -8
150 * Something went really wrong and we will crash now.
152 #define AV_LOG_PANIC 0
155 * Something went wrong and recovery is not possible.
156 * For example, no header was found for a format which depends
157 * on headers or an illegal combination of parameters is used.
159 #define AV_LOG_FATAL 8
162 * Something went wrong and cannot losslessly be recovered.
163 * However, not all future data is affected.
165 #define AV_LOG_ERROR 16
168 * Something somehow does not look correct. This may or may not
169 * lead to problems. An example would be the use of '-vstrict -2'.
171 #define AV_LOG_WARNING 24
174 * Standard information.
176 #define AV_LOG_INFO 32
179 * Detailed information.
181 #define AV_LOG_VERBOSE 40
184 * Stuff which is only useful for libav* developers.
186 #define AV_LOG_DEBUG 48
188 #define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET)
195 * Sets additional colors for extended debugging sessions.
197 av_log(ctx, AV_LOG_DEBUG|AV_LOG_C(134), "Message in purple\n");
199 * Requires 256color terminal support. Uses outside debugging is not
202 #define AV_LOG_C(x) (x << 8)
205 * Send the specified message to the log if the level is less than or equal
206 * to the current av_log_level. By default, all logging messages are sent to
207 * stderr. This behavior can be altered by setting a different logging callback
209 * @see av_log_set_callback
211 * @param avcl A pointer to an arbitrary struct of which the first field is a
212 * pointer to an AVClass struct.
213 * @param level The importance level of the message expressed using a @ref
214 * lavu_log_constants "Logging Constant".
215 * @param fmt The format string (printf-compatible) that specifies how
216 * subsequent arguments are converted to output.
218 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
222 * Send the specified message to the log if the level is less than or equal
223 * to the current av_log_level. By default, all logging messages are sent to
224 * stderr. This behavior can be altered by setting a different logging callback
226 * @see av_log_set_callback
228 * @param avcl A pointer to an arbitrary struct of which the first field is a
229 * pointer to an AVClass struct.
230 * @param level The importance level of the message expressed using a @ref
231 * lavu_log_constants "Logging Constant".
232 * @param fmt The format string (printf-compatible) that specifies how
233 * subsequent arguments are converted to output.
234 * @param vl The arguments referenced by the format string.
236 void av_vlog(void *avcl, int level, const char *fmt, va_list vl);
239 * Get the current log level
241 * @see lavu_log_constants
243 * @return Current log level
245 int av_log_get_level(void);
250 * @see lavu_log_constants
252 * @param level Logging level
254 void av_log_set_level(int level);
257 * Set the logging callback
259 * @note The callback must be thread safe, even if the application does not use
260 * threads itself as some codecs are multithreaded.
262 * @see av_log_default_callback
264 * @param callback A logging function with a compatible signature.
266 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list));
269 * Default logging callback
271 * It prints the message to stderr, optionally colorizing it.
273 * @param avcl A pointer to an arbitrary struct of which the first field is a
274 * pointer to an AVClass struct.
275 * @param level The importance level of the message expressed using a @ref
276 * lavu_log_constants "Logging Constant".
277 * @param fmt The format string (printf-compatible) that specifies how
278 * subsequent arguments are converted to output.
279 * @param vl The arguments referenced by the format string.
281 void av_log_default_callback(void *avcl, int level, const char *fmt,
285 * Return the context name
287 * @param ctx The AVClass context
289 * @return The AVClass class_name
291 const char* av_default_item_name(void* ctx);
292 AVClassCategory av_default_get_category(void *ptr);
295 * Format a line of log the same way as the default callback.
296 * @param line buffer to receive the formated line
297 * @param line_size size of the buffer
298 * @param print_prefix used to store whether the prefix must be printed;
299 * must point to a persistent integer initially set to 1
301 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
302 char *line, int line_size, int *print_prefix);
306 * Useful to print debug messages that shouldn't get compiled in normally.
310 # define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
312 # define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
316 * Skip repeated messages, this requires the user app to use av_log() instead of
317 * (f)printf as the 2 would otherwise interfere and lead to
318 * "Last message repeated x times" messages below (f)printf messages with some
320 * Also to receive the last, "last repeated" line if any, the user app must
321 * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end
323 #define AV_LOG_SKIP_REPEATED 1
326 * Include the log severity in messages originating from codecs.
328 * Results in messages such as:
329 * [rawvideo @ 0xDEADBEEF] [error] encode did not produce valid pts
331 #define AV_LOG_PRINT_LEVEL 2
333 void av_log_set_flags(int arg);
334 int av_log_get_flags(void);
340 #endif /* AVUTIL_LOG_H */