git.sesse.net Git - ffmpeg/blob - 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 #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 loging is stored.
  86      * for example a decoder that uses eval.c could pass its AVCodecContext to eval as such
  87      * parent context. And a av_log() implementation could then display the parent context
  88      * can be NULL of course
  89      */
  90     int parent_log_context_offset;
  91
  92     /**
  93      * Return next AVOptions-enabled child or NULL
  94      */
  95     void* (*child_next)(void *obj, void *prev);
  96
  97     /**
  98      * Return an AVClass corresponding to next potential
  99      * AVOptions-enabled child.
 100      *
 101      * The difference between child_next and this is that
 102      * child_next iterates over _already existing_ objects, while
 103      * child_class_next iterates over _all possible_ children.
 104      */
 105     const struct AVClass* (*child_class_next)(const struct AVClass *prev);
 106
 107     /**
 108      * Category used for visualization (like color)
 109      * This is only set if the category is equal for all objects using this class.
 110      * available since version (51 << 16 | 56 << 8 | 100)
 111      */
 112     AVClassCategory category;
 113
 114     /**
 115      * Callback to return the category.
 116      * available since version (51 << 16 | 59 << 8 | 100)
 117      */
 118     AVClassCategory (*get_category)(void* ctx);
 119
 120     /**
 121      * Callback to return the supported/allowed ranges.
 122      * available since version (52.12)
 123      */
 124     int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags);
 125 } AVClass;
 126
 127 /* av_log API */
 128
 129 #define AV_LOG_QUIET    -8
 130
 131 /**
 132  * Something went really wrong and we will crash now.
 133  */
 134 #define AV_LOG_PANIC     0
 135
 136 /**
 137  * Something went wrong and recovery is not possible.
 138  * For example, no header was found for a format which depends
 139  * on headers or an illegal combination of parameters is used.
 140  */
 141 #define AV_LOG_FATAL     8
 142
 143 /**
 144  * Something went wrong and cannot losslessly be recovered.
 145  * However, not all future data is affected.
 146  */
 147 #define AV_LOG_ERROR    16
 148
 149 /**
 150  * Something somehow does not look correct. This may or may not
 151  * lead to problems. An example would be the use of '-vstrict -2'.
 152  */
 153 #define AV_LOG_WARNING  24
 154
 155 #define AV_LOG_INFO     32
 156 #define AV_LOG_VERBOSE  40
 157
 158 /**
 159  * Stuff which is only useful for libav* developers.
 160  */
 161 #define AV_LOG_DEBUG    48
 162
 163 #define AV_LOG_MAX_OFFSET (AV_LOG_DEBUG - AV_LOG_QUIET)
 164
 165 /**
 166  * Send the specified message to the log if the level is less than or equal
 167  * to the current av_log_level. By default, all logging messages are sent to
 168  * stderr. This behavior can be altered by setting a different av_vlog callback
 169  * function.
 170  *
 171  * @param avcl A pointer to an arbitrary struct of which the first field is a
 172  * pointer to an AVClass struct.
 173  * @param level The importance level of the message, lower values signifying
 174  * higher importance.
 175  * @param fmt The format string (printf-compatible) that specifies how
 176  * subsequent arguments are converted to output.
 177  * @see av_vlog
 178  */
 179 void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4);
 180
 181 void av_vlog(void *avcl, int level, const char *fmt, va_list);
 182 int av_log_get_level(void);
 183 void av_log_set_level(int);
 184 void av_log_set_callback(void (*)(void*, int, const char*, va_list));
 185 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
 186 const char* av_default_item_name(void* ctx);
 187 AVClassCategory av_default_get_category(void *ptr);
 188
 189 /**
 190  * Format a line of log the same way as the default callback.
 191  * @param line          buffer to receive the formated line
 192  * @param line_size     size of the buffer
 193  * @param print_prefix  used to store whether the prefix must be printed;
 194  *                      must point to a persistent integer initially set to 1
 195  */
 196 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
 197                         char *line, int line_size, int *print_prefix);
 198
 199 /**
 200  * av_dlog macros
 201  * Useful to print debug messages that shouldn't get compiled in normally.
 202  */
 203
 204 #ifdef DEBUG
 205 #    define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
 206 #else
 207 #    define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
 208 #endif
 209
 210 /**
 211  * Skip repeated messages, this requires the user app to use av_log() instead of
 212  * (f)printf as the 2 would otherwise interfere and lead to
 213  * "Last message repeated x times" messages below (f)printf messages with some
 214  * bad luck.
 215  * Also to receive the last, "last repeated" line if any, the user app must
 216  * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end
 217  */
 218 #define AV_LOG_SKIP_REPEATED 1
 219 void av_log_set_flags(int arg);
 220
 221 #endif /* AVUTIL_LOG_H */