diff options
author | Ganesh Ajjanagadde <gajjanagadde@gmail.com> | 2015-10-10 19:48:08 +0300 |
---|---|---|
committer | Michael Niedermayer <michael@niedermayer.cc> | 2015-10-10 21:49:54 +0300 |
commit | f3fc103c6a8ed8e7056052c54508470eede46566 (patch) | |
tree | 4b38a5e5dfff2a33220676440afb5d7464a3de87 /doc/resampler.texi | |
parent | 07c60684a7502b256b1cded08dcdaec3dcdcc719 (diff) |
doc/resampler, swresample/options: use proper capitalization
Proper names should be capitalized in all user facing API as far as
possible. The option names themselves have not been changed since:
1. We consistently keep option names in lower case.
2. Changing them would break existing scripts.
3. I suspect that we want to be similar to Sox and its relevant options.
The converse is also true: improper names should not be capitalized
generally.
Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'doc/resampler.texi')
-rw-r--r-- | doc/resampler.texi | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/resampler.texi b/doc/resampler.texi index f9eef03f20..2c448ae2b9 100644 --- a/doc/resampler.texi +++ b/doc/resampler.texi @@ -94,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 @@ -132,7 +132,7 @@ 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 if set to 1, default value is 0. @item cutoff Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float @@ -214,13 +214,13 @@ 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 an integer in the interval [2,16], default value is 9. @item output_sample_bits |