Statistics
| Branch: | Revision:

ffmpeg / doc / ffprobe.texi @ 106f271f

History | View | Annotate | Download (2.95 KB)

1 336ce917 Stefano Sabatini
\input texinfo @c -*- texinfo -*-
2
3
@settitle FFprobe Documentation
4
@titlepage
5
@sp 7
6
@center @titlefont{FFprobe Documentation}
7
@sp 3
8
@end titlepage
9
10 a66d8cd9 Stefano Sabatini
@chapter Synopsis
11
12
The generic syntax is:
13
14
@example
15
@c man begin SYNOPSIS
16
ffprobe [options] [@file{input_file}]
17
@c man end
18
@end example
19
20 016ea628 Stefano Sabatini
@chapter Description
21 336ce917 Stefano Sabatini
@c man begin DESCRIPTION
22
23
FFprobe gathers information from multimedia streams and prints it in
24
human- and machine-readable fashion.
25
26
For example it can be used to check the format of the container used
27
by a multimedia stream and the format and type of each media stream
28
contained in it.
29
30
If a filename is specified in input, ffprobe will try to open and
31
probe the file content. If the file cannot be opened or recognized as
32
a multimedia file, a positive exit code is returned.
33
34
FFprobe may be employed both as a standalone application or in
35
combination with a textual filter, which may perform more
36
sophisticated processing, e.g. statistical processing or plotting.
37
38
Options are used to list some of the formats supported by ffprobe or
39
for specifying which information to display, and for setting how
40
ffprobe will show it.
41
42
FFprobe output is designed to be easily parsable by a textual filter,
43
and consists of one or more sections of the form:
44
@example
45
[SECTION]
46
key1=val1
47
...
48
keyN=valN
49
[/SECTION]
50
@end example
51
52
Metadata tags stored in the container or in the streams are recognized
53 0eb1a356 Stefano Sabatini
and printed in the corresponding "FORMAT" or "STREAM" section, and
54
are prefixed by the string "TAG:".
55 336ce917 Stefano Sabatini
56
@c man end
57
58 a66d8cd9 Stefano Sabatini
@chapter Options
59 336ce917 Stefano Sabatini
@c man begin OPTIONS
60
61
@include fftools-common-opts.texi
62
63
@section Main options
64
65
@table @option
66 1be784a2 Stefano Sabatini
67
@item -f @var{format}
68
Force format to use.
69
70 336ce917 Stefano Sabatini
@item -unit
71
Show the unit of the displayed values.
72
73
@item -prefix
74 4906e7b5 Stefano Sabatini
Use SI prefixes for the displayed values.
75
Unless the "-byte_binary_prefix" option is used all the prefixes
76 336ce917 Stefano Sabatini
are decimal.
77
78
@item -byte_binary_prefix
79
Force the use of binary prefixes for byte values.
80
81
@item -sexagesimal
82
Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
83
84
@item -pretty
85
Prettify the format of the displayed values, it corresponds to the
86 0eb1a356 Stefano Sabatini
options "-unit -prefix -byte_binary_prefix -sexagesimal".
87 336ce917 Stefano Sabatini
88
@item -show_format
89
Show information about the container format of the input multimedia
90
stream.
91
92
All the container format information is printed within a section with
93 0eb1a356 Stefano Sabatini
name "FORMAT".
94 336ce917 Stefano Sabatini
95 530bbe96 Stefano Sabatini
@item -show_packets
96
Show information about each packet contained in the input multimedia
97
stream.
98
99
The information for each single packet is printed within a dedicated
100 0eb1a356 Stefano Sabatini
section with name "PACKET".
101 530bbe96 Stefano Sabatini
102 336ce917 Stefano Sabatini
@item -show_streams
103
Show information about each media stream contained in the input
104
multimedia stream.
105
106
Each media stream information is printed within a dedicated section
107 0eb1a356 Stefano Sabatini
with name "STREAM".
108 336ce917 Stefano Sabatini
109
@end table
110
@c man end
111
112 1de4cfe6 Stefano Sabatini
@include protocols.texi
113 4419c8bf Stefano Sabatini
@include indevs.texi
114
115 336ce917 Stefano Sabatini
@ignore
116
117
@setfilename ffprobe
118
@settitle FFprobe media prober
119
120
@c man begin SEEALSO
121 b26247ed Stefano Sabatini
ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
122 336ce917 Stefano Sabatini
@c man end
123
124 aeadb328 Stefano Sabatini
@c man begin AUTHORS
125
The FFmpeg developers
126
@c man end
127
128 336ce917 Stefano Sabatini
@end ignore
129
130
@bye