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