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 <unistd.h>
  28 #include <stdlib.h>
  29 #include "avutil.h"
  30 #include "log.h"
  31
  32 #define LINE_SZ 1024
  33
  34 static int av_log_level = AV_LOG_INFO;
  35 static int flags;
  36
  37 #if defined(_WIN32) && !defined(__MINGW32CE__)
  38 #include <windows.h>
  39 static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
  40     [AV_LOG_PANIC  /8] = 12,
  41     [AV_LOG_FATAL  /8] = 12,
  42     [AV_LOG_ERROR  /8] = 12,
  43     [AV_LOG_WARNING/8] = 14,
  44     [AV_LOG_INFO   /8] =  7,
  45     [AV_LOG_VERBOSE/8] = 10,
  46     [AV_LOG_DEBUG  /8] = 10,
  47     [16+AV_CLASS_CATEGORY_NA              ] =  7,
  48     [16+AV_CLASS_CATEGORY_INPUT           ] = 13,
  49     [16+AV_CLASS_CATEGORY_OUTPUT          ] =  5,
  50     [16+AV_CLASS_CATEGORY_MUXER           ] = 13,
  51     [16+AV_CLASS_CATEGORY_DEMUXER         ] =  5,
  52     [16+AV_CLASS_CATEGORY_ENCODER         ] = 11,
  53     [16+AV_CLASS_CATEGORY_DECODER         ] =  3,
  54     [16+AV_CLASS_CATEGORY_FILTER          ] =  1,
  55     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] =  9,
  56 };
  57
  58 static int16_t background, attr_orig;
  59 static HANDLE con;
  60 #define set_color(x)  SetConsoleTextAttribute(con, background | color[x])
  61 #define reset_color() SetConsoleTextAttribute(con, attr_orig)
  62 #else
  63
  64 static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
  65     [AV_LOG_PANIC  /8] = 0x41,
  66     [AV_LOG_FATAL  /8] = 0x41,
  67     [AV_LOG_ERROR  /8] = 0x11,
  68     [AV_LOG_WARNING/8] = 0x03,
  69     [AV_LOG_INFO   /8] =    9,
  70     [AV_LOG_VERBOSE/8] = 0x02,
  71     [AV_LOG_DEBUG  /8] = 0x02,
  72     [16+AV_CLASS_CATEGORY_NA              ] =    9,
  73     [16+AV_CLASS_CATEGORY_INPUT           ] = 0x15,
  74     [16+AV_CLASS_CATEGORY_OUTPUT          ] = 0x05,
  75     [16+AV_CLASS_CATEGORY_MUXER           ] = 0x15,
  76     [16+AV_CLASS_CATEGORY_DEMUXER         ] = 0x05,
  77     [16+AV_CLASS_CATEGORY_ENCODER         ] = 0x16,
  78     [16+AV_CLASS_CATEGORY_DECODER         ] = 0x06,
  79     [16+AV_CLASS_CATEGORY_FILTER          ] = 0x04,
  80     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 0x14,
  81 };
  82
  83 #define set_color(x)  fprintf(stderr, "\033[%d;3%dm", color[x] >> 4, color[x]&15)
  84 #define reset_color() fprintf(stderr, "\033[0m")
  85 #endif
  86 static int use_color = -1;
  87
  88 #undef fprintf
  89 static void colored_fputs(int level, const char *str)
  90 {
  91     if (use_color < 0) {
  92 #if defined(_WIN32) && !defined(__MINGW32CE__)
  93         CONSOLE_SCREEN_BUFFER_INFO con_info;
  94         con = GetStdHandle(STD_ERROR_HANDLE);
  95         use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
  96                     !getenv("AV_LOG_FORCE_NOCOLOR");
  97         if (use_color) {
  98             GetConsoleScreenBufferInfo(con, &con_info);
  99             attr_orig  = con_info.wAttributes;
 100             background = attr_orig & 0xF0;
 101         }
 102 #elif HAVE_ISATTY
 103         use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
 104                     (getenv("TERM") && isatty(2) ||
 105                      getenv("AV_LOG_FORCE_COLOR"));
 106 #else
 107         use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
 108                    !getenv("AV_LOG_FORCE_NOCOLOR");
 109 #endif
 110     }
 111
 112     if (use_color) {
 113         set_color(level);
 114     }
 115     fputs(str, stderr);
 116     if (use_color) {
 117         reset_color();
 118     }
 119 }
 120
 121 const char *av_default_item_name(void *ptr)
 122 {
 123     return (*(AVClass **) ptr)->class_name;
 124 }
 125
 126 AVClassCategory av_default_get_category(void *ptr)
 127 {
 128     return (*(AVClass **) ptr)->category;
 129 }
 130
 131 static void sanitize(uint8_t *line){
 132     while(*line){
 133         if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
 134             *line='?';
 135         line++;
 136     }
 137 }
 138
 139 static int get_category(void *ptr){
 140     AVClass *avc = *(AVClass **) ptr;
 141     if(    !avc
 142         || (avc->version&0xFF)<100
 143         ||  avc->version < (51 << 16 | 59 << 8)
 144         ||  avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;
 145
 146     if(avc->get_category)
 147         return avc->get_category(ptr) + 16;
 148
 149     return avc->category + 16;
 150 }
 151
 152 static void format_line(void *ptr, int level, const char *fmt, va_list vl,
 153                         char part[3][LINE_SZ], int part_size, int *print_prefix, int type[2])
 154 {
 155     AVClass* avc = ptr ? *(AVClass **) ptr : NULL;
 156     part[0][0] = part[1][0] = part[2][0] = 0;
 157     if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
 158     if (*print_prefix && avc) {
 159         if (avc->parent_log_context_offset) {
 160             AVClass** parent = *(AVClass ***) (((uint8_t *) ptr) +
 161                                    avc->parent_log_context_offset);
 162             if (parent && *parent) {
 163                 snprintf(part[0], part_size, "[%s @ %p] ",
 164                          (*parent)->item_name(parent), parent);
 165                 if(type) type[0] = get_category(((uint8_t *) ptr) + avc->parent_log_context_offset);
 166             }
 167         }
 168         snprintf(part[1], part_size, "[%s @ %p] ",
 169                  avc->item_name(ptr), ptr);
 170         if(type) type[1] = get_category(ptr);
 171     }
 172
 173     vsnprintf(part[2], part_size, fmt, vl);
 174
 175     *print_prefix = strlen(part[2]) && part[2][strlen(part[2]) - 1] == '\n';
 176 }
 177
 178 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
 179                         char *line, int line_size, int *print_prefix)
 180 {
 181     char part[3][LINE_SZ];
 182     format_line(ptr, level, fmt, vl, part, sizeof(part[0]), print_prefix, NULL);
 183     snprintf(line, line_size, "%s%s%s", part[0], part[1], part[2]);
 184 }
 185
 186 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
 187 {
 188     static int print_prefix = 1;
 189     static int count;
 190     static char prev[LINE_SZ];
 191     char part[3][LINE_SZ];
 192     char line[LINE_SZ];
 193     static int is_atty;
 194     int type[2];
 195
 196     if (level > av_log_level)
 197         return;
 198     format_line(ptr, level, fmt, vl, part, sizeof(part[0]), &print_prefix, type);
 199     snprintf(line, sizeof(line), "%s%s%s", part[0], part[1], part[2]);
 200
 201 #if HAVE_ISATTY
 202     if (!is_atty)
 203         is_atty = isatty(2) ? 1 : -1;
 204 #endif
 205
 206 #undef fprintf
 207     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev)){
 208         count++;
 209         if (is_atty == 1)
 210             fprintf(stderr, "    Last message repeated %d times\r", count);
 211         return;
 212     }
 213     if (count > 0) {
 214         fprintf(stderr, "    Last message repeated %d times\n", count);
 215         count = 0;
 216     }
 217     strcpy(prev, line);
 218     sanitize(part[0]);
 219     colored_fputs(type[0], part[0]);
 220     sanitize(part[1]);
 221     colored_fputs(type[1], part[1]);
 222     sanitize(part[2]);
 223     colored_fputs(av_clip(level >> 3, 0, 6), part[2]);
 224 }
 225
 226 static void (*av_log_callback)(void*, int, const char*, va_list) =
 227     av_log_default_callback;
 228
 229 void av_log(void* avcl, int level, const char *fmt, ...)
 230 {
 231     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
 232     va_list vl;
 233     va_start(vl, fmt);
 234     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
 235         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
 236         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
 237     av_vlog(avcl, level, fmt, vl);
 238     va_end(vl);
 239 }
 240
 241 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
 242 {
 243     if(av_log_callback)
 244         av_log_callback(avcl, level, fmt, vl);
 245 }
 246
 247 int av_log_get_level(void)
 248 {
 249     return av_log_level;
 250 }
 251
 252 void av_log_set_level(int level)
 253 {
 254     av_log_level = level;
 255 }
 256
 257 void av_log_set_flags(int arg)
 258 {
 259     flags = arg;
 260 }
 261
 262 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
 263 {
 264     av_log_callback = callback;
 265 }