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 "libavcodec/opt.h"
27#include "libavutil/pixdesc.h"
28#include "libavdevice/avdevice.h"
29#include "cmdutils.h"
30
31const char program_name[] = "FFprobe";
32const int program_birth_year = 2007;
33
34static int do_show_format  = 0;
35static int do_show_streams = 0;
36
37static int convert_tags                 = 0;
38static int show_value_unit              = 0;
39static int use_value_prefix             = 0;
40static int use_byte_value_binary_prefix = 0;
41static int use_value_sexagesimal_format = 0;
42
43/* globals */
44static const OptionDef options[];
45
46/* FFprobe context */
47static const char *input_filename;
48static AVInputFormat *iformat = NULL;
49
50static const char *binary_unit_prefixes [] = { "", "Ki", "Mi", "Gi", "Ti", "Pi" };
51static const char *decimal_unit_prefixes[] = { "", "K" , "M" , "G" , "T" , "P"  };
52
53static const char *unit_second_str          = "s"    ;
54static const char *unit_hertz_str           = "Hz"   ;
55static const char *unit_byte_str            = "byte" ;
56static const char *unit_bit_per_second_str  = "bit/s";
57
58static char *value_string(char *buf, int buf_size, double val, const char *unit)
59{
60    if (unit == unit_second_str && use_value_sexagesimal_format) {
61        double secs;
62        int hours, mins;
63        secs  = val;
64        mins  = (int)secs / 60;
65        secs  = secs - mins * 60;
66        hours = mins / 60;
67        mins %= 60;
68        snprintf(buf, buf_size, "%d:%02d:%09.6f", hours, mins, secs);
69    } else if (use_value_prefix) {
70        const char *prefix_string;
71        int index;
72
73        if (unit == unit_byte_str && use_byte_value_binary_prefix) {
74            index = (int) (log(val)/log(2)) / 10;
75            index = av_clip(index, 0, FF_ARRAY_ELEMS(binary_unit_prefixes) -1);
76            val /= pow(2, index*10);
77            prefix_string = binary_unit_prefixes[index];
78        } else {
79            index = (int) (log10(val)) / 3;
80            index = av_clip(index, 0, FF_ARRAY_ELEMS(decimal_unit_prefixes) -1);
81            val /= pow(10, index*3);
82            prefix_string = decimal_unit_prefixes[index];
83        }
84
85        snprintf(buf, buf_size, "%.3f %s%s", val, prefix_string, show_value_unit ? unit : "");
86    } else {
87        snprintf(buf, buf_size, "%f %s", val, show_value_unit ? unit : "");
88    }
89
90    return buf;
91}
92
93static char *time_value_string(char *buf, int buf_size, int64_t val, const AVRational *time_base)
94{
95    if (val == AV_NOPTS_VALUE) {
96        snprintf(buf, buf_size, "N/A");
97    } else {
98        value_string(buf, buf_size, val * av_q2d(*time_base), unit_second_str);
99    }
100
101    return buf;
102}
103
104static const char *media_type_string(enum AVMediaType media_type)
105{
106    switch (media_type) {
107    case AVMEDIA_TYPE_VIDEO:      return "video";
108    case AVMEDIA_TYPE_AUDIO:      return "audio";
109    case AVMEDIA_TYPE_DATA:       return "data";
110    case AVMEDIA_TYPE_SUBTITLE:   return "subtitle";
111    case AVMEDIA_TYPE_ATTACHMENT: return "attachment";
112    default:                      return "unknown";
113    }
114}
115
116static void show_stream(AVFormatContext *fmt_ctx, int stream_idx)
117{
118    AVStream *stream = fmt_ctx->streams[stream_idx];
119    AVCodecContext *dec_ctx;
120    AVCodec *dec;
121    char val_str[128];
122    AVMetadataTag *tag = NULL;
123    char a, b, c, d;
124    AVRational display_aspect_ratio;
125
126    printf("[STREAM]\n");
127
128    printf("index=%d\n",        stream->index);
129
130    if ((dec_ctx = stream->codec)) {
131        if ((dec = dec_ctx->codec)) {
132            printf("codec_name=%s\n",         dec->name);
133            printf("codec_long_name=%s\n",    dec->long_name);
134        } else {
135            printf("codec_name=unknown\n");
136        }
137
138        printf("codec_type=%s\n",         media_type_string(dec_ctx->codec_type));
139        printf("codec_time_base=%d/%d\n", dec_ctx->time_base.num, dec_ctx->time_base.den);
140
141        /* print AVI/FourCC tag */
142        a = dec_ctx->codec_tag     & 0xff;
143        b = dec_ctx->codec_tag>>8  & 0xff;
144        c = dec_ctx->codec_tag>>16 & 0xff;
145        d = dec_ctx->codec_tag>>24 & 0xff;
146        printf("codec_tag_string=");
147        if (isprint(a)) printf("%c", a); else printf("[%d]", a);
148        if (isprint(b)) printf("%c", b); else printf("[%d]", b);
149        if (isprint(c)) printf("%c", c); else printf("[%d]", c);
150        if (isprint(d)) printf("%c", d); else printf("[%d]", d);
151        printf("\ncodec_tag=0x%04x\n", dec_ctx->codec_tag);
152
153        switch (dec_ctx->codec_type) {
154        case AVMEDIA_TYPE_VIDEO:
155            printf("width=%d\n",                   dec_ctx->width);
156            printf("height=%d\n",                  dec_ctx->height);
157            printf("has_b_frames=%d\n",            dec_ctx->has_b_frames);
158            if (dec_ctx->sample_aspect_ratio.num) {
159                printf("sample_aspect_ratio=%d:%d\n", dec_ctx->sample_aspect_ratio.num,
160                                                      dec_ctx->sample_aspect_ratio.den);
161                av_reduce(&display_aspect_ratio.num, &display_aspect_ratio.den,
162                          dec_ctx->width  * dec_ctx->sample_aspect_ratio.num,
163                          dec_ctx->height * dec_ctx->sample_aspect_ratio.den,
164                          1024*1024);
165                printf("display_aspect_ratio=%d:%d\n", display_aspect_ratio.num,
166                                                       display_aspect_ratio.den);
167            }
168            printf("pix_fmt=%s\n",                 dec_ctx->pix_fmt != PIX_FMT_NONE ?
169                   av_pix_fmt_descriptors[dec_ctx->pix_fmt].name : "unknown");
170            break;
171
172        case AVMEDIA_TYPE_AUDIO:
173            printf("sample_rate=%s\n",             value_string(val_str, sizeof(val_str),
174                                                                dec_ctx->sample_rate,
175                                                                unit_hertz_str));
176            printf("channels=%d\n",                dec_ctx->channels);
177            printf("bits_per_sample=%d\n",         av_get_bits_per_sample(dec_ctx->codec_id));
178            break;
179        }
180    } else {
181        printf("codec_type=unknown\n");
182    }
183
184    if (fmt_ctx->iformat->flags & AVFMT_SHOW_IDS)
185        printf("id=0x%x\n", stream->id);
186    printf("r_frame_rate=%d/%d\n",         stream->r_frame_rate.num,   stream->r_frame_rate.den);
187    printf("avg_frame_rate=%d/%d\n",       stream->avg_frame_rate.num, stream->avg_frame_rate.den);
188    printf("time_base=%d/%d\n",            stream->time_base.num,      stream->time_base.den);
189    if (stream->language[0])
190        printf("language=%s\n",            stream->language);
191    printf("start_time=%s\n",   time_value_string(val_str, sizeof(val_str), stream->start_time,
192                                                  &stream->time_base));
193    printf("duration=%s\n",     time_value_string(val_str, sizeof(val_str), stream->duration,
194                                                  &stream->time_base));
195    if (stream->nb_frames)
196        printf("nb_frames=%"PRId64"\n",    stream->nb_frames);
197
198    while ((tag = av_metadata_get(stream->metadata, "", tag, AV_METADATA_IGNORE_SUFFIX)))
199        printf("TAG:%s=%s\n", tag->key, tag->value);
200
201    printf("[/STREAM]\n");
202}
203
204static void show_format(AVFormatContext *fmt_ctx)
205{
206    AVMetadataTag *tag = NULL;
207    char val_str[128];
208
209    printf("[FORMAT]\n");
210
211    printf("filename=%s\n",         fmt_ctx->filename);
212    printf("nb_streams=%d\n",       fmt_ctx->nb_streams);
213    printf("format_name=%s\n",      fmt_ctx->iformat->name);
214    printf("format_long_name=%s\n", fmt_ctx->iformat->long_name);
215    printf("start_time=%s\n",       time_value_string(val_str, sizeof(val_str), fmt_ctx->start_time,
216                                                      &AV_TIME_BASE_Q));
217    printf("duration=%s\n",         time_value_string(val_str, sizeof(val_str), fmt_ctx->duration,
218                                                      &AV_TIME_BASE_Q));
219    printf("size=%s\n",             value_string(val_str, sizeof(val_str), fmt_ctx->file_size,
220                                                 unit_byte_str));
221    printf("bit_rate=%s\n",         value_string(val_str, sizeof(val_str), fmt_ctx->bit_rate,
222                                                 unit_bit_per_second_str));
223
224    if (convert_tags)
225        av_metadata_conv(fmt_ctx, NULL, fmt_ctx->iformat->metadata_conv);
226    while ((tag = av_metadata_get(fmt_ctx->metadata, "", tag, AV_METADATA_IGNORE_SUFFIX)))
227        printf("TAG:%s=%s\n", tag->key, tag->value);
228
229    printf("[/FORMAT]\n");
230}
231
232static int open_input_file(AVFormatContext **fmt_ctx_ptr, const char *filename)
233{
234    int err, i;
235    AVFormatContext *fmt_ctx;
236
237    fmt_ctx = avformat_alloc_context();
238
239    if ((err = av_open_input_file(&fmt_ctx, filename, iformat, 0, NULL)) < 0) {
240        print_error(filename, err);
241        return err;
242    }
243
244    /* fill the streams in the format context */
245    if ((err = av_find_stream_info(fmt_ctx)) < 0) {
246        print_error(filename, err);
247        return err;
248    }
249
250    dump_format(fmt_ctx, 0, filename, 0);
251
252    /* bind a decoder to each input stream */
253    for (i = 0; i < fmt_ctx->nb_streams; i++) {
254        AVStream *stream = fmt_ctx->streams[i];
255        AVCodec *codec;
256
257        if (!(codec = avcodec_find_decoder(stream->codec->codec_id))) {
258            fprintf(stderr, "Unsupported codec (id=%d) for input stream %d\n",
259                    stream->codec->codec_id, stream->index);
260        } else if (avcodec_open(stream->codec, codec) < 0) {
261            fprintf(stderr, "Error while opening codec for input stream %d\n",
262                    stream->index);
263        }
264    }
265
266    *fmt_ctx_ptr = fmt_ctx;
267    return 0;
268}
269
270static int probe_file(const char *filename)
271{
272    AVFormatContext *fmt_ctx;
273    int ret, i;
274
275    if ((ret = open_input_file(&fmt_ctx, filename)))
276        return ret;
277
278    if (do_show_streams)
279        for (i = 0; i < fmt_ctx->nb_streams; i++)
280            show_stream(fmt_ctx, i);
281
282    if (do_show_format)
283        show_format(fmt_ctx);
284
285    av_close_input_file(fmt_ctx);
286    return 0;
287}
288
289static void show_usage(void)
290{
291    printf("Simple multimedia streams analyzer\n");
292    printf("usage: ffprobe [OPTIONS] [INPUT_FILE]\n");
293    printf("\n");
294}
295
296static void opt_format(const char *arg)
297{
298    iformat = av_find_input_format(arg);
299    if (!iformat) {
300        fprintf(stderr, "Unknown input format: %s\n", arg);
301        exit(1);
302    }
303}
304
305static void opt_input_file(const char *arg)
306{
307    if (input_filename) {
308        fprintf(stderr, "Argument '%s' provided as input filename, but '%s' was already specified.\n",
309                arg, input_filename);
310        exit(1);
311    }
312    if (!strcmp(arg, "-"))
313        arg = "pipe:";
314    input_filename = arg;
315}
316
317static void show_help(void)
318{
319    show_usage();
320    show_help_options(options, "Main options:\n", 0, 0);
321    printf("\n");
322}
323
324static void opt_pretty(void)
325{
326    show_value_unit              = 1;
327    use_value_prefix             = 1;
328    use_byte_value_binary_prefix = 1;
329    use_value_sexagesimal_format = 1;
330}
331
332static const OptionDef options[] = {
333#include "cmdutils_common_opts.h"
334    { "convert_tags", OPT_BOOL, {(void*)&convert_tags}, "convert tag names to the FFmpeg generic tag names" },
335    { "f", HAS_ARG, {(void*)opt_format}, "force format", "format" },
336    { "unit", OPT_BOOL, {(void*)&show_value_unit}, "show unit of the displayed values" },
337    { "prefix", OPT_BOOL, {(void*)&use_value_prefix}, "use SI prefixes for the displayed values" },
338    { "byte_binary_prefix", OPT_BOOL, {(void*)&use_byte_value_binary_prefix},
339      "use binary prefixes for byte units" },
340    { "sexagesimal", OPT_BOOL,  {(void*)&use_value_sexagesimal_format},
341      "use sexagesimal format HOURS:MM:SS.MICROSECONDS for time units" },
342    { "pretty", 0, {(void*)&opt_pretty},
343      "prettify the format of displayed values, make it more human readable" },
344    { "show_format",  OPT_BOOL, {(void*)&do_show_format} , "show format/container info" },
345    { "show_streams", OPT_BOOL, {(void*)&do_show_streams}, "show streams info" },
346    { NULL, },
347};
348
349int main(int argc, char **argv)
350{
351    av_register_all();
352#if CONFIG_AVDEVICE
353    avdevice_register_all();
354#endif
355
356    show_banner();
357    parse_options(argc, argv, options, opt_input_file);
358
359    if (!input_filename) {
360        show_usage();
361        fprintf(stderr, "You have to specify one input file.\n");
362        fprintf(stderr, "Use -h to get full help or, even better, run 'man ffprobe'.\n");
363        exit(1);
364    }
365
366    return probe_file(input_filename);
367}
368