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