log: Remove redundant va_list creation from missing_feature_sample()
[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 "common.h"
39 #include "internal.h"
40 #include "log.h"
41
42 #define LINE_SZ 1024
43
44 static int av_log_level = AV_LOG_INFO;
45 static int flags;
46
47 #if HAVE_SETCONSOLETEXTATTRIBUTE
48 #include <windows.h>
49 static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
50     [AV_LOG_PANIC  /8] = 12,
51     [AV_LOG_FATAL  /8] = 12,
52     [AV_LOG_ERROR  /8] = 12,
53     [AV_LOG_WARNING/8] = 14,
54     [AV_LOG_INFO   /8] =  7,
55     [AV_LOG_VERBOSE/8] = 10,
56     [AV_LOG_DEBUG  /8] = 10,
57     [16+AV_CLASS_CATEGORY_NA              ] =  7,
58     [16+AV_CLASS_CATEGORY_INPUT           ] = 13,
59     [16+AV_CLASS_CATEGORY_OUTPUT          ] =  5,
60     [16+AV_CLASS_CATEGORY_MUXER           ] = 13,
61     [16+AV_CLASS_CATEGORY_DEMUXER         ] =  5,
62     [16+AV_CLASS_CATEGORY_ENCODER         ] = 11,
63     [16+AV_CLASS_CATEGORY_DECODER         ] =  3,
64     [16+AV_CLASS_CATEGORY_FILTER          ] = 10,
65     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] =  9,
66     [16+AV_CLASS_CATEGORY_SWSCALER        ] =  7,
67     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] =  7,
68 };
69
70 static int16_t background, attr_orig;
71 static HANDLE con;
72 #define set_color(x)  SetConsoleTextAttribute(con, background | color[x])
73 #define set_256color set_color
74 #define reset_color() SetConsoleTextAttribute(con, attr_orig)
75 #else
76
77 static const uint32_t color[16 + AV_CLASS_CATEGORY_NB] = {
78     [AV_LOG_PANIC  /8] =  52 << 16 | 196 << 8 | 0x41,
79     [AV_LOG_FATAL  /8] = 208 <<  8 | 0x41,
80     [AV_LOG_ERROR  /8] = 196 <<  8 | 0x11,
81     [AV_LOG_WARNING/8] = 226 <<  8 | 0x03,
82     [AV_LOG_INFO   /8] = 253 <<  8 | 0x09,
83     [AV_LOG_VERBOSE/8] =  40 <<  8 | 0x02,
84     [AV_LOG_DEBUG  /8] =  34 <<  8 | 0x02,
85     [16+AV_CLASS_CATEGORY_NA              ] = 250 << 8 | 0x09,
86     [16+AV_CLASS_CATEGORY_INPUT           ] = 219 << 8 | 0x15,
87     [16+AV_CLASS_CATEGORY_OUTPUT          ] = 201 << 8 | 0x05,
88     [16+AV_CLASS_CATEGORY_MUXER           ] = 213 << 8 | 0x15,
89     [16+AV_CLASS_CATEGORY_DEMUXER         ] = 207 << 8 | 0x05,
90     [16+AV_CLASS_CATEGORY_ENCODER         ] =  51 << 8 | 0x16,
91     [16+AV_CLASS_CATEGORY_DECODER         ] =  39 << 8 | 0x06,
92     [16+AV_CLASS_CATEGORY_FILTER          ] = 155 << 8 | 0x12,
93     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 192 << 8 | 0x14,
94     [16+AV_CLASS_CATEGORY_SWSCALER        ] = 153 << 8 | 0x14,
95     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] = 147 << 8 | 0x14,
96 };
97
98 #define set_color(x)  fprintf(stderr, "\033[%d;3%dm", (color[x] >> 4) & 15, color[x] & 15)
99 #define set_256color(x) fprintf(stderr, "\033[48;5;%dm\033[38;5;%dm", (color[x] >> 16) & 0xff, (color[x] >> 8) & 0xff)
100 #define reset_color() fprintf(stderr, "\033[0m")
101 #endif
102 static int use_color = -1;
103
104 static void colored_fputs(int level, const char *str)
105 {
106     if (use_color < 0) {
107 #if HAVE_SETCONSOLETEXTATTRIBUTE
108         CONSOLE_SCREEN_BUFFER_INFO con_info;
109         con = GetStdHandle(STD_ERROR_HANDLE);
110         use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
111                     !getenv("AV_LOG_FORCE_NOCOLOR");
112         if (use_color) {
113             GetConsoleScreenBufferInfo(con, &con_info);
114             attr_orig  = con_info.wAttributes;
115             background = attr_orig & 0xF0;
116         }
117 #elif HAVE_ISATTY
118         use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
119                     (getenv("TERM") && isatty(2) ||
120                      getenv("AV_LOG_FORCE_COLOR"));
121         if (getenv("AV_LOG_FORCE_256COLOR"))
122             use_color *= 256;
123 #else
124         use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
125                    !getenv("AV_LOG_FORCE_NOCOLOR");
126 #endif
127     }
128
129     if (use_color == 1) {
130         set_color(level);
131     } else if (use_color == 256)
132         set_256color(level);
133     fputs(str, stderr);
134     if (use_color) {
135         reset_color();
136     }
137 }
138
139 const char *av_default_item_name(void *ptr)
140 {
141     return (*(AVClass **) ptr)->class_name;
142 }
143
144 AVClassCategory av_default_get_category(void *ptr)
145 {
146     return (*(AVClass **) ptr)->category;
147 }
148
149 static void sanitize(uint8_t *line){
150     while(*line){
151         if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
152             *line='?';
153         line++;
154     }
155 }
156
157 static int get_category(void *ptr){
158     AVClass *avc = *(AVClass **) ptr;
159     if(    !avc
160         || (avc->version&0xFF)<100
161         ||  avc->version < (51 << 16 | 59 << 8)
162         ||  avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;
163
164     if(avc->get_category)
165         return avc->get_category(ptr) + 16;
166
167     return avc->category + 16;
168 }
169
170 static void format_line(void *ptr, int level, const char *fmt, va_list vl,
171                         char part[3][LINE_SZ], int part_size, int *print_prefix, int type[2])
172 {
173     AVClass* avc = ptr ? *(AVClass **) ptr : NULL;
174     part[0][0] = part[1][0] = part[2][0] = 0;
175     if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
176     if (*print_prefix && avc) {
177         if (avc->parent_log_context_offset) {
178             AVClass** parent = *(AVClass ***) (((uint8_t *) ptr) +
179                                    avc->parent_log_context_offset);
180             if (parent && *parent) {
181                 snprintf(part[0], part_size, "[%s @ %p] ",
182                          (*parent)->item_name(parent), parent);
183                 if(type) type[0] = get_category(((uint8_t *) ptr) + avc->parent_log_context_offset);
184             }
185         }
186         snprintf(part[1], part_size, "[%s @ %p] ",
187                  avc->item_name(ptr), ptr);
188         if(type) type[1] = get_category(ptr);
189     }
190
191     vsnprintf(part[2], part_size, fmt, vl);
192
193     *print_prefix = strlen(part[2]) && part[2][strlen(part[2]) - 1] == '\n';
194 }
195
196 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
197                         char *line, int line_size, int *print_prefix)
198 {
199     char part[3][LINE_SZ];
200     format_line(ptr, level, fmt, vl, part, sizeof(part[0]), print_prefix, NULL);
201     snprintf(line, line_size, "%s%s%s", part[0], part[1], part[2]);
202 }
203
204 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
205 {
206     static int print_prefix = 1;
207     static int count;
208     static char prev[LINE_SZ];
209     char part[3][LINE_SZ];
210     char line[LINE_SZ];
211     static int is_atty;
212     int type[2];
213
214     if (level > av_log_level)
215         return;
216     format_line(ptr, level, fmt, vl, part, sizeof(part[0]), &print_prefix, type);
217     snprintf(line, sizeof(line), "%s%s%s", part[0], part[1], part[2]);
218
219 #if HAVE_ISATTY
220     if (!is_atty)
221         is_atty = isatty(2) ? 1 : -1;
222 #endif
223
224     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev)){
225         count++;
226         if (is_atty == 1)
227             fprintf(stderr, "    Last message repeated %d times\r", count);
228         return;
229     }
230     if (count > 0) {
231         fprintf(stderr, "    Last message repeated %d times\n", count);
232         count = 0;
233     }
234     strcpy(prev, line);
235     sanitize(part[0]);
236     colored_fputs(type[0], part[0]);
237     sanitize(part[1]);
238     colored_fputs(type[1], part[1]);
239     sanitize(part[2]);
240     colored_fputs(av_clip(level >> 3, 0, 6), part[2]);
241 }
242
243 static void (*av_log_callback)(void*, int, const char*, va_list) =
244     av_log_default_callback;
245
246 void av_log(void* avcl, int level, const char *fmt, ...)
247 {
248     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
249     va_list vl;
250     va_start(vl, fmt);
251     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
252         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
253         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
254     av_vlog(avcl, level, fmt, vl);
255     va_end(vl);
256 }
257
258 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
259 {
260     if(av_log_callback)
261         av_log_callback(avcl, level, fmt, vl);
262 }
263
264 int av_log_get_level(void)
265 {
266     return av_log_level;
267 }
268
269 void av_log_set_level(int level)
270 {
271     av_log_level = level;
272 }
273
274 void av_log_set_flags(int arg)
275 {
276     flags = arg;
277 }
278
279 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
280 {
281     av_log_callback = callback;
282 }
283
284 static void missing_feature_sample(int sample, void *avc, const char *msg, va_list argument_list)
285 {
286     av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
287     av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg "
288            "version to the newest one from Git. If the problem still "
289            "occurs, it means that your file has a feature which has not "
290            "been implemented.\n");
291     if (sample)
292         av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
293                "of this file to ftp://upload.ffmpeg.org/MPlayer/incoming/ "
294                "and contact the ffmpeg-devel mailing list.\n");
295 }
296
297 void avpriv_request_sample(void *avc, const char *msg, ...)
298 {
299     va_list argument_list;
300
301     va_start(argument_list, msg);
302     missing_feature_sample(1, avc, msg, argument_list);
303     va_end(argument_list);
304 }
305
306 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
307 {
308     va_list argument_list;
309
310     va_start(argument_list, msg);
311     missing_feature_sample(0, avc, msg, argument_list);
312     va_end(argument_list);
313 }