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