git.sesse.net Git - casparcg/blob - ffmpeg 0.7/include/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  * Describe 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 {
  33     /**
  34      * The name of the class; usually it is the same name as the
  35      * context structure type to which the AVClass is associated.
  36      */
  37     const char* class_name;
  38
  39     /**
  40      * A pointer to a function which returns the name of a context
  41      * instance ctx associated with the class.
  42      */
  43     const char* (*item_name)(void* ctx);
  44
  45     /**
  46      * a pointer to the first option specified in the class if any or NULL
  47      *
  48      * @see av_set_default_options()
  49      */
  50     const struct AVOption *option;
  51
  52     /**
  53      * LIBAVUTIL_VERSION with which this structure was created.
  54      * This is used to allow fields to be added without requiring major
  55      * version bumps everywhere.
  56      */
  57
  58     int version;
  59
  60     /**
  61      * Offset in the structure where log_level_offset is stored.
  62      * 0 means there is no such variable
  63      */
  64     int log_level_offset_offset;
  65
  66     /**
  67      * Offset in the structure where a pointer to the parent context for loging is stored.
  68      * for example a decoder that uses eval.c could pass its AVCodecContext to eval as such
  69      * parent context. And a av_log() implementation could then display the parent context
  70      * can be NULL of course
  71      */
  72     int parent_log_context_offset;
  73 } AVClass;
  74
  75 /* av_log API */
  76
  77 #define AV_LOG_QUIET    -8
  78
  79 /**
  80  * Something went really wrong and we will crash now.
  81  */
  82 #define AV_LOG_PANIC     0
  83
  84 /**
  85  * Something went wrong and recovery is not possible.
  86  * For example, no header was found for a format which depends
  87  * on headers or an illegal combination of parameters is used.
  88  */
  89 #define AV_LOG_FATAL     8
  90
  91 /**
  92  * Something went wrong and cannot losslessly be recovered.
  93  * However, not all future data is affected.
  94  */
  95 #define AV_LOG_ERROR    16
  96
  97 /**
  98  * Something somehow does not look correct. This may or may not
  99  * lead to problems. An example would be the use of '-vstrict -2'.
 100  */
 101 #define AV_LOG_WARNING  24
 102
 103 #define AV_LOG_INFO     32
 104 #define AV_LOG_VERBOSE  40
 105
 106 /**
 107  * Stuff which is only useful for libav* developers.
 108  */
 109 #define AV_LOG_DEBUG    48
 110
 111 /**
 112  * Send the specified message to the log if the level is less than or equal
 113  * to the current av_log_level. By default, all logging messages are sent to
 114  * stderr. This behavior can be altered by setting a different av_vlog callback
 115  * function.
 116  *
 117  * @param avcl A pointer to an arbitrary struct of which the first field is a
 118  * pointer to an AVClass struct.
 119  * @param level The importance level of the message, lower values signifying
 120  * higher importance.
 121  * @param fmt The format string (printf-compatible) that specifies how
 122  * subsequent arguments are converted to output.
 123  * @see av_vlog
 124  */
 125 #ifdef __GNUC__
 126 void av_log(void *avcl, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
 127 #else
 128 void av_log(void *avcl, int level, const char *fmt, ...);
 129 #endif
 130
 131 void av_vlog(void *avcl, int level, const char *fmt, va_list);
 132 int av_log_get_level(void);
 133 void av_log_set_level(int);
 134 void av_log_set_callback(void (*)(void*, int, const char*, va_list));
 135 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
 136 const char* av_default_item_name(void* ctx);
 137
 138 /**
 139  * av_dlog macros
 140  * Useful to print debug messages that shouldn't get compiled in normally.
 141  */
 142
 143 #ifdef DEBUG
 144 #    define av_dlog(pctx, ...) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__)
 145 #else
 146 #    define av_dlog(pctx, ...) do { if (0) av_log(pctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
 147 #endif
 148
 149 /**
 150  * Skip repeated messages, this requires the user app to use av_log() instead of
 151  * (f)printf as the 2 would otherwise interfere and lead to
 152  * "Last message repeated x times" messages below (f)printf messages with some
 153  * bad luck.
 154  * Also to receive the last, "last repeated" line if any, the user app must
 155  * call av_log(NULL, AV_LOG_QUIET, ""); at the end
 156  */
 157 #define AV_LOG_SKIP_REPEATED 1
 158 void av_log_set_flags(int arg);
 159
 160 #endif /* AVUTIL_LOG_H */