rtmp: Rename packet types to closer match the spec
[ffmpeg.git] / doc / avprobe.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle avprobe Documentation
4 @titlepage
5 @center @titlefont{avprobe 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 avprobe [options] [@file{input_file}]
19 @c man end
20 @end example
21
22 @chapter Description
23 @c man begin DESCRIPTION
24
25 avprobe 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, avprobe 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 avprobe 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 avprobe or
41 for specifying which information to display, and for setting how
42 avprobe will show it.
43
44 avprobe output is designed to be easily parsable by any INI or JSON
45 parsers.
46
47 @c man end
48
49 @chapter Options
50 @c man begin OPTIONS
51
52 @include avtools-common-opts.texi
53
54 @section Main options
55
56 @table @option
57
58 @item -f @var{format}
59 Force format to use.
60
61 @item -of @var{formatter}
62 Use a specific formatter to output the document. The following
63 formatters are available
64 @table @option
65 @item ini
66
67 @item json
68
69 @item old
70 Pseudo-INI format that used to be the only one available in old
71 avprobe versions.
72 @end table
73
74 @item -unit
75 Show the unit of the displayed values.
76
77 @item -prefix
78 Use SI prefixes for the displayed values.
79 Unless the "-byte_binary_prefix" option is used all the prefixes
80 are decimal.
81
82 @item -byte_binary_prefix
83 Force the use of binary prefixes for byte values.
84
85 @item -sexagesimal
86 Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
87
88 @item -pretty
89 Prettify the format of the displayed values, it corresponds to the
90 options "-unit -prefix -byte_binary_prefix -sexagesimal".
91
92 @item -show_format
93 Show information about the container format of the input multimedia
94 stream.
95
96 All the container format information is printed within a section with
97 name "FORMAT".
98
99 @item -show_format_entry @var{name}
100 Like @option{-show_format}, but only prints the specified entry of the
101 container format information, rather than all. This option may be given more
102 than once, then all specified entries will be shown.
103
104 @item -show_packets
105 Show information about each packet contained in the input multimedia
106 stream.
107
108 The information for each single packet is printed within a dedicated
109 section with name "PACKET".
110
111 @item -show_streams
112 Show information about each media stream contained in the input
113 multimedia stream.
114
115 Each media stream information is printed within a dedicated section
116 with name "STREAM".
117
118 @end table
119 @c man end
120
121 @include demuxers.texi
122 @include muxers.texi
123 @include protocols.texi
124 @include indevs.texi
125
126 @ignore
127
128 @setfilename avprobe
129 @settitle avprobe media prober
130
131 @c man begin SEEALSO
132 avconv(1), avplay(1) and the Libav HTML documentation
133 @c man end
134
135 @c man begin AUTHORS
136 The Libav developers
137 @c man end
138
139 @end ignore
140
141 @bye