c1d9a6c39316b69030e5b2872c3346564353c149
[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 {
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 loging is stored.
69      * for example a decoder that uses eval.c could pass its AVCodecContext to eval as such
70      * parent context. And a av_log() implementation could then display the parent context
71      * can be NULL of course
72      */
73     int parent_log_context_offset;
74
75     /**
76      * A function for extended searching, e.g. in possible
77      * children objects.
78      */
79     const struct AVOption* (*opt_find)(void *obj, const char *name, const char *unit,
80                                        int opt_flags, int search_flags);
81 } AVClass;
82
83 /* av_log API */
84
85 #define AV_LOG_QUIET    -8
86
87 /**
88  * Something went really wrong and we will crash now.
89  */
90 #define AV_LOG_PANIC     0
91
92 /**
93  * Something went wrong and recovery is not possible.
94  * For example, no header was found for a format which depends
95  * on headers or an illegal combination of parameters is used.
96  */
97 #define AV_LOG_FATAL     8
98
99 /**
100  * Something went wrong and cannot losslessly be recovered.
101  * However, not all future data is affected.
102  */
103 #define AV_LOG_ERROR    16
104
105 /**
106  * Something somehow does not look correct. This may or may not
107  * lead to problems. An example would be the use of '-vstrict -2'.
108  */
109 #define AV_LOG_WARNING  24
110
111 #define AV_LOG_INFO     32
112 #define AV_LOG_VERBOSE  40
113
114 /**
115  * Stuff which is only useful for libav* developers.
116  */
117 #define AV_LOG_DEBUG    48
118
119 /**
120  * Send the specified message to the log if the level is less than or equal
121  * to the current av_log_level. By default, all logging messages are sent to
122  * stderr. This behavior can be altered by setting a different av_vlog callback
123  * function.
124  *
125  * @param avcl A pointer to an arbitrary struct of which the first field is a
126  * pointer to an AVClass struct.
127  * @param level The importance level of the message, lower values signifying
128  * higher importance.
129  * @param fmt The format string (printf-compatible) that specifies how
130  * subsequent arguments are converted to output.
131  * @see av_vlog
132  */
133 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
134
135 void av_vlog(void *avcl, int level, const char *fmt, va_list);
136 int av_log_get_level(void);
137 void av_log_set_level(int);
138 void av_log_set_callback(void (*)(void*, int, const char*, va_list));
139 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
140 const char* av_default_item_name(void* ctx);
141
142 /**
143  * av_dlog macros
144  * Useful to print debug messages that shouldn't get compiled in normally.
145  */
146
147 #ifdef DEBUG
148 #    define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
149 #else
150 #    define av_dlog(pctx, ...)
151 #endif
152
153 /**
154  * Skip repeated messages, this requires the user app to use av_log() instead of
155  * (f)printf as the 2 would otherwise interfere and lead to
156  * "Last message repeated x times" messages below (f)printf messages with some
157  * bad luck.
158  * Also to receive the last, "last repeated" line if any, the user app must
159  * call av_log(NULL, AV_LOG_QUIET, ""); at the end
160  */
161 #define AV_LOG_SKIP_REPEATED 1
162 void av_log_set_flags(int arg);
163
164 #endif /* AVUTIL_LOG_H */