Image entity media source

[OnFreund]

Proposed change

Add Image entities as media sources. Images that were previously represented as Camera entities did have media source.

Type of change

• [ ] Dependency upgrade
• [ ] Bugfix (non-breaking change which fixes an issue)
• [ ] New integration (thank you!)
• [X] New feature (which adds functionality to an existing integration)
• [ ] Deprecation (breaking change to happen in the future)
• [ ] Breaking change (fix/feature causing existing functionality to break)
• [ ] Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request:

Checklist

• [X] The code change is tested and works locally.
• [X] Local tests pass. Your PR cannot be merged unless tests pass
• [X] There is no commented out code in this PR.
• [X] I have followed the development checklist
• [X] I have followed the perfect PR recommendations
• [X] The code has been formatted using Ruff (ruff format homeassistant tests)
• [X] Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• [ ] Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• [ ] The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• [ ] New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• [ ] For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• [ ] Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• [ ] I have reviewed two other open pull requests in this repository.

[home-assistant[bot]]

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (image) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of image can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign image Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[OnFreund]

One functionality that I couldn't preserve - the item gets resolved as an image and does not change; with images that are Camera entities, a change in the image is reflected immediately.

[emontnemery]

Image entities are in some cases used for SVG formatted QR codes, will that work well with the mjpeg approach taken in this PR?

[OnFreund]

Image entities are in some cases used for SVG formatted QR codes, will that work well with the mjpeg approach taken in this PR?

That's a good question. My guess would be no, but I think we can start without supporting vector formats first, just like webrtc cameras aren't media sources.

[OnFreund]

Open items:

1. Add image proxy tests
2. How do we stop async_get_still_stream when the image isn't updated

[OnFreund]

The failed test doesn't seem related

[OnFreund]

A few notes:

1. The failed coverage is due to this line. As far as I can tell, there's no way to test this without directly calling the function, yet it seems like good defensive programming. The Camera media source also has this line, and it's also uncovered there.
2. SVGs do work in the browser, though I haven't tested cast.
3. The code is structured very similarly to the one in Camera, and the same cleanup mechanisms apply as they do there.
4. While close in structure, the code is different enough that I think refactoring to avoid duplication is outside the scope of this PR, especially with the Camera code not covered by tests. I think we can tackle this in a future PR, and I have some ideas how to do it.
5. The only reliable way to make chrome display the latest frame is to send each frame twice. I've tested other hacks, but they didn't work 100% of the time. At high FPS (even as low as 1/5) it's not a big deal - HLS streaming has similar latency if not higher, but for Image the effective FPS can be a really small fraction. Additionally, given the extremely low FPS, sending the frame twice shouldn't be a major concern from a bandwidth perspective.

CC @emontnemery

[home-assistant[bot]]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.