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 #if HAVE_PTHREADS
  44 #include <pthread.h>
  45 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  46 #endif
  47
  48 #define LINE_SZ 1024
  49
  50 static int av_log_level = AV_LOG_INFO;
  51 static int flags;
  52
  53 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
  54 #include <windows.h>
  55 static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
  56     [AV_LOG_PANIC  /8] = 12,
  57     [AV_LOG_FATAL  /8] = 12,
  58     [AV_LOG_ERROR  /8] = 12,
  59     [AV_LOG_WARNING/8] = 14,
  60     [AV_LOG_INFO   /8] =  7,
  61     [AV_LOG_VERBOSE/8] = 10,
  62     [AV_LOG_DEBUG  /8] = 10,
  63     [16+AV_CLASS_CATEGORY_NA              ] =  7,
  64     [16+AV_CLASS_CATEGORY_INPUT           ] = 13,
  65     [16+AV_CLASS_CATEGORY_OUTPUT          ] =  5,
  66     [16+AV_CLASS_CATEGORY_MUXER           ] = 13,
  67     [16+AV_CLASS_CATEGORY_DEMUXER         ] =  5,
  68     [16+AV_CLASS_CATEGORY_ENCODER         ] = 11,
  69     [16+AV_CLASS_CATEGORY_DECODER         ] =  3,
  70     [16+AV_CLASS_CATEGORY_FILTER          ] = 10,
  71     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] =  9,
  72     [16+AV_CLASS_CATEGORY_SWSCALER        ] =  7,
  73     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] =  7,
  74     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 13,
  75     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT  ] = 5,
  76     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 13,
  77     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT  ] = 5,
  78     [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT       ] = 13,
  79     [16+AV_CLASS_CATEGORY_DEVICE_INPUT        ] = 5,
  80 };
  81
  82 static int16_t background, attr_orig;
  83 static HANDLE con;
  84 #else
  85
  86 static const uint32_t color[16 + AV_CLASS_CATEGORY_NB] = {
  87     [AV_LOG_PANIC  /8] =  52 << 16 | 196 << 8 | 0x41,
  88     [AV_LOG_FATAL  /8] = 208 <<  8 | 0x41,
  89     [AV_LOG_ERROR  /8] = 196 <<  8 | 0x11,
  90     [AV_LOG_WARNING/8] = 226 <<  8 | 0x03,
  91     [AV_LOG_INFO   /8] = 253 <<  8 | 0x09,
  92     [AV_LOG_VERBOSE/8] =  40 <<  8 | 0x02,
  93     [AV_LOG_DEBUG  /8] =  34 <<  8 | 0x02,
  94     [16+AV_CLASS_CATEGORY_NA              ] = 250 << 8 | 0x09,
  95     [16+AV_CLASS_CATEGORY_INPUT           ] = 219 << 8 | 0x15,
  96     [16+AV_CLASS_CATEGORY_OUTPUT          ] = 201 << 8 | 0x05,
  97     [16+AV_CLASS_CATEGORY_MUXER           ] = 213 << 8 | 0x15,
  98     [16+AV_CLASS_CATEGORY_DEMUXER         ] = 207 << 8 | 0x05,
  99     [16+AV_CLASS_CATEGORY_ENCODER         ] =  51 << 8 | 0x16,
 100     [16+AV_CLASS_CATEGORY_DECODER         ] =  39 << 8 | 0x06,
 101     [16+AV_CLASS_CATEGORY_FILTER          ] = 155 << 8 | 0x12,
 102     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 192 << 8 | 0x14,
 103     [16+AV_CLASS_CATEGORY_SWSCALER        ] = 153 << 8 | 0x14,
 104     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] = 147 << 8 | 0x14,
 105     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 213 << 8 | 0x15,
 106     [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT  ] = 207 << 8 | 0x05,
 107     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 213 << 8 | 0x15,
 108     [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT  ] = 207 << 8 | 0x05,
 109     [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT       ] = 213 << 8 | 0x15,
 110     [16+AV_CLASS_CATEGORY_DEVICE_INPUT        ] = 207 << 8 | 0x05,
 111 };
 112
 113 #endif
 114 static int use_color = -1;
 115
 116 static void check_color_terminal(void)
 117 {
 118 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
 119     CONSOLE_SCREEN_BUFFER_INFO con_info;
 120     con = GetStdHandle(STD_ERROR_HANDLE);
 121     use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
 122                 !getenv("AV_LOG_FORCE_NOCOLOR");
 123     if (use_color) {
 124         GetConsoleScreenBufferInfo(con, &con_info);
 125         attr_orig  = con_info.wAttributes;
 126         background = attr_orig & 0xF0;
 127     }
 128 #elif HAVE_ISATTY
 129     char *term = getenv("TERM");
 130     use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
 131                 (getenv("TERM") && isatty(2) || getenv("AV_LOG_FORCE_COLOR"));
 132     if (   getenv("AV_LOG_FORCE_256COLOR")
 133         || (term && strstr(term, "256color")))
 134         use_color *= 256;
 135 #else
 136     use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
 137                !getenv("AV_LOG_FORCE_NOCOLOR");
 138 #endif
 139 }
 140
 141 static void colored_fputs(int level, int tint, const char *str)
 142 {
 143     int local_use_color;
 144     if (!*str)
 145         return;
 146
 147     if (use_color < 0)
 148         check_color_terminal();
 149
 150     if (level == AV_LOG_INFO/8) local_use_color = 0;
 151     else                        local_use_color = use_color;
 152
 153 #if defined(_WIN32) && !defined(__MINGW32CE__) && HAVE_SETCONSOLETEXTATTRIBUTE
 154     if (local_use_color)
 155         SetConsoleTextAttribute(con, background | color[level]);
 156     fputs(str, stderr);
 157     if (local_use_color)
 158         SetConsoleTextAttribute(con, attr_orig);
 159 #else
 160     if (local_use_color == 1) {
 161         fprintf(stderr,
 162                 "\033[%d;3%dm%s\033[0m",
 163                 (color[level] >> 4) & 15,
 164                 color[level] & 15,
 165                 str);
 166     } else if (tint && use_color == 256) {
 167         fprintf(stderr,
 168                 "\033[48;5;%dm\033[38;5;%dm%s\033[0m",
 169                 (color[level] >> 16) & 0xff,
 170                 tint,
 171                 str);
 172     } else if (local_use_color == 256) {
 173         fprintf(stderr,
 174                 "\033[48;5;%dm\033[38;5;%dm%s\033[0m",
 175                 (color[level] >> 16) & 0xff,
 176                 (color[level] >> 8) & 0xff,
 177                 str);
 178     } else
 179         fputs(str, stderr);
 180 #endif
 181
 182 }
 183
 184 const char *av_default_item_name(void *ptr)
 185 {
 186     return (*(AVClass **) ptr)->class_name;
 187 }
 188
 189 AVClassCategory av_default_get_category(void *ptr)
 190 {
 191     return (*(AVClass **) ptr)->category;
 192 }
 193
 194 static void sanitize(uint8_t *line){
 195     while(*line){
 196         if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
 197             *line='?';
 198         line++;
 199     }
 200 }
 201
 202 static int get_category(void *ptr){
 203     AVClass *avc = *(AVClass **) ptr;
 204     if(    !avc
 205         || (avc->version&0xFF)<100
 206         ||  avc->version < (51 << 16 | 59 << 8)
 207         ||  avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;
 208
 209     if(avc->get_category)
 210         return avc->get_category(ptr) + 16;
 211
 212     return avc->category + 16;
 213 }
 214
 215 static void format_line(void *avcl, int level, const char *fmt, va_list vl,
 216                         AVBPrint part[3], int *print_prefix, int type[2])
 217 {
 218     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
 219     av_bprint_init(part+0, 0, 1);
 220     av_bprint_init(part+1, 0, 1);
 221     av_bprint_init(part+2, 0, 65536);
 222
 223     if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
 224     if (*print_prefix && avc) {
 225         if (avc->parent_log_context_offset) {
 226             AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
 227                                    avc->parent_log_context_offset);
 228             if (parent && *parent) {
 229                 av_bprintf(part+0, "[%s @ %p] ",
 230                          (*parent)->item_name(parent), parent);
 231                 if(type) type[0] = get_category(parent);
 232             }
 233         }
 234         av_bprintf(part+1, "[%s @ %p] ",
 235                  avc->item_name(avcl), avcl);
 236         if(type) type[1] = get_category(avcl);
 237     }
 238
 239     av_vbprintf(part+2, fmt, vl);
 240
 241     if(*part[0].str || *part[1].str || *part[2].str) {
 242         char lastc = part[2].len && part[2].len <= part[2].size ? part[2].str[part[2].len - 1] : 0;
 243         *print_prefix = lastc == '\n' || lastc == '\r';
 244     }
 245 }
 246
 247 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
 248                         char *line, int line_size, int *print_prefix)
 249 {
 250     AVBPrint part[3];
 251     format_line(ptr, level, fmt, vl, part, print_prefix, NULL);
 252     snprintf(line, line_size, "%s%s%s", part[0].str, part[1].str, part[2].str);
 253     av_bprint_finalize(part+2, NULL);
 254 }
 255
 256 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
 257 {
 258     static int print_prefix = 1;
 259     static int count;
 260     static char prev[LINE_SZ];
 261     AVBPrint part[3];
 262     char line[LINE_SZ];
 263     static int is_atty;
 264     int type[2];
 265     unsigned tint = 0;
 266
 267     if (level >= 0) {
 268         tint = level & 0xff00;
 269         level &= 0xff;
 270     }
 271
 272     if (level > av_log_level)
 273         return;
 274 #if HAVE_PTHREADS
 275     pthread_mutex_lock(&mutex);
 276 #endif
 277
 278     format_line(ptr, level, fmt, vl, part, &print_prefix, type);
 279     snprintf(line, sizeof(line), "%s%s%s", part[0].str, part[1].str, part[2].str);
 280
 281 #if HAVE_ISATTY
 282     if (!is_atty)
 283         is_atty = isatty(2) ? 1 : -1;
 284 #endif
 285
 286     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev) &&
 287         *line && line[strlen(line) - 1] != '\r'){
 288         count++;
 289         if (is_atty == 1)
 290             fprintf(stderr, "    Last message repeated %d times\r", count);
 291         goto end;
 292     }
 293     if (count > 0) {
 294         fprintf(stderr, "    Last message repeated %d times\n", count);
 295         count = 0;
 296     }
 297     strcpy(prev, line);
 298     sanitize(part[0].str);
 299     colored_fputs(type[0], 0, part[0].str);
 300     sanitize(part[1].str);
 301     colored_fputs(type[1], 0, part[1].str);
 302     sanitize(part[2].str);
 303     colored_fputs(av_clip(level >> 3, 0, 6), tint >> 8, part[2].str);
 304 end:
 305     av_bprint_finalize(part+2, NULL);
 306 #if HAVE_PTHREADS
 307     pthread_mutex_unlock(&mutex);
 308 #endif
 309 }
 310
 311 static void (*av_log_callback)(void*, int, const char*, va_list) =
 312     av_log_default_callback;
 313
 314 void av_log(void* avcl, int level, const char *fmt, ...)
 315 {
 316     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
 317     va_list vl;
 318     va_start(vl, fmt);
 319     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
 320         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
 321         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
 322     av_vlog(avcl, level, fmt, vl);
 323     va_end(vl);
 324 }
 325
 326 void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
 327 {
 328     void (*log_callback)(void*, int, const char*, va_list) = av_log_callback;
 329     if (log_callback)
 330         log_callback(avcl, level, fmt, vl);
 331 }
 332
 333 int av_log_get_level(void)
 334 {
 335     return av_log_level;
 336 }
 337
 338 void av_log_set_level(int level)
 339 {
 340     av_log_level = level;
 341 }
 342
 343 void av_log_set_flags(int arg)
 344 {
 345     flags = arg;
 346 }
 347
 348 int av_log_get_flags(void)
 349 {
 350     return flags;
 351 }
 352
 353 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
 354 {
 355     av_log_callback = callback;
 356 }
 357
 358 static void missing_feature_sample(int sample, void *avc, const char *msg,
 359                                    va_list argument_list)
 360 {
 361     av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
 362     av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg "
 363            "version to the newest one from Git. If the problem still "
 364            "occurs, it means that your file has a feature which has not "
 365            "been implemented.\n");
 366     if (sample)
 367         av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
 368                "of this file to ftp://upload.ffmpeg.org/MPlayer/incoming/ "
 369                "and contact the ffmpeg-devel mailing list.\n");
 370 }
 371
 372 void avpriv_request_sample(void *avc, const char *msg, ...)
 373 {
 374     va_list argument_list;
 375
 376     va_start(argument_list, msg);
 377     missing_feature_sample(1, avc, msg, argument_list);
 378     va_end(argument_list);
 379 }
 380
 381 void avpriv_report_missing_feature(void *avc, const char *msg, ...)
 382 {
 383     va_list argument_list;
 384
 385     va_start(argument_list, msg);
 386     missing_feature_sample(0, avc, msg, argument_list);
 387     va_end(argument_list);
 388 }
 389
 390 #ifdef TEST
 391 // LCOV_EXCL_START
 392 #include <string.h>
 393
 394 int main(int argc, char **argv)
 395 {
 396     int i;
 397     av_log_set_level(AV_LOG_DEBUG);
 398     for (use_color=0; use_color<=256; use_color = 255*use_color+1) {
 399         av_log(NULL, AV_LOG_FATAL, "use_color: %d\n", use_color);
 400         for (i = AV_LOG_DEBUG; i>=AV_LOG_QUIET; i-=8) {
 401             av_log(NULL, i, " %d", i);
 402             av_log(NULL, AV_LOG_INFO, "e ");
 403             av_log(NULL, i + 256*123, "C%d", i);
 404             av_log(NULL, AV_LOG_INFO, "e");
 405         }
 406         av_log(NULL, AV_LOG_PANIC, "\n");
 407     }
 408     return 0;
 409 }
 410 // LCOV_EXCL_STOP
 411 #endif