2 * Various pretty-printing functions for use within FFmpeg
3 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
25 #include "libavutil/channel_layout.h"
26 #include "libavutil/display.h"
27 #include "libavutil/intreadwrite.h"
28 #include "libavutil/log.h"
29 #include "libavutil/mastering_display_metadata.h"
30 #include "libavutil/mathematics.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/replaygain.h"
34 #include "libavutil/stereo3d.h"
38 #define HEXDUMP_PRINT(...) \
41 av_log(avcl, level, __VA_ARGS__); \
43 fprintf(f, __VA_ARGS__); \
46 static void hex_dump_internal(void *avcl, FILE *f, int level,
47 const uint8_t *buf, int size)
51 for (i = 0; i < size; i += 16) {
55 HEXDUMP_PRINT("%08x ", i);
56 for (j = 0; j < 16; j++) {
58 HEXDUMP_PRINT(" %02x", buf[i + j]);
63 for (j = 0; j < len; j++) {
65 if (c < ' ' || c > '~')
67 HEXDUMP_PRINT("%c", c);
73 void av_hex_dump(FILE *f, const uint8_t *buf, int size)
75 hex_dump_internal(NULL, f, 0, buf, size);
78 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size)
80 hex_dump_internal(avcl, NULL, level, buf, size);
83 static void pkt_dump_internal(void *avcl, FILE *f, int level, const AVPacket *pkt,
84 int dump_payload, AVRational time_base)
86 HEXDUMP_PRINT("stream #%d:\n", pkt->stream_index);
87 HEXDUMP_PRINT(" keyframe=%d\n", (pkt->flags & AV_PKT_FLAG_KEY) != 0);
88 HEXDUMP_PRINT(" duration=%0.3f\n", pkt->duration * av_q2d(time_base));
89 /* DTS is _always_ valid after av_read_frame() */
90 HEXDUMP_PRINT(" dts=");
91 if (pkt->dts == AV_NOPTS_VALUE)
94 HEXDUMP_PRINT("%0.3f", pkt->dts * av_q2d(time_base));
95 /* PTS may not be known if B-frames are present. */
96 HEXDUMP_PRINT(" pts=");
97 if (pkt->pts == AV_NOPTS_VALUE)
100 HEXDUMP_PRINT("%0.3f", pkt->pts * av_q2d(time_base));
102 HEXDUMP_PRINT(" size=%d\n", pkt->size);
104 hex_dump_internal(avcl, f, level, pkt->data, pkt->size);
107 void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st)
109 pkt_dump_internal(NULL, f, 0, pkt, dump_payload, st->time_base);
112 void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload,
115 pkt_dump_internal(avcl, NULL, level, pkt, dump_payload, st->time_base);
119 static void print_fps(double d, const char *postfix)
121 uint64_t v = lrintf(d * 100);
123 av_log(NULL, AV_LOG_INFO, "%1.4f %s", d, postfix);
125 av_log(NULL, AV_LOG_INFO, "%3.2f %s", d, postfix);
126 else if (v % (100 * 1000))
127 av_log(NULL, AV_LOG_INFO, "%1.0f %s", d, postfix);
129 av_log(NULL, AV_LOG_INFO, "%1.0fk %s", d / 1000, postfix);
132 static void dump_metadata(void *ctx, AVDictionary *m, const char *indent)
134 if (m && !(av_dict_count(m) == 1 && av_dict_get(m, "language", NULL, 0))) {
135 AVDictionaryEntry *tag = NULL;
137 av_log(ctx, AV_LOG_INFO, "%sMetadata:\n", indent);
138 while ((tag = av_dict_get(m, "", tag, AV_DICT_IGNORE_SUFFIX)))
139 if (strcmp("language", tag->key)) {
140 const char *p = tag->value;
141 av_log(ctx, AV_LOG_INFO,
142 "%s %-16s: ", indent, tag->key);
145 size_t len = strcspn(p, "\x8\xa\xb\xc\xd");
146 av_strlcpy(tmp, p, FFMIN(sizeof(tmp), len+1));
147 av_log(ctx, AV_LOG_INFO, "%s", tmp);
149 if (*p == 0xd) av_log(ctx, AV_LOG_INFO, " ");
150 if (*p == 0xa) av_log(ctx, AV_LOG_INFO, "\n%s %-16s: ", indent, "");
153 av_log(ctx, AV_LOG_INFO, "\n");
158 /* param change side data*/
159 static void dump_paramchange(void *ctx, AVPacketSideData *sd)
162 const uint8_t *data = sd->data;
163 uint32_t flags, channels, sample_rate, width, height;
166 if (!data || sd->size < 4)
169 flags = AV_RL32(data);
173 if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) {
176 channels = AV_RL32(data);
179 av_log(ctx, AV_LOG_INFO, "channel count %"PRIu32", ", channels);
181 if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) {
184 layout = AV_RL64(data);
187 av_log(ctx, AV_LOG_INFO,
188 "channel layout: %s, ", av_get_channel_name(layout));
190 if (flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) {
193 sample_rate = AV_RL32(data);
196 av_log(ctx, AV_LOG_INFO, "sample_rate %"PRIu32", ", sample_rate);
198 if (flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) {
201 width = AV_RL32(data);
204 height = AV_RL32(data);
207 av_log(ctx, AV_LOG_INFO, "width %"PRIu32" height %"PRIu32, width, height);
212 av_log(ctx, AV_LOG_INFO, "unknown param");
215 /* replaygain side data*/
216 static void print_gain(void *ctx, const char *str, int32_t gain)
218 av_log(ctx, AV_LOG_INFO, "%s - ", str);
219 if (gain == INT32_MIN)
220 av_log(ctx, AV_LOG_INFO, "unknown");
222 av_log(ctx, AV_LOG_INFO, "%f", gain / 100000.0f);
223 av_log(ctx, AV_LOG_INFO, ", ");
226 static void print_peak(void *ctx, const char *str, uint32_t peak)
228 av_log(ctx, AV_LOG_INFO, "%s - ", str);
230 av_log(ctx, AV_LOG_INFO, "unknown");
232 av_log(ctx, AV_LOG_INFO, "%f", (float) peak / UINT32_MAX);
233 av_log(ctx, AV_LOG_INFO, ", ");
236 static void dump_replaygain(void *ctx, AVPacketSideData *sd)
240 if (sd->size < sizeof(*rg)) {
241 av_log(ctx, AV_LOG_INFO, "invalid data");
244 rg = (AVReplayGain*)sd->data;
246 print_gain(ctx, "track gain", rg->track_gain);
247 print_peak(ctx, "track peak", rg->track_peak);
248 print_gain(ctx, "album gain", rg->album_gain);
249 print_peak(ctx, "album peak", rg->album_peak);
252 static void dump_stereo3d(void *ctx, AVPacketSideData *sd)
257 if (sd->size < sizeof(*stereo)) {
258 av_log(ctx, AV_LOG_INFO, "invalid data");
262 stereo = (AVStereo3D *)sd->data;
264 av_log(ctx, AV_LOG_INFO, "%s", av_stereo3d_type_name(stereo->type));
266 if (stereo->flags & AV_STEREO3D_FLAG_INVERT)
267 av_log(ctx, AV_LOG_INFO, " (inverted)");
270 static void dump_audioservicetype(void *ctx, AVPacketSideData *sd)
272 enum AVAudioServiceType *ast = (enum AVAudioServiceType *)sd->data;
274 if (sd->size < sizeof(*ast)) {
275 av_log(ctx, AV_LOG_INFO, "invalid data");
280 case AV_AUDIO_SERVICE_TYPE_MAIN:
281 av_log(ctx, AV_LOG_INFO, "main");
283 case AV_AUDIO_SERVICE_TYPE_EFFECTS:
284 av_log(ctx, AV_LOG_INFO, "effects");
286 case AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED:
287 av_log(ctx, AV_LOG_INFO, "visually impaired");
289 case AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED:
290 av_log(ctx, AV_LOG_INFO, "hearing impaired");
292 case AV_AUDIO_SERVICE_TYPE_DIALOGUE:
293 av_log(ctx, AV_LOG_INFO, "dialogue");
295 case AV_AUDIO_SERVICE_TYPE_COMMENTARY:
296 av_log(ctx, AV_LOG_INFO, "comentary");
298 case AV_AUDIO_SERVICE_TYPE_EMERGENCY:
299 av_log(ctx, AV_LOG_INFO, "emergency");
301 case AV_AUDIO_SERVICE_TYPE_VOICE_OVER:
302 av_log(ctx, AV_LOG_INFO, "voice over");
304 case AV_AUDIO_SERVICE_TYPE_KARAOKE:
305 av_log(ctx, AV_LOG_INFO, "karaoke");
308 av_log(ctx, AV_LOG_WARNING, "unknown");
313 static void dump_cpb(void *ctx, AVPacketSideData *sd)
315 AVCPBProperties *cpb = (AVCPBProperties *)sd->data;
317 if (sd->size < sizeof(*cpb)) {
318 av_log(ctx, AV_LOG_INFO, "invalid data");
322 av_log(ctx, AV_LOG_INFO,
323 "bitrate max/min/avg: %d/%d/%d buffer size: %d vbv_delay: %"PRId64,
324 cpb->max_bitrate, cpb->min_bitrate, cpb->avg_bitrate,
329 static void dump_mastering_display_metadata(void *ctx, AVPacketSideData* sd) {
330 AVMasteringDisplayMetadata* metadata = (AVMasteringDisplayMetadata*)sd->data;
331 av_log(ctx, AV_LOG_INFO, "Mastering Display Metadata, "
332 "has_primaries:%d has_luminance:%d "
333 "r(%5.4f,%5.4f) g(%5.4f,%5.4f) b(%5.4f %5.4f) wp(%5.4f, %5.4f) "
334 "min_luminance=%f, max_luminance=%f\n",
335 metadata->has_primaries, metadata->has_luminance,
336 av_q2d(metadata->display_primaries[0][0]),
337 av_q2d(metadata->display_primaries[0][1]),
338 av_q2d(metadata->display_primaries[1][0]),
339 av_q2d(metadata->display_primaries[1][1]),
340 av_q2d(metadata->display_primaries[2][0]),
341 av_q2d(metadata->display_primaries[2][1]),
342 av_q2d(metadata->white_point[0]), av_q2d(metadata->white_point[1]),
343 av_q2d(metadata->min_luminance), av_q2d(metadata->max_luminance));
346 static void dump_sidedata(void *ctx, AVStream *st, const char *indent)
350 if (st->nb_side_data)
351 av_log(ctx, AV_LOG_INFO, "%sSide data:\n", indent);
353 for (i = 0; i < st->nb_side_data; i++) {
354 AVPacketSideData sd = st->side_data[i];
355 av_log(ctx, AV_LOG_INFO, "%s ", indent);
358 case AV_PKT_DATA_PALETTE:
359 av_log(ctx, AV_LOG_INFO, "palette");
361 case AV_PKT_DATA_NEW_EXTRADATA:
362 av_log(ctx, AV_LOG_INFO, "new extradata");
364 case AV_PKT_DATA_PARAM_CHANGE:
365 av_log(ctx, AV_LOG_INFO, "paramchange: ");
366 dump_paramchange(ctx, &sd);
368 case AV_PKT_DATA_H263_MB_INFO:
369 av_log(ctx, AV_LOG_INFO, "H.263 macroblock info");
371 case AV_PKT_DATA_REPLAYGAIN:
372 av_log(ctx, AV_LOG_INFO, "replaygain: ");
373 dump_replaygain(ctx, &sd);
375 case AV_PKT_DATA_DISPLAYMATRIX:
376 av_log(ctx, AV_LOG_INFO, "displaymatrix: rotation of %.2f degrees",
377 av_display_rotation_get((int32_t *)sd.data));
379 case AV_PKT_DATA_STEREO3D:
380 av_log(ctx, AV_LOG_INFO, "stereo3d: ");
381 dump_stereo3d(ctx, &sd);
383 case AV_PKT_DATA_AUDIO_SERVICE_TYPE:
384 av_log(ctx, AV_LOG_INFO, "audio service type: ");
385 dump_audioservicetype(ctx, &sd);
387 case AV_PKT_DATA_QUALITY_STATS:
388 av_log(ctx, AV_LOG_INFO, "quality factor: %d, pict_type: %c", AV_RL32(sd.data), av_get_picture_type_char(sd.data[4]));
390 case AV_PKT_DATA_CPB_PROPERTIES:
391 av_log(ctx, AV_LOG_INFO, "cpb: ");
394 case AV_PKT_DATA_MASTERING_DISPLAY_METADATA:
395 dump_mastering_display_metadata(ctx, &sd);
398 av_log(ctx, AV_LOG_INFO,
399 "unknown side data type %d (%d bytes)", sd.type, sd.size);
403 av_log(ctx, AV_LOG_INFO, "\n");
407 /* "user interface" functions */
408 static void dump_stream_format(AVFormatContext *ic, int i,
409 int index, int is_output)
412 int flags = (is_output ? ic->oformat->flags : ic->iformat->flags);
413 AVStream *st = ic->streams[i];
414 AVDictionaryEntry *lang = av_dict_get(st->metadata, "language", NULL, 0);
415 char *separator = ic->dump_separator;
416 AVCodecContext *avctx;
419 avctx = avcodec_alloc_context3(NULL);
423 ret = avcodec_parameters_to_context(avctx, st->codecpar);
425 avcodec_free_context(&avctx);
429 // Fields which are missing from AVCodecParameters need to be taken from the AVCodecContext
430 avctx->properties = st->codec->properties;
431 avctx->codec = st->codec->codec;
432 avctx->qmin = st->codec->qmin;
433 avctx->qmax = st->codec->qmax;
434 avctx->coded_width = st->codec->coded_width;
435 avctx->coded_height = st->codec->coded_height;
438 av_opt_set(avctx, "dump_separator", separator, 0);
439 avcodec_string(buf, sizeof(buf), avctx, is_output);
440 avcodec_free_context(&avctx);
442 av_log(NULL, AV_LOG_INFO, " Stream #%d:%d", index, i);
444 /* the pid is an important information, so we display it */
445 /* XXX: add a generic system */
446 if (flags & AVFMT_SHOW_IDS)
447 av_log(NULL, AV_LOG_INFO, "[0x%x]", st->id);
449 av_log(NULL, AV_LOG_INFO, "(%s)", lang->value);
450 av_log(NULL, AV_LOG_DEBUG, ", %d, %d/%d", st->codec_info_nb_frames,
451 st->time_base.num, st->time_base.den);
452 av_log(NULL, AV_LOG_INFO, ": %s", buf);
454 if (st->sample_aspect_ratio.num &&
455 av_cmp_q(st->sample_aspect_ratio, st->codecpar->sample_aspect_ratio)) {
456 AVRational display_aspect_ratio;
457 av_reduce(&display_aspect_ratio.num, &display_aspect_ratio.den,
458 st->codecpar->width * (int64_t)st->sample_aspect_ratio.num,
459 st->codecpar->height * (int64_t)st->sample_aspect_ratio.den,
461 av_log(NULL, AV_LOG_INFO, ", SAR %d:%d DAR %d:%d",
462 st->sample_aspect_ratio.num, st->sample_aspect_ratio.den,
463 display_aspect_ratio.num, display_aspect_ratio.den);
466 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
467 int fps = st->avg_frame_rate.den && st->avg_frame_rate.num;
468 int tbr = st->r_frame_rate.den && st->r_frame_rate.num;
469 int tbn = st->time_base.den && st->time_base.num;
470 int tbc = st->codec->time_base.den && st->codec->time_base.num;
472 if (fps || tbr || tbn || tbc)
473 av_log(NULL, AV_LOG_INFO, "%s", separator);
476 print_fps(av_q2d(st->avg_frame_rate), tbr || tbn || tbc ? "fps, " : "fps");
478 print_fps(av_q2d(st->r_frame_rate), tbn || tbc ? "tbr, " : "tbr");
480 print_fps(1 / av_q2d(st->time_base), tbc ? "tbn, " : "tbn");
482 print_fps(1 / av_q2d(st->codec->time_base), "tbc");
485 if (st->disposition & AV_DISPOSITION_DEFAULT)
486 av_log(NULL, AV_LOG_INFO, " (default)");
487 if (st->disposition & AV_DISPOSITION_DUB)
488 av_log(NULL, AV_LOG_INFO, " (dub)");
489 if (st->disposition & AV_DISPOSITION_ORIGINAL)
490 av_log(NULL, AV_LOG_INFO, " (original)");
491 if (st->disposition & AV_DISPOSITION_COMMENT)
492 av_log(NULL, AV_LOG_INFO, " (comment)");
493 if (st->disposition & AV_DISPOSITION_LYRICS)
494 av_log(NULL, AV_LOG_INFO, " (lyrics)");
495 if (st->disposition & AV_DISPOSITION_KARAOKE)
496 av_log(NULL, AV_LOG_INFO, " (karaoke)");
497 if (st->disposition & AV_DISPOSITION_FORCED)
498 av_log(NULL, AV_LOG_INFO, " (forced)");
499 if (st->disposition & AV_DISPOSITION_HEARING_IMPAIRED)
500 av_log(NULL, AV_LOG_INFO, " (hearing impaired)");
501 if (st->disposition & AV_DISPOSITION_VISUAL_IMPAIRED)
502 av_log(NULL, AV_LOG_INFO, " (visual impaired)");
503 if (st->disposition & AV_DISPOSITION_CLEAN_EFFECTS)
504 av_log(NULL, AV_LOG_INFO, " (clean effects)");
505 av_log(NULL, AV_LOG_INFO, "\n");
507 dump_metadata(NULL, st->metadata, " ");
509 dump_sidedata(NULL, st, " ");
512 void av_dump_format(AVFormatContext *ic, int index,
513 const char *url, int is_output)
516 uint8_t *printed = ic->nb_streams ? av_mallocz(ic->nb_streams) : NULL;
517 if (ic->nb_streams && !printed)
520 av_log(NULL, AV_LOG_INFO, "%s #%d, %s, %s '%s':\n",
521 is_output ? "Output" : "Input",
523 is_output ? ic->oformat->name : ic->iformat->name,
524 is_output ? "to" : "from", url);
525 dump_metadata(NULL, ic->metadata, " ");
528 av_log(NULL, AV_LOG_INFO, " Duration: ");
529 if (ic->duration != AV_NOPTS_VALUE) {
530 int hours, mins, secs, us;
531 int64_t duration = ic->duration + (ic->duration <= INT64_MAX - 5000 ? 5000 : 0);
532 secs = duration / AV_TIME_BASE;
533 us = duration % AV_TIME_BASE;
538 av_log(NULL, AV_LOG_INFO, "%02d:%02d:%02d.%02d", hours, mins, secs,
539 (100 * us) / AV_TIME_BASE);
541 av_log(NULL, AV_LOG_INFO, "N/A");
543 if (ic->start_time != AV_NOPTS_VALUE) {
545 av_log(NULL, AV_LOG_INFO, ", start: ");
546 secs = llabs(ic->start_time / AV_TIME_BASE);
547 us = llabs(ic->start_time % AV_TIME_BASE);
548 av_log(NULL, AV_LOG_INFO, "%s%d.%06d",
549 ic->start_time >= 0 ? "" : "-",
551 (int) av_rescale(us, 1000000, AV_TIME_BASE));
553 av_log(NULL, AV_LOG_INFO, ", bitrate: ");
555 av_log(NULL, AV_LOG_INFO, "%"PRId64" kb/s", (int64_t)ic->bit_rate / 1000);
557 av_log(NULL, AV_LOG_INFO, "N/A");
558 av_log(NULL, AV_LOG_INFO, "\n");
561 for (i = 0; i < ic->nb_chapters; i++) {
562 AVChapter *ch = ic->chapters[i];
563 av_log(NULL, AV_LOG_INFO, " Chapter #%d:%d: ", index, i);
564 av_log(NULL, AV_LOG_INFO,
565 "start %f, ", ch->start * av_q2d(ch->time_base));
566 av_log(NULL, AV_LOG_INFO,
567 "end %f\n", ch->end * av_q2d(ch->time_base));
569 dump_metadata(NULL, ch->metadata, " ");
572 if (ic->nb_programs) {
574 for (j = 0; j < ic->nb_programs; j++) {
575 AVDictionaryEntry *name = av_dict_get(ic->programs[j]->metadata,
577 av_log(NULL, AV_LOG_INFO, " Program %d %s\n", ic->programs[j]->id,
578 name ? name->value : "");
579 dump_metadata(NULL, ic->programs[j]->metadata, " ");
580 for (k = 0; k < ic->programs[j]->nb_stream_indexes; k++) {
581 dump_stream_format(ic, ic->programs[j]->stream_index[k],
583 printed[ic->programs[j]->stream_index[k]] = 1;
585 total += ic->programs[j]->nb_stream_indexes;
587 if (total < ic->nb_streams)
588 av_log(NULL, AV_LOG_INFO, " No Program\n");
591 for (i = 0; i < ic->nb_streams; i++)
593 dump_stream_format(ic, i, index, is_output);