diff mbox series

[FFmpeg-devel,v2,3/6] doc: update for libsvtav1 encoder

Message ID 1631928405-26935-3-git-send-email-lance.lmwang@gmail.com
State New
Headers show
Series [FFmpeg-devel,v2,1/6] avcodec/libsvtav1: Fix override setting of caps_internal
Related show

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished
andriy/make_ppc success Make finished
andriy/make_fate_ppc success Make fate finished

Commit Message

Limin Wang Sept. 18, 2021, 1:26 a.m. UTC
From: Limin Wang <lance.lmwang@gmail.com>

Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
---
 doc/encoders.texi | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

Comments

Jan Ekström Sept. 25, 2021, 11:32 a.m. UTC | #1
On Sat, Sep 18, 2021 at 4:27 AM <lance.lmwang@gmail.com> wrote:
>
> From: Limin Wang <lance.lmwang@gmail.com>
>
> Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
> ---

Hi,

"doc/encoders: add available values for libsvtav1 options"

would possibly be better as a commit message?

>  doc/encoders.texi | 44 ++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 44 insertions(+)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 8fccd73..64d604e 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1750,12 +1750,56 @@ You need to explicitly configure the build with @code{--enable-libsvtav1}.
>  @table @option
>  @item profile
>  Set the encoding profile.
> +@table @samp
> +@item main
> +@item high
> +@item professional
> +@end table
>
>  @item level
>  Set the operating point level.
> +@table @samp
> +@item 2.0
> +@item 2.1
> +@item 2.2
> +@item 2.3
> +@item 3.0
> +@item 3.1
> +@item 3.2
> +@item 3.3
> +@item 4.0
> +@item 4.1
> +@item 4.2
> +@item 4.3
> +@item 5.0
> +@item 5.1
> +@item 5.2
> +@item 5.3
> +@item 6.0
> +@item 6.1
> +@item 6.2
> +@item 6.3
> +@item 7.0
> +@item 7.1
> +@item 7.2
> +@item 7.3
> +@end table
> +

The levels list is somewhat long, and it's specific to AV1 and not
this encoder. I don't think we list H.264/HEVC etc levels, either?

So I'm not 100% sure on this bit, possibly just noting "Set the
operating point level, f.ex. '4.0'." is good enough?

> +@item hielevel
> +Set the Hierarchical prediction levels.
> +@table @samp
> +@item 3level
> +@item 4level, This is the default.

You probably mean this to be on a separate line. Right now it ends up
as part of the entry on the list a la: ‘4level, This is the default.’

Noticed through the HTML documentation output (ffmpeg-codecs.html).

> +@end table
>
>  @item tier
>  Set the operating point tier.
> +@table @samp
> +@item main
> +The main tier was designed for most applications. This is the default.
> +@item high
> +The high tier was designed for very demanding applications.
> +@end table
>

Looking at https://aomediacodec.github.io/av1-spec/av1-spec.pdf , it
seems like the high tier only enable higher bit rates/lower
compression ratios in levels.

I think explaining it like that is probably more understandable than
vague references for "most applications" and "very demanding
applications". Or only explaining which one is the default, as I would
expect a person who needs to set this flag to know what the tier flags
in AV1 bit stream mean.

Jan
Limin Wang Sept. 25, 2021, 1:01 p.m. UTC | #2
On Sat, Sep 25, 2021 at 02:32:43PM +0300, Jan Ekström wrote:
> On Sat, Sep 18, 2021 at 4:27 AM <lance.lmwang@gmail.com> wrote:
> >
> > From: Limin Wang <lance.lmwang@gmail.com>
> >
> > Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
> > ---
> 
> Hi,
> 
> "doc/encoders: add available values for libsvtav1 options"
> 
> would possibly be better as a commit message?

Sure, I'll change that.

> 
> >  doc/encoders.texi | 44 ++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 44 insertions(+)
> >
> > diff --git a/doc/encoders.texi b/doc/encoders.texi
> > index 8fccd73..64d604e 100644
> > --- a/doc/encoders.texi
> > +++ b/doc/encoders.texi
> > @@ -1750,12 +1750,56 @@ You need to explicitly configure the build with @code{--enable-libsvtav1}.
> >  @table @option
> >  @item profile
> >  Set the encoding profile.
> > +@table @samp
> > +@item main
> > +@item high
> > +@item professional
> > +@end table
> >
> >  @item level
> >  Set the operating point level.
> > +@table @samp
> > +@item 2.0
> > +@item 2.1
> > +@item 2.2
> > +@item 2.3
> > +@item 3.0
> > +@item 3.1
> > +@item 3.2
> > +@item 3.3
> > +@item 4.0
> > +@item 4.1
> > +@item 4.2
> > +@item 4.3
> > +@item 5.0
> > +@item 5.1
> > +@item 5.2
> > +@item 5.3
> > +@item 6.0
> > +@item 6.1
> > +@item 6.2
> > +@item 6.3
> > +@item 7.0
> > +@item 7.1
> > +@item 7.2
> > +@item 7.3
> > +@end table
> > +
> 
> The levels list is somewhat long, and it's specific to AV1 and not
> this encoder. I don't think we list H.264/HEVC etc levels, either?
> 
> So I'm not 100% sure on this bit, possibly just noting "Set the
> operating point level, f.ex. '4.0'." is good enough?

Yes, I think it's too long also. I can update by your idea.

> 
> > +@item hielevel
> > +Set the Hierarchical prediction levels.
> > +@table @samp
> > +@item 3level
> > +@item 4level, This is the default.
> 
> You probably mean this to be on a separate line. Right now it ends up
> as part of the entry on the list a la: ‘4level, This is the default.’
> 
> Noticed through the HTML documentation output (ffmpeg-codecs.html).

OK, will change that

> 
> > +@end table
> >
> >  @item tier
> >  Set the operating point tier.
> > +@table @samp
> > +@item main
> > +The main tier was designed for most applications. This is the default.
> > +@item high
> > +The high tier was designed for very demanding applications.
> > +@end table
> >
> 
> Looking at https://aomediacodec.github.io/av1-spec/av1-spec.pdf , it
> seems like the high tier only enable higher bit rates/lower
> compression ratios in levels.
> 
> I think explaining it like that is probably more understandable than
> vague references for "most applications" and "very demanding
> applications". Or only explaining which one is the default, as I would
> expect a person who needs to set this flag to know what the tier flags
> in AV1 bit stream mean.

OK, will only explaining which one is the default.

> 
> Jan
> _______________________________________________
> 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".
diff mbox series

Patch

diff --git a/doc/encoders.texi b/doc/encoders.texi
index 8fccd73..64d604e 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1750,12 +1750,56 @@  You need to explicitly configure the build with @code{--enable-libsvtav1}.
 @table @option
 @item profile
 Set the encoding profile.
+@table @samp
+@item main
+@item high
+@item professional
+@end table
 
 @item level
 Set the operating point level.
+@table @samp
+@item 2.0
+@item 2.1
+@item 2.2
+@item 2.3
+@item 3.0
+@item 3.1
+@item 3.2
+@item 3.3
+@item 4.0
+@item 4.1
+@item 4.2
+@item 4.3
+@item 5.0
+@item 5.1
+@item 5.2
+@item 5.3
+@item 6.0
+@item 6.1
+@item 6.2
+@item 6.3
+@item 7.0
+@item 7.1
+@item 7.2
+@item 7.3
+@end table
+
+@item hielevel
+Set the Hierarchical prediction levels.
+@table @samp
+@item 3level
+@item 4level, This is the default.
+@end table
 
 @item tier
 Set the operating point tier.
+@table @samp
+@item main
+The main tier was designed for most applications. This is the default.
+@item high
+The high tier was designed for very demanding applications.
+@end table
 
 @item rc
 Set the rate control mode to use.