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/spherical.h"
35 #include "libavutil/stereo3d.h"
39 #define HEXDUMP_PRINT(...) \
42 av_log(avcl, level, __VA_ARGS__); \
44 fprintf(f, __VA_ARGS__); \
47 static void hex_dump_internal(void *avcl, FILE *f, int level,
48 const uint8_t *buf, int size)
52 for (i = 0; i < size; i += 16) {
56 HEXDUMP_PRINT("%08x ", i);
57 for (j = 0; j < 16; j++) {
59 HEXDUMP_PRINT(" %02x", buf[i + j]);
64 for (j = 0; j < len; j++) {
66 if (c < ' ' || c > '~')
68 HEXDUMP_PRINT("%c", c);
74 void av_hex_dump(FILE *f, const uint8_t *buf, int size)
76 hex_dump_internal(NULL, f, 0, buf, size);
79 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size)
81 hex_dump_internal(avcl, NULL, level, buf, size);
84 static void pkt_dump_internal(void *avcl, FILE *f, int level, const AVPacket *pkt,
85 int dump_payload, AVRational time_base)
87 HEXDUMP_PRINT("stream #%d:\n", pkt->stream_index);
88 HEXDUMP_PRINT(" keyframe=%d\n", (pkt->flags & AV_PKT_FLAG_KEY) != 0);
89 HEXDUMP_PRINT(" duration=%0.3f\n", pkt->duration * av_q2d(time_base));
90 /* DTS is _always_ valid after av_read_frame() */
91 HEXDUMP_PRINT(" dts=");
92 if (pkt->dts == AV_NOPTS_VALUE)
95 HEXDUMP_PRINT("%0.3f", pkt->dts * av_q2d(time_base));
96 /* PTS may not be known if B-frames are present. */
97 HEXDUMP_PRINT(" pts=");
98 if (pkt->pts == AV_NOPTS_VALUE)
101 HEXDUMP_PRINT("%0.3f", pkt->pts * av_q2d(time_base));
103 HEXDUMP_PRINT(" size=%d\n", pkt->size);
105 hex_dump_internal(avcl, f, level, pkt->data, pkt->size);
108 void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st)
110 pkt_dump_internal(NULL, f, 0, pkt, dump_payload, st->time_base);
113 void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload,
116 pkt_dump_internal(avcl, NULL, level, pkt, dump_payload, st->time_base);
120 static void print_fps(double d, const char *postfix)
122 uint64_t v = lrintf(d * 100);
124 av_log(NULL, AV_LOG_INFO, "%1.4f %s", d, postfix);
126 av_log(NULL, AV_LOG_INFO, "%3.2f %s", d, postfix);
127 else if (v % (100 * 1000))
128 av_log(NULL, AV_LOG_INFO, "%1.0f %s", d, postfix);
130 av_log(NULL, AV_LOG_INFO, "%1.0fk %s", d / 1000, postfix);
133 static void dump_metadata(void *ctx, AVDictionary *m, const char *indent)
135 if (m && !(av_dict_count(m) == 1 && av_dict_get(m, "language", NULL, 0))) {
136 AVDictionaryEntry *tag = NULL;
138 av_log(ctx, AV_LOG_INFO, "%sMetadata:\n", indent);
139 while ((tag = av_dict_get(m, "", tag, AV_DICT_IGNORE_SUFFIX)))
140 if (strcmp("language", tag->key)) {
141 const char *p = tag->value;
142 av_log(ctx, AV_LOG_INFO,
143 "%s %-16s: ", indent, tag->key);
146 size_t len = strcspn(p, "\x8\xa\xb\xc\xd");
147 av_strlcpy(tmp, p, FFMIN(sizeof(tmp), len+1));
148 av_log(ctx, AV_LOG_INFO, "%s", tmp);
150 if (*p == 0xd) av_log(ctx, AV_LOG_INFO, " ");
151 if (*p == 0xa) av_log(ctx, AV_LOG_INFO, "\n%s %-16s: ", indent, "");
154 av_log(ctx, AV_LOG_INFO, "\n");
159 /* param change side data*/
160 static void dump_paramchange(void *ctx, AVPacketSideData *sd)
163 const uint8_t *data = sd->data;
164 uint32_t flags, channels, sample_rate, width, height;
167 if (!data || sd->size < 4)
170 flags = AV_RL32(data);
174 if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) {
177 channels = AV_RL32(data);
180 av_log(ctx, AV_LOG_INFO, "channel count %"PRIu32", ", channels);
182 if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) {
185 layout = AV_RL64(data);
188 av_log(ctx, AV_LOG_INFO,
189 "channel layout: %s, ", av_get_channel_name(layout));
191 if (flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) {
194 sample_rate = AV_RL32(data);
197 av_log(ctx, AV_LOG_INFO, "sample_rate %"PRIu32", ", sample_rate);
199 if (flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) {
202 width = AV_RL32(data);
205 height = AV_RL32(data);
208 av_log(ctx, AV_LOG_INFO, "width %"PRIu32" height %"PRIu32, width, height);
213 av_log(ctx, AV_LOG_INFO, "unknown param");
216 /* replaygain side data*/
217 static void print_gain(void *ctx, const char *str, int32_t gain)
219 av_log(ctx, AV_LOG_INFO, "%s - ", str);
220 if (gain == INT32_MIN)
221 av_log(ctx, AV_LOG_INFO, "unknown");
223 av_log(ctx, AV_LOG_INFO, "%f", gain / 100000.0f);
224 av_log(ctx, AV_LOG_INFO, ", ");
227 static void print_peak(void *ctx, const char *str, uint32_t peak)
229 av_log(ctx, AV_LOG_INFO, "%s - ", str);
231 av_log(ctx, AV_LOG_INFO, "unknown");
233 av_log(ctx, AV_LOG_INFO, "%f", (float) peak / UINT32_MAX);
234 av_log(ctx, AV_LOG_INFO, ", ");
237 static void dump_replaygain(void *ctx, AVPacketSideData *sd)
241 if (sd->size < sizeof(*rg)) {
242 av_log(ctx, AV_LOG_INFO, "invalid data");
245 rg = (AVReplayGain*)sd->data;
247 print_gain(ctx, "track gain", rg->track_gain);
248 print_peak(ctx, "track peak", rg->track_peak);
249 print_gain(ctx, "album gain", rg->album_gain);
250 print_peak(ctx, "album peak", rg->album_peak);
253 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",
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_content_light_metadata(void *ctx, AVPacketSideData* sd)
348 AVContentLightMetadata* metadata = (AVContentLightMetadata*)sd->data;
349 av_log(ctx, AV_LOG_INFO, "Content Light Level Metadata, "
350 "MaxCLL=%d, MaxFALL=%d",
351 metadata->MaxCLL, metadata->MaxFALL);
354 static void dump_spherical(void *ctx, AVCodecParameters *par, AVPacketSideData *sd)
356 AVSphericalMapping *spherical = (AVSphericalMapping *)sd->data;
357 double yaw, pitch, roll;
359 if (sd->size < sizeof(*spherical)) {
360 av_log(ctx, AV_LOG_INFO, "invalid data");
364 av_log(ctx, AV_LOG_INFO, "%s ", av_spherical_projection_name(spherical->projection));
366 yaw = ((double)spherical->yaw) / (1 << 16);
367 pitch = ((double)spherical->pitch) / (1 << 16);
368 roll = ((double)spherical->roll) / (1 << 16);
369 av_log(ctx, AV_LOG_INFO, "(%f/%f/%f) ", yaw, pitch, roll);
371 if (spherical->projection == AV_SPHERICAL_EQUIRECTANGULAR_TILE) {
373 av_spherical_tile_bounds(spherical, par->width, par->height,
375 av_log(ctx, AV_LOG_INFO,
376 "[%"SIZE_SPECIFIER", %"SIZE_SPECIFIER", %"SIZE_SPECIFIER", %"SIZE_SPECIFIER"] ",
378 } else if (spherical->projection == AV_SPHERICAL_CUBEMAP) {
379 av_log(ctx, AV_LOG_INFO, "[pad %"PRIu32"] ", spherical->padding);
383 static void dump_sidedata(void *ctx, AVStream *st, const char *indent)
387 if (st->nb_side_data)
388 av_log(ctx, AV_LOG_INFO, "%sSide data:\n", indent);
390 for (i = 0; i < st->nb_side_data; i++) {
391 AVPacketSideData sd = st->side_data[i];
392 av_log(ctx, AV_LOG_INFO, "%s ", indent);
395 case AV_PKT_DATA_PALETTE:
396 av_log(ctx, AV_LOG_INFO, "palette");
398 case AV_PKT_DATA_NEW_EXTRADATA:
399 av_log(ctx, AV_LOG_INFO, "new extradata");
401 case AV_PKT_DATA_PARAM_CHANGE:
402 av_log(ctx, AV_LOG_INFO, "paramchange: ");
403 dump_paramchange(ctx, &sd);
405 case AV_PKT_DATA_H263_MB_INFO:
406 av_log(ctx, AV_LOG_INFO, "H.263 macroblock info");
408 case AV_PKT_DATA_REPLAYGAIN:
409 av_log(ctx, AV_LOG_INFO, "replaygain: ");
410 dump_replaygain(ctx, &sd);
412 case AV_PKT_DATA_DISPLAYMATRIX:
413 av_log(ctx, AV_LOG_INFO, "displaymatrix: rotation of %.2f degrees",
414 av_display_rotation_get((int32_t *)sd.data));
416 case AV_PKT_DATA_STEREO3D:
417 av_log(ctx, AV_LOG_INFO, "stereo3d: ");
418 dump_stereo3d(ctx, &sd);
420 case AV_PKT_DATA_AUDIO_SERVICE_TYPE:
421 av_log(ctx, AV_LOG_INFO, "audio service type: ");
422 dump_audioservicetype(ctx, &sd);
424 case AV_PKT_DATA_QUALITY_STATS:
425 av_log(ctx, AV_LOG_INFO, "quality factor: %"PRId32", pict_type: %c",
426 AV_RL32(sd.data), av_get_picture_type_char(sd.data[4]));
428 case AV_PKT_DATA_CPB_PROPERTIES:
429 av_log(ctx, AV_LOG_INFO, "cpb: ");
432 case AV_PKT_DATA_MASTERING_DISPLAY_METADATA:
433 dump_mastering_display_metadata(ctx, &sd);
435 case AV_PKT_DATA_SPHERICAL:
436 av_log(ctx, AV_LOG_INFO, "spherical: ");
437 dump_spherical(ctx, st->codecpar, &sd);
439 case AV_PKT_DATA_CONTENT_LIGHT_LEVEL:
440 dump_content_light_metadata(ctx, &sd);
443 av_log(ctx, AV_LOG_INFO,
444 "unknown side data type %d (%d bytes)", sd.type, sd.size);
448 av_log(ctx, AV_LOG_INFO, "\n");
452 /* "user interface" functions */
453 static void dump_stream_format(AVFormatContext *ic, int i,
454 int index, int is_output)
457 int flags = (is_output ? ic->oformat->flags : ic->iformat->flags);
458 AVStream *st = ic->streams[i];
459 AVDictionaryEntry *lang = av_dict_get(st->metadata, "language", NULL, 0);
460 char *separator = ic->dump_separator;
461 AVCodecContext *avctx;
464 avctx = avcodec_alloc_context3(NULL);
468 ret = avcodec_parameters_to_context(avctx, st->codecpar);
470 avcodec_free_context(&avctx);
474 // Fields which are missing from AVCodecParameters need to be taken from the AVCodecContext
475 avctx->properties = st->codec->properties;
476 avctx->codec = st->codec->codec;
477 avctx->qmin = st->codec->qmin;
478 avctx->qmax = st->codec->qmax;
479 avctx->coded_width = st->codec->coded_width;
480 avctx->coded_height = st->codec->coded_height;
483 av_opt_set(avctx, "dump_separator", separator, 0);
484 avcodec_string(buf, sizeof(buf), avctx, is_output);
485 avcodec_free_context(&avctx);
487 av_log(NULL, AV_LOG_INFO, " Stream #%d:%d", index, i);
489 /* the pid is an important information, so we display it */
490 /* XXX: add a generic system */
491 if (flags & AVFMT_SHOW_IDS)
492 av_log(NULL, AV_LOG_INFO, "[0x%x]", st->id);
494 av_log(NULL, AV_LOG_INFO, "(%s)", lang->value);
495 av_log(NULL, AV_LOG_DEBUG, ", %d, %d/%d", st->codec_info_nb_frames,
496 st->time_base.num, st->time_base.den);
497 av_log(NULL, AV_LOG_INFO, ": %s", buf);
499 if (st->sample_aspect_ratio.num &&
500 av_cmp_q(st->sample_aspect_ratio, st->codecpar->sample_aspect_ratio)) {
501 AVRational display_aspect_ratio;
502 av_reduce(&display_aspect_ratio.num, &display_aspect_ratio.den,
503 st->codecpar->width * (int64_t)st->sample_aspect_ratio.num,
504 st->codecpar->height * (int64_t)st->sample_aspect_ratio.den,
506 av_log(NULL, AV_LOG_INFO, ", SAR %d:%d DAR %d:%d",
507 st->sample_aspect_ratio.num, st->sample_aspect_ratio.den,
508 display_aspect_ratio.num, display_aspect_ratio.den);
511 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
512 int fps = st->avg_frame_rate.den && st->avg_frame_rate.num;
513 int tbr = st->r_frame_rate.den && st->r_frame_rate.num;
514 int tbn = st->time_base.den && st->time_base.num;
515 int tbc = st->codec->time_base.den && st->codec->time_base.num;
517 if (fps || tbr || tbn || tbc)
518 av_log(NULL, AV_LOG_INFO, "%s", separator);
521 print_fps(av_q2d(st->avg_frame_rate), tbr || tbn || tbc ? "fps, " : "fps");
523 print_fps(av_q2d(st->r_frame_rate), tbn || tbc ? "tbr, " : "tbr");
525 print_fps(1 / av_q2d(st->time_base), tbc ? "tbn, " : "tbn");
527 print_fps(1 / av_q2d(st->codec->time_base), "tbc");
530 if (st->disposition & AV_DISPOSITION_DEFAULT)
531 av_log(NULL, AV_LOG_INFO, " (default)");
532 if (st->disposition & AV_DISPOSITION_DUB)
533 av_log(NULL, AV_LOG_INFO, " (dub)");
534 if (st->disposition & AV_DISPOSITION_ORIGINAL)
535 av_log(NULL, AV_LOG_INFO, " (original)");
536 if (st->disposition & AV_DISPOSITION_COMMENT)
537 av_log(NULL, AV_LOG_INFO, " (comment)");
538 if (st->disposition & AV_DISPOSITION_LYRICS)
539 av_log(NULL, AV_LOG_INFO, " (lyrics)");
540 if (st->disposition & AV_DISPOSITION_KARAOKE)
541 av_log(NULL, AV_LOG_INFO, " (karaoke)");
542 if (st->disposition & AV_DISPOSITION_FORCED)
543 av_log(NULL, AV_LOG_INFO, " (forced)");
544 if (st->disposition & AV_DISPOSITION_HEARING_IMPAIRED)
545 av_log(NULL, AV_LOG_INFO, " (hearing impaired)");
546 if (st->disposition & AV_DISPOSITION_VISUAL_IMPAIRED)
547 av_log(NULL, AV_LOG_INFO, " (visual impaired)");
548 if (st->disposition & AV_DISPOSITION_CLEAN_EFFECTS)
549 av_log(NULL, AV_LOG_INFO, " (clean effects)");
550 av_log(NULL, AV_LOG_INFO, "\n");
552 dump_metadata(NULL, st->metadata, " ");
554 dump_sidedata(NULL, st, " ");
557 void av_dump_format(AVFormatContext *ic, int index,
558 const char *url, int is_output)
561 uint8_t *printed = ic->nb_streams ? av_mallocz(ic->nb_streams) : NULL;
562 if (ic->nb_streams && !printed)
565 av_log(NULL, AV_LOG_INFO, "%s #%d, %s, %s '%s':\n",
566 is_output ? "Output" : "Input",
568 is_output ? ic->oformat->name : ic->iformat->name,
569 is_output ? "to" : "from", url);
570 dump_metadata(NULL, ic->metadata, " ");
573 av_log(NULL, AV_LOG_INFO, " Duration: ");
574 if (ic->duration != AV_NOPTS_VALUE) {
575 int hours, mins, secs, us;
576 int64_t duration = ic->duration + (ic->duration <= INT64_MAX - 5000 ? 5000 : 0);
577 secs = duration / AV_TIME_BASE;
578 us = duration % AV_TIME_BASE;
583 av_log(NULL, AV_LOG_INFO, "%02d:%02d:%02d.%02d", hours, mins, secs,
584 (100 * us) / AV_TIME_BASE);
586 av_log(NULL, AV_LOG_INFO, "N/A");
588 if (ic->start_time != AV_NOPTS_VALUE) {
590 av_log(NULL, AV_LOG_INFO, ", start: ");
591 secs = llabs(ic->start_time / AV_TIME_BASE);
592 us = llabs(ic->start_time % AV_TIME_BASE);
593 av_log(NULL, AV_LOG_INFO, "%s%d.%06d",
594 ic->start_time >= 0 ? "" : "-",
596 (int) av_rescale(us, 1000000, AV_TIME_BASE));
598 av_log(NULL, AV_LOG_INFO, ", bitrate: ");
600 av_log(NULL, AV_LOG_INFO, "%"PRId64" kb/s", ic->bit_rate / 1000);
602 av_log(NULL, AV_LOG_INFO, "N/A");
603 av_log(NULL, AV_LOG_INFO, "\n");
606 for (i = 0; i < ic->nb_chapters; i++) {
607 AVChapter *ch = ic->chapters[i];
608 av_log(NULL, AV_LOG_INFO, " Chapter #%d:%d: ", index, i);
609 av_log(NULL, AV_LOG_INFO,
610 "start %f, ", ch->start * av_q2d(ch->time_base));
611 av_log(NULL, AV_LOG_INFO,
612 "end %f\n", ch->end * av_q2d(ch->time_base));
614 dump_metadata(NULL, ch->metadata, " ");
617 if (ic->nb_programs) {
619 for (j = 0; j < ic->nb_programs; j++) {
620 AVDictionaryEntry *name = av_dict_get(ic->programs[j]->metadata,
622 av_log(NULL, AV_LOG_INFO, " Program %d %s\n", ic->programs[j]->id,
623 name ? name->value : "");
624 dump_metadata(NULL, ic->programs[j]->metadata, " ");
625 for (k = 0; k < ic->programs[j]->nb_stream_indexes; k++) {
626 dump_stream_format(ic, ic->programs[j]->stream_index[k],
628 printed[ic->programs[j]->stream_index[k]] = 1;
630 total += ic->programs[j]->nb_stream_indexes;
632 if (total < ic->nb_streams)
633 av_log(NULL, AV_LOG_INFO, " No Program\n");
636 for (i = 0; i < ic->nb_streams; i++)
638 dump_stream_format(ic, i, index, is_output);