Video controls . More...

Data Structures
struct	video_control
	Video control structure. More...

struct	video_ctrl_range

struct	video_ctrl_query

struct	video_control_range
	Video control range structure. More...

struct	video_control_query
	Video control query structure. More...

Base class control IDs
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 }

#define	VIDEO_CID_BASE 0x00980900

#define	VIDEO_CID_BRIGHTNESS (VIDEO_CID_BASE + 0)
	Amount of perceived light of the image, the luma (Y') value.

#define	VIDEO_CID_CONTRAST (VIDEO_CID_BASE + 1)
	Amount of difference between the bright colors and dark colors.

#define	VIDEO_CID_SATURATION (VIDEO_CID_BASE + 2)
	Colorfulness of the image while preserving its brightness.

#define	VIDEO_CID_HUE (VIDEO_CID_BASE + 3)
	Shift in the tint of every colors, clockwise in a RGB color wheel.

#define	VIDEO_CID_EXPOSURE (VIDEO_CID_BASE + 17)
	Amount of time an image sensor is exposed to light, affecting the brightness.

#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, avoiding flicker due to artificial lighting.

#define	VIDEO_CID_WHITE_BALANCE_TEMPERATURE (VIDEO_CID_BASE + 26)
	Balance of colors in direction of blue (cold) or red (warm)

#define	VIDEO_CID_LASTP1 (VIDEO_CID_BASE + 44)
	Last base CID + 1.

Camera class controls IDs
enum	video_exposure_auto_type { VIDEO_EXPOSURE_AUTO = 0 , VIDEO_EXPOSURE_MANUAL = 1 , VIDEO_EXPOSURE_SHUTTER_PRIORITY = 2 , VIDEO_EXPOSURE_APERTURE_PRIORITY = 3 }

#define	VIDEO_CID_CAMERA_CLASS_BASE 0x009a0900

#define	VIDEO_CID_EXPOSURE_AUTO (VIDEO_CID_CAMERA_CLASS_BASE + 1)
	Adjustments of exposure time and/or iris aperture.

#define	VIDEO_CID_ZOOM_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 13)
	Amount of optical zoom applied through to the camera optics.

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_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

Detailed Description

Video controls .

The Video control IDs (CIDs) are introduced with the same name as Linux V4L2 subsystem and under the same class. This facilitates inter-operability and debugging devices end-to-end across Linux and Zephyr.

This list is maintained compatible to the Linux kernel definitions in linux/include/uapi/linux/v4l2-controls.h

Macro Definition Documentation

◆ VIDEO_CID_ANALOGUE_GAIN

#define VIDEO_CID_ANALOGUE_GAIN (VIDEO_CID_IMAGE_SOURCE_CLASS_BASE + 3)

#include <zephyr/drivers/video-controls.h>

Analogue gain control.

◆ VIDEO_CID_AUTOGAIN

#define VIDEO_CID_AUTOGAIN (VIDEO_CID_BASE + 18)

#include <zephyr/drivers/video-controls.h>

Automatic gain control.

◆ VIDEO_CID_BASE

#define VIDEO_CID_BASE 0x00980900

#include <zephyr/drivers/video-controls.h>

◆ VIDEO_CID_BRIGHTNESS

#define VIDEO_CID_BRIGHTNESS (VIDEO_CID_BASE + 0)

#include <zephyr/drivers/video-controls.h>

Amount of perceived light of the image, the luma (Y') value.

◆ VIDEO_CID_CAMERA_CLASS_BASE

#define VIDEO_CID_CAMERA_CLASS_BASE 0x009a0900

#include <zephyr/drivers/video-controls.h>

◆ VIDEO_CID_CODEC_CLASS_BASE

#define VIDEO_CID_CODEC_CLASS_BASE 0x00990900

#include <zephyr/drivers/video-controls.h>

◆ VIDEO_CID_CONTRAST

#define VIDEO_CID_CONTRAST (VIDEO_CID_BASE + 1)

#include <zephyr/drivers/video-controls.h>

Amount of difference between the bright colors and dark colors.

◆ VIDEO_CID_EXPOSURE

#define VIDEO_CID_EXPOSURE (VIDEO_CID_BASE + 17)

#include <zephyr/drivers/video-controls.h>

Amount of time an image sensor is exposed to light, affecting the brightness.

◆ VIDEO_CID_EXPOSURE_AUTO

#define VIDEO_CID_EXPOSURE_AUTO (VIDEO_CID_CAMERA_CLASS_BASE + 1)

#include <zephyr/drivers/video-controls.h>

Adjustments of exposure time and/or iris aperture.

◆ VIDEO_CID_FLASH_CLASS_BASE

#define VIDEO_CID_FLASH_CLASS_BASE 0x009c0900

#include <zephyr/drivers/video-controls.h>

◆ VIDEO_CID_GAIN

#define VIDEO_CID_GAIN (VIDEO_CID_BASE + 19)

#include <zephyr/drivers/video-controls.h>

Gain control.

Most devices control only digital gain with this control. Devices that recognise the difference between digital and analogue gain use VIDEO_CID_DIGITAL_GAIN and VIDEO_CID_ANALOGUE_GAIN.