[FFmpeg-devel] [PATCH] doc/filters: added possible values to @item win_func

[Paul B Mahol]

On Wed, Sep 29, 2021 at 12:51 PM Arif Driessen <arifd86 at gmail.com> wrote:

> Here's your patch for `afftfilt` win_func. (copied from the surround
> filter, but checked against the code to ensure it's correct). If you like
> it, I'll do it for all the win_funcs.
>

Better add separate section, and than link to it with each filter docs,
instead copy paste lines 100 times.

>
> ---
>  doc/filters.texi | 27 ++++++++++++++++++++++++++-
>  1 file changed, 26 insertions(+), 1 deletion(-)
>
> diff --git a/doc/filters.texi b/doc/filters.texi
> index 568c2995bc..60403a628e 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -1325,7 +1325,32 @@ Set window size. Allowed range is from 16 to 131072.
>  Default is @code{4096}
>
>  @item win_func
> -Set window function. Default is @code{hann}.
> +Set window function.
> +
> +It accepts the following values:
> + at table @samp
> + at item rect
> + at item bartlett
> + at item hann, hanning
> + at item hamming
> + at item blackman
> + at item welch
> + at item flattop
> + at item bharris
> + at item bnuttall
> + at item bhann
> + at item sine
> + at item nuttall
> + at item lanczos
> + at item gauss
> + at item tukey
> + at item dolph
> + at item cauchy
> + at item parzen
> + at item poisson
> + at item bohman
> + at end table
> +Default is @code{hann}.
>
>  @item overlap
>  Set window overlap. If set to 1, the recommended overlap for selected
> --
> 2.30.2
>
>
>
> On Tue, Sep 28, 2021 at 4:56 PM Gyan Doshi <ffmpeg at gyani.pro> wrote:
>
> >
> >
> > On 2021-09-28 07:29 pm, Arif Driessen wrote:
> > >> These should be formatted like they are in the surround filter for the
> > > option with the same name.
> > >
> > > Good catch! Looking around, I see there are other filters too with a
> > > win_func option. When I next get a moment (either later today or more
> > > likely tomorrow) I'll double check with the code,
> > > and add documentation for those too. if that sounds good to you.
> > Sure. But let's start with this one.
> >
> > Regards,
> > Gyan
> > _______________________________________________
> > ffmpeg-devel mailing list
> > ffmpeg-devel at ffmpeg.org
> > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
> >
> > To unsubscribe, visit link above, or email
> > ffmpeg-devel-request at ffmpeg.org with subject "unsubscribe".
> >
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request at ffmpeg.org with subject "unsubscribe".
>