diff mbox series

[v5,2/5] docs: Document colorimetry class

Message ID 20210209162425.3970393-3-stanimir.varbanov@linaro.org
State Superseded
Headers show
Series HDR10 static metadata | expand

Commit Message

Stanimir Varbanov Feb. 9, 2021, 4:24 p.m. UTC
Add a document for ext control colorimetry class.

Signed-off-by: Stanimir Varbanov <stanimir.varbanov@linaro.org>

---
 .../userspace-api/media/v4l/common.rst        |  1 +
 .../media/v4l/ext-ctrls-colorimetry.rst       | 22 +++++++++++++++++++
 .../media/v4l/vidioc-g-ext-ctrls.rst          |  4 ++++
 3 files changed, 27 insertions(+)
 create mode 100644 Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst

-- 
2.25.1

Comments

Hans Verkuil March 16, 2021, 11:37 a.m. UTC | #1
On 09/02/2021 17:24, Stanimir Varbanov wrote:
> Add a document for ext control colorimetry class.

> 

> Signed-off-by: Stanimir Varbanov <stanimir.varbanov@linaro.org>

> ---

>  .../userspace-api/media/v4l/common.rst        |  1 +

>  .../media/v4l/ext-ctrls-colorimetry.rst       | 22 +++++++++++++++++++

>  .../media/v4l/vidioc-g-ext-ctrls.rst          |  4 ++++

>  3 files changed, 27 insertions(+)

>  create mode 100644 Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst

> 

> diff --git a/Documentation/userspace-api/media/v4l/common.rst b/Documentation/userspace-api/media/v4l/common.rst

> index 8c263c5a85d8..ea0435182e44 100644

> --- a/Documentation/userspace-api/media/v4l/common.rst

> +++ b/Documentation/userspace-api/media/v4l/common.rst

> @@ -51,6 +51,7 @@ applicable to all devices.

>      ext-ctrls-fm-tx

>      ext-ctrls-fm-rx

>      ext-ctrls-detect

> +    ext-ctrls-colorimetry

>      fourcc

>      format

>      planar-apis

> diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst

> new file mode 100644

> index 000000000000..862f78b41b32

> --- /dev/null

> +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst

> @@ -0,0 +1,22 @@

> +.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later

> +

> +.. _colorimetry-controls:

> +

> +*****************************

> +Colorimetry Control Reference

> +*****************************

> +

> +The Colorimetry class includes controls for High Dynamic Range

> +imaging for representing colors in digital images and video. The

> +controls should be used for video and image encoding and decoding

> +as well as in HDMI receivers and transmitters.

> +

> +Colorimetry Control IDs

> +-----------------------

> +

> +.. _colorimetry-control-id:

> +

> +``V4L2_CID_COLORIMETRY_CLASS (class)``

> +    The Colorimetry class descriptor. Calling

> +    :ref:`VIDIOC_QUERYCTRL` for this control will

> +    return a description of this control class.

> diff --git a/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst

> index b9c62affbb5a..8a95ebdd499a 100644

> --- a/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst

> +++ b/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst

> @@ -394,6 +394,10 @@ still cause this situation.

>        - 0xa40000

>        - The class containing stateless codec controls. These controls are

>  	described in :ref:`codec-stateless-controls`.

> +    * - ``V4L2_CTRL_CLASS_COLORIMETRY``

> +      - 0xa50000

> +      - The class containing colorimetry controls. These controls are

> +	described in :ref:`colorimetry-controls`.

>  

>  Return Value

>  ============

> 


Reviewed-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>


Regards,

	Hans
diff mbox series

Patch

diff --git a/Documentation/userspace-api/media/v4l/common.rst b/Documentation/userspace-api/media/v4l/common.rst
index 8c263c5a85d8..ea0435182e44 100644
--- a/Documentation/userspace-api/media/v4l/common.rst
+++ b/Documentation/userspace-api/media/v4l/common.rst
@@ -51,6 +51,7 @@  applicable to all devices.
     ext-ctrls-fm-tx
     ext-ctrls-fm-rx
     ext-ctrls-detect
+    ext-ctrls-colorimetry
     fourcc
     format
     planar-apis
diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst
new file mode 100644
index 000000000000..862f78b41b32
--- /dev/null
+++ b/Documentation/userspace-api/media/v4l/ext-ctrls-colorimetry.rst
@@ -0,0 +1,22 @@ 
+.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+
+.. _colorimetry-controls:
+
+*****************************
+Colorimetry Control Reference
+*****************************
+
+The Colorimetry class includes controls for High Dynamic Range
+imaging for representing colors in digital images and video. The
+controls should be used for video and image encoding and decoding
+as well as in HDMI receivers and transmitters.
+
+Colorimetry Control IDs
+-----------------------
+
+.. _colorimetry-control-id:
+
+``V4L2_CID_COLORIMETRY_CLASS (class)``
+    The Colorimetry class descriptor. Calling
+    :ref:`VIDIOC_QUERYCTRL` for this control will
+    return a description of this control class.
diff --git a/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst
index b9c62affbb5a..8a95ebdd499a 100644
--- a/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst
@@ -394,6 +394,10 @@  still cause this situation.
       - 0xa40000
       - The class containing stateless codec controls. These controls are
 	described in :ref:`codec-stateless-controls`.
+    * - ``V4L2_CTRL_CLASS_COLORIMETRY``
+      - 0xa50000
+      - The class containing colorimetry controls. These controls are
+	described in :ref:`colorimetry-controls`.
 
 Return Value
 ============