2022-02-22 04:22:27

by Nicolas Dufresne

[permalink] [raw]
Subject: [PATCH v1] doc: media: Document VP9 reference_mode miss-placement

The reference_mode derived syntax is part of the compressed headers and
should have been moved into the corresponding control structure. Document
this mistake. The value can be set to 0 if the driver does not require
compressed headers information.

Signed-off-by: Nicolas Dufresne <[email protected]>
---
.../userspace-api/media/v4l/ext-ctrls-codec-stateless.rst | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
index cc080c4257d01..ec48e4acb5ece 100644
--- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
+++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
@@ -1692,7 +1692,12 @@ See section '7.3.1 Tx mode semantics' of the :ref:`vp9` specification for more d
* - __u8
- ``reference_mode``
- Specifies the type of inter prediction to be used. See
- :ref:`Reference Mode<vp9_reference_mode>` for more details.
+ :ref:`Reference Mode<vp9_reference_mode>` for more details. Note that
+ this is derived as part of the compressed header parsing process and
+ for this reason should have bee part of
+ :c:type: `v4l2_ctrl_vp9_compressed_hdr` optional control. It is safe to
+ set this value to zero if the driver does not require compressed
+ headers.
* - __u8
- ``reserved[7]``
- Applications and drivers must set this to zero.
--
2.35.1


2022-02-22 08:35:47

by Andrzej Pietrasiewicz

[permalink] [raw]
Subject: Re: [PATCH v1] doc: media: Document VP9 reference_mode miss-placement

Hi Nicolas,

Thanks,

BTW There's a typo in the text, please see below, but other than that

Reviewed-by: Andrzej Pietrasiewicz <[email protected]>

W dniu 21.02.2022 o 20:37, Nicolas Dufresne pisze:
> The reference_mode derived syntax is part of the compressed headers and
> should have been moved into the corresponding control structure. Document
> this mistake. The value can be set to 0 if the driver does not require
> compressed headers information.
>
> Signed-off-by: Nicolas Dufresne <[email protected]>
> ---
> .../userspace-api/media/v4l/ext-ctrls-codec-stateless.rst | 7 ++++++-
> 1 file changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
> index cc080c4257d01..ec48e4acb5ece 100644
> --- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
> +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
> @@ -1692,7 +1692,12 @@ See section '7.3.1 Tx mode semantics' of the :ref:`vp9` specification for more d
> * - __u8
> - ``reference_mode``
> - Specifies the type of inter prediction to be used. See
> - :ref:`Reference Mode<vp9_reference_mode>` for more details.
> + :ref:`Reference Mode<vp9_reference_mode>` for more details. Note that
> + this is derived as part of the compressed header parsing process and
> + for this reason should have bee part of

should have been

> + :c:type: `v4l2_ctrl_vp9_compressed_hdr` optional control. It is safe to
> + set this value to zero if the driver does not require compressed
> + headers.
> * - __u8
> - ``reserved[7]``
> - Applications and drivers must set this to zero.