Statistics
| Branch: | Revision:

ffmpeg / doc / ffprobe-doc.texi @ 94498ec9

History | View | Annotate | Download (3.05 KB)

1
\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
@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
@chapter Description
21
@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
and printed in the corresponding "FORMAT" or "STREAM" section, and
54
are prefixed by the string "TAG:".
55

    
56
@c man end
57

    
58
@chapter Options
59
@c man begin OPTIONS
60

    
61
@include fftools-common-opts.texi
62

    
63
@section Main options
64

    
65
@table @option
66

    
67
@item -convert_tags
68
Convert the tag names in the format container to the generic FFmpeg tag names.
69

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

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

    
76
@item -prefix
77
Use SI prefixes for the displayed values.
78
Unless the "-byte_binary_prefix" option is used all the prefixes
79
are decimal.
80

    
81
@item -byte_binary_prefix
82
Force the use of binary prefixes for byte values.
83

    
84
@item -sexagesimal
85
Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
86

    
87
@item -pretty
88
Prettify the format of the displayed values, it corresponds to the
89
options "-unit -prefix -byte_binary_prefix -sexagesimal".
90

    
91
@item -show_format
92
Show information about the container format of the input multimedia
93
stream.
94

    
95
All the container format information is printed within a section with
96
name "FORMAT".
97

    
98
@item -show_packets
99
Show information about each packet contained in the input multimedia
100
stream.
101

    
102
The information for each single packet is printed within a dedicated
103
section with name "PACKET".
104

    
105
@item -show_streams
106
Show information about each media stream contained in the input
107
multimedia stream.
108

    
109
Each media stream information is printed within a dedicated section
110
with name "STREAM".
111

    
112
@end table
113
@c man end
114

    
115
@include protocols.texi
116
@include indevs.texi
117

    
118
@ignore
119

    
120
@setfilename ffprobe
121
@settitle FFprobe media prober
122

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

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

    
131
@end ignore
132

    
133
@bye