ffprobe: create a dedicated "Writers" section in the manual
[ffmpeg.git] / doc / ffprobe.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle ffprobe Documentation
4 @titlepage
5 @center @titlefont{ffprobe 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 ffprobe [options] [@file{input_file}]
19 @c man end
20 @end example
21
22 @chapter Description
23 @c man begin DESCRIPTION
24
25 ffprobe 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, ffprobe 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 ffprobe 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 ffprobe or
41 for specifying which information to display, and for setting how
42 ffprobe will show it.
43
44 ffprobe output is designed to be easily parsable by a textual filter,
45 and consists of one or more sections of a form defined by the selected
46 writer, which is specified by the @option{print_format} option.
47
48 Metadata tags stored in the container or in the streams are recognized
49 and printed in the corresponding "FORMAT" or "STREAM" section.
50
51 @c man end
52
53 @chapter Options
54 @c man begin OPTIONS
55
56 @include avtools-common-opts.texi
57
58 @section Main options
59
60 @table @option
61
62 @item -f @var{format}
63 Force format to use.
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 -print_format @var{format}
84 Set the output printing format.
85
86 For example for printing the output in JSON format, specify:
87 @example
88 -print_format json
89 @end example
90
91 For more details on the available output printing formats, see the
92 Writers section below.
93
94 @item -show_format
95 Show information about the container format of the input multimedia
96 stream.
97
98 All the container format information is printed within a section with
99 name "FORMAT".
100
101 @item -show_packets
102 Show information about each packet contained in the input multimedia
103 stream.
104
105 The information for each single packet is printed within a dedicated
106 section with name "PACKET".
107
108 @item -show_streams
109 Show information about each media stream contained in the input
110 multimedia stream.
111
112 Each media stream information is printed within a dedicated section
113 with name "STREAM".
114
115 @item -i @var{input_file}
116 Read @var{input_file}.
117
118 @end table
119 @c man end
120
121 @chapter Writers
122 @c man begin WRITERS
123
124 A writer defines the output format adopted by @file{ffprobe}, and will be
125 used for printing all the parts of the output.
126
127 A writer may accept one or more arguments, which specify the options to
128 adopt.
129
130 A description of the currently available writers follows.
131
132 @section default
133 Default format.
134
135 Print each section in the form:
136 @example
137 [SECTION]
138 key1=val1
139 ...
140 keyN=valN
141 [/SECTION]
142 @end example
143
144 Metadata tags are printed as a line in the corresponding FORMAT or
145 STREAM section, and are prefixed by the string "TAG:".
146
147 @section json
148 JSON based format.
149
150 Each section is printed using JSON notation.
151
152 For more information about JSON, see @url{http://www.json.org/}.
153
154 @c man end WRITERS
155
156 @include decoders.texi
157 @include demuxers.texi
158 @include protocols.texi
159 @include indevs.texi
160
161 @ignore
162
163 @setfilename ffprobe
164 @settitle ffprobe media prober
165
166 @c man begin SEEALSO
167 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
168 @c man end
169
170 @c man begin AUTHORS
171 The FFmpeg developers
172 @c man end
173
174 @end ignore
175
176 @bye