FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 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 #if HAVE_VALGRIND_VALGRIND_H
51 #include <valgrind/valgrind.h>
52 /* this is the log level at which valgrind will output a full backtrace */
53 #define BACKTRACE_LOGLEVEL AV_LOG_ERROR
54 #endif
55 
57 static int flags;
58 
59 #define NB_LEVELS 8
60 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
61 #include <windows.h>
62 static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
63  [AV_LOG_PANIC /8] = 12,
64  [AV_LOG_FATAL /8] = 12,
65  [AV_LOG_ERROR /8] = 12,
66  [AV_LOG_WARNING/8] = 14,
67  [AV_LOG_INFO /8] = 7,
68  [AV_LOG_VERBOSE/8] = 10,
69  [AV_LOG_DEBUG /8] = 10,
70  [AV_LOG_TRACE /8] = 8,
71  [16+AV_CLASS_CATEGORY_NA ] = 7,
72  [16+AV_CLASS_CATEGORY_INPUT ] = 13,
73  [16+AV_CLASS_CATEGORY_OUTPUT ] = 5,
74  [16+AV_CLASS_CATEGORY_MUXER ] = 13,
75  [16+AV_CLASS_CATEGORY_DEMUXER ] = 5,
76  [16+AV_CLASS_CATEGORY_ENCODER ] = 11,
77  [16+AV_CLASS_CATEGORY_DECODER ] = 3,
78  [16+AV_CLASS_CATEGORY_FILTER ] = 10,
88 };
89 
90 static int16_t background, attr_orig;
91 static HANDLE con;
92 #else
93 
94 static const uint32_t color[16 + AV_CLASS_CATEGORY_NB] = {
95  [AV_LOG_PANIC /8] = 52 << 16 | 196 << 8 | 0x41,
96  [AV_LOG_FATAL /8] = 208 << 8 | 0x41,
97  [AV_LOG_ERROR /8] = 196 << 8 | 0x11,
98  [AV_LOG_WARNING/8] = 226 << 8 | 0x03,
99  [AV_LOG_INFO /8] = 253 << 8 | 0x09,
100  [AV_LOG_VERBOSE/8] = 40 << 8 | 0x02,
101  [AV_LOG_DEBUG /8] = 34 << 8 | 0x02,
102  [AV_LOG_TRACE /8] = 34 << 8 | 0x07,
103  [16+AV_CLASS_CATEGORY_NA ] = 250 << 8 | 0x09,
104  [16+AV_CLASS_CATEGORY_INPUT ] = 219 << 8 | 0x15,
105  [16+AV_CLASS_CATEGORY_OUTPUT ] = 201 << 8 | 0x05,
106  [16+AV_CLASS_CATEGORY_MUXER ] = 213 << 8 | 0x15,
107  [16+AV_CLASS_CATEGORY_DEMUXER ] = 207 << 8 | 0x05,
108  [16+AV_CLASS_CATEGORY_ENCODER ] = 51 << 8 | 0x16,
109  [16+AV_CLASS_CATEGORY_DECODER ] = 39 << 8 | 0x06,
110  [16+AV_CLASS_CATEGORY_FILTER ] = 155 << 8 | 0x12,
111  [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 192 << 8 | 0x14,
112  [16+AV_CLASS_CATEGORY_SWSCALER ] = 153 << 8 | 0x14,
113  [16+AV_CLASS_CATEGORY_SWRESAMPLER ] = 147 << 8 | 0x14,
114  [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 213 << 8 | 0x15,
115  [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT ] = 207 << 8 | 0x05,
116  [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 213 << 8 | 0x15,
117  [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT ] = 207 << 8 | 0x05,
118  [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT ] = 213 << 8 | 0x15,
119  [16+AV_CLASS_CATEGORY_DEVICE_INPUT ] = 207 << 8 | 0x05,
120 };
121 
122 #endif
123 static int use_color = -1;
124 
125 static void check_color_terminal(void)
126 {
127 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
128  CONSOLE_SCREEN_BUFFER_INFO con_info;
129  con = GetStdHandle(STD_ERROR_HANDLE);
130  use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
131  !getenv("AV_LOG_FORCE_NOCOLOR");
132  if (use_color) {
133  GetConsoleScreenBufferInfo(con, &con_info);
134  attr_orig = con_info.wAttributes;
135  background = attr_orig & 0xF0;
136  }
137 #elif HAVE_ISATTY
138  char *term = getenv("TERM");
139  use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
140  (getenv("TERM") && isatty(2) || getenv("AV_LOG_FORCE_COLOR"));
141  if ( getenv("AV_LOG_FORCE_256COLOR")
142  || (term && strstr(term, "256color")))
143  use_color *= 256;
144 #else
145  use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
146  !getenv("AV_LOG_FORCE_NOCOLOR");
147 #endif
148 }
149 
150 static void colored_fputs(int level, int tint, const char *str)
151 {
152  int local_use_color;
153  if (!*str)
154  return;
155 
156  if (use_color < 0)
158 
159  if (level == AV_LOG_INFO/8) local_use_color = 0;
160  else local_use_color = use_color;
161 
162 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
163  if (local_use_color)
164  SetConsoleTextAttribute(con, background | color[level]);
165  fputs(str, stderr);
166  if (local_use_color)
167  SetConsoleTextAttribute(con, attr_orig);
168 #else
169  if (local_use_color == 1) {
170  fprintf(stderr,
171  "\033[%d;3%dm%s\033[0m",
172  (color[level] >> 4) & 15,
173  color[level] & 15,
174  str);
175  } else if (tint && use_color == 256) {
176  fprintf(stderr,
177  "\033[48;5;%dm\033[38;5;%dm%s\033[0m",
178  (color[level] >> 16) & 0xff,
179  tint,
180  str);
181  } else if (local_use_color == 256) {
182  fprintf(stderr,
183  "\033[48;5;%dm\033[38;5;%dm%s\033[0m",
184  (color[level] >> 16) & 0xff,
185  (color[level] >> 8) & 0xff,
186  str);
187  } else
188  fputs(str, stderr);
189 #endif
190 
191 }
192 
193 const char *av_default_item_name(void *ptr)
194 {
195  return (*(AVClass **) ptr)->class_name;
196 }
197 
199 {
200  return (*(AVClass **) ptr)->category;
201 }
202 
203 static void sanitize(uint8_t *line){
204  while(*line){
205  if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
206  *line='?';
207  line++;
208  }
209 }
210 
211 static int get_category(void *ptr){
212  AVClass *avc = *(AVClass **) ptr;
213  if( !avc
214  || (avc->version&0xFF)<100
215  || avc->version < (51 << 16 | 59 << 8)
216  || avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;
217 
218  if(avc->get_category)
219  return avc->get_category(ptr) + 16;
220 
221  return avc->category + 16;
222 }
223 
224 static const char *get_level_str(int level)
225 {
226  switch (level) {
227  case AV_LOG_QUIET:
228  return "quiet";
229  case AV_LOG_DEBUG:
230  return "debug";
231  case AV_LOG_VERBOSE:
232  return "verbose";
233  case AV_LOG_INFO:
234  return "info";
235  case AV_LOG_WARNING:
236  return "warning";
237  case AV_LOG_ERROR:
238  return "error";
239  case AV_LOG_FATAL:
240  return "fatal";
241  case AV_LOG_PANIC:
242  return "panic";
243  default:
244  return "";
245  }
246 }
247 
248 static void format_line(void *avcl, int level, const char *fmt, va_list vl,
249  AVBPrint part[4], int *print_prefix, int type[2])
250 {
251  AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
252  av_bprint_init(part+0, 0, 1);
253  av_bprint_init(part+1, 0, 1);
254  av_bprint_init(part+2, 0, 1);
255  av_bprint_init(part+3, 0, 65536);
256 
257  if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
258  if (*print_prefix && avc) {
259  if (avc->parent_log_context_offset) {
260  AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
262  if (parent && *parent) {
263  av_bprintf(part+0, "[%s @ %p] ",
264  (*parent)->item_name(parent), parent);
265  if(type) type[0] = get_category(parent);
266  }
267  }
268  av_bprintf(part+1, "[%s @ %p] ",
269  avc->item_name(avcl), avcl);
270  if(type) type[1] = get_category(avcl);
271 
273  av_bprintf(part+2, "[%s] ", get_level_str(level));
274  }
275 
276  av_vbprintf(part+3, fmt, vl);
277 
278  if(*part[0].str || *part[1].str || *part[2].str || *part[3].str) {
279  char lastc = part[3].len && part[3].len <= part[3].size ? part[3].str[part[3].len - 1] : 0;
280  *print_prefix = lastc == '\n' || lastc == '\r';
281  }
282 }
283 
284 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
285  char *line, int line_size, int *print_prefix)
286 {
287  AVBPrint part[4];
288  format_line(ptr, level, fmt, vl, part, print_prefix, NULL);
289  snprintf(line, line_size, "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str);
290  av_bprint_finalize(part+3, NULL);
291 }
292 
293 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
294 {
295  static int print_prefix = 1;
296  static int count;
297  static char prev[LINE_SZ];
298  AVBPrint part[4];
299  char line[LINE_SZ];
300  static int is_atty;
301  int type[2];
302  unsigned tint = 0;
303 
304  if (level >= 0) {
305  tint = level & 0xff00;
306  level &= 0xff;
307  }
308 
309  if (level > av_log_level)
310  return;
311 #if HAVE_PTHREADS
313 #endif
314 
315  format_line(ptr, level, fmt, vl, part, &print_prefix, type);
316  snprintf(line, sizeof(line), "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str);
317 
318 #if HAVE_ISATTY
319  if (!is_atty)
320  is_atty = isatty(2) ? 1 : -1;
321 #endif
322 
323  if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev) &&
324  *line && line[strlen(line) - 1] != '\r'){
325  count++;
326  if (is_atty == 1)
327  fprintf(stderr, " Last message repeated %d times\r", count);
328  goto end;
329  }
330  if (count > 0) {
331  fprintf(stderr, " Last message repeated %d times\n", count);
332  count = 0;
333  }
334  strcpy(prev, line);
335  sanitize(part[0].str);
336  colored_fputs(type[0], 0, part[0].str);
337  sanitize(part[1].str);
338  colored_fputs(type[1], 0, part[1].str);
339  sanitize(part[2].str);
340  colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[2].str);
341  sanitize(part[3].str);
342  colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[3].str);
343 
344 #if CONFIG_VALGRIND_BACKTRACE
345  if (level <= BACKTRACE_LOGLEVEL)
346  VALGRIND_PRINTF_BACKTRACE("");
347 #endif
348 end:
349  av_bprint_finalize(part+3, NULL);
350 #if HAVE_PTHREADS
352 #endif
353 }
354 
355 static void (*av_log_callback)(void*, int, const char*, va_list) =
357 
358 void av_log(void* avcl, int level, const char *fmt, ...)
359 {
360  AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
361  va_list vl;
362  va_start(vl, fmt);
363  if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
364  avc->log_level_offset_offset && level >= AV_LOG_FATAL)
365  level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
366  av_vlog(avcl, level, fmt, vl);
367  va_end(vl);
368 }
369 
370 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
371 {
372  void (*log_callback)(void*, int, const char*, va_list) = av_log_callback;
373  if (log_callback)
374  log_callback(avcl, level, fmt, vl);
375 }
376 
378 {
379  return av_log_level;
380 }
381 
383 {
385 }
386 
388 {
389  flags = arg;
390 }
391 
393 {
394  return flags;
395 }
396 
397 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
398 {
400 }
401 
402 static void missing_feature_sample(int sample, void *avc, const char *msg,
403  va_list argument_list)
404 {
405  av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
406  av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg "
407  "version to the newest one from Git. If the problem still "
408  "occurs, it means that your file has a feature which has not "
409  "been implemented.\n");
410  if (sample)
411  av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
412  "of this file to ftp://upload.ffmpeg.org/incoming/ "
413  "and contact the ffmpeg-devel mailing list. (ffmpeg-devel@ffmpeg.org)\n");
414 }
415 
416 void avpriv_request_sample(void *avc, const char *msg, ...)
417 {
418  va_list argument_list;
419 
420  va_start(argument_list, msg);
421  missing_feature_sample(1, avc, msg, argument_list);
422  va_end(argument_list);
423 }
424 
425 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
426 {
427  va_list argument_list;
428 
429  va_start(argument_list, msg);
430  missing_feature_sample(0, avc, msg, argument_list);
431  va_end(argument_list);
432 }
433 
434 #ifdef TEST
435 // LCOV_EXCL_START
436 #include <string.h>
437 
438 int main(int argc, char **argv)
439 {
440  int i;
442  for (use_color=0; use_color<=256; use_color = 255*use_color+1) {
443  av_log(NULL, AV_LOG_FATAL, "use_color: %d\n", use_color);
444  for (i = AV_LOG_DEBUG; i>=AV_LOG_QUIET; i-=8) {
445  av_log(NULL, i, " %d", i);
446  av_log(NULL, AV_LOG_INFO, "e ");
447  av_log(NULL, i + 256*123, "C%d", i);
448  av_log(NULL, AV_LOG_INFO, "e");
449  }
450  av_log(NULL, AV_LOG_PANIC, "\n");
451  }
452  return 0;
453 }
454 // LCOV_EXCL_STOP
455 #endif
#define NULL
Definition: coverity.c:32
void av_bprintf(AVBPrint *buf, const char *fmt,...)
Definition: bprint.c:94
const char * fmt
Definition: avisynth_c.h:632
static const char * get_level_str(int level)
Definition: log.c:224
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
void av_log_set_level(int level)
Set the log level.
Definition: log.c:382
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:193
external API header
#define sample
int av_bprint_finalize(AVBPrint *buf, char **ret_str)
Finalize a print buffer.
Definition: bprint.c:235
#define AV_LOG_QUIET
Print no output.
Definition: log.h:158
HMTX pthread_mutex_t
Definition: os2threads.h:40
static void missing_feature_sample(int sample, void *avc, const char *msg, va_list argument_list)
Definition: log.c:402
uint8_t
#define AV_LOG_PANIC
Something went really wrong and we will crash now.
Definition: log.h:163
#define AV_LOG_TRACE
Extremely verbose debugging, useful for libav* development.
Definition: log.h:202
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
int log_level_offset_offset
Offset in the structure where log_level_offset is stored.
Definition: log.h:99
static void sanitize(uint8_t *line)
Definition: log.c:203
static int flags
Definition: log.c:57
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
static int get_category(void *ptr)
Definition: log.c:211
#define isatty(fd)
Definition: checkasm.c:52
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl, char *line, int line_size, int *print_prefix)
Format a line of log the same way as the default callback.
Definition: log.c:284
static void format_line(void *avcl, int level, const char *fmt, va_list vl, AVBPrint part[4], int *print_prefix, int type[2])
Definition: log.c:248
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
Definition: bprint.c:69
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
const char * arg
Definition: jacosubdec.c:66
Definition: graph2dot.c:48
#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:342
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:358
int av_log_get_level(void)
Get the current log level.
Definition: log.c:377
static int av_log_level
Definition: log.c:56
AVClassCategory category
Category used for visualization (like color) This is only set if the category is equal for all object...
Definition: log.h:130
GLsizei count
Definition: opengl_enc.c:109
void av_log_default_callback(void *ptr, int level, const char *fmt, va_list vl)
Default logging callback.
Definition: log.c:293
common internal API header
static void check_color_terminal(void)
Definition: log.c:125
void avpriv_report_missing_feature(void *avc, const char *msg,...)
Definition: log.c:425
static void callback(void *priv_data, int index, uint8_t *buf, int buf_size, int64_t time, enum dshowDeviceType devtype)
Definition: dshow.c:161
void av_log_set_callback(void(*callback)(void *, int, const char *, va_list))
Set the logging callback.
Definition: log.c:397
not part of ABI/API
Definition: log.h:47
PVOID HANDLE
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
static void(* av_log_callback)(void *, int, const char *, va_list)
Definition: log.c:355
AVClassCategory(* get_category)(void *ctx)
Callback to return the category.
Definition: log.h:136
#define NB_LEVELS
Definition: log.c:59
static pthread_mutex_t * mutex
Definition: w32pthreads.h: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:78
#define AV_LOG_INFO
Standard information.
Definition: log.h:187
int av_log_get_flags(void)
Definition: log.c:392
GLint GLenum type
Definition: opengl_enc.c:105
void av_vbprintf(AVBPrint *buf, const char *fmt, va_list vl_arg)
Append a formatted string to a print buffer.
Definition: bprint.c:117
Describe the class of an AVClass context structure.
Definition: log.h:67
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:370
#define snprintf
Definition: snprintf.h:34
uint8_t level
Definition: svq3.c:150
int version
LIBAVUTIL_VERSION with which this structure was created.
Definition: log.h:93
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:108
static int use_color
Definition: log.c:123
AVClassCategory av_default_get_category(void *ptr)
Definition: log.c:198
AVClassCategory
Definition: log.h:29
static av_always_inline int pthread_mutex_unlock(pthread_mutex_t *mutex)
Definition: os2threads.h:108
void avpriv_request_sample(void *avc, const char *msg,...)
Definition: log.c:416
void av_log_set_flags(int arg)
Definition: log.c:387
#define LINE_SZ
Definition: log.c:48
#define AV_LOG_PRINT_LEVEL
Include the log severity in messages originating from codecs.
Definition: log.h:350
#define AV_LOG_FATAL
Something went wrong and recovery is not possible.
Definition: log.h:170
static av_always_inline int pthread_mutex_lock(pthread_mutex_t *mutex)
Definition: os2threads.h:101
#define INVALID_HANDLE_VALUE
Definition: windows2linux.h:47
int main(int argc, char **argv)
Definition: main.c:22
static void colored_fputs(int level, int tint, const char *str)
Definition: log.c:150