diff mbox series

[FFmpeg-devel] doc/encoders: Add all options for JPEG2000 encoder

Message ID 20200809174338.3107-1-gautamramk@gmail.com
State Superseded
Headers show
Series [FFmpeg-devel] doc/encoders: Add all options for JPEG2000 encoder
Related show

Checks

Context Check Description
andriy/default pending
andriy/make success Make finished
andriy/make_fate success Make fate finished

Commit Message

Gautam Ramakrishnan Aug. 9, 2020, 5:43 p.m. UTC
From: Gautam Ramakrishnan <gautamramk@gmail.com>

This patch updates the documentation by adding all options
for JPEG2000 encoder.
---
 doc/encoders.texi | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

Comments

Gyan Doshi Aug. 9, 2020, 6:36 p.m. UTC | #1
On 09-08-2020 11:13 pm, gautamramk@gmail.com wrote:
> From: Gautam Ramakrishnan <gautamramk@gmail.com>
>
> This patch updates the documentation by adding all options
> for JPEG2000 encoder.
> ---
>   doc/encoders.texi | 20 ++++++++++++++++++++
>   1 file changed, 20 insertions(+)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index de0472e225..aaac026709 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1369,6 +1369,26 @@ can be selected with @code{-pred 1}.
>   Can be set to either @code{j2k} or @code{jp2} (the default) that
>   makes it possible to store non-rgb pix_fmts.
>   
> +@item tile_width/tile_height
> +Allows setting of tile width and height.

Make these separate items.

> +
> +@item pred
> +Allows setting the DWT type, i.e lossy
> +DWT 97 (@code{dwt97int}) or lossless DWT 53 (@code{dwt53}).
> +
> +@item sop
> +Setting this to 1 will make the encoder to use SOP marker at the
> +start of every packet. Set to 0 by default.

Not related to this patch, but make these boolean options 
AV_OPT_TYPE_BOOL. It allows users to also set them to string values 
true/false or on/off.

> +@item eph
> +Setting this to 1 will make the encoder to use the EPH flag at the
> +end of every packet header. Set to 0 by default.
> +
> +@item prog
> +Sets the progression order to be used by the encoder.
> +Possible values are @code{lrcp}, @code{rlcp}, @code{rpcl},
> +@code{pcrl} and @code{cprl}. Set to @code{lrcp} by default.

One value per line, please. Also add option type for each option. See 
Hap encoder entry above this one. Some elaboration will be nice as well 
unless users are expected to know what the differences are between these 
values.

Thanks,
Gyan
Gautam Ramakrishnan Aug. 10, 2020, 2:28 a.m. UTC | #2
On Mon, Aug 10, 2020 at 12:07 AM Gyan Doshi <ffmpeg@gyani.pro> wrote:
>
>
>
> On 09-08-2020 11:13 pm, gautamramk@gmail.com wrote:
> > From: Gautam Ramakrishnan <gautamramk@gmail.com>
> >
> > This patch updates the documentation by adding all options
> > for JPEG2000 encoder.
> > ---
> >   doc/encoders.texi | 20 ++++++++++++++++++++
> >   1 file changed, 20 insertions(+)
> >
> > diff --git a/doc/encoders.texi b/doc/encoders.texi
> > index de0472e225..aaac026709 100644
> > --- a/doc/encoders.texi
> > +++ b/doc/encoders.texi
> > @@ -1369,6 +1369,26 @@ can be selected with @code{-pred 1}.
> >   Can be set to either @code{j2k} or @code{jp2} (the default) that
> >   makes it possible to store non-rgb pix_fmts.
> >
> > +@item tile_width/tile_height
> > +Allows setting of tile width and height.
>
> Make these separate items.
Shall do this
>
> > +
> > +@item pred
> > +Allows setting the DWT type, i.e lossy
> > +DWT 97 (@code{dwt97int}) or lossless DWT 53 (@code{dwt53}).
> > +
> > +@item sop
> > +Setting this to 1 will make the encoder to use SOP marker at the
> > +start of every packet. Set to 0 by default.
>
> Not related to this patch, but make these boolean options
> AV_OPT_TYPE_BOOL. It allows users to also set them to string values
> true/false or on/off.
>
> > +@item eph
> > +Setting this to 1 will make the encoder to use the EPH flag at the
> > +end of every packet header. Set to 0 by default.
> > +
> > +@item prog
> > +Sets the progression order to be used by the encoder.
> > +Possible values are @code{lrcp}, @code{rlcp}, @code{rpcl},
> > +@code{pcrl} and @code{cprl}. Set to @code{lrcp} by default.
>
> One value per line, please. Also add option type for each option. See
> Hap encoder entry above this one. Some elaboration will be nice as well
> unless users are expected to know what the differences are between these
> values.
>
I'll make these 1 value per line. However, I am not sure if
elaboration is possible
as the user is expected to know the difference between these values.
> Thanks,
> Gyan
> _______________________________________________
> 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 de0472e225..aaac026709 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1369,6 +1369,26 @@  can be selected with @code{-pred 1}.
 Can be set to either @code{j2k} or @code{jp2} (the default) that
 makes it possible to store non-rgb pix_fmts.
 
+@item tile_width/tile_height
+Allows setting of tile width and height.
+
+@item pred
+Allows setting the DWT type, i.e lossy
+DWT 97 (@code{dwt97int}) or lossless DWT 53 (@code{dwt53}).
+
+@item sop
+Setting this to 1 will make the encoder to use SOP marker at the
+start of every packet. Set to 0 by default.
+
+@item eph
+Setting this to 1 will make the encoder to use the EPH flag at the
+end of every packet header. Set to 0 by default.
+
+@item prog
+Sets the progression order to be used by the encoder.
+Possible values are @code{lrcp}, @code{rlcp}, @code{rpcl},
+@code{pcrl} and @code{cprl}. Set to @code{lrcp} by default.
+
 @end table
 
 @section librav1e