avprobe.texi 3 KB
Newer Older
Stefano Sabatini's avatar
Stefano Sabatini committed
1 2
\input texinfo @c -*- texinfo -*-

3
@settitle avprobe Documentation
Stefano Sabatini's avatar
Stefano Sabatini committed
4
@titlepage
5
@center @titlefont{avprobe Documentation}
Stefano Sabatini's avatar
Stefano Sabatini committed
6 7
@end titlepage

8 9 10 11
@top

@contents

12 13 14 15 16 17
@chapter Synopsis

The generic syntax is:

@example
@c man begin SYNOPSIS
18
avprobe [options] [@file{input_file}]
19 20 21
@c man end
@end example

22
@chapter Description
Stefano Sabatini's avatar
Stefano Sabatini committed
23 24
@c man begin DESCRIPTION

25
avprobe gathers information from multimedia streams and prints it in
Stefano Sabatini's avatar
Stefano Sabatini committed
26 27 28 29 30 31
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.

32
If a filename is specified in input, avprobe will try to open and
Stefano Sabatini's avatar
Stefano Sabatini committed
33 34 35
probe the file content. If the file cannot be opened or recognized as
a multimedia file, a positive exit code is returned.

36
avprobe may be employed both as a standalone application or in
Stefano Sabatini's avatar
Stefano Sabatini committed
37 38 39
combination with a textual filter, which may perform more
sophisticated processing, e.g. statistical processing or plotting.

40
Options are used to list some of the formats supported by avprobe or
Stefano Sabatini's avatar
Stefano Sabatini committed
41
for specifying which information to display, and for setting how
42
avprobe will show it.
Stefano Sabatini's avatar
Stefano Sabatini committed
43

44
avprobe output is designed to be easily parsable by a textual filter,
Stefano Sabatini's avatar
Stefano Sabatini committed
45 46 47 48 49 50 51 52 53 54
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
55 56
and printed in the corresponding "FORMAT" or "STREAM" section, and
are prefixed by the string "TAG:".
Stefano Sabatini's avatar
Stefano Sabatini committed
57 58 59

@c man end

60
@chapter Options
Stefano Sabatini's avatar
Stefano Sabatini committed
61 62
@c man begin OPTIONS

63
@include avtools-common-opts.texi
Stefano Sabatini's avatar
Stefano Sabatini committed
64 65 66 67

@section Main options

@table @option
68 69 70 71

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

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

@item -prefix
76 77
Use SI prefixes for the displayed values.
Unless the "-byte_binary_prefix" option is used all the prefixes
Stefano Sabatini's avatar
Stefano Sabatini committed
78 79 80 81 82 83 84 85 86 87
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
88
options "-unit -prefix -byte_binary_prefix -sexagesimal".
Stefano Sabatini's avatar
Stefano Sabatini committed
89 90 91 92 93 94

@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
95
name "FORMAT".
Stefano Sabatini's avatar
Stefano Sabatini committed
96

97 98 99 100 101
@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
102
section with name "PACKET".
103

Stefano Sabatini's avatar
Stefano Sabatini committed
104 105 106 107 108
@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
109
with name "STREAM".
Stefano Sabatini's avatar
Stefano Sabatini committed
110 111 112 113

@end table
@c man end

114
@include demuxers.texi
Stefano Sabatini's avatar
Stefano Sabatini committed
115
@include muxers.texi
Stefano Sabatini's avatar
Stefano Sabatini committed
116
@include protocols.texi
117 118
@include indevs.texi

Stefano Sabatini's avatar
Stefano Sabatini committed
119 120
@ignore

121 122
@setfilename avprobe
@settitle avprobe media prober
Stefano Sabatini's avatar
Stefano Sabatini committed
123 124

@c man begin SEEALSO
125
avconv(1), avplay(1), avserver(1) and the Libav HTML documentation
Stefano Sabatini's avatar
Stefano Sabatini committed
126 127
@c man end

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

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

@bye