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"
29 * Describe the class of an AVClass context structure. That is an
30 * arbitrary struct of which the first field is a pointer to an
31 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
33 typedef struct AVClass {
35 * The name of the class; usually it is the same name as the
36 * context structure type to which the AVClass is associated.
38 const char* class_name;
41 * A pointer to a function which returns the name of a context
42 * instance ctx associated with the class.
44 const char* (*item_name)(void* ctx);
47 * a pointer to the first option specified in the class if any or NULL
49 * @see av_set_default_options()
51 const struct AVOption *option;
54 * LIBAVUTIL_VERSION with which this structure was created.
55 * This is used to allow fields to be added without requiring major
56 * version bumps everywhere.
62 * Offset in the structure where log_level_offset is stored.
63 * 0 means there is no such variable
65 int log_level_offset_offset;
68 * Offset in the structure where a pointer to the parent context for
69 * logging is stored. For example a decoder could pass its AVCodecContext
70 * to eval as such a parent context, which an av_log() implementation
71 * could then leverage to display the parent context.
72 * The offset can be NULL.
74 int parent_log_context_offset;
77 * Return next AVOptions-enabled child or NULL
79 void* (*child_next)(void *obj, void *prev);
82 * Return an AVClass corresponding to the next potential
83 * AVOptions-enabled child.
85 * The difference between child_next and this is that
86 * child_next iterates over _already existing_ objects, while
87 * child_class_next iterates over _all possible_ children.
89 const struct AVClass* (*child_class_next)(const struct AVClass *prev);
93 * @addtogroup lavu_log
97 * @defgroup lavu_log_constants Logging Constants
105 #define AV_LOG_QUIET -8
108 * Something went really wrong and we will crash now.
110 #define AV_LOG_PANIC 0
113 * Something went wrong and recovery is not possible.
114 * For example, no header was found for a format which depends
115 * on headers or an illegal combination of parameters is used.
117 #define AV_LOG_FATAL 8
120 * Something went wrong and cannot losslessly be recovered.
121 * However, not all future data is affected.
123 #define AV_LOG_ERROR 16
126 * Something somehow does not look correct. This may or may not
127 * lead to problems. An example would be the use of '-vstrict -2'.
129 #define AV_LOG_WARNING 24
132 * Standard information.
134 #define AV_LOG_INFO 32
137 * Detailed information.
139 #define AV_LOG_VERBOSE 40
142 * Stuff which is only useful for libav* developers.
144 #define AV_LOG_DEBUG 48
151 * Send the specified message to the log if the level is less than or equal
152 * to the current av_log_level. By default, all logging messages are sent to
153 * stderr. This behavior can be altered by setting a different logging callback
155 * @see av_log_set_callback
157 * @param avcl A pointer to an arbitrary struct of which the first field is a
158 * pointer to an AVClass struct.
159 * @param level The importance level of the message expressed using a @ref
160 * lavu_log_constants "Logging Constant".
161 * @param fmt The format string (printf-compatible) that specifies how
162 * subsequent arguments are converted to output.
164 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
168 * Send the specified message to the log if the level is less than or equal
169 * to the current av_log_level. By default, all logging messages are sent to
170 * stderr. This behavior can be altered by setting a different logging callback
172 * @see av_log_set_callback
174 * @param avcl A pointer to an arbitrary struct of which the first field is a
175 * pointer to an AVClass struct.
176 * @param level The importance level of the message expressed using a @ref
177 * lavu_log_constants "Logging Constant".
178 * @param fmt The format string (printf-compatible) that specifies how
179 * subsequent arguments are converted to output.
180 * @param vl The arguments referenced by the format string.
182 void av_vlog(void *avcl, int level, const char *fmt, va_list vl);
185 * Get the current log level
187 * @see lavu_log_constants
189 * @return Current log level
191 int av_log_get_level(void);
196 * @see lavu_log_constants
198 * @param level Logging level
200 void av_log_set_level(int level);
203 * Set the logging callback
205 * @see av_log_default_callback
207 * @param callback A logging function with a compatible signature.
209 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list));
212 * Default logging callback
214 * It prints the message to stderr, optionally colorizing it.
216 * @param avcl A pointer to an arbitrary struct of which the first field is a
217 * pointer to an AVClass struct.
218 * @param level The importance level of the message expressed using a @ref
219 * lavu_log_constants "Logging Constant".
220 * @param fmt The format string (printf-compatible) that specifies how
221 * subsequent arguments are converted to output.
222 * @param ap The arguments referenced by the format string.
224 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
227 * Return the context name
229 * @param ctx The AVClass context
231 * @return The AVClass class_name
233 const char* av_default_item_name(void* ctx);
237 * Useful to print debug messages that shouldn't get compiled in normally.
241 # define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
243 # define av_dlog(pctx, ...)
247 * Skip repeated messages, this requires the user app to use av_log() instead of
248 * (f)printf as the 2 would otherwise interfere and lead to
249 * "Last message repeated x times" messages below (f)printf messages with some
251 * Also to receive the last, "last repeated" line if any, the user app must
252 * call av_log(NULL, AV_LOG_QUIET, ""); at the end
254 #define AV_LOG_SKIP_REPEATED 1
255 void av_log_set_flags(int arg);
261 #endif /* AVUTIL_LOG_H */