ffprobe: add "noprint_wrappers" option to default 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 -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_error
98 Show information about the error found when trying to probe the input.
99
100 The error information is printed within a section with name "ERROR".
101
102 @item -show_format
103 Show information about the container format of the input multimedia
104 stream.
105
106 All the container format information is printed within a section with
107 name "FORMAT".
108
109 @item -show_format_entry @var{name}
110 Like @option{-show_format}, but only prints the specified entry of the
111 container format information, rather than all. This option may be given more
112 than once, then all specified entries will be shown.
113
114 @item -show_packets
115 Show information about each packet contained in the input multimedia
116 stream.
117
118 The information for each single packet is printed within a dedicated
119 section with name "PACKET".
120
121 @item -show_frames
122 Show information about each frame contained in the input multimedia
123 stream.
124
125 The information for each single frame is printed within a dedicated
126 section with name "FRAME".
127
128 @item -show_streams
129 Show information about each media stream contained in the input
130 multimedia stream.
131
132 Each media stream information is printed within a dedicated section
133 with name "STREAM".
134
135 @item -count_frames
136 Count the number of frames per stream and report it in the
137 corresponding stream section.
138
139 @item -count_packets
140 Count the number of packets per stream and report it in the
141 corresponding stream section.
142
143 @item -show_private_data, -private
144 Show private data, that is data depending on the format of the
145 particular shown element.
146 This option is enabled by default, but you may need to disable it
147 for specific uses, for example when creating XSD-compliant XML output.
148
149 @item -show_program_version
150 Show information related to program version.
151
152 Version information is printed within a section with name
153 "PROGRAM_VERSION".
154
155 @item -show_library_versions
156 Show information related to library versions.
157
158 Version information for each library is printed within a section with
159 name "LIBRARY_VERSION".
160
161 @item -show_versions
162 Show information related to program and library versions. This is the
163 equivalent of setting both @option{-show_program_version} and
164 @option{-show_library_versions} options.
165
166 @item -i @var{input_file}
167 Read @var{input_file}.
168
169 @end table
170 @c man end
171
172 @chapter Writers
173 @c man begin WRITERS
174
175 A writer defines the output format adopted by @command{ffprobe}, and will be
176 used for printing all the parts of the output.
177
178 A writer may accept one or more arguments, which specify the options to
179 adopt.
180
181 A description of the currently available writers follows.
182
183 @section default
184 Default format.
185
186 Print each section in the form:
187 @example
188 [SECTION]
189 key1=val1
190 ...
191 keyN=valN
192 [/SECTION]
193 @end example
194
195 Metadata tags are printed as a line in the corresponding FORMAT or
196 STREAM section, and are prefixed by the string "TAG:".
197
198 This writer accepts options as a list of @var{key}=@var{value} pairs,
199 separated by ":".
200
201 A description of the accepted options follows.
202
203 @table @option
204
205 @item noprint_wrappers, nw
206 If set to 1 specify not to print the section header and footer.
207 Default value is 0.
208
209 @end table
210
211 @section compact
212 Compact format.
213
214 Each section is printed on a single line.
215 If no option is specifid, the output has the form:
216 @example
217 section|key1=val1| ... |keyN=valN
218 @end example
219
220 Metadata tags are printed in the corresponding "format" or "stream"
221 section. A metadata tag key, if printed, is prefixed by the string
222 "tag:".
223
224 This writer accepts options as a list of @var{key}=@var{value} pairs,
225 separated by ":".
226
227 The description of the accepted options follows.
228
229 @table @option
230
231 @item item_sep, s
232 Specify the character to use for separating fields in the output line.
233 It must be a single printable character, it is "|" by default.
234
235 @item nokey, nk
236 If set to 1 specify not to print the key of each field. Its default
237 value is 0.
238
239 @item escape, e
240 Set the escape mode to use, default to "c".
241
242 It can assume one of the following values:
243 @table @option
244 @item c
245 Perform C-like escaping. Strings containing a newline ('\n') or
246 carriage return ('\r'), the escaping character ('\') or the item
247 separator character @var{SEP} are escaped using C-like fashioned
248 escaping, so that a newline is converted to the sequence "\n", a
249 carriage return to "\r", '\' to "\\" and the separator @var{SEP} is
250 converted to "\@var{SEP}".
251
252 @item csv
253 Perform CSV-like escaping, as described in RFC4180.  Strings
254 containing a newline ('\n'), a carriage return ('\r'), a double quote
255 ('"'), or @var{SEP} are enclosed in double-quotes.
256
257 @item none
258 Perform no escaping.
259 @end table
260
261 @end table
262
263 @section csv
264 CSV format.
265
266 This writer is equivalent to
267 @code{compact=item_sep=,:nokey=1:escape=csv}.
268
269 @section json
270 JSON based format.
271
272 Each section is printed using JSON notation.
273
274 This writer accepts options as a list of @var{key}=@var{value} pairs,
275 separated by ":".
276
277 The description of the accepted options follows.
278
279 @table @option
280
281 @item compact, c
282 If set to 1 enable compact output, that is each section will be
283 printed on a single line. Default value is 0.
284 @end table
285
286 For more information about JSON, see @url{http://www.json.org/}.
287
288 @section xml
289 XML based format.
290
291 The XML output is described in the XML schema description file
292 @file{ffprobe.xsd} installed in the FFmpeg datadir.
293
294 Note that the output issued will be compliant to the
295 @file{ffprobe.xsd} schema only when no special global output options
296 (@option{unit}, @option{prefix}, @option{byte_binary_prefix},
297 @option{sexagesimal} etc.) are specified.
298
299 This writer accepts options as a list of @var{key}=@var{value} pairs,
300 separated by ":".
301
302 The description of the accepted options follows.
303
304 @table @option
305
306 @item fully_qualified, q
307 If set to 1 specify if the output should be fully qualified. Default
308 value is 0.
309 This is required for generating an XML file which can be validated
310 through an XSD file.
311
312 @item xsd_compliant, x
313 If set to 1 perform more checks for ensuring that the output is XSD
314 compliant. Default value is 0.
315 This option automatically sets @option{fully_qualified} to 1.
316 @end table
317
318 For more information about the XML format, see
319 @url{http://www.w3.org/XML/}.
320
321 @chapter Timecode
322
323 @command{ffprobe} supports Timecode extraction:
324
325 @itemize
326
327 @item MPEG1/2 timecode is extracted from the GOP, and is available in the video
328 stream details (@option{-show_streams}, see @var{timecode}).
329
330 @item MOV timecode is extracted from tmcd track, so is available in the tmcd
331 stream metadata (@option{-show_streams}, see @var{TAG:timecode}).
332
333 @item DV and GXF timecodes are available in format metadata
334 (@option{-show_format}, see @var{TAG:timecode}).
335
336 @end itemize
337
338 @c man end WRITERS
339
340 @include decoders.texi
341 @include demuxers.texi
342 @include protocols.texi
343 @include indevs.texi
344
345 @ignore
346
347 @setfilename ffprobe
348 @settitle ffprobe media prober
349
350 @c man begin SEEALSO
351 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
352 @c man end
353
354 @c man begin AUTHORS
355 The FFmpeg developers
356 @c man end
357
358 @end ignore
359
360 @bye