1 /* 2 * copyright (c) 2006 Michael Niedermayer <michaelni (at) 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 #include "attributes.h" 27 28 typedef enum { 29 AV_CLASS_CATEGORY_NA = 0, 30 AV_CLASS_CATEGORY_INPUT, 31 AV_CLASS_CATEGORY_OUTPUT, 32 AV_CLASS_CATEGORY_MUXER, 33 AV_CLASS_CATEGORY_DEMUXER, 34 AV_CLASS_CATEGORY_ENCODER, 35 AV_CLASS_CATEGORY_DECODER, 36 AV_CLASS_CATEGORY_FILTER, 37 AV_CLASS_CATEGORY_BITSTREAM_FILTER, 38 AV_CLASS_CATEGORY_SWSCALER, 39 AV_CLASS_CATEGORY_SWRESAMPLER, 40 AV_CLASS_CATEGORY_NB, ///< not part of ABI/API 41 }AVClassCategory; 42 43 struct AVOptionRanges; 44 45 /** 46 * Describe the class of an AVClass context structure. That is an 47 * arbitrary struct of which the first field is a pointer to an 48 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.). 49 */ 50 typedef struct AVClass { 51 /** 52 * The name of the class; usually it is the same name as the 53 * context structure type to which the AVClass is associated. 54 */ 55 const char* class_name; 56 57 /** 58 * A pointer to a function which returns the name of a context 59 * instance ctx associated with the class. 60 */ 61 const char* (*item_name)(void* ctx); 62 63 /** 64 * a pointer to the first option specified in the class if any or NULL 65 * 66 * @see av_set_default_options() 67 */ 68 const struct AVOption *option; 69 70 /** 71 * LIBAVUTIL_VERSION with which this structure was created. 72 * This is used to allow fields to be added without requiring major 73 * version bumps everywhere. 74 */ 75 76 int version; 77 78 /** 79 * Offset in the structure where log_level_offset is stored. 80 * 0 means there is no such variable 81 */ 82 int log_level_offset_offset; 83 84 /** 85 * Offset in the structure where a pointer to the parent context for 86 * logging is stored. For example a decoder could pass its AVCodecContext 87 * to eval as such a parent context, which an av_log() implementation 88 * could then leverage to display the parent context. 89 * The offset can be NULL. 90 */ 91 int parent_log_context_offset; 92 93 /** 94 * Return next AVOptions-enabled child or NULL 95 */ 96 void* (*child_next)(void *obj, void *prev); 97 98 /** 99 * Return an AVClass corresponding to the next potential 100 * AVOptions-enabled child. 101 * 102 * The difference between child_next and this is that 103 * child_next iterates over _already existing_ objects, while 104 * child_class_next iterates over _all possible_ children. 105 */ 106 const struct AVClass* (*child_class_next)(const struct AVClass *prev); 107 108 /** 109 * Category used for visualization (like color) 110 * This is only set if the category is equal for all objects using this class. 111 * available since version (51 << 16 | 56 << 8 | 100) 112 */ 113 AVClassCategory category; 114 115 /** 116 * Callback to return the category. 117 * available since version (51 << 16 | 59 << 8 | 100) 118 */ 119 AVClassCategory (*get_category)(void* ctx); 120 121 /** 122 * Callback to return the supported/allowed ranges. 123 * available since version (52.12) 124 */ 125 int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags); 126 } AVClass; 127 128 /* av_log API */ 129 130 #define AV_LOG_QUIET -8 131 132 /** 133 * Something went really wrong and we will crash now. 134 */ 135 #define AV_LOG_PANIC 0 136 137 /** 138 * Something went wrong and recovery is not possible. 139 * For example, no header was found for a format which depends 140 * on headers or an illegal combination of parameters is used. 141 */ 142 #define AV_LOG_FATAL 8 143 144 /** 145 * Something went wrong and cannot losslessly be recovered. 146 * However, not all future data is affected. 147 */ 148 #define AV_LOG_ERROR 16 149 150 /** 151 * Something somehow does not look correct. This may or may not 152 * lead to problems. An example would be the use of '-vstrict -2'. 153 */ 154 #define AV_LOG_WARNING 24 155 156 #define AV_LOG_INFO 32 157 #define AV_LOG_VERBOSE 40 158 159 /** 160 * Stuff which is only useful for libav* developers. 161 */ 162 #define AV_LOG_DEBUG 48 163 164 #define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET) 165 166 /** 167 * Send the specified message to the log if the level is less than or equal 168 * to the current av_log_level. By default, all logging messages are sent to 169 * stderr. This behavior can be altered by setting a different av_vlog callback 170 * function. 171 * 172 * @param avcl A pointer to an arbitrary struct of which the first field is a 173 * pointer to an AVClass struct. 174 * @param level The importance level of the message, lower values signifying 175 * higher importance. 176 * @param fmt The format string (printf-compatible) that specifies how 177 * subsequent arguments are converted to output. 178 * @see av_vlog 179 */ 180 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4); 181 182 void av_vlog(void *avcl, int level, const char *fmt, va_list); 183 int av_log_get_level(void); 184 void av_log_set_level(int); 185 void av_log_set_callback(void (*)(void*, int, const char*, va_list)); 186 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl); 187 const char* av_default_item_name(void* ctx); 188 AVClassCategory av_default_get_category(void *ptr); 189 190 /** 191 * Format a line of log the same way as the default callback. 192 * @param line buffer to receive the formated line 193 * @param line_size size of the buffer 194 * @param print_prefix used to store whether the prefix must be printed; 195 * must point to a persistent integer initially set to 1 196 */ 197 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl, 198 char *line, int line_size, int *print_prefix); 199 200 /** 201 * av_dlog macros 202 * Useful to print debug messages that shouldn't get compiled in normally. 203 */ 204 205 #ifdef DEBUG 206 # define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__) 207 #else 208 # define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0) 209 #endif 210 211 /** 212 * Skip repeated messages, this requires the user app to use av_log() instead of 213 * (f)printf as the 2 would otherwise interfere and lead to 214 * "Last message repeated x times" messages below (f)printf messages with some 215 * bad luck. 216 * Also to receive the last, "last repeated" line if any, the user app must 217 * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end 218 */ 219 #define AV_LOG_SKIP_REPEATED 1 220 void av_log_set_flags(int arg); 221 222 #endif /* AVUTIL_LOG_H */ 223
