diff mbox

[FFmpeg-devel,5/8] h264_metadata: Update documentation

Message ID 20180311183021.25556-5-sw@jkqxz.net
State Superseded
Headers show

Commit Message

Mark Thompson March 11, 2018, 6:30 p.m. UTC 
Improve documentation for the delete_filler option, and add the
display_orientation and a53_cc options.
---
 doc/bitstream_filters.texi | 50 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

Comments

Michael Niedermayer March 13, 2018, 12:23 a.m. UTC | #1 
On Sun, Mar 11, 2018 at 06:30:18PM +0000, Mark Thompson wrote:
> Improve documentation for the delete_filler option, and add the
> display_orientation and a53_cc options.
> ---
>  doc/bitstream_filters.texi | 50 +++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 49 insertions(+), 1 deletion(-)

overall LGTM (english not reviewed, thats not my area ;)

thx

[...]
diff mbox

Patch

diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
index b7ea549322..c196a30095 100644
--- a/doc/bitstream_filters.texi
+++ b/doc/bitstream_filters.texi
@@ -155,7 +155,55 @@  For example, @samp{086f3693-b7b3-4f2c-9653-21492feee5b8+hello} will
 insert the string ``hello'' associated with the given UUID.
 
 @item delete_filler
-Deletes both filler NAL units and filler SEI messages.
+Delete all filler in the stream: both filler data NAL units and
+filler payload SEI messages.
+
+Note that HRD parameters may be invalid after this transformation -
+in particular, the CPB may overflow if cbr_flag is set and the removed
+filler data was required to maintain the CPB level.
+
+@item display_orientation
+Modify display orientation SEI messages.
+
+@table @samp
+@item insert
+Insert new display orientation messages, overwriting any currently in
+the stream.  The new value is taken from the packet side data, modified
+by the @option{rotate} and @option{flip} options.
+
+@item remove
+Remove all display orientation messages from the stream.
+
+@item extract
+Extract display orientation messages so that they are available as
+packet side data.
+@end table
+
+@item rotate
+Set the rotation angle in the display orientation data.  This is an
+anticlockwise rotation angle in degrees.
+@item flip
+Set the flip fields in the display orientation data.  This can be any
+combination of the flags:
+@table @samp
+@item horizontal
+@item vertical
+@end table
+
+@item a53_cc
+Modify A/53 closed caption data in SEI messages.
+
+@table @samp
+@item insert
+Insert closed captions taken from packet side data into the stream.
+
+@item remove
+Remove all closed caption data from the stream.
+
+@item extract
+Extract closed captions from the stream so that they are available as
+as packet side data.
+@end table
 
 @end table