0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002
0003 .. _colorimetry-controls:
0004
0005 *****************************
0006 Colorimetry Control Reference
0007 *****************************
0008
0009 The Colorimetry class includes controls for High Dynamic Range
0010 imaging for representing colors in digital images and video. The
0011 controls should be used for video and image encoding and decoding
0012 as well as in HDMI receivers and transmitters.
0013
0014 Colorimetry Control IDs
0015 -----------------------
0016
0017 .. _colorimetry-control-id:
0018
0019 ``V4L2_CID_COLORIMETRY_CLASS (class)``
0020 The Colorimetry class descriptor. Calling
0021 :ref:`VIDIOC_QUERYCTRL` for this control will
0022 return a description of this control class.
0023
0024 ``V4L2_CID_COLORIMETRY_HDR10_CLL_INFO (struct)``
0025 The Content Light Level defines upper bounds for the nominal target
0026 brightness light level of the pictures.
0027
0028 .. c:type:: v4l2_ctrl_hdr10_cll_info
0029
0030 .. cssclass:: longtable
0031
0032 .. flat-table:: struct v4l2_ctrl_hdr10_cll_info
0033 :header-rows: 0
0034 :stub-columns: 0
0035 :widths: 1 1 2
0036
0037 * - __u16
0038 - ``max_content_light_level``
0039 - The upper bound for the maximum light level among all individual
0040 samples for the pictures of a video sequence, cd/m\ :sup:`2`.
0041 When equal to 0 no such upper bound is present.
0042 * - __u16
0043 - ``max_pic_average_light_level``
0044 - The upper bound for the maximum average light level among the
0045 samples for any individual picture of a video sequence,
0046 cd/m\ :sup:`2`. When equal to 0 no such upper bound is present.
0047
0048 ``V4L2_CID_COLORIMETRY_HDR10_MASTERING_DISPLAY (struct)``
0049 The mastering display defines the color volume (the color primaries,
0050 white point and luminance range) of a display considered to be the
0051 mastering display for the current video content.
0052
0053 .. c:type:: v4l2_ctrl_hdr10_mastering_display
0054
0055 .. cssclass:: longtable
0056
0057 .. flat-table:: struct v4l2_ctrl_hdr10_mastering_display
0058 :header-rows: 0
0059 :stub-columns: 0
0060 :widths: 1 1 2
0061
0062 * - __u16
0063 - ``display_primaries_x[3]``
0064 - Specifies the normalized x chromaticity coordinate of the color
0065 primary component c of the mastering display in increments of 0.00002.
0066 For describing the mastering display that uses Red, Green and Blue
0067 color primaries, index value c equal to 0 corresponds to the Green
0068 primary, c equal to 1 corresponds to Blue primary and c equal to 2
0069 corresponds to the Red color primary.
0070 * - __u16
0071 - ``display_primaries_y[3]``
0072 - Specifies the normalized y chromaticity coordinate of the color
0073 primary component c of the mastering display in increments of 0.00002.
0074 For describing the mastering display that uses Red, Green and Blue
0075 color primaries, index value c equal to 0 corresponds to the Green
0076 primary, c equal to 1 corresponds to Blue primary and c equal to 2
0077 corresponds to Red color primary.
0078 * - __u16
0079 - ``white_point_x``
0080 - Specifies the normalized x chromaticity coordinate of the white
0081 point of the mastering display in increments of 0.00002.
0082 * - __u16
0083 - ``white_point_y``
0084 - Specifies the normalized y chromaticity coordinate of the white
0085 point of the mastering display in increments of 0.00002.
0086 * - __u32
0087 - ``max_luminance``
0088 - Specifies the nominal maximum display luminance of the mastering
0089 display in units of 0.0001 cd/m\ :sup:`2`.
0090 * - __u32
0091 - ``min_luminance``
0092 - specifies the nominal minimum display luminance of the mastering
0093 display in units of 0.0001 cd/m\ :sup:`2`.
