[FFmpeg-devel] [PATCH] noise_bsf: mention the parameter in the docs

[Michael Niedermayer]

On Sun, Nov 30, 2014 at 02:45:54PM +0100, Christophe Gisquet wrote:
> Hi,
> 
> now that we can pass bsf arguments through the command-line, it's
> worth updating the documentation for it.
> 
> -- 
> Christophe

>  bitstream_filters.texi |    8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)
> 5e1eb6145ecc89ff897e78bd0444a0230971891f  0004-noise_bsf-mention-the-parameter-in-the-docs.patch
> From 4cd13dd05bb654ee311109c7289155ca82be5121 Mon Sep 17 00:00:00 2001
> From: Christophe Gisquet <christophe.gisquet at gmail.com>
> Date: Sun, 30 Nov 2014 11:59:22 +0100
> Subject: [PATCH 4/4] noise_bsf: mention the parameter in the docs
> 
> This looks more like a seed than an amount, as the variable name
> could lead to think.
> ---
>  doc/bitstream_filters.texi | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
> index 8124238..b3c5165 100644
> --- a/doc/bitstream_filters.texi
> +++ b/doc/bitstream_filters.texi
> @@ -21,7 +21,8 @@ name after a '='.
>  ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1/opt2=str2][,filter2] OUTPUT
>  @end example
>  
> -Below is a description of the currently available bitstream filters.
> +Below is a description of the currently available bitstream filters,
> +with their parameters, if any.
>  
>  @section aac_adtstoasc
>  
> @@ -143,8 +144,11 @@ ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
>  Damages the contents of packets without damaging the container. Can be
>  used for fuzzing or testing error resilience/concealment.
>  
> +Parameters:
> +A numeral string representing the seed of the noise.

its the inverse of the amount, so smaller numbers should result in
more noise with 1 resulting in the maximum

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

In a rich man's house there is no place to spit but his face.
-- Diogenes of Sinope
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 181 bytes
Desc: Digital signature
URL: <https://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20141130/af53d386/attachment.asc>