avprobe.texi 3.19 KB
Newer Older
Stefano Sabatini's avatar
Stefano Sabatini committed
1 2
\input texinfo @c -*- texinfo -*-

3
@settitle avprobe Documentation
Stefano Sabatini's avatar
Stefano Sabatini committed
4
@titlepage
5
@center @titlefont{avprobe Documentation}
Stefano Sabatini's avatar
Stefano Sabatini committed
6 7
@end titlepage

8 9 10 11
@top

@contents

12 13 14 15 16 17
@chapter Synopsis

The generic syntax is:

@example
@c man begin SYNOPSIS
18
avprobe [options] [@file{input_file}]
19 20 21
@c man end
@end example

22
@chapter Description
Stefano Sabatini's avatar
Stefano Sabatini committed
23 24
@c man begin DESCRIPTION

25
avprobe gathers information from multimedia streams and prints it in
Stefano Sabatini's avatar
Stefano Sabatini committed
26 27 28 29 30 31
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.

32
If a filename is specified in input, avprobe will try to open and
Stefano Sabatini's avatar
Stefano Sabatini committed
33 34 35
probe the file content. If the file cannot be opened or recognized as
a multimedia file, a positive exit code is returned.

36
avprobe may be employed both as a standalone application or in
Stefano Sabatini's avatar
Stefano Sabatini committed
37 38 39
combination with a textual filter, which may perform more
sophisticated processing, e.g. statistical processing or plotting.

40
Options are used to list some of the formats supported by avprobe or
Stefano Sabatini's avatar
Stefano Sabatini committed
41
for specifying which information to display, and for setting how
42
avprobe will show it.
Stefano Sabatini's avatar
Stefano Sabatini committed
43

44 45
avprobe output is designed to be easily parsable by any INI or JSON
parsers.
Stefano Sabatini's avatar
Stefano Sabatini committed
46 47 48

@c man end

49
@chapter Options
Stefano Sabatini's avatar
Stefano Sabatini committed
50 51
@c man begin OPTIONS

52
@include avtools-common-opts.texi
Stefano Sabatini's avatar
Stefano Sabatini committed
53 54 55 56

@section Main options

@table @option
57 58 59 60

@item -f @var{format}
Force format to use.

61
@item -of @var{formatter}
62 63 64 65 66 67 68 69 70 71 72
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
73

Stefano Sabatini's avatar
Stefano Sabatini committed
74 75 76 77
@item -unit
Show the unit of the displayed values.

@item -prefix
78 79
Use SI prefixes for the displayed values.
Unless the "-byte_binary_prefix" option is used all the prefixes
Stefano Sabatini's avatar
Stefano Sabatini committed
80 81 82 83 84 85 86 87 88 89
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
90
options "-unit -prefix -byte_binary_prefix -sexagesimal".
Stefano Sabatini's avatar
Stefano Sabatini committed
91 92 93 94 95 96

@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
97
name "FORMAT".
Stefano Sabatini's avatar
Stefano Sabatini committed
98

99 100 101 102 103
@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.

104 105 106 107 108
@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
109
section with name "PACKET".
110

Stefano Sabatini's avatar
Stefano Sabatini committed
111 112 113 114 115
@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
116
with name "STREAM".
Stefano Sabatini's avatar
Stefano Sabatini committed
117 118 119 120

@end table
@c man end

121
@include demuxers.texi
Stefano Sabatini's avatar
Stefano Sabatini committed
122
@include muxers.texi
Stefano Sabatini's avatar
Stefano Sabatini committed
123
@include protocols.texi
124 125
@include indevs.texi

Stefano Sabatini's avatar
Stefano Sabatini committed
126 127
@ignore

128 129
@setfilename avprobe
@settitle avprobe media prober
Stefano Sabatini's avatar
Stefano Sabatini committed
130 131

@c man begin SEEALSO
132
avconv(1), avplay(1) and the Libav HTML documentation
Stefano Sabatini's avatar
Stefano Sabatini committed
133 134
@c man end

135
@c man begin AUTHORS
136
The Libav developers
137 138
@c man end

Stefano Sabatini's avatar
Stefano Sabatini committed
139 140 141
@end ignore

@bye