doc/formats: Add documentation for 3 parameters that have been missing
[ffmpeg.git] / doc / formats.texi
1 @chapter Format Options
2 @c man begin FORMAT OPTIONS
3
4 The libavformat library provides some generic global options, which
5 can be set on all the muxers and demuxers. In addition each muxer or
6 demuxer may support so-called private options, which are specific for
7 that component.
8
9 Options may be set by specifying -@var{option} @var{value} in the
10 FFmpeg tools, or by setting the value explicitly in the
11 @code{AVFormatContext} options or using the @file{libavutil/opt.h} API
12 for programmatic use.
13
14 The list of supported options follows:
15
16 @table @option
17 @item avioflags @var{flags} (@emph{input/output})
18 Possible values:
19 @table @samp
20 @item direct
21 Reduce buffering.
22 @end table
23
24 @item probesize @var{integer} (@emph{input})
25 Set probing size in bytes, i.e. the size of the data to analyze to get
26 stream information. A higher value will allow to detect more
27 information in case it is dispersed into the stream, but will increase
28 latency. Must be an integer not lesser than 32. It is 5000000 by default.
29
30 @item packetsize @var{integer} (@emph{output})
31 Set packet size.
32
33 @item fflags @var{flags} (@emph{input/output})
34 Set format flags.
35
36 Possible values:
37 @table @samp
38 @item ignidx
39 Ignore index.
40 @item genpts
41 Generate PTS.
42 @item nofillin
43 Do not fill in missing values that can be exactly calculated.
44 @item noparse
45 Disable AVParsers, this needs @code{+nofillin} too.
46 @item igndts
47 Ignore DTS.
48 @item discardcorrupt
49 Discard corrupted frames.
50 @item sortdts
51 Try to interleave output packets by DTS.
52 @item keepside
53 Do not merge side data.
54 @item latm
55 Enable RTP MP4A-LATM payload.
56 @item nobuffer
57 Reduce the latency introduced by optional buffering
58 @end table
59
60 @item seek2any @var{integer} (@emph{input})
61 Forces seeking to enable seek to any mode if set to 1. Default is 0.
62
63 @item analyzeduration @var{integer} (@emph{input})
64 Specify how many microseconds are analyzed to probe the input. A
65 higher value will allow to detect more accurate information, but will
66 increase latency. It defaults to 5,000,000 microseconds = 5 seconds.
67
68 @item cryptokey @var{hexadecimal string} (@emph{input})
69 Set decryption key.
70
71 @item indexmem @var{integer} (@emph{input})
72 Set max memory used for timestamp index (per stream).
73
74 @item rtbufsize @var{integer} (@emph{input})
75 Set max memory used for buffering real-time frames.
76
77 @item fdebug @var{flags} (@emph{input/output})
78 Print specific debug info.
79
80 Possible values:
81 @table @samp
82 @item ts
83 @end table
84
85 @item max_delay @var{integer} (@emph{input/output})
86 Set maximum muxing or demuxing delay in microseconds.
87
88 @item fpsprobesize @var{integer} (@emph{input})
89 Set number of frames used to probe fps.
90
91 @item audio_preload @var{integer} (@emph{output})
92 Set microseconds by which audio packets should be interleaved earlier.
93
94 @item chunk_duration @var{integer} (@emph{output})
95 Set microseconds for each chunk.
96
97 @item chunk_size @var{integer} (@emph{output})
98 Set size in bytes for each chunk.
99
100 @item err_detect, f_err_detect @var{flags} (@emph{input})
101 Set error detection flags. @code{f_err_detect} is deprecated and
102 should be used only via the @command{ffmpeg} tool.
103
104 Possible values:
105 @table @samp
106 @item crccheck
107 Verify embedded CRCs.
108 @item bitstream
109 Detect bitstream specification deviations.
110 @item buffer
111 Detect improper bitstream length.
112 @item explode
113 Abort decoding on minor error detection.
114 @item careful
115 Consider things that violate the spec and have not been seen in the
116 wild as errors.
117 @item compliant
118 Consider all spec non compliancies as errors.
119 @item aggressive
120 Consider things that a sane encoder should not do as an error.
121 @end table
122
123 @item use_wallclock_as_timestamps @var{integer} (@emph{input})
124 Use wallclock as timestamps.
125
126 @item avoid_negative_ts @var{integer} (@emph{output})
127 Shift timestamps to make them non-negative. A value of 1 enables shifting,
128 a value of 0 disables it, the default value of -1 enables shifting
129 when required by the target format.
130
131 When shifting is enabled, all output timestamps are shifted by the
132 same amount. Audio, video, and subtitles desynching and relative
133 timestamp differences are preserved compared to how they would have
134 been without shifting.
135
136 Also note that this affects only leading negative timestamps, and not
137 non-monotonic negative timestamps.
138
139 @item skip_initial_bytes @var{integer} (@emph{input})
140 Set number initial bytes to skip. Default is 0.
141
142 @item correct_ts_overflow @var{integer} (@emph{input})
143 Correct single timestamp overflows if set to 1. Default is 1.
144
145 @item flush_packets @var{integer} (@emph{output})
146 Flush the underlying I/O stream after each packet. Default 1 enables it, and
147 has the effect of reducing the latency; 0 disables it and may slightly
148 increase performance in some cases.
149 @end table
150
151 @c man end FORMAT OPTIONS
152
153 @anchor{Format stream specifiers}
154 @section Format stream specifiers
155
156 Format stream specifiers allow selection of one or more streams that
157 match specific properties.
158
159 Possible forms of stream specifiers are:
160 @table @option
161 @item @var{stream_index}
162 Matches the stream with this index.
163
164 @item @var{stream_type}[:@var{stream_index}]
165 @var{stream_type} is one of following: 'v' for video, 'a' for audio,
166 's' for subtitle, 'd' for data, and 't' for attachments. If
167 @var{stream_index} is given, then it matches the stream number
168 @var{stream_index} of this type. Otherwise, it matches all streams of
169 this type.
170
171 @item p:@var{program_id}[:@var{stream_index}]
172 If @var{stream_index} is given, then it matches the stream with number
173 @var{stream_index} in the program with the id
174 @var{program_id}. Otherwise, it matches all streams in the program.
175
176 @item #@var{stream_id}
177 Matches the stream by a format-specific ID.
178 @end table
179
180 The exact semantics of stream specifiers is defined by the
181 @code{avformat_match_stream_specifier()} function declared in the
182 @file{libavformat/avformat.h} header.
183
184 @include demuxers.texi
185 @include muxers.texi
186 @include metadata.texi