Libav
log.c
Go to the documentation of this file.
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 
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 
44 static int flags;
45 
46 #if HAVE_SETCONSOLETEXTATTRIBUTE
47 #include <windows.h>
48 static const uint8_t color[] = { 12, 12, 12, 14, 7, 10, 11 };
49 static int16_t background, attr_orig;
50 static HANDLE con;
51 #define set_color(x) SetConsoleTextAttribute(con, background | color[x])
52 #define reset_color() SetConsoleTextAttribute(con, attr_orig)
53 #define print_256color(x)
54 #else
55 static const uint8_t color[] = { 0x41, 0x41, 0x11, 0x03, 9, 0x02, 0x06 };
56 #define set_color(x) fprintf(stderr, "\033[%d;3%dm", color[x] >> 4, color[x]&15)
57 #define print_256color(x) fprintf(stderr, "\033[38;5;%dm", x)
58 #define reset_color() fprintf(stderr, "\033[0m")
59 #endif
60 static int use_color = -1;
61 
62 static void check_color_terminal(void)
63 {
64 #if HAVE_SETCONSOLETEXTATTRIBUTE
65  CONSOLE_SCREEN_BUFFER_INFO con_info;
66  con = GetStdHandle(STD_ERROR_HANDLE);
67  use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
68  !getenv("AV_LOG_FORCE_NOCOLOR");
69  if (use_color) {
70  GetConsoleScreenBufferInfo(con, &con_info);
71  attr_orig = con_info.wAttributes;
72  background = attr_orig & 0xF0;
73  }
74 #elif HAVE_ISATTY
75  char *term = getenv("TERM");
76  use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
77  (getenv("TERM") && isatty(2) || getenv("AV_LOG_FORCE_COLOR"));
78  if (use_color)
79  use_color += term && strstr(term, "256color");
80 #else
81  use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
82  !getenv("AV_LOG_FORCE_NOCOLOR");
83 #endif
84 }
85 
86 static void colored_fputs(int level, int tint, const char *str)
87 {
88  if (use_color < 0)
90 
91  switch (use_color) {
92  case 1:
93  set_color(level);
94  break;
95  case 2:
96  set_color(level);
97  if (tint)
98  print_256color(tint);
99  break;
100  default:
101  break;
102  }
103  fputs(str, stderr);
104  if (use_color) {
105  reset_color();
106  }
107 }
108 
109 const char *av_default_item_name(void *ptr)
110 {
111  return (*(AVClass **) ptr)->class_name;
112 }
113 
114 void av_log_default_callback(void *avcl, int level, const char *fmt, va_list vl)
115 {
116  static int print_prefix = 1;
117  static int count;
118  static char prev[1024];
119  char line[1024];
120  static int is_atty;
121  AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
122  unsigned tint = level & 0xff00;
123 
124  level &= 0xff;
125 
126  if (level > av_log_level)
127  return;
128  line[0] = 0;
129  if (print_prefix && avc) {
130  if (avc->parent_log_context_offset) {
131  AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
133  if (parent && *parent) {
134  snprintf(line, sizeof(line), "[%s @ %p] ",
135  (*parent)->item_name(parent), parent);
136  }
137  }
138  snprintf(line + strlen(line), sizeof(line) - strlen(line), "[%s @ %p] ",
139  avc->item_name(avcl), avcl);
140  }
141 
142  vsnprintf(line + strlen(line), sizeof(line) - strlen(line), fmt, vl);
143 
144  print_prefix = strlen(line) && line[strlen(line) - 1] == '\n';
145 
146 #if HAVE_ISATTY
147  if (!is_atty)
148  is_atty = isatty(2) ? 1 : -1;
149 #endif
150 
151  if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) &&
152  !strncmp(line, prev, sizeof line)) {
153  count++;
154  if (is_atty == 1)
155  fprintf(stderr, " Last message repeated %d times\r", count);
156  return;
157  }
158  if (count > 0) {
159  fprintf(stderr, " Last message repeated %d times\n", count);
160  count = 0;
161  }
162  colored_fputs(av_clip(level >> 3, 0, 6), tint >> 8, line);
163  av_strlcpy(prev, line, sizeof line);
164 }
165 
166 static void (*av_log_callback)(void*, int, const char*, va_list) =
168 
169 void av_log(void* avcl, int level, const char *fmt, ...)
170 {
171  AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
172  va_list vl;
173  va_start(vl, fmt);
174  if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
175  avc->log_level_offset_offset && level >= AV_LOG_FATAL)
176  level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
177  av_vlog(avcl, level, fmt, vl);
178  va_end(vl);
179 }
180 
181 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
182 {
183  av_log_callback(avcl, level, fmt, vl);
184 }
185 
187 {
188  return av_log_level;
189 }
190 
192 {
194 }
195 
196 void av_log_set_flags(int arg)
197 {
198  flags = arg;
199 }
200 
201 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
202 {
203  av_log_callback = callback;
204 }
205 
206 static void missing_feature_sample(int sample, void *avc, const char *msg,
207  va_list argument_list)
208 {
209  av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
210  av_log(avc, AV_LOG_WARNING, " is not implemented. Update your Libav "
211  "version to the newest one from Git. If the problem still "
212  "occurs, it means that your file has a feature which has not "
213  "been implemented.\n");
214  if (sample)
215  av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
216  "of this file to ftp://upload.libav.org/incoming/ "
217  "and contact the libav-devel mailing list.\n");
218 }
219 
220 void avpriv_request_sample(void *avc, const char *msg, ...)
221 {
222  va_list argument_list;
223 
224  va_start(argument_list, msg);
225  missing_feature_sample(1, avc, msg, argument_list);
226  va_end(argument_list);
227 }
228 
229 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
230 {
231  va_list argument_list;
232 
233  va_start(argument_list, msg);
234  missing_feature_sample(0, avc, msg, argument_list);
235  va_end(argument_list);
236 }
#define set_color(x)
Definition: log.c:56
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:129
void av_log_set_level(int level)
Set the log level.
Definition: log.c:191
#define reset_color()
Definition: log.c:58
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:109
external API header
#define sample
static void missing_feature_sample(int sample, void *avc, const char *msg, va_list argument_list)
Definition: log.c:206
uint8_t
int log_level_offset_offset
Offset in the structure where log_level_offset is stored.
Definition: log.h:65
static int flags
Definition: log.c:44
#define print_256color(x)
Definition: log.c:57
Definition: graph2dot.c:49
#define AV_LOG_SKIP_REPEATED
Skip repeated messages, this requires the user app to use av_log() instead of (f)printf as the 2 woul...
Definition: log.h:265
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:169
int av_log_get_level(void)
Get the current log level.
Definition: log.c:186
static int av_log_level
Definition: log.c:43
size_t av_strlcpy(char *dst, const char *src, size_t size)
Copy the string src to dst, but no more than size - 1 bytes, and null-terminate dst.
Definition: avstring.c:81
void av_log_default_callback(void *avcl, int level, const char *fmt, va_list vl)
Default logging callback.
Definition: log.c:114
common internal API header
static void check_color_terminal(void)
Definition: log.c:62
void avpriv_report_missing_feature(void *avc, const char *msg,...)
Definition: log.c:229
void av_log_set_callback(void(*callback)(void *, int, const char *, va_list))
Set the logging callback.
Definition: log.c:201
static void(* av_log_callback)(void *, int, const char *, va_list)
Definition: log.c:166
const char *(* item_name)(void *ctx)
A pointer to a function which returns the name of a context instance ctx associated with the class...
Definition: log.h:44
NULL
Definition: eval.c:55
#define AV_LOG_INFO
Standard information.
Definition: log.h:134
static void(WINAPI *cond_broadcast)(pthread_cond_t *cond)
Describe the class of an AVClass context structure.
Definition: log.h:33
void av_vlog(void *avcl, int level, const char *fmt, va_list vl)
Send the specified message to the log if the level is less than or equal to the current av_log_level...
Definition: log.c:181
uint8_t level
Definition: svq3.c:147
int version
LIBAVUTIL_VERSION with which this structure was created.
Definition: log.h:59
common internal and external API header
int parent_log_context_offset
Offset in the structure where a pointer to the parent context for logging is stored.
Definition: log.h:74
static const uint8_t color[]
Definition: log.c:55
static int use_color
Definition: log.c:60
void avpriv_request_sample(void *avc, const char *msg,...)
Definition: log.c:220
void av_log_set_flags(int arg)
Definition: log.c:196
#define AV_LOG_FATAL
Something went wrong and recovery is not possible.
Definition: log.h:117
static void colored_fputs(int level, int tint, const char *str)
Definition: log.c:86