doc: merge syntax.texi, eval.texi and opencl.texi into utils.texi
[ffmpeg.git] / doc / resampler.texi
1 @chapter Resampler Options
2 @c man begin RESAMPLER OPTIONS
3
4 The audio resampler supports the following named options.
5
6 Options may be set by specifying -@var{option} @var{value} in the
7 FFmpeg tools, @var{option}=@var{value} for the aresample filter,
8 by setting the value explicitly in the
9 @code{SwrContext} options or using the @file{libavutil/opt.h} API for
10 programmatic use.
11
12 @table @option
13
14 @item ich, in_channel_count
15 Set the number of input channels. Default value is 0. Setting this
16 value is not mandatory if the corresponding channel layout
17 @option{in_channel_layout} is set.
18
19 @item och, out_channel_count
20 Set the number of output channels. Default value is 0. Setting this
21 value is not mandatory if the corresponding channel layout
22 @option{out_channel_layout} is set.
23
24 @item uch, used_channel_count
25 Set the number of used input channels. Default value is 0. This option is
26 only used for special remapping.
27
28 @item isr, in_sample_rate
29 Set the input sample rate. Default value is 0.
30
31 @item osr, out_sample_rate
32 Set the output sample rate. Default value is 0.
33
34 @item isf, in_sample_fmt
35 Specify the input sample format. It is set by default to @code{none}.
36
37 @item osf, out_sample_fmt
38 Specify the output sample format. It is set by default to @code{none}.
39
40 @item tsf, internal_sample_fmt
41 Set the internal sample format. Default value is @code{none}.
42 This will automatically be chosen when it is not explicitly set.
43
44 @item icl, in_channel_layout
45 Set the input channel layout.
46
47 @item ocl, out_channel_layout
48 Set the output channel layout.
49
50 @item clev, center_mix_level
51 Set the center mix level. It is a value expressed in deciBel, and must be
52 in the interval [-32,32].
53
54 @item slev, surround_mix_level
55 Set the surround mix level. It is a value expressed in deciBel, and must
56 be in the interval [-32,32].
57
58 @item lfe_mix_level
59 Set LFE mix into non LFE level. It is used when there is a LFE input but no
60 LFE output. It is a value expressed in deciBel, and must
61 be in the interval [-32,32].
62
63 @item rmvol, rematrix_volume
64 Set rematrix volume. Default value is 1.0.
65
66 @item flags, swr_flags
67 Set flags used by the converter. Default value is 0.
68
69 It supports the following individual flags:
70 @table @option
71 @item res
72 force resampling, this flag forces resampling to be used even when the
73 input and output sample rates match.
74 @end table
75
76 @item dither_scale
77 Set the dither scale. Default value is 1.
78
79 @item dither_method
80 Set dither method. Default value is 0.
81
82 Supported values:
83 @table @samp
84 @item rectangular
85 select rectangular dither
86 @item triangular
87 select triangular dither
88 @item triangular_hp
89 select triangular dither with high pass
90 @item lipshitz
91 select lipshitz noise shaping dither
92 @item shibata
93 select shibata noise shaping dither
94 @item low_shibata
95 select low shibata noise shaping dither
96 @item high_shibata
97 select high shibata noise shaping dither
98 @item f_weighted
99 select f-weighted noise shaping dither
100 @item modified_e_weighted
101 select modified-e-weighted noise shaping dither
102 @item improved_e_weighted
103 select improved-e-weighted noise shaping dither
104
105 @end table
106
107 @item resampler
108 Set resampling engine. Default value is swr.
109
110 Supported values:
111 @table @samp
112 @item swr
113 select the native SW Resampler; filter options precision and cheby are not
114 applicable in this case.
115 @item soxr
116 select the SoX Resampler (where available); compensation, and filter options
117 filter_size, phase_shift, filter_type & kaiser_beta, are not applicable in this
118 case.
119 @end table
120
121 @item filter_size
122 For swr only, set resampling filter size, default value is 32.
123
124 @item phase_shift
125 For swr only, set resampling phase shift, default value is 10, and must be in
126 the interval [0,30].
127
128 @item linear_interp
129 Use Linear Interpolation if set to 1, default value is 0.
130
131 @item cutoff
132 Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float
133 value between 0 and 1.  Default value is 0.97 with swr, and 0.91 with soxr
134 (which, with a sample-rate of 44100, preserves the entire audio band to 20kHz).
135
136 @item precision
137 For soxr only, the precision in bits to which the resampled signal will be
138 calculated.  The default value of 20 (which, with suitable dithering, is
139 appropriate for a destination bit-depth of 16) gives SoX's 'High Quality'; a
140 value of 28 gives SoX's 'Very High Quality'.
141
142 @item cheby
143 For soxr only, selects passband rolloff none (Chebyshev) & higher-precision
144 approximation for 'irrational' ratios. Default value is 0.
145
146 @item async
147 For swr only, simple 1 parameter audio sync to timestamps using stretching,
148 squeezing, filling and trimming. Setting this to 1 will enable filling and
149 trimming, larger values represent the maximum amount in samples that the data
150 may be stretched or squeezed for each second.
151 Default value is 0, thus no compensation is applied to make the samples match
152 the audio timestamps.
153
154 @item first_pts
155 For swr only, assume the first pts should be this value. The time unit is 1 / sample rate.
156 This allows for padding/trimming at the start of stream. By default, no
157 assumption is made about the first frame's expected pts, so no padding or
158 trimming is done. For example, this could be set to 0 to pad the beginning with
159 silence if an audio stream starts after the video stream or to trim any samples
160 with a negative pts due to encoder delay.
161
162 @item min_comp
163 For swr only, set the minimum difference between timestamps and audio data (in
164 seconds) to trigger stretching/squeezing/filling or trimming of the
165 data to make it match the timestamps. The default is that
166 stretching/squeezing/filling and trimming is disabled
167 (@option{min_comp} = @code{FLT_MAX}).
168
169 @item min_hard_comp
170 For swr only, set the minimum difference between timestamps and audio data (in
171 seconds) to trigger adding/dropping samples to make it match the
172 timestamps.  This option effectively is a threshold to select between
173 hard (trim/fill) and soft (squeeze/stretch) compensation. Note that
174 all compensation is by default disabled through @option{min_comp}.
175 The default is 0.1.
176
177 @item comp_duration
178 For swr only, set duration (in seconds) over which data is stretched/squeezed
179 to make it match the timestamps. Must be a non-negative double float value,
180 default value is 1.0.
181
182 @item max_soft_comp
183 For swr only, set maximum factor by which data is stretched/squeezed to make it
184 match the timestamps. Must be a non-negative double float value, default value
185 is 0.
186
187 @item matrix_encoding
188 Select matrixed stereo encoding.
189
190 It accepts the following values:
191 @table @samp
192 @item none
193 select none
194 @item dolby
195 select Dolby
196 @item dplii
197 select Dolby Pro Logic II
198 @end table
199
200 Default value is @code{none}.
201
202 @item filter_type
203 For swr only, select resampling filter type. This only affects resampling
204 operations.
205
206 It accepts the following values:
207 @table @samp
208 @item cubic
209 select cubic
210 @item blackman_nuttall
211 select Blackman Nuttall Windowed Sinc
212 @item kaiser
213 select Kaiser Windowed Sinc
214 @end table
215
216 @item kaiser_beta
217 For swr only, set Kaiser Window Beta value. Must be an integer in the
218 interval [2,16], default value is 9.
219
220 @end table
221
222 @c man end RESAMPLER OPTIONS