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