doc/ffprobe.texi
336ce917
 \input texinfo @c -*- texinfo -*-
 
89b503b5
 @settitle ffprobe Documentation
336ce917
 @titlepage
89b503b5
 @center @titlefont{ffprobe Documentation}
336ce917
 @end titlepage
 
a8f0814a
 @top
 
 @contents
 
a66d8cd9
 @chapter Synopsis
 
 The generic syntax is:
 
 @example
 @c man begin SYNOPSIS
 ffprobe [options] [@file{input_file}]
 @c man end
 @end example
 
016ea628
 @chapter Description
336ce917
 @c man begin DESCRIPTION
 
3a50894e
 ffprobe gathers information from multimedia streams and prints it in
336ce917
 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.
 
3a50894e
 ffprobe may be employed both as a standalone application or in
336ce917
 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.
 
3a50894e
 ffprobe output is designed to be easily parsable by a textual filter,
336ce917
 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
0eb1a356
 and printed in the corresponding "FORMAT" or "STREAM" section, and
 are prefixed by the string "TAG:".
336ce917
 
 @c man end
 
a66d8cd9
 @chapter Options
336ce917
 @c man begin OPTIONS
 
 @include fftools-common-opts.texi
 
 @section Main options
 
 @table @option
1be784a2
 
 @item -f @var{format}
 Force format to use.
 
336ce917
 @item -unit
 Show the unit of the displayed values.
 
 @item -prefix
4906e7b5
 Use SI prefixes for the displayed values.
 Unless the "-byte_binary_prefix" option is used all the prefixes
336ce917
 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
0eb1a356
 options "-unit -prefix -byte_binary_prefix -sexagesimal".
336ce917
 
 @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
0eb1a356
 name "FORMAT".
336ce917
 
530bbe96
 @item -show_packets
 Show information about each packet contained in the input multimedia
 stream.
 
 The information for each single packet is printed within a dedicated
0eb1a356
 section with name "PACKET".
530bbe96
 
336ce917
 @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
0eb1a356
 with name "STREAM".
336ce917
 
cea87fb2
 @item -i @var{input_file}
 Read @var{input_file}.
 
336ce917
 @end table
 @c man end
 
5e45f034
 @include decoders.texi
ef298ea7
 @include demuxers.texi
1de4cfe6
 @include protocols.texi
4419c8bf
 @include indevs.texi
 
336ce917
 @ignore
 
 @setfilename ffprobe
89b503b5
 @settitle ffprobe media prober
336ce917
 
 @c man begin SEEALSO
a6be21d3
 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
336ce917
 @c man end
 
aeadb328
 @c man begin AUTHORS
a6be21d3
 The FFmpeg developers
aeadb328
 @c man end
 
336ce917
 @end ignore
 
 @bye