librempeg/doc/avprobe.texi

142 lines
3.2 KiB
Plaintext
Raw Normal View History

\input texinfo @c -*- texinfo -*-
2011-07-26 17:04:43 +00:00
@settitle avprobe Documentation
@titlepage
2011-07-26 17:04:43 +00:00
@center @titlefont{avprobe Documentation}
@end titlepage
@top
@contents
@chapter Synopsis
The generic syntax is:
@example
@c man begin SYNOPSIS
2011-07-26 17:04:43 +00:00
avprobe [options] [@file{input_file}]
@c man end
@end example
@chapter Description
@c man begin DESCRIPTION
2011-07-26 17:04:43 +00:00
avprobe 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.
2011-07-26 17:04:43 +00:00
If a filename is specified in input, avprobe 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.
2011-07-26 17:04:43 +00:00
avprobe 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.
2011-07-26 17:04:43 +00:00
Options are used to list some of the formats supported by avprobe or
for specifying which information to display, and for setting how
2011-07-26 17:04:43 +00:00
avprobe will show it.
avprobe output is designed to be easily parsable by any INI or JSON
parsers.
@c man end
@chapter Options
@c man begin OPTIONS
@include avtools-common-opts.texi
@section Main options
@table @option
@item -f @var{format}
Force format to use.
@item -of @var{formatter}
Use a specific formatter to output the document. The following
formatters are available
@table @option
@item ini
@item json
@item old
Pseudo-INI format that used to be the only one available in old
avprobe versions.
@end table
@item -unit
Show the unit of the displayed values.
@item -prefix
Use SI prefixes for the displayed values.
Unless the "-byte_binary_prefix" option is used all the prefixes
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_format_entry @var{name}
Like @option{-show_format}, but only prints the specified entry of the
container format information, rather than all. This option may be given more
than once, then all specified entries will be shown.
@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
section with name "PACKET".
@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
@include demuxers.texi
@include muxers.texi
@include protocols.texi
@include indevs.texi
@ignore
2011-07-26 17:04:43 +00:00
@setfilename avprobe
@settitle avprobe media prober
@c man begin SEEALSO
avconv(1), avplay(1) and the Libav HTML documentation
@c man end
@c man begin AUTHORS
The Libav developers
@c man end
@end ignore
@bye