3 <!-- Created on December 14, 2013 by texi2html 1.82 -->
5 texi2html was written by:
6 Lionel Cons <Lionel.Cons@cern.ch> (original author)
7 Karl Berry <karl@freefriends.org>
8 Olaf Bachmann <obachman@mathematik.uni-kl.de>
10 Maintained by: Many creative people.
11 Send bugs and suggestions to <texi2html-bug@nongnu.org>
15 <title>FFmpeg documentation : ffprobe </title>
17 <meta name="description" content="ffprobe Documentation: ">
18 <meta name="keywords" content="FFmpeg documentation : ffprobe ">
19 <meta name="Generator" content="texi2html 1.82">
20 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
21 <link rel="stylesheet" type="text/css" href="default.css" />
23 <link rel="icon" href="favicon.png" type="image/png" />
29 <a name="SEC_Top"></a>
30 <h1 class="settitle">ffprobe Documentation</h1>
32 <a name="SEC_Contents"></a>
33 <h1>Table of Contents</h1>
34 <div class="contents">
37 <li><a name="toc-Synopsis" href="#Synopsis">1. Synopsis</a></li>
38 <li><a name="toc-Description" href="#Description">2. Description</a></li>
39 <li><a name="toc-Options" href="#Options">3. Options</a>
41 <li><a name="toc-Stream-specifiers-1" href="#Stream-specifiers-1">3.1 Stream specifiers</a></li>
42 <li><a name="toc-Generic-options" href="#Generic-options">3.2 Generic options</a></li>
43 <li><a name="toc-AVOptions" href="#AVOptions">3.3 AVOptions</a></li>
44 <li><a name="toc-Main-options" href="#Main-options">3.4 Main options</a></li>
46 <li><a name="toc-Writers" href="#Writers">4. Writers</a>
48 <li><a name="toc-default" href="#default">4.1 default</a></li>
49 <li><a name="toc-compact_002c-csv" href="#compact_002c-csv">4.2 compact, csv</a></li>
50 <li><a name="toc-flat" href="#flat">4.3 flat</a></li>
51 <li><a name="toc-ini" href="#ini">4.4 ini</a></li>
52 <li><a name="toc-json" href="#json">4.5 json</a></li>
53 <li><a name="toc-xml" href="#xml">4.6 xml</a></li>
55 <li><a name="toc-Timecode" href="#Timecode">5. Timecode</a></li>
56 <li><a name="toc-See-Also" href="#See-Also">6. See Also</a></li>
57 <li><a name="toc-Authors" href="#Authors">7. Authors</a></li>
61 <a name="Synopsis"></a>
62 <h1 class="chapter"><a href="ffprobe.html#toc-Synopsis">1. Synopsis</a></h1>
64 <p>ffprobe [<var>options</var>] [‘<tt>input_file</tt>’]
66 <a name="Description"></a>
67 <h1 class="chapter"><a href="ffprobe.html#toc-Description">2. Description</a></h1>
69 <p>ffprobe gathers information from multimedia streams and prints it in
70 human- and machine-readable fashion.
72 <p>For example it can be used to check the format of the container used
73 by a multimedia stream and the format and type of each media stream
76 <p>If a filename is specified in input, ffprobe will try to open and
77 probe the file content. If the file cannot be opened or recognized as
78 a multimedia file, a positive exit code is returned.
80 <p>ffprobe may be employed both as a standalone application or in
81 combination with a textual filter, which may perform more
82 sophisticated processing, e.g. statistical processing or plotting.
84 <p>Options are used to list some of the formats supported by ffprobe or
85 for specifying which information to display, and for setting how
88 <p>ffprobe output is designed to be easily parsable by a textual filter,
89 and consists of one or more sections of a form defined by the selected
90 writer, which is specified by the ‘<samp>print_format</samp>’ option.
92 <p>Sections may contain other nested sections, and are identified by a
93 name (which may be shared by other sections), and an unique
94 name. See the output of ‘<samp>sections</samp>’.
96 <p>Metadata tags stored in the container or in the streams are recognized
97 and printed in the corresponding "FORMAT", "STREAM" or "PROGRAM_STREAM"
101 <a name="Options"></a>
102 <h1 class="chapter"><a href="ffprobe.html#toc-Options">3. Options</a></h1>
104 <p>All the numerical options, if not specified otherwise, accept a string
105 representing a number as input, which may be followed by one of the SI
106 unit prefixes, for example: ’K’, ’M’, or ’G’.
108 <p>If ’i’ is appended to the SI unit prefix, the complete prefix will be
109 interpreted as a unit prefix for binary multiplies, which are based on
110 powers of 1024 instead of powers of 1000. Appending ’B’ to the SI unit
111 prefix multiplies the value by 8. This allows using, for example:
112 ’KB’, ’MiB’, ’G’ and ’B’ as number suffixes.
114 <p>Options which do not take arguments are boolean options, and set the
115 corresponding value to true. They can be set to false by prefixing
116 the option name with "no". For example using "-nofoo"
117 will set the boolean option with name "foo" to false.
119 <p><a name="Stream-specifiers"></a>
120 </p><a name="Stream-specifiers-1"></a>
121 <h2 class="section"><a href="ffprobe.html#toc-Stream-specifiers-1">3.1 Stream specifiers</a></h2>
122 <p>Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
123 are used to precisely specify which stream(s) a given option belongs to.
125 <p>A stream specifier is a string generally appended to the option name and
126 separated from it by a colon. E.g. <code>-codec:a:1 ac3</code> contains the
127 <code>a:1</code> stream specifier, which matches the second audio stream. Therefore, it
128 would select the ac3 codec for the second audio stream.
130 <p>A stream specifier can match several streams, so that the option is applied to all
131 of them. E.g. the stream specifier in <code>-b:a 128k</code> matches all audio
134 <p>An empty stream specifier matches all streams. For example, <code>-codec copy</code>
135 or <code>-codec: copy</code> would copy all the streams without reencoding.
137 <p>Possible forms of stream specifiers are:
138 </p><dl compact="compact">
139 <dt> ‘<samp><var>stream_index</var></samp>’</dt>
140 <dd><p>Matches the stream with this index. E.g. <code>-threads:1 4</code> would set the
141 thread count for the second stream to 4.
143 <dt> ‘<samp><var>stream_type</var>[:<var>stream_index</var>]</samp>’</dt>
144 <dd><p><var>stream_type</var> is one of following: ’v’ for video, ’a’ for audio, ’s’ for subtitle,
145 ’d’ for data, and ’t’ for attachments. If <var>stream_index</var> is given, then it matches
146 stream number <var>stream_index</var> of this type. Otherwise, it matches all
147 streams of this type.
149 <dt> ‘<samp>p:<var>program_id</var>[:<var>stream_index</var>]</samp>’</dt>
150 <dd><p>If <var>stream_index</var> is given, then it matches the stream with number <var>stream_index</var>
151 in the program with the id <var>program_id</var>. Otherwise, it matches all streams in the
154 <dt> ‘<samp>#<var>stream_id</var></samp>’</dt>
155 <dd><p>Matches the stream by a format-specific ID.
159 <a name="Generic-options"></a>
160 <h2 class="section"><a href="ffprobe.html#toc-Generic-options">3.2 Generic options</a></h2>
162 <p>These options are shared amongst the ff* tools.
164 <dl compact="compact">
165 <dt> ‘<samp>-L</samp>’</dt>
169 <dt> ‘<samp>-h, -?, -help, --help [<var>arg</var>]</samp>’</dt>
170 <dd><p>Show help. An optional parameter may be specified to print help about a specific
171 item. If no argument is specified, only basic (non advanced) tool
174 <p>Possible values of <var>arg</var> are:
175 </p><dl compact="compact">
176 <dt> ‘<samp>long</samp>’</dt>
177 <dd><p>Print advanced tool options in addition to the basic tool options.
180 <dt> ‘<samp>full</samp>’</dt>
181 <dd><p>Print complete list of options, including shared and private options
182 for encoders, decoders, demuxers, muxers, filters, etc.
185 <dt> ‘<samp>decoder=<var>decoder_name</var></samp>’</dt>
186 <dd><p>Print detailed information about the decoder named <var>decoder_name</var>. Use the
187 ‘<samp>-decoders</samp>’ option to get a list of all decoders.
190 <dt> ‘<samp>encoder=<var>encoder_name</var></samp>’</dt>
191 <dd><p>Print detailed information about the encoder named <var>encoder_name</var>. Use the
192 ‘<samp>-encoders</samp>’ option to get a list of all encoders.
195 <dt> ‘<samp>demuxer=<var>demuxer_name</var></samp>’</dt>
196 <dd><p>Print detailed information about the demuxer named <var>demuxer_name</var>. Use the
197 ‘<samp>-formats</samp>’ option to get a list of all demuxers and muxers.
200 <dt> ‘<samp>muxer=<var>muxer_name</var></samp>’</dt>
201 <dd><p>Print detailed information about the muxer named <var>muxer_name</var>. Use the
202 ‘<samp>-formats</samp>’ option to get a list of all muxers and demuxers.
205 <dt> ‘<samp>filter=<var>filter_name</var></samp>’</dt>
206 <dd><p>Print detailed information about the filter name <var>filter_name</var>. Use the
207 ‘<samp>-filters</samp>’ option to get a list of all filters.
212 <dt> ‘<samp>-version</samp>’</dt>
216 <dt> ‘<samp>-formats</samp>’</dt>
217 <dd><p>Show available formats.
220 <dt> ‘<samp>-codecs</samp>’</dt>
221 <dd><p>Show all codecs known to libavcodec.
223 <p>Note that the term ’codec’ is used throughout this documentation as a shortcut
224 for what is more correctly called a media bitstream format.
227 <dt> ‘<samp>-decoders</samp>’</dt>
228 <dd><p>Show available decoders.
231 <dt> ‘<samp>-encoders</samp>’</dt>
232 <dd><p>Show all available encoders.
235 <dt> ‘<samp>-bsfs</samp>’</dt>
236 <dd><p>Show available bitstream filters.
239 <dt> ‘<samp>-protocols</samp>’</dt>
240 <dd><p>Show available protocols.
243 <dt> ‘<samp>-filters</samp>’</dt>
244 <dd><p>Show available libavfilter filters.
247 <dt> ‘<samp>-pix_fmts</samp>’</dt>
248 <dd><p>Show available pixel formats.
251 <dt> ‘<samp>-sample_fmts</samp>’</dt>
252 <dd><p>Show available sample formats.
255 <dt> ‘<samp>-layouts</samp>’</dt>
256 <dd><p>Show channel names and standard channel layouts.
259 <dt> ‘<samp>-colors</samp>’</dt>
260 <dd><p>Show recognized color names.
263 <dt> ‘<samp>-loglevel [repeat+]<var>loglevel</var> | -v [repeat+]<var>loglevel</var></samp>’</dt>
264 <dd><p>Set the logging level used by the library.
265 Adding "repeat+" indicates that repeated log output should not be compressed
266 to the first line and the "Last message repeated n times" line will be
267 omitted. "repeat" can also be used alone.
268 If "repeat" is used alone, and with no prior loglevel set, the default
269 loglevel will be used. If multiple loglevel parameters are given, using
270 ’repeat’ will not change the loglevel.
271 <var>loglevel</var> is a number or a string containing one of the following values:
272 </p><dl compact="compact">
273 <dt> ‘<samp>quiet</samp>’</dt>
274 <dd><p>Show nothing at all; be silent.
276 <dt> ‘<samp>panic</samp>’</dt>
277 <dd><p>Only show fatal errors which could lead the process to crash, such as
278 and assert failure. This is not currently used for anything.
280 <dt> ‘<samp>fatal</samp>’</dt>
281 <dd><p>Only show fatal errors. These are errors after which the process absolutely
282 cannot continue after.
284 <dt> ‘<samp>error</samp>’</dt>
285 <dd><p>Show all errors, including ones which can be recovered from.
287 <dt> ‘<samp>warning</samp>’</dt>
288 <dd><p>Show all warnings and errors. Any message related to possibly
289 incorrect or unexpected events will be shown.
291 <dt> ‘<samp>info</samp>’</dt>
292 <dd><p>Show informative messages during processing. This is in addition to
293 warnings and errors. This is the default value.
295 <dt> ‘<samp>verbose</samp>’</dt>
296 <dd><p>Same as <code>info</code>, except more verbose.
298 <dt> ‘<samp>debug</samp>’</dt>
299 <dd><p>Show everything, including debugging information.
303 <p>By default the program logs to stderr, if coloring is supported by the
304 terminal, colors are used to mark errors and warnings. Log coloring
305 can be disabled setting the environment variable
306 <code>AV_LOG_FORCE_NOCOLOR</code> or <code>NO_COLOR</code>, or can be forced setting
307 the environment variable <code>AV_LOG_FORCE_COLOR</code>.
308 The use of the environment variable <code>NO_COLOR</code> is deprecated and
309 will be dropped in a following FFmpeg version.
312 <dt> ‘<samp>-report</samp>’</dt>
313 <dd><p>Dump full command line and console output to a file named
314 <code><var>program</var>-<var>YYYYMMDD</var>-<var>HHMMSS</var>.log</code> in the current
316 This file can be useful for bug reports.
317 It also implies <code>-loglevel verbose</code>.
319 <p>Setting the environment variable <code>FFREPORT</code> to any value has the
320 same effect. If the value is a ’:’-separated key=value sequence, these
321 options will affect the report; options values must be escaped if they
322 contain special characters or the options delimiter ’:’ (see the
323 “Quoting and escaping” section in the ffmpeg-utils manual). The
324 following option is recognized:
325 </p><dl compact="compact">
326 <dt> ‘<samp>file</samp>’</dt>
327 <dd><p>set the file name to use for the report; <code>%p</code> is expanded to the name
328 of the program, <code>%t</code> is expanded to a timestamp, <code>%%</code> is expanded
329 to a plain <code>%</code>
333 <p>Errors in parsing the environment variable are not fatal, and will not
334 appear in the report.
337 <dt> ‘<samp>-cpuflags flags (<em>global</em>)</samp>’</dt>
338 <dd><p>Allows setting and clearing cpu flags. This option is intended
339 for testing. Do not use it unless you know what you’re doing.
340 </p><table><tr><td> </td><td><pre class="example">ffmpeg -cpuflags -sse+mmx ...
341 ffmpeg -cpuflags mmx ...
342 ffmpeg -cpuflags 0 ...
343 </pre></td></tr></table>
344 <p>Possible flags for this option are:
345 </p><dl compact="compact">
346 <dt> ‘<samp>x86</samp>’</dt>
347 <dd><dl compact="compact">
348 <dt> ‘<samp>mmx</samp>’</dt>
349 <dt> ‘<samp>mmxext</samp>’</dt>
350 <dt> ‘<samp>sse</samp>’</dt>
351 <dt> ‘<samp>sse2</samp>’</dt>
352 <dt> ‘<samp>sse2slow</samp>’</dt>
353 <dt> ‘<samp>sse3</samp>’</dt>
354 <dt> ‘<samp>sse3slow</samp>’</dt>
355 <dt> ‘<samp>ssse3</samp>’</dt>
356 <dt> ‘<samp>atom</samp>’</dt>
357 <dt> ‘<samp>sse4.1</samp>’</dt>
358 <dt> ‘<samp>sse4.2</samp>’</dt>
359 <dt> ‘<samp>avx</samp>’</dt>
360 <dt> ‘<samp>xop</samp>’</dt>
361 <dt> ‘<samp>fma4</samp>’</dt>
362 <dt> ‘<samp>3dnow</samp>’</dt>
363 <dt> ‘<samp>3dnowext</samp>’</dt>
364 <dt> ‘<samp>cmov</samp>’</dt>
367 <dt> ‘<samp>ARM</samp>’</dt>
368 <dd><dl compact="compact">
369 <dt> ‘<samp>armv5te</samp>’</dt>
370 <dt> ‘<samp>armv6</samp>’</dt>
371 <dt> ‘<samp>armv6t2</samp>’</dt>
372 <dt> ‘<samp>vfp</samp>’</dt>
373 <dt> ‘<samp>vfpv3</samp>’</dt>
374 <dt> ‘<samp>neon</samp>’</dt>
377 <dt> ‘<samp>PowerPC</samp>’</dt>
378 <dd><dl compact="compact">
379 <dt> ‘<samp>altivec</samp>’</dt>
382 <dt> ‘<samp>Specific Processors</samp>’</dt>
383 <dd><dl compact="compact">
384 <dt> ‘<samp>pentium2</samp>’</dt>
385 <dt> ‘<samp>pentium3</samp>’</dt>
386 <dt> ‘<samp>pentium4</samp>’</dt>
387 <dt> ‘<samp>k6</samp>’</dt>
388 <dt> ‘<samp>k62</samp>’</dt>
389 <dt> ‘<samp>athlon</samp>’</dt>
390 <dt> ‘<samp>athlonxp</samp>’</dt>
391 <dt> ‘<samp>k8</samp>’</dt>
397 <dt> ‘<samp>-opencl_bench</samp>’</dt>
398 <dd><p>Benchmark all available OpenCL devices and show the results. This option
399 is only available when FFmpeg has been compiled with <code>--enable-opencl</code>.
402 <dt> ‘<samp>-opencl_options options (<em>global</em>)</samp>’</dt>
403 <dd><p>Set OpenCL environment options. This option is only available when
404 FFmpeg has been compiled with <code>--enable-opencl</code>.
406 <p><var>options</var> must be a list of <var>key</var>=<var>value</var> option pairs
407 separated by ’:’. See the “OpenCL Options” section in the
408 ffmpeg-utils manual for the list of supported options.
412 <a name="AVOptions"></a>
413 <h2 class="section"><a href="ffprobe.html#toc-AVOptions">3.3 AVOptions</a></h2>
415 <p>These options are provided directly by the libavformat, libavdevice and
416 libavcodec libraries. To see the list of available AVOptions, use the
417 ‘<samp>-help</samp>’ option. They are separated into two categories:
418 </p><dl compact="compact">
419 <dt> ‘<samp>generic</samp>’</dt>
420 <dd><p>These options can be set for any container, codec or device. Generic options
421 are listed under AVFormatContext options for containers/devices and under
422 AVCodecContext options for codecs.
424 <dt> ‘<samp>private</samp>’</dt>
425 <dd><p>These options are specific to the given container, device or codec. Private
426 options are listed under their corresponding containers/devices/codecs.
430 <p>For example to write an ID3v2.3 header instead of a default ID3v2.4 to
431 an MP3 file, use the ‘<samp>id3v2_version</samp>’ private option of the MP3
433 </p><table><tr><td> </td><td><pre class="example">ffmpeg -i input.flac -id3v2_version 3 out.mp3
434 </pre></td></tr></table>
436 <p>All codec AVOptions are per-stream, and thus a stream specifier
437 should be attached to them.
439 <p>Note: the ‘<samp>-nooption</samp>’ syntax cannot be used for boolean
440 AVOptions, use ‘<samp>-option 0</samp>’/‘<samp>-option 1</samp>’.
442 <p>Note: the old undocumented way of specifying per-stream AVOptions by
443 prepending v/a/s to the options name is now obsolete and will be
446 <a name="Main-options"></a>
447 <h2 class="section"><a href="ffprobe.html#toc-Main-options">3.4 Main options</a></h2>
449 <dl compact="compact">
450 <dt> ‘<samp>-f <var>format</var></samp>’</dt>
451 <dd><p>Force format to use.
454 <dt> ‘<samp>-unit</samp>’</dt>
455 <dd><p>Show the unit of the displayed values.
458 <dt> ‘<samp>-prefix</samp>’</dt>
459 <dd><p>Use SI prefixes for the displayed values.
460 Unless the "-byte_binary_prefix" option is used all the prefixes
464 <dt> ‘<samp>-byte_binary_prefix</samp>’</dt>
465 <dd><p>Force the use of binary prefixes for byte values.
468 <dt> ‘<samp>-sexagesimal</samp>’</dt>
469 <dd><p>Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
472 <dt> ‘<samp>-pretty</samp>’</dt>
473 <dd><p>Prettify the format of the displayed values, it corresponds to the
474 options "-unit -prefix -byte_binary_prefix -sexagesimal".
477 <dt> ‘<samp>-of, -print_format <var>writer_name</var>[=<var>writer_options</var>]</samp>’</dt>
478 <dd><p>Set the output printing format.
480 <p><var>writer_name</var> specifies the name of the writer, and
481 <var>writer_options</var> specifies the options to be passed to the writer.
483 <p>For example for printing the output in JSON format, specify:
484 </p><table><tr><td> </td><td><pre class="example">-print_format json
485 </pre></td></tr></table>
487 <p>For more details on the available output printing formats, see the
488 Writers section below.
491 <dt> ‘<samp>-sections</samp>’</dt>
492 <dd><p>Print sections structure and section information, and exit. The output
493 is not meant to be parsed by a machine.
496 <dt> ‘<samp>-select_streams <var>stream_specifier</var></samp>’</dt>
497 <dd><p>Select only the streams specified by <var>stream_specifier</var>. This
498 option affects only the options related to streams
499 (e.g. <code>show_streams</code>, <code>show_packets</code>, etc.).
501 <p>For example to show only audio streams, you can use the command:
502 </p><table><tr><td> </td><td><pre class="example">ffprobe -show_streams -select_streams a INPUT
503 </pre></td></tr></table>
505 <p>To show only video packets belonging to the video stream with index 1:
506 </p><table><tr><td> </td><td><pre class="example">ffprobe -show_packets -select_streams v:1 INPUT
507 </pre></td></tr></table>
510 <dt> ‘<samp>-show_data</samp>’</dt>
511 <dd><p>Show payload data, as a hexadecimal and ASCII dump. Coupled with
512 ‘<samp>-show_packets</samp>’, it will dump the packets’ data. Coupled with
513 ‘<samp>-show_streams</samp>’, it will dump the codec extradata.
515 <p>The dump is printed as the "data" field. It may contain newlines.
518 <dt> ‘<samp>-show_error</samp>’</dt>
519 <dd><p>Show information about the error found when trying to probe the input.
521 <p>The error information is printed within a section with name "ERROR".
524 <dt> ‘<samp>-show_format</samp>’</dt>
525 <dd><p>Show information about the container format of the input multimedia
528 <p>All the container format information is printed within a section with
529 name "FORMAT".
532 <dt> ‘<samp>-show_format_entry <var>name</var></samp>’</dt>
533 <dd><p>Like ‘<samp>-show_format</samp>’, but only prints the specified entry of the
534 container format information, rather than all. This option may be given more
535 than once, then all specified entries will be shown.
537 <p>This option is deprecated, use <code>show_entries</code> instead.
540 <dt> ‘<samp>-show_entries <var>section_entries</var></samp>’</dt>
541 <dd><p>Set list of entries to show.
543 <p>Entries are specified according to the following
544 syntax. <var>section_entries</var> contains a list of section entries
545 separated by <code>:</code>. Each section entry is composed by a section
546 name (or unique name), optionally followed by a list of entries local
547 to that section, separated by <code>,</code>.
549 <p>If section name is specified but is followed by no <code>=</code>, all
550 entries are printed to output, together with all the contained
551 sections. Otherwise only the entries specified in the local section
552 entries list are printed. In particular, if <code>=</code> is specified but
553 the list of local entries is empty, then no entries will be shown for
556 <p>Note that the order of specification of the local section entries is
557 not honored in the output, and the usual display order will be
560 <p>The formal syntax is given by:
561 </p><table><tr><td> </td><td><pre class="example"><var>LOCAL_SECTION_ENTRIES</var> ::= <var>SECTION_ENTRY_NAME</var>[,<var>LOCAL_SECTION_ENTRIES</var>]
562 <var>SECTION_ENTRY</var> ::= <var>SECTION_NAME</var>[=[<var>LOCAL_SECTION_ENTRIES</var>]]
563 <var>SECTION_ENTRIES</var> ::= <var>SECTION_ENTRY</var>[:<var>SECTION_ENTRIES</var>]
564 </pre></td></tr></table>
566 <p>For example, to show only the index and type of each stream, and the PTS
567 time, duration time, and stream index of the packets, you can specify
569 </p><table><tr><td> </td><td><pre class="example">packet=pts_time,duration_time,stream_index : stream=index,codec_type
570 </pre></td></tr></table>
572 <p>To show all the entries in the section "format", but only the codec
573 type in the section "stream", specify the argument:
574 </p><table><tr><td> </td><td><pre class="example">format : stream=codec_type
575 </pre></td></tr></table>
577 <p>To show all the tags in the stream and format sections:
578 </p><table><tr><td> </td><td><pre class="example">format_tags : format_tags
579 </pre></td></tr></table>
581 <p>To show only the <code>title</code> tag (if available) in the stream
583 </p><table><tr><td> </td><td><pre class="example">stream_tags=title
584 </pre></td></tr></table>
587 <dt> ‘<samp>-show_packets</samp>’</dt>
588 <dd><p>Show information about each packet contained in the input multimedia
591 <p>The information for each single packet is printed within a dedicated
592 section with name "PACKET".
595 <dt> ‘<samp>-show_frames</samp>’</dt>
596 <dd><p>Show information about each frame and subtitle contained in the input
599 <p>The information for each single frame is printed within a dedicated
600 section with name "FRAME" or "SUBTITLE".
603 <dt> ‘<samp>-show_streams</samp>’</dt>
604 <dd><p>Show information about each media stream contained in the input
607 <p>Each media stream information is printed within a dedicated section
608 with name "STREAM".
611 <dt> ‘<samp>-show_programs</samp>’</dt>
612 <dd><p>Show information about programs and their streams contained in the input
615 <p>Each media stream information is printed within a dedicated section
616 with name "PROGRAM_STREAM".
619 <dt> ‘<samp>-show_chapters</samp>’</dt>
620 <dd><p>Show information about chapters stored in the format.
622 <p>Each chapter is printed within a dedicated section with name "CHAPTER".
625 <dt> ‘<samp>-count_frames</samp>’</dt>
626 <dd><p>Count the number of frames per stream and report it in the
627 corresponding stream section.
630 <dt> ‘<samp>-count_packets</samp>’</dt>
631 <dd><p>Count the number of packets per stream and report it in the
632 corresponding stream section.
635 <dt> ‘<samp>-read_intervals <var>read_intervals</var></samp>’</dt>
637 <p>Read only the specified intervals. <var>read_intervals</var> must be a
638 sequence of interval specifications separated by ",".
639 <code>ffprobe</code> will seek to the interval starting point, and will
640 continue reading from that.
642 <p>Each interval is specified by two optional parts, separated by "%".
644 <p>The first part specifies the interval start position. It is
645 interpreted as an abolute position, or as a relative offset from the
646 current position if it is preceded by the "+" character. If this first
647 part is not specified, no seeking will be performed when reading this
650 <p>The second part specifies the interval end position. It is interpreted
651 as an absolute position, or as a relative offset from the current
652 position if it is preceded by the "+" character. If the offset
653 specification starts with "#", it is interpreted as the number of
654 packets to read (not including the flushing packets) from the interval
655 start. If no second part is specified, the program will read until the
658 <p>Note that seeking is not accurate, thus the actual interval start
659 point may be different from the specified position. Also, when an
660 interval duration is specified, the absolute end time will be computed
661 by adding the duration to the interval start point found by seeking
662 the file, rather than to the specified start value.
664 <p>The formal syntax is given by:
665 </p><table><tr><td> </td><td><pre class="example"><var>INTERVAL</var> ::= [<var>START</var>|+<var>START_OFFSET</var>][%[<var>END</var>|+<var>END_OFFSET</var>]]
666 <var>INTERVALS</var> ::= <var>INTERVAL</var>[,<var>INTERVALS</var>]
667 </pre></td></tr></table>
669 <p>A few examples follow.
672 Seek to time 10, read packets until 20 seconds after the found seek
673 point, then seek to position <code>01:30</code> (1 minute and thirty
674 seconds) and read packets until position <code>01:45</code>.
675 <table><tr><td> </td><td><pre class="example">10%+20,01:30%01:45
676 </pre></td></tr></table>
679 Read only 42 packets after seeking to position <code>01:23</code>:
680 <table><tr><td> </td><td><pre class="example">01:23%+#42
681 </pre></td></tr></table>
684 Read only the first 20 seconds from the start:
685 <table><tr><td> </td><td><pre class="example">%+20
686 </pre></td></tr></table>
689 Read from the start until position <code>02:30</code>:
690 <table><tr><td> </td><td><pre class="example">%02:30
691 </pre></td></tr></table>
695 <dt> ‘<samp>-show_private_data, -private</samp>’</dt>
696 <dd><p>Show private data, that is data depending on the format of the
697 particular shown element.
698 This option is enabled by default, but you may need to disable it
699 for specific uses, for example when creating XSD-compliant XML output.
702 <dt> ‘<samp>-show_program_version</samp>’</dt>
703 <dd><p>Show information related to program version.
705 <p>Version information is printed within a section with name
706 "PROGRAM_VERSION".
709 <dt> ‘<samp>-show_library_versions</samp>’</dt>
710 <dd><p>Show information related to library versions.
712 <p>Version information for each library is printed within a section with
713 name "LIBRARY_VERSION".
716 <dt> ‘<samp>-show_versions</samp>’</dt>
717 <dd><p>Show information related to program and library versions. This is the
718 equivalent of setting both ‘<samp>-show_program_version</samp>’ and
719 ‘<samp>-show_library_versions</samp>’ options.
722 <dt> ‘<samp>-bitexact</samp>’</dt>
723 <dd><p>Force bitexact output, useful to produce output which is not dependent
724 on the specific build.
727 <dt> ‘<samp>-i <var>input_file</var></samp>’</dt>
728 <dd><p>Read <var>input_file</var>.
733 <a name="Writers"></a>
734 <h1 class="chapter"><a href="ffprobe.html#toc-Writers">4. Writers</a></h1>
736 <p>A writer defines the output format adopted by <code>ffprobe</code>, and will be
737 used for printing all the parts of the output.
739 <p>A writer may accept one or more arguments, which specify the options
740 to adopt. The options are specified as a list of <var>key</var>=<var>value</var>
741 pairs, separated by ":".
743 <p>All writers support the following options:
745 <dl compact="compact">
746 <dt> ‘<samp>string_validation, sv</samp>’</dt>
747 <dd><p>Set string validation mode.
749 <p>The following values are accepted.
750 </p><dl compact="compact">
751 <dt> ‘<samp>fail</samp>’</dt>
752 <dd><p>The writer will fail immediately in case an invalid string (UTF-8)
753 sequence or code point is found in the input. This is especially
754 useful to validate input metadata.
757 <dt> ‘<samp>ignore</samp>’</dt>
758 <dd><p>Any validation error will be ignored. This will result in possibly
759 broken output, especially with the json or xml writer.
762 <dt> ‘<samp>replace</samp>’</dt>
763 <dd><p>The writer will substitute invalid UTF-8 sequences or code points with
764 the string specified with the ‘<samp>string_validation_replacement</samp>’.
768 <p>Default value is ‘<samp>replace</samp>’.
771 <dt> ‘<samp>string_validation_replacement, svr</samp>’</dt>
772 <dd><p>Set replacement string to use in case ‘<samp>string_validation</samp>’ is
773 set to ‘<samp>replace</samp>’.
775 <p>In case the option is not specified, the writer will assume the empty
776 string, that is it will remove the invalid sequences from the input
781 <p>A description of the currently available writers follows.
783 <a name="default"></a>
784 <h2 class="section"><a href="ffprobe.html#toc-default">4.1 default</a></h2>
787 <p>Print each section in the form:
788 </p><table><tr><td> </td><td><pre class="example">[SECTION]
793 </pre></td></tr></table>
795 <p>Metadata tags are printed as a line in the corresponding FORMAT, STREAM or
796 PROGRAM_STREAM section, and are prefixed by the string "TAG:".
798 <p>A description of the accepted options follows.
800 <dl compact="compact">
801 <dt> ‘<samp>nokey, nk</samp>’</dt>
802 <dd><p>If set to 1 specify not to print the key of each field. Default value
806 <dt> ‘<samp>noprint_wrappers, nw</samp>’</dt>
807 <dd><p>If set to 1 specify not to print the section header and footer.
812 <a name="compact_002c-csv"></a>
813 <h2 class="section"><a href="ffprobe.html#toc-compact_002c-csv">4.2 compact, csv</a></h2>
814 <p>Compact and CSV format.
816 <p>The <code>csv</code> writer is equivalent to <code>compact</code>, but supports
819 <p>Each section is printed on a single line.
820 If no option is specifid, the output has the form:
821 </p><table><tr><td> </td><td><pre class="example">section|key1=val1| ... |keyN=valN
822 </pre></td></tr></table>
824 <p>Metadata tags are printed in the corresponding "format" or "stream"
825 section. A metadata tag key, if printed, is prefixed by the string
828 <p>The description of the accepted options follows.
830 <dl compact="compact">
831 <dt> ‘<samp>item_sep, s</samp>’</dt>
832 <dd><p>Specify the character to use for separating fields in the output line.
833 It must be a single printable character, it is "|" by default ("," for
834 the <code>csv</code> writer).
837 <dt> ‘<samp>nokey, nk</samp>’</dt>
838 <dd><p>If set to 1 specify not to print the key of each field. Its default
839 value is 0 (1 for the <code>csv</code> writer).
842 <dt> ‘<samp>escape, e</samp>’</dt>
843 <dd><p>Set the escape mode to use, default to "c" ("csv" for the <code>csv</code>
846 <p>It can assume one of the following values:
847 </p><dl compact="compact">
848 <dt> ‘<samp>c</samp>’</dt>
849 <dd><p>Perform C-like escaping. Strings containing a newline (’\n’), carriage
850 return (’\r’), a tab (’\t’), a form feed (’\f’), the escaping
851 character (’\’) or the item separator character <var>SEP</var> are escaped using C-like fashioned
852 escaping, so that a newline is converted to the sequence "\n", a
853 carriage return to "\r", ’\’ to "\\" and the separator <var>SEP</var> is
854 converted to "\<var>SEP</var>".
857 <dt> ‘<samp>csv</samp>’</dt>
858 <dd><p>Perform CSV-like escaping, as described in RFC4180. Strings
859 containing a newline (’\n’), a carriage return (’\r’), a double quote
860 (’"’), or <var>SEP</var> are enclosed in double-quotes.
863 <dt> ‘<samp>none</samp>’</dt>
864 <dd><p>Perform no escaping.
869 <dt> ‘<samp>print_section, p</samp>’</dt>
870 <dd><p>Print the section name at the begin of each line if the value is
871 <code>1</code>, disable it with value set to <code>0</code>. Default value is
878 <h2 class="section"><a href="ffprobe.html#toc-flat">4.3 flat</a></h2>
881 <p>A free-form output where each line contains an explicit key=value, such as
882 "streams.stream.3.tags.foo=bar". The output is shell escaped, so it can be
883 directly embedded in sh scripts as long as the separator character is an
884 alphanumeric character or an underscore (see <var>sep_char</var> option).
886 <p>The description of the accepted options follows.
888 <dl compact="compact">
889 <dt> ‘<samp>sep_char, s</samp>’</dt>
890 <dd><p>Separator character used to separate the chapter, the section name, IDs and
891 potential tags in the printed field key.
893 <p>Default value is ’.’.
896 <dt> ‘<samp>hierarchical, h</samp>’</dt>
897 <dd><p>Specify if the section name specification should be hierarchical. If
898 set to 1, and if there is more than one section in the current
899 chapter, the section name will be prefixed by the name of the
900 chapter. A value of 0 will disable this behavior.
902 <p>Default value is 1.
907 <h2 class="section"><a href="ffprobe.html#toc-ini">4.4 ini</a></h2>
908 <p>INI format output.
910 <p>Print output in an INI based format.
912 <p>The following conventions are adopted:
916 all key and values are UTF-8
918 ’.’ is the subgroup separator
920 newline, ’\t’, ’\f’, ’\b’ and the following characters are escaped
922 ’\’ is the escape character
924 ’#’ is the comment indicator
926 ’=’ is the key/value separator
928 ’:’ is not used but usually parsed as key/value separator
931 <p>This writer accepts options as a list of <var>key</var>=<var>value</var> pairs,
932 separated by ":".
934 <p>The description of the accepted options follows.
936 <dl compact="compact">
937 <dt> ‘<samp>hierarchical, h</samp>’</dt>
938 <dd><p>Specify if the section name specification should be hierarchical. If
939 set to 1, and if there is more than one section in the current
940 chapter, the section name will be prefixed by the name of the
941 chapter. A value of 0 will disable this behavior.
943 <p>Default value is 1.
948 <h2 class="section"><a href="ffprobe.html#toc-json">4.5 json</a></h2>
949 <p>JSON based format.
951 <p>Each section is printed using JSON notation.
953 <p>The description of the accepted options follows.
955 <dl compact="compact">
956 <dt> ‘<samp>compact, c</samp>’</dt>
957 <dd><p>If set to 1 enable compact output, that is each section will be
958 printed on a single line. Default value is 0.
962 <p>For more information about JSON, see <a href="http://www.json.org/">http://www.json.org/</a>.
965 <h2 class="section"><a href="ffprobe.html#toc-xml">4.6 xml</a></h2>
968 <p>The XML output is described in the XML schema description file
969 ‘<tt>ffprobe.xsd</tt>’ installed in the FFmpeg datadir.
971 <p>An updated version of the schema can be retrieved at the url
972 <a href="http://www.ffmpeg.org/schema/ffprobe.xsd">http://www.ffmpeg.org/schema/ffprobe.xsd</a>, which redirects to the
973 latest schema committed into the FFmpeg development source code tree.
975 <p>Note that the output issued will be compliant to the
976 ‘<tt>ffprobe.xsd</tt>’ schema only when no special global output options
977 (‘<samp>unit</samp>’, ‘<samp>prefix</samp>’, ‘<samp>byte_binary_prefix</samp>’,
978 ‘<samp>sexagesimal</samp>’ etc.) are specified.
980 <p>The description of the accepted options follows.
982 <dl compact="compact">
983 <dt> ‘<samp>fully_qualified, q</samp>’</dt>
984 <dd><p>If set to 1 specify if the output should be fully qualified. Default
986 This is required for generating an XML file which can be validated
990 <dt> ‘<samp>xsd_compliant, x</samp>’</dt>
991 <dd><p>If set to 1 perform more checks for ensuring that the output is XSD
992 compliant. Default value is 0.
993 This option automatically sets ‘<samp>fully_qualified</samp>’ to 1.
997 <p>For more information about the XML format, see
998 <a href="http://www.w3.org/XML/">http://www.w3.org/XML/</a>.
1000 <a name="Timecode"></a>
1001 <h1 class="chapter"><a href="ffprobe.html#toc-Timecode">5. Timecode</a></h1>
1003 <p><code>ffprobe</code> supports Timecode extraction:
1007 MPEG1/2 timecode is extracted from the GOP, and is available in the video
1008 stream details (‘<samp>-show_streams</samp>’, see <var>timecode</var>).
1011 MOV timecode is extracted from tmcd track, so is available in the tmcd
1012 stream metadata (‘<samp>-show_streams</samp>’, see <var>TAG:timecode</var>).
1015 DV, GXF and AVI timecodes are available in format metadata
1016 (‘<samp>-show_format</samp>’, see <var>TAG:timecode</var>).
1021 <a name="See-Also"></a>
1022 <h1 class="chapter"><a href="ffprobe.html#toc-See-Also">6. See Also</a></h1>
1024 <p><a href="ffprobe-all.html">ffprobe-all</a>,
1025 <a href="ffmpeg.html">ffmpeg</a>, <a href="ffplay.html">ffplay</a>, <a href="ffserver.html">ffserver</a>,
1026 <a href="ffmpeg-utils.html">ffmpeg-utils</a>,
1027 <a href="ffmpeg-scaler.html">ffmpeg-scaler</a>,
1028 <a href="ffmpeg-resampler.html">ffmpeg-resampler</a>,
1029 <a href="ffmpeg-codecs.html">ffmpeg-codecs</a>,
1030 <a href="ffmpeg-bitstream-filters.html">ffmpeg-bitstream-filters</a>,
1031 <a href="ffmpeg-formats.html">ffmpeg-formats</a>,
1032 <a href="ffmpeg-devices.html">ffmpeg-devices</a>,
1033 <a href="ffmpeg-protocols.html">ffmpeg-protocols</a>,
1034 <a href="ffmpeg-filters.html">ffmpeg-filters</a>
1037 <a name="Authors"></a>
1038 <h1 class="chapter"><a href="ffprobe.html#toc-Authors">7. Authors</a></h1>
1040 <p>The FFmpeg developers.
1042 <p>For details about the authorship, see the Git history of the project
1043 (git://source.ffmpeg.org/ffmpeg), e.g. by typing the command
1044 <code>git log</code> in the FFmpeg source directory, or browsing the
1045 online repository at <a href="http://source.ffmpeg.org">http://source.ffmpeg.org</a>.
1047 <p>Maintainers for the specific components are listed in the file
1048 ‘<tt>MAINTAINERS</tt>’ in the source code tree.
1051 <footer class="footer pagination-right">
1052 <span class="label label-info">This document was generated by <em>Kyle Schwarz</em> on <em>December 14, 2013</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.82</em></a>.</span></footer></div></div></body>
projects / casparcg / blob