avprobe: update documentation
[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, either @var{ini} or
63 @var{json} available.
64
65 @item -unit
66 Show the unit of the displayed values.
67
68 @item -prefix
69 Use SI prefixes for the displayed values.
70 Unless the "-byte_binary_prefix" option is used all the prefixes
71 are decimal.
72
73 @item -byte_binary_prefix
74 Force the use of binary prefixes for byte values.
75
76 @item -sexagesimal
77 Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
78
79 @item -pretty
80 Prettify the format of the displayed values, it corresponds to the
81 options "-unit -prefix -byte_binary_prefix -sexagesimal".
82
83 @item -show_format
84 Show information about the container format of the input multimedia
85 stream.
86
87 All the container format information is printed within a section with
88 name "FORMAT".
89
90 @item -show_format_entry @var{name}
91 Like @option{-show_format}, but only prints the specified entry of the
92 container format information, rather than all. This option may be given more
93 than once, then all specified entries will be shown.
94
95 @item -show_packets
96 Show information about each packet contained in the input multimedia
97 stream.
98
99 The information for each single packet is printed within a dedicated
100 section with name "PACKET".
101
102 @item -show_streams
103 Show information about each media stream contained in the input
104 multimedia stream.
105
106 Each media stream information is printed within a dedicated section
107 with name "STREAM".
108
109 @end table
110 @c man end
111
112 @include demuxers.texi
113 @include muxers.texi
114 @include protocols.texi
115 @include indevs.texi
116
117 @ignore
118
119 @setfilename avprobe
120 @settitle avprobe media prober
121
122 @c man begin SEEALSO
123 avconv(1), avplay(1) and the Libav HTML documentation
124 @c man end
125
126 @c man begin AUTHORS
127 The Libav developers
128 @c man end
129
130 @end ignore
131
132 @bye