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