drivers: video: controls: rename all CIDs to Linux counterpart #78802
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ngphibang marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,162 @@ | ||
| /* | ||
| * Copyright (c) 2019 Linaro Limited. | ||
| * Copyright (c) 2024 tinyVision.ai Inc. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| #ifndef ZEPHYR_INCLUDE_VIDEO_CONTROLS_H_ | ||
| #define ZEPHYR_INCLUDE_VIDEO_CONTROLS_H_ | ||
|
|
||
| /** | ||
| * @file | ||
| * | ||
| * @brief Public APIs for Video. | ||
| */ | ||
|
|
||
| /** | ||
| * @brief Video controls | ||
| * @defgroup video_controls Video Controls | ||
| * @ingroup io_interfaces | ||
| * | ||
| * 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 | ||
| * @c linux/include/uapi/linux/v4l2-controls.h | ||
| * | ||
| * @{ | ||
| */ | ||
|
|
||
| #ifdef __cplusplus | ||
| extern "C" { | ||
| #endif | ||
|
|
||
| /** | ||
| * @name Base class control IDs | ||
| * @{ | ||
| */ | ||
| #define VIDEO_CID_BASE 0x00980900 | ||
|
|
||
| /** Amount of perceived light of the image, the luma (Y') value. */ | ||
| #define VIDEO_CID_BRIGHTNESS (VIDEO_CID_BASE + 0) | ||
|
|
||
| /** Amount of difference between the bright colors and dark colors. */ | ||
| #define VIDEO_CID_CONTRAST (VIDEO_CID_BASE + 1) | ||
|
|
||
| /** Colorfulness of the image while preserving its brightness */ | ||
| #define VIDEO_CID_SATURATION (VIDEO_CID_BASE + 2) | ||
|
|
||
| /** Shift in the tint of every colors, clockwise in a RGB color wheel */ | ||
| #define VIDEO_CID_HUE (VIDEO_CID_BASE + 3) | ||
|
|
||
| /** Amount of time an image sensor is exposed to light, affecting the brightness */ | ||
| #define VIDEO_CID_EXPOSURE (VIDEO_CID_BASE + 17) | ||
|
Comment on lines
+42
to
+55
Contributor
There was a problem hiding this comment. I appreciate the effort to make sure all public API is documented but FWIW I find these oddly worded for some reason. I guess that's what happens when the names are already mostly self-explanatory and one doesn't want to literally paraphrase them in the comment. Not blocking though :)
Contributor
There was a problem hiding this comment. Yes, I have same thoughts too and sometimes, the explanation is not totally correct as it is difficult to explain in short words, so it is better to not explain, developers who actually use these CID need to understand them, I think :-). But it's not a blocking point.
Contributor
Author
There was a problem hiding this comment. Reading them again, these do not help understanding what the control do. Better not risk defining them slightly differently than Linux ones. Frequent issue of newbies: they reinvent the wheel. New PR to address these small changes. Thank you for the feedback . :)
Contributor
Author
There was a problem hiding this comment. How about a link to this page for reference?
Contributor
There was a problem hiding this comment. Yes, I think it's a good idea but I am not sure if it's OK in Zephyr to refer to documentation of a different project. |
||
|
|
||
| /** Amount of amplification performed to each pixel electrical signal, affecting the brightness */ | ||
| #define VIDEO_CID_GAIN (VIDEO_CID_BASE + 19) | ||
|
|
||
| /** Flip the image horizontally: the left side becomes the right side */ | ||
| #define VIDEO_CID_HFLIP (VIDEO_CID_BASE + 20) | ||
|
|
||
| /** Flip the image vertically: the top side becomes the bottom side */ | ||
| #define VIDEO_CID_VFLIP (VIDEO_CID_BASE + 21) | ||
|
|
||
| /** Frequency of the power line to compensate for, avoiding flicker due to artificial lighting */ | ||
| #define VIDEO_CID_POWER_LINE_FREQUENCY (VIDEO_CID_BASE + 24) | ||
| 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, | ||
| }; | ||
|
|
||
| /** Balance of colors in direction of blue (cold) or red (warm) */ | ||
| #define VIDEO_CID_WHITE_BALANCE_TEMPERATURE (VIDEO_CID_BASE + 26) | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
||
| /** | ||
| * @name Stateful codec controls IDs | ||
| * @{ | ||
| */ | ||
| #define VIDEO_CID_CODEC_CLASS_BASE 0x00990900 | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
||
| /** | ||
| * @name Camera class controls IDs | ||
| * @{ | ||
| */ | ||
| #define VIDEO_CID_CAMERA_CLASS_BASE 0x009a0900 | ||
|
|
||
| /** Amount of optical zoom applied through to the camera optics */ | ||
| #define VIDEO_CID_ZOOM_ABSOLUTE (VIDEO_CID_CAMERA_CLASS_BASE + 13) | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
||
| /** | ||
| * @name Camera Flash class control IDs | ||
| * @{ | ||
| */ | ||
| #define VIDEO_CID_FLASH_CLASS_BASE 0x009c0900 | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
||
| /** | ||
| * @name JPEG class control IDs | ||
| * @{ | ||
| */ | ||
| #define VIDEO_CID_JPEG_CLASS_BASE 0x009d0900 | ||
|
|
||
| /** Quality (Q) factor of the JPEG algorithm, also increasing the data size */ | ||
| #define VIDEO_CID_JPEG_COMPRESSION_QUALITY (VIDEO_CID_JPEG_CLASS_BASE + 3) | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
||
| /** | ||
| * @name Image Source class control IDs | ||
| * @{ | ||
| */ | ||
| #define VIDEO_CID_IMAGE_SOURCE_CLASS_BASE 0x009e0900 | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
||
| /** | ||
| * @name Image Processing class control IDs | ||
| * @{ | ||
| */ | ||
| #define VIDEO_CID_IMAGE_PROC_CLASS_BASE 0x009f0900 | ||
|
|
||
| /** Pixel rate (pixels/second) in the device's pixel array. This control is read-only. */ | ||
| #define VIDEO_CID_PIXEL_RATE (VIDEO_CID_IMAGE_PROC_CLASS_BASE + 2) | ||
|
|
||
| /** Selection of the type of test pattern to represent */ | ||
| #define VIDEO_CID_TEST_PATTERN (VIDEO_CID_IMAGE_PROC_CLASS_BASE + 3) | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
||
| /** | ||
| * @name Vendor-specific class control IDs | ||
| * @{ | ||
| */ | ||
| #define VIDEO_CID_PRIVATE_BASE 0x08000000 | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
@@ -88,8 +165,6 @@ enum video_power_line_frequency { | |
| } | ||
| #endif | ||
|
|
||
| /** | ||
| * @} | ||
| */ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.