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