diff mbox

[FFmpeg-devel,5/5] doc/bitstream_filters: Add av1_metadata

Message ID 20181004230947.9658-5-sw@jkqxz.net
State Accepted
Headers show

Commit Message

Mark Thompson Oct. 4, 2018, 11:09 p.m. UTC
---
 doc/bitstream_filters.texi | 50 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

Comments

Mark Thompson Oct. 16, 2018, 9:15 p.m. UTC | #1
On 05/10/18 00:09, Mark Thompson wrote:
> ---
>  doc/bitstream_filters.texi | 50 ++++++++++++++++++++++++++++++++++++++
>  1 file changed, 50 insertions(+)
> 
> diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
> index d948c6d658..66df24fd3d 100644
> --- a/doc/bitstream_filters.texi
> +++ b/doc/bitstream_filters.texi
> @@ -37,6 +37,56 @@ raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or
>  to MOV/MP4 files and related formats such as 3GP or M4A. Please note
>  that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats.
>  
> +@section av1_metadata
> +
> +Modify metadata embedded in an AV1 stream.
> +
> +@table @option
> +@item td
> +Insert or remove temporal delimiter OBUs in all temporal units of the
> +stream.
> +
> +@table @samp
> +@item insert
> +@item remove
> +@end table
> +
> +@item color_primaries
> +@item transfer_characteristics
> +@item matrix_coefficients
> +Set the color description fields in the stream (see AV1 section 6.4.2).
> +
> +@item color_range
> +Set the color range in the stream (see AV1 section 6.4.2; note that
> +this cannot be set for streams using BT.709 primaries, sRGB transfer
> +characteristic and identity (RGB) matrix coefficients).
> +@table @samp
> +@item tv
> +Limited range.
> +@item pc
> +Full range.
> +@end table
> +
> +@item chroma_sample_position
> +Set the chroma sample location in the stream (see AV1 section 6.4.2).
> +This can only be set for 4:2:0 streams.
> +
> +@table @samp
> +@item vertical
> +Left position (matching the default in MPEG-2 and H.264).
> +@item colocated
> +Top-left position.
> +@end table
> +
> +@item tick_rate
> +Set the tick rate (@emph{num_units_in_display_tick / time_scale}) in
> +the timing info in the sequence header.
> +@item num_ticks_per_picture
> +Set the number of ticks in each picture, to indicate that the stream
> +has a fixed framerate.  Ignored if @option{tick_rate} is not also set.
> +
> +@end table
> +
>  @section chomp
>  
>  Remove zero padding at the end of a packet.
> 

Ping.

Thanks,

- Mark
James Almer Oct. 16, 2018, 9:20 p.m. UTC | #2
On 10/16/2018 6:15 PM, Mark Thompson wrote:
> On 05/10/18 00:09, Mark Thompson wrote:
>> ---
>>  doc/bitstream_filters.texi | 50 ++++++++++++++++++++++++++++++++++++++
>>  1 file changed, 50 insertions(+)
>>
>> diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
>> index d948c6d658..66df24fd3d 100644
>> --- a/doc/bitstream_filters.texi
>> +++ b/doc/bitstream_filters.texi
>> @@ -37,6 +37,56 @@ raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or
>>  to MOV/MP4 files and related formats such as 3GP or M4A. Please note
>>  that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats.
>>  
>> +@section av1_metadata
>> +
>> +Modify metadata embedded in an AV1 stream.
>> +
>> +@table @option
>> +@item td
>> +Insert or remove temporal delimiter OBUs in all temporal units of the
>> +stream.
>> +
>> +@table @samp
>> +@item insert

Maybe mention that it inserts one if there's none already at the
beginning of the TU, and does nothing otherwise. Same with remove below.

>> +@item remove
>> +@end table
>> +
>> +@item color_primaries
>> +@item transfer_characteristics
>> +@item matrix_coefficients
>> +Set the color description fields in the stream (see AV1 section 6.4.2).
>> +
>> +@item color_range
>> +Set the color range in the stream (see AV1 section 6.4.2; note that
>> +this cannot be set for streams using BT.709 primaries, sRGB transfer
>> +characteristic and identity (RGB) matrix coefficients).
>> +@table @samp
>> +@item tv
>> +Limited range.
>> +@item pc
>> +Full range.
>> +@end table
>> +
>> +@item chroma_sample_position
>> +Set the chroma sample location in the stream (see AV1 section 6.4.2).
>> +This can only be set for 4:2:0 streams.
>> +
>> +@table @samp
>> +@item vertical
>> +Left position (matching the default in MPEG-2 and H.264).
>> +@item colocated
>> +Top-left position.
>> +@end table
>> +
>> +@item tick_rate
>> +Set the tick rate (@emph{num_units_in_display_tick / time_scale}) in
>> +the timing info in the sequence header.
>> +@item num_ticks_per_picture
>> +Set the number of ticks in each picture, to indicate that the stream
>> +has a fixed framerate.  Ignored if @option{tick_rate} is not also set.
>> +
>> +@end table
>> +
>>  @section chomp
>>  
>>  Remove zero padding at the end of a packet.
>>
> 
> Ping.
> 
> Thanks,
> 
> - Mark

LGTM with or without the above change.
Mark Thompson Oct. 16, 2018, 9:59 p.m. UTC | #3
On 16/10/18 22:20, James Almer wrote:
> On 10/16/2018 6:15 PM, Mark Thompson wrote:
>> On 05/10/18 00:09, Mark Thompson wrote:
>>> ---
>>>  doc/bitstream_filters.texi | 50 ++++++++++++++++++++++++++++++++++++++
>>>  1 file changed, 50 insertions(+)
>>>
>>> diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
>>> index d948c6d658..66df24fd3d 100644
>>> --- a/doc/bitstream_filters.texi
>>> +++ b/doc/bitstream_filters.texi
>>> @@ -37,6 +37,56 @@ raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or
>>>  to MOV/MP4 files and related formats such as 3GP or M4A. Please note
>>>  that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats.
>>>  
>>> +@section av1_metadata
>>> +
>>> +Modify metadata embedded in an AV1 stream.
>>> +
>>> +@table @option
>>> +@item td
>>> +Insert or remove temporal delimiter OBUs in all temporal units of the
>>> +stream.
>>> +
>>> +@table @samp
>>> +@item insert
> 
> Maybe mention that it inserts one if there's none already at the
> beginning of the TU, and does nothing otherwise. Same with remove below.

Sure, added.

>>> ...
> 
> LGTM with or without the above change.

Applied with that change.

Thank you!

- Mark
diff mbox

Patch

diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
index d948c6d658..66df24fd3d 100644
--- a/doc/bitstream_filters.texi
+++ b/doc/bitstream_filters.texi
@@ -37,6 +37,56 @@  raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or
 to MOV/MP4 files and related formats such as 3GP or M4A. Please note
 that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats.
 
+@section av1_metadata
+
+Modify metadata embedded in an AV1 stream.
+
+@table @option
+@item td
+Insert or remove temporal delimiter OBUs in all temporal units of the
+stream.
+
+@table @samp
+@item insert
+@item remove
+@end table
+
+@item color_primaries
+@item transfer_characteristics
+@item matrix_coefficients
+Set the color description fields in the stream (see AV1 section 6.4.2).
+
+@item color_range
+Set the color range in the stream (see AV1 section 6.4.2; note that
+this cannot be set for streams using BT.709 primaries, sRGB transfer
+characteristic and identity (RGB) matrix coefficients).
+@table @samp
+@item tv
+Limited range.
+@item pc
+Full range.
+@end table
+
+@item chroma_sample_position
+Set the chroma sample location in the stream (see AV1 section 6.4.2).
+This can only be set for 4:2:0 streams.
+
+@table @samp
+@item vertical
+Left position (matching the default in MPEG-2 and H.264).
+@item colocated
+Top-left position.
+@end table
+
+@item tick_rate
+Set the tick rate (@emph{num_units_in_display_tick / time_scale}) in
+the timing info in the sequence header.
+@item num_ticks_per_picture
+Set the number of ticks in each picture, to indicate that the stream
+has a fixed framerate.  Ignored if @option{tick_rate} is not also set.
+
+@end table
+
 @section chomp
 
 Remove zero padding at the end of a packet.