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