From 336ce917e6e6adb10ee44945684c67cdea65e228 Mon Sep 17 00:00:00 2001 From: Stefano Sabatini Date: Sun, 21 Feb 2010 11:43:01 +0000 Subject: [PATCH] Add FFprobe tool. This is a simplified / cleaned-up version of the SourceForge program: http://sourceforge.net/projects/ffprobe/ Syntax / features may be different, in particular the options -show_packets and -show_frames are not yet supported in this version. Originally committed as revision 21936 to svn://svn.ffmpeg.org/ffmpeg/trunk --- Changelog | 1 + Makefile | 5 +- configure | 4 + doc/ffprobe-doc.texi | 114 +++++++++++++++ ffprobe.c | 333 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 455 insertions(+), 2 deletions(-) create mode 100644 doc/ffprobe-doc.texi create mode 100644 ffprobe.c diff --git a/Changelog b/Changelog index 0e561d5c2a..934549e596 100644 --- a/Changelog +++ b/Changelog @@ -58,6 +58,7 @@ version : - Indeo 5 decoder - RTP depacketization of AMR - WMAVoice decoder +- FFprobe tool diff --git a/Makefile b/Makefile index 49033816ab..0dc6d4d426 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,7 @@ vpath %.texi $(SRC_PATH_BARE) PROGS-$(CONFIG_FFMPEG) += ffmpeg PROGS-$(CONFIG_FFPLAY) += ffplay +PROGS-$(CONFIG_FFPROBE) += ffprobe PROGS-$(CONFIG_FFSERVER) += ffserver PROGS := $(addsuffix $(EXESUF), $(PROGS-yes)) @@ -15,7 +16,7 @@ MANPAGES = $(addprefix doc/, $(addsuffix .1, $(PROGS-yes))) TOOLS = $(addprefix tools/, $(addsuffix $(EXESUF), cws2fws pktdumper probetest qt-faststart trasher)) HOSTPROGS = $(addprefix tests/, audiogen videogen rotozoom tiny_psnr) -BASENAMES = ffmpeg ffplay ffserver +BASENAMES = ffmpeg ffplay ffprobe ffserver ALLPROGS = $(addsuffix $(EXESUF), $(BASENAMES)) ALLPROGS_G = $(addsuffix _g$(EXESUF), $(BASENAMES)) ALLMANPAGES = $(addsuffix .1, $(BASENAMES)) @@ -87,7 +88,7 @@ cmdutils.o cmdutils.d: version.h alltools: $(TOOLS) documentation: $(addprefix doc/, developer.html faq.html ffmpeg-doc.html \ - ffplay-doc.html ffserver-doc.html \ + ffplay-doc.html ffprobe-doc.html ffserver-doc.html \ general.html libavfilter.html $(ALLMANPAGES)) doc/%.html: doc/%.texi diff --git a/configure b/configure index 7d4c612c46..5f639331f3 100755 --- a/configure +++ b/configure @@ -82,6 +82,7 @@ Configuration options: --disable-doc do not build documentation --disable-ffmpeg disable ffmpeg build --disable-ffplay disable ffplay build + --disable-ffprobe disable ffprobe build --disable-ffserver disable ffserver build --disable-avdevice disable libavdevice build --disable-avcodec disable libavcodec build @@ -890,6 +891,7 @@ CONFIG_LIST=" fastdiv ffmpeg ffplay + ffprobe ffserver fft golomb @@ -1398,6 +1400,7 @@ avformat_deps="avcodec" ffmpeg_deps="avcodec avformat swscale" ffplay_deps="avcodec avformat swscale sdl" ffplay_select="rdft" +ffprobe_deps="avcodec avformat" ffserver_deps="avformat ffm_muxer rtp_protocol rtsp_demuxer" ffserver_extralibs='$ldl' @@ -1449,6 +1452,7 @@ enable doc enable fastdiv enable ffmpeg enable ffplay +enable ffprobe enable ffserver enable mpegaudio_hp enable network diff --git a/doc/ffprobe-doc.texi b/doc/ffprobe-doc.texi new file mode 100644 index 0000000000..d656de8fc4 --- /dev/null +++ b/doc/ffprobe-doc.texi @@ -0,0 +1,114 @@ +\input texinfo @c -*- texinfo -*- + +@settitle FFprobe Documentation +@titlepage +@sp 7 +@center @titlefont{FFprobe Documentation} +@sp 3 +@end titlepage + +@chapter Introduction + +@c man begin DESCRIPTION + +FFprobe gathers information from multimedia streams and prints it in +human- and machine-readable fashion. + +For example it can be used to check the format of the container used +by a multimedia stream and the format and type of each media stream +contained in it. + +If a filename is specified in input, ffprobe will try to open and +probe the file content. If the file cannot be opened or recognized as +a multimedia file, a positive exit code is returned. + +FFprobe may be employed both as a standalone application or in +combination with a textual filter, which may perform more +sophisticated processing, e.g. statistical processing or plotting. + +Options are used to list some of the formats supported by ffprobe or +for specifying which information to display, and for setting how +ffprobe will show it. + +FFprobe output is designed to be easily parsable by a textual filter, +and consists of one or more sections of the form: +@example +[SECTION] +key1=val1 +... +keyN=valN +[/SECTION] +@end example + +Metadata tags stored in the container or in the streams are recognized +and printed in the corresponding ``FORMAT'' or ``STREAM'' section, and +are prefixed by the string ``TAG:''. + +@c man end + +@chapter Invocation + +@section Syntax + +The generic syntax is: + +@example +@c man begin SYNOPSIS +ffprobe [options] [@file{input_file}] +@c man end +@end example + +@c man begin OPTIONS + +@include fftools-common-opts.texi + +@section Main options + +@table @option +@item -unit +Show the unit of the displayed values. + +@item -prefix +Show a SI prefixes of the displayed values. +Unless ``-byte_binary_prefix'' option is used all the prefix +are decimal. + +@item -byte_binary_prefix +Force the use of binary prefixes for byte values. + +@item -sexagesimal +Use sexagesimal format HH:MM:SS.MICROSECONDS for time values. + +@item -pretty +Prettify the format of the displayed values, it corresponds to the +options ``-unit -prefix -byte_binary_prefix -sexagesimal''. + +@item -show_format +Show information about the container format of the input multimedia +stream. + +All the container format information is printed within a section with +name ``FORMAT''. + +@item -show_streams +Show information about each media stream contained in the input +multimedia stream. + +Each media stream information is printed within a dedicated section +with name ``STREAM''. + +@end table +@c man end + +@ignore + +@setfilename ffprobe +@settitle FFprobe media prober + +@c man begin SEEALSO +ffmpeg(1), ffplay(1), ffserver(1) +@c man end + +@end ignore + +@bye diff --git a/ffprobe.c b/ffprobe.c new file mode 100644 index 0000000000..47dad44ec5 --- /dev/null +++ b/ffprobe.c @@ -0,0 +1,333 @@ +/* + * FFprobe : Simple Media Prober based on the FFmpeg libraries + * Copyright (c) 2007-2010 Stefano Sabatini + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#undef HAVE_AV_CONFIG_H +#include "libavformat/avformat.h" +#include "libavcodec/avcodec.h" +#include "libavcodec/opt.h" +#include "libavutil/pixdesc.h" +#include "cmdutils.h" + +const char program_name[] = "FFprobe"; +const int program_birth_year = 2007; + +static int do_show_format = 0; +static int do_show_streams = 0; + +static int show_value_unit = 0; +static int use_value_prefix = 0; +static int use_byte_value_binary_prefix = 0; +static int use_value_sexagesimal_format = 0; + +/* globals */ +static const OptionDef options[]; + +/* FFprobe context */ +static const char *input_filename; + +static const char *binary_unit_prefixes [] = { "", "Ki", "Mi", "Gi", "Ti", "Pi" }; +static const char *decimal_unit_prefixes[] = { "", "K" , "M" , "G" , "T" , "P" }; + +static const char *unit_second_str = "s" ; +static const char *unit_hertz_str = "Hz" ; +static const char *unit_byte_str = "byte" ; +static const char *unit_bit_per_second_str = "bit/s"; + +static char *value_string(char *buf, int buf_size, double val, const char *unit) +{ + if (unit == unit_second_str && use_value_sexagesimal_format) { + double secs; + int hours, mins; + secs = val; + mins = (int)secs / 60; + secs = secs - mins * 60; + hours = mins / 60; + mins %= 60; + snprintf(buf, buf_size, "%d:%02d:%09.6f", hours, mins, secs); + } else if (use_value_prefix) { + const char *prefix_string; + int index; + + if (unit == unit_byte_str && use_byte_value_binary_prefix) { + index = (int) (log2(val)) / 10; + index = av_clip(index, 0, FF_ARRAY_ELEMS(binary_unit_prefixes) -1); + val /= pow(2, index*10); + prefix_string = binary_unit_prefixes[index]; + } else { + index = (int) (log10(val)) / 3; + index = av_clip(index, 0, FF_ARRAY_ELEMS(decimal_unit_prefixes) -1); + val /= pow(10, index*3); + prefix_string = decimal_unit_prefixes[index]; + } + + snprintf(buf, buf_size, "%.3f %s%s", val, prefix_string, show_value_unit ? unit : ""); + } else { + snprintf(buf, buf_size, "%f %s", val, show_value_unit ? unit : ""); + } + + return buf; +} + +static char *time_value_string(char *buf, int buf_size, int64_t val, const AVRational *time_base) +{ + if (val == AV_NOPTS_VALUE) { + snprintf(buf, buf_size, "N/A"); + } else { + value_string(buf, buf_size, val * av_q2d(*time_base), unit_second_str); + } + + return buf; +} + +static const char *codec_type_string(enum CodecType codec_type) +{ + switch (codec_type) { + case CODEC_TYPE_VIDEO: return "video"; + case CODEC_TYPE_AUDIO: return "audio"; + case CODEC_TYPE_DATA: return "data"; + case CODEC_TYPE_SUBTITLE: return "subtitle"; + case CODEC_TYPE_ATTACHMENT: return "attachment"; + default: return "unknown"; + } +} + +static void show_stream(AVFormatContext *fmt_ctx, int stream_idx) +{ + AVStream *stream = fmt_ctx->streams[stream_idx]; + AVCodecContext *dec_ctx; + AVCodec *dec; + char val_str[128]; + AVMetadataTag *tag; + char a, b, c, d; + + printf("[STREAM]\n"); + + printf("index=%d\n", stream->index); + + if ((dec_ctx = stream->codec)) { + if ((dec = dec_ctx->codec)) { + printf("codec_name=%s\n", dec->name); + printf("codec_long_name=%s\n", dec->long_name); + } else { + printf("codec_name=unknown\n"); + } + + printf("codec_type=%s\n", codec_type_string(dec_ctx->codec_type)); + printf("codec_time_base=%d/%d\n", dec_ctx->time_base.num, dec_ctx->time_base.den); + + /* print AVI/FourCC tag */ + a = dec_ctx->codec_tag & 0xff; + b = dec_ctx->codec_tag>>8 & 0xff; + c = dec_ctx->codec_tag>>16 & 0xff; + d = dec_ctx->codec_tag>>24 & 0xff; + printf("codec_tag_string="); + if (isprint(a)) printf("%c", a); else printf("[%d]", a); + if (isprint(b)) printf("%c", b); else printf("[%d]", b); + if (isprint(c)) printf("%c", c); else printf("[%d]", c); + if (isprint(d)) printf("%c", d); else printf("[%d]", d); + printf("\ncodec_tag=0x%04x\n", dec_ctx->codec_tag); + + switch (dec_ctx->codec_type) { + case CODEC_TYPE_VIDEO: + printf("width=%d\n", dec_ctx->width); + printf("height=%d\n", dec_ctx->height); + printf("has_b_frames=%d\n", dec_ctx->has_b_frames); + printf("sample_aspect_ratio=%d:%d\n", dec_ctx->sample_aspect_ratio.num, + dec_ctx->sample_aspect_ratio.den); + printf("display_aspect_ratio=%d:%d\n", dec_ctx->sample_aspect_ratio.num, + dec_ctx->sample_aspect_ratio.den); + printf("pix_fmt=%s\n", dec_ctx->pix_fmt != PIX_FMT_NONE ? + av_pix_fmt_descriptors[dec_ctx->pix_fmt].name : "unknown"); + break; + + case CODEC_TYPE_AUDIO: + printf("sample_rate=%s\n", value_string(val_str, sizeof(val_str), + dec_ctx->sample_rate, + unit_hertz_str)); + printf("channels=%d\n", dec_ctx->channels); + printf("bits_per_sample=%d\n", av_get_bits_per_sample(dec_ctx->codec_id)); + break; + } + } else { + printf("codec_type=unknown\n"); + } + + if (fmt_ctx->iformat->flags & AVFMT_SHOW_IDS) + printf("id=0x%x\n", stream->id); + printf("r_frame_rate=%d/%d\n", stream->r_frame_rate.num, stream->r_frame_rate.den); + printf("avg_frame_rate=%d/%d\n", stream->avg_frame_rate.num, stream->avg_frame_rate.den); + printf("time_base=%d/%d\n", stream->time_base.num, stream->time_base.den); + if (stream->language[0]) + printf("language=%s\n", stream->language); + printf("start_time=%s\n", time_value_string(val_str, sizeof(val_str), stream->start_time, + &stream->time_base)); + printf("duration=%s\n", time_value_string(val_str, sizeof(val_str), stream->duration, + &stream->time_base)); + + while ((tag = av_metadata_get(stream->metadata, "", tag, AV_METADATA_IGNORE_SUFFIX))) + printf("%s=%s\n", tag->key, tag->value); + + printf("[/STREAM]\n"); +} + +static void show_format(AVFormatContext *fmt_ctx) +{ + AVMetadataTag *tag = NULL; + char val_str[128]; + + printf("[FORMAT]\n"); + + printf("filename=%s\n", fmt_ctx->filename); + printf("nb_streams=%d\n", fmt_ctx->nb_streams); + printf("format_name=%s\n", fmt_ctx->iformat->name); + printf("format_long_name=%s\n", fmt_ctx->iformat->long_name); + printf("start_time=%s\n", time_value_string(val_str, sizeof(val_str), fmt_ctx->start_time, + &AV_TIME_BASE_Q)); + printf("duration=%s\n", time_value_string(val_str, sizeof(val_str), fmt_ctx->duration, + &AV_TIME_BASE_Q)); + printf("size=%s\n", value_string(val_str, sizeof(val_str), fmt_ctx->file_size, + unit_byte_str)); + printf("bit_rate=%s\n", value_string(val_str, sizeof(val_str), fmt_ctx->bit_rate, + unit_bit_per_second_str)); + + while ((tag = av_metadata_get(fmt_ctx->metadata, "", tag, AV_METADATA_IGNORE_SUFFIX))) + printf("TAG:%s=%s\n", tag->key, tag->value); + + printf("[/FORMAT]\n"); +} + +static int open_input_file(AVFormatContext **fmt_ctx_ptr, const char *filename) +{ + int err, i; + AVFormatContext *fmt_ctx; + + fmt_ctx = avformat_alloc_context(); + + if ((err = av_open_input_file(&fmt_ctx, filename, NULL, 0, NULL)) < 0) { + print_error(filename, err); + return err; + } + + /* fill the streams in the format context */ + if ((err = av_find_stream_info(fmt_ctx)) < 0) { + print_error(filename, err); + return err; + } + + dump_format(fmt_ctx, 0, filename, 0); + + /* bind a decoder to each input stream */ + for (i = 0; i < fmt_ctx->nb_streams; i++) { + AVStream *stream = fmt_ctx->streams[i]; + AVCodec *codec; + + if (!(codec = avcodec_find_decoder(stream->codec->codec_id))) { + fprintf(stderr, "Unsupported codec (id=%d) for input stream %d\n", + stream->codec->codec_id, stream->index); + } else if (avcodec_open(stream->codec, codec) < 0) { + fprintf(stderr, "Error while opening codec for input stream %d\n", + stream->index); + } + } + + *fmt_ctx_ptr = fmt_ctx; + return 0; +} + +static int probe_file(const char *filename) +{ + AVFormatContext *fmt_ctx; + int ret, i; + + if ((ret = open_input_file(&fmt_ctx, filename))) + return ret; + + if (do_show_streams) + for (i = 0; i < fmt_ctx->nb_streams; i++) + show_stream(fmt_ctx, i); + + if (do_show_format) + show_format(fmt_ctx); + + av_close_input_file(fmt_ctx); + return 0; +} + +static void show_usage(void) +{ + printf("Simple multimedia streams analyzer\n"); + printf("usage: ffprobe [OPTIONS] [INPUT_FILE]\n"); + printf("\n"); +} + +static void opt_input_file(const char *filename) +{ + if (!strcmp(filename, "-")) + filename = "pipe:"; + input_filename = filename; +} + +static void show_help(void) +{ + show_usage(); + show_help_options(options, "Main options:\n", 0, 0); + printf("\n"); +} + +static void opt_pretty(void) +{ + show_value_unit = 1; + use_value_prefix = 1; + use_byte_value_binary_prefix = 1; + use_value_sexagesimal_format = 1; +} + +static const OptionDef options[] = { +#include "cmdutils_common_opts.h" + { "unit", OPT_BOOL, {(void*)&show_value_unit}, "show unit of the displayed values" }, + { "prefix", OPT_BOOL, {(void*)&use_value_prefix}, "use SI prefixes for the displayed values" }, + { "byte_binary_prefix", OPT_BOOL, {(void*)&use_byte_value_binary_prefix}, + "use binary prefixes for byte units" }, + { "sexagesimal", OPT_BOOL, {(void*)&use_value_sexagesimal_format}, + "use sexagesimal format HOURS:MM:SS.MICROSECONDS for time units" }, + { "pretty", 0, {(void*)&opt_pretty}, + "prettify the format of displayed values, make it more human readable" }, + { "show_format", OPT_BOOL, {(void*)&do_show_format} , "show format/container info" }, + { "show_streams", OPT_BOOL, {(void*)&do_show_streams}, "show streams info" }, + { NULL, }, +}; + +int main(int argc, char **argv) +{ + av_register_all(); + + show_banner(); + parse_options(argc, argv, options, opt_input_file); + + if (!input_filename) { + show_usage(); + fprintf(stderr, "You have to specify one input file.\n"); + fprintf(stderr, "Use -h to get full help or, even better, run 'man ffprobe'.\n"); + exit(1); + } + + return probe_file(input_filename); +}