2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include "attributes.h"
30 * Describe the class of an AVClass context structure. That is an
31 * arbitrary struct of which the first field is a pointer to an
32 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
34 typedef struct AVClass {
36 * The name of the class; usually it is the same name as the
37 * context structure type to which the AVClass is associated.
39 const char* class_name;
42 * A pointer to a function which returns the name of a context
43 * instance ctx associated with the class.
45 const char* (*item_name)(void* ctx);
48 * a pointer to the first option specified in the class if any or NULL
50 * @see av_set_default_options()
52 const struct AVOption *option;
55 * LIBAVUTIL_VERSION with which this structure was created.
56 * This is used to allow fields to be added without requiring major
57 * version bumps everywhere.
63 * Offset in the structure where log_level_offset is stored.
64 * 0 means there is no such variable
66 int log_level_offset_offset;
69 * Offset in the structure where a pointer to the parent context for
70 * logging is stored. For example a decoder could pass its AVCodecContext
71 * to eval as such a parent context, which an av_log() implementation
72 * could then leverage to display the parent context.
73 * The offset can be NULL.
75 int parent_log_context_offset;
78 * Return next AVOptions-enabled child or NULL
80 void* (*child_next)(void *obj, void *prev);
83 * Return an AVClass corresponding to the next potential
84 * AVOptions-enabled child.
86 * The difference between child_next and this is that
87 * child_next iterates over _already existing_ objects, while
88 * child_class_next iterates over _all possible_ children.
90 const struct AVClass* (*child_class_next)(const struct AVClass *prev);
94 * @addtogroup lavu_log
98 * @defgroup lavu_log_constants Logging Constants
106 #define AV_LOG_QUIET -8
109 * Something went really wrong and we will crash now.
111 #define AV_LOG_PANIC 0
114 * Something went wrong and recovery is not possible.
115 * For example, no header was found for a format which depends
116 * on headers or an illegal combination of parameters is used.
118 #define AV_LOG_FATAL 8
121 * Something went wrong and cannot losslessly be recovered.
122 * However, not all future data is affected.
124 #define AV_LOG_ERROR 16
127 * Something somehow does not look correct. This may or may not
128 * lead to problems. An example would be the use of '-vstrict -2'.
130 #define AV_LOG_WARNING 24
133 * Standard information.
135 #define AV_LOG_INFO 32
138 * Detailed information.
140 #define AV_LOG_VERBOSE 40
143 * Stuff which is only useful for libav* developers.
145 #define AV_LOG_DEBUG 48
148 * Extremely verbose debugging, useful for libav* development.
150 #define AV_LOG_TRACE 56
157 * Sets additional colors for extended debugging sessions.
159 av_log(ctx, AV_LOG_DEBUG|AV_LOG_C(134), "Message in purple\n");
161 * Requires 256color terminal support. Uses outside debugging is not
164 #define AV_LOG_C(x) (x << 8)
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 * stderr. This behavior can be altered by setting a different logging callback
171 * @see av_log_set_callback
173 * @param avcl A pointer to an arbitrary struct of which the first field is a
174 * pointer to an AVClass struct.
175 * @param level The importance level of the message expressed using a @ref
176 * lavu_log_constants "Logging Constant".
177 * @param fmt The format string (printf-compatible) that specifies how
178 * subsequent arguments are converted to output.
180 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
184 * Send the specified message to the log if the level is less than or equal
185 * to the current av_log_level. By default, all logging messages are sent to
186 * stderr. This behavior can be altered by setting a different logging callback
188 * @see av_log_set_callback
190 * @param avcl A pointer to an arbitrary struct of which the first field is a
191 * pointer to an AVClass struct.
192 * @param level The importance level of the message expressed using a @ref
193 * lavu_log_constants "Logging Constant".
194 * @param fmt The format string (printf-compatible) that specifies how
195 * subsequent arguments are converted to output.
196 * @param vl The arguments referenced by the format string.
198 void av_vlog(void *avcl, int level, const char *fmt, va_list vl);
201 * Get the current log level
203 * @see lavu_log_constants
205 * @return Current log level
207 int av_log_get_level(void);
212 * @see lavu_log_constants
214 * @param level Logging level
216 void av_log_set_level(int level);
219 * Set the logging callback
221 * @see av_log_default_callback
223 * @param callback A logging function with a compatible signature.
225 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list));
228 * Default logging callback
230 * It prints the message to stderr, optionally colorizing it.
232 * @param avcl A pointer to an arbitrary struct of which the first field is a
233 * pointer to an AVClass struct.
234 * @param level The importance level of the message expressed using a @ref
235 * lavu_log_constants "Logging Constant".
236 * @param fmt The format string (printf-compatible) that specifies how
237 * subsequent arguments are converted to output.
238 * @param vl The arguments referenced by the format string.
240 void av_log_default_callback(void *avcl, int level, const char *fmt,
244 * Return the context name
246 * @param ctx The AVClass context
248 * @return The AVClass class_name
250 const char* av_default_item_name(void* ctx);
253 * Skip repeated messages, this requires the user app to use av_log() instead of
254 * (f)printf as the 2 would otherwise interfere and lead to
255 * "Last message repeated x times" messages below (f)printf messages with some
257 * Also to receive the last, "last repeated" line if any, the user app must
258 * call av_log(NULL, AV_LOG_QUIET, ""); at the end
260 #define AV_LOG_SKIP_REPEATED 1
261 void av_log_set_flags(int arg);
267 #endif /* AVUTIL_LOG_H */