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