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 static void check_color_terminal(void)
 124 {
 125 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
 126     CONSOLE_SCREEN_BUFFER_INFO con_info;
 127     DWORD dummy;
 128     con = GetStdHandle(STD_ERROR_HANDLE);
 129     if (con != INVALID_HANDLE_VALUE && !GetConsoleMode(con, &dummy))
 130         con = INVALID_HANDLE_VALUE;
 131     use_color = (con != INVALID_HANDLE_VALUE) && !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("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("AV_LOG_FORCE_NOCOLOR");
 146 #endif
 147 }
 148
 149 static void ansi_fputs(int level, int tint, const char *str, int local_use_color)
 150 {
 151     if (local_use_color == 1) {
 152         fprintf(stderr,
 153                 "\033[%"PRIu32";3%"PRIu32"m%s\033[0m",
 154                 (color[level] >> 4) & 15,
 155                 color[level] & 15,
 156                 str);
 157     } else if (tint && use_color == 256) {
 158         fprintf(stderr,
 159                 "\033[48;5;%"PRIu32"m\033[38;5;%dm%s\033[0m",
 160                 (color[level] >> 16) & 0xff,
 161                 tint,
 162                 str);
 163     } else if (local_use_color == 256) {
 164         fprintf(stderr,
 165                 "\033[48;5;%"PRIu32"m\033[38;5;%"PRIu32"m%s\033[0m",
 166                 (color[level] >> 16) & 0xff,
 167                 (color[level] >> 8) & 0xff,
 168                 str);
 169     } else
 170         fputs(str, stderr);
 171 }
 172
 173 static void colored_fputs(int level, int tint, const char *str)
 174 {
 175     int local_use_color;
 176     if (!*str)
 177         return;
 178
 179     if (use_color < 0)
 180         check_color_terminal();
 181
 182     if (level == AV_LOG_INFO/8) local_use_color = 0;
 183     else                        local_use_color = use_color;
 184
 185 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE
 186     if (local_use_color)
 187         SetConsoleTextAttribute(con, background | color[level]);
 188     fputs(str, stderr);
 189     if (local_use_color)
 190         SetConsoleTextAttribute(con, attr_orig);
 191 #else
 192     ansi_fputs(level, tint, str, local_use_color);
 193 #endif
 194
 195 }
 196
 197 const char *av_default_item_name(void *ptr)
 198 {
 199     return (*(AVClass **) ptr)->class_name;
 200 }
 201
 202 AVClassCategory av_default_get_category(void *ptr)
 203 {
 204     return (*(AVClass **) ptr)->category;
 205 }
 206
 207 static void sanitize(uint8_t *line){
 208     while(*line){
 209         if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
 210             *line='?';
 211         line++;
 212     }
 213 }
 214
 215 static int get_category(void *ptr){
 216     AVClass *avc = *(AVClass **) ptr;
 217     if(    !avc
 218         || (avc->version&0xFF)<100
 219         ||  avc->version < (51 << 16 | 59 << 8)
 220         ||  avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;
 221
 222     if(avc->get_category)
 223         return avc->get_category(ptr) + 16;
 224
 225     return avc->category + 16;
 226 }
 227
 228 static const char *get_level_str(int level)
 229 {
 230     switch (level) {
 231     case AV_LOG_QUIET:
 232         return "quiet";
 233     case AV_LOG_DEBUG:
 234         return "debug";
 235     case AV_LOG_TRACE:
 236         return "trace";
 237     case AV_LOG_VERBOSE:
 238         return "verbose";
 239     case AV_LOG_INFO:
 240         return "info";
 241     case AV_LOG_WARNING:
 242         return "warning";
 243     case AV_LOG_ERROR:
 244         return "error";
 245     case AV_LOG_FATAL:
 246         return "fatal";
 247     case AV_LOG_PANIC:
 248         return "panic";
 249     default:
 250         return "";
 251     }
 252 }
 253
 254 static void format_line(void *avcl, int level, const char *fmt, va_list vl,
 255                         AVBPrint part[4], int *print_prefix, int type[2])
 256 {
 257     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
 258     av_bprint_init(part+0, 0, AV_BPRINT_SIZE_AUTOMATIC);
 259     av_bprint_init(part+1, 0, AV_BPRINT_SIZE_AUTOMATIC);
 260     av_bprint_init(part+2, 0, AV_BPRINT_SIZE_AUTOMATIC);
 261     av_bprint_init(part+3, 0, 65536);
 262
 263     if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
 264     if (*print_prefix && avc) {
 265         if (avc->parent_log_context_offset) {
 266             AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
 267                                    avc->parent_log_context_offset);
 268             if (parent && *parent) {
 269                 av_bprintf(part+0, "[%s @ %p] ",
 270                          (*parent)->item_name(parent), parent);
 271                 if(type) type[0] = get_category(parent);
 272             }
 273         }
 274         av_bprintf(part+1, "[%s @ %p] ",
 275                  avc->item_name(avcl), avcl);
 276         if(type) type[1] = get_category(avcl);
 277     }
 278
 279     if (*print_prefix && (level > AV_LOG_QUIET) && (flags & AV_LOG_PRINT_LEVEL))
 280         av_bprintf(part+2, "[%s] ", get_level_str(level));
 281
 282     av_vbprintf(part+3, fmt, vl);
 283
 284     if(*part[0].str || *part[1].str || *part[2].str || *part[3].str) {
 285         char lastc = part[3].len && part[3].len <= part[3].size ? part[3].str[part[3].len - 1] : 0;
 286         *print_prefix = lastc == '\n' || lastc == '\r';
 287     }
 288 }
 289
 290 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
 291                         char *line, int line_size, int *print_prefix)
 292 {
 293     av_log_format_line2(ptr, level, fmt, vl, line, line_size, print_prefix);
 294 }
 295
 296 int av_log_format_line2(void *ptr, int level, const char *fmt, va_list vl,
 297                         char *line, int line_size, int *print_prefix)
 298 {
 299     AVBPrint part[4];
 300     int ret;
 301
 302     format_line(ptr, level, fmt, vl, part, print_prefix, NULL);
 303     ret = snprintf(line, line_size, "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str);
 304     av_bprint_finalize(part+3, NULL);
 305     return ret;
 306 }
 307
 308 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
 309 {
 310     static int print_prefix = 1;
 311     static int count;
 312     static char prev[LINE_SZ];
 313     AVBPrint part[4];
 314     char line[LINE_SZ];
 315     static int is_atty;
 316     int type[2];
 317     unsigned tint = 0;
 318
 319     if (level >= 0) {
 320         tint = level & 0xff00;
 321         level &= 0xff;
 322     }
 323
 324     if (level > av_log_level)
 325         return;
 326     ff_mutex_lock(&mutex);
 327
 328     format_line(ptr, level, fmt, vl, part, &print_prefix, type);
 329     snprintf(line, sizeof(line), "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str);
 330
 331 #if HAVE_ISATTY
 332     if (!is_atty)
 333         is_atty = isatty(2) ? 1 : -1;
 334 #endif
 335
 336     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev) &&
 337         *line && line[strlen(line) - 1] != '\r'){
 338         count++;
 339         if (is_atty == 1)
 340             fprintf(stderr, "    Last message repeated %d times\r", count);
 341         goto end;
 342     }
 343     if (count > 0) {
 344         fprintf(stderr, "    Last message repeated %d times\n", count);
 345         count = 0;
 346     }
 347     strcpy(prev, line);
 348     sanitize(part[0].str);
 349     colored_fputs(type[0], 0, part[0].str);
 350     sanitize(part[1].str);
 351     colored_fputs(type[1], 0, part[1].str);
 352     sanitize(part[2].str);
 353     colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[2].str);
 354     sanitize(part[3].str);
 355     colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[3].str);
 356
 357 #if CONFIG_VALGRIND_BACKTRACE
 358     if (level <= BACKTRACE_LOGLEVEL)
 359         VALGRIND_PRINTF_BACKTRACE("%s", "");
 360 #endif
 361 end:
 362     av_bprint_finalize(part+3, NULL);
 363     ff_mutex_unlock(&mutex);
 364 }
 365
 366 static void (*av_log_callback)(void*, int, const char*, va_list) =
 367     av_log_default_callback;
 368
 369 void av_log(void* avcl, int level, const char *fmt, ...)
 370 {
 371     va_list vl;
 372     va_start(vl, fmt);
 373     av_vlog(avcl, level, fmt, vl);
 374     va_end(vl);
 375 }
 376
 377 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
 378 {
 379     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
 380     void (*log_callback)(void*, int, const char*, va_list) = av_log_callback;
 381     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
 382         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
 383         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
 384     if (log_callback)
 385         log_callback(avcl, level, fmt, vl);
 386 }
 387
 388 int av_log_get_level(void)
 389 {
 390     return av_log_level;
 391 }
 392
 393 void av_log_set_level(int level)
 394 {
 395     av_log_level = level;
 396 }
 397
 398 void av_log_set_flags(int arg)
 399 {
 400     flags = arg;
 401 }
 402
 403 int av_log_get_flags(void)
 404 {
 405     return flags;
 406 }
 407
 408 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
 409 {
 410     av_log_callback = callback;
 411 }
 412
 413 static void missing_feature_sample(int sample, void *avc, const char *msg,
 414                                    va_list argument_list)
 415 {
 416     av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
 417     av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg "
 418            "version to the newest one from Git. If the problem still "
 419            "occurs, it means that your file has a feature which has not "
 420            "been implemented.\n");
 421     if (sample)
 422         av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
 423                "of this file to ftp://upload.ffmpeg.org/incoming/ "
 424                "and contact the ffmpeg-devel mailing list. (ffmpeg-devel@ffmpeg.org)\n");
 425 }
 426
 427 void avpriv_request_sample(void *avc, const char *msg, ...)
 428 {
 429     va_list argument_list;
 430
 431     va_start(argument_list, msg);
 432     missing_feature_sample(1, avc, msg, argument_list);
 433     va_end(argument_list);
 434 }
 435
 436 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
 437 {
 438     va_list argument_list;
 439
 440     va_start(argument_list, msg);
 441     missing_feature_sample(0, avc, msg, argument_list);
 442     va_end(argument_list);
 443 }