log.c 13.3 KB
Newer Older
1 2 3 4
/*
 * log functions
 * Copyright (c) 2003 Michel Bardiaux
 *
5 6 7
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
8 9
 * modify it under the terms of the GNU Lesser General Public
 * 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 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 20 21 22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
23
 * @file
24
 * logging functions
25 26
 */

27 28
#include "config.h"

29
#if HAVE_UNISTD_H
30
#include <unistd.h>
31
#endif
32 33 34
#if HAVE_IO_H
#include <io.h>
#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
#include "thread.h"
43

44
static AVMutex mutex = AV_MUTEX_INITIALIZER;
45

46 47
#define LINE_SZ 1024

48 49 50 51 52 53
#if HAVE_VALGRIND_VALGRIND_H
#include <valgrind/valgrind.h>
/* this is the log level at which valgrind will output a full backtrace */
#define BACKTRACE_LOGLEVEL AV_LOG_ERROR
#endif

54
static int av_log_level = AV_LOG_INFO;
55
static int flags;
56

57
#define NB_LEVELS 8
James Almer's avatar
James Almer committed
58
#if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE
59
#include <windows.h>
60 61 62 63 64 65 66
static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = {
    [AV_LOG_PANIC  /8] = 12,
    [AV_LOG_FATAL  /8] = 12,
    [AV_LOG_ERROR  /8] = 12,
    [AV_LOG_WARNING/8] = 14,
    [AV_LOG_INFO   /8] =  7,
    [AV_LOG_VERBOSE/8] = 10,
67
    [AV_LOG_DEBUG  /8] = 10,
68
    [AV_LOG_TRACE  /8] = 8,
69
    [16+AV_CLASS_CATEGORY_NA              ] =  7,
70 71 72 73 74 75
    [16+AV_CLASS_CATEGORY_INPUT           ] = 13,
    [16+AV_CLASS_CATEGORY_OUTPUT          ] =  5,
    [16+AV_CLASS_CATEGORY_MUXER           ] = 13,
    [16+AV_CLASS_CATEGORY_DEMUXER         ] =  5,
    [16+AV_CLASS_CATEGORY_ENCODER         ] = 11,
    [16+AV_CLASS_CATEGORY_DECODER         ] =  3,
76
    [16+AV_CLASS_CATEGORY_FILTER          ] = 10,
77
    [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] =  9,
Paul B Mahol's avatar
Paul B Mahol committed
78 79
    [16+AV_CLASS_CATEGORY_SWSCALER        ] =  7,
    [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] =  7,
80 81 82 83 84 85
    [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 13,
    [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT  ] = 5,
    [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 13,
    [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT  ] = 5,
    [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT       ] = 13,
    [16+AV_CLASS_CATEGORY_DEVICE_INPUT        ] = 5,
86 87
};

88 89 90
static int16_t background, attr_orig;
static HANDLE con;
#else
91

Paul B Mahol's avatar
Paul B Mahol committed
92 93 94 95 96 97 98 99
static const uint32_t color[16 + AV_CLASS_CATEGORY_NB] = {
    [AV_LOG_PANIC  /8] =  52 << 16 | 196 << 8 | 0x41,
    [AV_LOG_FATAL  /8] = 208 <<  8 | 0x41,
    [AV_LOG_ERROR  /8] = 196 <<  8 | 0x11,
    [AV_LOG_WARNING/8] = 226 <<  8 | 0x03,
    [AV_LOG_INFO   /8] = 253 <<  8 | 0x09,
    [AV_LOG_VERBOSE/8] =  40 <<  8 | 0x02,
    [AV_LOG_DEBUG  /8] =  34 <<  8 | 0x02,
100
    [AV_LOG_TRACE  /8] =  34 <<  8 | 0x07,
Paul B Mahol's avatar
Paul B Mahol committed
101 102 103 104 105 106 107 108 109 110 111
    [16+AV_CLASS_CATEGORY_NA              ] = 250 << 8 | 0x09,
    [16+AV_CLASS_CATEGORY_INPUT           ] = 219 << 8 | 0x15,
    [16+AV_CLASS_CATEGORY_OUTPUT          ] = 201 << 8 | 0x05,
    [16+AV_CLASS_CATEGORY_MUXER           ] = 213 << 8 | 0x15,
    [16+AV_CLASS_CATEGORY_DEMUXER         ] = 207 << 8 | 0x05,
    [16+AV_CLASS_CATEGORY_ENCODER         ] =  51 << 8 | 0x16,
    [16+AV_CLASS_CATEGORY_DECODER         ] =  39 << 8 | 0x06,
    [16+AV_CLASS_CATEGORY_FILTER          ] = 155 << 8 | 0x12,
    [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 192 << 8 | 0x14,
    [16+AV_CLASS_CATEGORY_SWSCALER        ] = 153 << 8 | 0x14,
    [16+AV_CLASS_CATEGORY_SWRESAMPLER     ] = 147 << 8 | 0x14,
112 113 114 115 116 117
    [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 213 << 8 | 0x15,
    [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT  ] = 207 << 8 | 0x05,
    [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 213 << 8 | 0x15,
    [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT  ] = 207 << 8 | 0x05,
    [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT       ] = 213 << 8 | 0x15,
    [16+AV_CLASS_CATEGORY_DEVICE_INPUT        ] = 207 << 8 | 0x05,
118 119
};

120
#endif
121
static int use_color = -1;
122

123
static void check_color_terminal(void)
124
{
James Almer's avatar
James Almer committed
125
#if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE
126 127 128 129 130 131 132 133 134
    CONSOLE_SCREEN_BUFFER_INFO con_info;
    con = GetStdHandle(STD_ERROR_HANDLE);
    use_color = (con != INVALID_HANDLE_VALUE) && !getenv("NO_COLOR") &&
                !getenv("AV_LOG_FORCE_NOCOLOR");
    if (use_color) {
        GetConsoleScreenBufferInfo(con, &con_info);
        attr_orig  = con_info.wAttributes;
        background = attr_orig & 0xF0;
    }
135
#elif HAVE_ISATTY
136
    char *term = getenv("TERM");
137 138
    use_color = !getenv("NO_COLOR") && !getenv("AV_LOG_FORCE_NOCOLOR") &&
                (getenv("TERM") && isatty(2) || getenv("AV_LOG_FORCE_COLOR"));
139
    if (   getenv("AV_LOG_FORCE_256COLOR")
140
        || (term && strstr(term, "256color")))
141
        use_color *= 256;
142
#else
143 144
    use_color = getenv("AV_LOG_FORCE_COLOR") && !getenv("NO_COLOR") &&
               !getenv("AV_LOG_FORCE_NOCOLOR");
145
#endif
146 147
}

148
static void colored_fputs(int level, int tint, const char *str)
149
{
150
    int local_use_color;
151 152 153 154 155
    if (!*str)
        return;

    if (use_color < 0)
        check_color_terminal();
156

157 158 159
    if (level == AV_LOG_INFO/8) local_use_color = 0;
    else                        local_use_color = use_color;

James Almer's avatar
James Almer committed
160
#if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE
161
    if (local_use_color)
162
        SetConsoleTextAttribute(con, background | color[level]);
163
    fputs(str, stderr);
164
    if (local_use_color)
165 166
        SetConsoleTextAttribute(con, attr_orig);
#else
167
    if (local_use_color == 1) {
168
        fprintf(stderr,
169
                "\033[%"PRIu32";3%"PRIu32"m%s\033[0m",
170 171 172
                (color[level] >> 4) & 15,
                color[level] & 15,
                str);
173 174
    } else if (tint && use_color == 256) {
        fprintf(stderr,
175
                "\033[48;5;%"PRIu32"m\033[38;5;%dm%s\033[0m",
176 177 178
                (color[level] >> 16) & 0xff,
                tint,
                str);
179
    } else if (local_use_color == 256) {
180
        fprintf(stderr,
181
                "\033[48;5;%"PRIu32"m\033[38;5;%"PRIu32"m%s\033[0m",
182 183 184 185 186 187 188
                (color[level] >> 16) & 0xff,
                (color[level] >> 8) & 0xff,
                str);
    } else
        fputs(str, stderr);
#endif

189 190
}

191 192 193
const char *av_default_item_name(void *ptr)
{
    return (*(AVClass **) ptr)->class_name;
194 195
}

196 197 198 199 200
AVClassCategory av_default_get_category(void *ptr)
{
    return (*(AVClass **) ptr)->category;
}

201 202 203 204 205 206 207 208
static void sanitize(uint8_t *line){
    while(*line){
        if(*line < 0x08 || (*line > 0x0D && *line < 0x20))
            *line='?';
        line++;
    }
}

209 210
static int get_category(void *ptr){
    AVClass *avc = *(AVClass **) ptr;
211 212
    if(    !avc
        || (avc->version&0xFF)<100
213
        ||  avc->version < (51 << 16 | 59 << 8)
214 215
        ||  avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16;

216 217 218
    if(avc->get_category)
        return avc->get_category(ptr) + 16;

219 220 221
    return avc->category + 16;
}

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
static const char *get_level_str(int level)
{
    switch (level) {
    case AV_LOG_QUIET:
        return "quiet";
    case AV_LOG_DEBUG:
        return "debug";
    case AV_LOG_VERBOSE:
        return "verbose";
    case AV_LOG_INFO:
        return "info";
    case AV_LOG_WARNING:
        return "warning";
    case AV_LOG_ERROR:
        return "error";
    case AV_LOG_FATAL:
        return "fatal";
    case AV_LOG_PANIC:
        return "panic";
    default:
        return "";
    }
}

246
static void format_line(void *avcl, int level, const char *fmt, va_list vl,
247
                        AVBPrint part[4], int *print_prefix, int type[2])
248
{
249
    AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
250 251 252
    av_bprint_init(part+0, 0, AV_BPRINT_SIZE_AUTOMATIC);
    av_bprint_init(part+1, 0, AV_BPRINT_SIZE_AUTOMATIC);
    av_bprint_init(part+2, 0, AV_BPRINT_SIZE_AUTOMATIC);
253
    av_bprint_init(part+3, 0, 65536);
254

255
    if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16;
256
    if (*print_prefix && avc) {
257
        if (avc->parent_log_context_offset) {
258
            AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) +
259 260
                                   avc->parent_log_context_offset);
            if (parent && *parent) {
261
                av_bprintf(part+0, "[%s @ %p] ",
262
                         (*parent)->item_name(parent), parent);
263
                if(type) type[0] = get_category(parent);
264 265
            }
        }
266
        av_bprintf(part+1, "[%s @ %p] ",
267
                 avc->item_name(avcl), avcl);
268
        if(type) type[1] = get_category(avcl);
269
    }
270

271 272 273
    if (*print_prefix && (level > AV_LOG_QUIET) && (flags & AV_LOG_PRINT_LEVEL))
        av_bprintf(part+2, "[%s] ", get_level_str(level));

274
    av_vbprintf(part+3, fmt, vl);
275

276 277
    if(*part[0].str || *part[1].str || *part[2].str || *part[3].str) {
        char lastc = part[3].len && part[3].len <= part[3].size ? part[3].str[part[3].len - 1] : 0;
278 279
        *print_prefix = lastc == '\n' || lastc == '\r';
    }
280 281 282 283
}

void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl,
                        char *line, int line_size, int *print_prefix)
284 285 286 287 288 289
{
    av_log_format_line2(ptr, level, fmt, vl, line, line_size, print_prefix);
}

int av_log_format_line2(void *ptr, int level, const char *fmt, va_list vl,
                        char *line, int line_size, int *print_prefix)
290
{
291
    AVBPrint part[4];
292 293
    int ret;

294
    format_line(ptr, level, fmt, vl, part, print_prefix, NULL);
295
    ret = snprintf(line, line_size, "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str);
296
    av_bprint_finalize(part+3, NULL);
297
    return ret;
298 299 300 301 302 303
}

void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl)
{
    static int print_prefix = 1;
    static int count;
304
    static char prev[LINE_SZ];
305
    AVBPrint part[4];
306
    char line[LINE_SZ];
307
    static int is_atty;
308
    int type[2];
309
    unsigned tint = 0;
310

311 312 313 314
    if (level >= 0) {
        tint = level & 0xff00;
        level &= 0xff;
    }
315

316 317
    if (level > av_log_level)
        return;
318
    ff_mutex_lock(&mutex);
319

320
    format_line(ptr, level, fmt, vl, part, &print_prefix, type);
321
    snprintf(line, sizeof(line), "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str);
322 323

#if HAVE_ISATTY
324 325
    if (!is_atty)
        is_atty = isatty(2) ? 1 : -1;
326 327
#endif

328 329
    if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev) &&
        *line && line[strlen(line) - 1] != '\r'){
330
        count++;
331
        if (is_atty == 1)
Michael Niedermayer's avatar
Michael Niedermayer committed
332
            fprintf(stderr, "    Last message repeated %d times\r", count);
333
        goto end;
334
    }
335
    if (count > 0) {
336
        fprintf(stderr, "    Last message repeated %d times\n", count);
337
        count = 0;
338 339
    }
    strcpy(prev, line);
340
    sanitize(part[0].str);
341
    colored_fputs(type[0], 0, part[0].str);
342
    sanitize(part[1].str);
343
    colored_fputs(type[1], 0, part[1].str);
344
    sanitize(part[2].str);
345
    colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[2].str);
346
    sanitize(part[3].str);
347
    colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[3].str);
348 349 350

#if CONFIG_VALGRIND_BACKTRACE
    if (level <= BACKTRACE_LOGLEVEL)
351
        VALGRIND_PRINTF_BACKTRACE("%s", "");
352
#endif
353
end:
354
    av_bprint_finalize(part+3, NULL);
355
    ff_mutex_unlock(&mutex);
356 357
}

358 359
static void (*av_log_callback)(void*, int, const char*, va_list) =
    av_log_default_callback;
360 361 362

void av_log(void* avcl, int level, const char *fmt, ...)
{
363
    AVClass* avc = avcl ? *(AVClass **) avcl : NULL;
364 365
    va_list vl;
    va_start(vl, fmt);
366 367 368
    if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) &&
        avc->log_level_offset_offset && level >= AV_LOG_FATAL)
        level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset);
369 370 371 372 373 374
    av_vlog(avcl, level, fmt, vl);
    va_end(vl);
}

void av_vlog(void* avcl, int level, const char *fmt, va_list vl)
{
375 376 377
    void (*log_callback)(void*, int, const char*, va_list) = av_log_callback;
    if (log_callback)
        log_callback(avcl, level, fmt, vl);
378 379 380 381 382 383 384 385 386 387 388 389
}

int av_log_get_level(void)
{
    return av_log_level;
}

void av_log_set_level(int level)
{
    av_log_level = level;
}

390 391
void av_log_set_flags(int arg)
{
392
    flags = arg;
393 394
}

395 396 397 398 399
int av_log_get_flags(void)
{
    return flags;
}

400 401 402 403
void av_log_set_callback(void (*callback)(void*, int, const char*, va_list))
{
    av_log_callback = callback;
}
404

405 406
static void missing_feature_sample(int sample, void *avc, const char *msg,
                                   va_list argument_list)
407 408
{
    av_vlog(avc, AV_LOG_WARNING, msg, argument_list);
409
    av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg "
410 411 412 413 414
           "version to the newest one from Git. If the problem still "
           "occurs, it means that your file has a feature which has not "
           "been implemented.\n");
    if (sample)
        av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample "
415
               "of this file to ftp://upload.ffmpeg.org/incoming/ "
416
               "and contact the ffmpeg-devel mailing list. (ffmpeg-devel@ffmpeg.org)\n");
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
}

void avpriv_request_sample(void *avc, const char *msg, ...)
{
    va_list argument_list;

    va_start(argument_list, msg);
    missing_feature_sample(1, avc, msg, argument_list);
    va_end(argument_list);
}

void avpriv_report_missing_feature(void *avc, const char *msg, ...)
{
    va_list argument_list;

    va_start(argument_list, msg);
    missing_feature_sample(0, avc, msg, argument_list);
    va_end(argument_list);
}