diff mbox

[FFmpeg-devel] Updated the documentation for libaom encoder options.

Message ID 20190410005551.238625-1-samjohn@google.com
State New
Headers show

Commit Message

Diego Felix de Souza via ffmpeg-devel April 10, 2019, 12:55 a.m. UTC
---
 doc/encoders.texi | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

Comments

Diego Felix de Souza via ffmpeg-devel April 17, 2019, 7:03 p.m. UTC | #1
Hi,

Is there anything to be done for this patch ?

Thanks
Sam John

On Tue, Apr 9, 2019 at 5:55 PM Sam John <samjohn@google.com> wrote:

> ---
>  doc/encoders.texi | 47 +++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 47 insertions(+)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 94337d009c..15b9199549 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1434,6 +1434,16 @@ value is 1, which will be slow and high quality.
>  Enable use of alternate reference frames.  Defaults to the internal
>  default of the library.
>
> +@item arnr-max-frames
> +Set altref noise reduction max frame count.
> +
> +@item arnr-strength
> +Set altref noise reduction filter strength.
> +
> +@item aq-mode
> +Set adaptive quantization mode (0: off (default), 1: variance 2:
> complexity, 3:
> +cyclic refresh).
> +
>  @item lag-in-frames
>  Set the maximum number of frames which the encoder may keep in flight
>  at any one time for lookahead purposes.  Defaults to the internal
> @@ -1466,6 +1476,31 @@ buffer falls below this percentage, frames will be
> dropped until it
>  has refilled above the threshold.  Defaults to zero (no frames are
>  dropped).
>
> +@item denoise-noise-level
> +Amount of noise to be removed for grain synthesis. Grain synthesis is
> disabled if
> +this option is not set or set to 0.
> +
> +@item denoise-block-size
> +Block size used for denoising for grain synthesis. If not set, AV1 codec
> +uses the default value of 32.
> +
> +@item undershoot-pct
> +Set datarate undershoot (min) percentage of the target bitrate.
> +
> +@item overshoot-pct
> +Set datarate overshoot (max) percentage of the target bitrate.
> +
> +@item maxsection-pct
> +Maximum percentage variation of the GOP bitrate from the target bitrate.
> If maxsection-pct
> +is not set, the libaomenc wrapper computes it as follows: @code{(maxrate
> * 100 / bitrate)}.
> +
> +@item minrate
> +Minimum percentage variation of the GOP bitrate from the target bitrate.
> If minsection-pct
> +is not set, the libaomenc wrapper computes it as follows: @code{(minrate
> * 100 / bitrate)}.
> +
> +@item frame-parallel @var{boolean}
> +Enable frame parallel decodability features. The default value is true.
> +
>  @item tiles
>  Set the number of tiles to encode the input video with, as columns x
>  rows.  Larger numbers allow greater parallelism in both encoding and
> @@ -1480,6 +1515,18 @@ Provided for compatibility with libvpx/VP9.
>  @item row-mt (Requires libaom >= 1.0.0-759-g90a15f4f2)
>  Enable row based multi-threading. Disabled by default.
>
> +@item enable-cdef @var{boolean}
> +Flag to enable or disable Constrained Directional Enhancement Filter. The
> libaom-av1
> +encoder enables CDEF by default.
> +
> +@item enable-global-motion @var{boolean}
> +Flag to enable or disable the use of global motion for block prediction.
> +The default value is true.
> +
> +@item enable-intrabc @var{boolean}
> +Flag to enable or disable block copy mode for intra block prediction.
> This mode is
> +useful for screen content. The default value is true.
> +
>  @end table
>
>  @section libkvazaar
> --
> 2.21.0.392.gf8f6787159e-goog
>
>
Gyan Doshi April 17, 2019, 7:17 p.m. UTC | #2
On 18-04-2019 12:33 AM, Sam John via ffmpeg-devel wrote:
> Hi,
>
> Is there anything to be done for this patch ?
>
Just a tiny bit of formatting, which I'll do and push.

Thanks,
Gyan


> On Tue, Apr 9, 2019 at 5:55 PM Sam John <samjohn@google.com> wrote:
>
>> ---
>>   doc/encoders.texi | 47 +++++++++++++++++++++++++++++++++++++++++++++++
>>   1 file changed, 47 insertions(+)
>>
>> diff --git a/doc/encoders.texi b/doc/encoders.texi
>> index 94337d009c..15b9199549 100644
>> --- a/doc/encoders.texi
>> +++ b/doc/encoders.texi
>> @@ -1434,6 +1434,16 @@ value is 1, which will be slow and high quality.
>>   Enable use of alternate reference frames.  Defaults to the internal
>>   default of the library.
>>
>> +@item arnr-max-frames
>> +Set altref noise reduction max frame count.
>> +
>> +@item arnr-strength
>> +Set altref noise reduction filter strength.
>> +
>> +@item aq-mode
>> +Set adaptive quantization mode (0: off (default), 1: variance 2:
>> complexity, 3:
>> +cyclic refresh).
>> +
>>   @item lag-in-frames
>>   Set the maximum number of frames which the encoder may keep in flight
>>   at any one time for lookahead purposes.  Defaults to the internal
>> @@ -1466,6 +1476,31 @@ buffer falls below this percentage, frames will be
>> dropped until it
>>   has refilled above the threshold.  Defaults to zero (no frames are
>>   dropped).
>>
>> +@item denoise-noise-level
>> +Amount of noise to be removed for grain synthesis. Grain synthesis is
>> disabled if
>> +this option is not set or set to 0.
>> +
>> +@item denoise-block-size
>> +Block size used for denoising for grain synthesis. If not set, AV1 codec
>> +uses the default value of 32.
>> +
>> +@item undershoot-pct
>> +Set datarate undershoot (min) percentage of the target bitrate.
>> +
>> +@item overshoot-pct
>> +Set datarate overshoot (max) percentage of the target bitrate.
>> +
>> +@item maxsection-pct
>> +Maximum percentage variation of the GOP bitrate from the target bitrate.
>> If maxsection-pct
>> +is not set, the libaomenc wrapper computes it as follows: @code{(maxrate
>> * 100 / bitrate)}.
>> +
>> +@item minrate
>> +Minimum percentage variation of the GOP bitrate from the target bitrate.
>> If minsection-pct
>> +is not set, the libaomenc wrapper computes it as follows: @code{(minrate
>> * 100 / bitrate)}.
>> +
>> +@item frame-parallel @var{boolean}
>> +Enable frame parallel decodability features. The default value is true.
>> +
>>   @item tiles
>>   Set the number of tiles to encode the input video with, as columns x
>>   rows.  Larger numbers allow greater parallelism in both encoding and
>> @@ -1480,6 +1515,18 @@ Provided for compatibility with libvpx/VP9.
>>   @item row-mt (Requires libaom >= 1.0.0-759-g90a15f4f2)
>>   Enable row based multi-threading. Disabled by default.
>>
>> +@item enable-cdef @var{boolean}
>> +Flag to enable or disable Constrained Directional Enhancement Filter. The
>> libaom-av1
>> +encoder enables CDEF by default.
>> +
>> +@item enable-global-motion @var{boolean}
>> +Flag to enable or disable the use of global motion for block prediction.
>> +The default value is true.
>> +
>> +@item enable-intrabc @var{boolean}
>> +Flag to enable or disable block copy mode for intra block prediction.
>> This mode is
>> +useful for screen content. The default value is true.
>> +
>>   @end table
>>
>>   @section libkvazaar
>> --
>> 2.21.0.392.gf8f6787159e-goog
>>
>>
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
Gyan Doshi April 18, 2019, 7:42 a.m. UTC | #3
On 18-04-2019 12:47 AM, Gyan wrote:
>
>
> On 18-04-2019 12:33 AM, Sam John via ffmpeg-devel wrote:
>> Hi,
>>
>> Is there anything to be done for this patch ?
>>
> Just a tiny bit of formatting, which I'll do and push.

Added some details; fixed some formatting and

pushed as 88325f4b34dd927da680fe180d4ebdc5f8464e39

Gyan
diff mbox

Patch

diff --git a/doc/encoders.texi b/doc/encoders.texi
index 94337d009c..15b9199549 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1434,6 +1434,16 @@  value is 1, which will be slow and high quality.
 Enable use of alternate reference frames.  Defaults to the internal
 default of the library.
 
+@item arnr-max-frames
+Set altref noise reduction max frame count.
+
+@item arnr-strength
+Set altref noise reduction filter strength.
+
+@item aq-mode
+Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3:
+cyclic refresh).
+
 @item lag-in-frames
 Set the maximum number of frames which the encoder may keep in flight
 at any one time for lookahead purposes.  Defaults to the internal
@@ -1466,6 +1476,31 @@  buffer falls below this percentage, frames will be dropped until it
 has refilled above the threshold.  Defaults to zero (no frames are
 dropped).
 
+@item denoise-noise-level
+Amount of noise to be removed for grain synthesis. Grain synthesis is disabled if 
+this option is not set or set to 0.
+
+@item denoise-block-size
+Block size used for denoising for grain synthesis. If not set, AV1 codec
+uses the default value of 32.
+
+@item undershoot-pct
+Set datarate undershoot (min) percentage of the target bitrate.
+
+@item overshoot-pct
+Set datarate overshoot (max) percentage of the target bitrate.
+
+@item maxsection-pct
+Maximum percentage variation of the GOP bitrate from the target bitrate. If maxsection-pct
+is not set, the libaomenc wrapper computes it as follows: @code{(maxrate * 100 / bitrate)}.
+
+@item minrate
+Minimum percentage variation of the GOP bitrate from the target bitrate. If minsection-pct
+is not set, the libaomenc wrapper computes it as follows: @code{(minrate * 100 / bitrate)}.
+
+@item frame-parallel @var{boolean}
+Enable frame parallel decodability features. The default value is true.
+
 @item tiles
 Set the number of tiles to encode the input video with, as columns x
 rows.  Larger numbers allow greater parallelism in both encoding and
@@ -1480,6 +1515,18 @@  Provided for compatibility with libvpx/VP9.
 @item row-mt (Requires libaom >= 1.0.0-759-g90a15f4f2)
 Enable row based multi-threading. Disabled by default.
 
+@item enable-cdef @var{boolean}
+Flag to enable or disable Constrained Directional Enhancement Filter. The libaom-av1
+encoder enables CDEF by default.
+
+@item enable-global-motion @var{boolean}
+Flag to enable or disable the use of global motion for block prediction. 
+The default value is true.
+
+@item enable-intrabc @var{boolean}
+Flag to enable or disable block copy mode for intra block prediction. This mode is
+useful for screen content. The default value is true.
+
 @end table
 
 @section libkvazaar