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