forked from Minki/linux
media: doc: Document dual use of H.264 pic_num/frame_num
These two fields need documentation as they have dual meaning. It is also confusing since pic_num is a derived value from frame_num, so this should help application developers. If we ever need to make a V2 of this API, I would suggest to remove pic_num entirely. Signed-off-by: Nicolas Dufresne <nicolas.dufresne@collabora.com> Reviewed-by: Sebastian Fricke <sebastian.fricke@collabora.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
This commit is contained in:
parent
397edc703a
commit
804e192a81
@ -649,10 +649,16 @@ Stateless Codec Control ID
|
||||
:c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64.
|
||||
* - __u32
|
||||
- ``pic_num``
|
||||
-
|
||||
- For short term references, this must match the derived value PicNum
|
||||
(8-28) and for long term references it must match the derived value
|
||||
LongTermPicNum (8-29). When decoding frames (as opposed to fields)
|
||||
pic_num is the same as FrameNumWrap.
|
||||
* - __u16
|
||||
- ``frame_num``
|
||||
-
|
||||
- For short term references, this must match the frame_num value from
|
||||
the slice header syntax (the driver will wrap the value if needed). For
|
||||
long term references, this must be set to the value of
|
||||
long_term_frame_idx described in the dec_ref_pic_marking() syntax.
|
||||
* - __u8
|
||||
- ``fields``
|
||||
- Specifies how the DPB entry is referenced. See :ref:`Reference Fields <h264_ref_fields>`
|
||||
|
Loading…
Reference in New Issue
Block a user