Statistics
| Branch: | Revision:

ffmpeg / doc / ffprobe.texi @ db95e559

History | View | Annotate | Download (3 KB)

1 336ce917 Stefano Sabatini
\input texinfo @c -*- texinfo -*-
2
3
@settitle FFprobe Documentation
4
@titlepage
5
@center @titlefont{FFprobe Documentation}
6
@end titlepage
7
8 a8f0814a Janne Grunau
@top
9
10
@contents
11
12 a66d8cd9 Stefano Sabatini
@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 016ea628 Stefano Sabatini
@chapter Description
23 336ce917 Stefano Sabatini
@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 the form:
46
@example
47
[SECTION]
48
key1=val1
49
...
50
keyN=valN
51
[/SECTION]
52
@end example
53
54
Metadata tags stored in the container or in the streams are recognized
55 0eb1a356 Stefano Sabatini
and printed in the corresponding "FORMAT" or "STREAM" section, and
56
are prefixed by the string "TAG:".
57 336ce917 Stefano Sabatini
58
@c man end
59
60 a66d8cd9 Stefano Sabatini
@chapter Options
61 336ce917 Stefano Sabatini
@c man begin OPTIONS
62
63
@include fftools-common-opts.texi
64
65
@section Main options
66
67
@table @option
68 1be784a2 Stefano Sabatini
69
@item -f @var{format}
70
Force format to use.
71
72 336ce917 Stefano Sabatini
@item -unit
73
Show the unit of the displayed values.
74
75
@item -prefix
76 4906e7b5 Stefano Sabatini
Use SI prefixes for the displayed values.
77
Unless the "-byte_binary_prefix" option is used all the prefixes
78 336ce917 Stefano Sabatini
are decimal.
79
80
@item -byte_binary_prefix
81
Force the use of binary prefixes for byte values.
82
83
@item -sexagesimal
84
Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
85
86
@item -pretty
87
Prettify the format of the displayed values, it corresponds to the
88 0eb1a356 Stefano Sabatini
options "-unit -prefix -byte_binary_prefix -sexagesimal".
89 336ce917 Stefano Sabatini
90
@item -show_format
91
Show information about the container format of the input multimedia
92
stream.
93
94
All the container format information is printed within a section with
95 0eb1a356 Stefano Sabatini
name "FORMAT".
96 336ce917 Stefano Sabatini
97 530bbe96 Stefano Sabatini
@item -show_packets
98
Show information about each packet contained in the input multimedia
99
stream.
100
101
The information for each single packet is printed within a dedicated
102 0eb1a356 Stefano Sabatini
section with name "PACKET".
103 530bbe96 Stefano Sabatini
104 336ce917 Stefano Sabatini
@item -show_streams
105
Show information about each media stream contained in the input
106
multimedia stream.
107
108
Each media stream information is printed within a dedicated section
109 0eb1a356 Stefano Sabatini
with name "STREAM".
110 336ce917 Stefano Sabatini
111
@end table
112
@c man end
113
114 ef298ea7 Stefano Sabatini
@include demuxers.texi
115 85466e1e Stefano Sabatini
@include muxers.texi
116 1de4cfe6 Stefano Sabatini
@include protocols.texi
117 4419c8bf Stefano Sabatini
@include indevs.texi
118
119 336ce917 Stefano Sabatini
@ignore
120
121
@setfilename ffprobe
122
@settitle FFprobe media prober
123
124
@c man begin SEEALSO
125 a6be21d3 Michael Niedermayer
ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
126 336ce917 Stefano Sabatini
@c man end
127
128 aeadb328 Stefano Sabatini
@c man begin AUTHORS
129 a6be21d3 Michael Niedermayer
The FFmpeg developers
130 aeadb328 Stefano Sabatini
@c man end
131
132 336ce917 Stefano Sabatini
@end ignore
133
134
@bye