Skip to content

Support streaming TTS in wyoming #147392

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

Merged
merged 4 commits into from
Jun 24, 2025
Merged

Conversation

synesthesiam
Copy link
Contributor

Breaking change

Proposed change

Adds streaming support to wyoming text-to-speech entities. If supported, text is streamed to the TTS endpoint and audio is streamed back into Home Assistant.

Text chunks are not guaranteed to be on a sentence or even a word boundary, so it is up to the TTS endpoint to store and combine/split them appropriately for the underlying models.

Requires #147385

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:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

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:

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:

@home-assistant
Copy link

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

Code owner commands

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

elif AudioStart.is_type(event.type):
yield AudioStart.from_event(event)

read_task = self.config_entry.async_create_background_task(
Copy link
Member

Choose a reason for hiding this comment

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

Given that this event happens a lot, is it possible to write this directly to the asyncio queue instead of a background task per event?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Refactored to avoid repeated task creation

@synesthesiam synesthesiam force-pushed the synesthesiam-20250620-wyoming-tts-streaming branch from d4e8972 to bbb3929 Compare June 24, 2025 15:21
@synesthesiam synesthesiam marked this pull request as ready for review June 24, 2025 15:21
@synesthesiam synesthesiam added this to the 2025.7.0b0 milestone Jun 24, 2025
async def data_gen():
async with AsyncTcpClient(self.service.host, self.service.port) as client:
# Stream text chunks to client
self.config_entry.async_create_background_task(
Copy link
Member

Choose a reason for hiding this comment

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

I would move this outside of data_gen. You want it to start asap and not just when someone starts consuming the audio (which might not happen if it never received the text!)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, manually managing the client 👍

@balloob balloob merged commit cefc882 into dev Jun 24, 2025
30 checks passed
@balloob balloob deleted the synesthesiam-20250620-wyoming-tts-streaming branch June 24, 2025 17:04
@github-actions github-actions bot locked and limited conversation to collaborators Jun 25, 2025
@frenck frenck removed this from the 2025.7.0b0 milestone Jun 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants