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 }

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 }

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

#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)

#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.

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

enum	video_camera_orientation { VIDEO_CAMERA_ORIENTATION_FRONT = 0 , VIDEO_CAMERA_ORIENTATION_BACK = 1 , VIDEO_CAMERA_ORIENTATION_EXTERNAL = 2 }

#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.

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_ALPHA_COMPONENT

#define VIDEO_CID_ALPHA_COMPONENT (VIDEO_CID_BASE + 41)

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

Sets the alpha color component.

Some devices produce data with a user-controllable alpha component. Set the value applied to the alpha channel of every pixel produced.

◆ 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_AUTO_WHITE_BALANCE

#define VIDEO_CID_AUTO_WHITE_BALANCE (VIDEO_CID_BASE + 12)

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

Automatic white balance (cameras).

◆ VIDEO_CID_AUTOBRIGHTNESS

#define VIDEO_CID_AUTOBRIGHTNESS (VIDEO_CID_BASE + 32)

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

◆ VIDEO_CID_AUTOGAIN

#define VIDEO_CID_AUTOGAIN (VIDEO_CID_BASE + 18)

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

Automatic gain control.

◆ VIDEO_CID_BACKLIGHT_COMPENSATION

#define VIDEO_CID_BACKLIGHT_COMPENSATION (VIDEO_CID_BASE + 28)

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

Adjusts the backlight compensation in a camera.

The minimum value disables backlight compensation.

◆ VIDEO_CID_BAND_STOP_FILTER

#define VIDEO_CID_BAND_STOP_FILTER (VIDEO_CID_BASE + 33)

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

Switch the band-stop filter of a camera sensor on or off, or specify its strength.

Such band-stop filters can be used, for example, to filter out the fluorescent light component.

◆ VIDEO_CID_BASE

#define VIDEO_CID_BASE 0x00980900

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

◆ VIDEO_CID_BLUE_BALANCE

#define VIDEO_CID_BLUE_BALANCE (VIDEO_CID_BASE + 15)

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

Blue chroma balance, as a ratio to the green channel.

◆ VIDEO_CID_BRIGHTNESS

#define VIDEO_CID_BRIGHTNESS (VIDEO_CID_BASE + 0)

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

Picture brightness, or more precisely, the black level.

◆ VIDEO_CID_CAMERA_CLASS_BASE

#define VIDEO_CID_CAMERA_CLASS_BASE 0x009a0900

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

◆ VIDEO_CID_CAMERA_ORIENTATION

#define VIDEO_CID_CAMERA_ORIENTATION (VIDEO_CID_CAMERA_CLASS_BASE + 34)

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

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.

This control is particularly meaningful for devices which have a well defined orientation, such as phones, laptops and portable devices since the control is expressed as a position relative to the device's intended usage orientation. , or , are said to have the VIDEO_CAMERA_ORIENTATION_EXTERNAL orientation.

◆ VIDEO_CID_CAMERA_SENSOR_ROTATION

#define VIDEO_CID_CAMERA_SENSOR_ROTATION (VIDEO_CID_CAMERA_CLASS_BASE + 35)

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

This read-only control describes the orientation of the sensor in the device.

The value is the rotation correction in degrees in the counter-clockwise direction to be applied to the captured images once captured to memory to compensate for the camera sensor mounting rotation.

◆ VIDEO_CID_CODEC_CLASS_BASE

#define VIDEO_CID_CODEC_CLASS_BASE 0x00990900

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

◆ VIDEO_CID_COLORFX

#define VIDEO_CID_COLORFX (VIDEO_CID_BASE + 31)

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

Selects a color effect.

◆ VIDEO_CID_CONTRAST

#define VIDEO_CID_CONTRAST (VIDEO_CID_BASE + 1)

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

Picture contrast or luma gain.

◆ VIDEO_CID_EXPOSURE

#define VIDEO_CID_EXPOSURE (VIDEO_CID_BASE + 17)

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

Image sensor exposure time.

◆ VIDEO_CID_EXPOSURE_ABSOLUTE

#define VIDEO_CID_EXPOSURE_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 2)

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

Determines the exposure time of the camera sensor.

The exposure time is limited by the frame in terval. Drivers should interpret the values as 100 µs units, where the value 1 stands for 1/10000th of a second, 10000 for 1 second and 100000 for 10 seconds.

◆ VIDEO_CID_EXPOSURE_AUTO

#define VIDEO_CID_EXPOSURE_AUTO (VIDEO_CID_CAMERA_CLASS_BASE + 1)

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

Enables automatic adjustments of the exposure time and/or iris aperture.

Manual exposure or iris changes when it is not VIDEO_EXPOSURE_MANUAL is undefined. Drivers should ignore such requests.

◆ VIDEO_CID_EXPOSURE_AUTO_PRIORITY

#define VIDEO_CID_EXPOSURE_AUTO_PRIORITY (VIDEO_CID_CAMERA_CLASS_BASE + 3)

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

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.

Disabled by default: the frame rate must remain constant.

◆ VIDEO_CID_FLASH_CLASS_BASE

#define VIDEO_CID_FLASH_CLASS_BASE 0x009c0900

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

◆ VIDEO_CID_FOCUS_ABSOLUTE

#define VIDEO_CID_FOCUS_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 10)

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

This control sets the focal point of the camera to the specified position.

The unit is undefined. Positive values set the focus closer to the camera, negative values towards infinity.

◆ VIDEO_CID_FOCUS_AUTO

#define VIDEO_CID_FOCUS_AUTO (VIDEO_CID_CAMERA_CLASS_BASE + 12)

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

Enables continuous automatic focus adjustments.

Manual focus adjustments while this control is on (set to 1) is undefined. Drivers should ignore such requests.

◆ VIDEO_CID_FOCUS_RELATIVE

#define VIDEO_CID_FOCUS_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 11)

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

This write-only control moves the focal point of the camera by the specified amount.

The unit is undefined. Positive values move the focus closer to the camera, negative values towards infinity.

◆ 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.

◆ VIDEO_CID_GAMMA

#define VIDEO_CID_GAMMA (VIDEO_CID_BASE + 16)

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

Gamma adjust.

◆ VIDEO_CID_HFLIP

#define VIDEO_CID_HFLIP (VIDEO_CID_BASE + 20)

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

Flip the image horizontally: the left side becomes the right side.

◆ VIDEO_CID_HUE

#define VIDEO_CID_HUE (VIDEO_CID_BASE + 3)

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

Hue or color balance.

◆ VIDEO_CID_HUE_AUTO

#define VIDEO_CID_HUE_AUTO (VIDEO_CID_BASE + 25)

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

Enables automatic hue control by the device.

Setting VIDEO_CID_HUE while automatic hue control is enabled is undefined. Drivers should ignore such request.

◆ VIDEO_CID_IMAGE_PROC_CLASS_BASE

#define VIDEO_CID_IMAGE_PROC_CLASS_BASE 0x009f0900

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

◆ VIDEO_CID_IMAGE_SOURCE_CLASS_BASE

#define VIDEO_CID_IMAGE_SOURCE_CLASS_BASE 0x009e0900

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

◆ VIDEO_CID_IRIS_ABSOLUTE

#define VIDEO_CID_IRIS_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 17)

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

This control sets the camera's aperture to the specified value.

The unit is undefined. Larger values open the iris wider, smaller values close it.

◆ VIDEO_CID_IRIS_RELATIVE

#define VIDEO_CID_IRIS_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 18)

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

This write-only control modifies the camera's aperture by the specified amount.

The unit is undefined. Positive values open the iris one step further, negative values close it one step further.

◆ VIDEO_CID_JPEG_CLASS_BASE

#define VIDEO_CID_JPEG_CLASS_BASE 0x009d0900

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

◆ VIDEO_CID_JPEG_COMPRESSION_QUALITY

#define VIDEO_CID_JPEG_COMPRESSION_QUALITY (VIDEO_CID_JPEG_CLASS_BASE + 3)

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

Quality (Q) factor of the JPEG algorithm, also increasing the data size.

◆ VIDEO_CID_LASTP1

#define VIDEO_CID_LASTP1 (VIDEO_CID_BASE + 44)

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

Last base CID + 1.

◆ VIDEO_CID_PAN_ABSOLUTE

#define VIDEO_CID_PAN_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 8)

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

This control turns the camera horizontally to the specified position.

Positive values move the camera to the right (clockwise when viewed from above), negative values to the left. Drivers should interpret the values as arc seconds, with valid values between -180 * 3600 and +180 * 3600 inclusive.

◆ VIDEO_CID_PAN_RELATIVE

#define VIDEO_CID_PAN_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 4)

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

This write-only control turns the camera horizontally by the specified amount.

The unit is undefined. A positive value moves the camera to the right (clockwise when viewed from above), a negative value to the left. A value of zero does not cause motion.

◆ VIDEO_CID_PAN_SPEED

#define VIDEO_CID_PAN_SPEED (VIDEO_CID_CAMERA_CLASS_BASE + 32)

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

This control turns the camera horizontally at the specific speed.

The unit is undefined. A positive value moves the camera to the right (clockwise when viewed from above), a negative value to the left. A value of zero stops the motion if one is in progress and has no effect otherwise.

◆ VIDEO_CID_PIXEL_RATE

#define VIDEO_CID_PIXEL_RATE (VIDEO_CID_IMAGE_PROC_CLASS_BASE + 2)

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

Pixel rate (pixels/second) in the device's pixel array.

This control is read-only.

◆ VIDEO_CID_POWER_LINE_FREQUENCY

#define VIDEO_CID_POWER_LINE_FREQUENCY (VIDEO_CID_BASE + 24)

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

Frequency of the power line to compensate for, avoiding flicker due to artificial lighting.

◆ VIDEO_CID_PRIVATE_BASE

#define VIDEO_CID_PRIVATE_BASE 0x08000000

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

◆ VIDEO_CID_RED_BALANCE

#define VIDEO_CID_RED_BALANCE (VIDEO_CID_BASE + 14)

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

Red chroma balance, as a ratio to the green channel.

◆ VIDEO_CID_SATURATION

#define VIDEO_CID_SATURATION (VIDEO_CID_BASE + 2)

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

Picture color saturation or chroma gain.

◆ VIDEO_CID_SHARPNESS

#define VIDEO_CID_SHARPNESS (VIDEO_CID_BASE + 27)

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

Adjusts the sharpness filters in a camera.

The minimum value disables the filters, higher values give a sharper picture.

◆ VIDEO_CID_TEST_PATTERN

#define VIDEO_CID_TEST_PATTERN (VIDEO_CID_IMAGE_PROC_CLASS_BASE + 3)

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

Selection of the type of test pattern to represent.

◆ VIDEO_CID_TILT_ABSOLUTE

#define VIDEO_CID_TILT_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 9)

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

This control turns the camera vertically to the specified position.

Positive values move the camera up, negative values down. Drivers should interpret the values as arc seconds, with valid values between -180 * 3600 and +180 * 3600 inclusive.

◆ VIDEO_CID_TILT_RELATIVE

#define VIDEO_CID_TILT_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 5)

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

This write-only control turns the camera vertically by the specified amount.

The unit is undefined. A positive value moves the camera up, a negative value down. A value of zero does not cause motion.

◆ VIDEO_CID_TILT_SPEED

#define VIDEO_CID_TILT_SPEED (VIDEO_CID_CAMERA_CLASS_BASE + 33)

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

This control turns the camera vertically at the specified speed.

The unit is undefined. A positive value moves the camera up, a negative value down. A value of zero stops the motion if one is in progress and has no effect otherwise.

◆ VIDEO_CID_VFLIP

#define VIDEO_CID_VFLIP (VIDEO_CID_BASE + 21)

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

Flip the image vertically: the top side becomes the bottom side.

◆ VIDEO_CID_WHITE_BALANCE_TEMPERATURE

#define VIDEO_CID_WHITE_BALANCE_TEMPERATURE (VIDEO_CID_BASE + 26)

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

White balance settings as a color temperature in Kelvin.

A driver should have a minimum range of 2800 (incandescent) to 6500 (daylight).

◆ VIDEO_CID_WIDE_DYNAMIC_RANGE

#define VIDEO_CID_WIDE_DYNAMIC_RANGE (VIDEO_CID_CAMERA_CLASS_BASE + 21)

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

Enables or disables the camera's wide dynamic range feature.

This feature allows to obtain clear images in situations where intensity of the illumination varies significantly throughout the scene, i.e. there are simultaneously very dark and very bright areas. It is most commonly realized in cameras by combining two subsequent frames with different exposure times.

◆ VIDEO_CID_ZOOM_ABSOLUTE

#define VIDEO_CID_ZOOM_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 13)

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

Specify the objective lens focal length as an absolute value.

The zoom unit is driver-specific and its value should be a positive integer.

◆ VIDEO_CID_ZOOM_CONTINUOUS

#define VIDEO_CID_ZOOM_CONTINUOUS (VIDEO_CID_CAMERA_CLASS_BASE + 15)

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

Start a continuous zoom movement.

Move the objective lens group at the specified speed until it reaches physical device limits or until an explicit request to stop the movement. A positive value moves the zoom lens group towards the telephoto direction. A value of zero stops the zoom lens group movement. A negative value moves the zoom lens group towards the wide-angle direction. The zoom speed unit is driver-specific.

◆ VIDEO_CID_ZOOM_RELATIVE

#define VIDEO_CID_ZOOM_RELATIVE (VIDEO_CID_CAMERA_CLASS_BASE + 14)

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

This write-only control sets the objective lens focal length relatively to the current value.

Positive values move the zoom lens group towards the telephoto direction, negative values towards the wide-angle direction. The zoom unit is driver-specific.

◆ VIDEO_CTRL_FLAG_NEXT_CTRL

#define VIDEO_CTRL_FLAG_NEXT_CTRL 0x80000000

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

Enumeration Type Documentation

◆ video_camera_orientation

enum video_camera_orientation

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

Enumerator
VIDEO_CAMERA_ORIENTATION_FRONT	Camera installed on the user-facing side of a phone/tablet/laptop device.
VIDEO_CAMERA_ORIENTATION_BACK	Camera installed on the opposite side of the user.
VIDEO_CAMERA_ORIENTATION_EXTERNAL	Camera sensors not directly attached to the device or that can move freely.

◆ video_colorfx

enum video_colorfx

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

Enumerator
VIDEO_COLORFX_NONE
VIDEO_COLORFX_BW
VIDEO_COLORFX_SEPIA
VIDEO_COLORFX_NEGATIVE
VIDEO_COLORFX_EMBOSS
VIDEO_COLORFX_SKETCH
VIDEO_COLORFX_SKY_BLUE
VIDEO_COLORFX_GRASS_GREEN
VIDEO_COLORFX_SKIN_WHITEN
VIDEO_COLORFX_VIVID
VIDEO_COLORFX_AQUA
VIDEO_COLORFX_ART_FREEZE
VIDEO_COLORFX_SILHOUETTE
VIDEO_COLORFX_SOLARIZATION
VIDEO_COLORFX_ANTIQUE

◆ video_exposure_type

enum video_exposure_type

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

Enumerator
VIDEO_EXPOSURE_AUTO
VIDEO_EXPOSURE_MANUAL
VIDEO_EXPOSURE_SHUTTER_PRIORITY
VIDEO_EXPOSURE_APERTURE_PRIORITY

◆ video_power_line_frequency

enum video_power_line_frequency

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

Enumerator
VIDEO_CID_POWER_LINE_FREQUENCY_DISABLED
VIDEO_CID_POWER_LINE_FREQUENCY_50HZ
VIDEO_CID_POWER_LINE_FREQUENCY_60HZ
VIDEO_CID_POWER_LINE_FREQUENCY_AUTO

Data Structures

Base class control IDs

Camera class controls IDs

Stateful codec controls IDs

Camera Flash class control IDs

JPEG class control IDs

Image Source class control IDs

Image Processing class control IDs

Vendor-specific class control IDs

Query flags, to be ORed with the control ID

Detailed Description

Macro Definition Documentation

◆ VIDEO_CID_ALPHA_COMPONENT

◆ VIDEO_CID_ANALOGUE_GAIN

◆ VIDEO_CID_AUTO_WHITE_BALANCE

◆ VIDEO_CID_AUTOBRIGHTNESS

◆ VIDEO_CID_AUTOGAIN

◆ VIDEO_CID_BACKLIGHT_COMPENSATION

◆ VIDEO_CID_BAND_STOP_FILTER

◆ VIDEO_CID_BASE

◆ VIDEO_CID_BLUE_BALANCE

◆ VIDEO_CID_BRIGHTNESS

◆ VIDEO_CID_CAMERA_CLASS_BASE

◆ VIDEO_CID_CAMERA_ORIENTATION

◆ VIDEO_CID_CAMERA_SENSOR_ROTATION

◆ VIDEO_CID_CODEC_CLASS_BASE

◆ VIDEO_CID_COLORFX

◆ VIDEO_CID_CONTRAST

◆ VIDEO_CID_EXPOSURE

◆ VIDEO_CID_EXPOSURE_ABSOLUTE

◆ VIDEO_CID_EXPOSURE_AUTO

◆ VIDEO_CID_EXPOSURE_AUTO_PRIORITY

◆ VIDEO_CID_FLASH_CLASS_BASE

◆ VIDEO_CID_FOCUS_ABSOLUTE

◆ VIDEO_CID_FOCUS_AUTO

◆ VIDEO_CID_FOCUS_RELATIVE

◆ VIDEO_CID_GAIN

◆ VIDEO_CID_GAMMA

◆ VIDEO_CID_HFLIP

◆ VIDEO_CID_HUE

◆ VIDEO_CID_HUE_AUTO

◆ VIDEO_CID_IMAGE_PROC_CLASS_BASE

◆ VIDEO_CID_IMAGE_SOURCE_CLASS_BASE

◆ VIDEO_CID_IRIS_ABSOLUTE

◆ VIDEO_CID_IRIS_RELATIVE

◆ VIDEO_CID_JPEG_CLASS_BASE

◆ VIDEO_CID_JPEG_COMPRESSION_QUALITY

◆ VIDEO_CID_LASTP1

◆ VIDEO_CID_PAN_ABSOLUTE

◆ VIDEO_CID_PAN_RELATIVE

◆ VIDEO_CID_PAN_SPEED

◆ VIDEO_CID_PIXEL_RATE

◆ VIDEO_CID_POWER_LINE_FREQUENCY

◆ VIDEO_CID_PRIVATE_BASE

◆ VIDEO_CID_RED_BALANCE

◆ VIDEO_CID_SATURATION

◆ VIDEO_CID_SHARPNESS

◆ VIDEO_CID_TEST_PATTERN

◆ VIDEO_CID_TILT_ABSOLUTE

◆ VIDEO_CID_TILT_RELATIVE

◆ VIDEO_CID_TILT_SPEED

◆ VIDEO_CID_VFLIP

◆ VIDEO_CID_WHITE_BALANCE_TEMPERATURE

◆ VIDEO_CID_WIDE_DYNAMIC_RANGE

◆ VIDEO_CID_ZOOM_ABSOLUTE

◆ VIDEO_CID_ZOOM_CONTINUOUS

◆ VIDEO_CID_ZOOM_RELATIVE

◆ VIDEO_CTRL_FLAG_NEXT_CTRL

Enumeration Type Documentation

◆ video_camera_orientation

◆ video_colorfx

◆ video_exposure_type

◆ video_power_line_frequency