162306a36Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
262306a36Sopenharmony_ci
362306a36Sopenharmony_ci.. _image-process-controls:
462306a36Sopenharmony_ci
562306a36Sopenharmony_ci*******************************
662306a36Sopenharmony_ciImage Process Control Reference
762306a36Sopenharmony_ci*******************************
862306a36Sopenharmony_ci
962306a36Sopenharmony_ciThe Image Process control class is intended for low-level control of
1062306a36Sopenharmony_ciimage processing functions. Unlike ``V4L2_CID_IMAGE_SOURCE_CLASS``, the
1162306a36Sopenharmony_cicontrols in this class affect processing the image, and do not control
1262306a36Sopenharmony_cicapturing of it.
1362306a36Sopenharmony_ci
1462306a36Sopenharmony_ci
1562306a36Sopenharmony_ci.. _image-process-control-id:
1662306a36Sopenharmony_ci
1762306a36Sopenharmony_ciImage Process Control IDs
1862306a36Sopenharmony_ci=========================
1962306a36Sopenharmony_ci
2062306a36Sopenharmony_ci``V4L2_CID_IMAGE_PROC_CLASS (class)``
2162306a36Sopenharmony_ci    The IMAGE_PROC class descriptor.
2262306a36Sopenharmony_ci
2362306a36Sopenharmony_ci.. _v4l2-cid-link-freq:
2462306a36Sopenharmony_ci
2562306a36Sopenharmony_ci``V4L2_CID_LINK_FREQ (integer menu)``
2662306a36Sopenharmony_ci    The frequency of the data bus (e.g. parallel or CSI-2).
2762306a36Sopenharmony_ci
2862306a36Sopenharmony_ci.. _v4l2-cid-pixel-rate:
2962306a36Sopenharmony_ci
3062306a36Sopenharmony_ci``V4L2_CID_PIXEL_RATE (64-bit integer)``
3162306a36Sopenharmony_ci    Pixel sampling rate in the device's pixel array. This control is
3262306a36Sopenharmony_ci    read-only and its unit is pixels / second.
3362306a36Sopenharmony_ci
3462306a36Sopenharmony_ci    Some devices use horizontal and vertical balanking to configure the frame
3562306a36Sopenharmony_ci    rate. The frame rate can be calculated from the pixel rate, analogue crop
3662306a36Sopenharmony_ci    rectangle as well as horizontal and vertical blanking. The pixel rate
3762306a36Sopenharmony_ci    control may be present in a different sub-device than the blanking controls
3862306a36Sopenharmony_ci    and the analogue crop rectangle configuration.
3962306a36Sopenharmony_ci
4062306a36Sopenharmony_ci    The configuration of the frame rate is performed by selecting the desired
4162306a36Sopenharmony_ci    horizontal and vertical blanking. The unit of this control is Hz.
4262306a36Sopenharmony_ci
4362306a36Sopenharmony_ci``V4L2_CID_TEST_PATTERN (menu)``
4462306a36Sopenharmony_ci    Some capture/display/sensor devices have the capability to generate
4562306a36Sopenharmony_ci    test pattern images. These hardware specific test patterns can be
4662306a36Sopenharmony_ci    used to test if a device is working properly.
4762306a36Sopenharmony_ci
4862306a36Sopenharmony_ci``V4L2_CID_DEINTERLACING_MODE (menu)``
4962306a36Sopenharmony_ci    The video deinterlacing mode (such as Bob, Weave, ...). The menu items are
5062306a36Sopenharmony_ci    driver specific and are documented in :ref:`uapi-v4l-drivers`.
5162306a36Sopenharmony_ci
5262306a36Sopenharmony_ci``V4L2_CID_DIGITAL_GAIN (integer)``
5362306a36Sopenharmony_ci    Digital gain is the value by which all colour components
5462306a36Sopenharmony_ci    are multiplied by. Typically the digital gain applied is the
5562306a36Sopenharmony_ci    control value divided by e.g. 0x100, meaning that to get no
5662306a36Sopenharmony_ci    digital gain the control value needs to be 0x100. The no-gain
5762306a36Sopenharmony_ci    configuration is also typically the default.
58