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