diff options
author | Ganesh Ajjanagadde <gajjanagadde@gmail.com> | 2015-10-10 12:48:08 -0400 |
---|---|---|
committer | Michael Niedermayer <michael@niedermayer.cc> | 2015-10-10 20:49:54 +0200 |
commit | f3fc103c6a8ed8e7056052c54508470eede46566 (patch) | |
tree | 4b38a5e5dfff2a33220676440afb5d7464a3de87 | |
parent | 07c60684a7502b256b1cded08dcdaec3dcdcc719 (diff) | |
download | ffmpeg-f3fc103c6a8ed8e7056052c54508470eede46566.tar.gz |
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>
-rw-r--r-- | doc/resampler.texi | 16 | ||||
-rw-r--r-- | libswresample/options.c | 14 | ||||
-rw-r--r-- | libswresample/swresample.h | 4 |
3 files changed, 17 insertions, 17 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 diff --git a/libswresample/options.c b/libswresample/options.c index 1bc1a70510..0bcb102a35 100644 --- a/libswresample/options.c +++ b/libswresample/options.c @@ -74,10 +74,10 @@ static const AVOption options[]={ {"rectangular" , "select rectangular dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_RECTANGULAR}, INT_MIN, INT_MAX , PARAM, "dither_method"}, {"triangular" , "select triangular dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_TRIANGULAR }, INT_MIN, INT_MAX , PARAM, "dither_method"}, {"triangular_hp" , "select triangular dither with high pass" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_TRIANGULAR_HIGHPASS }, INT_MIN, INT_MAX, PARAM, "dither_method"}, -{"lipshitz" , "select lipshitz noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_LIPSHITZ}, INT_MIN, INT_MAX, PARAM, "dither_method"}, -{"shibata" , "select shibata noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_SHIBATA }, INT_MIN, INT_MAX, PARAM, "dither_method"}, -{"low_shibata" , "select low shibata noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_LOW_SHIBATA }, INT_MIN, INT_MAX, PARAM, "dither_method"}, -{"high_shibata" , "select high shibata noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_HIGH_SHIBATA }, INT_MIN, INT_MAX, PARAM, "dither_method"}, +{"lipshitz" , "select Lipshitz noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_LIPSHITZ}, INT_MIN, INT_MAX, PARAM, "dither_method"}, +{"shibata" , "select Shibata noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_SHIBATA }, INT_MIN, INT_MAX, PARAM, "dither_method"}, +{"low_shibata" , "select low Shibata noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_LOW_SHIBATA }, INT_MIN, INT_MAX, PARAM, "dither_method"}, +{"high_shibata" , "select high Shibata noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_HIGH_SHIBATA }, INT_MIN, INT_MAX, PARAM, "dither_method"}, {"f_weighted" , "select f-weighted noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_F_WEIGHTED }, INT_MIN, INT_MAX, PARAM, "dither_method"}, {"modified_e_weighted" , "select modified-e-weighted noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_MODIFIED_E_WEIGHTED }, INT_MIN, INT_MAX, PARAM, "dither_method"}, {"improved_e_weighted" , "select improved-e-weighted noise shaping dither" , 0 , AV_OPT_TYPE_CONST, {.i64=SWR_DITHER_NS_IMPROVED_E_WEIGHTED }, INT_MIN, INT_MAX, PARAM, "dither_method"}, @@ -117,10 +117,10 @@ static const AVOption options[]={ { "filter_type" , "select swr filter type" , OFFSET(filter_type) , AV_OPT_TYPE_INT , { .i64 = SWR_FILTER_TYPE_KAISER }, SWR_FILTER_TYPE_CUBIC, SWR_FILTER_TYPE_KAISER, PARAM, "filter_type" }, { "cubic" , "select cubic" , 0 , AV_OPT_TYPE_CONST, { .i64 = SWR_FILTER_TYPE_CUBIC }, INT_MIN, INT_MAX, PARAM, "filter_type" }, - { "blackman_nuttall", "select Blackman Nuttall Windowed Sinc", 0 , AV_OPT_TYPE_CONST, { .i64 = SWR_FILTER_TYPE_BLACKMAN_NUTTALL }, INT_MIN, INT_MAX, PARAM, "filter_type" }, - { "kaiser" , "select Kaiser Windowed Sinc" , 0 , AV_OPT_TYPE_CONST, { .i64 = SWR_FILTER_TYPE_KAISER }, INT_MIN, INT_MAX, PARAM, "filter_type" }, + { "blackman_nuttall", "select Blackman Nuttall windowed sinc", 0 , AV_OPT_TYPE_CONST, { .i64 = SWR_FILTER_TYPE_BLACKMAN_NUTTALL }, INT_MIN, INT_MAX, PARAM, "filter_type" }, + { "kaiser" , "select Kaiser windowed sinc" , 0 , AV_OPT_TYPE_CONST, { .i64 = SWR_FILTER_TYPE_KAISER }, INT_MIN, INT_MAX, PARAM, "filter_type" }, -{ "kaiser_beta" , "set swr Kaiser Window Beta" , OFFSET(kaiser_beta) , AV_OPT_TYPE_INT , {.i64=9 }, 2 , 16 , PARAM }, +{ "kaiser_beta" , "set swr Kaiser window beta" , OFFSET(kaiser_beta) , AV_OPT_TYPE_INT , {.i64=9 }, 2 , 16 , PARAM }, { "output_sample_bits" , "set swr number of output sample bits", OFFSET(dither.output_sample_bits), AV_OPT_TYPE_INT , {.i64=0 }, 0 , 64 , PARAM }, {0} diff --git a/libswresample/swresample.h b/libswresample/swresample.h index e1617f472f..10eaebc439 100644 --- a/libswresample/swresample.h +++ b/libswresample/swresample.h @@ -169,8 +169,8 @@ enum SwrEngine { /** Resampling Filter Types */ enum SwrFilterType { SWR_FILTER_TYPE_CUBIC, /**< Cubic */ - SWR_FILTER_TYPE_BLACKMAN_NUTTALL, /**< Blackman Nuttall Windowed Sinc */ - SWR_FILTER_TYPE_KAISER, /**< Kaiser Windowed Sinc */ + SWR_FILTER_TYPE_BLACKMAN_NUTTALL, /**< Blackman Nuttall windowed sinc */ + SWR_FILTER_TYPE_KAISER, /**< Kaiser windowed sinc */ }; /** |