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