ffprobe: add JSON output printing format.
[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 the form:
46 @example
47 [SECTION]
48 key1=val1
49 ...
50 keyN=valN
51 [/SECTION]
52 @end example
53
54 Metadata tags stored in the container or in the streams are recognized
55 and printed in the corresponding "FORMAT" or "STREAM" section, and
56 are prefixed by the string "TAG:".
57
58 @c man end
59
60 @chapter Options
61 @c man begin OPTIONS
62
63 @include avtools-common-opts.texi
64
65 @section Main options
66
67 @table @option
68
69 @item -f @var{format}
70 Force format to use.
71
72 @item -unit
73 Show the unit of the displayed values.
74
75 @item -prefix
76 Use SI prefixes for the displayed values.
77 Unless the "-byte_binary_prefix" option is used all the prefixes
78 are decimal.
79
80 @item -byte_binary_prefix
81 Force the use of binary prefixes for byte values.
82
83 @item -sexagesimal
84 Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
85
86 @item -pretty
87 Prettify the format of the displayed values, it corresponds to the
88 options "-unit -prefix -byte_binary_prefix -sexagesimal".
89
90 @item -print_format @var{format}
91 Set the output printing format.
92 Current available formats are "default" and "json".
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 @include decoders.texi
122 @include demuxers.texi
123 @include protocols.texi
124 @include indevs.texi
125
126 @ignore
127
128 @setfilename ffprobe
129 @settitle ffprobe media prober
130
131 @c man begin SEEALSO
132 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
133 @c man end
134
135 @c man begin AUTHORS
136 The FFmpeg developers
137 @c man end
138
139 @end ignore
140
141 @bye