build: Rename OBJDIRS variable to OUTDIRS
[libav.git] / doc / avprobe.texi
CommitLineData
336ce917
SS
1\input texinfo @c -*- texinfo -*-
2
9e12f0bf 3@settitle avprobe Documentation
336ce917 4@titlepage
9e12f0bf 5@center @titlefont{avprobe Documentation}
336ce917
SS
6@end titlepage
7
a8f0814a
JG
8@top
9
10@contents
11
a66d8cd9
SS
12@chapter Synopsis
13
14The generic syntax is:
15
16@example
17@c man begin SYNOPSIS
9e12f0bf 18avprobe [options] [@file{input_file}]
a66d8cd9
SS
19@c man end
20@end example
21
016ea628 22@chapter Description
336ce917
SS
23@c man begin DESCRIPTION
24
9e12f0bf 25avprobe gathers information from multimedia streams and prints it in
336ce917
SS
26human- and machine-readable fashion.
27
28For example it can be used to check the format of the container used
29by a multimedia stream and the format and type of each media stream
30contained in it.
31
9e12f0bf 32If a filename is specified in input, avprobe will try to open and
336ce917
SS
33probe the file content. If the file cannot be opened or recognized as
34a multimedia file, a positive exit code is returned.
35
9e12f0bf 36avprobe may be employed both as a standalone application or in
336ce917
SS
37combination with a textual filter, which may perform more
38sophisticated processing, e.g. statistical processing or plotting.
39
9e12f0bf 40Options are used to list some of the formats supported by avprobe or
336ce917 41for specifying which information to display, and for setting how
9e12f0bf 42avprobe will show it.
336ce917 43
6a6c2a94
LB
44avprobe output is designed to be easily parsable by any INI or JSON
45parsers.
336ce917
SS
46
47@c man end
48
a66d8cd9 49@chapter Options
336ce917
SS
50@c man begin OPTIONS
51
b3dd2010 52@include avtools-common-opts.texi
336ce917
SS
53
54@section Main options
55
56@table @option
1be784a2
SS
57
58@item -f @var{format}
59Force format to use.
60
6a6c2a94 61@item -of @var{formatter}
8271f55b
AK
62Use a specific formatter to output the document. The following
63formatters are available
64@table @option
65@item ini
66
67@item json
68
69@item old
70Pseudo-INI format that used to be the only one available in old
71avprobe versions.
72@end table
6a6c2a94 73
336ce917
SS
74@item -unit
75Show the unit of the displayed values.
76
77@item -prefix
4906e7b5
SS
78Use SI prefixes for the displayed values.
79Unless the "-byte_binary_prefix" option is used all the prefixes
336ce917
SS
80are decimal.
81
82@item -byte_binary_prefix
83Force the use of binary prefixes for byte values.
84
85@item -sexagesimal
86Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
87
88@item -pretty
89Prettify the format of the displayed values, it corresponds to the
0eb1a356 90options "-unit -prefix -byte_binary_prefix -sexagesimal".
336ce917
SS
91
92@item -show_format
93Show information about the container format of the input multimedia
94stream.
95
96All the container format information is printed within a section with
0eb1a356 97name "FORMAT".
336ce917 98
08354bf4
RB
99@item -show_format_entry @var{name}
100Like @option{-show_format}, but only prints the specified entry of the
101container format information, rather than all. This option may be given more
102than once, then all specified entries will be shown.
103
530bbe96
SS
104@item -show_packets
105Show information about each packet contained in the input multimedia
106stream.
107
108The information for each single packet is printed within a dedicated
0eb1a356 109section with name "PACKET".
530bbe96 110
336ce917
SS
111@item -show_streams
112Show information about each media stream contained in the input
113multimedia stream.
114
115Each media stream information is printed within a dedicated section
0eb1a356 116with name "STREAM".
336ce917
SS
117
118@end table
119@c man end
120
ef298ea7 121@include demuxers.texi
85466e1e 122@include muxers.texi
1de4cfe6 123@include protocols.texi
4419c8bf
SS
124@include indevs.texi
125
336ce917
SS
126@ignore
127
9e12f0bf
AK
128@setfilename avprobe
129@settitle avprobe media prober
336ce917
SS
130
131@c man begin SEEALSO
2e87b4c5 132avconv(1), avplay(1) and the Libav HTML documentation
336ce917
SS
133@c man end
134
aeadb328 135@c man begin AUTHORS
f8a45fa1 136The Libav developers
aeadb328
SS
137@c man end
138
336ce917
SS
139@end ignore
140
141@bye