log: Introduce a more verbose debug level
[ffmpeg.git] / libavutil / log.c
1 /*
2  * log functions
3  * Copyright (c) 2003 Michel Bardiaux
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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 "avstring.h"
38 #include "avutil.h"
39 #include "common.h"
40 #include "internal.h"
41 #include "log.h"
42
43 static int av_log_level = AV_LOG_INFO;
44 static int flags;
45
46 #define NB_LEVELS 8
47 #if HAVE_SETCONSOLETEXTATTRIBUTE
48 #include <windows.h>
49 static const uint8_t color[NB_LEVELS] = { 12, 12, 12, 14, 7, 10, 11, 8};
50 static int16_t background, attr_orig;
51 static HANDLE con;
52 #define set_color(x)  SetConsoleTextAttribute(con, background | color[x])
53 #define reset_color() SetConsoleTextAttribute(con, attr_orig)
54 #define print_256color(x)
55 #else
56 static const uint8_t color[NB_LEVELS] = {
57     0x41, 0x41, 0x11, 0x03, 9, 0x02, 0x06, 0x07
58 };
59 #define set_color(x)  fprintf(stderr, "\033[%d;3%dm", color[x] >> 4, color[x]&15)
60 #define print_256color(x) fprintf(stderr, "\033[38;5;%dm", x)
61 #define reset_color() fprintf(stderr, "\033[0m")
62 #endif
63 static int use_color = -1;
64
65 static void check_color_terminal(void)
66 {
67 #if HAVE_SETCONSOLETEXTATTRIBUTE
68     CONSOLE_SCREEN_BUFFER_INFO con_info;
69     con = GetStdHandle(STD_ERROR_HANDLE);
70     use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
71                 !getenv("AV_LOG_FORCE_NOCOLOR");
72     if (use_color) {
73         GetConsoleScreenBufferInfo(con, &con_info);
74         attr_orig  = con_info.wAttributes;
75         background = attr_orig & 0xF0;
76     }
77 #elif HAVE_ISATTY
78     char *term = getenv("TERM");
79     use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
80                 (getenv("TERM") && isatty(2) || getenv("AV_LOG_FORCE_COLOR"));
81     if (use_color)
82         use_color += term && strstr(term, "256color");
83 #else
84     use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
85                !getenv("AV_LOG_FORCE_NOCOLOR");
86 #endif
87 }
88
89 static void colored_fputs(int level, int tint, const char *str)
90 {
91     if (use_color < 0)
92         check_color_terminal();
93
94     switch (use_color) {
95     case 1:
96         set_color(level);
97         break;
98     case 2:
99         set_color(level);
100         if (tint)
101             print_256color(tint);
102         break;
103     default:
104         break;
105     }
106     fputs(str, stderr);
107     if (use_color) {
108         reset_color();
109     }
110 }
111
112 const char *av_default_item_name(void *ptr)
113 {
114     return (*(AVClass **) ptr)->class_name;
115 }
116
117 void av_log_default_callback(void *avcl, int level, const char *fmt, va_list vl)
118 {
119     static int print_prefix = 1;
120     static int count;
121     static char prev[1024];
122     char line[1024];
123     static int is_atty;
124     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
125     unsigned tint = level & 0xff00;
126
127     level &= 0xff;
128
129     if (level > av_log_level)
130         return;
131     line[0] = 0;
132     if (print_prefix && avc) {
133         if (avc->parent_log_context_offset) {
134             AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
135                                    avc->parent_log_context_offset);
136             if (parent && *parent) {
137                 snprintf(line, sizeof(line), "[%s @ %p] ",
138                          (*parent)->item_name(parent), parent);
139             }
140         }
141         snprintf(line + strlen(line), sizeof(line) - strlen(line), "[%s @ %p] ",
142                  avc->item_name(avcl), avcl);
143     }
144
145     vsnprintf(line + strlen(line), sizeof(line) - strlen(line), fmt, vl);
146
147     print_prefix = strlen(line) && line[strlen(line) - 1] == '\n';
148
149 #if HAVE_ISATTY
150     if (!is_atty)
151         is_atty = isatty(2) ? 1 : -1;
152 #endif
153
154     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) &&
155         !strncmp(line, prev, sizeof line)) {
156         count++;
157         if (is_atty == 1)
158             fprintf(stderr, "    Last message repeated %d times\r", count);
159         return;
160     }
161     if (count > 0) {
162         fprintf(stderr, "    Last message repeated %d times\n", count);
163         count = 0;
164     }
165     colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, line);
166     av_strlcpy(prev, line, sizeof line);
167 }
168
169 static void (*av_log_callback)(void*, int, const char*, va_list) =
170     av_log_default_callback;
171
172 void av_log(void* avcl, int level, const char *fmt, ...)
173 {
174     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
175     va_list vl;
176     va_start(vl, fmt);
177     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
178         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
179         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
180     av_vlog(avcl, level, fmt, vl);
181     va_end(vl);
182 }
183
184 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
185 {
186     av_log_callback(avcl, level, fmt, vl);
187 }
188
189 int av_log_get_level(void)
190 {
191     return av_log_level;
192 }
193
194 void av_log_set_level(int level)
195 {
196     av_log_level = level;
197 }
198
199 void av_log_set_flags(int arg)
200 {
201     flags = arg;
202 }
203
204 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
205 {
206     av_log_callback = callback;
207 }
208
209 static void missing_feature_sample(int sample, void *avc, const char *msg,
210                                    va_list argument_list)
211 {
212     av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
213     av_log(avc, AV_LOG_WARNING, " is not implemented. Update your Libav "
214            "version to the newest one from Git. If the problem still "
215            "occurs, it means that your file has a feature which has not "
216            "been implemented.\n");
217     if (sample)
218         av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
219                "of this file to ftp://upload.libav.org/incoming/ "
220                "and contact the libav-devel mailing list.\n");
221 }
222
223 void avpriv_request_sample(void *avc, const char *msg, ...)
224 {
225     va_list argument_list;
226
227     va_start(argument_list, msg);
228     missing_feature_sample(1, avc, msg, argument_list);
229     va_end(argument_list);
230 }
231
232 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
233 {
234     va_list argument_list;
235
236     va_start(argument_list, msg);
237     missing_feature_sample(0, avc, msg, argument_list);
238     va_end(argument_list);
239 }