ffprobe-doc.texi 3.05 KB
Newer Older
Stefano Sabatini's avatar
Stefano Sabatini committed
1 2 3 4 5 6 7 8 9
\input texinfo @c -*- texinfo -*-

@settitle FFprobe Documentation
@titlepage
@sp 7
@center @titlefont{FFprobe Documentation}
@sp 3
@end titlepage

10 11 12 13 14 15 16 17 18 19
@chapter Synopsis

The generic syntax is:

@example
@c man begin SYNOPSIS
ffprobe [options] [@file{input_file}]
@c man end
@end example

20
@chapter Description
Stefano Sabatini's avatar
Stefano Sabatini committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
@c man begin DESCRIPTION

FFprobe gathers information from multimedia streams and prints it in
human- and machine-readable fashion.

For example it can be used to check the format of the container used
by a multimedia stream and the format and type of each media stream
contained in it.

If a filename is specified in input, ffprobe will try to open and
probe the file content. If the file cannot be opened or recognized as
a multimedia file, a positive exit code is returned.

FFprobe may be employed both as a standalone application or in
combination with a textual filter, which may perform more
sophisticated processing, e.g. statistical processing or plotting.

Options are used to list some of the formats supported by ffprobe or
for specifying which information to display, and for setting how
ffprobe will show it.

FFprobe output is designed to be easily parsable by a textual filter,
and consists of one or more sections of the form:
@example
[SECTION]
key1=val1
...
keyN=valN
[/SECTION]
@end example

Metadata tags stored in the container or in the streams are recognized
53 54
and printed in the corresponding "FORMAT" or "STREAM" section, and
are prefixed by the string "TAG:".
Stefano Sabatini's avatar
Stefano Sabatini committed
55 56 57

@c man end

58
@chapter Options
Stefano Sabatini's avatar
Stefano Sabatini committed
59 60 61 62 63 64 65
@c man begin OPTIONS

@include fftools-common-opts.texi

@section Main options

@table @option
66

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

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

Stefano Sabatini's avatar
Stefano Sabatini committed
73 74 75 76 77
@item -unit
Show the unit of the displayed values.

@item -prefix
Show a SI prefixes of the displayed values.
78
Unless "-byte_binary_prefix" option is used all the prefix
Stefano Sabatini's avatar
Stefano Sabatini committed
79 80 81 82 83 84 85 86 87 88
are decimal.

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

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

@item -pretty
Prettify the format of the displayed values, it corresponds to the
89
options "-unit -prefix -byte_binary_prefix -sexagesimal".
Stefano Sabatini's avatar
Stefano Sabatini committed
90 91 92 93 94 95

@item -show_format
Show information about the container format of the input multimedia
stream.

All the container format information is printed within a section with
96
name "FORMAT".
Stefano Sabatini's avatar
Stefano Sabatini committed
97

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

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

Stefano Sabatini's avatar
Stefano Sabatini committed
105 106 107 108 109
@item -show_streams
Show information about each media stream contained in the input
multimedia stream.

Each media stream information is printed within a dedicated section
110
with name "STREAM".
Stefano Sabatini's avatar
Stefano Sabatini committed
111 112 113 114

@end table
@c man end

Stefano Sabatini's avatar
Stefano Sabatini committed
115
@include protocols.texi
116 117
@include indevs.texi

Stefano Sabatini's avatar
Stefano Sabatini committed
118 119 120 121 122 123
@ignore

@setfilename ffprobe
@settitle FFprobe media prober

@c man begin SEEALSO
124
ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
Stefano Sabatini's avatar
Stefano Sabatini committed
125 126
@c man end

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

Stefano Sabatini's avatar
Stefano Sabatini committed
131 132 133
@end ignore

@bye