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