log: Document AV_LOG_C usage
[ffmpeg.git] / libavutil / log.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of Libav.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #ifndef AVUTIL_LOG_H
22 #define AVUTIL_LOG_H
23
24 #include <stdarg.h>
25 #include "avutil.h"
26 #include "attributes.h"
27
28 /**
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.).
32  */
33 typedef struct AVClass {
34     /**
35      * The name of the class; usually it is the same name as the
36      * context structure type to which the AVClass is associated.
37      */
38     const char* class_name;
39
40     /**
41      * A pointer to a function which returns the name of a context
42      * instance ctx associated with the class.
43      */
44     const char* (*item_name)(void* ctx);
45
46     /**
47      * a pointer to the first option specified in the class if any or NULL
48      *
49      * @see av_set_default_options()
50      */
51     const struct AVOption *option;
52
53     /**
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.
57      */
58
59     int version;
60
61     /**
62      * Offset in the structure where log_level_offset is stored.
63      * 0 means there is no such variable
64      */
65     int log_level_offset_offset;
66
67     /**
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.
73      */
74     int parent_log_context_offset;
75
76     /**
77      * Return next AVOptions-enabled child or NULL
78      */
79     void* (*child_next)(void *obj, void *prev);
80
81     /**
82      * Return an AVClass corresponding to the next potential
83      * AVOptions-enabled child.
84      *
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.
88      */
89     const struct AVClass* (*child_class_next)(const struct AVClass *prev);
90 } AVClass;
91
92 /**
93  * @addtogroup lavu_log
94  *
95  * @{
96  *
97  * @defgroup lavu_log_constants Logging Constants
98  *
99  * @{
100  */
101
102 /**
103  * Print no output.
104  */
105 #define AV_LOG_QUIET    -8
106
107 /**
108  * Something went really wrong and we will crash now.
109  */
110 #define AV_LOG_PANIC     0
111
112 /**
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.
116  */
117 #define AV_LOG_FATAL     8
118
119 /**
120  * Something went wrong and cannot losslessly be recovered.
121  * However, not all future data is affected.
122  */
123 #define AV_LOG_ERROR    16
124
125 /**
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'.
128  */
129 #define AV_LOG_WARNING  24
130
131 /**
132  * Standard information.
133  */
134 #define AV_LOG_INFO     32
135
136 /**
137  * Detailed information.
138  */
139 #define AV_LOG_VERBOSE  40
140
141 /**
142  * Stuff which is only useful for libav* developers.
143  */
144 #define AV_LOG_DEBUG    48
145
146 /**
147  * @}
148  */
149
150 /**
151  * Sets additional colors for extended debugging sessions.
152  * @code
153    av_log(ctx, AV_LOG_DEBUG|AV_LOG_C(134), "Message in purple\n");
154    @endcode
155  * Requires 256color terminal support. Uses outside debugging is not
156  * recommended.
157  */
158 #define AV_LOG_C(x) (x << 8)
159
160 /**
161  * Send the specified message to the log if the level is less than or equal
162  * to the current av_log_level. By default, all logging messages are sent to
163  * stderr. This behavior can be altered by setting a different logging callback
164  * function.
165  * @see av_log_set_callback
166  *
167  * @param avcl A pointer to an arbitrary struct of which the first field is a
168  *        pointer to an AVClass struct.
169  * @param level The importance level of the message expressed using a @ref
170  *        lavu_log_constants "Logging Constant".
171  * @param fmt The format string (printf-compatible) that specifies how
172  *        subsequent arguments are converted to output.
173  */
174 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
175
176
177 /**
178  * Send the specified message to the log if the level is less than or equal
179  * to the current av_log_level. By default, all logging messages are sent to
180  * stderr. This behavior can be altered by setting a different logging callback
181  * function.
182  * @see av_log_set_callback
183  *
184  * @param avcl A pointer to an arbitrary struct of which the first field is a
185  *        pointer to an AVClass struct.
186  * @param level The importance level of the message expressed using a @ref
187  *        lavu_log_constants "Logging Constant".
188  * @param fmt The format string (printf-compatible) that specifies how
189  *        subsequent arguments are converted to output.
190  * @param vl The arguments referenced by the format string.
191  */
192 void av_vlog(void *avcl, int level, const char *fmt, va_list vl);
193
194 /**
195  * Get the current log level
196  *
197  * @see lavu_log_constants
198  *
199  * @return Current log level
200  */
201 int av_log_get_level(void);
202
203 /**
204  * Set the log level
205  *
206  * @see lavu_log_constants
207  *
208  * @param level Logging level
209  */
210 void av_log_set_level(int level);
211
212 /**
213  * Set the logging callback
214  *
215  * @see av_log_default_callback
216  *
217  * @param callback A logging function with a compatible signature.
218  */
219 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list));
220
221 /**
222  * Default logging callback
223  *
224  * It prints the message to stderr, optionally colorizing it.
225  *
226  * @param avcl A pointer to an arbitrary struct of which the first field is a
227  *        pointer to an AVClass struct.
228  * @param level The importance level of the message expressed using a @ref
229  *        lavu_log_constants "Logging Constant".
230  * @param fmt The format string (printf-compatible) that specifies how
231  *        subsequent arguments are converted to output.
232  * @param vl The arguments referenced by the format string.
233  */
234 void av_log_default_callback(void *avcl, int level, const char *fmt,
235                              va_list vl);
236
237 /**
238  * Return the context name
239  *
240  * @param  ctx The AVClass context
241  *
242  * @return The AVClass class_name
243  */
244 const char* av_default_item_name(void* ctx);
245
246 /**
247  * av_dlog macros
248  * Useful to print debug messages that shouldn't get compiled in normally.
249  */
250
251 #ifdef DEBUG
252 #    define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
253 #else
254 #    define av_dlog(pctx, ...)
255 #endif
256
257 /**
258  * Skip repeated messages, this requires the user app to use av_log() instead of
259  * (f)printf as the 2 would otherwise interfere and lead to
260  * "Last message repeated x times" messages below (f)printf messages with some
261  * bad luck.
262  * Also to receive the last, "last repeated" line if any, the user app must
263  * call av_log(NULL, AV_LOG_QUIET, ""); at the end
264  */
265 #define AV_LOG_SKIP_REPEATED 1
266 void av_log_set_flags(int arg);
267
268 /**
269  * @}
270  */
271
272 #endif /* AVUTIL_LOG_H */