AVOptions: add av_opt_find() as a replacement for av_find_opt.
[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
27 /**
28  * Describe the class of an AVClass context structure. That is an
29  * arbitrary struct of which the first field is a pointer to an
30  * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
31  */
32 typedef struct {
33     /**
34      * The name of the class; usually it is the same name as the
35      * context structure type to which the AVClass is associated.
36      */
37     const char* class_name;
38
39     /**
40      * A pointer to a function which returns the name of a context
41      * instance ctx associated with the class.
42      */
43     const char* (*item_name)(void* ctx);
44
45     /**
46      * a pointer to the first option specified in the class if any or NULL
47      *
48      * @see av_set_default_options()
49      */
50     const struct AVOption *option;
51
52     /**
53      * LIBAVUTIL_VERSION with which this structure was created.
54      * This is used to allow fields to be added without requiring major
55      * version bumps everywhere.
56      */
57
58     int version;
59
60     /**
61      * Offset in the structure where log_level_offset is stored.
62      * 0 means there is no such variable
63      */
64     int log_level_offset_offset;
65
66     /**
67      * Offset in the structure where a pointer to the parent context for loging is stored.
68      * for example a decoder that uses eval.c could pass its AVCodecContext to eval as such
69      * parent context. And a av_log() implementation could then display the parent context
70      * can be NULL of course
71      */
72     int parent_log_context_offset;
73
74     /**
75      * A function for extended searching, e.g. in possible
76      * children objects.
77      */
78     const struct AVOption* (*opt_find)(void *obj, const char *name, const char *unit,
79                                        int opt_flags, int search_flags);
80 } AVClass;
81
82 /* av_log API */
83
84 #define AV_LOG_QUIET    -8
85
86 /**
87  * Something went really wrong and we will crash now.
88  */
89 #define AV_LOG_PANIC     0
90
91 /**
92  * Something went wrong and recovery is not possible.
93  * For example, no header was found for a format which depends
94  * on headers or an illegal combination of parameters is used.
95  */
96 #define AV_LOG_FATAL     8
97
98 /**
99  * Something went wrong and cannot losslessly be recovered.
100  * However, not all future data is affected.
101  */
102 #define AV_LOG_ERROR    16
103
104 /**
105  * Something somehow does not look correct. This may or may not
106  * lead to problems. An example would be the use of '-vstrict -2'.
107  */
108 #define AV_LOG_WARNING  24
109
110 #define AV_LOG_INFO     32
111 #define AV_LOG_VERBOSE  40
112
113 /**
114  * Stuff which is only useful for libav* developers.
115  */
116 #define AV_LOG_DEBUG    48
117
118 /**
119  * Send the specified message to the log if the level is less than or equal
120  * to the current av_log_level. By default, all logging messages are sent to
121  * stderr. This behavior can be altered by setting a different av_vlog callback
122  * function.
123  *
124  * @param avcl A pointer to an arbitrary struct of which the first field is a
125  * pointer to an AVClass struct.
126  * @param level The importance level of the message, lower values signifying
127  * higher importance.
128  * @param fmt The format string (printf-compatible) that specifies how
129  * subsequent arguments are converted to output.
130  * @see av_vlog
131  */
132 #ifdef __GNUC__
133 void av_log(void *avcl, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
134 #else
135 void av_log(void *avcl, int level, const char *fmt, ...);
136 #endif
137
138 void av_vlog(void *avcl, int level, const char *fmt, va_list);
139 int av_log_get_level(void);
140 void av_log_set_level(int);
141 void av_log_set_callback(void (*)(void*, int, const char*, va_list));
142 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
143 const char* av_default_item_name(void* ctx);
144
145 /**
146  * av_dlog macros
147  * Useful to print debug messages that shouldn't get compiled in normally.
148  */
149
150 #ifdef DEBUG
151 #    define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
152 #else
153 #    define av_dlog(pctx, ...)
154 #endif
155
156 /**
157  * Skip repeated messages, this requires the user app to use av_log() instead of
158  * (f)printf as the 2 would otherwise interfere and lead to
159  * "Last message repeated x times" messages below (f)printf messages with some
160  * bad luck.
161  * Also to receive the last, "last repeated" line if any, the user app must
162  * call av_log(NULL, AV_LOG_QUIET, ""); at the end
163  */
164 #define AV_LOG_SKIP_REPEATED 1
165 void av_log_set_flags(int arg);
166
167 #endif /* AVUTIL_LOG_H */