ffprobe: generalize nesting model for the default writer
[ffmpeg.git] / ffprobe.c
1 /*
2  * Copyright (c) 2007-2010 Stefano Sabatini
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * simple media prober based on the FFmpeg libraries
24  */
25
26 #include "config.h"
27 #include "version.h"
28
29 #include <string.h>
30
31 #include "libavformat/avformat.h"
32 #include "libavcodec/avcodec.h"
33 #include "libavutil/avassert.h"
34 #include "libavutil/avstring.h"
35 #include "libavutil/bprint.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/pixdesc.h"
38 #include "libavutil/dict.h"
39 #include "libavutil/libm.h"
40 #include "libavutil/timecode.h"
41 #include "libavdevice/avdevice.h"
42 #include "libswscale/swscale.h"
43 #include "libswresample/swresample.h"
44 #include "libpostproc/postprocess.h"
45 #include "cmdutils.h"
46
47 const char program_name[] = "ffprobe";
48 const int program_birth_year = 2007;
49
50 static int do_bitexact = 0;
51 static int do_count_frames = 0;
52 static int do_count_packets = 0;
53 static int do_read_frames  = 0;
54 static int do_read_packets = 0;
55 static int do_show_error   = 0;
56 static int do_show_format  = 0;
57 static int do_show_frames  = 0;
58 static AVDictionary *fmt_entries_to_show = NULL;
59 static int do_show_packets = 0;
60 static int do_show_streams = 0;
61 static int do_show_data    = 0;
62 static int do_show_program_version  = 0;
63 static int do_show_library_versions = 0;
64
65 static int show_value_unit              = 0;
66 static int use_value_prefix             = 0;
67 static int use_byte_value_binary_prefix = 0;
68 static int use_value_sexagesimal_format = 0;
69 static int show_private_data            = 1;
70
71 static char *print_format;
72
73 /* section structure definition */
74
75 struct section {
76     int id;             ///< unique id indentifying a section
77     const char *name;
78
79 #define SECTION_FLAG_IS_WRAPPER      1 ///< the section only contains other sections, but has no data at its own level
80 #define SECTION_FLAG_IS_ARRAY        2 ///< the section contains an array of elements of the same type
81     int flags;
82     const char *element_name; ///< name of the contained element, if provided
83 };
84
85 typedef enum {
86     SECTION_ID_NONE = -1,
87     SECTION_ID_ERROR,
88     SECTION_ID_FORMAT,
89     SECTION_ID_FORMAT_TAGS,
90     SECTION_ID_FRAME,
91     SECTION_ID_FRAMES,
92     SECTION_ID_FRAME_TAGS,
93     SECTION_ID_LIBRARY_VERSION,
94     SECTION_ID_LIBRARY_VERSIONS,
95     SECTION_ID_PACKET,
96     SECTION_ID_PACKETS,
97     SECTION_ID_PACKETS_AND_FRAMES,
98     SECTION_ID_PROGRAM_VERSION,
99     SECTION_ID_ROOT,
100     SECTION_ID_STREAM,
101     SECTION_ID_STREAMS,
102     SECTION_ID_STREAM_TAGS
103 } SectionID;
104
105 static const struct section sections[] = {
106     [SECTION_ID_ERROR] =              { SECTION_ID_ERROR,              "error" },
107     [SECTION_ID_FORMAT] =             { SECTION_ID_FORMAT,             "format" },
108     [SECTION_ID_FORMAT_TAGS] =        { SECTION_ID_FORMAT_TAGS,        "tags", .element_name = "tag" },
109     [SECTION_ID_FRAME] =              { SECTION_ID_FRAME,              "frame" },
110     [SECTION_ID_FRAMES] =             { SECTION_ID_FRAMES,             "frames", SECTION_FLAG_IS_ARRAY },
111     [SECTION_ID_FRAME_TAGS] =         { SECTION_ID_FRAME_TAGS,         "tags", .element_name = "tag" },
112     [SECTION_ID_LIBRARY_VERSION] =    { SECTION_ID_LIBRARY_VERSION,    "library_version" },
113     [SECTION_ID_LIBRARY_VERSIONS] =   { SECTION_ID_LIBRARY_VERSIONS,   "library_versions", SECTION_FLAG_IS_ARRAY },
114     [SECTION_ID_PACKET] =             { SECTION_ID_PACKET,             "packet" },
115     [SECTION_ID_PACKETS] =            { SECTION_ID_PACKETS,            "packets", SECTION_FLAG_IS_ARRAY },
116     [SECTION_ID_PACKETS_AND_FRAMES] = { SECTION_ID_PACKETS_AND_FRAMES, "packets_and_frames", SECTION_FLAG_IS_ARRAY },
117     [SECTION_ID_PROGRAM_VERSION] =    { SECTION_ID_PROGRAM_VERSION,    "program_version" },
118     [SECTION_ID_ROOT] =               { SECTION_ID_ROOT,               "root", SECTION_FLAG_IS_WRAPPER },
119     [SECTION_ID_STREAM] =             { SECTION_ID_STREAM,             "stream" },
120     [SECTION_ID_STREAMS] =            { SECTION_ID_STREAMS,            "streams", SECTION_FLAG_IS_ARRAY },
121     [SECTION_ID_STREAM_TAGS] =        { SECTION_ID_STREAM_TAGS,        "tags", .element_name = "tag" },
122 };
123
124 static const OptionDef *options;
125
126 /* FFprobe context */
127 static const char *input_filename;
128 static AVInputFormat *iformat = NULL;
129
130 static const char *const binary_unit_prefixes [] = { "", "Ki", "Mi", "Gi", "Ti", "Pi" };
131 static const char *const decimal_unit_prefixes[] = { "", "K" , "M" , "G" , "T" , "P"  };
132
133 static const char unit_second_str[]         = "s"    ;
134 static const char unit_hertz_str[]          = "Hz"   ;
135 static const char unit_byte_str[]           = "byte" ;
136 static const char unit_bit_per_second_str[] = "bit/s";
137 static uint64_t *nb_streams_packets;
138 static uint64_t *nb_streams_frames;
139
140 void av_noreturn exit_program(int ret)
141 {
142     av_dict_free(&fmt_entries_to_show);
143     exit(ret);
144 }
145
146 struct unit_value {
147     union { double d; long long int i; } val;
148     const char *unit;
149 };
150
151 static char *value_string(char *buf, int buf_size, struct unit_value uv)
152 {
153     double vald;
154     long long int vali;
155     int show_float = 0;
156
157     if (uv.unit == unit_second_str) {
158         vald = uv.val.d;
159         show_float = 1;
160     } else {
161         vald = vali = uv.val.i;
162     }
163
164     if (uv.unit == unit_second_str && use_value_sexagesimal_format) {
165         double secs;
166         int hours, mins;
167         secs  = vald;
168         mins  = (int)secs / 60;
169         secs  = secs - mins * 60;
170         hours = mins / 60;
171         mins %= 60;
172         snprintf(buf, buf_size, "%d:%02d:%09.6f", hours, mins, secs);
173     } else {
174         const char *prefix_string = "";
175
176         if (use_value_prefix && vald > 1) {
177             long long int index;
178
179             if (uv.unit == unit_byte_str && use_byte_value_binary_prefix) {
180                 index = (long long int) (log2(vald)) / 10;
181                 index = av_clip(index, 0, FF_ARRAY_ELEMS(binary_unit_prefixes) - 1);
182                 vald /= exp2(index * 10);
183                 prefix_string = binary_unit_prefixes[index];
184             } else {
185                 index = (long long int) (log10(vald)) / 3;
186                 index = av_clip(index, 0, FF_ARRAY_ELEMS(decimal_unit_prefixes) - 1);
187                 vald /= pow(10, index * 3);
188                 prefix_string = decimal_unit_prefixes[index];
189             }
190         }
191
192         if (show_float || (use_value_prefix && vald != (long long int)vald))
193             snprintf(buf, buf_size, "%f", vald);
194         else
195             snprintf(buf, buf_size, "%lld", vali);
196         av_strlcatf(buf, buf_size, "%s%s%s", *prefix_string || show_value_unit ? " " : "",
197                  prefix_string, show_value_unit ? uv.unit : "");
198     }
199
200     return buf;
201 }
202
203 /* WRITERS API */
204
205 typedef struct WriterContext WriterContext;
206
207 #define WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS 1
208 #define WRITER_FLAG_PUT_PACKETS_AND_FRAMES_IN_SAME_CHAPTER 2
209
210 typedef struct Writer {
211     const AVClass *priv_class;      ///< private class of the writer, if any
212     int priv_size;                  ///< private size for the writer context
213     const char *name;
214
215     int  (*init)  (WriterContext *wctx);
216     void (*uninit)(WriterContext *wctx);
217
218     void (*print_section_header)(WriterContext *wctx);
219     void (*print_section_footer)(WriterContext *wctx);
220     void (*print_integer)       (WriterContext *wctx, const char *, long long int);
221     void (*print_rational)      (WriterContext *wctx, AVRational *q, char *sep);
222     void (*print_string)        (WriterContext *wctx, const char *, const char *);
223     int flags;                  ///< a combination or WRITER_FLAG_*
224 } Writer;
225
226 #define SECTION_MAX_NB_LEVELS 10
227
228 struct WriterContext {
229     const AVClass *class;           ///< class of the writer
230     const Writer *writer;           ///< the Writer of which this is an instance
231     char *name;                     ///< name of this writer instance
232     void *priv;                     ///< private data for use by the filter
233
234     const struct section *sections; ///< array containing all sections
235     int nb_sections;                ///< number of sections
236
237     int level;                      ///< current level, starting from 0
238
239     /** number of the item printed in the given section, starting from 0 */
240     unsigned int nb_item[SECTION_MAX_NB_LEVELS];
241
242     /** section per each level */
243     const struct section *section[SECTION_MAX_NB_LEVELS];
244
245     unsigned int nb_section_packet; ///< number of the packet section in case we are in "packets_and_frames" section
246     unsigned int nb_section_frame;  ///< number of the frame  section in case we are in "packets_and_frames" section
247     unsigned int nb_section_packet_frame; ///< nb_section_packet or nb_section_frame according if is_packets_and_frames
248 };
249
250 static const char *writer_get_name(void *p)
251 {
252     WriterContext *wctx = p;
253     return wctx->writer->name;
254 }
255
256 static const AVClass writer_class = {
257     "Writer",
258     writer_get_name,
259     NULL,
260     LIBAVUTIL_VERSION_INT,
261 };
262
263 static void writer_close(WriterContext **wctx)
264 {
265     if (!*wctx)
266         return;
267
268     if ((*wctx)->writer->uninit)
269         (*wctx)->writer->uninit(*wctx);
270     if ((*wctx)->writer->priv_class)
271         av_opt_free((*wctx)->priv);
272     av_freep(&((*wctx)->priv));
273     av_freep(wctx);
274 }
275
276 static int writer_open(WriterContext **wctx, const Writer *writer, const char *args,
277                        const struct section *sections, int nb_sections)
278 {
279     int ret = 0;
280
281     if (!(*wctx = av_malloc(sizeof(WriterContext)))) {
282         ret = AVERROR(ENOMEM);
283         goto fail;
284     }
285
286     if (!((*wctx)->priv = av_mallocz(writer->priv_size))) {
287         ret = AVERROR(ENOMEM);
288         goto fail;
289     }
290
291     (*wctx)->class = &writer_class;
292     (*wctx)->writer = writer;
293     (*wctx)->level = -1;
294     (*wctx)->sections = sections;
295     (*wctx)->nb_sections = nb_sections;
296
297     if (writer->priv_class) {
298         void *priv_ctx = (*wctx)->priv;
299         *((const AVClass **)priv_ctx) = writer->priv_class;
300         av_opt_set_defaults(priv_ctx);
301
302         if (args &&
303             (ret = av_set_options_string(priv_ctx, args, "=", ":")) < 0)
304             goto fail;
305     }
306     if ((*wctx)->writer->init)
307         ret = (*wctx)->writer->init(*wctx);
308     if (ret < 0)
309         goto fail;
310
311     return 0;
312
313 fail:
314     writer_close(wctx);
315     return ret;
316 }
317
318 static inline void writer_print_section_header(WriterContext *wctx,
319                                                int section_id)
320 {
321     int parent_section_id;
322     wctx->level++;
323     av_assert0(wctx->level < SECTION_MAX_NB_LEVELS);
324     parent_section_id = wctx->level ?
325         (wctx->section[wctx->level-1])->id : SECTION_ID_NONE;
326
327     wctx->nb_item[wctx->level] = 0;
328     wctx->section[wctx->level] = &wctx->sections[section_id];
329
330     if (section_id == SECTION_ID_PACKETS_AND_FRAMES) {
331         wctx->nb_section_packet = wctx->nb_section_frame =
332         wctx->nb_section_packet_frame = 0;
333     } else if (parent_section_id == SECTION_ID_PACKETS_AND_FRAMES) {
334         wctx->nb_section_packet_frame = section_id == SECTION_ID_PACKET ?
335             wctx->nb_section_packet : wctx->nb_section_frame;
336     }
337
338     if (wctx->writer->print_section_header)
339         wctx->writer->print_section_header(wctx);
340 }
341
342 static inline void writer_print_section_footer(WriterContext *wctx)
343 {
344     int section_id = wctx->section[wctx->level]->id;
345     int parent_section_id = wctx->level ?
346         wctx->section[wctx->level-1]->id : SECTION_ID_NONE;
347
348     if (parent_section_id != SECTION_ID_NONE)
349         wctx->nb_item[wctx->level-1]++;
350     if (parent_section_id == SECTION_ID_PACKETS_AND_FRAMES) {
351         if (section_id == SECTION_ID_PACKET) wctx->nb_section_packet++;
352         else                                     wctx->nb_section_frame++;
353     }
354     if (wctx->writer->print_section_footer)
355         wctx->writer->print_section_footer(wctx);
356     wctx->level--;
357 }
358
359 static inline void writer_print_integer(WriterContext *wctx,
360                                         const char *key, long long int val)
361 {
362     if ((wctx->section[wctx->level]->id != SECTION_ID_FORMAT
363          && wctx->section[wctx->level]->id != SECTION_ID_FORMAT_TAGS) ||
364         !fmt_entries_to_show || av_dict_get(fmt_entries_to_show, key, NULL, 0)) {
365         wctx->writer->print_integer(wctx, key, val);
366         wctx->nb_item[wctx->level]++;
367     }
368 }
369
370 static inline void writer_print_string(WriterContext *wctx,
371                                        const char *key, const char *val, int opt)
372 {
373     if (opt && !(wctx->writer->flags & WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS))
374         return;
375     if ((wctx->section[wctx->level]->id != SECTION_ID_FORMAT
376          && wctx->section[wctx->level]->id != SECTION_ID_FORMAT_TAGS) ||
377         !fmt_entries_to_show || av_dict_get(fmt_entries_to_show, key, NULL, 0)) {
378         wctx->writer->print_string(wctx, key, val);
379         wctx->nb_item[wctx->level]++;
380     }
381 }
382
383 static inline void writer_print_rational(WriterContext *wctx,
384                                          const char *key, AVRational q, char sep)
385 {
386     AVBPrint buf;
387     av_bprint_init(&buf, 0, AV_BPRINT_SIZE_AUTOMATIC);
388     av_bprintf(&buf, "%d%c%d", q.num, sep, q.den);
389     writer_print_string(wctx, key, buf.str, 0);
390 }
391
392 static void writer_print_time(WriterContext *wctx, const char *key,
393                               int64_t ts, const AVRational *time_base, int is_duration)
394 {
395     char buf[128];
396
397     if ((!is_duration && ts == AV_NOPTS_VALUE) || (is_duration && ts == 0)) {
398         writer_print_string(wctx, key, "N/A", 1);
399     } else {
400         double d = ts * av_q2d(*time_base);
401         struct unit_value uv;
402         uv.val.d = d;
403         uv.unit = unit_second_str;
404         value_string(buf, sizeof(buf), uv);
405         writer_print_string(wctx, key, buf, 0);
406     }
407 }
408
409 static void writer_print_ts(WriterContext *wctx, const char *key, int64_t ts, int is_duration)
410 {
411     if ((!is_duration && ts == AV_NOPTS_VALUE) || (is_duration && ts == 0)) {
412         writer_print_string(wctx, key, "N/A", 1);
413     } else {
414         writer_print_integer(wctx, key, ts);
415     }
416 }
417
418 static void writer_print_data(WriterContext *wctx, const char *name,
419                               uint8_t *data, int size)
420 {
421     AVBPrint bp;
422     int offset = 0, l, i;
423
424     av_bprint_init(&bp, 0, AV_BPRINT_SIZE_UNLIMITED);
425     av_bprintf(&bp, "\n");
426     while (size) {
427         av_bprintf(&bp, "%08x: ", offset);
428         l = FFMIN(size, 16);
429         for (i = 0; i < l; i++) {
430             av_bprintf(&bp, "%02x", data[i]);
431             if (i & 1)
432                 av_bprintf(&bp, " ");
433         }
434         av_bprint_chars(&bp, ' ', 41 - 2 * i - i / 2);
435         for (i = 0; i < l; i++)
436             av_bprint_chars(&bp, data[i] - 32U < 95 ? data[i] : '.', 1);
437         av_bprintf(&bp, "\n");
438         offset += l;
439         data   += l;
440         size   -= l;
441     }
442     writer_print_string(wctx, name, bp.str, 0);
443     av_bprint_finalize(&bp, NULL);
444 }
445
446 #define MAX_REGISTERED_WRITERS_NB 64
447
448 static const Writer *registered_writers[MAX_REGISTERED_WRITERS_NB + 1];
449
450 static int writer_register(const Writer *writer)
451 {
452     static int next_registered_writer_idx = 0;
453
454     if (next_registered_writer_idx == MAX_REGISTERED_WRITERS_NB)
455         return AVERROR(ENOMEM);
456
457     registered_writers[next_registered_writer_idx++] = writer;
458     return 0;
459 }
460
461 static const Writer *writer_get_by_name(const char *name)
462 {
463     int i;
464
465     for (i = 0; registered_writers[i]; i++)
466         if (!strcmp(registered_writers[i]->name, name))
467             return registered_writers[i];
468
469     return NULL;
470 }
471
472
473 /* WRITERS */
474
475 #define DEFINE_WRITER_CLASS(name)                   \
476 static const char *name##_get_name(void *ctx)       \
477 {                                                   \
478     return #name ;                                  \
479 }                                                   \
480 static const AVClass name##_class = {               \
481     #name,                                          \
482     name##_get_name,                                \
483     name##_options                                  \
484 }
485
486 /* Default output */
487
488 typedef struct DefaultContext {
489     const AVClass *class;
490     int nokey;
491     int noprint_wrappers;
492     int nested_section[SECTION_MAX_NB_LEVELS];
493     AVBPrint prefix[SECTION_MAX_NB_LEVELS];
494 } DefaultContext;
495
496 #define OFFSET(x) offsetof(DefaultContext, x)
497
498 static const AVOption default_options[] = {
499     { "noprint_wrappers", "do not print headers and footers", OFFSET(noprint_wrappers), AV_OPT_TYPE_INT, {.i64=0}, 0, 1 },
500     { "nw",               "do not print headers and footers", OFFSET(noprint_wrappers), AV_OPT_TYPE_INT, {.i64=0}, 0, 1 },
501     { "nokey",          "force no key printing",     OFFSET(nokey),          AV_OPT_TYPE_INT, {.i64=0}, 0, 1 },
502     { "nk",             "force no key printing",     OFFSET(nokey),          AV_OPT_TYPE_INT, {.i64=0}, 0, 1 },
503     {NULL},
504 };
505
506 DEFINE_WRITER_CLASS(default);
507
508 /* lame uppercasing routine, assumes the string is lower case ASCII */
509 static inline char *upcase_string(char *dst, size_t dst_size, const char *src)
510 {
511     int i;
512     for (i = 0; src[i] && i < dst_size-1; i++)
513         dst[i] = av_toupper(src[i]);
514     dst[i] = 0;
515     return dst;
516 }
517
518 static int default_init(WriterContext *wctx)
519 {
520     DefaultContext *def = wctx->priv;
521     int i;
522
523     for (i = 0; i < SECTION_MAX_NB_LEVELS; i++)
524         av_bprint_init(&def->prefix[i], 1, AV_BPRINT_SIZE_UNLIMITED);
525     return 0;
526 }
527
528 static void default_uninit(WriterContext *wctx)
529 {
530     DefaultContext *def = wctx->priv;
531     int i;
532
533     for (i = 0; i < SECTION_MAX_NB_LEVELS; i++)
534         av_bprint_finalize(&def->prefix[i], NULL);
535 }
536
537 static void default_print_section_header(WriterContext *wctx)
538 {
539     DefaultContext *def = wctx->priv;
540     char buf[32];
541     const struct section *section = wctx->section[wctx->level];
542     const struct section *parent_section = wctx->level ?
543         wctx->section[wctx->level-1] : NULL;
544
545     av_bprint_clear(&def->prefix[wctx->level]);
546     if (parent_section &&
547         !(parent_section->flags & (SECTION_FLAG_IS_WRAPPER|SECTION_FLAG_IS_ARRAY))) {
548         def->nested_section[wctx->level] = 1;
549         av_bprintf(&def->prefix[wctx->level], "%s%s:", def->prefix[wctx->level-1].str,
550                    upcase_string(buf, sizeof(buf),
551                                  av_x_if_null(section->element_name, section->name)));
552     }
553
554     if (def->noprint_wrappers || def->nested_section[wctx->level])
555         return;
556
557     if (!(section->flags & (SECTION_FLAG_IS_WRAPPER|SECTION_FLAG_IS_ARRAY)))
558         printf("[%s]\n", upcase_string(buf, sizeof(buf), section->name));
559 }
560
561 static void default_print_section_footer(WriterContext *wctx)
562 {
563     DefaultContext *def = wctx->priv;
564     const struct section *section = wctx->section[wctx->level];
565     char buf[32];
566
567     if (def->noprint_wrappers || def->nested_section[wctx->level])
568         return;
569
570     if (!(section->flags & (SECTION_FLAG_IS_WRAPPER|SECTION_FLAG_IS_ARRAY)))
571         printf("[/%s]\n", upcase_string(buf, sizeof(buf), section->name));
572 }
573
574 static void default_print_str(WriterContext *wctx, const char *key, const char *value)
575 {
576     DefaultContext *def = wctx->priv;
577
578     if (!def->nokey)
579         printf("%s%s=", def->prefix[wctx->level].str, key);
580     printf("%s\n", value);
581 }
582
583 static void default_print_int(WriterContext *wctx, const char *key, long long int value)
584 {
585     DefaultContext *def = wctx->priv;
586
587     if (!def->nokey)
588         printf("%s%s=", def->prefix[wctx->level].str, key);
589     printf("%lld\n", value);
590 }
591
592 static const Writer default_writer = {
593     .name                  = "default",
594     .priv_size             = sizeof(DefaultContext),
595     .init                  = default_init,
596     .uninit                = default_uninit,
597     .print_section_header  = default_print_section_header,
598     .print_section_footer  = default_print_section_footer,
599     .print_integer         = default_print_int,
600     .print_string          = default_print_str,
601     .flags = WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS,
602     .priv_class            = &default_class,
603 };
604
605 /* Compact output */
606
607 /**
608  * Apply C-language-like string escaping.
609  */
610 static const char *c_escape_str(AVBPrint *dst, const char *src, const char sep, void *log_ctx)
611 {
612     const char *p;
613
614     for (p = src; *p; p++) {
615         switch (*p) {
616         case '\b': av_bprintf(dst, "%s", "\\b");  break;
617         case '\f': av_bprintf(dst, "%s", "\\f");  break;
618         case '\n': av_bprintf(dst, "%s", "\\n");  break;
619         case '\r': av_bprintf(dst, "%s", "\\r");  break;
620         case '\\': av_bprintf(dst, "%s", "\\\\"); break;
621         default:
622             if (*p == sep)
623                 av_bprint_chars(dst, '\\', 1);
624             av_bprint_chars(dst, *p, 1);
625         }
626     }
627     return dst->str;
628 }
629
630 /**
631  * Quote fields containing special characters, check RFC4180.
632  */
633 static const char *csv_escape_str(AVBPrint *dst, const char *src, const char sep, void *log_ctx)
634 {
635     char meta_chars[] = { sep, '"', '\n', '\r', '\0' };
636     int needs_quoting = !!src[strcspn(src, meta_chars)];
637
638     if (needs_quoting)
639         av_bprint_chars(dst, '\"', 1);
640
641     for (; *src; src++) {
642         if (*src == '"')
643             av_bprint_chars(dst, '\"', 1);
644         av_bprint_chars(dst, *src, 1);
645     }
646     if (needs_quoting)
647         av_bprint_chars(dst, '\"', 1);
648     return dst->str;
649 }
650
651 static const char *none_escape_str(AVBPrint *dst, const char *src, const char sep, void *log_ctx)
652 {
653     return src;
654 }
655
656 typedef struct CompactContext {
657     const AVClass *class;
658     char *item_sep_str;
659     char item_sep;
660     int nokey;
661     int print_section;
662     char *escape_mode_str;
663     const char * (*escape_str)(AVBPrint *dst, const char *src, const char sep, void *log_ctx);
664 } CompactContext;
665
666 #undef OFFSET
667 #define OFFSET(x) offsetof(CompactContext, x)
668
669 static const AVOption compact_options[]= {
670     {"item_sep", "set item separator",    OFFSET(item_sep_str),    AV_OPT_TYPE_STRING, {.str="|"},  CHAR_MIN, CHAR_MAX },
671     {"s",        "set item separator",    OFFSET(item_sep_str),    AV_OPT_TYPE_STRING, {.str="|"},  CHAR_MIN, CHAR_MAX },
672     {"nokey",    "force no key printing", OFFSET(nokey),           AV_OPT_TYPE_INT,    {.i64=0},    0,        1        },
673     {"nk",       "force no key printing", OFFSET(nokey),           AV_OPT_TYPE_INT,    {.i64=0},    0,        1        },
674     {"escape",   "set escape mode",       OFFSET(escape_mode_str), AV_OPT_TYPE_STRING, {.str="c"},  CHAR_MIN, CHAR_MAX },
675     {"e",        "set escape mode",       OFFSET(escape_mode_str), AV_OPT_TYPE_STRING, {.str="c"},  CHAR_MIN, CHAR_MAX },
676     {"print_section", "print section name", OFFSET(print_section), AV_OPT_TYPE_INT,    {.i64=1},    0,        1        },
677     {"p",             "print section name", OFFSET(print_section), AV_OPT_TYPE_INT,    {.i64=1},    0,        1        },
678     {NULL},
679 };
680
681 DEFINE_WRITER_CLASS(compact);
682
683 static av_cold int compact_init(WriterContext *wctx)
684 {
685     CompactContext *compact = wctx->priv;
686
687     if (strlen(compact->item_sep_str) != 1) {
688         av_log(wctx, AV_LOG_ERROR, "Item separator '%s' specified, but must contain a single character\n",
689                compact->item_sep_str);
690         return AVERROR(EINVAL);
691     }
692     compact->item_sep = compact->item_sep_str[0];
693
694     if      (!strcmp(compact->escape_mode_str, "none")) compact->escape_str = none_escape_str;
695     else if (!strcmp(compact->escape_mode_str, "c"   )) compact->escape_str = c_escape_str;
696     else if (!strcmp(compact->escape_mode_str, "csv" )) compact->escape_str = csv_escape_str;
697     else {
698         av_log(wctx, AV_LOG_ERROR, "Unknown escape mode '%s'\n", compact->escape_mode_str);
699         return AVERROR(EINVAL);
700     }
701
702     return 0;
703 }
704
705 static void compact_print_section_header(WriterContext *wctx)
706 {
707     CompactContext *compact = wctx->priv;
708     const struct section *section = wctx->section[wctx->level];
709
710     if (!strcmp(section->name, "tags"))
711         wctx->nb_item[wctx->level] = wctx->nb_item[wctx->level-1];
712     else if (compact->print_section &&
713         !(section->flags & (SECTION_FLAG_IS_WRAPPER|SECTION_FLAG_IS_ARRAY)))
714         printf("%s%c", section->name, compact->item_sep);
715 }
716
717 static void compact_print_section_footer(WriterContext *wctx)
718 {
719     const struct section *section = wctx->section[wctx->level];
720
721     if (strcmp(section->name, "tags") &&
722         !(section->flags & (SECTION_FLAG_IS_WRAPPER|SECTION_FLAG_IS_ARRAY)))
723         printf("\n");
724 }
725
726 static void compact_print_str(WriterContext *wctx, const char *key, const char *value)
727 {
728     CompactContext *compact = wctx->priv;
729     const struct section *section = wctx->section[wctx->level];
730     const char *key_prefix = !strcmp(section->name, "tags") ? "tag:" : "";
731     AVBPrint buf;
732
733     if (wctx->nb_item[wctx->level]) printf("%c", compact->item_sep);
734     if (!compact->nokey)
735         printf("%s%s=", key_prefix, key);
736     av_bprint_init(&buf, 1, AV_BPRINT_SIZE_UNLIMITED);
737     printf("%s", compact->escape_str(&buf, value, compact->item_sep, wctx));
738     av_bprint_finalize(&buf, NULL);
739
740 }
741
742 static void compact_print_int(WriterContext *wctx, const char *key, long long int value)
743 {
744     CompactContext *compact = wctx->priv;
745
746     if (wctx->nb_item[wctx->level]) printf("%c", compact->item_sep);
747     if (!compact->nokey)
748         printf("%s=", key);
749     printf("%lld", value);
750 }
751
752 static const Writer compact_writer = {
753     .name                 = "compact",
754     .priv_size            = sizeof(CompactContext),
755     .init                 = compact_init,
756     .print_section_header = compact_print_section_header,
757     .print_section_footer = compact_print_section_footer,
758     .print_integer        = compact_print_int,
759     .print_string         = compact_print_str,
760     .flags = WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS,
761     .priv_class           = &compact_class,
762 };
763
764 /* CSV output */
765
766 #undef OFFSET
767 #define OFFSET(x) offsetof(CompactContext, x)
768
769 static const AVOption csv_options[] = {
770     {"item_sep", "set item separator",    OFFSET(item_sep_str),    AV_OPT_TYPE_STRING, {.str=","},  CHAR_MIN, CHAR_MAX },
771     {"s",        "set item separator",    OFFSET(item_sep_str),    AV_OPT_TYPE_STRING, {.str=","},  CHAR_MIN, CHAR_MAX },
772     {"nokey",    "force no key printing", OFFSET(nokey),           AV_OPT_TYPE_INT,    {.i64=1},    0,        1        },
773     {"nk",       "force no key printing", OFFSET(nokey),           AV_OPT_TYPE_INT,    {.i64=1},    0,        1        },
774     {"escape",   "set escape mode",       OFFSET(escape_mode_str), AV_OPT_TYPE_STRING, {.str="csv"}, CHAR_MIN, CHAR_MAX },
775     {"e",        "set escape mode",       OFFSET(escape_mode_str), AV_OPT_TYPE_STRING, {.str="csv"}, CHAR_MIN, CHAR_MAX },
776     {"print_section", "print section name", OFFSET(print_section), AV_OPT_TYPE_INT,    {.i64=1},    0,        1        },
777     {"p",             "print section name", OFFSET(print_section), AV_OPT_TYPE_INT,    {.i64=1},    0,        1        },
778     {NULL},
779 };
780
781 DEFINE_WRITER_CLASS(csv);
782
783 static const Writer csv_writer = {
784     .name                 = "csv",
785     .priv_size            = sizeof(CompactContext),
786     .init                 = compact_init,
787     .print_section_header = compact_print_section_header,
788     .print_section_footer = compact_print_section_footer,
789     .print_integer        = compact_print_int,
790     .print_string         = compact_print_str,
791     .flags = WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS,
792     .priv_class           = &csv_class,
793 };
794
795 /* Flat output */
796
797 typedef struct FlatContext {
798     const AVClass *class;
799     AVBPrint section_header[SECTION_MAX_NB_LEVELS];
800     const char *sep_str;
801     char sep;
802     int hierarchical;
803 } FlatContext;
804
805 #undef OFFSET
806 #define OFFSET(x) offsetof(FlatContext, x)
807
808 static const AVOption flat_options[]= {
809     {"sep_char", "set separator",    OFFSET(sep_str),    AV_OPT_TYPE_STRING, {.str="."},  CHAR_MIN, CHAR_MAX },
810     {"s",        "set separator",    OFFSET(sep_str),    AV_OPT_TYPE_STRING, {.str="."},  CHAR_MIN, CHAR_MAX },
811     {"hierarchical", "specify if the section specification should be hierarchical", OFFSET(hierarchical), AV_OPT_TYPE_INT, {.i64=1}, 0, 1 },
812     {"h",           "specify if the section specification should be hierarchical", OFFSET(hierarchical), AV_OPT_TYPE_INT, {.i64=1}, 0, 1 },
813     {NULL},
814 };
815
816 DEFINE_WRITER_CLASS(flat);
817
818 static av_cold int flat_init(WriterContext *wctx)
819 {
820     FlatContext *flat = wctx->priv;
821     int i;
822
823     if (strlen(flat->sep_str) != 1) {
824         av_log(wctx, AV_LOG_ERROR, "Item separator '%s' specified, but must contain a single character\n",
825                flat->sep_str);
826         return AVERROR(EINVAL);
827     }
828     flat->sep = flat->sep_str[0];
829
830     for (i = 0; i < SECTION_MAX_NB_LEVELS; i++)
831         av_bprint_init(&flat->section_header[i], 1, AV_BPRINT_SIZE_UNLIMITED);
832     return 0;
833 }
834
835 static void flat_uninit(WriterContext *wctx)
836 {
837     FlatContext *flat = wctx->priv;
838     int i;
839
840     for (i = 0; i < SECTION_MAX_NB_LEVELS; i++)
841         av_bprint_finalize(&flat->section_header[i], NULL);
842 }
843
844 static const char *flat_escape_key_str(AVBPrint *dst, const char *src, const char sep)
845 {
846     const char *p;
847
848     for (p = src; *p; p++) {
849         if (!((*p >= '0' && *p <= '9') ||
850               (*p >= 'a' && *p <= 'z') ||
851               (*p >= 'A' && *p <= 'Z')))
852             av_bprint_chars(dst, '_', 1);
853         else
854             av_bprint_chars(dst, *p, 1);
855     }
856     return dst->str;
857 }
858
859 static const char *flat_escape_value_str(AVBPrint *dst, const char *src)
860 {
861     const char *p;
862
863     for (p = src; *p; p++) {
864         switch (*p) {
865         case '\n': av_bprintf(dst, "%s", "\\n");  break;
866         case '\r': av_bprintf(dst, "%s", "\\r");  break;
867         case '\\': av_bprintf(dst, "%s", "\\\\"); break;
868         case '"':  av_bprintf(dst, "%s", "\\\""); break;
869         case '`':  av_bprintf(dst, "%s", "\\`");  break;
870         case '$':  av_bprintf(dst, "%s", "\\$");  break;
871         default:   av_bprint_chars(dst, *p, 1);   break;
872         }
873     }
874     return dst->str;
875 }
876
877 static void flat_print_section_header(WriterContext *wctx)
878 {
879     FlatContext *flat = wctx->priv;
880     AVBPrint *buf = &flat->section_header[wctx->level];
881     int i;
882
883     /* build section header */
884     av_bprint_clear(buf);
885     for (i = 1; i <= wctx->level; i++) {
886         if (flat->hierarchical ||
887             !(wctx->section[i]->flags & (SECTION_FLAG_IS_ARRAY|SECTION_FLAG_IS_WRAPPER)))
888             av_bprintf(buf, "%s%s", wctx->section[i]->name, flat->sep_str);
889     }
890 }
891
892 static void flat_print_key_prefix(WriterContext *wctx)
893 {
894     FlatContext *flat = wctx->priv;
895     const struct section *parent_section = wctx->section[wctx->level-1];
896
897     printf("%s", flat->section_header[wctx->level].str);
898
899     if (parent_section->flags & SECTION_FLAG_IS_ARRAY) {
900         int n = parent_section->id == SECTION_ID_PACKETS_AND_FRAMES ?
901             wctx->nb_section_packet_frame : wctx->nb_item[wctx->level-1];
902         printf("%d%s", n, flat->sep_str);
903     }
904 }
905
906 static void flat_print_int(WriterContext *wctx, const char *key, long long int value)
907 {
908     flat_print_key_prefix(wctx);
909     printf("%s=%lld\n", key, value);
910 }
911
912 static void flat_print_str(WriterContext *wctx, const char *key, const char *value)
913 {
914     FlatContext *flat = wctx->priv;
915     AVBPrint buf;
916
917     flat_print_key_prefix(wctx);
918     av_bprint_init(&buf, 1, AV_BPRINT_SIZE_UNLIMITED);
919     printf("%s=", flat_escape_key_str(&buf, key, flat->sep));
920     av_bprint_clear(&buf);
921     printf("\"%s\"\n", flat_escape_value_str(&buf, value));
922     av_bprint_finalize(&buf, NULL);
923 }
924
925 static const Writer flat_writer = {
926     .name                  = "flat",
927     .priv_size             = sizeof(FlatContext),
928     .init                  = flat_init,
929     .uninit                = flat_uninit,
930     .print_section_header  = flat_print_section_header,
931     .print_integer         = flat_print_int,
932     .print_string          = flat_print_str,
933     .flags = WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS|WRITER_FLAG_PUT_PACKETS_AND_FRAMES_IN_SAME_CHAPTER,
934     .priv_class            = &flat_class,
935 };
936
937 /* INI format output */
938
939 typedef struct {
940     const AVClass *class;
941     int hierarchical;
942 } INIContext;
943
944 #undef OFFSET
945 #define OFFSET(x) offsetof(INIContext, x)
946
947 static const AVOption ini_options[] = {
948     {"hierarchical", "specify if the section specification should be hierarchical", OFFSET(hierarchical), AV_OPT_TYPE_INT, {.i64=1}, 0, 1 },
949     {"h",           "specify if the section specification should be hierarchical", OFFSET(hierarchical), AV_OPT_TYPE_INT, {.i64=1}, 0, 1 },
950     {NULL},
951 };
952
953 DEFINE_WRITER_CLASS(ini);
954
955 static char *ini_escape_str(AVBPrint *dst, const char *src)
956 {
957     int i = 0;
958     char c = 0;
959
960     while (c = src[i++]) {
961         switch (c) {
962         case '\b': av_bprintf(dst, "%s", "\\b"); break;
963         case '\f': av_bprintf(dst, "%s", "\\f"); break;
964         case '\n': av_bprintf(dst, "%s", "\\n"); break;
965         case '\r': av_bprintf(dst, "%s", "\\r"); break;
966         case '\t': av_bprintf(dst, "%s", "\\t"); break;
967         case '\\':
968         case '#' :
969         case '=' :
970         case ':' : av_bprint_chars(dst, '\\', 1);
971         default:
972             if ((unsigned char)c < 32)
973                 av_bprintf(dst, "\\x00%02x", c & 0xff);
974             else
975                 av_bprint_chars(dst, c, 1);
976             break;
977         }
978     }
979     return dst->str;
980 }
981
982 static void ini_print_section_header(WriterContext *wctx)
983 {
984     INIContext *ini = wctx->priv;
985     AVBPrint buf;
986     int i;
987     const struct section *section = wctx->section[wctx->level];
988     const struct section *parent_section = wctx->level ?
989         wctx->section[wctx->level-1] : NULL;
990
991     av_bprint_init(&buf, 1, AV_BPRINT_SIZE_UNLIMITED);
992     if (wctx->level == 0) {
993         printf("# ffprobe output\n\n");
994         return;
995     }
996
997     if (wctx->nb_item[wctx->level-1])
998         printf("\n");
999
1000     for (i = 1; i <= wctx->level; i++) {
1001         if (ini->hierarchical ||
1002             !(section->flags & (SECTION_FLAG_IS_ARRAY|SECTION_FLAG_IS_WRAPPER)))
1003             av_bprintf(&buf, "%s%s", i>1 ? "." : "", wctx->section[i]->name);
1004     }
1005
1006     if (parent_section->flags & SECTION_FLAG_IS_ARRAY) {
1007         int n = parent_section->id == SECTION_ID_PACKETS_AND_FRAMES ?
1008             wctx->nb_section_packet_frame : wctx->nb_item[wctx->level-1];
1009         av_bprintf(&buf, ".%d", n);
1010     }
1011
1012     if (!(section->flags & (SECTION_FLAG_IS_ARRAY|SECTION_FLAG_IS_WRAPPER)))
1013         printf("[%s]\n", buf.str);
1014     av_bprint_finalize(&buf, NULL);
1015 }
1016
1017 static void ini_print_str(WriterContext *wctx, const char *key, const char *value)
1018 {
1019     AVBPrint buf;
1020
1021     av_bprint_init(&buf, 1, AV_BPRINT_SIZE_UNLIMITED);
1022     printf("%s=", ini_escape_str(&buf, key));
1023     av_bprint_clear(&buf);
1024     printf("%s\n", ini_escape_str(&buf, value));
1025     av_bprint_finalize(&buf, NULL);
1026 }
1027
1028 static void ini_print_int(WriterContext *wctx, const char *key, long long int value)
1029 {
1030     printf("%s=%lld\n", key, value);
1031 }
1032
1033 static const Writer ini_writer = {
1034     .name                  = "ini",
1035     .priv_size             = sizeof(INIContext),
1036     .print_section_header  = ini_print_section_header,
1037     .print_integer         = ini_print_int,
1038     .print_string          = ini_print_str,
1039     .flags = WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS|WRITER_FLAG_PUT_PACKETS_AND_FRAMES_IN_SAME_CHAPTER,
1040     .priv_class            = &ini_class,
1041 };
1042
1043 /* JSON output */
1044
1045 typedef struct {
1046     const AVClass *class;
1047     int indent_level;
1048     int compact;
1049     const char *item_sep, *item_start_end;
1050 } JSONContext;
1051
1052 #undef OFFSET
1053 #define OFFSET(x) offsetof(JSONContext, x)
1054
1055 static const AVOption json_options[]= {
1056     { "compact", "enable compact output", OFFSET(compact), AV_OPT_TYPE_INT, {.i64=0}, 0, 1 },
1057     { "c",       "enable compact output", OFFSET(compact), AV_OPT_TYPE_INT, {.i64=0}, 0, 1 },
1058     { NULL }
1059 };
1060
1061 DEFINE_WRITER_CLASS(json);
1062
1063 static av_cold int json_init(WriterContext *wctx)
1064 {
1065     JSONContext *json = wctx->priv;
1066
1067     json->item_sep       = json->compact ? ", " : ",\n";
1068     json->item_start_end = json->compact ? " "  : "\n";
1069
1070     return 0;
1071 }
1072
1073 static const char *json_escape_str(AVBPrint *dst, const char *src, void *log_ctx)
1074 {
1075     static const char json_escape[] = {'"', '\\', '\b', '\f', '\n', '\r', '\t', 0};
1076     static const char json_subst[]  = {'"', '\\',  'b',  'f',  'n',  'r',  't', 0};
1077     const char *p;
1078
1079     for (p = src; *p; p++) {
1080         char *s = strchr(json_escape, *p);
1081         if (s) {
1082             av_bprint_chars(dst, '\\', 1);
1083             av_bprint_chars(dst, json_subst[s - json_escape], 1);
1084         } else if ((unsigned char)*p < 32) {
1085             av_bprintf(dst, "\\u00%02x", *p & 0xff);
1086         } else {
1087             av_bprint_chars(dst, *p, 1);
1088         }
1089     }
1090     return dst->str;
1091 }
1092
1093 #define JSON_INDENT() printf("%*c", json->indent_level * 4, ' ')
1094
1095 static void json_print_section_header(WriterContext *wctx)
1096 {
1097     JSONContext *json = wctx->priv;
1098     AVBPrint buf;
1099     const struct section *section = wctx->section[wctx->level];
1100     const struct section *parent_section = wctx->level ?
1101         wctx->section[wctx->level-1] : NULL;
1102
1103     if (wctx->level && wctx->nb_item[wctx->level-1])
1104         printf(",\n");
1105
1106     if (section->flags & SECTION_FLAG_IS_WRAPPER) {
1107         printf("{\n");
1108         json->indent_level++;
1109     } else {
1110         av_bprint_init(&buf, 1, AV_BPRINT_SIZE_UNLIMITED);
1111         json_escape_str(&buf, section->name, wctx);
1112         JSON_INDENT();
1113
1114         json->indent_level++;
1115         if (section->flags & SECTION_FLAG_IS_ARRAY) {
1116             printf("\"%s\": [\n", buf.str);
1117         } else if (!(parent_section->flags & SECTION_FLAG_IS_ARRAY)) {
1118             printf("\"%s\": {%s", buf.str, json->item_start_end);
1119         } else {
1120             printf("{%s", json->item_start_end);
1121
1122             /* this is required so the parser can distinguish between packets and frames */
1123             if (parent_section->id == SECTION_ID_PACKETS_AND_FRAMES) {
1124                 if (!json->compact)
1125                     JSON_INDENT();
1126                 printf("\"type\": \"%s\"%s", section->name, json->item_sep);
1127             }
1128         }
1129         av_bprint_finalize(&buf, NULL);
1130     }
1131 }
1132
1133 static void json_print_section_footer(WriterContext *wctx)
1134 {
1135     JSONContext *json = wctx->priv;
1136     const struct section *section = wctx->section[wctx->level];
1137
1138     if (wctx->level == 0) {
1139         json->indent_level--;
1140         printf("\n}\n");
1141     } else if (section->flags & SECTION_FLAG_IS_ARRAY) {
1142         printf("\n");
1143         json->indent_level--;
1144         JSON_INDENT();
1145         printf("]");
1146     } else {
1147         printf("%s", json->item_start_end);
1148         json->indent_level--;
1149         if (!json->compact)
1150             JSON_INDENT();
1151         printf("}");
1152     }
1153 }
1154
1155 static inline void json_print_item_str(WriterContext *wctx,
1156                                        const char *key, const char *value)
1157 {
1158     AVBPrint buf;
1159
1160     av_bprint_init(&buf, 1, AV_BPRINT_SIZE_UNLIMITED);
1161     printf("\"%s\":", json_escape_str(&buf, key,   wctx));
1162     av_bprint_clear(&buf);
1163     printf(" \"%s\"", json_escape_str(&buf, value, wctx));
1164     av_bprint_finalize(&buf, NULL);
1165 }
1166
1167 static void json_print_str(WriterContext *wctx, const char *key, const char *value)
1168 {
1169     JSONContext *json = wctx->priv;
1170
1171     if (wctx->nb_item[wctx->level])
1172         printf("%s", json->item_sep);
1173     if (!json->compact)
1174         JSON_INDENT();
1175     json_print_item_str(wctx, key, value);
1176 }
1177
1178 static void json_print_int(WriterContext *wctx, const char *key, long long int value)
1179 {
1180     JSONContext *json = wctx->priv;
1181     AVBPrint buf;
1182
1183     if (wctx->nb_item[wctx->level])
1184         printf("%s", json->item_sep);
1185     if (!json->compact)
1186         JSON_INDENT();
1187
1188     av_bprint_init(&buf, 1, AV_BPRINT_SIZE_UNLIMITED);
1189     printf("\"%s\": %lld", json_escape_str(&buf, key, wctx), value);
1190     av_bprint_finalize(&buf, NULL);
1191 }
1192
1193 static const Writer json_writer = {
1194     .name                 = "json",
1195     .priv_size            = sizeof(JSONContext),
1196     .init                 = json_init,
1197     .print_section_header = json_print_section_header,
1198     .print_section_footer = json_print_section_footer,
1199     .print_integer        = json_print_int,
1200     .print_string         = json_print_str,
1201     .flags = WRITER_FLAG_PUT_PACKETS_AND_FRAMES_IN_SAME_CHAPTER,
1202     .priv_class           = &json_class,
1203 };
1204
1205 /* XML output */
1206
1207 typedef struct {
1208     const AVClass *class;
1209     int within_tag;
1210     int indent_level;
1211     int fully_qualified;
1212     int xsd_strict;
1213 } XMLContext;
1214
1215 #undef OFFSET
1216 #define OFFSET(x) offsetof(XMLContext, x)
1217
1218 static const AVOption xml_options[] = {
1219     {"fully_qualified", "specify if the output should be fully qualified", OFFSET(fully_qualified), AV_OPT_TYPE_INT, {.i64=0},  0, 1 },
1220     {"q",               "specify if the output should be fully qualified", OFFSET(fully_qualified), AV_OPT_TYPE_INT, {.i64=0},  0, 1 },
1221     {"xsd_strict",      "ensure that the output is XSD compliant",         OFFSET(xsd_strict),      AV_OPT_TYPE_INT, {.i64=0},  0, 1 },
1222     {"x",               "ensure that the output is XSD compliant",         OFFSET(xsd_strict),      AV_OPT_TYPE_INT, {.i64=0},  0, 1 },
1223     {NULL},
1224 };
1225
1226 DEFINE_WRITER_CLASS(xml);
1227
1228 static av_cold int xml_init(WriterContext *wctx)
1229 {
1230     XMLContext *xml = wctx->priv;
1231
1232     if (xml->xsd_strict) {
1233         xml->fully_qualified = 1;
1234 #define CHECK_COMPLIANCE(opt, opt_name)                                 \
1235         if (opt) {                                                      \
1236             av_log(wctx, AV_LOG_ERROR,                                  \
1237                    "XSD-compliant output selected but option '%s' was selected, XML output may be non-compliant.\n" \
1238                    "You need to disable such option with '-no%s'\n", opt_name, opt_name); \
1239             return AVERROR(EINVAL);                                     \
1240         }
1241         CHECK_COMPLIANCE(show_private_data, "private");
1242         CHECK_COMPLIANCE(show_value_unit,   "unit");
1243         CHECK_COMPLIANCE(use_value_prefix,  "prefix");
1244
1245         if (do_show_frames && do_show_packets) {
1246             av_log(wctx, AV_LOG_ERROR,
1247                    "Interleaved frames and packets are not allowed in XSD. "
1248                    "Select only one between the -show_frames and the -show_packets options.\n");
1249             return AVERROR(EINVAL);
1250         }
1251     }
1252
1253     return 0;
1254 }
1255
1256 static const char *xml_escape_str(AVBPrint *dst, const char *src, void *log_ctx)
1257 {
1258     const char *p;
1259
1260     for (p = src; *p; p++) {
1261         switch (*p) {
1262         case '&' : av_bprintf(dst, "%s", "&amp;");  break;
1263         case '<' : av_bprintf(dst, "%s", "&lt;");   break;
1264         case '>' : av_bprintf(dst, "%s", "&gt;");   break;
1265         case '\"': av_bprintf(dst, "%s", "&quot;"); break;
1266         case '\'': av_bprintf(dst, "%s", "&apos;"); break;
1267         default: av_bprint_chars(dst, *p, 1);
1268         }
1269     }
1270
1271     return dst->str;
1272 }
1273
1274 #define XML_INDENT() printf("%*c", xml->indent_level * 4, ' ')
1275
1276 static void xml_print_section_header(WriterContext *wctx)
1277 {
1278     XMLContext *xml = wctx->priv;
1279     const struct section *section = wctx->section[wctx->level];
1280     const struct section *parent_section = wctx->level ?
1281         wctx->section[wctx->level-1] : NULL;
1282
1283     if (wctx->level == 0) {
1284         const char *qual = " xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' "
1285             "xmlns:ffprobe='http://www.ffmpeg.org/schema/ffprobe' "
1286             "xsi:schemaLocation='http://www.ffmpeg.org/schema/ffprobe ffprobe.xsd'";
1287
1288         printf("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
1289         printf("<%sffprobe%s>\n",
1290                xml->fully_qualified ? "ffprobe:" : "",
1291                xml->fully_qualified ? qual : "");
1292         return;
1293     }
1294
1295     if (xml->within_tag) {
1296         xml->within_tag = 0;
1297         printf(">\n");
1298     }
1299     if (!strcmp(section->name, "tags")) {
1300         xml->indent_level++;
1301     } else {
1302         if (!(parent_section->flags & SECTION_FLAG_IS_ARRAY) &&
1303             (wctx->level && wctx->nb_item[wctx->level-1]))
1304         printf("\n");
1305
1306         xml->indent_level++;
1307
1308         if (section->flags & SECTION_FLAG_IS_ARRAY) {
1309             XML_INDENT(); printf("<%s>\n", section->name);
1310         } else {
1311             XML_INDENT(); printf("<%s ", section->name);
1312             xml->within_tag = 1;
1313         }
1314     }
1315 }
1316
1317 static void xml_print_section_footer(WriterContext *wctx)
1318 {
1319     XMLContext *xml = wctx->priv;
1320     const struct section *section = wctx->section[wctx->level];
1321
1322     if (wctx->level == 0) {
1323         printf("</%sffprobe>\n", xml->fully_qualified ? "ffprobe:" : "");
1324     } else if (xml->within_tag) {
1325         xml->within_tag = 0;
1326         printf("/>\n");
1327         xml->indent_level--;
1328     } else if (!strcmp(section->name, "tags")) {
1329         xml->indent_level--;
1330     } else {
1331         XML_INDENT(); printf("</%s>\n", section->name);
1332         xml->indent_level--;
1333     }
1334 }
1335
1336 static void xml_print_str(WriterContext *wctx, const char *key, const char *value)
1337 {
1338     AVBPrint buf;
1339     XMLContext *xml = wctx->priv;
1340     const struct section *section = wctx->section[wctx->level];
1341
1342     av_bprint_init(&buf, 1, AV_BPRINT_SIZE_UNLIMITED);
1343
1344     if (!strcmp(section->name, "tags")) {
1345         XML_INDENT();
1346         printf("<tag key=\"%s\"", xml_escape_str(&buf, key, wctx));
1347         av_bprint_clear(&buf);
1348         printf(" value=\"%s\"/>\n", xml_escape_str(&buf, value, wctx));
1349     } else {
1350         if (wctx->nb_item[wctx->level])
1351             printf(" ");
1352         printf("%s=\"%s\"", key, xml_escape_str(&buf, value, wctx));
1353     }
1354
1355     av_bprint_finalize(&buf, NULL);
1356 }
1357
1358 static void xml_print_int(WriterContext *wctx, const char *key, long long int value)
1359 {
1360     if (wctx->nb_item[wctx->level])
1361         printf(" ");
1362     printf("%s=\"%lld\"", key, value);
1363 }
1364
1365 static Writer xml_writer = {
1366     .name                 = "xml",
1367     .priv_size            = sizeof(XMLContext),
1368     .init                 = xml_init,
1369     .print_section_header = xml_print_section_header,
1370     .print_section_footer = xml_print_section_footer,
1371     .print_integer        = xml_print_int,
1372     .print_string         = xml_print_str,
1373     .flags = WRITER_FLAG_PUT_PACKETS_AND_FRAMES_IN_SAME_CHAPTER,
1374     .priv_class           = &xml_class,
1375 };
1376
1377 static void writer_register_all(void)
1378 {
1379     static int initialized;
1380
1381     if (initialized)
1382         return;
1383     initialized = 1;
1384
1385     writer_register(&default_writer);
1386     writer_register(&compact_writer);
1387     writer_register(&csv_writer);
1388     writer_register(&flat_writer);
1389     writer_register(&ini_writer);
1390     writer_register(&json_writer);
1391     writer_register(&xml_writer);
1392 }
1393
1394 #define print_fmt(k, f, ...) do {              \
1395     av_bprint_clear(&pbuf);                    \
1396     av_bprintf(&pbuf, f, __VA_ARGS__);         \
1397     writer_print_string(w, k, pbuf.str, 0);    \
1398 } while (0)
1399
1400 #define print_int(k, v)         writer_print_integer(w, k, v)
1401 #define print_q(k, v, s)        writer_print_rational(w, k, v, s)
1402 #define print_str(k, v)         writer_print_string(w, k, v, 0)
1403 #define print_str_opt(k, v)     writer_print_string(w, k, v, 1)
1404 #define print_time(k, v, tb)    writer_print_time(w, k, v, tb, 0)
1405 #define print_ts(k, v)          writer_print_ts(w, k, v, 0)
1406 #define print_duration_time(k, v, tb) writer_print_time(w, k, v, tb, 1)
1407 #define print_duration_ts(k, v)       writer_print_ts(w, k, v, 1)
1408 #define print_val(k, v, u) do {                                     \
1409     struct unit_value uv;                                           \
1410     uv.val.i = v;                                                   \
1411     uv.unit = u;                                                    \
1412     writer_print_string(w, k, value_string(val_str, sizeof(val_str), uv), 0); \
1413 } while (0)
1414
1415 #define print_section_header(s) writer_print_section_header(w, s)
1416 #define print_section_footer(s) writer_print_section_footer(w, s)
1417
1418 static inline void show_tags(WriterContext *wctx, AVDictionary *tags, int section_id)
1419 {
1420     AVDictionaryEntry *tag = NULL;
1421
1422     if (!tags)
1423         return;
1424     writer_print_section_header(wctx, section_id);
1425     while ((tag = av_dict_get(tags, "", tag, AV_DICT_IGNORE_SUFFIX)))
1426         writer_print_string(wctx, tag->key, tag->value, 0);
1427     writer_print_section_footer(wctx);
1428 }
1429
1430 static void show_packet(WriterContext *w, AVFormatContext *fmt_ctx, AVPacket *pkt, int packet_idx)
1431 {
1432     char val_str[128];
1433     AVStream *st = fmt_ctx->streams[pkt->stream_index];
1434     AVBPrint pbuf;
1435     const char *s;
1436
1437     av_bprint_init(&pbuf, 1, AV_BPRINT_SIZE_UNLIMITED);
1438
1439     writer_print_section_header(w, SECTION_ID_PACKET);
1440
1441     s = av_get_media_type_string(st->codec->codec_type);
1442     if (s) print_str    ("codec_type", s);
1443     else   print_str_opt("codec_type", "unknown");
1444     print_int("stream_index",     pkt->stream_index);
1445     print_ts  ("pts",             pkt->pts);
1446     print_time("pts_time",        pkt->pts, &st->time_base);
1447     print_ts  ("dts",             pkt->dts);
1448     print_time("dts_time",        pkt->dts, &st->time_base);
1449     print_duration_ts("duration",        pkt->duration);
1450     print_duration_time("duration_time", pkt->duration, &st->time_base);
1451     print_duration_ts("convergence_duration", pkt->convergence_duration);
1452     print_duration_time("convergence_duration_time", pkt->convergence_duration, &st->time_base);
1453     print_val("size",             pkt->size, unit_byte_str);
1454     if (pkt->pos != -1) print_fmt    ("pos", "%"PRId64, pkt->pos);
1455     else                print_str_opt("pos", "N/A");
1456     print_fmt("flags", "%c",      pkt->flags & AV_PKT_FLAG_KEY ? 'K' : '_');
1457     if (do_show_data)
1458         writer_print_data(w, "data", pkt->data, pkt->size);
1459     writer_print_section_footer(w);
1460
1461     av_bprint_finalize(&pbuf, NULL);
1462     fflush(stdout);
1463 }
1464
1465 static void show_frame(WriterContext *w, AVFrame *frame, AVStream *stream,
1466                        AVFormatContext *fmt_ctx)
1467 {
1468     AVBPrint pbuf;
1469     const char *s;
1470
1471     av_bprint_init(&pbuf, 1, AV_BPRINT_SIZE_UNLIMITED);
1472
1473     writer_print_section_header(w, SECTION_ID_FRAME);
1474
1475     s = av_get_media_type_string(stream->codec->codec_type);
1476     if (s) print_str    ("media_type", s);
1477     else   print_str_opt("media_type", "unknown");
1478     print_int("key_frame",              frame->key_frame);
1479     print_ts  ("pkt_pts",               frame->pkt_pts);
1480     print_time("pkt_pts_time",          frame->pkt_pts, &stream->time_base);
1481     print_ts  ("pkt_dts",               frame->pkt_dts);
1482     print_time("pkt_dts_time",          frame->pkt_dts, &stream->time_base);
1483     print_duration_ts  ("pkt_duration",      frame->pkt_duration);
1484     print_duration_time("pkt_duration_time", frame->pkt_duration, &stream->time_base);
1485     if (frame->pkt_pos != -1) print_fmt    ("pkt_pos", "%"PRId64, frame->pkt_pos);
1486     else                      print_str_opt("pkt_pos", "N/A");
1487
1488     switch (stream->codec->codec_type) {
1489         AVRational sar;
1490
1491     case AVMEDIA_TYPE_VIDEO:
1492         print_int("width",                  frame->width);
1493         print_int("height",                 frame->height);
1494         s = av_get_pix_fmt_name(frame->format);
1495         if (s) print_str    ("pix_fmt", s);
1496         else   print_str_opt("pix_fmt", "unknown");
1497         sar = av_guess_sample_aspect_ratio(fmt_ctx, stream, frame);
1498         if (sar.num) {
1499             print_q("sample_aspect_ratio", sar, ':');
1500         } else {
1501             print_str_opt("sample_aspect_ratio", "N/A");
1502         }
1503         print_fmt("pict_type",              "%c", av_get_picture_type_char(frame->pict_type));
1504         print_int("coded_picture_number",   frame->coded_picture_number);
1505         print_int("display_picture_number", frame->display_picture_number);
1506         print_int("interlaced_frame",       frame->interlaced_frame);
1507         print_int("top_field_first",        frame->top_field_first);
1508         print_int("repeat_pict",            frame->repeat_pict);
1509         print_int("reference",              frame->reference);
1510         break;
1511
1512     case AVMEDIA_TYPE_AUDIO:
1513         s = av_get_sample_fmt_name(frame->format);
1514         if (s) print_str    ("sample_fmt", s);
1515         else   print_str_opt("sample_fmt", "unknown");
1516         print_int("nb_samples",         frame->nb_samples);
1517         print_int("channels", av_frame_get_channels(frame));
1518         if (av_frame_get_channel_layout(frame)) {
1519             av_bprint_clear(&pbuf);
1520             av_bprint_channel_layout(&pbuf, av_frame_get_channels(frame),
1521                                      av_frame_get_channel_layout(frame));
1522             print_str    ("channel_layout", pbuf.str);
1523         } else
1524             print_str_opt("channel_layout", "unknown");
1525         break;
1526     }
1527     show_tags(w, av_frame_get_metadata(frame), SECTION_ID_FRAME_TAGS);
1528
1529     writer_print_section_footer(w);
1530
1531     av_bprint_finalize(&pbuf, NULL);
1532     fflush(stdout);
1533 }
1534
1535 static av_always_inline int process_frame(WriterContext *w,
1536                                           AVFormatContext *fmt_ctx,
1537                                           AVFrame *frame, AVPacket *pkt)
1538 {
1539     AVCodecContext *dec_ctx = fmt_ctx->streams[pkt->stream_index]->codec;
1540     int ret = 0, got_frame = 0;
1541
1542     avcodec_get_frame_defaults(frame);
1543     if (dec_ctx->codec) {
1544         switch (dec_ctx->codec_type) {
1545         case AVMEDIA_TYPE_VIDEO:
1546             ret = avcodec_decode_video2(dec_ctx, frame, &got_frame, pkt);
1547             break;
1548
1549         case AVMEDIA_TYPE_AUDIO:
1550             ret = avcodec_decode_audio4(dec_ctx, frame, &got_frame, pkt);
1551             break;
1552         }
1553     }
1554
1555     if (ret < 0)
1556         return ret;
1557     ret = FFMIN(ret, pkt->size); /* guard against bogus return values */
1558     pkt->data += ret;
1559     pkt->size -= ret;
1560     if (got_frame) {
1561         nb_streams_frames[pkt->stream_index]++;
1562         if (do_show_frames)
1563             show_frame(w, frame, fmt_ctx->streams[pkt->stream_index], fmt_ctx);
1564     }
1565     return got_frame;
1566 }
1567
1568 static void read_packets(WriterContext *w, AVFormatContext *fmt_ctx)
1569 {
1570     AVPacket pkt, pkt1;
1571     AVFrame frame;
1572     int i = 0;
1573
1574     av_init_packet(&pkt);
1575
1576     while (!av_read_frame(fmt_ctx, &pkt)) {
1577         if (do_read_packets) {
1578             if (do_show_packets)
1579                 show_packet(w, fmt_ctx, &pkt, i++);
1580             nb_streams_packets[pkt.stream_index]++;
1581         }
1582         if (do_read_frames) {
1583             pkt1 = pkt;
1584             while (pkt1.size && process_frame(w, fmt_ctx, &frame, &pkt1) > 0);
1585         }
1586         av_free_packet(&pkt);
1587     }
1588     av_init_packet(&pkt);
1589     pkt.data = NULL;
1590     pkt.size = 0;
1591     //Flush remaining frames that are cached in the decoder
1592     for (i = 0; i < fmt_ctx->nb_streams; i++) {
1593         pkt.stream_index = i;
1594         if (do_read_frames)
1595             while (process_frame(w, fmt_ctx, &frame, &pkt) > 0);
1596     }
1597 }
1598
1599 static void show_stream(WriterContext *w, AVFormatContext *fmt_ctx, int stream_idx)
1600 {
1601     AVStream *stream = fmt_ctx->streams[stream_idx];
1602     AVCodecContext *dec_ctx;
1603     const AVCodec *dec;
1604     char val_str[128];
1605     const char *s;
1606     AVRational sar, dar;
1607     AVBPrint pbuf;
1608
1609     av_bprint_init(&pbuf, 1, AV_BPRINT_SIZE_UNLIMITED);
1610
1611     writer_print_section_header(w, SECTION_ID_STREAM);
1612
1613     print_int("index", stream->index);
1614
1615     if ((dec_ctx = stream->codec)) {
1616         const char *profile = NULL;
1617         dec = dec_ctx->codec;
1618         if (dec) {
1619             print_str("codec_name", dec->name);
1620             if (!do_bitexact) {
1621                 if (dec->long_name) print_str    ("codec_long_name", dec->long_name);
1622                 else                print_str_opt("codec_long_name", "unknown");
1623             }
1624         } else {
1625             print_str_opt("codec_name", "unknown");
1626             if (!do_bitexact) {
1627                 print_str_opt("codec_long_name", "unknown");
1628             }
1629         }
1630
1631         if (dec && (profile = av_get_profile_name(dec, dec_ctx->profile)))
1632             print_str("profile", profile);
1633         else
1634             print_str_opt("profile", "unknown");
1635
1636         s = av_get_media_type_string(dec_ctx->codec_type);
1637         if (s) print_str    ("codec_type", s);
1638         else   print_str_opt("codec_type", "unknown");
1639         print_q("codec_time_base", dec_ctx->time_base, '/');
1640
1641         /* print AVI/FourCC tag */
1642         av_get_codec_tag_string(val_str, sizeof(val_str), dec_ctx->codec_tag);
1643         print_str("codec_tag_string",    val_str);
1644         print_fmt("codec_tag", "0x%04x", dec_ctx->codec_tag);
1645
1646         /* Print useful disposition */
1647         print_int("default", !!(stream->disposition & AV_DISPOSITION_DEFAULT));
1648         print_int("forced", !!(stream->disposition & AV_DISPOSITION_FORCED));
1649
1650         switch (dec_ctx->codec_type) {
1651         case AVMEDIA_TYPE_VIDEO:
1652             print_int("width",        dec_ctx->width);
1653             print_int("height",       dec_ctx->height);
1654             print_int("has_b_frames", dec_ctx->has_b_frames);
1655             sar = av_guess_sample_aspect_ratio(fmt_ctx, stream, NULL);
1656             if (sar.den) {
1657                 print_q("sample_aspect_ratio", sar, ':');
1658                 av_reduce(&dar.num, &dar.den,
1659                           dec_ctx->width  * sar.num,
1660                           dec_ctx->height * sar.den,
1661                           1024*1024);
1662                 print_q("display_aspect_ratio", dar, ':');
1663             } else {
1664                 print_str_opt("sample_aspect_ratio", "N/A");
1665                 print_str_opt("display_aspect_ratio", "N/A");
1666             }
1667             s = av_get_pix_fmt_name(dec_ctx->pix_fmt);
1668             if (s) print_str    ("pix_fmt", s);
1669             else   print_str_opt("pix_fmt", "unknown");
1670             print_int("level",   dec_ctx->level);
1671             if (dec_ctx->timecode_frame_start >= 0) {
1672                 char tcbuf[AV_TIMECODE_STR_SIZE];
1673                 av_timecode_make_mpeg_tc_string(tcbuf, dec_ctx->timecode_frame_start);
1674                 print_str("timecode", tcbuf);
1675             } else {
1676                 print_str_opt("timecode", "N/A");
1677             }
1678             print_int("attached_pic",
1679                       !!(stream->disposition & AV_DISPOSITION_ATTACHED_PIC));
1680             break;
1681
1682         case AVMEDIA_TYPE_AUDIO:
1683             s = av_get_sample_fmt_name(dec_ctx->sample_fmt);
1684             if (s) print_str    ("sample_fmt", s);
1685             else   print_str_opt("sample_fmt", "unknown");
1686             print_val("sample_rate",     dec_ctx->sample_rate, unit_hertz_str);
1687             print_int("channels",        dec_ctx->channels);
1688             print_int("bits_per_sample", av_get_bits_per_sample(dec_ctx->codec_id));
1689             break;
1690         }
1691     } else {
1692         print_str_opt("codec_type", "unknown");
1693     }
1694     if (dec_ctx->codec && dec_ctx->codec->priv_class && show_private_data) {
1695         const AVOption *opt = NULL;
1696         while (opt = av_opt_next(dec_ctx->priv_data,opt)) {
1697             uint8_t *str;
1698             if (opt->flags) continue;
1699             if (av_opt_get(dec_ctx->priv_data, opt->name, 0, &str) >= 0) {
1700                 print_str(opt->name, str);
1701                 av_free(str);
1702             }
1703         }
1704     }
1705
1706     if (fmt_ctx->iformat->flags & AVFMT_SHOW_IDS) print_fmt    ("id", "0x%x", stream->id);
1707     else                                          print_str_opt("id", "N/A");
1708     print_q("r_frame_rate",   stream->r_frame_rate,   '/');
1709     print_q("avg_frame_rate", stream->avg_frame_rate, '/');
1710     print_q("time_base",      stream->time_base,      '/');
1711     print_ts  ("start_pts",   stream->start_time);
1712     print_time("start_time",  stream->start_time, &stream->time_base);
1713     print_ts  ("duration_ts", stream->duration);
1714     print_time("duration",    stream->duration, &stream->time_base);
1715     if (dec_ctx->bit_rate > 0) print_val    ("bit_rate", dec_ctx->bit_rate, unit_bit_per_second_str);
1716     else                       print_str_opt("bit_rate", "N/A");
1717     if (stream->nb_frames) print_fmt    ("nb_frames", "%"PRId64, stream->nb_frames);
1718     else                   print_str_opt("nb_frames", "N/A");
1719     if (nb_streams_frames[stream_idx])  print_fmt    ("nb_read_frames", "%"PRIu64, nb_streams_frames[stream_idx]);
1720     else                                print_str_opt("nb_read_frames", "N/A");
1721     if (nb_streams_packets[stream_idx]) print_fmt    ("nb_read_packets", "%"PRIu64, nb_streams_packets[stream_idx]);
1722     else                                print_str_opt("nb_read_packets", "N/A");
1723     if (do_show_data)
1724         writer_print_data(w, "extradata", dec_ctx->extradata,
1725                                           dec_ctx->extradata_size);
1726     show_tags(w, stream->metadata, SECTION_ID_STREAM_TAGS);
1727
1728     writer_print_section_footer(w);
1729     av_bprint_finalize(&pbuf, NULL);
1730     fflush(stdout);
1731 }
1732
1733 static void show_streams(WriterContext *w, AVFormatContext *fmt_ctx)
1734 {
1735     int i;
1736     writer_print_section_header(w, SECTION_ID_STREAMS);
1737     for (i = 0; i < fmt_ctx->nb_streams; i++)
1738         show_stream(w, fmt_ctx, i);
1739     writer_print_section_footer(w);
1740 }
1741
1742 static void show_format(WriterContext *w, AVFormatContext *fmt_ctx)
1743 {
1744     char val_str[128];
1745     int64_t size = fmt_ctx->pb ? avio_size(fmt_ctx->pb) : -1;
1746
1747     writer_print_section_header(w, SECTION_ID_FORMAT);
1748     print_str("filename",         fmt_ctx->filename);
1749     print_int("nb_streams",       fmt_ctx->nb_streams);
1750     print_str("format_name",      fmt_ctx->iformat->name);
1751     if (!do_bitexact) {
1752         if (fmt_ctx->iformat->long_name) print_str    ("format_long_name", fmt_ctx->iformat->long_name);
1753         else                             print_str_opt("format_long_name", "unknown");
1754     }
1755     print_time("start_time",      fmt_ctx->start_time, &AV_TIME_BASE_Q);
1756     print_time("duration",        fmt_ctx->duration,   &AV_TIME_BASE_Q);
1757     if (size >= 0) print_val    ("size", size, unit_byte_str);
1758     else           print_str_opt("size", "N/A");
1759     if (fmt_ctx->bit_rate > 0) print_val    ("bit_rate", fmt_ctx->bit_rate, unit_bit_per_second_str);
1760     else                       print_str_opt("bit_rate", "N/A");
1761     show_tags(w, fmt_ctx->metadata, SECTION_ID_FORMAT_TAGS);
1762
1763     writer_print_section_footer(w);
1764     fflush(stdout);
1765 }
1766
1767 static void show_error(WriterContext *w, int err)
1768 {
1769     char errbuf[128];
1770     const char *errbuf_ptr = errbuf;
1771
1772     if (av_strerror(err, errbuf, sizeof(errbuf)) < 0)
1773         errbuf_ptr = strerror(AVUNERROR(err));
1774
1775     writer_print_section_header(w, SECTION_ID_ERROR);
1776     print_int("code", err);
1777     print_str("string", errbuf_ptr);
1778     writer_print_section_footer(w);
1779 }
1780
1781 static int open_input_file(AVFormatContext **fmt_ctx_ptr, const char *filename)
1782 {
1783     int err, i;
1784     AVFormatContext *fmt_ctx = NULL;
1785     AVDictionaryEntry *t;
1786
1787     if ((err = avformat_open_input(&fmt_ctx, filename,
1788                                    iformat, &format_opts)) < 0) {
1789         print_error(filename, err);
1790         return err;
1791     }
1792     if ((t = av_dict_get(format_opts, "", NULL, AV_DICT_IGNORE_SUFFIX))) {
1793         av_log(NULL, AV_LOG_ERROR, "Option %s not found.\n", t->key);
1794         return AVERROR_OPTION_NOT_FOUND;
1795     }
1796
1797
1798     /* fill the streams in the format context */
1799     if ((err = avformat_find_stream_info(fmt_ctx, NULL)) < 0) {
1800         print_error(filename, err);
1801         return err;
1802     }
1803
1804     av_dump_format(fmt_ctx, 0, filename, 0);
1805
1806     /* bind a decoder to each input stream */
1807     for (i = 0; i < fmt_ctx->nb_streams; i++) {
1808         AVStream *stream = fmt_ctx->streams[i];
1809         AVCodec *codec;
1810
1811         if (stream->codec->codec_id == AV_CODEC_ID_PROBE) {
1812             av_log(NULL, AV_LOG_ERROR,
1813                    "Failed to probe codec for input stream %d\n",
1814                     stream->index);
1815         } else if (!(codec = avcodec_find_decoder(stream->codec->codec_id))) {
1816             av_log(NULL, AV_LOG_ERROR,
1817                     "Unsupported codec with id %d for input stream %d\n",
1818                     stream->codec->codec_id, stream->index);
1819         } else if (avcodec_open2(stream->codec, codec, NULL) < 0) {
1820             av_log(NULL, AV_LOG_ERROR, "Error while opening codec for input stream %d\n",
1821                    stream->index);
1822         }
1823     }
1824
1825     *fmt_ctx_ptr = fmt_ctx;
1826     return 0;
1827 }
1828
1829 static void close_input_file(AVFormatContext **ctx_ptr)
1830 {
1831     int i;
1832     AVFormatContext *fmt_ctx = *ctx_ptr;
1833
1834     /* close decoder for each stream */
1835     for (i = 0; i < fmt_ctx->nb_streams; i++)
1836         if (fmt_ctx->streams[i]->codec->codec_id != AV_CODEC_ID_NONE)
1837             avcodec_close(fmt_ctx->streams[i]->codec);
1838
1839     avformat_close_input(ctx_ptr);
1840 }
1841
1842 static int probe_file(WriterContext *wctx, const char *filename)
1843 {
1844     AVFormatContext *fmt_ctx;
1845     int ret;
1846     int section_id;
1847
1848     do_read_frames = do_show_frames || do_count_frames;
1849     do_read_packets = do_show_packets || do_count_packets;
1850
1851     ret = open_input_file(&fmt_ctx, filename);
1852     if (ret >= 0) {
1853         nb_streams_frames  = av_calloc(fmt_ctx->nb_streams, sizeof(*nb_streams_frames));
1854         nb_streams_packets = av_calloc(fmt_ctx->nb_streams, sizeof(*nb_streams_packets));
1855         if (do_read_frames || do_read_packets) {
1856             if (do_show_frames && do_show_packets &&
1857                 wctx->writer->flags & WRITER_FLAG_PUT_PACKETS_AND_FRAMES_IN_SAME_CHAPTER)
1858                 section_id = SECTION_ID_PACKETS_AND_FRAMES;
1859             else if (do_show_packets && !do_show_frames)
1860                 section_id = SECTION_ID_PACKETS;
1861             else // (!do_show_packets && do_show_frames)
1862                 section_id = SECTION_ID_FRAMES;
1863             if (do_show_frames || do_show_packets)
1864                 writer_print_section_header(wctx, section_id);
1865             read_packets(wctx, fmt_ctx);
1866             if (do_show_frames || do_show_packets)
1867                 writer_print_section_footer(wctx);
1868         }
1869         if (do_show_streams)
1870             show_streams(wctx, fmt_ctx);
1871         if (do_show_format)
1872             show_format(wctx, fmt_ctx);
1873
1874         close_input_file(&fmt_ctx);
1875         av_freep(&nb_streams_frames);
1876         av_freep(&nb_streams_packets);
1877     }
1878     return ret;
1879 }
1880
1881 static void show_usage(void)
1882 {
1883     av_log(NULL, AV_LOG_INFO, "Simple multimedia streams analyzer\n");
1884     av_log(NULL, AV_LOG_INFO, "usage: %s [OPTIONS] [INPUT_FILE]\n", program_name);
1885     av_log(NULL, AV_LOG_INFO, "\n");
1886 }
1887
1888 static void ffprobe_show_program_version(WriterContext *w)
1889 {
1890     AVBPrint pbuf;
1891     av_bprint_init(&pbuf, 1, AV_BPRINT_SIZE_UNLIMITED);
1892
1893     writer_print_section_header(w, SECTION_ID_PROGRAM_VERSION);
1894     print_str("version", FFMPEG_VERSION);
1895     print_fmt("copyright", "Copyright (c) %d-%d the FFmpeg developers",
1896               program_birth_year, this_year);
1897     print_str("build_date", __DATE__);
1898     print_str("build_time", __TIME__);
1899     print_str("compiler_ident", CC_IDENT);
1900     print_str("configuration", FFMPEG_CONFIGURATION);
1901     writer_print_section_footer(w);
1902
1903     av_bprint_finalize(&pbuf, NULL);
1904 }
1905
1906 #define SHOW_LIB_VERSION(libname, LIBNAME)                              \
1907     do {                                                                \
1908         if (CONFIG_##LIBNAME) {                                         \
1909             unsigned int version = libname##_version();                 \
1910             writer_print_section_header(w, SECTION_ID_LIBRARY_VERSION); \
1911             print_str("name",    "lib" #libname);                       \
1912             print_int("major",   LIB##LIBNAME##_VERSION_MAJOR);         \
1913             print_int("minor",   LIB##LIBNAME##_VERSION_MINOR);         \
1914             print_int("micro",   LIB##LIBNAME##_VERSION_MICRO);         \
1915             print_int("version", version);                              \
1916             print_str("ident",   LIB##LIBNAME##_IDENT);                 \
1917             writer_print_section_footer(w);                             \
1918         }                                                               \
1919     } while (0)
1920
1921 static void ffprobe_show_library_versions(WriterContext *w)
1922 {
1923     writer_print_section_header(w, SECTION_ID_LIBRARY_VERSIONS);
1924     SHOW_LIB_VERSION(avutil,     AVUTIL);
1925     SHOW_LIB_VERSION(avcodec,    AVCODEC);
1926     SHOW_LIB_VERSION(avformat,   AVFORMAT);
1927     SHOW_LIB_VERSION(avdevice,   AVDEVICE);
1928     SHOW_LIB_VERSION(avfilter,   AVFILTER);
1929     SHOW_LIB_VERSION(swscale,    SWSCALE);
1930     SHOW_LIB_VERSION(swresample, SWRESAMPLE);
1931     SHOW_LIB_VERSION(postproc,   POSTPROC);
1932     writer_print_section_footer(w);
1933 }
1934
1935 static int opt_format(void *optctx, const char *opt, const char *arg)
1936 {
1937     iformat = av_find_input_format(arg);
1938     if (!iformat) {
1939         av_log(NULL, AV_LOG_ERROR, "Unknown input format: %s\n", arg);
1940         return AVERROR(EINVAL);
1941     }
1942     return 0;
1943 }
1944
1945 static int opt_show_format_entry(void *optctx, const char *opt, const char *arg)
1946 {
1947     do_show_format = 1;
1948     av_dict_set(&fmt_entries_to_show, arg, "", 0);
1949     return 0;
1950 }
1951
1952 static void opt_input_file(void *optctx, const char *arg)
1953 {
1954     if (input_filename) {
1955         av_log(NULL, AV_LOG_ERROR,
1956                 "Argument '%s' provided as input filename, but '%s' was already specified.\n",
1957                 arg, input_filename);
1958         exit(1);
1959     }
1960     if (!strcmp(arg, "-"))
1961         arg = "pipe:";
1962     input_filename = arg;
1963 }
1964
1965 static int opt_input_file_i(void *optctx, const char *opt, const char *arg)
1966 {
1967     opt_input_file(optctx, arg);
1968     return 0;
1969 }
1970
1971 void show_help_default(const char *opt, const char *arg)
1972 {
1973     av_log_set_callback(log_callback_help);
1974     show_usage();
1975     show_help_options(options, "Main options:", 0, 0, 0);
1976     printf("\n");
1977
1978     show_help_children(avformat_get_class(), AV_OPT_FLAG_DECODING_PARAM);
1979 }
1980
1981 static int opt_pretty(void *optctx, const char *opt, const char *arg)
1982 {
1983     show_value_unit              = 1;
1984     use_value_prefix             = 1;
1985     use_byte_value_binary_prefix = 1;
1986     use_value_sexagesimal_format = 1;
1987     return 0;
1988 }
1989
1990 static int opt_show_versions(const char *opt, const char *arg)
1991 {
1992     do_show_program_version  = 1;
1993     do_show_library_versions = 1;
1994     return 0;
1995 }
1996
1997 static const OptionDef real_options[] = {
1998 #include "cmdutils_common_opts.h"
1999     { "f", HAS_ARG, {.func_arg = opt_format}, "force format", "format" },
2000     { "unit", OPT_BOOL, {&show_value_unit}, "show unit of the displayed values" },
2001     { "prefix", OPT_BOOL, {&use_value_prefix}, "use SI prefixes for the displayed values" },
2002     { "byte_binary_prefix", OPT_BOOL, {&use_byte_value_binary_prefix},
2003       "use binary prefixes for byte units" },
2004     { "sexagesimal", OPT_BOOL,  {&use_value_sexagesimal_format},
2005       "use sexagesimal format HOURS:MM:SS.MICROSECONDS for time units" },
2006     { "pretty", 0, {.func_arg = opt_pretty},
2007       "prettify the format of displayed values, make it more human readable" },
2008     { "print_format", OPT_STRING | HAS_ARG, {(void*)&print_format},
2009       "set the output printing format (available formats are: default, compact, csv, flat, ini, json, xml)", "format" },
2010     { "of", OPT_STRING | HAS_ARG, {(void*)&print_format}, "alias for -print_format", "format" },
2011     { "show_data",    OPT_BOOL, {(void*)&do_show_data}, "show packets data" },
2012     { "show_error",   OPT_BOOL, {(void*)&do_show_error} ,  "show probing error" },
2013     { "show_format",  OPT_BOOL, {&do_show_format} , "show format/container info" },
2014     { "show_frames",  OPT_BOOL, {(void*)&do_show_frames} , "show frames info" },
2015     { "show_format_entry", HAS_ARG, {.func_arg = opt_show_format_entry},
2016       "show a particular entry from the format/container info", "entry" },
2017     { "show_packets", OPT_BOOL, {&do_show_packets}, "show packets info" },
2018     { "show_streams", OPT_BOOL, {&do_show_streams}, "show streams info" },
2019     { "count_frames", OPT_BOOL, {(void*)&do_count_frames}, "count the number of frames per stream" },
2020     { "count_packets", OPT_BOOL, {(void*)&do_count_packets}, "count the number of packets per stream" },
2021     { "show_program_version",  OPT_BOOL, {(void*)&do_show_program_version},  "show ffprobe version" },
2022     { "show_library_versions", OPT_BOOL, {(void*)&do_show_library_versions}, "show library versions" },
2023     { "show_versions",         0, {(void*)&opt_show_versions}, "show program and library versions" },
2024     { "show_private_data", OPT_BOOL, {(void*)&show_private_data}, "show private data" },
2025     { "private",           OPT_BOOL, {(void*)&show_private_data}, "same as show_private_data" },
2026     { "bitexact", OPT_BOOL, {&do_bitexact}, "force bitexact output" },
2027     { "default", HAS_ARG | OPT_AUDIO | OPT_VIDEO | OPT_EXPERT, {.func_arg = opt_default}, "generic catch all option", "" },
2028     { "i", HAS_ARG, {.func_arg = opt_input_file_i}, "read specified file", "input_file"},
2029     { NULL, },
2030 };
2031
2032 int main(int argc, char **argv)
2033 {
2034     const Writer *w;
2035     WriterContext *wctx;
2036     char *buf;
2037     char *w_name = NULL, *w_args = NULL;
2038     int ret;
2039
2040     av_log_set_flags(AV_LOG_SKIP_REPEATED);
2041     options = real_options;
2042     parse_loglevel(argc, argv, options);
2043     av_register_all();
2044     avformat_network_init();
2045     init_opts();
2046 #if CONFIG_AVDEVICE
2047     avdevice_register_all();
2048 #endif
2049
2050     show_banner(argc, argv, options);
2051     parse_options(NULL, argc, argv, options, opt_input_file);
2052
2053     if (do_bitexact && (do_show_program_version || do_show_library_versions)) {
2054         av_log(NULL, AV_LOG_ERROR,
2055                "-bitexact and -show_program_version or -show_library_versions "
2056                "options are incompatible\n");
2057         ret = AVERROR(EINVAL);
2058         goto end;
2059     }
2060
2061     writer_register_all();
2062
2063     if (!print_format)
2064         print_format = av_strdup("default");
2065     w_name = av_strtok(print_format, "=", &buf);
2066     w_args = buf;
2067
2068     w = writer_get_by_name(w_name);
2069     if (!w) {
2070         av_log(NULL, AV_LOG_ERROR, "Unknown output format with name '%s'\n", w_name);
2071         ret = AVERROR(EINVAL);
2072         goto end;
2073     }
2074
2075     if ((ret = writer_open(&wctx, w, w_args,
2076                            sections, FF_ARRAY_ELEMS(sections))) >= 0) {
2077         writer_print_section_header(wctx, SECTION_ID_ROOT);
2078
2079         if (do_show_program_version)
2080             ffprobe_show_program_version(wctx);
2081         if (do_show_library_versions)
2082             ffprobe_show_library_versions(wctx);
2083
2084         if (!input_filename &&
2085             ((do_show_format || do_show_streams || do_show_packets || do_show_error) ||
2086              (!do_show_program_version && !do_show_library_versions))) {
2087             show_usage();
2088             av_log(NULL, AV_LOG_ERROR, "You have to specify one input file.\n");
2089             av_log(NULL, AV_LOG_ERROR, "Use -h to get full help or, even better, run 'man %s'.\n", program_name);
2090             ret = AVERROR(EINVAL);
2091         } else if (input_filename) {
2092             ret = probe_file(wctx, input_filename);
2093             if (ret < 0 && do_show_error)
2094                 show_error(wctx, ret);
2095         }
2096
2097         writer_print_section_footer(wctx);
2098         writer_close(&wctx);
2099     }
2100
2101 end:
2102     av_freep(&print_format);
2103
2104     uninit_opts();
2105     av_dict_free(&fmt_entries_to_show);
2106
2107     avformat_network_deinit();
2108
2109     return ret;
2110 }