Add go2rtc and extend camera integration for better WebRTC support

[edenhaus]

Breaking change

Proposed change

• Extend the camera integration
  • Allow registering ICE servers, which any WebRTC camera will use
  • Added a new function to return WebRTCClientConfiguration to the frontend (Integration can overwrite it partly)
  • Refactor registering a WebRTC proxy: Previously, only rstp_to_webrtc proxy could be registered. Now, any WebRTC proxy supporting any protocol can be registered
  • Added ws endpoint to fetch WebRTC client config
• Add go2rtc integration. Will automatically use provided binary if HA is running inside docker. Otherwise, a host will be asked
• Add go2rtc binary to docker image

Library: https://github.com/home-assistant-libs/python-go2rtc-client

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• 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: Add go2rtc home-assistant.io#34998

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format homeassistant tests)
• 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.

To help with the load of incoming pull requests:

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

[home-assistant]

Hey there @allenporter, mind taking a look at this pull request as it has been labeled with an integration (rtsp_to_webrtc) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of rtsp_to_webrtc 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 rtsp_to_webrtc 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.

[home-assistant]

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

Code owner commands

Code owners of camera 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 camera 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.

[allenporter]

My impression is that https://www.home-assistant.io/integrations/rtsp_to_webrtc/ already supports go2rtc because go2rtc exports the same API as RTSPToWebRTC for backwards compatibility/forking. However, i don't think the documentation is updated. rtsp_to_webrtc also works with RTSPtoWeb and detects the type of server involved.

Can we either or both (1) Improve usability for of rtsp_to_webrtc by improving documentation or making a virtual integration etc so that the same integration is used but with a different brand/name/icon (2) add any functionality missing to the rtsp to webrtc client library needed for go2rtc? though i'm not actually sure what functionality is missing

[allenporter]

A couple other considerations:
(1) downloading a go binary is not something home assistant core should support like the custom component does We would instead guide users to install an add-on I believe -- and there are ways to improve discovery for that?
(2) The name webrtc is one we avoided for rtsp_to_webrtc in home-assistant/architecture#658 discussion and so i'm not positive that name should be used here either.
(3) I am supportive of adding new websocket endpoints for stun settings. There was some previous discussion here home-assistant/architecture#1040 and I agree with making this available through the existing registration mechanism (I nudged sdb9696 over discord chat towards the approach you have built here).

[edenhaus]

(1) downloading a go binary is not something home assistant core should support like the custom component does We would instead guide users to install an add-on I believe -- and there are ways to improve discovery for that?

The go binary will be installed and shipped with the docker image. The code was only copied from the current custom component and is handy to test everything

I just opened the PR to make testing the code on multiple machines easier. The PR is far from completed
About improvements to rtsp_to_webrtc, I currently create a POC for WebRTC but of course, we can improve both later

[allenporter]

OK my point was that my impression was rtsp_to_webrtc already works with go2rtc, RTSPtoWebRTC, and RTSPtoWeb so i'm questioning if we need both. For example the current client is adaptive supporting two different protocols and decides which one to do so if you want more functionality it could support a 3rd type.

[bemble]

We should be able to registrer a list of ice servers.

[MartinHjelmare]

I didn't look at the tests yet.

[MartinHjelmare]

Tests are missing for go2rtc init module.

[home-assistant]

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

Learn more about our pull request process.

[edenhaus]

Test coverage is now 100%

$ pytest tests/components/go2rtc --cov homeassistant/components/go2rtc --cov-report term-missing
Test session starts (platform: linux, Python 3.12.3, pytest 8.3.3, pytest-sugar 1.0.0)
rootdir: /workspaces/core
configfile: pyproject.toml
plugins: aiohttp-1.0.5, picked-0.5.0, requests-mock-1.12.1, respx-0.21.1, cov-5.0.0, sugar-1.0.0, anyio-4.4.0, syrupy-4.7.1, timeout-2.3.1, socket-0.7.0, github-actions-annotate-failures-0.2.0, xdist-3.6.1, unordered-0.6.1, mock-3.14.0, asyncio-0.24.0, typeguard-4.3.0, pytest_freezer-0.4.8, rerunfailures-14.0
asyncio: mode=Mode.AUTO, default_loop_scope=function
collected 10 items                                                                                                                                                                 

 tests/components/go2rtc/test_config_flow.py ✓✓✓✓✓✓                                                                                                                   60% ██████    
 tests/components/go2rtc/test_init.py ✓✓                                                                                                                              80% ████████  
 tests/components/go2rtc/test_server.py ✓✓                                                                                                                           100% ██████████

---------- coverage: platform linux, python 3.12.3-final-0 -----------
Name                                             Stmts   Miss  Cover   Missing
------------------------------------------------------------------------------
homeassistant/components/go2rtc/__init__.py         34      0   100%
homeassistant/components/go2rtc/config_flow.py      41      0   100%
homeassistant/components/go2rtc/const.py             2      0   100%
homeassistant/components/go2rtc/server.py           34      0   100%
------------------------------------------------------------------------------
TOTAL                                              111      0   100%


Results (1.68s):
      10 passed

[MartinHjelmare]

Looks good!