doc/ffprobe: factorize definition of writers syntax
[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 -of, -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 -select_streams @var{stream_specifier}
98 Select only the streams specified by @var{stream_specifier}. This
99 option affects only the options related to streams
100 (e.g. @code{show_streams}, @code{show_packets}, etc.).
101
102 For example to show only audio streams, you can use the command:
103 @example
104 ffprobe -show_streams -select_streams a INPUT
105 @end example
106
107 To show only video packets belonging to the video stream with index 1:
108 @example
109 ffprobe -show_packets -select_streams v:1 INPUT
110 @end example
111
112 @item -show_data
113 Show payload data, as an hexadecimal and ASCII dump. Coupled with
114 @option{-show_packets}, it will dump the packets' data. Coupled with
115 @option{-show_streams}, it will dump the codec extradata.
116
117 The dump is printed as the "data" field. It may contain newlines.
118
119 @item -show_error
120 Show information about the error found when trying to probe the input.
121
122 The error information is printed within a section with name "ERROR".
123
124 @item -show_format
125 Show information about the container format of the input multimedia
126 stream.
127
128 All the container format information is printed within a section with
129 name "FORMAT".
130
131 @item -show_format_entry @var{name}
132 Like @option{-show_format}, but only prints the specified entry of the
133 container format information, rather than all. This option may be given more
134 than once, then all specified entries will be shown.
135
136 @item -show_packets
137 Show information about each packet contained in the input multimedia
138 stream.
139
140 The information for each single packet is printed within a dedicated
141 section with name "PACKET".
142
143 @item -show_frames
144 Show information about each frame contained in the input multimedia
145 stream.
146
147 The information for each single frame is printed within a dedicated
148 section with name "FRAME".
149
150 @item -show_streams
151 Show information about each media stream contained in the input
152 multimedia stream.
153
154 Each media stream information is printed within a dedicated section
155 with name "STREAM".
156
157 @item -count_frames
158 Count the number of frames per stream and report it in the
159 corresponding stream section.
160
161 @item -count_packets
162 Count the number of packets per stream and report it in the
163 corresponding stream section.
164
165 @item -show_private_data, -private
166 Show private data, that is data depending on the format of the
167 particular shown element.
168 This option is enabled by default, but you may need to disable it
169 for specific uses, for example when creating XSD-compliant XML output.
170
171 @item -show_program_version
172 Show information related to program version.
173
174 Version information is printed within a section with name
175 "PROGRAM_VERSION".
176
177 @item -show_library_versions
178 Show information related to library versions.
179
180 Version information for each library is printed within a section with
181 name "LIBRARY_VERSION".
182
183 @item -show_versions
184 Show information related to program and library versions. This is the
185 equivalent of setting both @option{-show_program_version} and
186 @option{-show_library_versions} options.
187
188 @item -bitexact
189 Force bitexact output, useful to produce output which is not dependent
190 on the specific build.
191
192 @item -i @var{input_file}
193 Read @var{input_file}.
194
195 @end table
196 @c man end
197
198 @chapter Writers
199 @c man begin WRITERS
200
201 A writer defines the output format adopted by @command{ffprobe}, and will be
202 used for printing all the parts of the output.
203
204 A writer may accept one or more arguments, which specify the options
205 to adopt. The options are specified as a list of @var{key}=@var{value}
206 pairs, separated by ":".
207
208 A description of the currently available writers follows.
209
210 @section default
211 Default format.
212
213 Print each section in the form:
214 @example
215 [SECTION]
216 key1=val1
217 ...
218 keyN=valN
219 [/SECTION]
220 @end example
221
222 Metadata tags are printed as a line in the corresponding FORMAT or
223 STREAM section, and are prefixed by the string "TAG:".
224
225 A description of the accepted options follows.
226
227 @table @option
228
229 @item nokey, nk
230 If set to 1 specify not to print the key of each field. Default value
231 is 0.
232
233 @item noprint_wrappers, nw
234 If set to 1 specify not to print the section header and footer.
235 Default value is 0.
236 @end table
237
238 @section compact, csv
239 Compact and CSV format.
240
241 The @code{csv} writer is equivalent to @code{compact}, but supports
242 different defaults.
243
244 Each section is printed on a single line.
245 If no option is specifid, the output has the form:
246 @example
247 section|key1=val1| ... |keyN=valN
248 @end example
249
250 Metadata tags are printed in the corresponding "format" or "stream"
251 section. A metadata tag key, if printed, is prefixed by the string
252 "tag:".
253
254 The description of the accepted options follows.
255
256 @table @option
257
258 @item item_sep, s
259 Specify the character to use for separating fields in the output line.
260 It must be a single printable character, it is "|" by default ("," for
261 the @code{csv} writer).
262
263 @item nokey, nk
264 If set to 1 specify not to print the key of each field. Its default
265 value is 0 (1 for the @code{csv} writer).
266
267 @item escape, e
268 Set the escape mode to use, default to "c" ("csv" for the @code{csv}
269 writer).
270
271 It can assume one of the following values:
272 @table @option
273 @item c
274 Perform C-like escaping. Strings containing a newline ('\n'), carriage
275 return ('\r'), a tab ('\t'), a form feed ('\f'), the escaping
276 character ('\') or the item separator character @var{SEP} are escaped using C-like fashioned
277 escaping, so that a newline is converted to the sequence "\n", a
278 carriage return to "\r", '\' to "\\" and the separator @var{SEP} is
279 converted to "\@var{SEP}".
280
281 @item csv
282 Perform CSV-like escaping, as described in RFC4180.  Strings
283 containing a newline ('\n'), a carriage return ('\r'), a double quote
284 ('"'), or @var{SEP} are enclosed in double-quotes.
285
286 @item none
287 Perform no escaping.
288 @end table
289
290 @item print_section, p
291 Print the section name at the begin of each line if the value is
292 @code{1}, disable it with value set to @code{0}. Default value is
293 @code{1}.
294
295 @end table
296
297 @section flat
298 Flat format.
299
300 A free-form output where each line contains an explicit key=value, such as
301 "streams.stream.3.tags.foo=bar". The output is shell escaped, so it can be
302 directly embedded in sh scripts as long as the separator character is an
303 alphanumeric character or an underscore (see @var{sep_char} option).
304
305 The description of the accepted options follows.
306
307 @table @option
308 @item sep_char, s
309 Separator character used to separate the chapter, the section name, IDs and
310 potential tags in the printed field key.
311
312 Default value is '.'.
313
314 @item hierarchical, h
315 Specify if the section name specification should be hierarchical. If
316 set to 1, and if there is more than one section in the current
317 chapter, the section name will be prefixed by the name of the
318 chapter. A value of 0 will disable this behavior.
319
320 Default value is 1.
321 @end table
322
323 @section ini
324 INI format output.
325
326 Print output in an INI based format.
327
328 The following conventions are adopted:
329
330 @itemize
331 @item
332 all key and values are UTF-8
333 @item
334 '.' is the subgroup separator
335 @item
336 newline, '\t', '\f', '\b' and the following characters are escaped
337 @item
338 '\' is the escape character
339 @item
340 '#' is the comment indicator
341 @item
342 '=' is the key/value separator
343 @item
344 ':' is not used but usually parsed as key/value separator
345 @end itemize
346
347 This writer accepts options as a list of @var{key}=@var{value} pairs,
348 separated by ":".
349
350 The description of the accepted options follows.
351
352 @table @option
353 @item hierarchical, h
354 Specify if the section name specification should be hierarchical. If
355 set to 1, and if there is more than one section in the current
356 chapter, the section name will be prefixed by the name of the
357 chapter. A value of 0 will disable this behavior.
358
359 Default value is 1.
360 @end table
361
362 @section json
363 JSON based format.
364
365 Each section is printed using JSON notation.
366
367 The description of the accepted options follows.
368
369 @table @option
370
371 @item compact, c
372 If set to 1 enable compact output, that is each section will be
373 printed on a single line. Default value is 0.
374 @end table
375
376 For more information about JSON, see @url{http://www.json.org/}.
377
378 @section xml
379 XML based format.
380
381 The XML output is described in the XML schema description file
382 @file{ffprobe.xsd} installed in the FFmpeg datadir.
383
384 An updated version of the schema can be retrieved at the url
385 @url{http://www.ffmpeg.org/schema/ffprobe.xsd}, which redirects to the
386 latest schema committed into the FFmpeg development source code tree.
387
388 Note that the output issued will be compliant to the
389 @file{ffprobe.xsd} schema only when no special global output options
390 (@option{unit}, @option{prefix}, @option{byte_binary_prefix},
391 @option{sexagesimal} etc.) are specified.
392
393 The description of the accepted options follows.
394
395 @table @option
396
397 @item fully_qualified, q
398 If set to 1 specify if the output should be fully qualified. Default
399 value is 0.
400 This is required for generating an XML file which can be validated
401 through an XSD file.
402
403 @item xsd_compliant, x
404 If set to 1 perform more checks for ensuring that the output is XSD
405 compliant. Default value is 0.
406 This option automatically sets @option{fully_qualified} to 1.
407 @end table
408
409 For more information about the XML format, see
410 @url{http://www.w3.org/XML/}.
411 @c man end WRITERS
412
413 @chapter Timecode
414 @c man begin TIMECODE
415
416 @command{ffprobe} supports Timecode extraction:
417
418 @itemize
419
420 @item
421 MPEG1/2 timecode is extracted from the GOP, and is available in the video
422 stream details (@option{-show_streams}, see @var{timecode}).
423
424 @item
425 MOV timecode is extracted from tmcd track, so is available in the tmcd
426 stream metadata (@option{-show_streams}, see @var{TAG:timecode}).
427
428 @item
429 DV, GXF and AVI timecodes are available in format metadata
430 (@option{-show_format}, see @var{TAG:timecode}).
431
432 @end itemize
433 @c man end TIMECODE
434
435 @include syntax.texi
436 @include decoders.texi
437 @include demuxers.texi
438 @include protocols.texi
439 @include indevs.texi
440
441 @ignore
442
443 @setfilename ffprobe
444 @settitle ffprobe media prober
445
446 @c man begin SEEALSO
447 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
448 @c man end
449
450 @c man begin AUTHORS
451 The FFmpeg developers
452 @c man end
453
454 @end ignore
455
456 @bye