|
Zephyr API Documentation 4.3.0-rc1
A Scalable Open Source RTOS
|
Main header file for video controls driver API. More...
#include <stdint.h>Go to the source code of this file.
Data Structures | |
| struct | video_control |
| Video control structure. More... | |
| struct | video_ctrl_range |
| struct | video_ctrl_query |
Macros | |
Stateful codec controls IDs | |
| #define | VIDEO_CID_CODEC_CLASS_BASE 0x00990900 |
Camera Flash class control IDs | |
| #define | VIDEO_CID_FLASH_CLASS_BASE 0x009c0900 |
JPEG class control IDs | |
| #define | VIDEO_CID_JPEG_CLASS_BASE 0x009d0900 |
| #define | VIDEO_CID_JPEG_COMPRESSION_QUALITY (VIDEO_CID_JPEG_CLASS_BASE + 3) |
| Quality (Q) factor of the JPEG algorithm, also increasing the data size. | |
Image Source class control IDs | |
| #define | VIDEO_CID_IMAGE_SOURCE_CLASS_BASE 0x009e0900 |
| #define | VIDEO_CID_ANALOGUE_GAIN (VIDEO_CID_IMAGE_SOURCE_CLASS_BASE + 3) |
| Analogue gain control. | |
Image Processing class control IDs | |
| #define | VIDEO_CID_IMAGE_PROC_CLASS_BASE 0x009f0900 |
| #define | VIDEO_CID_LINK_FREQ (VIDEO_CID_IMAGE_PROC_CLASS_BASE + 1) |
| Link frequency, applicable for the CSI2 based devices. | |
| #define | VIDEO_CID_PIXEL_RATE (VIDEO_CID_IMAGE_PROC_CLASS_BASE + 2) |
| Pixel rate (pixels/second) in the device's pixel array. | |
| #define | VIDEO_CID_TEST_PATTERN (VIDEO_CID_IMAGE_PROC_CLASS_BASE + 3) |
| Selection of the type of test pattern to represent. | |
Vendor-specific class control IDs | |
| #define | VIDEO_CID_PRIVATE_BASE 0x08000000 |
Query flags, to be ORed with the control ID | |
| #define | VIDEO_CTRL_FLAG_NEXT_CTRL 0x80000000 |
Base class control IDs | |
| #define | VIDEO_CID_BASE 0x00980900 |
| #define | VIDEO_CID_BRIGHTNESS (VIDEO_CID_BASE + 0) |
| Picture brightness, or more precisely, the black level. | |
| #define | VIDEO_CID_CONTRAST (VIDEO_CID_BASE + 1) |
| Picture contrast or luma gain. | |
| #define | VIDEO_CID_SATURATION (VIDEO_CID_BASE + 2) |
| Picture color saturation or chroma gain. | |
| #define | VIDEO_CID_HUE (VIDEO_CID_BASE + 3) |
| Hue or color balance. | |
| #define | VIDEO_CID_AUTO_WHITE_BALANCE (VIDEO_CID_BASE + 12) |
| Automatic white balance (cameras). | |
| #define | VIDEO_CID_RED_BALANCE (VIDEO_CID_BASE + 14) |
| Red chroma balance, as a ratio to the green channel. | |
| #define | VIDEO_CID_BLUE_BALANCE (VIDEO_CID_BASE + 15) |
| Blue chroma balance, as a ratio to the green channel. | |
| #define | VIDEO_CID_GAMMA (VIDEO_CID_BASE + 16) |
| Gamma adjust. | |
| #define | VIDEO_CID_EXPOSURE (VIDEO_CID_BASE + 17) |
| Image sensor exposure time. | |
| #define | VIDEO_CID_AUTOGAIN (VIDEO_CID_BASE + 18) |
| Automatic gain control. | |
| #define | VIDEO_CID_GAIN (VIDEO_CID_BASE + 19) |
| Gain control. | |
| #define | VIDEO_CID_HFLIP (VIDEO_CID_BASE + 20) |
| Flip the image horizontally: the left side becomes the right side. | |
| #define | VIDEO_CID_VFLIP (VIDEO_CID_BASE + 21) |
| Flip the image vertically: the top side becomes the bottom side. | |
| #define | VIDEO_CID_POWER_LINE_FREQUENCY (VIDEO_CID_BASE + 24) |
| Frequency of the power line to compensate for. | |
| #define | VIDEO_CID_HUE_AUTO (VIDEO_CID_BASE + 25) |
| Enables automatic hue control by the device. | |
| #define | VIDEO_CID_WHITE_BALANCE_TEMPERATURE (VIDEO_CID_BASE + 26) |
| White balance settings as a color temperature in Kelvin. | |
| #define | VIDEO_CID_SHARPNESS (VIDEO_CID_BASE + 27) |
| Adjusts the sharpness filters in a camera. | |
| #define | VIDEO_CID_BACKLIGHT_COMPENSATION (VIDEO_CID_BASE + 28) |
| Adjusts the backlight compensation in a camera. | |
| #define | VIDEO_CID_COLORFX (VIDEO_CID_BASE + 31) |
| Selects a color effect. | |
| #define | VIDEO_CID_AUTOBRIGHTNESS (VIDEO_CID_BASE + 32) |
| Enables automatic brightness. | |
| #define | VIDEO_CID_BAND_STOP_FILTER (VIDEO_CID_BASE + 33) |
| Switch the band-stop filter of a camera sensor on or off, or specify its strength. | |
| #define | VIDEO_CID_ALPHA_COMPONENT (VIDEO_CID_BASE + 41) |
| Sets the alpha color component. | |
| #define | VIDEO_CID_LASTP1 (VIDEO_CID_BASE + 44) |
| Last base CID + 1. | |
| enum | video_power_line_frequency { VIDEO_CID_POWER_LINE_FREQUENCY_DISABLED = 0 , VIDEO_CID_POWER_LINE_FREQUENCY_50HZ = 1 , VIDEO_CID_POWER_LINE_FREQUENCY_60HZ = 2 , VIDEO_CID_POWER_LINE_FREQUENCY_AUTO = 3 } |
| Video power line frequency. More... | |
| enum | video_colorfx { VIDEO_COLORFX_NONE = 0 , VIDEO_COLORFX_BW = 1 , VIDEO_COLORFX_SEPIA = 2 , VIDEO_COLORFX_NEGATIVE = 3 , VIDEO_COLORFX_EMBOSS = 4 , VIDEO_COLORFX_SKETCH = 5 , VIDEO_COLORFX_SKY_BLUE = 6 , VIDEO_COLORFX_GRASS_GREEN = 7 , VIDEO_COLORFX_SKIN_WHITEN = 8 , VIDEO_COLORFX_VIVID = 9 , VIDEO_COLORFX_AQUA = 10 , VIDEO_COLORFX_ART_FREEZE = 11 , VIDEO_COLORFX_SILHOUETTE = 12 , VIDEO_COLORFX_SOLARIZATION = 13 , VIDEO_COLORFX_ANTIQUE = 14 } |
| Video color effects. More... | |
Camera class controls IDs | |
| #define | VIDEO_CID_CAMERA_CLASS_BASE 0x009a0900 |
| #define | VIDEO_CID_EXPOSURE_AUTO (VIDEO_CID_CAMERA_CLASS_BASE + 1) |
| Enables automatic adjustments of the exposure time and/or iris aperture. | |
| #define | VIDEO_CID_EXPOSURE_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 2) |
| Determines the exposure time of the camera sensor. | |
| #define | VIDEO_CID_EXPOSURE_AUTO_PRIORITY (VIDEO_CID_CAMERA_CLASS_BASE + 3) |
| Whether the device may dynamically vary the frame rate under the effect of auto-exposure Applicable when VIDEO_CID_EXPOSURE_AUTO is set to VIDEO_EXPOSURE_AUTO or VIDEO_EXPOSURE_APERTURE_PRIORITY. | |
| #define | VIDEO_CID_PAN_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 4) |
| This write-only control turns the camera horizontally by the specified amount. | |
| #define | VIDEO_CID_TILT_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 5) |
| This write-only control turns the camera vertically by the specified amount. | |
| #define | VIDEO_CID_PAN_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 8) |
| This control turns the camera horizontally to the specified position. | |
| #define | VIDEO_CID_TILT_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 9) |
| This control turns the camera vertically to the specified position. | |
| #define | VIDEO_CID_FOCUS_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 10) |
| This control sets the focal point of the camera to the specified position. | |
| #define | VIDEO_CID_FOCUS_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 11) |
| This write-only control moves the focal point of the camera by the specified amount. | |
| #define | VIDEO_CID_FOCUS_AUTO (VIDEO_CID_CAMERA_CLASS_BASE + 12) |
| Enables continuous automatic focus adjustments. | |
| #define | VIDEO_CID_ZOOM_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 13) |
| Specify the objective lens focal length as an absolute value. | |
| #define | VIDEO_CID_ZOOM_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 14) |
| This write-only control sets the objective lens focal length relatively to the current value. | |
| #define | VIDEO_CID_ZOOM_CONTINUOUS (VIDEO_CID_CAMERA_CLASS_BASE + 15) |
| Start a continuous zoom movement. | |
| #define | VIDEO_CID_IRIS_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 17) |
| This control sets the camera's aperture to the specified value. | |
| #define | VIDEO_CID_IRIS_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 18) |
| This write-only control modifies the camera's aperture by the specified amount. | |
| #define | VIDEO_CID_WIDE_DYNAMIC_RANGE (VIDEO_CID_CAMERA_CLASS_BASE + 21) |
| Enables or disables the camera's wide dynamic range feature. | |
| #define | VIDEO_CID_PAN_SPEED (VIDEO_CID_CAMERA_CLASS_BASE + 32) |
| This control turns the camera horizontally at the specific speed. | |
| #define | VIDEO_CID_TILT_SPEED (VIDEO_CID_CAMERA_CLASS_BASE + 33) |
| This control turns the camera vertically at the specified speed. | |
| #define | VIDEO_CID_CAMERA_ORIENTATION (VIDEO_CID_CAMERA_CLASS_BASE + 34) |
| This read-only control describes the camera position on the device It by reports where the camera camera is installed, its mounting position on the device. | |
| #define | VIDEO_CID_CAMERA_SENSOR_ROTATION (VIDEO_CID_CAMERA_CLASS_BASE + 35) |
| This read-only control describes the orientation of the sensor in the device. | |
| enum | video_exposure_type { VIDEO_EXPOSURE_AUTO = 0 , VIDEO_EXPOSURE_MANUAL = 1 , VIDEO_EXPOSURE_SHUTTER_PRIORITY = 2 , VIDEO_EXPOSURE_APERTURE_PRIORITY = 3 } |
| Video exposure type. More... | |
| enum | video_camera_orientation { VIDEO_CAMERA_ORIENTATION_FRONT = 0 , VIDEO_CAMERA_ORIENTATION_BACK = 1 , VIDEO_CAMERA_ORIENTATION_EXTERNAL = 2 } |
| Video camera orientation. More... | |
Main header file for video controls driver API.