Do not attempt to seek to index for streamed files and if the user explicitly
[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
016ea628 10@chapter Description
336ce917
SS
11@c man begin DESCRIPTION
12
13FFprobe gathers information from multimedia streams and prints it in
14human- and machine-readable fashion.
15
16For example it can be used to check the format of the container used
17by a multimedia stream and the format and type of each media stream
18contained in it.
19
20If a filename is specified in input, ffprobe will try to open and
21probe the file content. If the file cannot be opened or recognized as
22a multimedia file, a positive exit code is returned.
23
24FFprobe may be employed both as a standalone application or in
25combination with a textual filter, which may perform more
26sophisticated processing, e.g. statistical processing or plotting.
27
28Options are used to list some of the formats supported by ffprobe or
29for specifying which information to display, and for setting how
30ffprobe will show it.
31
32FFprobe output is designed to be easily parsable by a textual filter,
33and consists of one or more sections of the form:
34@example
35[SECTION]
36key1=val1
37...
38keyN=valN
39[/SECTION]
40@end example
41
42Metadata tags stored in the container or in the streams are recognized
43and printed in the corresponding ``FORMAT'' or ``STREAM'' section, and
44are prefixed by the string ``TAG:''.
45
46@c man end
47
48@chapter Invocation
49
50@section Syntax
51
52The generic syntax is:
53
54@example
55@c man begin SYNOPSIS
56ffprobe [options] [@file{input_file}]
57@c man end
58@end example
59
60@c man begin OPTIONS
61
62@include fftools-common-opts.texi
63
64@section Main options
65
66@table @option
1be784a2 67
4bfe67da
SS
68@item -convert_tags
69Convert the tag names in the format container to the generic FFmpeg tag names.
70
1be784a2
SS
71@item -f @var{format}
72Force format to use.
73
336ce917
SS
74@item -unit
75Show the unit of the displayed values.
76
77@item -prefix
78Show a SI prefixes of the displayed values.
79Unless ``-byte_binary_prefix'' option is used all the prefix
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
90options ``-unit -prefix -byte_binary_prefix -sexagesimal''.
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
97name ``FORMAT''.
98
99@item -show_streams
100Show information about each media stream contained in the input
101multimedia stream.
102
103Each media stream information is printed within a dedicated section
104with name ``STREAM''.
105
106@end table
107@c man end
108
109@ignore
110
111@setfilename ffprobe
112@settitle FFprobe media prober
113
114@c man begin SEEALSO
b26247ed 115ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
336ce917
SS
116@c man end
117
aeadb328
SS
118@c man begin AUTHORS
119The FFmpeg developers
120@c man end
121
336ce917
SS
122@end ignore
123
124@bye