avcodec/wavpack: Fix integer overflow in DEC_MED() / INC_MED()
[ffmpeg.git] / doc / resampler.texi
index d37d53d..5ed3f43 100644 (file)
@@ -42,10 +42,11 @@ Set the internal sample format. Default value is @code{none}.
 This will automatically be chosen when it is not explicitly set.
 
 @item icl, in_channel_layout
-Set the input channel layout.
-
 @item ocl, out_channel_layout
-Set the output channel layout.
+Set the input/output channel layout.
+
+See @ref{channel layout syntax,,the Channel Layout section in the ffmpeg-utils(1) manual,ffmpeg-utils}
+for the required syntax.
 
 @item clev, center_mix_level
 Set the center mix level. It is a value expressed in deciBel, and must be
@@ -63,6 +64,11 @@ be in the interval [-32,32].
 @item rmvol, rematrix_volume
 Set rematrix volume. Default value is 1.0.
 
+@item rematrix_maxval
+Set maximum output value for rematrixing.
+This can be used to prevent clipping vs. preventing volume reduction.
+A value of 1.0 prevents clipping.
+
 @item flags, swr_flags
 Set flags used by the converter. Default value is 0.
 
@@ -88,13 +94,13 @@ select triangular dither
 @item triangular_hp
 select triangular dither with high pass
 @item lipshitz
-select lipshitz noise shaping dither
+select Lipshitz noise shaping dither.
 @item shibata
-select shibata noise shaping dither
+select Shibata noise shaping dither.
 @item low_shibata
-select low shibata noise shaping dither
+select low Shibata noise shaping dither.
 @item high_shibata
-select high shibata noise shaping dither
+select high Shibata noise shaping dither.
 @item f_weighted
 select f-weighted noise shaping dither
 @item modified_e_weighted
@@ -114,8 +120,8 @@ 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.
+filter_size, phase_shift, exact_rational, filter_type & kaiser_beta, are not
+applicable in this case.
 @end table
 
 @item filter_size
@@ -126,7 +132,13 @@ For swr only, set resampling phase shift, default value is 10, and must be in
 the interval [0,30].
 
 @item linear_interp
-Use Linear Interpolation if set to 1, default value is 0.
+Use linear interpolation when enabled (the default). Disable it if you want
+to preserve speed instead of quality when exact_rational fails.
+
+@item exact_rational
+For swr only, when enabled, try to use exact phase_count based on input and
+output sample rate. However, if it is larger than @code{1 << phase_shift},
+the phase_count will be @code{1 << phase_shift} as fallback. Default is enabled.
 
 @item cutoff
 Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float
@@ -208,15 +220,19 @@ It accepts the following values:
 @item cubic
 select cubic
 @item blackman_nuttall
-select Blackman Nuttall Windowed Sinc
+select Blackman Nuttall windowed sinc
 @item kaiser
-select Kaiser Windowed Sinc
+select Kaiser windowed sinc
 @end table
 
 @item kaiser_beta
-For swr only, set Kaiser Window Beta value. Must be an integer in the
+For swr only, set Kaiser window beta value. Must be a double float value in the
 interval [2,16], default value is 9.
 
+@item output_sample_bits
+For swr only, set number of used output sample bits for dithering. Must be an integer in the
+interval [0,64], default value is 0, which means it's not used.
+
 @end table
 
 @c man end RESAMPLER OPTIONS