32e1ba74c4d98fd2c3f7f2e0cfa4e57b8c834977
[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
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 "avutil.h"
38 #include "bprint.h"
39 #include "common.h"
40 #include "internal.h"
41 #include "log.h"
42
43 #if HAVE_PTHREADS
44 #include <pthread.h>
45 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
46 #endif
47
48 #define LINE_SZ 1024
49
50 static int av_log_level = AV_LOG_INFO;
51 static int flags;
52
53 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
54 #include <windows.h>
55 static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
56     [AV_LOG_PANIC  /8] = 12,
57     [AV_LOG_FATAL  /8] = 12,
58     [AV_LOG_ERROR  /8] = 12,
59     [AV_LOG_WARNING/8] = 14,
60     [AV_LOG_INFO   /8] =  7,
61     [AV_LOG_VERBOSE/8] = 10,
62     [AV_LOG_DEBUG  /8] = 10,
63     [16+AV_CLASS_CATEGORY_NA              ] =  7,
64     [16+AV_CLASS_CATEGORY_INPUT           ] = 13,
65     [16+AV_CLASS_CATEGORY_OUTPUT          ] =  5,
66     [16+AV_CLASS_CATEGORY_MUXER           ] = 13,
67     [16+AV_CLASS_CATEGORY_DEMUXER         ] =  5,
68     [16+AV_CLASS_CATEGORY_ENCODER         ] = 11,
69     [16+AV_CLASS_CATEGORY_DECODER         ] =  3,
70     [16+AV_CLASS_CATEGORY_FILTER          ] = 10,
71     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] =  9,
72     [16+AV_CLASS_CATEGORY_SWSCALER        ] =  7,
73     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] =  7,
74     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 13,
75     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT  ] = 5,
76     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 13,
77     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT  ] = 5,
78     [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT       ] = 13,
79     [16+AV_CLASS_CATEGORY_DEVICE_INPUT        ] = 5,
80 };
81
82 static int16_t background, attr_orig;
83 static HANDLE con;
84 #else
85
86 static const uint32_t color[16 + AV_CLASS_CATEGORY_NB] = {
87     [AV_LOG_PANIC  /8] =  52 << 16 | 196 << 8 | 0x41,
88     [AV_LOG_FATAL  /8] = 208 <<  8 | 0x41,
89     [AV_LOG_ERROR  /8] = 196 <<  8 | 0x11,
90     [AV_LOG_WARNING/8] = 226 <<  8 | 0x03,
91     [AV_LOG_INFO   /8] = 253 <<  8 | 0x09,
92     [AV_LOG_VERBOSE/8] =  40 <<  8 | 0x02,
93     [AV_LOG_DEBUG  /8] =  34 <<  8 | 0x02,
94     [16+AV_CLASS_CATEGORY_NA              ] = 250 << 8 | 0x09,
95     [16+AV_CLASS_CATEGORY_INPUT           ] = 219 << 8 | 0x15,
96     [16+AV_CLASS_CATEGORY_OUTPUT          ] = 201 << 8 | 0x05,
97     [16+AV_CLASS_CATEGORY_MUXER           ] = 213 << 8 | 0x15,
98     [16+AV_CLASS_CATEGORY_DEMUXER         ] = 207 << 8 | 0x05,
99     [16+AV_CLASS_CATEGORY_ENCODER         ] =  51 << 8 | 0x16,
100     [16+AV_CLASS_CATEGORY_DECODER         ] =  39 << 8 | 0x06,
101     [16+AV_CLASS_CATEGORY_FILTER          ] = 155 << 8 | 0x12,
102     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 192 << 8 | 0x14,
103     [16+AV_CLASS_CATEGORY_SWSCALER        ] = 153 << 8 | 0x14,
104     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] = 147 << 8 | 0x14,
105     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 213 << 8 | 0x15,
106     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT  ] = 207 << 8 | 0x05,
107     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 213 << 8 | 0x15,
108     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT  ] = 207 << 8 | 0x05,
109     [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT       ] = 213 << 8 | 0x15,
110     [16+AV_CLASS_CATEGORY_DEVICE_INPUT        ] = 207 << 8 | 0x05,
111 };
112
113 #endif
114 static int use_color = -1;
115
116 static void check_color_terminal(void)
117 {
118 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
119     CONSOLE_SCREEN_BUFFER_INFO con_info;
120     con = GetStdHandle(STD_ERROR_HANDLE);
121     use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
122                 !getenv("AV_LOG_FORCE_NOCOLOR");
123     if (use_color) {
124         GetConsoleScreenBufferInfo(con, &con_info);
125         attr_orig  = con_info.wAttributes;
126         background = attr_orig & 0xF0;
127     }
128 #elif HAVE_ISATTY
129     char *term = getenv("TERM");
130     use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
131                 (getenv("TERM") && isatty(2) || getenv("AV_LOG_FORCE_COLOR"));
132     if (   getenv("AV_LOG_FORCE_256COLOR")
133         || (term && strstr(term, "256color")))
134         use_color *= 256;
135 #else
136     use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
137                !getenv("AV_LOG_FORCE_NOCOLOR");
138 #endif
139 }
140
141 static void colored_fputs(int level, int tint, const char *str)
142 {
143     if (!*str)
144         return;
145
146     if (use_color < 0)
147         check_color_terminal();
148
149 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
150     if (use_color && level != AV_LOG_INFO/8)
151         SetConsoleTextAttribute(con, background | color[level]);
152     fputs(str, stderr);
153     if (use_color && level != AV_LOG_INFO/8)
154         SetConsoleTextAttribute(con, attr_orig);
155 #else
156     if (use_color == 1 && level != AV_LOG_INFO/8) {
157         fprintf(stderr,
158                 "\033[%d;3%dm%s\033[0m",
159                 (color[level] >> 4) & 15,
160                 color[level] & 15,
161                 str);
162     } else if (tint && use_color == 256) {
163         fprintf(stderr,
164                 "\033[48;5;%dm\033[38;5;%dm%s\033[0m",
165                 (color[level] >> 16) & 0xff,
166                 tint,
167                 str);
168     } else if (use_color == 256 && level != AV_LOG_INFO/8) {
169         fprintf(stderr,
170                 "\033[48;5;%dm\033[38;5;%dm%s\033[0m",
171                 (color[level] >> 16) & 0xff,
172                 (color[level] >> 8) & 0xff,
173                 str);
174     } else
175         fputs(str, stderr);
176 #endif
177
178 }
179
180 const char *av_default_item_name(void *ptr)
181 {
182     return (*(AVClass **) ptr)->class_name;
183 }
184
185 AVClassCategory av_default_get_category(void *ptr)
186 {
187     return (*(AVClass **) ptr)->category;
188 }
189
190 static void sanitize(uint8_t *line){
191     while(*line){
192         if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
193             *line='?';
194         line++;
195     }
196 }
197
198 static int get_category(void *ptr){
199     AVClass *avc = *(AVClass **) ptr;
200     if(    !avc
201         || (avc->version&0xFF)<100
202         ||  avc->version < (51 << 16 | 59 << 8)
203         ||  avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;
204
205     if(avc->get_category)
206         return avc->get_category(ptr) + 16;
207
208     return avc->category + 16;
209 }
210
211 static void format_line(void *avcl, int level, const char *fmt, va_list vl,
212                         AVBPrint part[3], int *print_prefix, int type[2])
213 {
214     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
215     av_bprint_init(part+0, 0, 1);
216     av_bprint_init(part+1, 0, 1);
217     av_bprint_init(part+2, 0, 65536);
218
219     if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
220     if (*print_prefix && avc) {
221         if (avc->parent_log_context_offset) {
222             AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
223                                    avc->parent_log_context_offset);
224             if (parent && *parent) {
225                 av_bprintf(part+0, "[%s @ %p] ",
226                          (*parent)->item_name(parent), parent);
227                 if(type) type[0] = get_category(parent);
228             }
229         }
230         av_bprintf(part+1, "[%s @ %p] ",
231                  avc->item_name(avcl), avcl);
232         if(type) type[1] = get_category(avcl);
233     }
234
235     av_vbprintf(part+2, fmt, vl);
236
237     if(*part[0].str || *part[1].str || *part[2].str) {
238         char lastc = part[2].len && part[2].len <= part[2].size ? part[2].str[part[2].len - 1] : 0;
239         *print_prefix = lastc == '\n' || lastc == '\r';
240     }
241 }
242
243 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
244                         char *line, int line_size, int *print_prefix)
245 {
246     AVBPrint part[3];
247     format_line(ptr, level, fmt, vl, part, print_prefix, NULL);
248     snprintf(line, line_size, "%s%s%s", part[0].str, part[1].str, part[2].str);
249     av_bprint_finalize(part+2, NULL);
250 }
251
252 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
253 {
254     static int print_prefix = 1;
255     static int count;
256     static char prev[LINE_SZ];
257     AVBPrint part[3];
258     char line[LINE_SZ];
259     static int is_atty;
260     int type[2];
261     unsigned tint = 0;
262
263     if (level >= 0) {
264         tint = level & 0xff00;
265         level &= 0xff;
266     }
267
268     if (level > av_log_level)
269         return;
270 #if HAVE_PTHREADS
271     pthread_mutex_lock(&mutex);
272 #endif
273
274     format_line(ptr, level, fmt, vl, part, &print_prefix, type);
275     snprintf(line, sizeof(line), "%s%s%s", part[0].str, part[1].str, part[2].str);
276
277 #if HAVE_ISATTY
278     if (!is_atty)
279         is_atty = isatty(2) ? 1 : -1;
280 #endif
281
282     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev) &&
283         *line && line[strlen(line) - 1] != '\r'){
284         count++;
285         if (is_atty == 1)
286             fprintf(stderr, "    Last message repeated %d times\r", count);
287         goto end;
288     }
289     if (count > 0) {
290         fprintf(stderr, "    Last message repeated %d times\n", count);
291         count = 0;
292     }
293     strcpy(prev, line);
294     sanitize(part[0].str);
295     colored_fputs(type[0], 0, part[0].str);
296     sanitize(part[1].str);
297     colored_fputs(type[1], 0, part[1].str);
298     sanitize(part[2].str);
299     colored_fputs(av_clip(level >> 3, 0, 6), tint >> 8, part[2].str);
300 end:
301     av_bprint_finalize(part+2, NULL);
302 #if HAVE_PTHREADS
303     pthread_mutex_unlock(&mutex);
304 #endif
305 }
306
307 static void (*av_log_callback)(void*, int, const char*, va_list) =
308     av_log_default_callback;
309
310 void av_log(void* avcl, int level, const char *fmt, ...)
311 {
312     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
313     va_list vl;
314     va_start(vl, fmt);
315     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
316         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
317         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
318     av_vlog(avcl, level, fmt, vl);
319     va_end(vl);
320 }
321
322 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
323 {
324     void (*log_callback)(void*, int, const char*, va_list) = av_log_callback;
325     if (log_callback)
326         log_callback(avcl, level, fmt, vl);
327 }
328
329 int av_log_get_level(void)
330 {
331     return av_log_level;
332 }
333
334 void av_log_set_level(int level)
335 {
336     av_log_level = level;
337 }
338
339 void av_log_set_flags(int arg)
340 {
341     flags = arg;
342 }
343
344 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
345 {
346     av_log_callback = callback;
347 }
348
349 static void missing_feature_sample(int sample, void *avc, const char *msg,
350                                    va_list argument_list)
351 {
352     av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
353     av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg "
354            "version to the newest one from Git. If the problem still "
355            "occurs, it means that your file has a feature which has not "
356            "been implemented.\n");
357     if (sample)
358         av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
359                "of this file to ftp://upload.ffmpeg.org/MPlayer/incoming/ "
360                "and contact the ffmpeg-devel mailing list.\n");
361 }
362
363 void avpriv_request_sample(void *avc, const char *msg, ...)
364 {
365     va_list argument_list;
366
367     va_start(argument_list, msg);
368     missing_feature_sample(1, avc, msg, argument_list);
369     va_end(argument_list);
370 }
371
372 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
373 {
374     va_list argument_list;
375
376     va_start(argument_list, msg);
377     missing_feature_sample(0, avc, msg, argument_list);
378     va_end(argument_list);
379 }
380
381 #ifdef TEST
382 // LCOV_EXCL_START
383 #include <string.h>
384
385 int main(int argc, char **argv)
386 {
387     int i;
388     av_log_set_level(AV_LOG_DEBUG);
389     for (use_color=0; use_color<=256; use_color = 255*use_color+1) {
390         av_log(NULL, AV_LOG_FATAL, "use_color: %d\n", use_color);
391         for (i = AV_LOG_DEBUG; i>=AV_LOG_QUIET; i-=8) {
392             av_log(NULL, i, " %d", i);
393             av_log(NULL, AV_LOG_INFO, "e ");
394             av_log(NULL, i + 256*123, "C%d", i);
395             av_log(NULL, AV_LOG_INFO, "e");
396         }
397         av_log(NULL, AV_LOG_PANIC, "\n");
398     }
399     return 0;
400 }
401 // LCOV_EXCL_STOP
402 #endif