log: add AV_CLASS_CATEGORY_NB
[ffmpeg.git] / libavutil / log.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
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 typedef enum {
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_NB, ///< not part of ABI/API
39 }AVClassCategory;
40
41 /**
42  * Describe the class of an AVClass context structure. That is an
43  * arbitrary struct of which the first field is a pointer to an
44  * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
45  */
46 typedef struct AVClass {
47     /**
48      * The name of the class; usually it is the same name as the
49      * context structure type to which the AVClass is associated.
50      */
51     const char* class_name;
52
53     /**
54      * A pointer to a function which returns the name of a context
55      * instance ctx associated with the class.
56      */
57     const char* (*item_name)(void* ctx);
58
59     /**
60      * a pointer to the first option specified in the class if any or NULL
61      *
62      * @see av_set_default_options()
63      */
64     const struct AVOption *option;
65
66     /**
67      * LIBAVUTIL_VERSION with which this structure was created.
68      * This is used to allow fields to be added without requiring major
69      * version bumps everywhere.
70      */
71
72     int version;
73
74     /**
75      * Offset in the structure where log_level_offset is stored.
76      * 0 means there is no such variable
77      */
78     int log_level_offset_offset;
79
80     /**
81      * Offset in the structure where a pointer to the parent context for loging is stored.
82      * for example a decoder that uses eval.c could pass its AVCodecContext to eval as such
83      * parent context. And a av_log() implementation could then display the parent context
84      * can be NULL of course
85      */
86     int parent_log_context_offset;
87
88     /**
89      * Return next AVOptions-enabled child or NULL
90      */
91     void* (*child_next)(void *obj, void *prev);
92
93     /**
94      * Return an AVClass corresponding to next potential
95      * AVOptions-enabled child.
96      *
97      * The difference between child_next and this is that
98      * child_next iterates over _already existing_ objects, while
99      * child_class_next iterates over _all possible_ children.
100      */
101     const struct AVClass* (*child_class_next)(const struct AVClass *prev);
102
103     /**
104      * Category used for visualization (like color)
105      * available since version (51 << 16 | 56 << 8 | 100)
106      */
107     AVClassCategory category;
108 } AVClass;
109
110 /* av_log API */
111
112 #define AV_LOG_QUIET    -8
113
114 /**
115  * Something went really wrong and we will crash now.
116  */
117 #define AV_LOG_PANIC     0
118
119 /**
120  * Something went wrong and recovery is not possible.
121  * For example, no header was found for a format which depends
122  * on headers or an illegal combination of parameters is used.
123  */
124 #define AV_LOG_FATAL     8
125
126 /**
127  * Something went wrong and cannot losslessly be recovered.
128  * However, not all future data is affected.
129  */
130 #define AV_LOG_ERROR    16
131
132 /**
133  * Something somehow does not look correct. This may or may not
134  * lead to problems. An example would be the use of '-vstrict -2'.
135  */
136 #define AV_LOG_WARNING  24
137
138 #define AV_LOG_INFO     32
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 #define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET)
147
148 /**
149  * Send the specified message to the log if the level is less than or equal
150  * to the current av_log_level. By default, all logging messages are sent to
151  * stderr. This behavior can be altered by setting a different av_vlog callback
152  * function.
153  *
154  * @param avcl A pointer to an arbitrary struct of which the first field is a
155  * pointer to an AVClass struct.
156  * @param level The importance level of the message, lower values signifying
157  * higher importance.
158  * @param fmt The format string (printf-compatible) that specifies how
159  * subsequent arguments are converted to output.
160  * @see av_vlog
161  */
162 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
163
164 void av_vlog(void *avcl, int level, const char *fmt, va_list);
165 int av_log_get_level(void);
166 void av_log_set_level(int);
167 void av_log_set_callback(void (*)(void*, int, const char*, va_list));
168 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
169 const char* av_default_item_name(void* ctx);
170
171 /**
172  * Format a line of log the same way as the default callback.
173  * @param line          buffer to receive the formated line
174  * @param line_size     size of the buffer
175  * @param print_prefix  used to store whether the prefix must be printed;
176  *                      must point to a persistent integer initially set to 1
177  */
178 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
179                         char *line, int line_size, int *print_prefix);
180
181 /**
182  * av_dlog macros
183  * Useful to print debug messages that shouldn't get compiled in normally.
184  */
185
186 #ifdef DEBUG
187 #    define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
188 #else
189 #    define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
190 #endif
191
192 /**
193  * Skip repeated messages, this requires the user app to use av_log() instead of
194  * (f)printf as the 2 would otherwise interfere and lead to
195  * "Last message repeated x times" messages below (f)printf messages with some
196  * bad luck.
197  * Also to receive the last, "last repeated" line if any, the user app must
198  * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end
199  */
200 #define AV_LOG_SKIP_REPEATED 1
201 void av_log_set_flags(int arg);
202
203 #endif /* AVUTIL_LOG_H */