log: Document AV_LOG_C usage
[ffmpeg.git] / libavutil / log.c
1 /*
2  * log functions
3  * Copyright (c) 2003 Michel Bardiaux
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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
24  * logging functions
25  */
26
27 #include "config.h"
28
29 #if HAVE_UNISTD_H
30 #include <unistd.h>
31 #endif
32 #if HAVE_IO_H
33 #include <io.h>
34 #endif
35 #include <stdarg.h>
36 #include <stdlib.h>
37 #include "avstring.h"
38 #include "avutil.h"
39 #include "common.h"
40 #include "internal.h"
41 #include "log.h"
42
43 static int av_log_level = AV_LOG_INFO;
44 static int flags;
45
46 #if HAVE_SETCONSOLETEXTATTRIBUTE
47 #include <windows.h>
48 static const uint8_t color[] = { 12, 12, 12, 14, 7, 10, 11 };
49 static int16_t background, attr_orig;
50 static HANDLE con;
51 #define set_color(x)  SetConsoleTextAttribute(con, background | color[x])
52 #define reset_color() SetConsoleTextAttribute(con, attr_orig)
53 #else
54 static const uint8_t color[] = { 0x41, 0x41, 0x11, 0x03, 9, 0x02, 0x06 };
55 #define set_color(x)  fprintf(stderr, "\033[%d;3%dm", color[x] >> 4, color[x]&15)
56 #define print_256color(x) fprintf(stderr, "\033[38;5;%dm", x)
57 #define reset_color() fprintf(stderr, "\033[0m")
58 #endif
59 static int use_color = -1;
60
61 static void check_color_terminal(void)
62 {
63 #if HAVE_SETCONSOLETEXTATTRIBUTE
64     CONSOLE_SCREEN_BUFFER_INFO con_info;
65     con = GetStdHandle(STD_ERROR_HANDLE);
66     use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
67                 !getenv("AV_LOG_FORCE_NOCOLOR");
68     if (use_color) {
69         GetConsoleScreenBufferInfo(con, &con_info);
70         attr_orig  = con_info.wAttributes;
71         background = attr_orig & 0xF0;
72     }
73 #elif HAVE_ISATTY
74     char *term = getenv("TERM");
75     use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
76                 (getenv("TERM") && isatty(2) || getenv("AV_LOG_FORCE_COLOR"));
77     use_color += !!strstr(term, "256color") ;
78 #else
79     use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
80                !getenv("AV_LOG_FORCE_NOCOLOR");
81 #endif
82 }
83
84 static void colored_fputs(int level, int tint, const char *str)
85 {
86     if (use_color < 0)
87         check_color_terminal();
88
89     switch (use_color) {
90     case 1:
91         set_color(level);
92         break;
93     case 2:
94         set_color(level);
95         if (tint)
96             print_256color(tint);
97         break;
98     default:
99         break;
100     }
101     fputs(str, stderr);
102     if (use_color) {
103         reset_color();
104     }
105 }
106
107 const char *av_default_item_name(void *ptr)
108 {
109     return (*(AVClass **) ptr)->class_name;
110 }
111
112 void av_log_default_callback(void *avcl, int level, const char *fmt, va_list vl)
113 {
114     static int print_prefix = 1;
115     static int count;
116     static char prev[1024];
117     char line[1024];
118     static int is_atty;
119     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
120     unsigned tint = level & 0xff00;
121
122     level &= 0xff;
123
124     if (level > av_log_level)
125         return;
126     line[0] = 0;
127     if (print_prefix && avc) {
128         if (avc->parent_log_context_offset) {
129             AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
130                                    avc->parent_log_context_offset);
131             if (parent && *parent) {
132                 snprintf(line, sizeof(line), "[%s @ %p] ",
133                          (*parent)->item_name(parent), parent);
134             }
135         }
136         snprintf(line + strlen(line), sizeof(line) - strlen(line), "[%s @ %p] ",
137                  avc->item_name(avcl), avcl);
138     }
139
140     vsnprintf(line + strlen(line), sizeof(line) - strlen(line), fmt, vl);
141
142     print_prefix = strlen(line) && line[strlen(line) - 1] == '\n';
143
144 #if HAVE_ISATTY
145     if (!is_atty)
146         is_atty = isatty(2) ? 1 : -1;
147 #endif
148
149     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) &&
150         !strncmp(line, prev, sizeof line)) {
151         count++;
152         if (is_atty == 1)
153             fprintf(stderr, "    Last message repeated %d times\r", count);
154         return;
155     }
156     if (count > 0) {
157         fprintf(stderr, "    Last message repeated %d times\n", count);
158         count = 0;
159     }
160     colored_fputs(av_clip(level >> 3, 0, 6), tint >> 8, line);
161     av_strlcpy(prev, line, sizeof line);
162 }
163
164 static void (*av_log_callback)(void*, int, const char*, va_list) =
165     av_log_default_callback;
166
167 void av_log(void* avcl, int level, const char *fmt, ...)
168 {
169     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
170     va_list vl;
171     va_start(vl, fmt);
172     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
173         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
174         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
175     av_vlog(avcl, level, fmt, vl);
176     va_end(vl);
177 }
178
179 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
180 {
181     av_log_callback(avcl, level, fmt, vl);
182 }
183
184 int av_log_get_level(void)
185 {
186     return av_log_level;
187 }
188
189 void av_log_set_level(int level)
190 {
191     av_log_level = level;
192 }
193
194 void av_log_set_flags(int arg)
195 {
196     flags = arg;
197 }
198
199 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
200 {
201     av_log_callback = callback;
202 }
203
204 static void missing_feature_sample(int sample, void *avc, const char *msg,
205                                    va_list argument_list)
206 {
207     av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
208     av_log(avc, AV_LOG_WARNING, " is not implemented. Update your Libav "
209            "version to the newest one from Git. If the problem still "
210            "occurs, it means that your file has a feature which has not "
211            "been implemented.\n");
212     if (sample)
213         av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
214                "of this file to ftp://upload.libav.org/incoming/ "
215                "and contact the libav-devel mailing list.\n");
216 }
217
218 void avpriv_request_sample(void *avc, const char *msg, ...)
219 {
220     va_list argument_list;
221
222     va_start(argument_list, msg);
223     missing_feature_sample(1, avc, msg, argument_list);
224     va_end(argument_list);
225 }
226
227 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
228 {
229     va_list argument_list;
230
231     va_start(argument_list, msg);
232     missing_feature_sample(0, avc, msg, argument_list);
233     va_end(argument_list);
234 }