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