ext-ctrls-image-process.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
  2. .. c:namespace:: V4L
  3. .. _image-process-controls:
  4. *******************************
  5. Image Process Control Reference
  6. *******************************
  7. The Image Process control class is intended for low-level control of
  8. image processing functions. Unlike ``V4L2_CID_IMAGE_SOURCE_CLASS``, the
  9. controls in this class affect processing the image, and do not control
  10. capturing of it.
  11. .. _image-process-control-id:
  12. Image Process Control IDs
  13. =========================
  14. ``V4L2_CID_IMAGE_PROC_CLASS (class)``
  15. The IMAGE_PROC class descriptor.
  16. .. _v4l2-cid-link-freq:
  17. ``V4L2_CID_LINK_FREQ (integer menu)``
  18. The frequency of the data bus (e.g. parallel or CSI-2).
  19. .. _v4l2-cid-pixel-rate:
  20. ``V4L2_CID_PIXEL_RATE (64-bit integer)``
  21. Pixel sampling rate in the device's pixel array. This control is
  22. read-only and its unit is pixels / second.
  23. Some devices use horizontal and vertical blanking to configure the frame
  24. rate. The frame rate can be calculated from the pixel rate, analogue crop
  25. rectangle as well as horizontal and vertical blanking. The pixel rate
  26. control may be present in a different sub-device than the blanking controls
  27. and the analogue crop rectangle configuration.
  28. The configuration of the frame rate is performed by selecting the desired
  29. horizontal and vertical blanking. The unit of this control is Hz.
  30. ``V4L2_CID_TEST_PATTERN (menu)``
  31. Some capture/display/sensor devices have the capability to generate
  32. test pattern images. These hardware specific test patterns can be
  33. used to test if a device is working properly.
  34. ``V4L2_CID_DEINTERLACING_MODE (menu)``
  35. The video deinterlacing mode (such as Bob, Weave, ...). The menu items are
  36. driver specific and are documented in :ref:`uapi-v4l-drivers`.
  37. ``V4L2_CID_DIGITAL_GAIN (integer)``
  38. Digital gain is the value by which all colour components
  39. are multiplied by. Typically the digital gain applied is the
  40. control value divided by e.g. 0x100, meaning that to get no
  41. digital gain the control value needs to be 0x100. The no-gain
  42. configuration is also typically the default.