drivers: video: add format utilities to improve usability #79476

josuah · 2024-10-06T18:51:34Z

Introduce several enhancements for dealing with the video API:

Documentation of formats inspired from this LWN article [EDIT: this representation is convenient, but note that the bit packing of RGB565, RGB555, RGB565X, RGB555X are wrong in it].

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 grep through[EDIT: fixed version below]:

* | Bbbbbbbb | Gggggggg | Bbbbbbbb | Gggggggg | Bbbbbbbb | Gggggggg | ...
* | Gggggggg | Rrrrrrrr | Gggggggg | Rrrrrrrr | Gggggggg | Rrrrrrrr | ...
*
* | gggBbbbb | RrrrrGgg | ...
*
* | Xxxxxxxx Rrrrrrrr Gggggggg Bbbbbbbb | ...

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() to VIDEO_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.

loicpoulain · 2024-10-07T18:29:50Z

include/zephyr/drivers/video.h

From macro below, should be "{fourcc} {width}x{height}" ?

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 · 2024-10-14T21:55:14Z

force-push: CI fixes
force-push: rebase

josuah · 2024-10-15T16:16:47Z

force-push: use _BPP instead of _BITS_PER_PIXEL following this new function naming:
https://github.com/zephyrproject-rtos/zephyr/pull/76475/files#diff-70c4de6949b97c13ac893b4bfb16fbcc433593fbfa96ec8947bb5cb83c4d04bcR835-R852

josuah · 2024-10-21T10:02:42Z

force-push: split <zephyr/drivers/video-formats.h> into <zephyr/drivers/video/formats.h>, like it is done for all other Zephyr driver includes: include/zephyr/drivers

cfriedt · 2025-01-18T09:59:43Z

doc/releases/migration-guide-4.1.rst

Please use BITS_PER_BYTE throughout this change.

cfriedt

Please use BITS_PER_BYTE instead of /8 or *8

josuah · 2025-01-18T14:15:23Z

force-push:

rebase on main
use / BITS_PER_BYTE instead of / 8 when relevant (thank you @cfriedt!)

I also applied BITS_PER_BYTE here location hoping that is what was meant.

doc/releases/migration-guide-4.1.rst

kartben · 2025-01-23T15:49:55Z

@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 <[email protected]>

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 <[email protected]>

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 <[email protected]>

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 <[email protected]>

josuah · 2025-01-23T17:13:21Z

Yes of course!

kartben

Yes of course!

Thanks! Didn't expect it to dismiss existing approvals as I don't think there were any conflicts but, anyway, refresh +1 :)

josuah added Enhancement Changes/Updates/Additions to existing features area: Video Video subsystem labels Oct 6, 2024

josuah requested review from LucasTambor, loicpoulain and ngphibang October 6, 2024 18:51

zephyrbot added the area: Samples Samples label Oct 6, 2024

zephyrbot requested review from kartben and nashif October 6, 2024 18:52

zephyrbot assigned kartben Oct 6, 2024

loicpoulain reviewed Oct 7, 2024

View reviewed changes

loicpoulain self-requested a review October 11, 2024 20:04

josuah force-pushed the pr-video-format-utilities branch from 29a4758 to 6c21f48 Compare October 14, 2024 11:40

loicpoulain previously approved these changes Oct 14, 2024

View reviewed changes

josuah dismissed loicpoulain’s stale review via 6762ced October 14, 2024 13:58

josuah force-pushed the pr-video-format-utilities branch 3 times, most recently from c021247 to d541c10 Compare October 14, 2024 21:53

josuah force-pushed the pr-video-format-utilities branch from d541c10 to a9587f1 Compare October 15, 2024 16:14

josuah mentioned this pull request Oct 15, 2024

Improve NXP CSI and MIPI_CSI2Rx drivers #76475

Merged

zephyrbot added the area: C++ label Oct 21, 2024

zephyrbot requested review from alexanderwachter, cfriedt and stephanosio October 21, 2024 09:59

josuah force-pushed the pr-video-format-utilities branch from 12ca486 to 75345f9 Compare October 21, 2024 10:02

zephyrbot added the area: Process label Oct 21, 2024

zephyrbot requested a review from MaureenHelm October 21, 2024 10:03

josuah force-pushed the pr-video-format-utilities branch from 75345f9 to ac056cf Compare October 21, 2024 10:08

cfriedt reviewed Jan 18, 2025

View reviewed changes

cfriedt requested changes Jan 18, 2025

View reviewed changes

josuah dismissed ngphibang’s stale review via 6ce200d January 18, 2025 14:12

josuah force-pushed the pr-video-format-utilities branch from e8ad2e7 to 6ce200d Compare January 18, 2025 14:12

cfriedt reviewed Jan 18, 2025

View reviewed changes

doc/releases/migration-guide-4.1.rst Outdated Show resolved Hide resolved

josuah force-pushed the pr-video-format-utilities branch from 6ce200d to f1bc836 Compare January 19, 2025 17:46

cfriedt previously approved these changes Jan 19, 2025

View reviewed changes

kartben previously approved these changes Jan 20, 2025

View reviewed changes

doc/releases/migration-guide-4.1.rst Outdated Show resolved Hide resolved

josuah dismissed stale reviews from kartben and cfriedt via 7e1e702 January 20, 2025 13:03

josuah force-pushed the pr-video-format-utilities branch from f1bc836 to 7e1e702 Compare January 20, 2025 13:03

kartben previously approved these changes Jan 21, 2025

View reviewed changes

cfriedt previously approved these changes Jan 21, 2025

View reviewed changes

kartben unassigned ngphibang Jan 21, 2025

josuah added 4 commits January 23, 2025 17:13

josuah dismissed stale reviews from cfriedt and kartben via a35b5c6 January 23, 2025 17:13

josuah force-pushed the pr-video-format-utilities branch from 7e1e702 to a35b5c6 Compare January 23, 2025 17:13

zephyrbot assigned fabiobaltieri and kartben Jan 23, 2025

kartben approved these changes Jan 23, 2025

View reviewed changes

cfriedt approved these changes Jan 24, 2025

View reviewed changes

kartben merged commit 9cebc19 into zephyrproject-rtos:main Jan 24, 2025
24 checks passed

josuah mentioned this pull request Feb 24, 2025

drivers: video: introduce VIDEO_FOURCC_TO_STR #86199

Merged

drivers: video: add format utilities to improve usability #79476

drivers: video: add format utilities to improve usability #79476

Uh oh!

Conversation

josuah commented Oct 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

loicpoulain Oct 7, 2024

Choose a reason for hiding this comment

Uh oh!

josuah Oct 7, 2024

Choose a reason for hiding this comment

Uh oh!

josuah commented Oct 14, 2024

Uh oh!

josuah commented Oct 15, 2024

Uh oh!

josuah commented Oct 21, 2024

Uh oh!

cfriedt Jan 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cfriedt left a comment

Choose a reason for hiding this comment

Uh oh!

josuah commented Jan 18, 2025

Uh oh!

Uh oh!

Uh oh!

kartben commented Jan 23, 2025

Uh oh!

josuah commented Jan 23, 2025

Uh oh!

kartben left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

josuah commented Oct 6, 2024 •

edited

Loading

cfriedt Jan 18, 2025 •

edited

Loading