^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) .. _image-source-controls:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) ******************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) Image Source Control Reference
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) ******************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) The Image Source control class is intended for low-level control of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) image source devices such as image sensors. The devices feature an
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) analogue to digital converter and a bus transmitter to transmit the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) image data out of the device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) .. _image-source-control-id:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) Image Source Control IDs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) ========================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) ``V4L2_CID_IMAGE_SOURCE_CLASS (class)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) The IMAGE_SOURCE class descriptor.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) ``V4L2_CID_VBLANK (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) Vertical blanking. The idle period after every frame during which no
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) image data is produced. The unit of vertical blanking is a line.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) Every line has length of the image width plus horizontal blanking at
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) the pixel rate defined by ``V4L2_CID_PIXEL_RATE`` control in the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) same sub-device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) ``V4L2_CID_HBLANK (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) Horizontal blanking. The idle period after every line of image data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) during which no image data is produced. The unit of horizontal
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) blanking is pixels.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) ``V4L2_CID_ANALOGUE_GAIN (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) Analogue gain is gain affecting all colour components in the pixel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) matrix. The gain operation is performed in the analogue domain
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) before A/D conversion.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) ``V4L2_CID_TEST_PATTERN_RED (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) Test pattern red colour component.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) ``V4L2_CID_TEST_PATTERN_GREENR (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) Test pattern green (next to red) colour component.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) ``V4L2_CID_TEST_PATTERN_BLUE (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) Test pattern blue colour component.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) ``V4L2_CID_TEST_PATTERN_GREENB (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) Test pattern green (next to blue) colour component.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) ``V4L2_CID_UNIT_CELL_SIZE (struct)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) This control returns the unit cell size in nanometers. The struct
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) :c:type:`v4l2_area` provides the width and the height in separate
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) fields to take into consideration asymmetric pixels.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) This control does not take into consideration any possible hardware
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) binning.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) The unit cell consists of the whole area of the pixel, sensitive and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) non-sensitive.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) This control is required for automatic calibration of sensors/cameras.