Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Video Controls
Device Driver APIs

Video controls . 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_GAIN   (VIDEO_CID_BASE + 19)
 Amount of amplification performed to each pixel electrical signal, affecting the brightness.
 
#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)
 

Stateful codec controls IDs

#define VIDEO_CID_CODEC_CLASS_BASE   0x00990900
 

Camera class controls IDs

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

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
 

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
 

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

Amount of amplification performed to each pixel electrical signal, affecting the brightness.

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

Shift in the tint of every colors, clockwise in a RGB color wheel.

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

#define VIDEO_CID_SATURATION   (VIDEO_CID_BASE + 2)

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

Colorfulness of the image while preserving its brightness.

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

Balance of colors in direction of blue (cold) or red (warm)

◆ VIDEO_CID_ZOOM_ABSOLUTE

#define VIDEO_CID_ZOOM_ABSOLUTE   (VIDEO_CID_CAMERA_CLASS_BASE + 13)

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

Amount of optical zoom applied through to the camera optics.

Enumeration Type Documentation

◆ 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