ffmpeg-resampler.texi 7.72 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
\input texinfo @c -*- texinfo -*-

@settitle FFmpeg Resampler Documentation
@titlepage
@center @titlefont{FFmpeg Resampler Documentation}
@end titlepage

@top

@contents

@chapter Description
@c man begin DESCRIPTION

The FFmpeg resampler provides an high-level interface to the
libswresample library audio resampling utilities. In particular it
allows to perform audio resampling, audio channel layout rematrixing,
and convert audio format and packing layout.

@c man end DESCRIPTION

@chapter Resampler Options
@c man begin RESAMPLER OPTIONS

The audio resampler supports the following named options.

Options may be set by specifying -@var{option} @var{value} in the
28 29
FFmpeg tools, @var{option}=@var{value} for the aresample filter,
by setting the value explicitly in the
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
@code{SwrContext} options or using the @file{libavutil/opt.h} API for
programmatic use.

@table @option

@item ich, in_channel_count
Set the number of input channels. Default value is 0. Setting this
value is not mandatory if the corresponding channel layout
@option{in_channel_layout} is set.

@item och, out_channel_count
Set the number of output channels. Default value is 0. Setting this
value is not mandatory if the corresponding channel layout
@option{out_channel_layout} is set.

@item uch, used_channel_count
46
Set the number of used input channels. Default value is 0. This option is
47 48 49 50 51 52 53 54 55
only used for special remapping.

@item isr, in_sample_rate
Set the input sample rate. Default value is 0.

@item osr, out_sample_rate
Set the output sample rate. Default value is 0.

@item isf, in_sample_fmt
56
Specify the input sample format. It is set by default to @code{none}.
57 58

@item osf, out_sample_fmt
59
Specify the output sample format. It is set by default to @code{none}.
60 61

@item tsf, internal_sample_fmt
62
Set the internal sample format. Default value is @code{none}.
63
This will automatically be chosen when it is not explicitly set.
64 65 66 67 68 69 70 71

@item icl, in_channel_layout
Set the input channel layout.

@item ocl, out_channel_layout
Set the output channel layout.

@item clev, center_mix_level
72 73
Set the center mix level. It is a value expressed in deciBel, and must be
in the interval [-32,32].
74 75

@item slev, surround_mix_level
76 77
Set the surround mix level. It is a value expressed in deciBel, and must
be in the interval [-32,32].
78

Michael Niedermayer's avatar
Michael Niedermayer committed
79
@item lfe_mix_level
80 81
Set LFE mix into non LFE level. It is used when there is a LFE input but no
LFE output. It is a value expressed in deciBel, and must
82
be in the interval [-32,32].
83 84 85 86 87 88 89 90 91 92

@item rmvol, rematrix_volume
Set rematrix volume. Default value is 1.0.

@item flags, swr_flags
Set flags used by the converter. Default value is 0.

It supports the following individual flags:
@table @option
@item res
93 94
force resampling, this flag forces resampling to be used even when the
input and output sample rates match.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
@end table

@item dither_scale
Set the dither scale. Default value is 1.

@item dither_method
Set dither method. Default value is 0.

Supported values:
@table @samp
@item rectangular
select rectangular dither
@item triangular
select triangular dither
@item triangular_hp
select triangular dither with high pass
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
@item lipshitz
select lipshitz noise shaping dither
@item shibata
select shibata noise shaping dither
@item low_shibata
select low shibata noise shaping dither
@item high_shibata
select high shibata noise shaping dither
@item f_weighted
select f-weighted noise shaping dither
@item modified_e_weighted
select modified-e-weighted noise shaping dither
@item improved_e_weighted
select improved-e-weighted noise shaping dither

126 127
@end table

Rob Sykes's avatar
Rob Sykes committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141
@item resampler
Set resampling engine. Default value is swr.

Supported values:
@table @samp
@item swr
select the native SW Resampler; filter options precision and cheby are not
applicable in this case.
@item soxr
select the SoX Resampler (where available); compensation, and filter options
filter_size, phase_shift, filter_type & kaiser_beta, are not applicable in this
case.
@end table

142
@item filter_size
143
For swr only, set resampling filter size, default value is 32.
144 145

@item phase_shift
146 147
For swr only, set resampling phase shift, default value is 10, and must be in
the interval [0,30].
148 149 150 151 152

@item linear_interp
Use Linear Interpolation if set to 1, default value is 0.

@item cutoff
Rob Sykes's avatar
Rob Sykes committed
153
Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float
154
value between 0 and 1.  Default value is 0.97 with swr, and 0.91 with soxr
Rob Sykes's avatar
Rob Sykes committed
155 156 157 158 159 160 161 162 163 164 165
(which, with a sample-rate of 44100, preserves the entire audio band to 20kHz).

@item precision
For soxr only, the precision in bits to which the resampled signal will be
calculated.  The default value of 20 (which, with suitable dithering, is
appropriate for a destination bit-depth of 16) gives SoX's 'High Quality'; a
value of 28 gives SoX's 'Very High Quality'.

@item cheby
For soxr only, selects passband rolloff none (Chebyshev) & higher-precision
approximation for 'irrational' ratios. Default value is 0.
166

167 168 169 170 171 172 173 174
@item async
For swr only, simple 1 parameter audio sync to timestamps using stretching,
squeezing, filling and trimming. Setting this to 1 will enable filling and
trimming, larger values represent the maximum amount in samples that the data
may be stretched or squeezed for each second.
Default value is 0, thus no compensation is applied to make the samples match
the audio timestamps.

175 176 177 178 179 180 181 182
@item first_pts
For swr only, assume the first pts should be this value. The time unit is 1 / sample rate.
This allows for padding/trimming at the start of stream. By default, no
assumption is made about the first frame's expected pts, so no padding or
trimming is done. For example, this could be set to 0 to pad the beginning with
silence if an audio stream starts after the video stream or to trim any samples
with a negative pts due to encoder delay.

183
@item min_comp
Rob Sykes's avatar
Rob Sykes committed
184
For swr only, set the minimum difference between timestamps and audio data (in
185 186 187 188
seconds) to trigger stretching/squeezing/filling or trimming of the
data to make it match the timestamps. The default is that
stretching/squeezing/filling and trimming is disabled
(@option{min_comp} = @code{FLT_MAX}).
189 190

@item min_hard_comp
Rob Sykes's avatar
Rob Sykes committed
191
For swr only, set the minimum difference between timestamps and audio data (in
192 193 194 195 196
seconds) to trigger adding/dropping samples to make it match the
timestamps.  This option effectively is a threshold to select between
hard (trim/fill) and soft (squeeze/stretch) compensation. Note that
all compensation is by default disabled through @option{min_comp}.
The default is 0.1.
197 198

@item comp_duration
Rob Sykes's avatar
Rob Sykes committed
199 200 201
For swr only, set duration (in seconds) over which data is stretched/squeezed
to make it match the timestamps. Must be a non-negative double float value,
default value is 1.0.
202 203

@item max_soft_comp
Rob Sykes's avatar
Rob Sykes committed
204 205 206
For swr only, set maximum factor by which data is stretched/squeezed to make it
match the timestamps. Must be a non-negative double float value, default value
is 0.
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

@item matrix_encoding
Select matrixed stereo encoding.

It accepts the following values:
@table @samp
@item none
select none
@item dolby
select Dolby
@item dplii
select Dolby Pro Logic II
@end table

Default value is @code{none}.

@item filter_type
Rob Sykes's avatar
Rob Sykes committed
224
For swr only, select resampling filter type. This only affects resampling
225 226 227 228 229 230 231 232 233 234 235 236 237
operations.

It accepts the following values:
@table @samp
@item cubic
select cubic
@item blackman_nuttall
select Blackman Nuttall Windowed Sinc
@item kaiser
select Kaiser Windowed Sinc
@end table

@item kaiser_beta
238 239
For swr only, set Kaiser Window Beta value. Must be an integer in the
interval [2,16], default value is 9.
240 241 242 243 244

@end table

@c man end RESAMPLER OPTIONS

245 246 247 248
@chapter See Also

@ifhtml
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
249
@url{libswresample.html,libswresample}
250 251 252 253 254 255
@end ifhtml

@ifnothtml
ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libswresample(3)
@end ifnothtml

256 257
@include authors.texi

258 259 260 261 262 263
@ignore

@setfilename ffmpeg-resampler
@settitle FFmpeg Resampler

@end ignore
264 265

@bye