media: uapi: h264: clarify num_ref_idx_l[01]_(default_)active fields
authorPhilipp Zabel <p.zabel@pengutronix.de>
Tue, 10 Sep 2019 10:22:39 +0000 (07:22 -0300)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Tue, 1 Oct 2019 20:12:54 +0000 (17:12 -0300)
commit187ef7c5c78153acdce8c8714e5918b1018c710b
tree8bf25ba63a09849c58805bcaac5bd8b7ef0a47c1
parent8255b4d21967e978f96a87cf032471f527149794
media: uapi: h264: clarify num_ref_idx_l[01]_(default_)active fields

Since the uapi does not contain the num_ref_idx_active_override_flag,
drivers for decoders that do not parse slices themselves don't know
how to choose between the num_ref_idx_l[01]_default_active and the
num_ref_idx_l[01]_active override fields.

Instead, userspace must set the override fields to the default values
if the slice does not have the num_ref_idx_active_override flag set.
The drivers will then always enable the override internally and ignore
the default fields completely.

Clarify this requirement in the API documentation.

Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Documentation/media/uapi/v4l/ext-ctrls-codec.rst