Fix typo.
[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
27 /**
28  * Describes 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 } AVClass;
60
61 /* av_log API */
62
63 #define AV_LOG_QUIET    -8
64
65 /**
66  * Something went really wrong and we will crash now.
67  */
68 #define AV_LOG_PANIC     0
69
70 /**
71  * Something went wrong and recovery is not possible.
72  * For example, no header was found for a format which depends
73  * on headers or an illegal combination of parameters is used.
74  */
75 #define AV_LOG_FATAL     8
76
77 /**
78  * Something went wrong and cannot losslessly be recovered.
79  * However, not all future data is affected.
80  */
81 #define AV_LOG_ERROR    16
82
83 /**
84  * Something somehow does not look correct. This may or may not
85  * lead to problems. An example would be the use of '-vstrict -2'.
86  */
87 #define AV_LOG_WARNING  24
88
89 #define AV_LOG_INFO     32
90 #define AV_LOG_VERBOSE  40
91
92 /**
93  * Stuff which is only useful for libav* developers.
94  */
95 #define AV_LOG_DEBUG    48
96
97 /**
98  * Sends the specified message to the log if the level is less than or equal
99  * to the current av_log_level. By default, all logging messages are sent to
100  * stderr. This behavior can be altered by setting a different av_vlog callback
101  * function.
102  *
103  * @param avcl A pointer to an arbitrary struct of which the first field is a
104  * pointer to an AVClass struct.
105  * @param level The importance level of the message, lower values signifying
106  * higher importance.
107  * @param fmt The format string (printf-compatible) that specifies how
108  * subsequent arguments are converted to output.
109  * @see av_vlog
110  */
111 #ifdef __GNUC__
112 void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
113 #else
114 void av_log(void*, int level, const char *fmt, ...);
115 #endif
116
117 void av_vlog(void*, int level, const char *fmt, va_list);
118 int av_log_get_level(void);
119 void av_log_set_level(int);
120 void av_log_set_callback(void (*)(void*, int, const char*, va_list));
121 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
122
123 #endif /* AVUTIL_LOG_H */