libavformat/dump.c
2dc26561
 /*
83d100ba
  * Various pretty-printing functions for use within FFmpeg
7b7afaf8
  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
2dc26561
  *
83d100ba
  * This file is part of FFmpeg.
2dc26561
  *
83d100ba
  * FFmpeg is free software; you can redistribute it and/or
2dc26561
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
83d100ba
  * FFmpeg is distributed in the hope that it will be useful,
2dc26561
  * 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
83d100ba
  * License along with FFmpeg; if not, write to the Free Software
2dc26561
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #include <stdio.h>
 #include <stdint.h>
 
711aa2a8
 #include "libavutil/channel_layout.h"
 #include "libavutil/display.h"
 #include "libavutil/intreadwrite.h"
2dc26561
 #include "libavutil/log.h"
 #include "libavutil/mathematics.h"
83d100ba
 #include "libavutil/avstring.h"
711aa2a8
 #include "libavutil/replaygain.h"
93014864
 #include "libavutil/stereo3d.h"
2dc26561
 
 #include "avformat.h"
 
 #define HEXDUMP_PRINT(...)                                                    \
     do {                                                                      \
         if (!f)                                                               \
             av_log(avcl, level, __VA_ARGS__);                                 \
         else                                                                  \
             fprintf(f, __VA_ARGS__);                                          \
     } while (0)
 
 static void hex_dump_internal(void *avcl, FILE *f, int level,
                               const uint8_t *buf, int size)
 {
     int len, i, j, c;
 
     for (i = 0; i < size; i += 16) {
         len = size - i;
         if (len > 16)
             len = 16;
         HEXDUMP_PRINT("%08x ", i);
         for (j = 0; j < 16; j++) {
             if (j < len)
                 HEXDUMP_PRINT(" %02x", buf[i + j]);
             else
                 HEXDUMP_PRINT("   ");
         }
         HEXDUMP_PRINT(" ");
         for (j = 0; j < len; j++) {
             c = buf[i + j];
             if (c < ' ' || c > '~')
                 c = '.';
             HEXDUMP_PRINT("%c", c);
         }
         HEXDUMP_PRINT("\n");
     }
 }
 
 void av_hex_dump(FILE *f, const uint8_t *buf, int size)
 {
     hex_dump_internal(NULL, f, 0, buf, size);
 }
 
 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size)
 {
     hex_dump_internal(avcl, NULL, level, buf, size);
 }
 
83d100ba
 static void pkt_dump_internal(void *avcl, FILE *f, int level, const AVPacket *pkt,
2dc26561
                               int dump_payload, AVRational time_base)
 {
     HEXDUMP_PRINT("stream #%d:\n", pkt->stream_index);
     HEXDUMP_PRINT("  keyframe=%d\n", (pkt->flags & AV_PKT_FLAG_KEY) != 0);
     HEXDUMP_PRINT("  duration=%0.3f\n", pkt->duration * av_q2d(time_base));
     /* DTS is _always_ valid after av_read_frame() */
     HEXDUMP_PRINT("  dts=");
     if (pkt->dts == AV_NOPTS_VALUE)
         HEXDUMP_PRINT("N/A");
     else
         HEXDUMP_PRINT("%0.3f", pkt->dts * av_q2d(time_base));
     /* PTS may not be known if B-frames are present. */
     HEXDUMP_PRINT("  pts=");
     if (pkt->pts == AV_NOPTS_VALUE)
         HEXDUMP_PRINT("N/A");
     else
         HEXDUMP_PRINT("%0.3f", pkt->pts * av_q2d(time_base));
     HEXDUMP_PRINT("\n");
     HEXDUMP_PRINT("  size=%d\n", pkt->size);
     if (dump_payload)
         av_hex_dump(f, pkt->data, pkt->size);
 }
 
83d100ba
 void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st)
2dc26561
 {
     pkt_dump_internal(NULL, f, 0, pkt, dump_payload, st->time_base);
 }
 
83d100ba
 void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload,
                       const AVStream *st)
2dc26561
 {
     pkt_dump_internal(avcl, NULL, level, pkt, dump_payload, st->time_base);
 }
 
 
 static void print_fps(double d, const char *postfix)
 {
     uint64_t v = lrintf(d * 100);
     if (v % 100)
         av_log(NULL, AV_LOG_INFO, ", %3.2f %s", d, postfix);
     else if (v % (100 * 1000))
         av_log(NULL, AV_LOG_INFO, ", %1.0f %s", d, postfix);
     else
         av_log(NULL, AV_LOG_INFO, ", %1.0fk %s", d / 1000, postfix);
 }
 
 static void dump_metadata(void *ctx, AVDictionary *m, const char *indent)
 {
     if (m && !(av_dict_count(m) == 1 && av_dict_get(m, "language", NULL, 0))) {
         AVDictionaryEntry *tag = NULL;
 
         av_log(ctx, AV_LOG_INFO, "%sMetadata:\n", indent);
         while ((tag = av_dict_get(m, "", tag, AV_DICT_IGNORE_SUFFIX)))
83d100ba
             if (strcmp("language", tag->key)) {
                 const char *p = tag->value;
2dc26561
                 av_log(ctx, AV_LOG_INFO,
83d100ba
                        "%s  %-16s: ", indent, tag->key);
                 while (*p) {
                     char tmp[256];
                     size_t len = strcspn(p, "\x8\xa\xb\xc\xd");
                     av_strlcpy(tmp, p, FFMIN(sizeof(tmp), len+1));
                     av_log(ctx, AV_LOG_INFO, "%s", tmp);
                     p += len;
                     if (*p == 0xd) av_log(ctx, AV_LOG_INFO, " ");
                     if (*p == 0xa) av_log(ctx, AV_LOG_INFO, "\n%s  %-16s: ", indent, "");
                     if (*p) p++;
                 }
                 av_log(ctx, AV_LOG_INFO, "\n");
             }
2dc26561
     }
 }
 
711aa2a8
 /* param change side data*/
 static void dump_paramchange(void *ctx, AVPacketSideData *sd)
 {
     int size = sd->size;
     const uint8_t *data = sd->data;
     uint32_t flags, channels, sample_rate, width, height;
     uint64_t layout;
 
     if (!data || sd->size < 4)
         goto fail;
 
     flags = AV_RL32(data);
     data += 4;
     size -= 4;
 
     if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) {
         if (size < 4)
             goto fail;
         channels = AV_RL32(data);
         data += 4;
         size -= 4;
59ca29a5
         av_log(ctx, AV_LOG_INFO, "channel count %"PRIu32", ", channels);
711aa2a8
     }
     if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) {
         if (size < 8)
             goto fail;
         layout = AV_RL64(data);
         data += 8;
         size -= 8;
         av_log(ctx, AV_LOG_INFO,
                "channel layout: %s, ", av_get_channel_name(layout));
     }
     if (flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) {
         if (size < 4)
             goto fail;
         sample_rate = AV_RL32(data);
         data += 4;
         size -= 4;
59ca29a5
         av_log(ctx, AV_LOG_INFO, "sample_rate %"PRIu32", ", sample_rate);
711aa2a8
     }
     if (flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) {
         if (size < 8)
             goto fail;
         width = AV_RL32(data);
         data += 4;
         size -= 4;
         height = AV_RL32(data);
         data += 4;
         size -= 4;
59ca29a5
         av_log(ctx, AV_LOG_INFO, "width %"PRIu32" height %"PRIu32, width, height);
711aa2a8
     }
 
     return;
 fail:
     av_log(ctx, AV_LOG_INFO, "unknown param");
 }
 
 /* replaygain side data*/
 static void print_gain(void *ctx, const char *str, int32_t gain)
 {
     av_log(ctx, AV_LOG_INFO, "%s - ", str);
     if (gain == INT32_MIN)
         av_log(ctx, AV_LOG_INFO, "unknown");
     else
         av_log(ctx, AV_LOG_INFO, "%f", gain / 100000.0f);
     av_log(ctx, AV_LOG_INFO, ", ");
 }
 
 static void print_peak(void *ctx, const char *str, uint32_t peak)
 {
     av_log(ctx, AV_LOG_INFO, "%s - ", str);
     if (!peak)
         av_log(ctx, AV_LOG_INFO, "unknown");
     else
         av_log(ctx, AV_LOG_INFO, "%f", (float) peak / UINT32_MAX);
     av_log(ctx, AV_LOG_INFO, ", ");
 }
 
 static void dump_replaygain(void *ctx, AVPacketSideData *sd)
 {
     AVReplayGain *rg;
 
     if (sd->size < sizeof(*rg)) {
         av_log(ctx, AV_LOG_INFO, "invalid data");
         return;
     }
     rg = (AVReplayGain*)sd->data;
 
     print_gain(ctx, "track gain", rg->track_gain);
     print_peak(ctx, "track peak", rg->track_peak);
     print_gain(ctx, "album gain", rg->album_gain);
     print_peak(ctx, "album peak", rg->album_peak);
 }
 
93014864
 static void dump_stereo3d(void *ctx, AVPacketSideData *sd)
 {
     AVStereo3D *stereo;
 
     if (sd->size < sizeof(*stereo)) {
         av_log(ctx, AV_LOG_INFO, "invalid data");
         return;
     }
 
     stereo = (AVStereo3D *)sd->data;
 
     switch (stereo->type) {
     case AV_STEREO3D_2D:
         av_log(ctx, AV_LOG_INFO, "2D");
         break;
     case AV_STEREO3D_SIDEBYSIDE:
         av_log(ctx, AV_LOG_INFO, "side by side");
         break;
     case AV_STEREO3D_TOPBOTTOM:
         av_log(ctx, AV_LOG_INFO, "top and bottom");
         break;
     case AV_STEREO3D_FRAMESEQUENCE:
         av_log(ctx, AV_LOG_INFO, "frame alternate");
         break;
     case AV_STEREO3D_CHECKERBOARD:
         av_log(ctx, AV_LOG_INFO, "checkerboard");
         break;
     case AV_STEREO3D_LINES:
         av_log(ctx, AV_LOG_INFO, "interleaved lines");
         break;
     case AV_STEREO3D_COLUMNS:
         av_log(ctx, AV_LOG_INFO, "interleaved columns");
         break;
     case AV_STEREO3D_SIDEBYSIDE_QUINCUNX:
         av_log(ctx, AV_LOG_INFO, "side by side (quincunx subsampling)");
         break;
     default:
         av_log(ctx, AV_LOG_WARNING, "unknown");
         break;
     }
 
     if (stereo->flags & AV_STEREO3D_FLAG_INVERT)
         av_log(ctx, AV_LOG_INFO, " (inverted)");
 }
 
711aa2a8
 static void dump_sidedata(void *ctx, AVStream *st, const char *indent)
 {
     int i;
 
     if (st->nb_side_data)
         av_log(ctx, AV_LOG_INFO, "%sSide data:\n", indent);
 
     for (i = 0; i < st->nb_side_data; i++) {
         AVPacketSideData sd = st->side_data[i];
         av_log(ctx, AV_LOG_INFO, "%s  ", indent);
 
         switch (sd.type) {
         case AV_PKT_DATA_PALETTE:
             av_log(ctx, AV_LOG_INFO, "palette");
             break;
         case AV_PKT_DATA_NEW_EXTRADATA:
             av_log(ctx, AV_LOG_INFO, "new extradata");
             break;
         case AV_PKT_DATA_PARAM_CHANGE:
             av_log(ctx, AV_LOG_INFO, "paramchange: ");
             dump_paramchange(ctx, &sd);
             break;
         case AV_PKT_DATA_H263_MB_INFO:
             av_log(ctx, AV_LOG_INFO, "h263 macroblock info");
             break;
         case AV_PKT_DATA_REPLAYGAIN:
             av_log(ctx, AV_LOG_INFO, "replaygain: ");
             dump_replaygain(ctx, &sd);
             break;
         case AV_PKT_DATA_DISPLAYMATRIX:
             av_log(ctx, AV_LOG_INFO, "displaymatrix: rotation of %.2f degrees",
                    av_display_rotation_get((int32_t *)sd.data));
             break;
93014864
         case AV_PKT_DATA_STEREO3D:
             av_log(ctx, AV_LOG_INFO, "stereo3d: ");
             dump_stereo3d(ctx, &sd);
             break;
711aa2a8
         default:
             av_log(ctx, AV_LOG_WARNING,
                    "unknown side data type %d (%d bytes)", sd.type, sd.size);
             break;
         }
 
         av_log(ctx, AV_LOG_INFO, "\n");
     }
 }
 
2dc26561
 /* "user interface" functions */
 static void dump_stream_format(AVFormatContext *ic, int i,
                                int index, int is_output)
 {
     char buf[256];
     int flags = (is_output ? ic->oformat->flags : ic->iformat->flags);
     AVStream *st = ic->streams[i];
     AVDictionaryEntry *lang = av_dict_get(st->metadata, "language", NULL, 0);
 
     avcodec_string(buf, sizeof(buf), st->codec, is_output);
83d100ba
     av_log(NULL, AV_LOG_INFO, "    Stream #%d:%d", index, i);
2dc26561
 
     /* the pid is an important information, so we display it */
     /* XXX: add a generic system */
     if (flags & AVFMT_SHOW_IDS)
         av_log(NULL, AV_LOG_INFO, "[0x%x]", st->id);
     if (lang)
         av_log(NULL, AV_LOG_INFO, "(%s)", lang->value);
     av_log(NULL, AV_LOG_DEBUG, ", %d, %d/%d", st->codec_info_nb_frames,
3f4edf01
            st->time_base.num, st->time_base.den);
2dc26561
     av_log(NULL, AV_LOG_INFO, ": %s", buf);
 
     if (st->sample_aspect_ratio.num && // default
         av_cmp_q(st->sample_aspect_ratio, st->codec->sample_aspect_ratio)) {
         AVRational display_aspect_ratio;
         av_reduce(&display_aspect_ratio.num, &display_aspect_ratio.den,
                   st->codec->width  * st->sample_aspect_ratio.num,
                   st->codec->height * st->sample_aspect_ratio.den,
                   1024 * 1024);
83d100ba
         av_log(NULL, AV_LOG_INFO, ", SAR %d:%d DAR %d:%d",
2dc26561
                st->sample_aspect_ratio.num, st->sample_aspect_ratio.den,
                display_aspect_ratio.num, display_aspect_ratio.den);
     }
 
     if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
         if (st->avg_frame_rate.den && st->avg_frame_rate.num)
             print_fps(av_q2d(st->avg_frame_rate), "fps");
83d100ba
 #if FF_API_R_FRAME_RATE
         if (st->r_frame_rate.den && st->r_frame_rate.num)
             print_fps(av_q2d(st->r_frame_rate), "tbr");
 #endif
2dc26561
         if (st->time_base.den && st->time_base.num)
             print_fps(1 / av_q2d(st->time_base), "tbn");
         if (st->codec->time_base.den && st->codec->time_base.num)
             print_fps(1 / av_q2d(st->codec->time_base), "tbc");
     }
 
     if (st->disposition & AV_DISPOSITION_DEFAULT)
         av_log(NULL, AV_LOG_INFO, " (default)");
     if (st->disposition & AV_DISPOSITION_DUB)
         av_log(NULL, AV_LOG_INFO, " (dub)");
     if (st->disposition & AV_DISPOSITION_ORIGINAL)
         av_log(NULL, AV_LOG_INFO, " (original)");
     if (st->disposition & AV_DISPOSITION_COMMENT)
         av_log(NULL, AV_LOG_INFO, " (comment)");
     if (st->disposition & AV_DISPOSITION_LYRICS)
         av_log(NULL, AV_LOG_INFO, " (lyrics)");
     if (st->disposition & AV_DISPOSITION_KARAOKE)
         av_log(NULL, AV_LOG_INFO, " (karaoke)");
     if (st->disposition & AV_DISPOSITION_FORCED)
         av_log(NULL, AV_LOG_INFO, " (forced)");
     if (st->disposition & AV_DISPOSITION_HEARING_IMPAIRED)
         av_log(NULL, AV_LOG_INFO, " (hearing impaired)");
     if (st->disposition & AV_DISPOSITION_VISUAL_IMPAIRED)
         av_log(NULL, AV_LOG_INFO, " (visual impaired)");
     if (st->disposition & AV_DISPOSITION_CLEAN_EFFECTS)
         av_log(NULL, AV_LOG_INFO, " (clean effects)");
     av_log(NULL, AV_LOG_INFO, "\n");
 
     dump_metadata(NULL, st->metadata, "    ");
711aa2a8
 
     dump_sidedata(NULL, st, "    ");
2dc26561
 }
 
 void av_dump_format(AVFormatContext *ic, int index,
                     const char *url, int is_output)
 {
     int i;
     uint8_t *printed = ic->nb_streams ? av_mallocz(ic->nb_streams) : NULL;
     if (ic->nb_streams && !printed)
         return;
 
     av_log(NULL, AV_LOG_INFO, "%s #%d, %s, %s '%s':\n",
            is_output ? "Output" : "Input",
            index,
            is_output ? ic->oformat->name : ic->iformat->name,
            is_output ? "to" : "from", url);
     dump_metadata(NULL, ic->metadata, "  ");
 
     if (!is_output) {
         av_log(NULL, AV_LOG_INFO, "  Duration: ");
         if (ic->duration != AV_NOPTS_VALUE) {
             int hours, mins, secs, us;
83d100ba
             int64_t duration = ic->duration + 5000;
             secs  = duration / AV_TIME_BASE;
             us    = duration % AV_TIME_BASE;
2dc26561
             mins  = secs / 60;
             secs %= 60;
             hours = mins / 60;
             mins %= 60;
             av_log(NULL, AV_LOG_INFO, "%02d:%02d:%02d.%02d", hours, mins, secs,
                    (100 * us) / AV_TIME_BASE);
         } else {
             av_log(NULL, AV_LOG_INFO, "N/A");
         }
         if (ic->start_time != AV_NOPTS_VALUE) {
             int secs, us;
             av_log(NULL, AV_LOG_INFO, ", start: ");
             secs = ic->start_time / AV_TIME_BASE;
             us   = abs(ic->start_time % AV_TIME_BASE);
             av_log(NULL, AV_LOG_INFO, "%d.%06d",
                    secs, (int) av_rescale(us, 1000000, AV_TIME_BASE));
         }
         av_log(NULL, AV_LOG_INFO, ", bitrate: ");
         if (ic->bit_rate)
             av_log(NULL, AV_LOG_INFO, "%d kb/s", ic->bit_rate / 1000);
         else
             av_log(NULL, AV_LOG_INFO, "N/A");
         av_log(NULL, AV_LOG_INFO, "\n");
     }
 
     for (i = 0; i < ic->nb_chapters; i++) {
         AVChapter *ch = ic->chapters[i];
         av_log(NULL, AV_LOG_INFO, "    Chapter #%d.%d: ", index, i);
         av_log(NULL, AV_LOG_INFO,
                "start %f, ", ch->start * av_q2d(ch->time_base));
         av_log(NULL, AV_LOG_INFO,
                "end %f\n", ch->end * av_q2d(ch->time_base));
 
         dump_metadata(NULL, ch->metadata, "    ");
     }
 
     if (ic->nb_programs) {
         int j, k, total = 0;
         for (j = 0; j < ic->nb_programs; j++) {
             AVDictionaryEntry *name = av_dict_get(ic->programs[j]->metadata,
                                                   "name", NULL, 0);
             av_log(NULL, AV_LOG_INFO, "  Program %d %s\n", ic->programs[j]->id,
                    name ? name->value : "");
             dump_metadata(NULL, ic->programs[j]->metadata, "    ");
             for (k = 0; k < ic->programs[j]->nb_stream_indexes; k++) {
                 dump_stream_format(ic, ic->programs[j]->stream_index[k],
                                    index, is_output);
                 printed[ic->programs[j]->stream_index[k]] = 1;
             }
             total += ic->programs[j]->nb_stream_indexes;
         }
         if (total < ic->nb_streams)
             av_log(NULL, AV_LOG_INFO, "  No Program\n");
     }
 
     for (i = 0; i < ic->nb_streams; i++)
         if (!printed[i])
             dump_stream_format(ic, i, index, is_output);
 
     av_free(printed);
 }