Skip to content

doc: migration-guide-4.2: video: add note on pitch #90110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

josuah
Copy link
Collaborator

@josuah josuah commented May 18, 2025

Dependencies:

Document the change of semantics of video_format.pitch field, modified in 33dcbe3

A separate patch to allow it to be discussed separately and speed-up #87366 review.

@josuah josuah requested a review from ngphibang May 18, 2025 17:32
* video_format.pitch is no longer to be set by the application, but instead written back by
the driver letting the application know how much padding this particular driver will use
per line and in turn know the required buffer size. Existing applications will not be
broken by this change but can be simplified as performed in the samplesp in the commit
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/samplesp/sample

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I also split an overly long sentence in half in the process.

@josuah josuah force-pushed the pr-video-migration-guide branch from d0fc96b to f9a1ab4 Compare May 18, 2025 21:29
ngphibang
ngphibang previously approved these changes May 18, 2025
@josuah josuah added Release Notes To be mentioned in the release notes area: Video Video subsystem labels May 18, 2025
@josuah josuah marked this pull request as ready for review May 23, 2025 23:45
the driver. Then the application can know how much padding this particular driver uses
per line, and in turn know the required buffer size. Existing applications will not be
broken by this change but can be simplified as performed in the sample in the commit
``33dcbe37cfd3593e8c6e9cfd218dd31fdd533598``.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A proposed re-wording:

video_format.ptich has been updated to be set explicitly by the driver, a task formerly required of the application.
  This update enables the application to correctly allocate a buffer size on a per driver basis.  Existing applications
 will not be broken by this change but can be simplified as performed in the sample in the commit
 ``33dcbe37cfd3593e8c6e9cfd218dd31fdd533598``.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to be synthetic and high-level here... Thanks!

@josuah
Copy link
Collaborator Author

josuah commented Jun 2, 2025

Force-push:

  • Rebase on lastest main
  • Apply rewording from @dkalowsk.

Copy link

sonarqubecloud bot commented Jun 2, 2025

Document the change of semantics of video_format.pitch field,
modified in commit 33dcbe3.

Signed-off-by: Josuah Demangeon <me@josuah.net>
@josuah josuah requested a review from dkalowsk June 2, 2025 17:37
@danieldegrasse danieldegrasse merged commit efe7677 into zephyrproject-rtos:main Jun 20, 2025
21 checks passed
@josuah josuah deleted the pr-video-migration-guide branch June 20, 2025 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Video Video subsystem Release Notes To be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants