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