git.sesse.net Git - ffmpeg/blob - ffprobe.c

   1 /*
   2  * ffprobe : Simple Media Prober based on the FFmpeg libraries
   3  * Copyright (c) 2007-2010 Stefano Sabatini
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #include "config.h"
  23
  24 #include "libavformat/avformat.h"
  25 #include "libavcodec/avcodec.h"
  26 #include "libavutil/avstring.h"
  27 #include "libavutil/opt.h"
  28 #include "libavutil/pixdesc.h"
  29 #include "libavutil/dict.h"
  30 #include "libavdevice/avdevice.h"
  31 #include "cmdutils.h"
  32
  33 const char program_name[] = "ffprobe";
  34 const int program_birth_year = 2007;
  35
  36 static int do_show_format  = 0;
  37 static int do_show_packets = 0;
  38 static int do_show_streams = 0;
  39
  40 static int show_value_unit              = 0;
  41 static int use_value_prefix             = 0;
  42 static int use_byte_value_binary_prefix = 0;
  43 static int use_value_sexagesimal_format = 0;
  44
  45 static char *print_format;
  46
  47 static const OptionDef options[];
  48
  49 /* FFprobe context */
  50 static const char *input_filename;
  51 static AVInputFormat *iformat = NULL;
  52
  53 static const char *binary_unit_prefixes [] = { "", "Ki", "Mi", "Gi", "Ti", "Pi" };
  54 static const char *decimal_unit_prefixes[] = { "", "K" , "M" , "G" , "T" , "P"  };
  55
  56 static const char *unit_second_str          = "s"    ;
  57 static const char *unit_hertz_str           = "Hz"   ;
  58 static const char *unit_byte_str            = "byte" ;
  59 static const char *unit_bit_per_second_str  = "bit/s";
  60
  61 void av_noreturn exit_program(int ret)
  62 {
  63     exit(ret);
  64 }
  65
  66 struct unit_value {
  67     union { double d; int i; } val;
  68     const char *unit;
  69 };
  70
  71 static char *value_string(char *buf, int buf_size, struct unit_value uv)
  72 {
  73     double vald;
  74     int show_float = 0;
  75
  76     if (uv.unit == unit_second_str) {
  77         vald = uv.val.d;
  78         show_float = 1;
  79     } else {
  80         vald = uv.val.i;
  81     }
  82
  83     if (uv.unit == unit_second_str && use_value_sexagesimal_format) {
  84         double secs;
  85         int hours, mins;
  86         secs  = vald;
  87         mins  = (int)secs / 60;
  88         secs  = secs - mins * 60;
  89         hours = mins / 60;
  90         mins %= 60;
  91         snprintf(buf, buf_size, "%d:%02d:%09.6f", hours, mins, secs);
  92     } else if (use_value_prefix) {
  93         const char *prefix_string;
  94         int index, l;
  95
  96         if (uv.unit == unit_byte_str && use_byte_value_binary_prefix) {
  97             index = (int) (log(vald)/log(2)) / 10;
  98             index = av_clip(index, 0, FF_ARRAY_ELEMS(binary_unit_prefixes) -1);
  99             vald /= pow(2, index*10);
 100             prefix_string = binary_unit_prefixes[index];
 101         } else {
 102             index = (int) (log10(vald)) / 3;
 103             index = av_clip(index, 0, FF_ARRAY_ELEMS(decimal_unit_prefixes) -1);
 104             vald /= pow(10, index*3);
 105             prefix_string = decimal_unit_prefixes[index];
 106         }
 107
 108         if (show_float || vald != (int)vald) l = snprintf(buf, buf_size, "%.3f", vald);
 109         else                                 l = snprintf(buf, buf_size, "%d",   (int)vald);
 110         snprintf(buf+l, buf_size-l, "%s%s%s", prefix_string || show_value_unit ? " " : "",
 111                  prefix_string, show_value_unit ? uv.unit : "");
 112     } else {
 113         int l;
 114
 115         if (show_float) l = snprintf(buf, buf_size, "%.3f", vald);
 116         else            l = snprintf(buf, buf_size, "%d",   (int)vald);
 117         snprintf(buf+l, buf_size-l, "%s%s", show_value_unit ? " " : "",
 118                  show_value_unit ? uv.unit : "");
 119     }
 120
 121     return buf;
 122 }
 123
 124 /* WRITERS API */
 125
 126 typedef struct WriterContext WriterContext;
 127
 128 #define WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS 1
 129
 130 typedef struct Writer {
 131     int priv_size;                  ///< private size for the writer context
 132     const char *name;
 133
 134     int  (*init)  (WriterContext *wctx, const char *args, void *opaque);
 135     void (*uninit)(WriterContext *wctx);
 136
 137     void (*print_header)(WriterContext *ctx);
 138     void (*print_footer)(WriterContext *ctx);
 139
 140     void (*print_chapter_header)(WriterContext *wctx, const char *);
 141     void (*print_chapter_footer)(WriterContext *wctx, const char *);
 142     void (*print_section_header)(WriterContext *wctx, const char *);
 143     void (*print_section_footer)(WriterContext *wctx, const char *);
 144     void (*print_integer)       (WriterContext *wctx, const char *, int);
 145     void (*print_string)        (WriterContext *wctx, const char *, const char *);
 146     void (*show_tags)           (WriterContext *wctx, AVDictionary *dict);
 147     int flags;                  ///< a combination or WRITER_FLAG_*
 148 } Writer;
 149
 150 struct WriterContext {
 151     const AVClass *class;           ///< class of the writer
 152     const Writer *writer;           ///< the Writer of which this is an instance
 153     char *name;                     ///< name of this writer instance
 154     void *priv;                     ///< private data for use by the filter
 155     unsigned int nb_item;           ///< number of the item printed in the given section, starting at 0
 156     unsigned int nb_section;        ///< number of the section printed in the given section sequence, starting at 0
 157     unsigned int nb_chapter;        ///< number of the chapter, starting at 0
 158 };
 159
 160 static const char *writer_get_name(void *p)
 161 {
 162     WriterContext *wctx = p;
 163     return wctx->writer->name;
 164 }
 165
 166 static const AVClass writer_class = {
 167     "Writer",
 168     writer_get_name,
 169     NULL,
 170     LIBAVUTIL_VERSION_INT,
 171 };
 172
 173 static void writer_close(WriterContext **wctx)
 174 {
 175     if (*wctx && (*wctx)->writer->uninit)
 176         (*wctx)->writer->uninit(*wctx);
 177
 178     av_freep(&((*wctx)->priv));
 179     av_freep(wctx);
 180 }
 181
 182 static int writer_open(WriterContext **wctx, const Writer *writer,
 183                        const char *args, void *opaque)
 184 {
 185     int ret = 0;
 186
 187     if (!(*wctx = av_malloc(sizeof(WriterContext)))) {
 188         ret = AVERROR(ENOMEM);
 189         goto fail;
 190     }
 191
 192     if (!((*wctx)->priv = av_mallocz(writer->priv_size))) {
 193         ret = AVERROR(ENOMEM);
 194         goto fail;
 195     }
 196
 197     (*wctx)->class = &writer_class;
 198     (*wctx)->writer = writer;
 199     if ((*wctx)->writer->init)
 200         ret = (*wctx)->writer->init(*wctx, args, opaque);
 201     if (ret < 0)
 202         goto fail;
 203
 204     return 0;
 205
 206 fail:
 207     writer_close(wctx);
 208     return ret;
 209 }
 210
 211 static inline void writer_print_header(WriterContext *wctx)
 212 {
 213     if (wctx->writer->print_header)
 214         wctx->writer->print_header(wctx);
 215     wctx->nb_chapter = 0;
 216 }
 217
 218 static inline void writer_print_footer(WriterContext *wctx)
 219 {
 220     if (wctx->writer->print_footer)
 221         wctx->writer->print_footer(wctx);
 222 }
 223
 224 static inline void writer_print_chapter_header(WriterContext *wctx,
 225                                                const char *header)
 226 {
 227     if (wctx->writer->print_chapter_header)
 228         wctx->writer->print_chapter_header(wctx, header);
 229     wctx->nb_section = 0;
 230 }
 231
 232 static inline void writer_print_chapter_footer(WriterContext *wctx,
 233                                                const char *footer)
 234 {
 235     if (wctx->writer->print_chapter_footer)
 236         wctx->writer->print_chapter_footer(wctx, footer);
 237     wctx->nb_chapter++;
 238 }
 239
 240 static inline void writer_print_section_header(WriterContext *wctx,
 241                                                const char *header)
 242 {
 243     if (wctx->writer->print_section_header)
 244         wctx->writer->print_section_header(wctx, header);
 245     wctx->nb_item = 0;
 246 }
 247
 248 static inline void writer_print_section_footer(WriterContext *wctx,
 249                                                const char *footer)
 250 {
 251     if (wctx->writer->print_section_footer)
 252         wctx->writer->print_section_footer(wctx, footer);
 253     wctx->nb_section++;
 254 }
 255
 256 static inline void writer_print_integer(WriterContext *wctx,
 257                                         const char *key, int val)
 258 {
 259     wctx->writer->print_integer(wctx, key, val);
 260     wctx->nb_item++;
 261 }
 262
 263 static inline void writer_print_string(WriterContext *wctx,
 264                                        const char *key, const char *val, int opt)
 265 {
 266     if (opt && !(wctx->writer->flags & WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS))
 267         return;
 268     wctx->writer->print_string(wctx, key, val);
 269     wctx->nb_item++;
 270 }
 271
 272 static void writer_print_time(WriterContext *wctx, const char *key,
 273                               int64_t ts, const AVRational *time_base)
 274 {
 275     char buf[128];
 276
 277     if (ts == AV_NOPTS_VALUE) {
 278         writer_print_string(wctx, key, "N/A", 1);
 279     } else {
 280         double d = ts * av_q2d(*time_base);
 281         value_string(buf, sizeof(buf), (struct unit_value){.val.d=d, .unit=unit_second_str});
 282         writer_print_string(wctx, key, buf, 0);
 283     }
 284 }
 285
 286 static void writer_print_ts(WriterContext *wctx, const char *key, int64_t ts)
 287 {
 288     char buf[128];
 289
 290     if (ts == AV_NOPTS_VALUE) {
 291         writer_print_string(wctx, key, "N/A", 1);
 292     } else {
 293         snprintf(buf, sizeof(buf), "%"PRId64, ts);
 294         writer_print_string(wctx, key, buf, 0);
 295     }
 296 }
 297
 298 static inline void writer_show_tags(WriterContext *wctx, AVDictionary *dict)
 299 {
 300     wctx->writer->show_tags(wctx, dict);
 301 }
 302
 303 #define MAX_REGISTERED_WRITERS_NB 64
 304
 305 static Writer *registered_writers[MAX_REGISTERED_WRITERS_NB + 1];
 306
 307 static int writer_register(Writer *writer)
 308 {
 309     static int next_registered_writer_idx = 0;
 310
 311     if (next_registered_writer_idx == MAX_REGISTERED_WRITERS_NB)
 312         return AVERROR(ENOMEM);
 313
 314     registered_writers[next_registered_writer_idx++] = writer;
 315     return 0;
 316 }
 317
 318 static Writer *writer_get_by_name(const char *name)
 319 {
 320     int i;
 321
 322     for (i = 0; registered_writers[i]; i++)
 323         if (!strcmp(registered_writers[i]->name, name))
 324             return registered_writers[i];
 325
 326     return NULL;
 327 }
 328
 329 /* Print helpers */
 330
 331 struct print_buf {
 332     char *s;
 333     int len;
 334 };
 335
 336 static char *fast_asprintf(struct print_buf *pbuf, const char *fmt, ...)
 337 {
 338     va_list va;
 339     int len;
 340
 341     va_start(va, fmt);
 342     len = vsnprintf(NULL, 0, fmt, va);
 343     va_end(va);
 344     if (len < 0)
 345         goto fail;
 346
 347     if (pbuf->len < len) {
 348         char *p = av_realloc(pbuf->s, len + 1);
 349         if (!p)
 350             goto fail;
 351         pbuf->s   = p;
 352         pbuf->len = len;
 353     }
 354
 355     va_start(va, fmt);
 356     len = vsnprintf(pbuf->s, len + 1, fmt, va);
 357     va_end(va);
 358     if (len < 0)
 359         goto fail;
 360     return pbuf->s;
 361
 362 fail:
 363     av_freep(&pbuf->s);
 364     pbuf->len = 0;
 365     return NULL;
 366 }
 367
 368 #define ESCAPE_INIT_BUF_SIZE 256
 369
 370 #define ESCAPE_CHECK_SIZE(src, size, max_size)                          \
 371     if (size > max_size) {                                              \
 372         char buf[64];                                                   \
 373         snprintf(buf, sizeof(buf), "%s", src);                          \
 374         av_log(log_ctx, AV_LOG_WARNING,                                 \
 375                "String '%s...' with is too big\n", buf);                \
 376         return "FFPROBE_TOO_BIG_STRING";                                \
 377     }
 378
 379 #define ESCAPE_REALLOC_BUF(dst_size_p, dst_p, src, size)                \
 380     if (*dst_size_p < size) {                                           \
 381         char *q = av_realloc(*dst_p, size);                             \
 382         if (!q) {                                                       \
 383             char buf[64];                                               \
 384             snprintf(buf, sizeof(buf), "%s", src);                      \
 385             av_log(log_ctx, AV_LOG_WARNING,                             \
 386                    "String '%s...' could not be escaped\n", buf);       \
 387             return "FFPROBE_THIS_STRING_COULD_NOT_BE_ESCAPED";          \
 388         }                                                               \
 389         *dst_size_p = size;                                             \
 390         *dst = q;                                                       \
 391     }
 392
 393 /* WRITERS */
 394
 395 /* Default output */
 396
 397 static void default_print_footer(WriterContext *wctx)
 398 {
 399     printf("\n");
 400 }
 401
 402 static void default_print_chapter_header(WriterContext *wctx, const char *chapter)
 403 {
 404     if (wctx->nb_chapter)
 405         printf("\n");
 406 }
 407
 408 /* lame uppercasing routine, assumes the string is lower case ASCII */
 409 static inline char *upcase_string(char *dst, size_t dst_size, const char *src)
 410 {
 411     int i;
 412     for (i = 0; src[i] && i < dst_size-1; i++)
 413         dst[i] = src[i]-32;
 414     dst[i] = 0;
 415     return dst;
 416 }
 417
 418 static void default_print_section_header(WriterContext *wctx, const char *section)
 419 {
 420     char buf[32];
 421
 422     if (wctx->nb_section)
 423         printf("\n");
 424     printf("[%s]\n", upcase_string(buf, sizeof(buf), section));
 425 }
 426
 427 static void default_print_section_footer(WriterContext *wctx, const char *section)
 428 {
 429     char buf[32];
 430
 431     printf("[/%s]", upcase_string(buf, sizeof(buf), section));
 432 }
 433
 434 static void default_print_str(WriterContext *wctx, const char *key, const char *value)
 435 {
 436     printf("%s=%s\n", key, value);
 437 }
 438
 439 static void default_print_int(WriterContext *wctx, const char *key, int value)
 440 {
 441     printf("%s=%d\n", key, value);
 442 }
 443
 444 static void default_show_tags(WriterContext *wctx, AVDictionary *dict)
 445 {
 446     AVDictionaryEntry *tag = NULL;
 447     while ((tag = av_dict_get(dict, "", tag, AV_DICT_IGNORE_SUFFIX))) {
 448         printf("TAG:");
 449         writer_print_string(wctx, tag->key, tag->value, 0);
 450     }
 451 }
 452
 453 static Writer default_writer = {
 454     .name                  = "default",
 455     .print_footer          = default_print_footer,
 456     .print_chapter_header  = default_print_chapter_header,
 457     .print_section_header  = default_print_section_header,
 458     .print_section_footer  = default_print_section_footer,
 459     .print_integer         = default_print_int,
 460     .print_string          = default_print_str,
 461     .show_tags             = default_show_tags,
 462     .flags = WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS,
 463 };
 464
 465 /* Compact output */
 466
 467 /**
 468  * Escape \n, \r, \\ and sep characters contained in s, and print the
 469  * resulting string.
 470  */
 471 static const char *c_escape_str(char **dst, size_t *dst_size,
 472                                 const char *src, const char sep, void *log_ctx)
 473 {
 474     const char *p;
 475     char *q;
 476     size_t size = 1;
 477
 478     /* precompute size */
 479     for (p = src; *p; p++, size++) {
 480         ESCAPE_CHECK_SIZE(src, size, SIZE_MAX-2);
 481         if (*p == '\n' || *p == '\r' || *p == '\\')
 482             size++;
 483     }
 484
 485     ESCAPE_REALLOC_BUF(dst_size, dst, src, size);
 486
 487     q = *dst;
 488     for (p = src; *p; p++) {
 489         switch (*src) {
 490         case '\n': *q++ = '\\'; *q++ = 'n';  break;
 491         case '\r': *q++ = '\\'; *q++ = 'r';  break;
 492         case '\\': *q++ = '\\'; *q++ = '\\'; break;
 493         default:
 494             if (*p == sep)
 495                 *q++ = '\\';
 496             *q++ = *p;
 497         }
 498     }
 499     *q = 0;
 500     return *dst;
 501 }
 502
 503 /**
 504  * Quote fields containing special characters, check RFC4180.
 505  */
 506 static const char *csv_escape_str(char **dst, size_t *dst_size,
 507                                   const char *src, const char sep, void *log_ctx)
 508 {
 509     const char *p;
 510     char *q;
 511     size_t size = 1;
 512     int quote = 0;
 513
 514     /* precompute size */
 515     for (p = src; *p; p++, size++) {
 516         ESCAPE_CHECK_SIZE(src, size, SIZE_MAX-4);
 517         if (*p == '"' || *p == sep || *p == '\n' || *p == '\r')
 518             if (!quote) {
 519                 quote = 1;
 520                 size += 2;
 521             }
 522         if (*p == '"')
 523             size++;
 524     }
 525
 526     ESCAPE_REALLOC_BUF(dst_size, dst, src, size);
 527
 528     q = *dst;
 529     p = src;
 530     if (quote)
 531         *q++ = '\"';
 532     while (*p) {
 533         if (*p == '"')
 534             *q++ = '\"';
 535         *q++ = *p++;
 536     }
 537     if (quote)
 538         *q++ = '\"';
 539     *q = 0;
 540
 541     return *dst;
 542 }
 543
 544 static const char *none_escape_str(char **dst, size_t *dst_size,
 545                                    const char *src, const char sep, void *log_ctx)
 546 {
 547     return src;
 548 }
 549
 550 typedef struct CompactContext {
 551     const AVClass *class;
 552     char *item_sep_str;
 553     char item_sep;
 554     int nokey;
 555     char  *buf;
 556     size_t buf_size;
 557     char *escape_mode_str;
 558     const char * (*escape_str)(char **dst, size_t *dst_size,
 559                                const char *src, const char sep, void *log_ctx);
 560 } CompactContext;
 561
 562 #define OFFSET(x) offsetof(CompactContext, x)
 563
 564 static const AVOption compact_options[]= {
 565     {"item_sep", "set item separator",    OFFSET(item_sep_str),    AV_OPT_TYPE_STRING, {.str="|"},  CHAR_MIN, CHAR_MAX },
 566     {"s",        "set item separator",    OFFSET(item_sep_str),    AV_OPT_TYPE_STRING, {.str="|"},  CHAR_MIN, CHAR_MAX },
 567     {"nokey",    "force no key printing", OFFSET(nokey),           AV_OPT_TYPE_INT,    {.dbl=0},    0,        1        },
 568     {"nk",       "force no key printing", OFFSET(nokey),           AV_OPT_TYPE_INT,    {.dbl=0},    0,        1        },
 569     {"escape",   "set escape mode",       OFFSET(escape_mode_str), AV_OPT_TYPE_STRING, {.str="c"},  CHAR_MIN, CHAR_MAX },
 570     {"e",        "set escape mode",       OFFSET(escape_mode_str), AV_OPT_TYPE_STRING, {.str="c"},  CHAR_MIN, CHAR_MAX },
 571     {NULL},
 572 };
 573
 574 static const char *compact_get_name(void *ctx)
 575 {
 576     return "compact";
 577 }
 578
 579 static const AVClass compact_class = {
 580     "CompactContext",
 581     compact_get_name,
 582     compact_options
 583 };
 584
 585 static av_cold int compact_init(WriterContext *wctx, const char *args, void *opaque)
 586 {
 587     CompactContext *compact = wctx->priv;
 588     int err;
 589
 590     compact->class = &compact_class;
 591     av_opt_set_defaults(compact);
 592
 593     if (args &&
 594         (err = (av_set_options_string(compact, args, "=", ":"))) < 0) {
 595         av_log(wctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
 596         return err;
 597     }
 598     if (strlen(compact->item_sep_str) != 1) {
 599         av_log(wctx, AV_LOG_ERROR, "Item separator '%s' specified, but must contain a single character\n",
 600                compact->item_sep_str);
 601         return AVERROR(EINVAL);
 602     }
 603     compact->item_sep = compact->item_sep_str[0];
 604
 605     compact->buf_size = ESCAPE_INIT_BUF_SIZE;
 606     if (!(compact->buf = av_malloc(compact->buf_size)))
 607         return AVERROR(ENOMEM);
 608
 609     if      (!strcmp(compact->escape_mode_str, "none")) compact->escape_str = none_escape_str;
 610     else if (!strcmp(compact->escape_mode_str, "c"   )) compact->escape_str = c_escape_str;
 611     else if (!strcmp(compact->escape_mode_str, "csv" )) compact->escape_str = csv_escape_str;
 612     else {
 613         av_log(wctx, AV_LOG_ERROR, "Unknown escape mode '%s'\n", compact->escape_mode_str);
 614         return AVERROR(EINVAL);
 615     }
 616
 617     return 0;
 618 }
 619
 620 static av_cold void compact_uninit(WriterContext *wctx)
 621 {
 622     CompactContext *compact = wctx->priv;
 623
 624     av_freep(&compact->item_sep_str);
 625     av_freep(&compact->buf);
 626     av_freep(&compact->escape_mode_str);
 627 }
 628
 629 static void compact_print_section_header(WriterContext *wctx, const char *section)
 630 {
 631     CompactContext *compact = wctx->priv;
 632
 633     printf("%s%c", section, compact->item_sep);
 634 }
 635
 636 static void compact_print_section_footer(WriterContext *wctx, const char *section)
 637 {
 638     printf("\n");
 639 }
 640
 641 static void compact_print_str(WriterContext *wctx, const char *key, const char *value)
 642 {
 643     CompactContext *compact = wctx->priv;
 644
 645     if (wctx->nb_item) printf("%c", compact->item_sep);
 646     if (!compact->nokey)
 647         printf("%s=", key);
 648     printf("%s", compact->escape_str(&compact->buf, &compact->buf_size,
 649                                      value, compact->item_sep, wctx));
 650 }
 651
 652 static void compact_print_int(WriterContext *wctx, const char *key, int value)
 653 {
 654     CompactContext *compact = wctx->priv;
 655
 656     if (wctx->nb_item) printf("%c", compact->item_sep);
 657     if (!compact->nokey)
 658         printf("%s=", key);
 659     printf("%d", value);
 660 }
 661
 662 static void compact_show_tags(WriterContext *wctx, AVDictionary *dict)
 663 {
 664     CompactContext *compact = wctx->priv;
 665     AVDictionaryEntry *tag = NULL;
 666
 667     while ((tag = av_dict_get(dict, "", tag, AV_DICT_IGNORE_SUFFIX))) {
 668         if (wctx->nb_item) printf("%c", compact->item_sep);
 669         if (!compact->nokey)
 670             printf("tag:%s=", compact->escape_str(&compact->buf, &compact->buf_size,
 671                                                   tag->key, compact->item_sep, wctx));
 672         printf("%s", compact->escape_str(&compact->buf, &compact->buf_size,
 673                                          tag->value, compact->item_sep, wctx));
 674     }
 675 }
 676
 677 static Writer compact_writer = {
 678     .name                 = "compact",
 679     .priv_size            = sizeof(CompactContext),
 680     .init                 = compact_init,
 681     .uninit               = compact_uninit,
 682     .print_section_header = compact_print_section_header,
 683     .print_section_footer = compact_print_section_footer,
 684     .print_integer        = compact_print_int,
 685     .print_string         = compact_print_str,
 686     .show_tags            = compact_show_tags,
 687     .flags = WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS,
 688 };
 689
 690 /* CSV output */
 691
 692 static av_cold int csv_init(WriterContext *wctx, const char *args, void *opaque)
 693 {
 694     return compact_init(wctx, "item_sep=,:nokey=1:escape=csv", opaque);
 695 }
 696
 697 static Writer csv_writer = {
 698     .name                 = "csv",
 699     .priv_size            = sizeof(CompactContext),
 700     .init                 = csv_init,
 701     .uninit               = compact_uninit,
 702     .print_section_header = compact_print_section_header,
 703     .print_section_footer = compact_print_section_footer,
 704     .print_integer        = compact_print_int,
 705     .print_string         = compact_print_str,
 706     .show_tags            = compact_show_tags,
 707     .flags = WRITER_FLAG_DISPLAY_OPTIONAL_FIELDS,
 708 };
 709
 710 /* JSON output */
 711
 712 typedef struct {
 713     int multiple_entries; ///< tells if the given chapter requires multiple entries
 714     char *buf;
 715     size_t buf_size;
 716 } JSONContext;
 717
 718 static av_cold int json_init(WriterContext *wctx, const char *args, void *opaque)
 719 {
 720     JSONContext *json = wctx->priv;
 721
 722     json->buf_size = ESCAPE_INIT_BUF_SIZE;
 723     if (!(json->buf = av_malloc(json->buf_size)))
 724         return AVERROR(ENOMEM);
 725
 726     return 0;
 727 }
 728
 729 static av_cold void json_uninit(WriterContext *wctx)
 730 {
 731     JSONContext *json = wctx->priv;
 732     av_freep(&json->buf);
 733 }
 734
 735 static const char *json_escape_str(char **dst, size_t *dst_size, const char *src,
 736                                    void *log_ctx)
 737 {
 738     static const char json_escape[] = {'"', '\\', '\b', '\f', '\n', '\r', '\t', 0};
 739     static const char json_subst[]  = {'"', '\\',  'b',  'f',  'n',  'r',  't', 0};
 740     const char *p;
 741     char *q;
 742     size_t size = 1;
 743
 744     // compute the length of the escaped string
 745     for (p = src; *p; p++) {
 746         ESCAPE_CHECK_SIZE(src, size, SIZE_MAX-6);
 747         if (strchr(json_escape, *p))     size += 2; // simple escape
 748         else if ((unsigned char)*p < 32) size += 6; // handle non-printable chars
 749         else                             size += 1; // char copy
 750     }
 751     ESCAPE_REALLOC_BUF(dst_size, dst, src, size);
 752
 753     q = *dst;
 754     for (p = src; *p; p++) {
 755         char *s = strchr(json_escape, *p);
 756         if (s) {
 757             *q++ = '\\';
 758             *q++ = json_subst[s - json_escape];
 759         } else if ((unsigned char)*p < 32) {
 760             snprintf(q, 7, "\\u00%02x", *p & 0xff);
 761             q += 6;
 762         } else {
 763             *q++ = *p;
 764         }
 765     }
 766     *q = 0;
 767     return *dst;
 768 }
 769
 770 static void json_print_header(WriterContext *wctx)
 771 {
 772     printf("{");
 773 }
 774
 775 static void json_print_footer(WriterContext *wctx)
 776 {
 777     printf("\n}\n");
 778 }
 779
 780 static void json_print_chapter_header(WriterContext *wctx, const char *chapter)
 781 {
 782     JSONContext *json = wctx->priv;
 783
 784     if (wctx->nb_chapter)
 785         printf(",");
 786     json->multiple_entries = !strcmp(chapter, "packets") || !strcmp(chapter, "streams");
 787     printf("\n  \"%s\":%s", json_escape_str(&json->buf, &json->buf_size, chapter, wctx),
 788            json->multiple_entries ? " [" : " ");
 789 }
 790
 791 static void json_print_chapter_footer(WriterContext *wctx, const char *chapter)
 792 {
 793     JSONContext *json = wctx->priv;
 794
 795     if (json->multiple_entries)
 796         printf("]");
 797 }
 798
 799 static void json_print_section_header(WriterContext *wctx, const char *section)
 800 {
 801     if (wctx->nb_section) printf(",");
 802     printf("{\n");
 803 }
 804
 805 static void json_print_section_footer(WriterContext *wctx, const char *section)
 806 {
 807     printf("\n  }");
 808 }
 809
 810 static inline void json_print_item_str(WriterContext *wctx,
 811                                        const char *key, const char *value,
 812                                        const char *indent)
 813 {
 814     JSONContext *json = wctx->priv;
 815
 816     printf("%s\"%s\":", indent, json_escape_str(&json->buf, &json->buf_size, key,   wctx));
 817     printf(" \"%s\"",           json_escape_str(&json->buf, &json->buf_size, value, wctx));
 818 }
 819
 820 #define INDENT "    "
 821
 822 static void json_print_str(WriterContext *wctx, const char *key, const char *value)
 823 {
 824     if (wctx->nb_item) printf(",\n");
 825     json_print_item_str(wctx, key, value, INDENT);
 826 }
 827
 828 static void json_print_int(WriterContext *wctx, const char *key, int value)
 829 {
 830     JSONContext *json = wctx->priv;
 831
 832     if (wctx->nb_item) printf(",\n");
 833     printf(INDENT "\"%s\": %d",
 834            json_escape_str(&json->buf, &json->buf_size, key, wctx), value);
 835 }
 836
 837 static void json_show_tags(WriterContext *wctx, AVDictionary *dict)
 838 {
 839     AVDictionaryEntry *tag = NULL;
 840     int is_first = 1;
 841     if (!dict)
 842         return;
 843     printf(",\n" INDENT "\"tags\": {\n");
 844     while ((tag = av_dict_get(dict, "", tag, AV_DICT_IGNORE_SUFFIX))) {
 845         if (is_first) is_first = 0;
 846         else          printf(",\n");
 847         json_print_item_str(wctx, tag->key, tag->value, INDENT INDENT);
 848     }
 849     printf("\n    }");
 850 }
 851
 852 static Writer json_writer = {
 853     .name         = "json",
 854     .priv_size    = sizeof(JSONContext),
 855
 856     .init                 = json_init,
 857     .uninit               = json_uninit,
 858     .print_header         = json_print_header,
 859     .print_footer         = json_print_footer,
 860     .print_chapter_header = json_print_chapter_header,
 861     .print_chapter_footer = json_print_chapter_footer,
 862     .print_section_header = json_print_section_header,
 863     .print_section_footer = json_print_section_footer,
 864     .print_integer        = json_print_int,
 865     .print_string         = json_print_str,
 866     .show_tags            = json_show_tags,
 867 };
 868
 869 static void writer_register_all(void)
 870 {
 871     static int initialized;
 872
 873     if (initialized)
 874         return;
 875     initialized = 1;
 876
 877     writer_register(&default_writer);
 878     writer_register(&compact_writer);
 879     writer_register(&csv_writer);
 880     writer_register(&json_writer);
 881 }
 882
 883 #define print_fmt(k, f, ...) do {              \
 884     if (fast_asprintf(&pbuf, f, __VA_ARGS__))  \
 885         writer_print_string(w, k, pbuf.s, 0);  \
 886 } while (0)
 887
 888 #define print_fmt_opt(k, f, ...) do {          \
 889     if (fast_asprintf(&pbuf, f, __VA_ARGS__))  \
 890         writer_print_string(w, k, pbuf.s, 1);  \
 891 } while (0)
 892
 893 #define print_int(k, v)         writer_print_integer(w, k, v)
 894 #define print_str(k, v)         writer_print_string(w, k, v, 0)
 895 #define print_str_opt(k, v)     writer_print_string(w, k, v, 1)
 896 #define print_time(k, v, tb)    writer_print_time(w, k, v, tb)
 897 #define print_ts(k, v)          writer_print_ts(w, k, v)
 898 #define print_val(k, v, u)      writer_print_string(w, k, \
 899     value_string(val_str, sizeof(val_str), (struct unit_value){.val.i = v, .unit=u}), 1)
 900 #define print_section_header(s) writer_print_section_header(w, s)
 901 #define print_section_footer(s) writer_print_section_footer(w, s)
 902 #define show_tags(metadata)     writer_show_tags(w, metadata)
 903
 904 static void show_packet(WriterContext *w, AVFormatContext *fmt_ctx, AVPacket *pkt, int packet_idx)
 905 {
 906     char val_str[128];
 907     AVStream *st = fmt_ctx->streams[pkt->stream_index];
 908     struct print_buf pbuf = {.s = NULL};
 909     const char *s;
 910
 911     print_section_header("packet");
 912     s = av_get_media_type_string(st->codec->codec_type);
 913     if (s) print_str    ("codec_type", s);
 914     else   print_str_opt("codec_type", "unknown");
 915     print_int("stream_index",     pkt->stream_index);
 916     print_ts  ("pts",             pkt->pts);
 917     print_time("pts_time",        pkt->pts, &st->time_base);
 918     print_ts  ("dts",             pkt->dts);
 919     print_time("dts_time",        pkt->dts, &st->time_base);
 920     print_ts  ("duration",        pkt->duration);
 921     print_time("duration_time",   pkt->duration, &st->time_base);
 922     print_val("size",             pkt->size, unit_byte_str);
 923     if (pkt->pos != -1) print_fmt    ("pos", "%"PRId64, pkt->pos);
 924     else                print_str_opt("pos", "N/A");
 925     print_fmt("flags", "%c",      pkt->flags & AV_PKT_FLAG_KEY ? 'K' : '_');
 926     print_section_footer("packet");
 927
 928     av_free(pbuf.s);
 929     fflush(stdout);
 930 }
 931
 932 static void show_packets(WriterContext *w, AVFormatContext *fmt_ctx)
 933 {
 934     AVPacket pkt;
 935     int i = 0;
 936
 937     av_init_packet(&pkt);
 938
 939     while (!av_read_frame(fmt_ctx, &pkt))
 940         show_packet(w, fmt_ctx, &pkt, i++);
 941 }
 942
 943 static void show_stream(WriterContext *w, AVFormatContext *fmt_ctx, int stream_idx)
 944 {
 945     AVStream *stream = fmt_ctx->streams[stream_idx];
 946     AVCodecContext *dec_ctx;
 947     AVCodec *dec;
 948     char val_str[128];
 949     const char *s;
 950     AVRational display_aspect_ratio;
 951     struct print_buf pbuf = {.s = NULL};
 952
 953     print_section_header("stream");
 954
 955     print_int("index", stream->index);
 956
 957     if ((dec_ctx = stream->codec)) {
 958         if ((dec = dec_ctx->codec)) {
 959             print_str("codec_name",      dec->name);
 960             print_str("codec_long_name", dec->long_name);
 961         } else {
 962             print_str_opt("codec_name",      "unknown");
 963             print_str_opt("codec_long_name", "unknown");
 964         }
 965
 966         s = av_get_media_type_string(dec_ctx->codec_type);
 967         if (s) print_str    ("codec_type", s);
 968         else   print_str_opt("codec_type", "unknown");
 969         print_fmt("codec_time_base", "%d/%d", dec_ctx->time_base.num, dec_ctx->time_base.den);
 970
 971         /* print AVI/FourCC tag */
 972         av_get_codec_tag_string(val_str, sizeof(val_str), dec_ctx->codec_tag);
 973         print_str("codec_tag_string",    val_str);
 974         print_fmt("codec_tag", "0x%04x", dec_ctx->codec_tag);
 975
 976         switch (dec_ctx->codec_type) {
 977         case AVMEDIA_TYPE_VIDEO:
 978             print_int("width",        dec_ctx->width);
 979             print_int("height",       dec_ctx->height);
 980             print_int("has_b_frames", dec_ctx->has_b_frames);
 981             if (dec_ctx->sample_aspect_ratio.num) {
 982                 print_fmt("sample_aspect_ratio", "%d:%d",
 983                           dec_ctx->sample_aspect_ratio.num,
 984                           dec_ctx->sample_aspect_ratio.den);
 985                 av_reduce(&display_aspect_ratio.num, &display_aspect_ratio.den,
 986                           dec_ctx->width  * dec_ctx->sample_aspect_ratio.num,
 987                           dec_ctx->height * dec_ctx->sample_aspect_ratio.den,
 988                           1024*1024);
 989                 print_fmt("display_aspect_ratio", "%d:%d",
 990                           display_aspect_ratio.num,
 991                           display_aspect_ratio.den);
 992             } else {
 993                 print_str_opt("sample_aspect_ratio", "N/A");
 994                 print_str_opt("display_aspect_ratio", "N/A");
 995             }
 996             s = av_get_pix_fmt_name(dec_ctx->pix_fmt);
 997             if (s) print_str    ("pix_fmt", s);
 998             else   print_str_opt("pix_fmt", "unknown");
 999             print_int("level",   dec_ctx->level);
1000             break;
1001
1002         case AVMEDIA_TYPE_AUDIO:
1003             s = av_get_sample_fmt_name(dec_ctx->sample_fmt);
1004             if (s) print_str    ("sample_fmt", s);
1005             else   print_str_opt("sample_fmt", "unknown");
1006             print_val("sample_rate",     dec_ctx->sample_rate, unit_hertz_str);
1007             print_int("channels",        dec_ctx->channels);
1008             print_int("bits_per_sample", av_get_bits_per_sample(dec_ctx->codec_id));
1009             break;
1010         }
1011     } else {
1012         print_str_opt("codec_type", "unknown");
1013     }
1014     if (dec_ctx->codec && dec_ctx->codec->priv_class) {
1015         const AVOption *opt = NULL;
1016         while (opt = av_opt_next(dec_ctx->priv_data,opt)) {
1017             uint8_t *str;
1018             if (opt->flags) continue;
1019             if (av_opt_get(dec_ctx->priv_data, opt->name, 0, &str) >= 0) {
1020                 print_str(opt->name, str);
1021                 av_free(str);
1022             }
1023         }
1024     }
1025
1026     if (fmt_ctx->iformat->flags & AVFMT_SHOW_IDS) print_fmt    ("id", "0x%x", stream->id);
1027     else                                          print_str_opt("id", "N/A");
1028     print_fmt("r_frame_rate",   "%d/%d", stream->r_frame_rate.num,   stream->r_frame_rate.den);
1029     print_fmt("avg_frame_rate", "%d/%d", stream->avg_frame_rate.num, stream->avg_frame_rate.den);
1030     print_fmt("time_base",      "%d/%d", stream->time_base.num,      stream->time_base.den);
1031     print_time("start_time",    stream->start_time, &stream->time_base);
1032     print_time("duration",      stream->duration,   &stream->time_base);
1033     if (stream->nb_frames) print_fmt    ("nb_frames", "%"PRId64, stream->nb_frames);
1034     else                   print_str_opt("nb_frames", "N/A");
1035     show_tags(stream->metadata);
1036
1037     print_section_footer("stream");
1038     av_free(pbuf.s);
1039     fflush(stdout);
1040 }
1041
1042 static void show_streams(WriterContext *w, AVFormatContext *fmt_ctx)
1043 {
1044     int i;
1045     for (i = 0; i < fmt_ctx->nb_streams; i++)
1046         show_stream(w, fmt_ctx, i);
1047 }
1048
1049 static void show_format(WriterContext *w, AVFormatContext *fmt_ctx)
1050 {
1051     char val_str[128];
1052     int64_t size = avio_size(fmt_ctx->pb);
1053     struct print_buf pbuf = {.s = NULL};
1054
1055     print_section_header("format");
1056     print_str("filename",         fmt_ctx->filename);
1057     print_int("nb_streams",       fmt_ctx->nb_streams);
1058     print_str("format_name",      fmt_ctx->iformat->name);
1059     print_str("format_long_name", fmt_ctx->iformat->long_name);
1060     print_time("start_time",      fmt_ctx->start_time, &AV_TIME_BASE_Q);
1061     print_time("duration",        fmt_ctx->duration,   &AV_TIME_BASE_Q);
1062     if (size >= 0) print_val    ("size", size, unit_byte_str);
1063     else           print_str_opt("size", "N/A");
1064     if (fmt_ctx->bit_rate > 0) print_val    ("bit_rate", fmt_ctx->bit_rate, unit_bit_per_second_str);
1065     else                       print_str_opt("bit_rate", "N/A");
1066     show_tags(fmt_ctx->metadata);
1067     print_section_footer("format");
1068     av_free(pbuf.s);
1069     fflush(stdout);
1070 }
1071
1072 static int open_input_file(AVFormatContext **fmt_ctx_ptr, const char *filename)
1073 {
1074     int err, i;
1075     AVFormatContext *fmt_ctx = NULL;
1076     AVDictionaryEntry *t;
1077
1078     if ((err = avformat_open_input(&fmt_ctx, filename, iformat, &format_opts)) < 0) {
1079         print_error(filename, err);
1080         return err;
1081     }
1082     if ((t = av_dict_get(format_opts, "", NULL, AV_DICT_IGNORE_SUFFIX))) {
1083         av_log(NULL, AV_LOG_ERROR, "Option %s not found.\n", t->key);
1084         return AVERROR_OPTION_NOT_FOUND;
1085     }
1086
1087
1088     /* fill the streams in the format context */
1089     if ((err = avformat_find_stream_info(fmt_ctx, NULL)) < 0) {
1090         print_error(filename, err);
1091         return err;
1092     }
1093
1094     av_dump_format(fmt_ctx, 0, filename, 0);
1095
1096     /* bind a decoder to each input stream */
1097     for (i = 0; i < fmt_ctx->nb_streams; i++) {
1098         AVStream *stream = fmt_ctx->streams[i];
1099         AVCodec *codec;
1100
1101         if (!(codec = avcodec_find_decoder(stream->codec->codec_id))) {
1102             fprintf(stderr, "Unsupported codec with id %d for input stream %d\n",
1103                     stream->codec->codec_id, stream->index);
1104         } else if (avcodec_open2(stream->codec, codec, NULL) < 0) {
1105             fprintf(stderr, "Error while opening codec for input stream %d\n",
1106                     stream->index);
1107         }
1108     }
1109
1110     *fmt_ctx_ptr = fmt_ctx;
1111     return 0;
1112 }
1113
1114 #define PRINT_CHAPTER(name) do {                                        \
1115     if (do_show_ ## name) {                                             \
1116         writer_print_chapter_header(wctx, #name);                       \
1117         show_ ## name (wctx, fmt_ctx);                                  \
1118         writer_print_chapter_footer(wctx, #name);                       \
1119     }                                                                   \
1120 } while (0)
1121
1122 static int probe_file(const char *filename)
1123 {
1124     AVFormatContext *fmt_ctx;
1125     int ret;
1126     Writer *w;
1127     char *buf;
1128     char *w_name = NULL, *w_args = NULL;
1129     WriterContext *wctx;
1130
1131     writer_register_all();
1132
1133     if (!print_format)
1134         print_format = av_strdup("default");
1135     w_name = av_strtok(print_format, "=", &buf);
1136     w_args = buf;
1137
1138     w = writer_get_by_name(w_name);
1139     if (!w) {
1140         av_log(NULL, AV_LOG_ERROR, "Unknown output format with name '%s'\n", w_name);
1141         ret = AVERROR(EINVAL);
1142         goto end;
1143     }
1144
1145     if ((ret = writer_open(&wctx, w, w_args, NULL)) < 0)
1146         goto end;
1147     if ((ret = open_input_file(&fmt_ctx, filename)))
1148         goto end;
1149
1150     writer_print_header(wctx);
1151     PRINT_CHAPTER(packets);
1152     PRINT_CHAPTER(streams);
1153     PRINT_CHAPTER(format);
1154     writer_print_footer(wctx);
1155
1156     av_close_input_file(fmt_ctx);
1157     writer_close(&wctx);
1158
1159 end:
1160     av_freep(&print_format);
1161
1162     return ret;
1163 }
1164
1165 static void show_usage(void)
1166 {
1167     printf("Simple multimedia streams analyzer\n");
1168     printf("usage: %s [OPTIONS] [INPUT_FILE]\n", program_name);
1169     printf("\n");
1170 }
1171
1172 static int opt_format(const char *opt, const char *arg)
1173 {
1174     iformat = av_find_input_format(arg);
1175     if (!iformat) {
1176         fprintf(stderr, "Unknown input format: %s\n", arg);
1177         return AVERROR(EINVAL);
1178     }
1179     return 0;
1180 }
1181
1182 static void opt_input_file(void *optctx, const char *arg)
1183 {
1184     if (input_filename) {
1185         fprintf(stderr, "Argument '%s' provided as input filename, but '%s' was already specified.\n",
1186                 arg, input_filename);
1187         exit(1);
1188     }
1189     if (!strcmp(arg, "-"))
1190         arg = "pipe:";
1191     input_filename = arg;
1192 }
1193
1194 static int opt_help(const char *opt, const char *arg)
1195 {
1196     av_log_set_callback(log_callback_help);
1197     show_usage();
1198     show_help_options(options, "Main options:\n", 0, 0);
1199     printf("\n");
1200
1201     show_help_children(avformat_get_class(), AV_OPT_FLAG_DECODING_PARAM);
1202
1203     return 0;
1204 }
1205
1206 static int opt_pretty(const char *opt, const char *arg)
1207 {
1208     show_value_unit              = 1;
1209     use_value_prefix             = 1;
1210     use_byte_value_binary_prefix = 1;
1211     use_value_sexagesimal_format = 1;
1212     return 0;
1213 }
1214
1215 static const OptionDef options[] = {
1216 #include "cmdutils_common_opts.h"
1217     { "f", HAS_ARG, {(void*)opt_format}, "force format", "format" },
1218     { "unit", OPT_BOOL, {(void*)&show_value_unit}, "show unit of the displayed values" },
1219     { "prefix", OPT_BOOL, {(void*)&use_value_prefix}, "use SI prefixes for the displayed values" },
1220     { "byte_binary_prefix", OPT_BOOL, {(void*)&use_byte_value_binary_prefix},
1221       "use binary prefixes for byte units" },
1222     { "sexagesimal", OPT_BOOL,  {(void*)&use_value_sexagesimal_format},
1223       "use sexagesimal format HOURS:MM:SS.MICROSECONDS for time units" },
1224     { "pretty", 0, {(void*)&opt_pretty},
1225       "prettify the format of displayed values, make it more human readable" },
1226     { "print_format", OPT_STRING | HAS_ARG, {(void*)&print_format},
1227       "set the output printing format (available formats are: default, compact, csv, json)", "format" },
1228     { "show_format",  OPT_BOOL, {(void*)&do_show_format} , "show format/container info" },
1229     { "show_packets", OPT_BOOL, {(void*)&do_show_packets}, "show packets info" },
1230     { "show_streams", OPT_BOOL, {(void*)&do_show_streams}, "show streams info" },
1231     { "default", HAS_ARG | OPT_AUDIO | OPT_VIDEO | OPT_EXPERT, {(void*)opt_default}, "generic catch all option", "" },
1232     { "i", HAS_ARG, {(void *)opt_input_file}, "read specified file", "input_file"},
1233     { NULL, },
1234 };
1235
1236 int main(int argc, char **argv)
1237 {
1238     int ret;
1239
1240     parse_loglevel(argc, argv, options);
1241     av_register_all();
1242     avformat_network_init();
1243     init_opts();
1244 #if CONFIG_AVDEVICE
1245     avdevice_register_all();
1246 #endif
1247
1248     show_banner();
1249     parse_options(NULL, argc, argv, options, opt_input_file);
1250
1251     if (!input_filename) {
1252         show_usage();
1253         fprintf(stderr, "You have to specify one input file.\n");
1254         fprintf(stderr, "Use -h to get full help or, even better, run 'man %s'.\n", program_name);
1255         exit(1);
1256     }
1257
1258     ret = probe_file(input_filename);
1259
1260     avformat_network_deinit();
1261
1262     return ret;
1263 }