log.h 3.49 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 AVUTIL_LOG_H
#define AVUTIL_LOG_H
23 24

#include <stdarg.h>
25
#include "avutil.h"
26 27

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

    /**
41
     * A pointer to a function which returns the name of a context
42
     * instance ctx associated with the class.
43 44 45 46 47 48 49 50
     */
    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
51
    const struct AVOption *option;
52 53 54 55
};

/* av_log API */

56 57 58
#define AV_LOG_QUIET    -8

/**
59
 * Something went really wrong and we will crash now.
60 61 62 63
 */
#define AV_LOG_PANIC     0

/**
64 65 66
 * Something went wrong and recovery is not possible.
 * For example, no header was found for a format which depends
 * on headers or an illegal combination of parameters is used.
67 68 69 70
 */
#define AV_LOG_FATAL     8

/**
71 72
 * Something went wrong and cannot losslessly be recovered.
 * However, not all future data is affected.
73 74 75 76
 */
#define AV_LOG_ERROR    16

/**
77 78
 * Something somehow does not look correct. This may or may not
 * lead to problems. An example would be the use of '-vstrict -2'.
79 80 81 82 83 84 85
 */
#define AV_LOG_WARNING  24

#define AV_LOG_INFO     32
#define AV_LOG_VERBOSE  40

/**
86
 * Stuff which is only useful for libav* developers.
87 88
 */
#define AV_LOG_DEBUG    48
89

90
/**
91 92
 * Sends 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
93 94 95 96 97 98 99 100 101 102 103
 * 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
 */
104
#ifdef __GNUC__
105
void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
106
#else
107
void av_log(void*, int level, const char *fmt, ...);
108 109
#endif

110 111 112 113 114
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);
115

116
#endif /* AVUTIL_LOG_H */