log.h 3.71 KB
Newer Older
1 2 3
/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

21 22
#ifndef FFMPEG_LOG_H
#define FFMPEG_LOG_H
23 24 25 26

#include <stdarg.h>

/**
27 28 29
 * Describes the class of an AVClass context structure, that is an
 * arbitrary struct of which the first field is a pointer to an
 * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.).
30 31 32
 */
typedef struct AVCLASS AVClass;
struct AVCLASS {
33
    /**
Diego Biurrun's avatar
Diego Biurrun committed
34 35
     * The name of the class; usually it is the same name of the
     * context structure type to which the AVClass is associated.
36
     */
37
    const char* class_name;
38 39 40 41 42 43 44 45 46 47 48 49

    /**
     * a pointer to a function which returns the name of a context
     * instance \p ctx associated with the class
     */
    const char* (*item_name)(void* ctx);

    /**
     * a pointer to the first option specified in the class if any or NULL
     *
     * @see av_set_default_options()
     */
Baptiste Coudurier's avatar
Baptiste Coudurier committed
50
    const struct AVOption *option;
51 52 53 54
};

/* av_log API */

55
#if LIBAVUTIL_VERSION_INT < (50<<16)
56
#define AV_LOG_QUIET -1
57
#define AV_LOG_FATAL 0
58
#define AV_LOG_ERROR 0
59
#define AV_LOG_WARNING 1
60
#define AV_LOG_INFO 1
61
#define AV_LOG_VERBOSE 1
62
#define AV_LOG_DEBUG 2
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
#else
#define AV_LOG_QUIET    -8

/**
 * something went really wrong and we will crash now
 */
#define AV_LOG_PANIC     0

/**
 * something went wrong and recovery is not possible
 * like no header in a format which depends on it or a combination
 * of parameters which are not allowed
 */
#define AV_LOG_FATAL     8

/**
 * something went wrong and cannot losslessly be recovered
 * but not all future data is affected
 */
#define AV_LOG_ERROR    16

/**
 * something somehow does not look correct / something which may or may not
 * lead to some problems like use of -vstrict -2
 */
#define AV_LOG_WARNING  24

#define AV_LOG_INFO     32
#define AV_LOG_VERBOSE  40

/**
 * stuff which is only useful for libav* developers
 */
#define AV_LOG_DEBUG    48
#endif
Måns Rullgård's avatar
Måns Rullgård committed
98 99

#if LIBAVUTIL_VERSION_INT < (50<<16)
100
extern int av_log_level;
Måns Rullgård's avatar
Måns Rullgård committed
101
#endif
102

103 104 105 106 107 108 109 110 111 112 113 114 115 116
/**
 * Send the specified message to the log if the level is less than or equal to
 * the current av_log_level. By default, all logging messages are sent to
 * stderr. This behavior can be altered by setting a different av_vlog callback
 * function.
 *
 * @param avcl A pointer to an arbitrary struct of which the first field is a
 * pointer to an AVClass struct.
 * @param level The importance level of the message, lower values signifying
 * higher importance.
 * @param fmt The format string (printf-compatible) that specifies how
 * subsequent arguments are converted to output.
 * @see av_vlog
 */
117
#ifdef __GNUC__
118
void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
119
#else
120
void av_log(void*, int level, const char *fmt, ...);
121 122
#endif

123 124 125 126 127
void av_vlog(void*, int level, const char *fmt, va_list);
int av_log_get_level(void);
void av_log_set_level(int);
void av_log_set_callback(void (*)(void*, int, const char*, va_list));
void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl);
128

129
#endif /* FFMPEG_LOG_H */