ffprobe: show chapter and chapter metadata information
[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 ffprobe [@var{options}] [@file{input_file}]
15
16 @chapter Description
17 @c man begin DESCRIPTION
18
19 ffprobe gathers information from multimedia streams and prints it in
20 human- and machine-readable fashion.
21
22 For example it can be used to check the format of the container used
23 by a multimedia stream and the format and type of each media stream
24 contained in it.
25
26 If a filename is specified in input, ffprobe will try to open and
27 probe the file content. If the file cannot be opened or recognized as
28 a multimedia file, a positive exit code is returned.
29
30 ffprobe may be employed both as a standalone application or in
31 combination with a textual filter, which may perform more
32 sophisticated processing, e.g. statistical processing or plotting.
33
34 Options are used to list some of the formats supported by ffprobe or
35 for specifying which information to display, and for setting how
36 ffprobe will show it.
37
38 ffprobe output is designed to be easily parsable by a textual filter,
39 and consists of one or more sections of a form defined by the selected
40 writer, which is specified by the @option{print_format} option.
41
42 Sections may contain other nested sections, and are identified by a
43 name (which may be shared by other sections), and an unique
44 name. See the output of @option{sections}.
45
46 Metadata tags stored in the container or in the streams are recognized
47 and printed in the corresponding "FORMAT" or "STREAM" section.
48
49 @c man end
50
51 @chapter Options
52 @c man begin OPTIONS
53
54 @include avtools-common-opts.texi
55
56 @section Main options
57
58 @table @option
59
60 @item -f @var{format}
61 Force format to use.
62
63 @item -unit
64 Show the unit of the displayed values.
65
66 @item -prefix
67 Use SI prefixes for the displayed values.
68 Unless the "-byte_binary_prefix" option is used all the prefixes
69 are decimal.
70
71 @item -byte_binary_prefix
72 Force the use of binary prefixes for byte values.
73
74 @item -sexagesimal
75 Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
76
77 @item -pretty
78 Prettify the format of the displayed values, it corresponds to the
79 options "-unit -prefix -byte_binary_prefix -sexagesimal".
80
81 @item -of, -print_format @var{writer_name}[=@var{writer_options}]
82 Set the output printing format.
83
84 @var{writer_name} specifies the name of the writer, and
85 @var{writer_options} specifies the options to be passed to the writer.
86
87 For example for printing the output in JSON format, specify:
88 @example
89 -print_format json
90 @end example
91
92 For more details on the available output printing formats, see the
93 Writers section below.
94
95 @item -sections
96 Print sections structure and section information, and exit. The output
97 is not meant to be parsed by a machine.
98
99 @item -select_streams @var{stream_specifier}
100 Select only the streams specified by @var{stream_specifier}. This
101 option affects only the options related to streams
102 (e.g. @code{show_streams}, @code{show_packets}, etc.).
103
104 For example to show only audio streams, you can use the command:
105 @example
106 ffprobe -show_streams -select_streams a INPUT
107 @end example
108
109 To show only video packets belonging to the video stream with index 1:
110 @example
111 ffprobe -show_packets -select_streams v:1 INPUT
112 @end example
113
114 @item -show_data
115 Show payload data, as an hexadecimal and ASCII dump. Coupled with
116 @option{-show_packets}, it will dump the packets' data. Coupled with
117 @option{-show_streams}, it will dump the codec extradata.
118
119 The dump is printed as the "data" field. It may contain newlines.
120
121 @item -show_error
122 Show information about the error found when trying to probe the input.
123
124 The error information is printed within a section with name "ERROR".
125
126 @item -show_format
127 Show information about the container format of the input multimedia
128 stream.
129
130 All the container format information is printed within a section with
131 name "FORMAT".
132
133 @item -show_format_entry @var{name}
134 Like @option{-show_format}, but only prints the specified entry of the
135 container format information, rather than all. This option may be given more
136 than once, then all specified entries will be shown.
137
138 This option is deprecated, use @code{show_entries} instead.
139
140 @item -show_entries @var{section_entries}
141 Set list of entries to show.
142
143 Entries are specified according to the following
144 syntax. @var{section_entries} contains a list of section entries
145 separated by @code{:}. Each section entry is composed by a section
146 name (or unique name), optionally followed by a list of entries local
147 to that section, separated by @code{,}.
148
149 If section name is specified but is followed by no @code{=}, all
150 entries are printed to output, together with all the contained
151 sections. Otherwise only the entries specified in the local section
152 entries list are printed. In particular, if @code{=} is specified but
153 the list of local entries is empty, then no entries will be shown for
154 that section.
155
156 Note that the order of specification of the local section entries is
157 not honored in the output, and the usual display order will be
158 retained.
159
160 The formal syntax is given by:
161 @example
162 @var{LOCAL_SECTION_ENTRIES} ::= @var{SECTION_ENTRY_NAME}[,@var{LOCAL_SECTION_ENTRIES}]
163 @var{SECTION_ENTRY}         ::= @var{SECTION_NAME}[=[@var{LOCAL_SECTION_ENTRIES}]]
164 @var{SECTION_ENTRIES}       ::= @var{SECTION_ENTRY}[:@var{SECTION_ENTRIES}]
165 @end example
166
167 For example, to show only the index and type of each stream, and the PTS
168 time, duration time, and stream index of the packets, you can specify
169 the argument:
170 @example
171 packet=pts_time,duration_time,stream_index : stream=index,codec_type
172 @end example
173
174 To show all the entries in the section "format", but only the codec
175 type in the section "stream", specify the argument:
176 @example
177 format : stream=codec_type
178 @end example
179
180 To show all the tags in the stream and format sections:
181 @example
182 format_tags : format_tags
183 @end example
184
185 To show only the @code{title} tag (if available) in the stream
186 sections:
187 @example
188 stream_tags=title
189 @end example
190
191 @item -show_packets
192 Show information about each packet contained in the input multimedia
193 stream.
194
195 The information for each single packet is printed within a dedicated
196 section with name "PACKET".
197
198 @item -show_frames
199 Show information about each frame contained in the input multimedia
200 stream.
201
202 The information for each single frame is printed within a dedicated
203 section with name "FRAME".
204
205 @item -show_streams
206 Show information about each media stream contained in the input
207 multimedia stream.
208
209 Each media stream information is printed within a dedicated section
210 with name "STREAM".
211
212 @item -show_chapters
213 Show information about chapters stored in the format.
214
215 Each chapter is printed within a dedicated section with name "CHAPTER".
216
217 @item -count_frames
218 Count the number of frames per stream and report it in the
219 corresponding stream section.
220
221 @item -count_packets
222 Count the number of packets per stream and report it in the
223 corresponding stream section.
224
225 @item -show_private_data, -private
226 Show private data, that is data depending on the format of the
227 particular shown element.
228 This option is enabled by default, but you may need to disable it
229 for specific uses, for example when creating XSD-compliant XML output.
230
231 @item -show_program_version
232 Show information related to program version.
233
234 Version information is printed within a section with name
235 "PROGRAM_VERSION".
236
237 @item -show_library_versions
238 Show information related to library versions.
239
240 Version information for each library is printed within a section with
241 name "LIBRARY_VERSION".
242
243 @item -show_versions
244 Show information related to program and library versions. This is the
245 equivalent of setting both @option{-show_program_version} and
246 @option{-show_library_versions} options.
247
248 @item -bitexact
249 Force bitexact output, useful to produce output which is not dependent
250 on the specific build.
251
252 @item -i @var{input_file}
253 Read @var{input_file}.
254
255 @end table
256 @c man end
257
258 @chapter Writers
259 @c man begin WRITERS
260
261 A writer defines the output format adopted by @command{ffprobe}, and will be
262 used for printing all the parts of the output.
263
264 A writer may accept one or more arguments, which specify the options
265 to adopt. The options are specified as a list of @var{key}=@var{value}
266 pairs, separated by ":".
267
268 A description of the currently available writers follows.
269
270 @section default
271 Default format.
272
273 Print each section in the form:
274 @example
275 [SECTION]
276 key1=val1
277 ...
278 keyN=valN
279 [/SECTION]
280 @end example
281
282 Metadata tags are printed as a line in the corresponding FORMAT or
283 STREAM section, and are prefixed by the string "TAG:".
284
285 A description of the accepted options follows.
286
287 @table @option
288
289 @item nokey, nk
290 If set to 1 specify not to print the key of each field. Default value
291 is 0.
292
293 @item noprint_wrappers, nw
294 If set to 1 specify not to print the section header and footer.
295 Default value is 0.
296 @end table
297
298 @section compact, csv
299 Compact and CSV format.
300
301 The @code{csv} writer is equivalent to @code{compact}, but supports
302 different defaults.
303
304 Each section is printed on a single line.
305 If no option is specifid, the output has the form:
306 @example
307 section|key1=val1| ... |keyN=valN
308 @end example
309
310 Metadata tags are printed in the corresponding "format" or "stream"
311 section. A metadata tag key, if printed, is prefixed by the string
312 "tag:".
313
314 The description of the accepted options follows.
315
316 @table @option
317
318 @item item_sep, s
319 Specify the character to use for separating fields in the output line.
320 It must be a single printable character, it is "|" by default ("," for
321 the @code{csv} writer).
322
323 @item nokey, nk
324 If set to 1 specify not to print the key of each field. Its default
325 value is 0 (1 for the @code{csv} writer).
326
327 @item escape, e
328 Set the escape mode to use, default to "c" ("csv" for the @code{csv}
329 writer).
330
331 It can assume one of the following values:
332 @table @option
333 @item c
334 Perform C-like escaping. Strings containing a newline ('\n'), carriage
335 return ('\r'), a tab ('\t'), a form feed ('\f'), the escaping
336 character ('\') or the item separator character @var{SEP} are escaped using C-like fashioned
337 escaping, so that a newline is converted to the sequence "\n", a
338 carriage return to "\r", '\' to "\\" and the separator @var{SEP} is
339 converted to "\@var{SEP}".
340
341 @item csv
342 Perform CSV-like escaping, as described in RFC4180.  Strings
343 containing a newline ('\n'), a carriage return ('\r'), a double quote
344 ('"'), or @var{SEP} are enclosed in double-quotes.
345
346 @item none
347 Perform no escaping.
348 @end table
349
350 @item print_section, p
351 Print the section name at the begin of each line if the value is
352 @code{1}, disable it with value set to @code{0}. Default value is
353 @code{1}.
354
355 @end table
356
357 @section flat
358 Flat format.
359
360 A free-form output where each line contains an explicit key=value, such as
361 "streams.stream.3.tags.foo=bar". The output is shell escaped, so it can be
362 directly embedded in sh scripts as long as the separator character is an
363 alphanumeric character or an underscore (see @var{sep_char} option).
364
365 The description of the accepted options follows.
366
367 @table @option
368 @item sep_char, s
369 Separator character used to separate the chapter, the section name, IDs and
370 potential tags in the printed field key.
371
372 Default value is '.'.
373
374 @item hierarchical, h
375 Specify if the section name specification should be hierarchical. If
376 set to 1, and if there is more than one section in the current
377 chapter, the section name will be prefixed by the name of the
378 chapter. A value of 0 will disable this behavior.
379
380 Default value is 1.
381 @end table
382
383 @section ini
384 INI format output.
385
386 Print output in an INI based format.
387
388 The following conventions are adopted:
389
390 @itemize
391 @item
392 all key and values are UTF-8
393 @item
394 '.' is the subgroup separator
395 @item
396 newline, '\t', '\f', '\b' and the following characters are escaped
397 @item
398 '\' is the escape character
399 @item
400 '#' is the comment indicator
401 @item
402 '=' is the key/value separator
403 @item
404 ':' is not used but usually parsed as key/value separator
405 @end itemize
406
407 This writer accepts options as a list of @var{key}=@var{value} pairs,
408 separated by ":".
409
410 The description of the accepted options follows.
411
412 @table @option
413 @item hierarchical, h
414 Specify if the section name specification should be hierarchical. If
415 set to 1, and if there is more than one section in the current
416 chapter, the section name will be prefixed by the name of the
417 chapter. A value of 0 will disable this behavior.
418
419 Default value is 1.
420 @end table
421
422 @section json
423 JSON based format.
424
425 Each section is printed using JSON notation.
426
427 The description of the accepted options follows.
428
429 @table @option
430
431 @item compact, c
432 If set to 1 enable compact output, that is each section will be
433 printed on a single line. Default value is 0.
434 @end table
435
436 For more information about JSON, see @url{http://www.json.org/}.
437
438 @section xml
439 XML based format.
440
441 The XML output is described in the XML schema description file
442 @file{ffprobe.xsd} installed in the FFmpeg datadir.
443
444 An updated version of the schema can be retrieved at the url
445 @url{http://www.ffmpeg.org/schema/ffprobe.xsd}, which redirects to the
446 latest schema committed into the FFmpeg development source code tree.
447
448 Note that the output issued will be compliant to the
449 @file{ffprobe.xsd} schema only when no special global output options
450 (@option{unit}, @option{prefix}, @option{byte_binary_prefix},
451 @option{sexagesimal} etc.) are specified.
452
453 The description of the accepted options follows.
454
455 @table @option
456
457 @item fully_qualified, q
458 If set to 1 specify if the output should be fully qualified. Default
459 value is 0.
460 This is required for generating an XML file which can be validated
461 through an XSD file.
462
463 @item xsd_compliant, x
464 If set to 1 perform more checks for ensuring that the output is XSD
465 compliant. Default value is 0.
466 This option automatically sets @option{fully_qualified} to 1.
467 @end table
468
469 For more information about the XML format, see
470 @url{http://www.w3.org/XML/}.
471 @c man end WRITERS
472
473 @chapter Timecode
474 @c man begin TIMECODE
475
476 @command{ffprobe} supports Timecode extraction:
477
478 @itemize
479
480 @item
481 MPEG1/2 timecode is extracted from the GOP, and is available in the video
482 stream details (@option{-show_streams}, see @var{timecode}).
483
484 @item
485 MOV timecode is extracted from tmcd track, so is available in the tmcd
486 stream metadata (@option{-show_streams}, see @var{TAG:timecode}).
487
488 @item
489 DV, GXF and AVI timecodes are available in format metadata
490 (@option{-show_format}, see @var{TAG:timecode}).
491
492 @end itemize
493 @c man end TIMECODE
494
495 @include config.texi
496 @ifset config-all
497 @ifset config-avutil
498 @include utils.texi
499 @end ifset
500 @ifset config-avcodec
501 @include codecs.texi
502 @include bitstream_filters.texi
503 @end ifset
504 @ifset config-avformat
505 @include formats.texi
506 @include protocols.texi
507 @end ifset
508 @ifset config-avdevice
509 @include devices.texi
510 @end ifset
511 @ifset config-swresample
512 @include resampler.texi
513 @end ifset
514 @ifset config-swscale
515 @include scaler.texi
516 @end ifset
517 @ifset config-avfilter
518 @include filters.texi
519 @end ifset
520 @end ifset
521
522 @chapter See Also
523
524 @ifhtml
525 @ifset config-all
526 @url{ffprobe.html,ffprobe},
527 @end ifset
528 @ifset config-not-all
529 @url{ffprobe-all.html,ffprobe-all},
530 @end ifset
531 @url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffserver.html,ffserver},
532 @url{ffmpeg-utils.html,ffmpeg-utils},
533 @url{ffmpeg-scaler.html,ffmpeg-scaler},
534 @url{ffmpeg-resampler.html,ffmpeg-resampler},
535 @url{ffmpeg-codecs.html,ffmpeg-codecs},
536 @url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
537 @url{ffmpeg-formats.html,ffmpeg-formats},
538 @url{ffmpeg-devices.html,ffmpeg-devices},
539 @url{ffmpeg-protocols.html,ffmpeg-protocols},
540 @url{ffmpeg-filters.html,ffmpeg-filters}
541 @end ifhtml
542
543 @ifnothtml
544 @ifset config-all
545 ffprobe(1),
546 @end ifset
547 @ifset config-not-all
548 ffprobe-all(1),
549 @end ifset
550 ffmpeg(1), ffplay(1), ffserver(1),
551 ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
552 ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
553 ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
554 @end ifnothtml
555
556 @include authors.texi
557
558 @ignore
559
560 @setfilename ffprobe
561 @settitle ffprobe media prober
562
563 @end ignore
564
565 @bye