diff mbox series

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

Message ID 20200810164400.27325-1-gautamramk@gmail.com
State Accepted
Headers show
Series [FFmpeg-devel,v2] 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. 10, 2020, 4:44 p.m. UTC
From: Gautam Ramakrishnan <gautamramk@gmail.com>

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

Comments

Gyan Doshi Aug. 14, 2020, 5:51 a.m. UTC | #1
Will apply.

On 10-08-2020 10:14 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 | 36 +++++++++++++++++++++++++++++++++++-
>   1 file changed, 35 insertions(+), 1 deletion(-)
>
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index de0472e225..426baa8033 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1365,10 +1365,44 @@ can be selected with @code{-pred 1}.
>   @subsection Options
>   
>   @table @option
> -@item format
> +@item format @var{integer}
>   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 @var{integer}
> +Sets tile width. Default is 256.
> +
> +@item tile_height @var{integer}
> +Sets tile height. Default is 256.
> +
> +@item pred @var{integer}
> +Allows setting the DWT type
> +@table @option
> +@item dwt97int (Lossy)
> +@item dwt53 (Lossless)
> +@end table
> +Default is @code{dwt97int}
> +
> +@item sop @var{boolean}
> +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 @var{boolean}
> +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 @var{integer}
> +Sets the progression order to be used by the encoder.
> +Possible values are:
> +@table @option
> +@item lrcp
> +@item rlcp
> +@item rpcl
> +@item pcrl
> +@item cprl
> +@end table
> +Set to @code{lrcp} by default.
> +
>   @end table
>   
>   @section librav1e
Gyan Doshi Aug. 17, 2020, 10:03 a.m. UTC | #2
On 14-08-2020 11:21 am, Gyan Doshi wrote:
> Will apply.

Pushed as 642404f28d39cefb7857c0d77c3a4e5ac98e62c6 with minor changes.

Thanks,
Gyan

>
> On 10-08-2020 10:14 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 | 36 +++++++++++++++++++++++++++++++++++-
>>   1 file changed, 35 insertions(+), 1 deletion(-)
>>
>> diff --git a/doc/encoders.texi b/doc/encoders.texi
>> index de0472e225..426baa8033 100644
>> --- a/doc/encoders.texi
>> +++ b/doc/encoders.texi
>> @@ -1365,10 +1365,44 @@ can be selected with @code{-pred 1}.
>>   @subsection Options
>>     @table @option
>> -@item format
>> +@item format @var{integer}
>>   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 @var{integer}
>> +Sets tile width. Default is 256.
>> +
>> +@item tile_height @var{integer}
>> +Sets tile height. Default is 256.
>> +
>> +@item pred @var{integer}
>> +Allows setting the DWT type
>> +@table @option
>> +@item dwt97int (Lossy)
>> +@item dwt53 (Lossless)
>> +@end table
>> +Default is @code{dwt97int}
>> +
>> +@item sop @var{boolean}
>> +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 @var{boolean}
>> +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 @var{integer}
>> +Sets the progression order to be used by the encoder.
>> +Possible values are:
>> +@table @option
>> +@item lrcp
>> +@item rlcp
>> +@item rpcl
>> +@item pcrl
>> +@item cprl
>> +@end table
>> +Set to @code{lrcp} by default.
>> +
>>   @end table
>>     @section librav1e
>
> _______________________________________________
> 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..426baa8033 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1365,10 +1365,44 @@  can be selected with @code{-pred 1}.
 @subsection Options
 
 @table @option
-@item format
+@item format @var{integer}
 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 @var{integer}
+Sets tile width. Default is 256.
+
+@item tile_height @var{integer}
+Sets tile height. Default is 256.
+
+@item pred @var{integer}
+Allows setting the DWT type
+@table @option
+@item dwt97int (Lossy)
+@item dwt53 (Lossless)
+@end table
+Default is @code{dwt97int}
+
+@item sop @var{boolean}
+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 @var{boolean}
+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 @var{integer}
+Sets the progression order to be used by the encoder.
+Possible values are:
+@table @option
+@item lrcp
+@item rlcp
+@item rpcl
+@item pcrl
+@item cprl
+@end table
+Set to @code{lrcp} by default.
+
 @end table
 
 @section librav1e