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