da6a560b3817bb8f8916034ade00641f4076b87e
[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 FFMPEG_LOG_H
22 #define FFMPEG_LOG_H
23
24 #include <stdarg.h>
25
26 /**
27  * Describes the class of an AVClass context structure, that is an
28  * arbitrary struct of which the first field is a pointer to an
29  * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
30  */
31 typedef struct AVCLASS AVClass;
32 struct AVCLASS {
33     /**
34      * the name of the class, usually it is the same name of 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 \p 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 /* av_log API */
54
55 #if LIBAVUTIL_VERSION_INT < (50<<16)
56 #define AV_LOG_QUIET -1
57 #define AV_LOG_FATAL 0
58 #define AV_LOG_ERROR 0
59 #define AV_LOG_WARNING 1
60 #define AV_LOG_INFO 1
61 #define AV_LOG_VERBOSE 1
62 #define AV_LOG_DEBUG 2
63 #else
64 #define AV_LOG_QUIET    -8
65
66 /**
67  * something went really wrong and we will crash now
68  */
69 #define AV_LOG_PANIC     0
70
71 /**
72  * something went wrong and recovery is not possible
73  * like no header in a format which depends on it or a combination
74  * of parameters which are not allowed
75  */
76 #define AV_LOG_FATAL     8
77
78 /**
79  * something went wrong and cannot losslessly be recovered
80  * but not all future data is affected
81  */
82 #define AV_LOG_ERROR    16
83
84 /**
85  * something somehow does not look correct / something which may or may not
86  * lead to some problems like use of -vstrict -2
87  */
88 #define AV_LOG_WARNING  24
89
90 #define AV_LOG_INFO     32
91 #define AV_LOG_VERBOSE  40
92
93 /**
94  * stuff which is only useful for libav* developers
95  */
96 #define AV_LOG_DEBUG    48
97 #endif
98
99 #if LIBAVUTIL_VERSION_INT < (50<<16)
100 extern int av_log_level;
101 #endif
102
103 /**
104  * Send the specified message to the log if the level is less than or equal to
105  * the current av_log_level. By default, all logging messages are sent to
106  * stderr. This behavior can be altered by setting a different av_vlog callback
107  * function.
108  *
109  * @param avcl A pointer to an arbitrary struct of which the first field is a
110  * pointer to an AVClass struct.
111  * @param level The importance level of the message, lower values signifying
112  * higher importance.
113  * @param fmt The format string (printf-compatible) that specifies how
114  * subsequent arguments are converted to output.
115  * @see av_vlog
116  */
117 #ifdef __GNUC__
118 void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
119 #else
120 void av_log(void*, int level, const char *fmt, ...);
121 #endif
122
123 void av_vlog(void*, int level, const char *fmt, va_list);
124 int av_log_get_level(void);
125 void av_log_set_level(int);
126 void av_log_set_callback(void (*)(void*, int, const char*, va_list));
127 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
128
129 #endif /* FFMPEG_LOG_H */