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