Adds Doxygen docs for the av_log function.
[ffmpeg.git] / libavutil / log.c
1 /*
2  * log functions
3  * Copyright (c) 2003 Michel Bardiaux
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file log.c
24  * log.
25  */
26
27 #include "avutil.h"
28
29 int av_log_level = AV_LOG_INFO;
30
31 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
32 {
33     static int print_prefix=1;
34     AVClass* avc= ptr ? *(AVClass**)ptr : NULL;
35     if(level>av_log_level)
36         return;
37 #undef fprintf
38     if(print_prefix && avc) {
39             fprintf(stderr, "[%s @ %p]", avc->item_name(ptr), avc);
40     }
41 #define fprintf please_use_av_log
42
43     print_prefix= strstr(fmt, "\n") != NULL;
44
45     vfprintf(stderr, fmt, vl);
46 }
47
48 #if LIBAVUTIL_VERSION_INT < (50<<16)
49 static void (*av_log_callback)(void*, int, const char*, va_list) = av_log_default_callback;
50 #else
51 void (*av_vlog)(void*, int, const char*, va_list) = av_log_default_callback;
52 #endif
53
54 /**
55  * Send the specified message to the log if the level is less than or equal to
56  * the current av_log_level. By default, all logging messages are sent to
57  * stderr. This behavior can be altered by setting a different av_vlog callback
58  * function.
59  *
60  * @param avcl A pointer to an arbitrary struct of which the first field is a
61  * pointer to an AVClass struct.
62  * @param level The importance level of the message, lower values signifying
63  * higher importance.
64  * @param fmt The format string (printf-compatible) that specifies how
65  * subsequent arguments are converted to output.
66  * @see av_vlog
67  */
68 void av_log(void* avcl, int level, const char *fmt, ...)
69 {
70     va_list vl;
71     va_start(vl, fmt);
72     av_vlog(avcl, level, fmt, vl);
73     va_end(vl);
74 }
75
76 #if LIBAVUTIL_VERSION_INT < (50<<16)
77 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
78 {
79     av_log_callback(avcl, level, fmt, vl);
80 }
81
82 int av_log_get_level(void)
83 {
84     return av_log_level;
85 }
86
87 void av_log_set_level(int level)
88 {
89     av_log_level = level;
90 }
91
92 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
93 {
94     av_log_callback = callback;
95 }
96 #endif