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