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