[FFmpeg-devel] [PATCH 3/3] doc/ffmpeg: expand -bsf documentation

[Stefano Sabatini]

On date Tuesday 2023-09-19 20:15:07 +0200, Anton Khirnov wrote:
> Explain how to pass options to filters.
> ---
>  doc/ffmpeg.texi | 15 ++++++++++++---
>  1 file changed, 12 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index d2864ff37e..cf47eb68d1 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -1893,9 +1893,18 @@ ffmpeg -i inurl -streamid 0:33 -streamid 1:36 out.ts
>  @end example
>  
>  @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
> -Set bitstream filters for matching streams. @var{bitstream_filters} is
> -a comma-separated list of bitstream filters. Use the @code{-bsfs} option
> -to get the list of bitstream filters.
> +Apply bitstream filters to matching streams.
> +

> + at var{bitstream_filters} is a comma-separated list of bitstream filter
> +specifications that will be applied to coded packets in the order they are
> +written in.

Nit: semantic slide from "bitstream filter specification" to
"bitstream filter" (we apply the filter, not its specification).

This is my take:

@var{bitstream_filters} is a comma-separated list of bitstream filter
specifications. The specified bitstream filters are applied to coded
packets in the order they are written in.

Probably "encoded" in place of "coded" to clarify that this is about
encoded streams.

> + at example
> + at var{filter}[=@var{optname0}=@var{optval0}:@var{optname1}=@var{optval1}:...]
> + at end example
> +Any of the ',=:' characters that are to be a part of an option value need to be
> +escaped with a backslash.
>
> +Use the @code{-bsfs} option to get the list of bitstream filters.

Looks good otherwise, thanks.