0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002
0003 .. _image-process-controls:
0004
0005 *******************************
0006 Image Process Control Reference
0007 *******************************
0008
0009 The Image Process control class is intended for low-level control of
0010 image processing functions. Unlike ``V4L2_CID_IMAGE_SOURCE_CLASS``, the
0011 controls in this class affect processing the image, and do not control
0012 capturing of it.
0013
0014
0015 .. _image-process-control-id:
0016
0017 Image Process Control IDs
0018 =========================
0019
0020 ``V4L2_CID_IMAGE_PROC_CLASS (class)``
0021 The IMAGE_PROC class descriptor.
0022
0023 .. _v4l2-cid-link-freq:
0024
0025 ``V4L2_CID_LINK_FREQ (integer menu)``
0026 The frequency of the data bus (e.g. parallel or CSI-2).
0027
0028 .. _v4l2-cid-pixel-rate:
0029
0030 ``V4L2_CID_PIXEL_RATE (64-bit integer)``
0031 Pixel sampling rate in the device's pixel array. This control is
0032 read-only and its unit is pixels / second.
0033
0034 Some devices use horizontal and vertical balanking to configure the frame
0035 rate. The frame rate can be calculated from the pixel rate, analogue crop
0036 rectangle as well as horizontal and vertical blanking. The pixel rate
0037 control may be present in a different sub-device than the blanking controls
0038 and the analogue crop rectangle configuration.
0039
0040 The configuration of the frame rate is performed by selecting the desired
0041 horizontal and vertical blanking. The unit of this control is Hz.
0042
0043 ``V4L2_CID_TEST_PATTERN (menu)``
0044 Some capture/display/sensor devices have the capability to generate
0045 test pattern images. These hardware specific test patterns can be
0046 used to test if a device is working properly.
0047
0048 ``V4L2_CID_DEINTERLACING_MODE (menu)``
0049 The video deinterlacing mode (such as Bob, Weave, ...). The menu items are
0050 driver specific and are documented in :ref:`uapi-v4l-drivers`.
0051
0052 ``V4L2_CID_DIGITAL_GAIN (integer)``
0053 Digital gain is the value by which all colour components
0054 are multiplied by. Typically the digital gain applied is the
0055 control value divided by e.g. 0x100, meaning that to get no
0056 digital gain the control value needs to be 0x100. The no-gain
0057 configuration is also typically the default.
