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