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

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2
   3 .. _colorimetry-controls:
   4
   5 *****************************
   6 Colorimetry Control Reference
   7 *****************************
   8
   9 The Colorimetry class includes controls for High Dynamic Range
  10 imaging for representing colors in digital images and video. The
  11 controls should be used for video and image encoding and decoding
  12 as well as in HDMI receivers and transmitters.
  13
  14 Colorimetry Control IDs
  15 -----------------------
  16
  17 .. _colorimetry-control-id:
  18
  19 ``V4L2_CID_COLORIMETRY_CLASS (class)``
  20     The Colorimetry class descriptor. Calling
  21     :ref:`VIDIOC_QUERYCTRL` for this control will
  22     return a description of this control class.
  23
  24 ``V4L2_CID_COLORIMETRY_HDR10_CLL_INFO (struct)``
  25     The Content Light Level defines upper bounds for the nominal target
  26     brightness light level of the pictures.
  27
  28 .. c:type:: v4l2_ctrl_hdr10_cll_info
  29
  30 .. cssclass:: longtable
  31
  32 .. flat-table:: struct v4l2_ctrl_hdr10_cll_info
  33     :header-rows:  0
  34     :stub-columns: 0
  35     :widths:       1 1 2
  36
  37     * - __u16
  38       - ``max_content_light_level``
  39       - The upper bound for the maximum light level among all individual
  40         samples for the pictures of a video sequence, cd/m\ :sup:`2`.
  41         When equal to 0 no such upper bound is present.
  42     * - __u16
  43       - ``max_pic_average_light_level``
  44       - The upper bound for the maximum average light level among the
  45         samples for any individual picture of a video sequence,
  46         cd/m\ :sup:`2`. When equal to 0 no such upper bound is present.
  47
  48 ``V4L2_CID_COLORIMETRY_HDR10_MASTERING_DISPLAY (struct)``
  49     The mastering display defines the color volume (the color primaries,
  50     white point and luminance range) of a display considered to be the
  51     mastering display for the current video content.
  52
  53 .. c:type:: v4l2_ctrl_hdr10_mastering_display
  54
  55 .. cssclass:: longtable
  56
  57 .. flat-table:: struct v4l2_ctrl_hdr10_mastering_display
  58     :header-rows:  0
  59     :stub-columns: 0
  60     :widths:       1 1 2
  61
  62     * - __u16
  63       - ``display_primaries_x[3]``
  64       - Specifies the normalized x chromaticity coordinate of the color
  65         primary component c of the mastering display in increments of 0.00002.
  66         For describing the mastering display that uses Red, Green and Blue
  67         color primaries, index value c equal to 0 corresponds to the Green
  68         primary, c equal to 1 corresponds to Blue primary and c equal to 2
  69         corresponds to the Red color primary.
  70     * - __u16
  71       - ``display_primaries_y[3]``
  72       - Specifies the normalized y chromaticity coordinate of the color
  73         primary component c of the mastering display in increments of 0.00002.
  74         For describing the mastering display that uses Red, Green and Blue
  75         color primaries, index value c equal to 0 corresponds to the Green
  76         primary, c equal to 1 corresponds to Blue primary and c equal to 2
  77         corresponds to Red color primary.
  78     * - __u16
  79       - ``white_point_x``
  80       - Specifies the normalized x chromaticity coordinate of the white
  81         point of the mastering display in increments of 0.00002.
  82     * - __u16
  83       - ``white_point_y``
  84       - Specifies the normalized y chromaticity coordinate of the white
  85         point of the mastering display in increments of 0.00002.
  86     * - __u32
  87       - ``max_luminance``
  88       - Specifies the nominal maximum display luminance of the mastering
  89         display in units of 0.0001 cd/m\ :sup:`2`.
  90     * - __u32
  91       - ``min_luminance``
  92       - specifies the nominal minimum display luminance of the mastering
  93         display in units of 0.0001 cd/m\ :sup:`2`.