drivers: video: add format utilities to improve usability #79476
Conversation
This file contains 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
josuah
added
Enhancement
loicpoulain
reviewed
Oct 7, 2024
include/zephyr/drivers/video.h
Outdated
| /** | ||
| * @brief Print formatter to use in printf() style format strings. | ||
| * | ||
| * This prints a video format in the form of "{width}x{height} {fourcc}" format |
There was a problem hiding this comment.
From macro below, should be "{fourcc} {width}x{height}" ?
There was a problem hiding this comment.
You are right, I changed it after seeing how v4l2-ctl and the examples show the formats but forgot to update thedoc. I will adjust it along with other doc fixups.
Thank you for pointing it!
josuah
force-pushed
the
pr-video-format-utilities
branch
from
29a4758 to
6c21f48
Compare
loicpoulain
previously approved these changes
Oct 14, 2024
josuah
force-pushed
the
pr-video-format-utilities
branch
3 times, most recently
from
c021247 to
d541c10
Compare
|
force-push: CI fixes |
josuah
force-pushed
the
pr-video-format-utilities
branch
from
d541c10 to
a9587f1
Compare
|
force-push: use |
josuah
force-pushed
the
pr-video-format-utilities
branch
from
12ca486 to
75345f9
Compare
|
force-push: split |
josuah
force-pushed
the
pr-video-format-utilities
branch
from
75345f9 to
ac056cf
Compare
ngphibang
previously approved these changes
Jan 15, 2025
cfriedt
reviewed
Jan 18, 2025
doc/releases/migration-guide-4.1.rst
Outdated
| * The ``video_pix_fmt_bpp()`` function was returning a byte count, this got replaced by | ||
| ``video_bits_per_pixel()`` which return a bit count. For instance, invocations such as | ||
| ``pitch = width * video_pix_fmt_bpp(pixfmt)`` needs to be replaced by an equivalent | ||
| ``pitch = width * video_bits_per_pixel(pixfmt) / 8``. |
There was a problem hiding this comment.
Please use BITS_PER_BYTE throughout this change.
cfriedt
requested changes
Jan 18, 2025
josuah
force-pushed
the
pr-video-format-utilities
branch
from
e8ad2e7 to
6ce200d
Compare
cfriedt
reviewed
Jan 18, 2025
josuah
force-pushed
the
pr-video-format-utilities
branch
from
6ce200d to
f1bc836
Compare
cfriedt
previously approved these changes
Jan 19, 2025
kartben
previously approved these changes
Jan 20, 2025
josuah
force-pushed
the
pr-video-format-utilities
branch
from
f1bc836 to
7e1e702
Compare
kartben
previously approved these changes
Jan 21, 2025
cfriedt
previously approved these changes
Jan 21, 2025
|
@josuah can you please rebase? random CI glitch causing a job to be stuck and can't seem to be able to re-trigger it manually. Thanks! |
Introduce a new text documentation of the video formats, describing every bit, gives the position of the most significant bit, outline how it is cut in bytes, and show the pixel segmentation. Extra care is taken for the RGB565 which requies paying attention to the bit endianess as well as the byte endianess. Signed-off-by: Josuah Demangeon <me@josuah.net>
Rename video_fourcc() to VIDEO_FOURCC(), differing from the Linux implementation, but more compliant with the coding style. Also introduce a VIDEO_FOURCC_FROM_STR() to generate a FOURCC format code out of a 4-characters string. Signed-off-by: Josuah Demangeon <me@josuah.net>
This was present in the form of video_pix_fmt_bpp() inside ST and NXP drivers, and was returning the number of bytes, which does not allow support for 10-bits, 4-bits or non-byte aligned video formats. The helper leverages the VIDEO_PIX_FMT_*_BITS macros. Signed-off-by: Josuah Demangeon <me@josuah.net>
The previous commit introduces video_bits_per_pixel() and converts all invocation relying on video_pix_fmt_bpp(), 3rd-party users will need to do the same on their code, and this is not a 100% drop-in API, so better document it on the release notes. Signed-off-by: Josuah Demangeon <me@josuah.net>
josuah
force-pushed
the
pr-video-format-utilities
branch
from
7e1e702 to
a35b5c6
Compare
|
Yes of course! |
kartben
approved these changes
Jan 23, 2025
cfriedt
approved these changes
Jan 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Introduce several enhancements for dealing with the video API:
note: this image is wrong for RGB565 format!
But in a text-based format to be easy to maintain and colorblindness-friendly, and easy to
grepthrough[EDIT: fixed version below]:Add a printf() formatter like stdint.h's PRIu32:
printf("video format: " PRIvfmt, PRIvfmt_arg(&fmt));This is present elsewhere on Zephyr
Convert
video_fourcc()toVIDEO_FOURCC()and make it visible to the documentation, now that it is used outside of the header itself.Add a
VIDEO_FOURCC_FROM_STR()to easily convert a string from i.e. Kconfig or the devicetree.Looking forward to your feedback and advises.