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