1\input texinfo @c -*- texinfo -*-
2
3@settitle avprobe Documentation
4@titlepage
5@center @titlefont{avprobe Documentation}
6@end titlepage
7
8@top
9
10@contents
11
12@chapter Synopsis
13
14The generic syntax is:
15
16@example
17@c man begin SYNOPSIS
18avprobe [options] [@file{input_file}]
19@c man end
20@end example
21
22@chapter Description
23@c man begin DESCRIPTION
24
25avprobe gathers information from multimedia streams and prints it in
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
32If a filename is specified in input, avprobe will try to open and
33probe the file content. If the file cannot be opened or recognized as
34a multimedia file, a positive exit code is returned.
35
36avprobe may be employed both as a standalone application or in
37combination with a textual filter, which may perform more
38sophisticated processing, e.g. statistical processing or plotting.
39
40Options are used to list some of the formats supported by avprobe or
41for specifying which information to display, and for setting how
42avprobe will show it.
43
44avprobe output is designed to be easily parsable by a textual filter,
45and consists of one or more sections of the form:
46@example
47[SECTION]
48key1=val1
49...
50keyN=valN
51[/SECTION]
52@end example
53
54Metadata tags stored in the container or in the streams are recognized
55and printed in the corresponding "FORMAT" or "STREAM" section, and
56are prefixed by the string "TAG:".
57
58@c man end
59
60@chapter Options
61@c man begin OPTIONS
62
63@include avtools-common-opts.texi
64
65@section Main options
66
67@table @option
68
69@item -f @var{format}
70Force format to use.
71
72@item -unit
73Show the unit of the displayed values.
74
75@item -prefix
76Use SI prefixes for the displayed values.
77Unless the "-byte_binary_prefix" option is used all the prefixes
78are decimal.
79
80@item -byte_binary_prefix
81Force the use of binary prefixes for byte values.
82
83@item -sexagesimal
84Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
85
86@item -pretty
87Prettify the format of the displayed values, it corresponds to the
88options "-unit -prefix -byte_binary_prefix -sexagesimal".
89
90@item -show_format
91Show information about the container format of the input multimedia
92stream.
93
94All the container format information is printed within a section with
95name "FORMAT".
96
97@item -show_packets
98Show information about each packet contained in the input multimedia
99stream.
100
101The information for each single packet is printed within a dedicated
102section with name "PACKET".
103
104@item -show_streams
105Show information about each media stream contained in the input
106multimedia stream.
107
108Each media stream information is printed within a dedicated section
109with name "STREAM".
110
111@end table
112@c man end
113
114@include demuxers.texi
115@include muxers.texi
116@include protocols.texi
117@include indevs.texi
118
119@ignore
120
121@setfilename avprobe
122@settitle avprobe media prober
123
124@c man begin SEEALSO
125avconv(1), avplay(1) and the Libav HTML documentation
126@c man end
127
128@c man begin AUTHORS
129The Libav developers
130@c man end
131
132@end ignore
133
134@bye
135