ffprobe: add print_section option to the compact writer
[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 @item print_section, p
272 Print the section name at the begin of each line if the value is
273 @code{1}, disable it with value set to @code{0}. Default value is
274 @code{1}.
275
276 @end table
277
278 @section csv
279 CSV format.
280
281 This writer is equivalent to
282 @code{compact=item_sep=,:nokey=1:escape=csv}.
283
284 @section flat
285 Flat format.
286
287 A free-form output where each line contains an explicit key=value, such as
288 "streams.stream.3.tags.foo=bar". The output is shell escaped, so it can be
289 directly embedded in sh scripts as long as the separator character is an
290 alphanumeric character or an underscore (see @var{sep_char} option).
291
292 This writer accepts options as a list of @var{key}=@var{value} pairs,
293 separated by ":".
294
295 The description of the accepted options follows.
296
297 @table @option
298 @item sep_char, s
299 Separator character used to separate the chapter, the section name, IDs and
300 potential tags in the printed field key.
301
302 Default value is '.'.
303
304 @item hierarchical, h
305 Specify if the section name specification should be hierarchical. If
306 set to 1, and if there is more than one section in the current
307 chapter, the section name will be prefixed by the name of the
308 chapter. A value of 0 will disable this behavior.
309
310 Default value is 1.
311 @end table
312
313 @section ini
314 INI format output.
315
316 Print output in an INI based format.
317
318 The following conventions are adopted:
319
320 @itemize
321 @item
322 all key and values are UTF-8
323 @item
324 '.' is the subgroup separator
325 @item
326 newline, '\t', '\f', '\b' and the following characters are escaped
327 @item
328 '\' is the escape character
329 @item
330 '#' is the comment indicator
331 @item
332 '=' is the key/value separator
333 @item
334 ':' is not used but usually parsed as key/value separator
335 @end itemize
336
337 This writer accepts options as a list of @var{key}=@var{value} pairs,
338 separated by ":".
339
340 The description of the accepted options follows.
341
342 @table @option
343 @item hierarchical, h
344 Specify if the section name specification should be hierarchical. If
345 set to 1, and if there is more than one section in the current
346 chapter, the section name will be prefixed by the name of the
347 chapter. A value of 0 will disable this behavior.
348
349 Default value is 1.
350 @end table
351
352 @section json
353 JSON based format.
354
355 Each section is printed using JSON notation.
356
357 This writer accepts options as a list of @var{key}=@var{value} pairs,
358 separated by ":".
359
360 The description of the accepted options follows.
361
362 @table @option
363
364 @item compact, c
365 If set to 1 enable compact output, that is each section will be
366 printed on a single line. Default value is 0.
367 @end table
368
369 For more information about JSON, see @url{http://www.json.org/}.
370
371 @section xml
372 XML based format.
373
374 The XML output is described in the XML schema description file
375 @file{ffprobe.xsd} installed in the FFmpeg datadir.
376
377 An updated version of the schema can be retrieved at the url
378 @url{http://www.ffmpeg.org/schema/ffprobe.xsd}, which redirects to the
379 latest schema committed into the FFmpeg development source code tree.
380
381 Note that the output issued will be compliant to the
382 @file{ffprobe.xsd} schema only when no special global output options
383 (@option{unit}, @option{prefix}, @option{byte_binary_prefix},
384 @option{sexagesimal} etc.) are specified.
385
386 This writer accepts options as a list of @var{key}=@var{value} pairs,
387 separated by ":".
388
389 The description of the accepted options follows.
390
391 @table @option
392
393 @item fully_qualified, q
394 If set to 1 specify if the output should be fully qualified. Default
395 value is 0.
396 This is required for generating an XML file which can be validated
397 through an XSD file.
398
399 @item xsd_compliant, x
400 If set to 1 perform more checks for ensuring that the output is XSD
401 compliant. Default value is 0.
402 This option automatically sets @option{fully_qualified} to 1.
403 @end table
404
405 For more information about the XML format, see
406 @url{http://www.w3.org/XML/}.
407 @c man end WRITERS
408
409 @chapter Timecode
410 @c man begin TIMECODE
411
412 @command{ffprobe} supports Timecode extraction:
413
414 @itemize
415
416 @item
417 MPEG1/2 timecode is extracted from the GOP, and is available in the video
418 stream details (@option{-show_streams}, see @var{timecode}).
419
420 @item
421 MOV timecode is extracted from tmcd track, so is available in the tmcd
422 stream metadata (@option{-show_streams}, see @var{TAG:timecode}).
423
424 @item
425 DV, GXF and AVI timecodes are available in format metadata
426 (@option{-show_format}, see @var{TAG:timecode}).
427
428 @end itemize
429 @c man end TIMECODE
430
431 @include syntax.texi
432 @include decoders.texi
433 @include demuxers.texi
434 @include protocols.texi
435 @include indevs.texi
436
437 @ignore
438
439 @setfilename ffprobe
440 @settitle ffprobe media prober
441
442 @c man begin SEEALSO
443 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
444 @c man end
445
446 @c man begin AUTHORS
447 The FFmpeg developers
448 @c man end
449
450 @end ignore
451
452 @bye