git.sesse.net Git - ffmpeg/blob - 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 #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 #include "thread.h"
  43
  44 static AVMutex mutex = AV_MUTEX_INITIALIZER;
  45
  46 #define LINE_SZ 1024
  47
  48 #if HAVE_VALGRIND_VALGRIND_H
  49 #include <valgrind/valgrind.h>
  50 /* this is the log level at which valgrind will output a full backtrace */
  51 #define BACKTRACE_LOGLEVEL AV_LOG_ERROR
  52 #endif
  53
  54 static int av_log_level = AV_LOG_INFO;
  55 static int flags;
  56
  57 #define NB_LEVELS 8
  58 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
  59 #include <windows.h>
  60 static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
  61     [AV_LOG_PANIC  /8] = 12,
  62     [AV_LOG_FATAL  /8] = 12,
  63     [AV_LOG_ERROR  /8] = 12,
  64     [AV_LOG_WARNING/8] = 14,
  65     [AV_LOG_INFO   /8] =  7,
  66     [AV_LOG_VERBOSE/8] = 10,
  67     [AV_LOG_DEBUG  /8] = 10,
  68     [AV_LOG_TRACE  /8] = 8,
  69     [16+AV_CLASS_CATEGORY_NA              ] =  7,
  70     [16+AV_CLASS_CATEGORY_INPUT           ] = 13,
  71     [16+AV_CLASS_CATEGORY_OUTPUT          ] =  5,
  72     [16+AV_CLASS_CATEGORY_MUXER           ] = 13,
  73     [16+AV_CLASS_CATEGORY_DEMUXER         ] =  5,
  74     [16+AV_CLASS_CATEGORY_ENCODER         ] = 11,
  75     [16+AV_CLASS_CATEGORY_DECODER         ] =  3,
  76     [16+AV_CLASS_CATEGORY_FILTER          ] = 10,
  77     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] =  9,
  78     [16+AV_CLASS_CATEGORY_SWSCALER        ] =  7,
  79     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] =  7,
  80     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 13,
  81     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT  ] = 5,
  82     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 13,
  83     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT  ] = 5,
  84     [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT       ] = 13,
  85     [16+AV_CLASS_CATEGORY_DEVICE_INPUT        ] = 5,
  86 };
  87
  88 static int16_t background, attr_orig;
  89 static HANDLE con;
  90 #else
  91
  92 static const uint32_t color[16 + AV_CLASS_CATEGORY_NB] = {
  93     [AV_LOG_PANIC  /8] =  52 << 16 | 196 << 8 | 0x41,
  94     [AV_LOG_FATAL  /8] = 208 <<  8 | 0x41,
  95     [AV_LOG_ERROR  /8] = 196 <<  8 | 0x11,
  96     [AV_LOG_WARNING/8] = 226 <<  8 | 0x03,
  97     [AV_LOG_INFO   /8] = 253 <<  8 | 0x09,
  98     [AV_LOG_VERBOSE/8] =  40 <<  8 | 0x02,
  99     [AV_LOG_DEBUG  /8] =  34 <<  8 | 0x02,
 100     [AV_LOG_TRACE  /8] =  34 <<  8 | 0x07,
 101     [16+AV_CLASS_CATEGORY_NA              ] = 250 << 8 | 0x09,
 102     [16+AV_CLASS_CATEGORY_INPUT           ] = 219 << 8 | 0x15,
 103     [16+AV_CLASS_CATEGORY_OUTPUT          ] = 201 << 8 | 0x05,
 104     [16+AV_CLASS_CATEGORY_MUXER           ] = 213 << 8 | 0x15,
 105     [16+AV_CLASS_CATEGORY_DEMUXER         ] = 207 << 8 | 0x05,
 106     [16+AV_CLASS_CATEGORY_ENCODER         ] =  51 << 8 | 0x16,
 107     [16+AV_CLASS_CATEGORY_DECODER         ] =  39 << 8 | 0x06,
 108     [16+AV_CLASS_CATEGORY_FILTER          ] = 155 << 8 | 0x12,
 109     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 192 << 8 | 0x14,
 110     [16+AV_CLASS_CATEGORY_SWSCALER        ] = 153 << 8 | 0x14,
 111     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] = 147 << 8 | 0x14,
 112     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 213 << 8 | 0x15,
 113     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT  ] = 207 << 8 | 0x05,
 114     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 213 << 8 | 0x15,
 115     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT  ] = 207 << 8 | 0x05,
 116     [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT       ] = 213 << 8 | 0x15,
 117     [16+AV_CLASS_CATEGORY_DEVICE_INPUT        ] = 207 << 8 | 0x05,
 118 };
 119
 120 #endif
 121 static int use_color = -1;
 122
 123 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
 124 static void win_console_puts(const char *str)
 125 {
 126     const uint8_t *q = str;
 127     uint16_t line[LINE_SZ];
 128
 129     while (*q) {
 130         uint16_t *buf = line;
 131         DWORD nb_chars = 0;
 132         DWORD written;
 133
 134         while (*q && nb_chars < LINE_SZ - 1) {
 135             uint32_t ch;
 136             uint16_t tmp;
 137
 138             GET_UTF8(ch, *q ? *q++ : 0, ch = 0xfffd; goto continue_on_invalid;)
 139 continue_on_invalid:
 140             PUT_UTF16(ch, tmp, *buf++ = tmp; nb_chars++;)
 141         }
 142
 143         WriteConsoleW(con, line, nb_chars, &written, NULL);
 144     }
 145 }
 146 #endif
 147
 148 static void check_color_terminal(void)
 149 {
 150     char *term = getenv("TERM");
 151
 152 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
 153     CONSOLE_SCREEN_BUFFER_INFO con_info;
 154     DWORD dummy;
 155     con = GetStdHandle(STD_ERROR_HANDLE);
 156     if (con != INVALID_HANDLE_VALUE && !GetConsoleMode(con, &dummy))
 157         con = INVALID_HANDLE_VALUE;
 158     if (con != INVALID_HANDLE_VALUE) {
 159         GetConsoleScreenBufferInfo(con, &con_info);
 160         attr_orig  = con_info.wAttributes;
 161         background = attr_orig & 0xF0;
 162     }
 163 #endif
 164
 165     if (getenv("AV_LOG_FORCE_NOCOLOR")) {
 166         use_color = 0;
 167     } else if (getenv("AV_LOG_FORCE_COLOR")) {
 168         use_color = 1;
 169     } else {
 170 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
 171         use_color = (con != INVALID_HANDLE_VALUE);
 172 #elif HAVE_ISATTY
 173         use_color = (term && isatty(2));
 174 #else
 175         use_color = 0;
 176 #endif
 177     }
 178
 179     if (getenv("AV_LOG_FORCE_256COLOR") || term && strstr(term, "256color"))
 180         use_color *= 256;
 181 }
 182
 183 static void ansi_fputs(int level, int tint, const char *str, int local_use_color)
 184 {
 185     if (local_use_color == 1) {
 186         fprintf(stderr,
 187                 "\033[%"PRIu32";3%"PRIu32"m%s\033[0m",
 188                 (color[level] >> 4) & 15,
 189                 color[level] & 15,
 190                 str);
 191     } else if (tint && use_color == 256) {
 192         fprintf(stderr,
 193                 "\033[48;5;%"PRIu32"m\033[38;5;%dm%s\033[0m",
 194                 (color[level] >> 16) & 0xff,
 195                 tint,
 196                 str);
 197     } else if (local_use_color == 256) {
 198         fprintf(stderr,
 199                 "\033[48;5;%"PRIu32"m\033[38;5;%"PRIu32"m%s\033[0m",
 200                 (color[level] >> 16) & 0xff,
 201                 (color[level] >> 8) & 0xff,
 202                 str);
 203     } else
 204         fputs(str, stderr);
 205 }
 206
 207 static void colored_fputs(int level, int tint, const char *str)
 208 {
 209     int local_use_color;
 210     if (!*str)
 211         return;
 212
 213     if (use_color < 0)
 214         check_color_terminal();
 215
 216     if (level == AV_LOG_INFO/8) local_use_color = 0;
 217     else                        local_use_color = use_color;
 218
 219 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
 220     if (con != INVALID_HANDLE_VALUE) {
 221         if (local_use_color)
 222             SetConsoleTextAttribute(con, background | color[level]);
 223         win_console_puts(str);
 224         if (local_use_color)
 225             SetConsoleTextAttribute(con, attr_orig);
 226     } else {
 227         ansi_fputs(level, tint, str, local_use_color);
 228     }
 229 #else
 230     ansi_fputs(level, tint, str, local_use_color);
 231 #endif
 232
 233 }
 234
 235 const char *av_default_item_name(void *ptr)
 236 {
 237     return (*(AVClass **) ptr)->class_name;
 238 }
 239
 240 AVClassCategory av_default_get_category(void *ptr)
 241 {
 242     return (*(AVClass **) ptr)->category;
 243 }
 244
 245 static void sanitize(uint8_t *line){
 246     while(*line){
 247         if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
 248             *line='?';
 249         line++;
 250     }
 251 }
 252
 253 static int get_category(void *ptr){
 254     AVClass *avc = *(AVClass **) ptr;
 255     if(    !avc
 256         || (avc->version&0xFF)<100
 257         ||  avc->version < (51 << 16 | 59 << 8)
 258         ||  avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;
 259
 260     if(avc->get_category)
 261         return avc->get_category(ptr) + 16;
 262
 263     return avc->category + 16;
 264 }
 265
 266 static const char *get_level_str(int level)
 267 {
 268     switch (level) {
 269     case AV_LOG_QUIET:
 270         return "quiet";
 271     case AV_LOG_DEBUG:
 272         return "debug";
 273     case AV_LOG_TRACE:
 274         return "trace";
 275     case AV_LOG_VERBOSE:
 276         return "verbose";
 277     case AV_LOG_INFO:
 278         return "info";
 279     case AV_LOG_WARNING:
 280         return "warning";
 281     case AV_LOG_ERROR:
 282         return "error";
 283     case AV_LOG_FATAL:
 284         return "fatal";
 285     case AV_LOG_PANIC:
 286         return "panic";
 287     default:
 288         return "";
 289     }
 290 }
 291
 292 static void format_line(void *avcl, int level, const char *fmt, va_list vl,
 293                         AVBPrint part[4], int *print_prefix, int type[2])
 294 {
 295     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
 296     av_bprint_init(part+0, 0, AV_BPRINT_SIZE_AUTOMATIC);
 297     av_bprint_init(part+1, 0, AV_BPRINT_SIZE_AUTOMATIC);
 298     av_bprint_init(part+2, 0, AV_BPRINT_SIZE_AUTOMATIC);
 299     av_bprint_init(part+3, 0, 65536);
 300
 301     if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
 302     if (*print_prefix && avc) {
 303         if (avc->parent_log_context_offset) {
 304             AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
 305                                    avc->parent_log_context_offset);
 306             if (parent && *parent) {
 307                 av_bprintf(part+0, "[%s @ %p] ",
 308                          (*parent)->item_name(parent), parent);
 309                 if(type) type[0] = get_category(parent);
 310             }
 311         }
 312         av_bprintf(part+1, "[%s @ %p] ",
 313                  avc->item_name(avcl), avcl);
 314         if(type) type[1] = get_category(avcl);
 315     }
 316
 317     if (*print_prefix && (level > AV_LOG_QUIET) && (flags & AV_LOG_PRINT_LEVEL))
 318         av_bprintf(part+2, "[%s] ", get_level_str(level));
 319
 320     av_vbprintf(part+3, fmt, vl);
 321
 322     if(*part[0].str || *part[1].str || *part[2].str || *part[3].str) {
 323         char lastc = part[3].len && part[3].len <= part[3].size ? part[3].str[part[3].len - 1] : 0;
 324         *print_prefix = lastc == '\n' || lastc == '\r';
 325     }
 326 }
 327
 328 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
 329                         char *line, int line_size, int *print_prefix)
 330 {
 331     av_log_format_line2(ptr, level, fmt, vl, line, line_size, print_prefix);
 332 }
 333
 334 int av_log_format_line2(void *ptr, int level, const char *fmt, va_list vl,
 335                         char *line, int line_size, int *print_prefix)
 336 {
 337     AVBPrint part[4];
 338     int ret;
 339
 340     format_line(ptr, level, fmt, vl, part, print_prefix, NULL);
 341     ret = snprintf(line, line_size, "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str);
 342     av_bprint_finalize(part+3, NULL);
 343     return ret;
 344 }
 345
 346 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
 347 {
 348     static int print_prefix = 1;
 349     static int count;
 350     static char prev[LINE_SZ];
 351     AVBPrint part[4];
 352     char line[LINE_SZ];
 353     static int is_atty;
 354     int type[2];
 355     unsigned tint = 0;
 356
 357     if (level >= 0) {
 358         tint = level & 0xff00;
 359         level &= 0xff;
 360     }
 361
 362     if (level > av_log_level)
 363         return;
 364     ff_mutex_lock(&mutex);
 365
 366     format_line(ptr, level, fmt, vl, part, &print_prefix, type);
 367     snprintf(line, sizeof(line), "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str);
 368
 369 #if HAVE_ISATTY
 370     if (!is_atty)
 371         is_atty = isatty(2) ? 1 : -1;
 372 #endif
 373
 374     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev) &&
 375         *line && line[strlen(line) - 1] != '\r'){
 376         count++;
 377         if (is_atty == 1)
 378             fprintf(stderr, "    Last message repeated %d times\r", count);
 379         goto end;
 380     }
 381     if (count > 0) {
 382         fprintf(stderr, "    Last message repeated %d times\n", count);
 383         count = 0;
 384     }
 385     strcpy(prev, line);
 386     sanitize(part[0].str);
 387     colored_fputs(type[0], 0, part[0].str);
 388     sanitize(part[1].str);
 389     colored_fputs(type[1], 0, part[1].str);
 390     sanitize(part[2].str);
 391     colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[2].str);
 392     sanitize(part[3].str);
 393     colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[3].str);
 394
 395 #if CONFIG_VALGRIND_BACKTRACE
 396     if (level <= BACKTRACE_LOGLEVEL)
 397         VALGRIND_PRINTF_BACKTRACE("%s", "");
 398 #endif
 399 end:
 400     av_bprint_finalize(part+3, NULL);
 401     ff_mutex_unlock(&mutex);
 402 }
 403
 404 static void (*av_log_callback)(void*, int, const char*, va_list) =
 405     av_log_default_callback;
 406
 407 void av_log(void* avcl, int level, const char *fmt, ...)
 408 {
 409     va_list vl;
 410     va_start(vl, fmt);
 411     av_vlog(avcl, level, fmt, vl);
 412     va_end(vl);
 413 }
 414
 415 void av_log_once(void* avcl, int initial_level, int subsequent_level, int *state, const char *fmt, ...)
 416 {
 417     va_list vl;
 418     va_start(vl, fmt);
 419     av_vlog(avcl, *state ? subsequent_level : initial_level, fmt, vl);
 420     va_end(vl);
 421     *state = 1;
 422 }
 423
 424 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
 425 {
 426     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
 427     void (*log_callback)(void*, int, const char*, va_list) = av_log_callback;
 428     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
 429         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
 430         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
 431     if (log_callback)
 432         log_callback(avcl, level, fmt, vl);
 433 }
 434
 435 int av_log_get_level(void)
 436 {
 437     return av_log_level;
 438 }
 439
 440 void av_log_set_level(int level)
 441 {
 442     av_log_level = level;
 443 }
 444
 445 void av_log_set_flags(int arg)
 446 {
 447     flags = arg;
 448 }
 449
 450 int av_log_get_flags(void)
 451 {
 452     return flags;
 453 }
 454
 455 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
 456 {
 457     av_log_callback = callback;
 458 }
 459
 460 static void missing_feature_sample(int sample, void *avc, const char *msg,
 461                                    va_list argument_list)
 462 {
 463     av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
 464     av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg "
 465            "version to the newest one from Git. If the problem still "
 466            "occurs, it means that your file has a feature which has not "
 467            "been implemented.\n");
 468     if (sample)
 469         av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
 470                "of this file to https://streams.videolan.org/upload/ "
 471                "and contact the ffmpeg-devel mailing list. (ffmpeg-devel@ffmpeg.org)\n");
 472 }
 473
 474 void avpriv_request_sample(void *avc, const char *msg, ...)
 475 {
 476     va_list argument_list;
 477
 478     va_start(argument_list, msg);
 479     missing_feature_sample(1, avc, msg, argument_list);
 480     va_end(argument_list);
 481 }
 482
 483 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
 484 {
 485     va_list argument_list;
 486
 487     va_start(argument_list, msg);
 488     missing_feature_sample(0, avc, msg, argument_list);
 489     va_end(argument_list);
 490 }