ae285a3de1778708f3d9c5fa1e982224d8ff1994
[ffmpeg.git] / libavformat / dump.c
1 /*
2  * Various pretty-printing functions for use within Libav
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include <stdio.h>
22 #include <stdint.h>
23
24 #include "libavutil/log.h"
25 #include "libavutil/mathematics.h"
26
27 #include "avformat.h"
28
29 #define HEXDUMP_PRINT(...)                                                    \
30     do {                                                                      \
31         if (!f)                                                               \
32             av_log(avcl, level, __VA_ARGS__);                                 \
33         else                                                                  \
34             fprintf(f, __VA_ARGS__);                                          \
35     } while (0)
36
37 static void hex_dump_internal(void *avcl, FILE *f, int level,
38                               const uint8_t *buf, int size)
39 {
40     int len, i, j, c;
41
42     for (i = 0; i < size; i += 16) {
43         len = size - i;
44         if (len > 16)
45             len = 16;
46         HEXDUMP_PRINT("%08x ", i);
47         for (j = 0; j < 16; j++) {
48             if (j < len)
49                 HEXDUMP_PRINT(" %02x", buf[i + j]);
50             else
51                 HEXDUMP_PRINT("   ");
52         }
53         HEXDUMP_PRINT(" ");
54         for (j = 0; j < len; j++) {
55             c = buf[i + j];
56             if (c < ' ' || c > '~')
57                 c = '.';
58             HEXDUMP_PRINT("%c", c);
59         }
60         HEXDUMP_PRINT("\n");
61     }
62 }
63
64 void av_hex_dump(FILE *f, const uint8_t *buf, int size)
65 {
66     hex_dump_internal(NULL, f, 0, buf, size);
67 }
68
69 void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size)
70 {
71     hex_dump_internal(avcl, NULL, level, buf, size);
72 }
73
74 static void pkt_dump_internal(void *avcl, FILE *f, int level, AVPacket *pkt,
75                               int dump_payload, AVRational time_base)
76 {
77     HEXDUMP_PRINT("stream #%d:\n", pkt->stream_index);
78     HEXDUMP_PRINT("  keyframe=%d\n", (pkt->flags & AV_PKT_FLAG_KEY) != 0);
79     HEXDUMP_PRINT("  duration=%0.3f\n", pkt->duration * av_q2d(time_base));
80     /* DTS is _always_ valid after av_read_frame() */
81     HEXDUMP_PRINT("  dts=");
82     if (pkt->dts == AV_NOPTS_VALUE)
83         HEXDUMP_PRINT("N/A");
84     else
85         HEXDUMP_PRINT("%0.3f", pkt->dts * av_q2d(time_base));
86     /* PTS may not be known if B-frames are present. */
87     HEXDUMP_PRINT("  pts=");
88     if (pkt->pts == AV_NOPTS_VALUE)
89         HEXDUMP_PRINT("N/A");
90     else
91         HEXDUMP_PRINT("%0.3f", pkt->pts * av_q2d(time_base));
92     HEXDUMP_PRINT("\n");
93     HEXDUMP_PRINT("  size=%d\n", pkt->size);
94     if (dump_payload)
95         av_hex_dump(f, pkt->data, pkt->size);
96 }
97
98 void av_pkt_dump2(FILE *f, AVPacket *pkt, int dump_payload, AVStream *st)
99 {
100     pkt_dump_internal(NULL, f, 0, pkt, dump_payload, st->time_base);
101 }
102
103 void av_pkt_dump_log2(void *avcl, int level, AVPacket *pkt, int dump_payload,
104                       AVStream *st)
105 {
106     pkt_dump_internal(avcl, NULL, level, pkt, dump_payload, st->time_base);
107 }
108
109
110 static void print_fps(double d, const char *postfix)
111 {
112     uint64_t v = lrintf(d * 100);
113     if (v % 100)
114         av_log(NULL, AV_LOG_INFO, ", %3.2f %s", d, postfix);
115     else if (v % (100 * 1000))
116         av_log(NULL, AV_LOG_INFO, ", %1.0f %s", d, postfix);
117     else
118         av_log(NULL, AV_LOG_INFO, ", %1.0fk %s", d / 1000, postfix);
119 }
120
121 static void dump_metadata(void *ctx, AVDictionary *m, const char *indent)
122 {
123     if (m && !(av_dict_count(m) == 1 && av_dict_get(m, "language", NULL, 0))) {
124         AVDictionaryEntry *tag = NULL;
125
126         av_log(ctx, AV_LOG_INFO, "%sMetadata:\n", indent);
127         while ((tag = av_dict_get(m, "", tag, AV_DICT_IGNORE_SUFFIX)))
128             if (strcmp("language", tag->key))
129                 av_log(ctx, AV_LOG_INFO,
130                        "%s  %-16s: %s\n", indent, tag->key, tag->value);
131     }
132 }
133
134 /* "user interface" functions */
135 static void dump_stream_format(AVFormatContext *ic, int i,
136                                int index, int is_output)
137 {
138     char buf[256];
139     int flags = (is_output ? ic->oformat->flags : ic->iformat->flags);
140     AVStream *st = ic->streams[i];
141     int g = av_gcd(st->time_base.num, st->time_base.den);
142     AVDictionaryEntry *lang = av_dict_get(st->metadata, "language", NULL, 0);
143
144     avcodec_string(buf, sizeof(buf), st->codec, is_output);
145     av_log(NULL, AV_LOG_INFO, "    Stream #%d.%d", index, i);
146
147     /* the pid is an important information, so we display it */
148     /* XXX: add a generic system */
149     if (flags & AVFMT_SHOW_IDS)
150         av_log(NULL, AV_LOG_INFO, "[0x%x]", st->id);
151     if (lang)
152         av_log(NULL, AV_LOG_INFO, "(%s)", lang->value);
153     av_log(NULL, AV_LOG_DEBUG, ", %d, %d/%d", st->codec_info_nb_frames,
154            st->time_base.num / g, st->time_base.den / g);
155     av_log(NULL, AV_LOG_INFO, ": %s", buf);
156
157     if (st->sample_aspect_ratio.num && // default
158         av_cmp_q(st->sample_aspect_ratio, st->codec->sample_aspect_ratio)) {
159         AVRational display_aspect_ratio;
160         av_reduce(&display_aspect_ratio.num, &display_aspect_ratio.den,
161                   st->codec->width  * st->sample_aspect_ratio.num,
162                   st->codec->height * st->sample_aspect_ratio.den,
163                   1024 * 1024);
164         av_log(NULL, AV_LOG_INFO, ", PAR %d:%d DAR %d:%d",
165                st->sample_aspect_ratio.num, st->sample_aspect_ratio.den,
166                display_aspect_ratio.num, display_aspect_ratio.den);
167     }
168
169     if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
170         if (st->avg_frame_rate.den && st->avg_frame_rate.num)
171             print_fps(av_q2d(st->avg_frame_rate), "fps");
172         if (st->time_base.den && st->time_base.num)
173             print_fps(1 / av_q2d(st->time_base), "tbn");
174         if (st->codec->time_base.den && st->codec->time_base.num)
175             print_fps(1 / av_q2d(st->codec->time_base), "tbc");
176     }
177
178     if (st->disposition & AV_DISPOSITION_DEFAULT)
179         av_log(NULL, AV_LOG_INFO, " (default)");
180     if (st->disposition & AV_DISPOSITION_DUB)
181         av_log(NULL, AV_LOG_INFO, " (dub)");
182     if (st->disposition & AV_DISPOSITION_ORIGINAL)
183         av_log(NULL, AV_LOG_INFO, " (original)");
184     if (st->disposition & AV_DISPOSITION_COMMENT)
185         av_log(NULL, AV_LOG_INFO, " (comment)");
186     if (st->disposition & AV_DISPOSITION_LYRICS)
187         av_log(NULL, AV_LOG_INFO, " (lyrics)");
188     if (st->disposition & AV_DISPOSITION_KARAOKE)
189         av_log(NULL, AV_LOG_INFO, " (karaoke)");
190     if (st->disposition & AV_DISPOSITION_FORCED)
191         av_log(NULL, AV_LOG_INFO, " (forced)");
192     if (st->disposition & AV_DISPOSITION_HEARING_IMPAIRED)
193         av_log(NULL, AV_LOG_INFO, " (hearing impaired)");
194     if (st->disposition & AV_DISPOSITION_VISUAL_IMPAIRED)
195         av_log(NULL, AV_LOG_INFO, " (visual impaired)");
196     if (st->disposition & AV_DISPOSITION_CLEAN_EFFECTS)
197         av_log(NULL, AV_LOG_INFO, " (clean effects)");
198     av_log(NULL, AV_LOG_INFO, "\n");
199
200     dump_metadata(NULL, st->metadata, "    ");
201 }
202
203 void av_dump_format(AVFormatContext *ic, int index,
204                     const char *url, int is_output)
205 {
206     int i;
207     uint8_t *printed = ic->nb_streams ? av_mallocz(ic->nb_streams) : NULL;
208     if (ic->nb_streams && !printed)
209         return;
210
211     av_log(NULL, AV_LOG_INFO, "%s #%d, %s, %s '%s':\n",
212            is_output ? "Output" : "Input",
213            index,
214            is_output ? ic->oformat->name : ic->iformat->name,
215            is_output ? "to" : "from", url);
216     dump_metadata(NULL, ic->metadata, "  ");
217
218     if (!is_output) {
219         av_log(NULL, AV_LOG_INFO, "  Duration: ");
220         if (ic->duration != AV_NOPTS_VALUE) {
221             int hours, mins, secs, us;
222             secs  = ic->duration / AV_TIME_BASE;
223             us    = ic->duration % AV_TIME_BASE;
224             mins  = secs / 60;
225             secs %= 60;
226             hours = mins / 60;
227             mins %= 60;
228             av_log(NULL, AV_LOG_INFO, "%02d:%02d:%02d.%02d", hours, mins, secs,
229                    (100 * us) / AV_TIME_BASE);
230         } else {
231             av_log(NULL, AV_LOG_INFO, "N/A");
232         }
233         if (ic->start_time != AV_NOPTS_VALUE) {
234             int secs, us;
235             av_log(NULL, AV_LOG_INFO, ", start: ");
236             secs = ic->start_time / AV_TIME_BASE;
237             us   = abs(ic->start_time % AV_TIME_BASE);
238             av_log(NULL, AV_LOG_INFO, "%d.%06d",
239                    secs, (int) av_rescale(us, 1000000, AV_TIME_BASE));
240         }
241         av_log(NULL, AV_LOG_INFO, ", bitrate: ");
242         if (ic->bit_rate)
243             av_log(NULL, AV_LOG_INFO, "%d kb/s", ic->bit_rate / 1000);
244         else
245             av_log(NULL, AV_LOG_INFO, "N/A");
246         av_log(NULL, AV_LOG_INFO, "\n");
247     }
248
249     for (i = 0; i < ic->nb_chapters; i++) {
250         AVChapter *ch = ic->chapters[i];
251         av_log(NULL, AV_LOG_INFO, "    Chapter #%d.%d: ", index, i);
252         av_log(NULL, AV_LOG_INFO,
253                "start %f, ", ch->start * av_q2d(ch->time_base));
254         av_log(NULL, AV_LOG_INFO,
255                "end %f\n", ch->end * av_q2d(ch->time_base));
256
257         dump_metadata(NULL, ch->metadata, "    ");
258     }
259
260     if (ic->nb_programs) {
261         int j, k, total = 0;
262         for (j = 0; j < ic->nb_programs; j++) {
263             AVDictionaryEntry *name = av_dict_get(ic->programs[j]->metadata,
264                                                   "name", NULL, 0);
265             av_log(NULL, AV_LOG_INFO, "  Program %d %s\n", ic->programs[j]->id,
266                    name ? name->value : "");
267             dump_metadata(NULL, ic->programs[j]->metadata, "    ");
268             for (k = 0; k < ic->programs[j]->nb_stream_indexes; k++) {
269                 dump_stream_format(ic, ic->programs[j]->stream_index[k],
270                                    index, is_output);
271                 printed[ic->programs[j]->stream_index[k]] = 1;
272             }
273             total += ic->programs[j]->nb_stream_indexes;
274         }
275         if (total < ic->nb_streams)
276             av_log(NULL, AV_LOG_INFO, "  No Program\n");
277     }
278
279     for (i = 0; i < ic->nb_streams; i++)
280         if (!printed[i])
281             dump_stream_format(ic, i, index, is_output);
282
283     av_free(printed);
284 }