yading@11: /*
yading@11:  * log functions
yading@11:  * Copyright (c) 2003 Michel Bardiaux
yading@11:  *
yading@11:  * This file is part of FFmpeg.
yading@11:  *
yading@11:  * FFmpeg is free software; you can redistribute it and/or
yading@11:  * modify it under the terms of the GNU Lesser General Public
yading@11:  * License as published by the Free Software Foundation; either
yading@11:  * version 2.1 of the License, or (at your option) any later version.
yading@11:  *
yading@11:  * FFmpeg is distributed in the hope that it will be useful,
yading@11:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@11:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@11:  * Lesser General Public License for more details.
yading@11:  *
yading@11:  * You should have received a copy of the GNU Lesser General Public
yading@11:  * License along with FFmpeg; if not, write to the Free Software
yading@11:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@11:  */
yading@11: 
yading@11: /**
yading@11:  * @file
yading@11:  * logging functions
yading@11:  */
yading@11: 
yading@11: #include "config.h"
yading@11: 
yading@11: #if HAVE_UNISTD_H
yading@11: #include <unistd.h>
yading@11: #endif
yading@11: #if HAVE_IO_H
yading@11: #include <io.h>
yading@11: #endif
yading@11: #include <stdarg.h>
yading@11: #include <stdlib.h>
yading@11: #include "avutil.h"
yading@11: #include "common.h"
yading@11: #include "internal.h"
yading@11: #include "log.h"
yading@11: 
yading@11: #define LINE_SZ 1024
yading@11: 
yading@11: static int av_log_level = AV_LOG_INFO;
yading@11: static int flags;
yading@11: 
yading@11: #if HAVE_SETCONSOLETEXTATTRIBUTE
yading@11: #include <windows.h>
yading@11: static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
yading@11:     [AV_LOG_PANIC  /8] = 12,
yading@11:     [AV_LOG_FATAL  /8] = 12,
yading@11:     [AV_LOG_ERROR  /8] = 12,
yading@11:     [AV_LOG_WARNING/8] = 14,
yading@11:     [AV_LOG_INFO   /8] =  7,
yading@11:     [AV_LOG_VERBOSE/8] = 10,
yading@11:     [AV_LOG_DEBUG  /8] = 10,
yading@11:     [16+AV_CLASS_CATEGORY_NA              ] =  7,
yading@11:     [16+AV_CLASS_CATEGORY_INPUT           ] = 13,
yading@11:     [16+AV_CLASS_CATEGORY_OUTPUT          ] =  5,
yading@11:     [16+AV_CLASS_CATEGORY_MUXER           ] = 13,
yading@11:     [16+AV_CLASS_CATEGORY_DEMUXER         ] =  5,
yading@11:     [16+AV_CLASS_CATEGORY_ENCODER         ] = 11,
yading@11:     [16+AV_CLASS_CATEGORY_DECODER         ] =  3,
yading@11:     [16+AV_CLASS_CATEGORY_FILTER          ] = 10,
yading@11:     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] =  9,
yading@11:     [16+AV_CLASS_CATEGORY_SWSCALER        ] =  7,
yading@11:     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] =  7,
yading@11: };
yading@11: 
yading@11: static int16_t background, attr_orig;
yading@11: static HANDLE con;
yading@11: #define set_color(x)  SetConsoleTextAttribute(con, background | color[x])
yading@11: #define set_256color set_color
yading@11: #define reset_color() SetConsoleTextAttribute(con, attr_orig)
yading@11: #else
yading@11: 
yading@11: static const uint32_t color[16 + AV_CLASS_CATEGORY_NB] = {
yading@11:     [AV_LOG_PANIC  /8] =  52 << 16 | 196 << 8 | 0x41,
yading@11:     [AV_LOG_FATAL  /8] = 208 <<  8 | 0x41,
yading@11:     [AV_LOG_ERROR  /8] = 196 <<  8 | 0x11,
yading@11:     [AV_LOG_WARNING/8] = 226 <<  8 | 0x03,
yading@11:     [AV_LOG_INFO   /8] = 253 <<  8 | 0x09,
yading@11:     [AV_LOG_VERBOSE/8] =  40 <<  8 | 0x02,
yading@11:     [AV_LOG_DEBUG  /8] =  34 <<  8 | 0x02,
yading@11:     [16+AV_CLASS_CATEGORY_NA              ] = 250 << 8 | 0x09,
yading@11:     [16+AV_CLASS_CATEGORY_INPUT           ] = 219 << 8 | 0x15,
yading@11:     [16+AV_CLASS_CATEGORY_OUTPUT          ] = 201 << 8 | 0x05,
yading@11:     [16+AV_CLASS_CATEGORY_MUXER           ] = 213 << 8 | 0x15,
yading@11:     [16+AV_CLASS_CATEGORY_DEMUXER         ] = 207 << 8 | 0x05,
yading@11:     [16+AV_CLASS_CATEGORY_ENCODER         ] =  51 << 8 | 0x16,
yading@11:     [16+AV_CLASS_CATEGORY_DECODER         ] =  39 << 8 | 0x06,
yading@11:     [16+AV_CLASS_CATEGORY_FILTER          ] = 155 << 8 | 0x12,
yading@11:     [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 192 << 8 | 0x14,
yading@11:     [16+AV_CLASS_CATEGORY_SWSCALER        ] = 153 << 8 | 0x14,
yading@11:     [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] = 147 << 8 | 0x14,
yading@11: };
yading@11: 
yading@11: #define set_color(x)  fprintf(stderr, "\033[%d;3%dm", (color[x] >> 4) & 15, color[x] & 15)
yading@11: #define set_256color(x) fprintf(stderr, "\033[48;5;%dm\033[38;5;%dm", (color[x] >> 16) & 0xff, (color[x] >> 8) & 0xff)
yading@11: #define reset_color() fprintf(stderr, "\033[0m")
yading@11: #endif
yading@11: static int use_color = -1;
yading@11: 
yading@11: static void colored_fputs(int level, const char *str)
yading@11: {
yading@11:     if (use_color < 0) {
yading@11: #if HAVE_SETCONSOLETEXTATTRIBUTE
yading@11:         CONSOLE_SCREEN_BUFFER_INFO con_info;
yading@11:         con = GetStdHandle(STD_ERROR_HANDLE);
yading@11:         use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
yading@11:                     !getenv("AV_LOG_FORCE_NOCOLOR");
yading@11:         if (use_color) {
yading@11:             GetConsoleScreenBufferInfo(con, &con_info);
yading@11:             attr_orig  = con_info.wAttributes;
yading@11:             background = attr_orig & 0xF0;
yading@11:         }
yading@11: #elif HAVE_ISATTY
yading@11:         use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
yading@11:                     (getenv("TERM") && isatty(2) ||
yading@11:                      getenv("AV_LOG_FORCE_COLOR"));
yading@11:         if (getenv("AV_LOG_FORCE_256COLOR"))
yading@11:             use_color *= 256;
yading@11: #else
yading@11:         use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
yading@11:                    !getenv("AV_LOG_FORCE_NOCOLOR");
yading@11: #endif
yading@11:     }
yading@11: 
yading@11:     if (use_color == 1) {
yading@11:         set_color(level);
yading@11:     } else if (use_color == 256)
yading@11:         set_256color(level);
yading@11:     fputs(str, stderr);
yading@11:     if (use_color) {
yading@11:         reset_color();
yading@11:     }
yading@11: }
yading@11: 
yading@11: const char *av_default_item_name(void *ptr)
yading@11: {
yading@11:     return (*(AVClass **) ptr)->class_name;
yading@11: }
yading@11: 
yading@11: AVClassCategory av_default_get_category(void *ptr)
yading@11: {
yading@11:     return (*(AVClass **) ptr)->category;
yading@11: }
yading@11: 
yading@11: static void sanitize(uint8_t *line){
yading@11:     while(*line){
yading@11:         if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
yading@11:             *line='?';
yading@11:         line++;
yading@11:     }
yading@11: }
yading@11: 
yading@11: static int get_category(void *ptr){
yading@11:     AVClass *avc = *(AVClass **) ptr;
yading@11:     if(    !avc
yading@11:         || (avc->version&0xFF)<100
yading@11:         ||  avc->version < (51 << 16 | 59 << 8)
yading@11:         ||  avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;
yading@11: 
yading@11:     if(avc->get_category)
yading@11:         return avc->get_category(ptr) + 16;
yading@11: 
yading@11:     return avc->category + 16;
yading@11: }
yading@11: 
yading@11: static void format_line(void *ptr, int level, const char *fmt, va_list vl,
yading@11:                         char part[3][LINE_SZ], int part_size, int *print_prefix, int type[2])
yading@11: {
yading@11:     AVClass* avc = ptr ? *(AVClass **) ptr : NULL;
yading@11:     part[0][0] = part[1][0] = part[2][0] = 0;
yading@11:     if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
yading@11:     if (*print_prefix && avc) {
yading@11:         if (avc->parent_log_context_offset) {
yading@11:             AVClass** parent = *(AVClass ***) (((uint8_t *) ptr) +
yading@11:                                    avc->parent_log_context_offset);
yading@11:             if (parent && *parent) {
yading@11:                 snprintf(part[0], part_size, "[%s @ %p] ",
yading@11:                          (*parent)->item_name(parent), parent);
yading@11:                 if(type) type[0] = get_category(((uint8_t *) ptr) + avc->parent_log_context_offset);
yading@11:             }
yading@11:         }
yading@11:         snprintf(part[1], part_size, "[%s @ %p] ",
yading@11:                  avc->item_name(ptr), ptr);
yading@11:         if(type) type[1] = get_category(ptr);
yading@11:     }
yading@11: 
yading@11:     vsnprintf(part[2], part_size, fmt, vl);
yading@11: 
yading@11:     *print_prefix = strlen(part[2]) && part[2][strlen(part[2]) - 1] == '\n';
yading@11: }
yading@11: 
yading@11: void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
yading@11:                         char *line, int line_size, int *print_prefix)
yading@11: {
yading@11:     char part[3][LINE_SZ];
yading@11:     format_line(ptr, level, fmt, vl, part, sizeof(part[0]), print_prefix, NULL);
yading@11:     snprintf(line, line_size, "%s%s%s", part[0], part[1], part[2]);
yading@11: }
yading@11: 
yading@11: void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
yading@11: {
yading@11:     static int print_prefix = 1;
yading@11:     static int count;
yading@11:     static char prev[LINE_SZ];
yading@11:     char part[3][LINE_SZ];
yading@11:     char line[LINE_SZ];
yading@11:     static int is_atty;
yading@11:     int type[2];
yading@11: 
yading@11:     if (level > av_log_level)
yading@11:         return;
yading@11:     format_line(ptr, level, fmt, vl, part, sizeof(part[0]), &print_prefix, type);
yading@11:     snprintf(line, sizeof(line), "%s%s%s", part[0], part[1], part[2]);
yading@11: 
yading@11: #if HAVE_ISATTY
yading@11:     if (!is_atty)
yading@11:         is_atty = isatty(2) ? 1 : -1;
yading@11: #endif
yading@11: 
yading@11:     if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev)){
yading@11:         count++;
yading@11:         if (is_atty == 1)
yading@11:             fprintf(stderr, "    Last message repeated %d times\r", count);
yading@11:         return;
yading@11:     }
yading@11:     if (count > 0) {
yading@11:         fprintf(stderr, "    Last message repeated %d times\n", count);
yading@11:         count = 0;
yading@11:     }
yading@11:     strcpy(prev, line);
yading@11:     sanitize(part[0]);
yading@11:     colored_fputs(type[0], part[0]);
yading@11:     sanitize(part[1]);
yading@11:     colored_fputs(type[1], part[1]);
yading@11:     sanitize(part[2]);
yading@11:     colored_fputs(av_clip(level >> 3, 0, 6), part[2]);
yading@11: }
yading@11: 
yading@11: static void (*av_log_callback)(void*, int, const char*, va_list) =
yading@11:     av_log_default_callback;
yading@11: 
yading@11: void av_log(void* avcl, int level, const char *fmt, ...)
yading@11: {
yading@11:     AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
yading@11:     va_list vl;
yading@11:     va_start(vl, fmt);
yading@11:     if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
yading@11:         avc->log_level_offset_offset && level >= AV_LOG_FATAL)
yading@11:         level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
yading@11:     av_vlog(avcl, level, fmt, vl);
yading@11:     va_end(vl);
yading@11: }
yading@11: 
yading@11: void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
yading@11: {
yading@11:     if(av_log_callback)
yading@11:         av_log_callback(avcl, level, fmt, vl);
yading@11: }
yading@11: 
yading@11: int av_log_get_level(void)
yading@11: {
yading@11:     return av_log_level;
yading@11: }
yading@11: 
yading@11: void av_log_set_level(int level)
yading@11: {
yading@11:     av_log_level = level;
yading@11: }
yading@11: 
yading@11: void av_log_set_flags(int arg)
yading@11: {
yading@11:     flags = arg;
yading@11: }
yading@11: 
yading@11: void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
yading@11: {
yading@11:     av_log_callback = callback;
yading@11: }
yading@11: 
yading@11: static void missing_feature_sample(int sample, void *avc, const char *msg, va_list argument_list)
yading@11: {
yading@11:     av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
yading@11:     av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg "
yading@11:            "version to the newest one from Git. If the problem still "
yading@11:            "occurs, it means that your file has a feature which has not "
yading@11:            "been implemented.\n");
yading@11:     if (sample)
yading@11:         av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
yading@11:                "of this file to ftp://upload.ffmpeg.org/MPlayer/incoming/ "
yading@11:                "and contact the ffmpeg-devel mailing list.\n");
yading@11: }
yading@11: 
yading@11: void avpriv_request_sample(void *avc, const char *msg, ...)
yading@11: {
yading@11:     va_list argument_list;
yading@11: 
yading@11:     va_start(argument_list, msg);
yading@11:     missing_feature_sample(1, avc, msg, argument_list);
yading@11:     va_end(argument_list);
yading@11: }
yading@11: 
yading@11: void avpriv_report_missing_feature(void *avc, const char *msg, ...)
yading@11: {
yading@11:     va_list argument_list;
yading@11: 
yading@11:     va_start(argument_list, msg);
yading@11:     missing_feature_sample(0, avc, msg, argument_list);
yading@11:     va_end(argument_list);
yading@11: }