Update Rodio to 0.21 #20323

mnmaita · 2025-07-29T10:14:28Z

Objective

Closes Update cpal requirement from 0.15 to 0.16 #19672

Solution

Updated both cpal and rodio to their latest versions.
Updated code to address rodio's breaking changes.
Reworked audio related feature flags so symphonia becomes the default audio backend except for .ogg files, where we will still default to lewton.
Replaced aarch64-apple-ios-sim target with arm64-apple-ios-simulator.

Testing

Tested audio related examples.

mnmaita · 2025-07-29T10:16:56Z

Outstanding items:

Fix tools/example-showcase/disable-audio.patch
Figure out why the soundtrack and spatial examples are not working.
Do we want to make symphonia the default?
Is it ok to have lewton as the default ogg backend due to issues with the symphonia implementation when using looped/buffered sources?
Is the target change for iOS simulator sensible here or should we postpone that?
Review feature flag names.
Add a migration guide.
Remove minimp3.
Bump cpal once it releases a new version with the Send + Sync fix and remove the patch in Cargo.toml.

github-actions · 2025-07-29T20:39:42Z

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Please review the instructions for writing migration guides, then expand or revise the content in the migration guides directory to reflect your changes.

nyfair · 2025-10-16T17:49:02Z

Symphonia released 0.5.5 last week, and bevy_audio picks it up by default after cargo update. However, the combination of rodio 0.20 and symphonia 0.5.5 causes a panic when decoding MPEG-4 streams.

This bug can be verified by running this rodio example directly
https://github.com/RustAudio/rodio/blob/v0.20.1/examples/music_m4a.rs

I suggest either merging this PR or pinning the symphonia dependency to version 0.5.4 in Cargo.toml.

mnmaita · 2025-10-22T09:57:51Z

@nyfair this PR is quite broken so I wouldn't merge it yet. We could do the version pinning as a stopgap and leave a comment on said change to fix it later. I might have some time to update this PR in a couple of days so I'll try my best to finalize it soon. @alice-i-cecile in the meantime, would you be able to help me figuring out the 3rd, 4th and 5th items that I left in my comment?

mnmaita · 2025-10-22T13:55:45Z

crates/bevy_audio/src/audio_source.rs

+    /// which iterates over samples of type [`rodio::Sample`].
    /// Must be a [`rodio::Source`] so that it can provide information on the audio it is iterating over.
-    type Decoder: rodio::Source + Send + Iterator<Item = Self::DecoderItem>;
+    type Decoder: rodio::Source + Send + Iterator<Item = rodio::Sample>;


rodio::Source has Iterator<Item = rodio::Sample> as a bound as far as I can see, should we drop this redundant bound or should we keep it?

mnmaita · 2025-10-22T14:36:56Z

There's an unreleased change in cpal that makes Source Send. This will fix the build issues in MacOS as far as I can tell. I'll try bothering some people here and there to push this forward... 😅

EDIT:
Confirmed that the latest changes in cpal fix the MacOS builds, but... this change broke the windows build as there seems to be a type that doesn't implement Sync and makes it not possible to derive Resource for AudioOutput (it seems to be struct HANDLE(pub *mut core::ffi::c_void) from the windows crate).

If someone has any suggestions on how to proceed from here please let me know. Related issue: RustAudio/cpal#1038

alice-i-cecile

We shouldn't be exposing minimp3 at all, per #20183

mnmaita · 2025-10-29T19:19:38Z

We shouldn't be exposing minimp3 at all, per #20183

Rebased, removed the unwanted feature and fixed some wrongly set internal feature flags for the fallbacks. I've also cleaned up my own messages as there was too much noise in the PR. Later I will try pushing a temporary commit to see if I can fix the outstanding issues and we can finally test this, analyze what options we have and make a decision for this upgrade.

github-actions · 2025-10-29T19:35:47Z

You added a new feature but didn't update the readme. Please run cargo run -p build-templated-pages -- update features to update it, and commit the file change.

alice-i-cecile · 2025-12-10T19:54:01Z

Can you please resolve merge conflicts and get CI passing?

mnmaita · 2025-12-10T22:43:05Z

Can you please resolve merge conflicts and get CI passing?

Hey @alice-i-cecile, I can fix the conflicts but I don't think I can fix the CI, we'd need a new version of cpal to be cut. From what I can see in the check-sources job, it's not desirable to patch cpal version with an arbitrary revision from their main branch (which contains the fix for Send+Sync issues in some of their types). How should we proceed here? I held off on writing the migration guide for this reason, but I could work on finishing that too if desirable.

alice-i-cecile · 2025-12-11T01:14:43Z

Can you track down the cpal authors and pester them (politely and patiently!) for a release? You're correct that we can't ship this with a git dependency.

mnmaita · 2025-12-11T10:03:28Z

Can you track down the cpal authors and pester them (politely and patiently!) for a release? You're correct that we can't ship this with a git dependency.

Relevant: RustAudio/cpal#1065 😄

Please also check this question I had:

Is it ok to have lewton as the default ogg backend due to RustAudio/rodio#775 (comment) with the symphonia implementation when using looped/buffered sources?

It seems like a PR that fixed that "got too big" and was just closed, and I didn't see any other PRs pushed to fix that. So as a follow up question:

Do we want to make symphonia the default (for the rest of the audio formats)?

As far as I understand, symphonia is an opt-in feature right now.

Thanks @alice-i-cecile!

--- updated-dependencies: - dependency-name: cpal dependency-version: 0.16.0 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]>

This version depends on cpal 0.16

mnmaita · 2025-12-11T12:56:02Z

Rebased and added a migration guide. I just realized that this will probably become a bump to rodio 0.22 as cpal's next version will be breaking.

alice-i-cecile added A-Audio Sounds playback and modification C-Dependencies A change to the crates that Bevy depends on S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jul 29, 2025

github-project-automation bot added this to Audio Jul 29, 2025

alice-i-cecile added the M-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Jul 29, 2025

mnmaita mentioned this pull request Aug 11, 2025

Update rodio requirement from 0.20 to 0.21 #20511

Closed

mnmaita force-pushed the mnmaita/dependabot/cargo/cpal-0.16 branch from 7111175 to 51b8311 Compare October 22, 2025 12:57

mnmaita marked this pull request as ready for review October 22, 2025 13:47

mnmaita commented Oct 22, 2025

View reviewed changes

mnmaita mentioned this pull request Oct 27, 2025

wasapi: Stream no longer Sync RustAudio/cpal#1038

Closed

mnmaita force-pushed the mnmaita/dependabot/cargo/cpal-0.16 branch from b85a940 to 6248b2e Compare October 27, 2025 23:41

alice-i-cecile requested changes Oct 29, 2025

View reviewed changes

github-project-automation bot moved this to Needs Update in Audio Oct 29, 2025

mnmaita force-pushed the mnmaita/dependabot/cargo/cpal-0.16 branch from 6248b2e to 9ef8982 Compare October 29, 2025 19:14

alice-i-cecile added this to the 0.18 milestone Nov 23, 2025

alice-i-cecile removed this from the 0.18 milestone Dec 10, 2025

dependabot bot and others added 25 commits December 11, 2025 12:56

Update cpal requirement from 0.15 to 0.16

103b31b

--- updated-dependencies: - dependency-name: cpal dependency-version: 0.16.0 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps rodio to 0.21

098d436

This version depends on cpal 0.16

Removes coreaudio-sys patch requirement

4ee875b

Updates Android docs

9a43d20

Updates doc comment pointing to older version

201bcb2

Bumps referenced bevy version in examples doc template

84dce68

Replaces aarch64-apple-ios-sim target with arm64-apple-ios-simulator

ea265e2

Reworks audio feature flags

0bdb9f9

Migrates code for rodio 0.21 compatibility

07be887

Reworks features to make symphonia the default

38f49f8

Fixes internal feature flags

1749fa4

Fixes feature gated extensions

20cabfc

Updates AudioLoader docs

5d44c1c

Temporarily makes lewton the default ogg backend

94cec69

Fixes disable-audio.patch

99ba88c

Fixes licence exceptions for symphonia

62fc2bc

Removes minimp3 usage and fixes fallback features

ae86ae5

Updates cargo_features.md

e765702

Removes obsolete android_shared_stdcxx feature

22c06db

TEMPORARY: cpal patch to fix Send + Sync issue

b71dc5e

Reexports rodio's ChannelCount and SampleRate aliases

eb9280b

TEMPORARY: rodio patch for latest cpal compatibility

79e9dcc

Fixes decodable example

f3b18f7

Enables lewton when using audio-all feature

14c4894

Adds migration guide

210a0bb

mnmaita force-pushed the mnmaita/dependabot/cargo/cpal-0.16 branch from e230b93 to 210a0bb Compare December 11, 2025 12:53

Fix markdown lints

fa00c43

mnmaita force-pushed the mnmaita/dependabot/cargo/cpal-0.16 branch from 9c9e8fb to fa00c43 Compare December 11, 2025 14:34

Uh oh!

Update Rodio to 0.21 #20323

Are you sure you want to change the base?

Update Rodio to 0.21 #20323

Conversation

mnmaita commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Objective

Solution

Testing

Uh oh!

mnmaita commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 29, 2025

Uh oh!

nyfair commented Oct 16, 2025

Uh oh!

mnmaita commented Oct 22, 2025

Uh oh!

mnmaita Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

mnmaita commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

mnmaita commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 29, 2025

Uh oh!

alice-i-cecile commented Dec 10, 2025

Uh oh!

mnmaita commented Dec 10, 2025

Uh oh!

alice-i-cecile commented Dec 11, 2025

Uh oh!

mnmaita commented Dec 11, 2025

Uh oh!

mnmaita commented Dec 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mnmaita commented Jul 29, 2025 •

edited

Loading

mnmaita commented Jul 29, 2025 •

edited

Loading

mnmaita commented Oct 22, 2025 •

edited

Loading

mnmaita commented Oct 29, 2025 •

edited

Loading