ffprobe: add -select_streams 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 @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 to
205 adopt.
206
207 A description of the currently available writers follows.
208
209 @section default
210 Default format.
211
212 Print each section in the form:
213 @example
214 [SECTION]
215 key1=val1
216 ...
217 keyN=valN
218 [/SECTION]
219 @end example
220
221 Metadata tags are printed as a line in the corresponding FORMAT or
222 STREAM section, and are prefixed by the string "TAG:".
223
224 This writer accepts options as a list of @var{key}=@var{value} pairs,
225 separated by ":".
226
227 A description of the accepted options follows.
228
229 @table @option
230
231 @item nokey, nk
232 If set to 1 specify not to print the key of each field. Default value
233 is 0.
234
235 @item noprint_wrappers, nw
236 If set to 1 specify not to print the section header and footer.
237 Default value is 0.
238 @end table
239
240 @section compact, csv
241 Compact and CSV format.
242
243 The @code{csv} writer is equivalent to @code{compact}, but supports
244 different defaults.
245
246 Each section is printed on a single line.
247 If no option is specifid, the output has the form:
248 @example
249 section|key1=val1| ... |keyN=valN
250 @end example
251
252 Metadata tags are printed in the corresponding "format" or "stream"
253 section. A metadata tag key, if printed, is prefixed by the string
254 "tag:".
255
256 This writer accepts options as a list of @var{key}=@var{value} pairs,
257 separated by ":".
258
259 The description of the accepted options follows.
260
261 @table @option
262
263 @item item_sep, s
264 Specify the character to use for separating fields in the output line.
265 It must be a single printable character, it is "|" by default ("," for
266 the @code{csv} writer).
267
268 @item nokey, nk
269 If set to 1 specify not to print the key of each field. Its default
270 value is 0 (1 for the @code{csv} writer).
271
272 @item escape, e
273 Set the escape mode to use, default to "c" ("csv" for the @code{csv}
274 writer).
275
276 It can assume one of the following values:
277 @table @option
278 @item c
279 Perform C-like escaping. Strings containing a newline ('\n'), carriage
280 return ('\r'), a tab ('\t'), a form feed ('\f'), the escaping
281 character ('\') or the item separator character @var{SEP} are escaped using C-like fashioned
282 escaping, so that a newline is converted to the sequence "\n", a
283 carriage return to "\r", '\' to "\\" and the separator @var{SEP} is
284 converted to "\@var{SEP}".
285
286 @item csv
287 Perform CSV-like escaping, as described in RFC4180.  Strings
288 containing a newline ('\n'), a carriage return ('\r'), a double quote
289 ('"'), or @var{SEP} are enclosed in double-quotes.
290
291 @item none
292 Perform no escaping.
293 @end table
294
295 @item print_section, p
296 Print the section name at the begin of each line if the value is
297 @code{1}, disable it with value set to @code{0}. Default value is
298 @code{1}.
299
300 @end table
301
302 @section flat
303 Flat format.
304
305 A free-form output where each line contains an explicit key=value, such as
306 "streams.stream.3.tags.foo=bar". The output is shell escaped, so it can be
307 directly embedded in sh scripts as long as the separator character is an
308 alphanumeric character or an underscore (see @var{sep_char} option).
309
310 This writer accepts options as a list of @var{key}=@var{value} pairs,
311 separated by ":".
312
313 The description of the accepted options follows.
314
315 @table @option
316 @item sep_char, s
317 Separator character used to separate the chapter, the section name, IDs and
318 potential tags in the printed field key.
319
320 Default value is '.'.
321
322 @item hierarchical, h
323 Specify if the section name specification should be hierarchical. If
324 set to 1, and if there is more than one section in the current
325 chapter, the section name will be prefixed by the name of the
326 chapter. A value of 0 will disable this behavior.
327
328 Default value is 1.
329 @end table
330
331 @section ini
332 INI format output.
333
334 Print output in an INI based format.
335
336 The following conventions are adopted:
337
338 @itemize
339 @item
340 all key and values are UTF-8
341 @item
342 '.' is the subgroup separator
343 @item
344 newline, '\t', '\f', '\b' and the following characters are escaped
345 @item
346 '\' is the escape character
347 @item
348 '#' is the comment indicator
349 @item
350 '=' is the key/value separator
351 @item
352 ':' is not used but usually parsed as key/value separator
353 @end itemize
354
355 This writer accepts options as a list of @var{key}=@var{value} pairs,
356 separated by ":".
357
358 The description of the accepted options follows.
359
360 @table @option
361 @item hierarchical, h
362 Specify if the section name specification should be hierarchical. If
363 set to 1, and if there is more than one section in the current
364 chapter, the section name will be prefixed by the name of the
365 chapter. A value of 0 will disable this behavior.
366
367 Default value is 1.
368 @end table
369
370 @section json
371 JSON based format.
372
373 Each section is printed using JSON notation.
374
375 This writer accepts options as a list of @var{key}=@var{value} pairs,
376 separated by ":".
377
378 The description of the accepted options follows.
379
380 @table @option
381
382 @item compact, c
383 If set to 1 enable compact output, that is each section will be
384 printed on a single line. Default value is 0.
385 @end table
386
387 For more information about JSON, see @url{http://www.json.org/}.
388
389 @section xml
390 XML based format.
391
392 The XML output is described in the XML schema description file
393 @file{ffprobe.xsd} installed in the FFmpeg datadir.
394
395 An updated version of the schema can be retrieved at the url
396 @url{http://www.ffmpeg.org/schema/ffprobe.xsd}, which redirects to the
397 latest schema committed into the FFmpeg development source code tree.
398
399 Note that the output issued will be compliant to the
400 @file{ffprobe.xsd} schema only when no special global output options
401 (@option{unit}, @option{prefix}, @option{byte_binary_prefix},
402 @option{sexagesimal} etc.) are specified.
403
404 This writer accepts options as a list of @var{key}=@var{value} pairs,
405 separated by ":".
406
407 The description of the accepted options follows.
408
409 @table @option
410
411 @item fully_qualified, q
412 If set to 1 specify if the output should be fully qualified. Default
413 value is 0.
414 This is required for generating an XML file which can be validated
415 through an XSD file.
416
417 @item xsd_compliant, x
418 If set to 1 perform more checks for ensuring that the output is XSD
419 compliant. Default value is 0.
420 This option automatically sets @option{fully_qualified} to 1.
421 @end table
422
423 For more information about the XML format, see
424 @url{http://www.w3.org/XML/}.
425 @c man end WRITERS
426
427 @chapter Timecode
428 @c man begin TIMECODE
429
430 @command{ffprobe} supports Timecode extraction:
431
432 @itemize
433
434 @item
435 MPEG1/2 timecode is extracted from the GOP, and is available in the video
436 stream details (@option{-show_streams}, see @var{timecode}).
437
438 @item
439 MOV timecode is extracted from tmcd track, so is available in the tmcd
440 stream metadata (@option{-show_streams}, see @var{TAG:timecode}).
441
442 @item
443 DV, GXF and AVI timecodes are available in format metadata
444 (@option{-show_format}, see @var{TAG:timecode}).
445
446 @end itemize
447 @c man end TIMECODE
448
449 @include syntax.texi
450 @include decoders.texi
451 @include demuxers.texi
452 @include protocols.texi
453 @include indevs.texi
454
455 @ignore
456
457 @setfilename ffprobe
458 @settitle ffprobe media prober
459
460 @c man begin SEEALSO
461 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
462 @c man end
463
464 @c man begin AUTHORS
465 The FFmpeg developers
466 @c man end
467
468 @end ignore
469
470 @bye