ffprobe: add support to video frame information printing
[ffmpeg.git] / doc / ffprobe.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle ffprobe Documentation
4 @titlepage
5 @center @titlefont{ffprobe Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Synopsis
13
14 The generic syntax is:
15
16 @example
17 @c man begin SYNOPSIS
18 ffprobe [options] [@file{input_file}]
19 @c man end
20 @end example
21
22 @chapter Description
23 @c man begin DESCRIPTION
24
25 ffprobe gathers information from multimedia streams and prints it in
26 human- and machine-readable fashion.
27
28 For example it can be used to check the format of the container used
29 by a multimedia stream and the format and type of each media stream
30 contained in it.
31
32 If a filename is specified in input, ffprobe will try to open and
33 probe the file content. If the file cannot be opened or recognized as
34 a multimedia file, a positive exit code is returned.
35
36 ffprobe may be employed both as a standalone application or in
37 combination with a textual filter, which may perform more
38 sophisticated processing, e.g. statistical processing or plotting.
39
40 Options are used to list some of the formats supported by ffprobe or
41 for specifying which information to display, and for setting how
42 ffprobe will show it.
43
44 ffprobe output is designed to be easily parsable by a textual filter,
45 and consists of one or more sections of a form defined by the selected
46 writer, which is specified by the @option{print_format} option.
47
48 Metadata tags stored in the container or in the streams are recognized
49 and printed in the corresponding "FORMAT" or "STREAM" section.
50
51 @c man end
52
53 @chapter Options
54 @c man begin OPTIONS
55
56 @include avtools-common-opts.texi
57
58 @section Main options
59
60 @table @option
61
62 @item -f @var{format}
63 Force format to use.
64
65 @item -unit
66 Show the unit of the displayed values.
67
68 @item -prefix
69 Use SI prefixes for the displayed values.
70 Unless the "-byte_binary_prefix" option is used all the prefixes
71 are decimal.
72
73 @item -byte_binary_prefix
74 Force the use of binary prefixes for byte values.
75
76 @item -sexagesimal
77 Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
78
79 @item -pretty
80 Prettify the format of the displayed values, it corresponds to the
81 options "-unit -prefix -byte_binary_prefix -sexagesimal".
82
83 @item -print_format @var{writer_name}[=@var{writer_options}]
84 Set the output printing format.
85
86 @var{writer_name} specifies the name of the writer, and
87 @var{writer_options} specifies the options to be passed to the writer.
88
89 For example for printing the output in JSON format, specify:
90 @example
91 -print_format json
92 @end example
93
94 For more details on the available output printing formats, see the
95 Writers section below.
96
97 @item -show_error
98 Show information about the error found when trying to probe the input.
99
100 The error information is printed within a section with name "ERROR".
101
102 @item -show_format
103 Show information about the container format of the input multimedia
104 stream.
105
106 All the container format information is printed within a section with
107 name "FORMAT".
108
109 @item -show_packets
110 Show information about each packet contained in the input multimedia
111 stream.
112
113 The information for each single packet is printed within a dedicated
114 section with name "PACKET".
115
116 @item -show_frames
117 Show information about each video frame contained in the input multimedia
118 stream.
119
120 The information for each single frame is printed within a dedicated
121 section with name "FRAME".
122
123 @item -show_streams
124 Show information about each media stream contained in the input
125 multimedia stream.
126
127 Each media stream information is printed within a dedicated section
128 with name "STREAM".
129
130 @item -show_private_data, -private
131 Show private data, that is data depending on the format of the
132 particular shown element.
133 This option is enabled by default, but you may need to disable it
134 for specific uses, for example when creating XSD-compliant XML output.
135
136 @item -i @var{input_file}
137 Read @var{input_file}.
138
139 @end table
140 @c man end
141
142 @chapter Writers
143 @c man begin WRITERS
144
145 A writer defines the output format adopted by @command{ffprobe}, and will be
146 used for printing all the parts of the output.
147
148 A writer may accept one or more arguments, which specify the options to
149 adopt.
150
151 A description of the currently available writers follows.
152
153 @section default
154 Default format.
155
156 Print each section in the form:
157 @example
158 [SECTION]
159 key1=val1
160 ...
161 keyN=valN
162 [/SECTION]
163 @end example
164
165 Metadata tags are printed as a line in the corresponding FORMAT or
166 STREAM section, and are prefixed by the string "TAG:".
167
168 @section compact
169 Compact format.
170
171 Each section is printed on a single line.
172 If no option is specifid, the output has the form:
173 @example
174 section|key1=val1| ... |keyN=valN
175 @end example
176
177 Metadata tags are printed in the corresponding "format" or "stream"
178 section. A metadata tag key, if printed, is prefixed by the string
179 "tag:".
180
181 This writer accepts options as a list of @var{key}=@var{value} pairs,
182 separated by ":".
183
184 The description of the accepted options follows.
185
186 @table @option
187
188 @item item_sep, s
189 Specify the character to use for separating fields in the output line.
190 It must be a single printable character, it is "|" by default.
191
192 @item nokey, nk
193 If set to 1 specify not to print the key of each field. Its default
194 value is 0.
195
196 @item escape, e
197 Set the escape mode to use, default to "c".
198
199 It can assume one of the following values:
200 @table @option
201 @item c
202 Perform C-like escaping. Strings containing a newline ('\n') or
203 carriage return ('\r'), the escaping character ('\') or the item
204 separator character @var{SEP} are escaped using C-like fashioned
205 escaping, so that a newline is converted to the sequence "\n", a
206 carriage return to "\r", '\' to "\\" and the separator @var{SEP} is
207 converted to "\@var{SEP}".
208
209 @item csv
210 Perform CSV-like escaping, as described in RFC4180.  Strings
211 containing a newline ('\n'), a carriage return ('\r'), a double quote
212 ('"'), or @var{SEP} are enclosed in double-quotes.
213
214 @item none
215 Perform no escaping.
216 @end table
217
218 @end table
219
220 @section csv
221 CSV format.
222
223 This writer is equivalent to
224 @code{compact=item_sep=,:nokey=1:escape=csv}.
225
226 @section json
227 JSON based format.
228
229 Each section is printed using JSON notation.
230
231 For more information about JSON, see @url{http://www.json.org/}.
232
233 @section xml
234 XML based format.
235
236 The XML output is described in the XML schema description file
237 @file{ffprobe.xsd} installed in the FFmpeg datadir.
238
239 Note that the output issued will be compliant to the
240 @file{ffprobe.xsd} schema only when no special global output options
241 (@option{unit}, @option{prefix}, @option{byte_binary_prefix},
242 @option{sexagesimal} etc.) are specified.
243
244 This writer accepts options as a list of @var{key}=@var{value} pairs,
245 separated by ":".
246
247 The description of the accepted options follows.
248
249 @table @option
250
251 @item fully_qualified, q
252 If set to 1 specify if the output should be fully qualified. Default
253 value is 0.
254 This is required for generating an XML file which can be validated
255 through an XSD file.
256
257 @item xsd_compliant, x
258 If set to 1 perform more checks for ensuring that the output is XSD
259 compliant. Default value is 0.
260 This option automatically sets @option{fully_qualified} to 1.
261 @end table
262
263 For more information about the XML format, see
264 @url{http://www.w3.org/XML/}.
265
266 @c man end WRITERS
267
268 @include decoders.texi
269 @include demuxers.texi
270 @include protocols.texi
271 @include indevs.texi
272
273 @ignore
274
275 @setfilename ffprobe
276 @settitle ffprobe media prober
277
278 @c man begin SEEALSO
279 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
280 @c man end
281
282 @c man begin AUTHORS
283 The FFmpeg developers
284 @c man end
285
286 @end ignore
287
288 @bye