log.c (15177B)
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 <inttypes.h> 36 #include <stdarg.h> 37 #include <stdio.h> 38 #include <stdlib.h> 39 #include <string.h> 40 #include "bprint.h" 41 #include "common.h" 42 #include "internal.h" 43 #include "log.h" 44 #include "thread.h" 45 46 static AVMutex mutex = AV_MUTEX_INITIALIZER; 47 48 #define LINE_SZ 1024 49 50 #if HAVE_VALGRIND_VALGRIND_H && CONFIG_VALGRIND_BACKTRACE 51 #include <valgrind/valgrind.h> 52 /* this is the log level at which valgrind will output a full backtrace */ 53 #define BACKTRACE_LOGLEVEL AV_LOG_ERROR 54 #endif 55 56 static int av_log_level = AV_LOG_INFO; 57 static int flags; 58 59 #define NB_LEVELS 8 60 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE 61 #include <windows.h> 62 static const uint8_t color[16 + AV_CLASS_CATEGORY_NB] = { 63 [AV_LOG_PANIC /8] = 12, 64 [AV_LOG_FATAL /8] = 12, 65 [AV_LOG_ERROR /8] = 12, 66 [AV_LOG_WARNING/8] = 14, 67 [AV_LOG_INFO /8] = 7, 68 [AV_LOG_VERBOSE/8] = 10, 69 [AV_LOG_DEBUG /8] = 10, 70 [AV_LOG_TRACE /8] = 8, 71 [16+AV_CLASS_CATEGORY_NA ] = 7, 72 [16+AV_CLASS_CATEGORY_INPUT ] = 13, 73 [16+AV_CLASS_CATEGORY_OUTPUT ] = 5, 74 [16+AV_CLASS_CATEGORY_MUXER ] = 13, 75 [16+AV_CLASS_CATEGORY_DEMUXER ] = 5, 76 [16+AV_CLASS_CATEGORY_ENCODER ] = 11, 77 [16+AV_CLASS_CATEGORY_DECODER ] = 3, 78 [16+AV_CLASS_CATEGORY_FILTER ] = 10, 79 [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 9, 80 [16+AV_CLASS_CATEGORY_SWSCALER ] = 7, 81 [16+AV_CLASS_CATEGORY_SWRESAMPLER ] = 7, 82 [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 13, 83 [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT ] = 5, 84 [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 13, 85 [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT ] = 5, 86 [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT ] = 13, 87 [16+AV_CLASS_CATEGORY_DEVICE_INPUT ] = 5, 88 }; 89 90 static int16_t background, attr_orig; 91 static HANDLE con; 92 #else 93 94 static const uint32_t color[16 + AV_CLASS_CATEGORY_NB] = { 95 [AV_LOG_PANIC /8] = 52 << 16 | 196 << 8 | 0x41, 96 [AV_LOG_FATAL /8] = 208 << 8 | 0x41, 97 [AV_LOG_ERROR /8] = 196 << 8 | 0x11, 98 [AV_LOG_WARNING/8] = 226 << 8 | 0x03, 99 [AV_LOG_INFO /8] = 253 << 8 | 0x09, 100 [AV_LOG_VERBOSE/8] = 40 << 8 | 0x02, 101 [AV_LOG_DEBUG /8] = 34 << 8 | 0x02, 102 [AV_LOG_TRACE /8] = 34 << 8 | 0x07, 103 [16+AV_CLASS_CATEGORY_NA ] = 250 << 8 | 0x09, 104 [16+AV_CLASS_CATEGORY_INPUT ] = 219 << 8 | 0x15, 105 [16+AV_CLASS_CATEGORY_OUTPUT ] = 201 << 8 | 0x05, 106 [16+AV_CLASS_CATEGORY_MUXER ] = 213 << 8 | 0x15, 107 [16+AV_CLASS_CATEGORY_DEMUXER ] = 207 << 8 | 0x05, 108 [16+AV_CLASS_CATEGORY_ENCODER ] = 51 << 8 | 0x16, 109 [16+AV_CLASS_CATEGORY_DECODER ] = 39 << 8 | 0x06, 110 [16+AV_CLASS_CATEGORY_FILTER ] = 155 << 8 | 0x12, 111 [16+AV_CLASS_CATEGORY_BITSTREAM_FILTER] = 192 << 8 | 0x14, 112 [16+AV_CLASS_CATEGORY_SWSCALER ] = 153 << 8 | 0x14, 113 [16+AV_CLASS_CATEGORY_SWRESAMPLER ] = 147 << 8 | 0x14, 114 [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT ] = 213 << 8 | 0x15, 115 [16+AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT ] = 207 << 8 | 0x05, 116 [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT ] = 213 << 8 | 0x15, 117 [16+AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT ] = 207 << 8 | 0x05, 118 [16+AV_CLASS_CATEGORY_DEVICE_OUTPUT ] = 213 << 8 | 0x15, 119 [16+AV_CLASS_CATEGORY_DEVICE_INPUT ] = 207 << 8 | 0x05, 120 }; 121 122 #endif 123 static int use_color = -1; 124 125 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE 126 static void win_console_puts(const char *str) 127 { 128 const uint8_t *q = str; 129 uint16_t line[LINE_SZ]; 130 131 while (*q) { 132 uint16_t *buf = line; 133 DWORD nb_chars = 0; 134 DWORD written; 135 136 while (*q && nb_chars < LINE_SZ - 1) { 137 uint32_t ch; 138 uint16_t tmp; 139 140 GET_UTF8(ch, *q ? *q++ : 0, ch = 0xfffd; goto continue_on_invalid;) 141 continue_on_invalid: 142 PUT_UTF16(ch, tmp, *buf++ = tmp; nb_chars++;) 143 } 144 145 WriteConsoleW(con, line, nb_chars, &written, NULL); 146 } 147 } 148 #endif 149 150 static void check_color_terminal(void) 151 { 152 char *term = getenv("TERM"); 153 154 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE 155 CONSOLE_SCREEN_BUFFER_INFO con_info; 156 DWORD dummy; 157 con = GetStdHandle(STD_ERROR_HANDLE); 158 if (con != INVALID_HANDLE_VALUE && !GetConsoleMode(con, &dummy)) 159 con = INVALID_HANDLE_VALUE; 160 if (con != INVALID_HANDLE_VALUE) { 161 GetConsoleScreenBufferInfo(con, &con_info); 162 attr_orig = con_info.wAttributes; 163 background = attr_orig & 0xF0; 164 } 165 #endif 166 167 if (getenv("AV_LOG_FORCE_NOCOLOR")) { 168 use_color = 0; 169 } else if (getenv("AV_LOG_FORCE_COLOR")) { 170 use_color = 1; 171 } else { 172 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE 173 use_color = (con != INVALID_HANDLE_VALUE); 174 #elif HAVE_ISATTY 175 use_color = (term && isatty(2)); 176 #else 177 use_color = 0; 178 #endif 179 } 180 181 if (getenv("AV_LOG_FORCE_256COLOR") || term && strstr(term, "256color")) 182 use_color *= 256; 183 } 184 185 static void ansi_fputs(int level, int tint, const char *str, int local_use_color) 186 { 187 if (local_use_color == 1) { 188 fprintf(stderr, 189 "\033[%"PRIu32";3%"PRIu32"m%s\033[0m", 190 (color[level] >> 4) & 15, 191 color[level] & 15, 192 str); 193 } else if (tint && use_color == 256) { 194 fprintf(stderr, 195 "\033[48;5;%"PRIu32"m\033[38;5;%dm%s\033[0m", 196 (color[level] >> 16) & 0xff, 197 tint, 198 str); 199 } else if (local_use_color == 256) { 200 fprintf(stderr, 201 "\033[48;5;%"PRIu32"m\033[38;5;%"PRIu32"m%s\033[0m", 202 (color[level] >> 16) & 0xff, 203 (color[level] >> 8) & 0xff, 204 str); 205 } else 206 fputs(str, stderr); 207 } 208 209 static void colored_fputs(int level, int tint, const char *str) 210 { 211 int local_use_color; 212 if (!*str) 213 return; 214 215 if (use_color < 0) 216 check_color_terminal(); 217 218 if (level == AV_LOG_INFO/8) local_use_color = 0; 219 else local_use_color = use_color; 220 221 #if defined(_WIN32) && HAVE_SETCONSOLETEXTATTRIBUTE && HAVE_GETSTDHANDLE 222 if (con != INVALID_HANDLE_VALUE) { 223 if (local_use_color) 224 SetConsoleTextAttribute(con, background | color[level]); 225 win_console_puts(str); 226 if (local_use_color) 227 SetConsoleTextAttribute(con, attr_orig); 228 } else { 229 ansi_fputs(level, tint, str, local_use_color); 230 } 231 #else 232 ansi_fputs(level, tint, str, local_use_color); 233 #endif 234 235 } 236 237 const char *av_default_item_name(void *ptr) 238 { 239 return (*(AVClass **) ptr)->class_name; 240 } 241 242 AVClassCategory av_default_get_category(void *ptr) 243 { 244 return (*(AVClass **) ptr)->category; 245 } 246 247 static void sanitize(uint8_t *line){ 248 while(*line){ 249 if(*line < 0x08 || (*line > 0x0D && *line < 0x20)) 250 *line='?'; 251 line++; 252 } 253 } 254 255 static int get_category(void *ptr){ 256 AVClass *avc = *(AVClass **) ptr; 257 if( !avc 258 || (avc->version&0xFF)<100 259 || avc->version < (51 << 16 | 59 << 8) 260 || avc->category >= AV_CLASS_CATEGORY_NB) return AV_CLASS_CATEGORY_NA + 16; 261 262 if(avc->get_category) 263 return avc->get_category(ptr) + 16; 264 265 return avc->category + 16; 266 } 267 268 static const char *get_level_str(int level) 269 { 270 switch (level) { 271 case AV_LOG_QUIET: 272 return "quiet"; 273 case AV_LOG_DEBUG: 274 return "debug"; 275 case AV_LOG_TRACE: 276 return "trace"; 277 case AV_LOG_VERBOSE: 278 return "verbose"; 279 case AV_LOG_INFO: 280 return "info"; 281 case AV_LOG_WARNING: 282 return "warning"; 283 case AV_LOG_ERROR: 284 return "error"; 285 case AV_LOG_FATAL: 286 return "fatal"; 287 case AV_LOG_PANIC: 288 return "panic"; 289 default: 290 return ""; 291 } 292 } 293 294 static const char *item_name(void *obj, const AVClass *cls) 295 { 296 return (cls->item_name ? cls->item_name : av_default_item_name)(obj); 297 } 298 299 static void format_line(void *avcl, int level, const char *fmt, va_list vl, 300 AVBPrint part[4], int *print_prefix, int type[2]) 301 { 302 AVClass* avc = avcl ? *(AVClass **) avcl : NULL; 303 av_bprint_init(part+0, 0, AV_BPRINT_SIZE_AUTOMATIC); 304 av_bprint_init(part+1, 0, AV_BPRINT_SIZE_AUTOMATIC); 305 av_bprint_init(part+2, 0, AV_BPRINT_SIZE_AUTOMATIC); 306 av_bprint_init(part+3, 0, 65536); 307 308 if(type) type[0] = type[1] = AV_CLASS_CATEGORY_NA + 16; 309 if (*print_prefix && avc) { 310 if (avc->parent_log_context_offset) { 311 AVClass** parent = *(AVClass ***) (((uint8_t *) avcl) + 312 avc->parent_log_context_offset); 313 if (parent && *parent) { 314 av_bprintf(part+0, "[%s @ %p] ", 315 item_name(parent, *parent), parent); 316 if(type) type[0] = get_category(parent); 317 } 318 } 319 av_bprintf(part+1, "[%s @ %p] ", 320 item_name(avcl, avc), avcl); 321 if(type) type[1] = get_category(avcl); 322 } 323 324 if (*print_prefix && (level > AV_LOG_QUIET) && (flags & AV_LOG_PRINT_LEVEL)) 325 av_bprintf(part+2, "[%s] ", get_level_str(level)); 326 327 av_vbprintf(part+3, fmt, vl); 328 329 if(*part[0].str || *part[1].str || *part[2].str || *part[3].str) { 330 char lastc = part[3].len && part[3].len <= part[3].size ? part[3].str[part[3].len - 1] : 0; 331 *print_prefix = lastc == '\n' || lastc == '\r'; 332 } 333 } 334 335 void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl, 336 char *line, int line_size, int *print_prefix) 337 { 338 av_log_format_line2(ptr, level, fmt, vl, line, line_size, print_prefix); 339 } 340 341 int av_log_format_line2(void *ptr, int level, const char *fmt, va_list vl, 342 char *line, int line_size, int *print_prefix) 343 { 344 AVBPrint part[4]; 345 int ret; 346 347 format_line(ptr, level, fmt, vl, part, print_prefix, NULL); 348 ret = snprintf(line, line_size, "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str); 349 av_bprint_finalize(part+3, NULL); 350 return ret; 351 } 352 353 void av_log_default_callback(void* ptr, int level, const char* fmt, va_list vl) 354 { 355 static int print_prefix = 1; 356 static int count; 357 static char prev[LINE_SZ]; 358 AVBPrint part[4]; 359 char line[LINE_SZ]; 360 static int is_atty; 361 int type[2]; 362 unsigned tint = 0; 363 364 if (level >= 0) { 365 tint = level & 0xff00; 366 level &= 0xff; 367 } 368 369 if (level > av_log_level) 370 return; 371 ff_mutex_lock(&mutex); 372 373 format_line(ptr, level, fmt, vl, part, &print_prefix, type); 374 snprintf(line, sizeof(line), "%s%s%s%s", part[0].str, part[1].str, part[2].str, part[3].str); 375 376 #if HAVE_ISATTY 377 if (!is_atty) 378 is_atty = isatty(2) ? 1 : -1; 379 #endif 380 381 if (print_prefix && (flags & AV_LOG_SKIP_REPEATED) && !strcmp(line, prev) && 382 *line && line[strlen(line) - 1] != '\r'){ 383 count++; 384 if (is_atty == 1) 385 fprintf(stderr, " Last message repeated %d times\r", count); 386 goto end; 387 } 388 if (count > 0) { 389 fprintf(stderr, " Last message repeated %d times\n", count); 390 count = 0; 391 } 392 strcpy(prev, line); 393 sanitize(part[0].str); 394 colored_fputs(type[0], 0, part[0].str); 395 sanitize(part[1].str); 396 colored_fputs(type[1], 0, part[1].str); 397 sanitize(part[2].str); 398 colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[2].str); 399 sanitize(part[3].str); 400 colored_fputs(av_clip(level >> 3, 0, NB_LEVELS - 1), tint >> 8, part[3].str); 401 402 #if CONFIG_VALGRIND_BACKTRACE 403 if (level <= BACKTRACE_LOGLEVEL) 404 VALGRIND_PRINTF_BACKTRACE("%s", ""); 405 #endif 406 end: 407 av_bprint_finalize(part+3, NULL); 408 ff_mutex_unlock(&mutex); 409 } 410 411 static void (*av_log_callback)(void*, int, const char*, va_list) = 412 av_log_default_callback; 413 414 void av_log(void* avcl, int level, const char *fmt, ...) 415 { 416 va_list vl; 417 va_start(vl, fmt); 418 av_vlog(avcl, level, fmt, vl); 419 va_end(vl); 420 } 421 422 void av_log_once(void* avcl, int initial_level, int subsequent_level, int *state, const char *fmt, ...) 423 { 424 va_list vl; 425 va_start(vl, fmt); 426 av_vlog(avcl, *state ? subsequent_level : initial_level, fmt, vl); 427 va_end(vl); 428 *state = 1; 429 } 430 431 void av_vlog(void* avcl, int level, const char *fmt, va_list vl) 432 { 433 AVClass* avc = avcl ? *(AVClass **) avcl : NULL; 434 void (*log_callback)(void*, int, const char*, va_list) = av_log_callback; 435 if (avc && avc->version >= (50 << 16 | 15 << 8 | 2) && 436 avc->log_level_offset_offset && level >= AV_LOG_FATAL) 437 level += *(int *) (((uint8_t *) avcl) + avc->log_level_offset_offset); 438 if (log_callback) 439 log_callback(avcl, level, fmt, vl); 440 } 441 442 int av_log_get_level(void) 443 { 444 return av_log_level; 445 } 446 447 void av_log_set_level(int level) 448 { 449 av_log_level = level; 450 } 451 452 void av_log_set_flags(int arg) 453 { 454 flags = arg; 455 } 456 457 int av_log_get_flags(void) 458 { 459 return flags; 460 } 461 462 void av_log_set_callback(void (*callback)(void*, int, const char*, va_list)) 463 { 464 av_log_callback = callback; 465 } 466 467 static void missing_feature_sample(int sample, void *avc, const char *msg, 468 va_list argument_list) 469 { 470 av_vlog(avc, AV_LOG_WARNING, msg, argument_list); 471 av_log(avc, AV_LOG_WARNING, " is not implemented. Update your FFmpeg " 472 "version to the newest one from Git. If the problem still " 473 "occurs, it means that your file has a feature which has not " 474 "been implemented.\n"); 475 if (sample) 476 av_log(avc, AV_LOG_WARNING, "If you want to help, upload a sample " 477 "of this file to https://streams.videolan.org/upload/ " 478 "and contact the ffmpeg-devel mailing list. (ffmpeg-devel@ffmpeg.org)\n"); 479 } 480 481 void avpriv_request_sample(void *avc, const char *msg, ...) 482 { 483 va_list argument_list; 484 485 va_start(argument_list, msg); 486 missing_feature_sample(1, avc, msg, argument_list); 487 va_end(argument_list); 488 } 489 490 void avpriv_report_missing_feature(void *avc, const char *msg, ...) 491 { 492 va_list argument_list; 493 494 va_start(argument_list, msg); 495 missing_feature_sample(0, avc, msg, argument_list); 496 va_end(argument_list); 497 }