Statistics
| Branch: | Revision:

ffmpeg / doc / ffprobe.texi @ a8f0814a

History | View | Annotate | Download (3 KB)

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 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
and printed in the corresponding "FORMAT" or "STREAM" section, and
56
are prefixed by the string "TAG:".
57

    
58
@c man end
59

    
60
@chapter Options
61
@c man begin OPTIONS
62

    
63
@include fftools-common-opts.texi
64

    
65
@section Main options
66

    
67
@table @option
68

    
69
@item -f @var{format}
70
Force format to use.
71

    
72
@item -unit
73
Show the unit of the displayed values.
74

    
75
@item -prefix
76
Use SI prefixes for the displayed values.
77
Unless the "-byte_binary_prefix" option is used all the prefixes
78
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
options "-unit -prefix -byte_binary_prefix -sexagesimal".
89

    
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
name "FORMAT".
96

    
97
@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
section with name "PACKET".
103

    
104
@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
with name "STREAM".
110

    
111
@end table
112
@c man end
113

    
114
@include demuxers.texi
115
@include muxers.texi
116
@include protocols.texi
117
@include indevs.texi
118

    
119
@ignore
120

    
121
@setfilename ffprobe
122
@settitle FFprobe media prober
123

    
124
@c man begin SEEALSO
125
ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
126
@c man end
127

    
128
@c man begin AUTHORS
129
The FFmpeg developers
130
@c man end
131

    
132
@end ignore
133

    
134
@bye