Skip to content
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

Fix unexpected stop of media playback via ffmpeg proxy for ESPhome devices #130788

Conversation

mib1185
Copy link
Contributor

@mib1185 mib1185 commented Nov 17, 2024

Proposed change

The ffmpeg tool writes per default its progress stats to stderr. These stats reaches after ~ 30min already 2750 entries with each 70 bytes.
The stderr is connected to a subprocess pipe, but never read, so the buffer to be overflowed, so that the task get canceled. Further the stderr is only read in case of an error, so no need to write the progress stats into it.

source: https://ffmpeg.org/ffmpeg.html#Main-options

-stats (global)
Log encoding progress/statistics as "info"-level log (see -loglevel). It is on by default, to explicitly disable it you need to > specify -nostats.

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:

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 @OttoWinter, @jesserockz, @kbx81, @bdraco, mind taking a look at this pull request as it has been labeled with an integration (esphome) you are listed as a code owner for? Thanks!

Code owner commands

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

@mib1185 mib1185 added this to the 2024.11.3 milestone Nov 17, 2024
@bdraco
Copy link
Member

bdraco commented Nov 17, 2024

Should we connect stderr to dev null or log it somewhere ?

@mib1185
Copy link
Contributor Author

mib1185 commented Nov 17, 2024

I've thought about devnull, but it is read in case of any other errors:

stderr_text = ""
while line := await proc.stderr.readline():
stderr_text += line.decode()
_LOGGER.error("FFmpeg output: %s", stderr_text)

I don't think, we need to log it - at most as a debug log maybe 🤔

@bdraco
Copy link
Member

bdraco commented Nov 17, 2024

I think this is fine for a patch release.

We might want to change it to https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.communicate in the future so it does log stderr if something does go wrong later in the process.

@mib1185 mib1185 merged commit d8dd6d6 into home-assistant:dev Nov 17, 2024
34 checks passed
@mib1185 mib1185 deleted the esphome/disable-progress-stats-in-ffmpeg-command branch November 17, 2024 00:58
bvanelli pushed a commit to bvanelli/homeassistant-core that referenced this pull request Nov 17, 2024
…vices (home-assistant#130788)

disable writing progress stats to stderr in ffmpeg command
@marcelveldt
Copy link
Member

stderr pipe might still fill up if there are errors being logged by ffmpeg, which can happen very quickly in case of encoding issues. I think a better future-proof approach will be to keep reading stderr in a separate task to avoid the deadlock situation.

@mib1185
Copy link
Contributor Author

mib1185 commented Nov 17, 2024

done in #130808

dotvav pushed a commit to dotvav/home-assistant-core that referenced this pull request Nov 17, 2024
…vices (home-assistant#130788)

disable writing progress stats to stderr in ffmpeg command
@github-actions github-actions bot locked and limited conversation to collaborators Nov 18, 2024
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.

7 participants