18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
28c2ecf20Sopenharmony_ci
38c2ecf20Sopenharmony_ci.. _image-source-controls:
48c2ecf20Sopenharmony_ci
58c2ecf20Sopenharmony_ci******************************
68c2ecf20Sopenharmony_ciImage Source Control Reference
78c2ecf20Sopenharmony_ci******************************
88c2ecf20Sopenharmony_ci
98c2ecf20Sopenharmony_ciThe Image Source control class is intended for low-level control of
108c2ecf20Sopenharmony_ciimage source devices such as image sensors. The devices feature an
118c2ecf20Sopenharmony_cianalogue to digital converter and a bus transmitter to transmit the
128c2ecf20Sopenharmony_ciimage data out of the device.
138c2ecf20Sopenharmony_ci
148c2ecf20Sopenharmony_ci
158c2ecf20Sopenharmony_ci.. _image-source-control-id:
168c2ecf20Sopenharmony_ci
178c2ecf20Sopenharmony_ciImage Source Control IDs
188c2ecf20Sopenharmony_ci========================
198c2ecf20Sopenharmony_ci
208c2ecf20Sopenharmony_ci``V4L2_CID_IMAGE_SOURCE_CLASS (class)``
218c2ecf20Sopenharmony_ci    The IMAGE_SOURCE class descriptor.
228c2ecf20Sopenharmony_ci
238c2ecf20Sopenharmony_ci``V4L2_CID_VBLANK (integer)``
248c2ecf20Sopenharmony_ci    Vertical blanking. The idle period after every frame during which no
258c2ecf20Sopenharmony_ci    image data is produced. The unit of vertical blanking is a line.
268c2ecf20Sopenharmony_ci    Every line has length of the image width plus horizontal blanking at
278c2ecf20Sopenharmony_ci    the pixel rate defined by ``V4L2_CID_PIXEL_RATE`` control in the
288c2ecf20Sopenharmony_ci    same sub-device.
298c2ecf20Sopenharmony_ci
308c2ecf20Sopenharmony_ci``V4L2_CID_HBLANK (integer)``
318c2ecf20Sopenharmony_ci    Horizontal blanking. The idle period after every line of image data
328c2ecf20Sopenharmony_ci    during which no image data is produced. The unit of horizontal
338c2ecf20Sopenharmony_ci    blanking is pixels.
348c2ecf20Sopenharmony_ci
358c2ecf20Sopenharmony_ci``V4L2_CID_ANALOGUE_GAIN (integer)``
368c2ecf20Sopenharmony_ci    Analogue gain is gain affecting all colour components in the pixel
378c2ecf20Sopenharmony_ci    matrix. The gain operation is performed in the analogue domain
388c2ecf20Sopenharmony_ci    before A/D conversion.
398c2ecf20Sopenharmony_ci
408c2ecf20Sopenharmony_ci``V4L2_CID_TEST_PATTERN_RED (integer)``
418c2ecf20Sopenharmony_ci    Test pattern red colour component.
428c2ecf20Sopenharmony_ci
438c2ecf20Sopenharmony_ci``V4L2_CID_TEST_PATTERN_GREENR (integer)``
448c2ecf20Sopenharmony_ci    Test pattern green (next to red) colour component.
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_ci``V4L2_CID_TEST_PATTERN_BLUE (integer)``
478c2ecf20Sopenharmony_ci    Test pattern blue colour component.
488c2ecf20Sopenharmony_ci
498c2ecf20Sopenharmony_ci``V4L2_CID_TEST_PATTERN_GREENB (integer)``
508c2ecf20Sopenharmony_ci    Test pattern green (next to blue) colour component.
518c2ecf20Sopenharmony_ci
528c2ecf20Sopenharmony_ci``V4L2_CID_UNIT_CELL_SIZE (struct)``
538c2ecf20Sopenharmony_ci    This control returns the unit cell size in nanometers. The struct
548c2ecf20Sopenharmony_ci    :c:type:`v4l2_area` provides the width and the height in separate
558c2ecf20Sopenharmony_ci    fields to take into consideration asymmetric pixels.
568c2ecf20Sopenharmony_ci    This control does not take into consideration any possible hardware
578c2ecf20Sopenharmony_ci    binning.
588c2ecf20Sopenharmony_ci    The unit cell consists of the whole area of the pixel, sensitive and
598c2ecf20Sopenharmony_ci    non-sensitive.
608c2ecf20Sopenharmony_ci    This control is required for automatic calibration of sensors/cameras.
61