Skip to content

Update cpal requirement from 0.17 to 0.18 - #24662

Closed
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/cargo/cpal-0.18
Closed

Update cpal requirement from 0.17 to 0.18#24662
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/cargo/cpal-0.18

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Jun 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Updates the requirements on cpal to permit the latest version.

Release notes

Sourced from cpal's releases.

cpal 0.18.1

A quick follow-up to 0.18.0 primarily to fix the docs.rs build failure.

  • docs.rs: Excluded pipewire, whose system dependency isn't available in that sandboxed build environment.
  • WASM: Fixed the audioworklet feature failing to compile on wasm32-wasip1 and other non-browser wasm32 targets.

No API or behavioral changes.

Links

Changelog

Sourced from cpal's changelog.

[0.18.1] - 2026-06-07

Fixed

  • Exclude pipewire from the docs.rs build; system dependency not available in its environment.
  • Fix wasm-bindgen causing compile errors on non-browser wasm32 targets such as wasm32-wasip1.

[0.18.0] - 2026-06-06

Added

  • New ErrorKind variants for the unified error type: BackendError (platform error without a specific mapping); DeviceBusy (retryable device access, e.g. EBUSY/EAGAIN); DeviceChanged (audio route changed to another device); InvalidInput (invalid caller-supplied values); PermissionDenied (OS-level access denial); RealtimeDenied (real-time scheduling refused — previously only printed to stderr); ResourceExhausted (OS thread/memory limits); UnsupportedOperation (backend or device does not implement the operation).
  • Device now implements PartialEq, Eq, Hash, Display, and Debug on all backends.
  • realtime feature for real-time audio thread scheduling without a D-Bus build dependency.
  • StreamTrait::now() to query the current instant on the stream's clock.
  • StreamTrait::buffer_size() to query the stream's current buffer size in frames per callback.
  • SAMPLE_RATE_CD (44100 Hz) and SAMPLE_RATE_48K (48000 Hz) constants.
  • SupportedStreamConfigRange::try_with_standard_sample_rate() and with_standard_sample_rate() to select 48 kHz or 44.1 kHz from a range.
  • SupportedStreamConfigRange::contains_rate() to test whether a sample rate falls within a range.
  • StreamConfig and SupportedStreamConfig now implement Copy.
  • BufferSize now implements Default (returns BufferSize::Default).
  • SupportedBufferSize now implements Default (returns SupportedBufferSize::Unknown).
  • HostTrait::device_by_id() is now backend-dispatched, allowing each host to override the default implementation.
  • DSD512 sample rates added to the common rate probe list.
  • AAudio: Streams now request PERFORMANCE_MODE_LOW_LATENCY with the realtime feature; reports ErrorKind::RealtimeDenied if not granted.
  • ALSA: device_by_id() now accepts PCM shorthand names such as hw:0,0 and plughw:foo.
  • CoreAudio: tvOS target support (Tier 3, requires nightly).
  • PipeWire: New host for Linux and BSD via the native PipeWire API.
  • PulseAudio: New host for Linux and BSD via the PulseAudio API.
  • WASAPI: F64 sample format support.

Changed

  • Changed per-operation error types (DevicesError, SupportedStreamConfigsError, etc.) and HostUnavailable into a unified Error/ErrorKind. See https://github.com/RustAudio/cpal/blob/master/UPGRADING.md.
  • DeviceTrait now requires PartialEq + Eq + Hash + Debug + Display with a stable device ID.
  • DeviceTrait::build_*_stream() now takes StreamConfig by value instead of &StreamConfig.
  • StreamInstant API changed and extended to mirror std::time::Instant/Duration. See https://github.com/RustAudio/cpal/blob/master/UPGRADING.md for migration details.
  • Streams no longer start automatically on build_*_stream(); call play() explicitly. Previously ALSA, CoreAudio, and JACK auto-started streams on creation.
  • Default output and input configs now prefer 48 kHz, then 44.1 kHz, then the device maximum.

... (truncated)

Commits
  • 94ecb6e fix(ci): docs.rs has libjack-jackd2-dev
  • 50d9646 ci: check with all features (#1240)
  • 51f96e9 chore: prepare for v0.18.1 release
  • 189db47 fix: exclude pipewire from docs.rs (#1239)
  • 45fe976 fix(wasm): all features without atomics
  • baa3678 doc: finalize changelog and upgrading guide for v0.18 release (#1238)
  • 27473ac fix(pipewire): use node.latency and re-promote RT when re-negotiated (#1236)
  • 0048977 perf(alsa): optimize enumeration speed (#1233)
  • 7d4aedb chore(jack): pin to >= 0.13.5 (#1231)
  • d2a2688 fix(pulseaudio): use device names as id (#1228)
  • Additional commits viewable in compare view

You can trigger a rebase of this PR by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

@dependabot
Update cpal requirement from 0.17 to 0.18
16eb407 
Updates the requirements on [cpal](https://github.com/RustAudio/cpal) to permit the latest version.
- [Release notes](https://github.com/RustAudio/cpal/releases)
- [Changelog](https://github.com/RustAudio/cpal/blob/master/CHANGELOG.md)
- [Commits](RustAudio/cpal@v0.17.0...v0.18.1)

---
updated-dependencies:
- dependency-name: cpal
  dependency-version: 0.18.1
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot Bot added the C-Dependencies A change to the crates that Bevy depends on label Jun 19, 2026
@alice-i-cecile alice-i-cecile added A-Audio Sounds playback and modification S-Needs-Testing Testing must be done to verify an issue or fix D-Trivial Nice and easy! A great choice to get started with Bevy labels Jun 21, 2026
@github-project-automation github-project-automation Bot moved this to Needs SME Triage in Audio Jun 21, 2026
@alice-i-cecile alice-i-cecile added this to the 0.20 milestone Jun 21, 2026
@mnmaita

mnmaita commented Jun 22, 2026

Copy link
Copy Markdown
Member

As far as I can see cpal is only a dependency for android targets and we only use rodio's cpal re-export in bevy_audio code, so I'm wondering if we really need to state this dependency directly. Maybe someone can clarify if this is done to ensure platform compatibility.

Besides that, I think we should group these dependency updates (rodio + cpal) to avoid potentially depending on different versions. Let me know what do you think.

@JamJomJim

JamJomJim commented Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

@mnmaita this direct dependency was to enable an oboe feature that is no longer used.
#25220

I recommend we close this dependabot PR

Related: I'm currently patching rodio on a personal project to use a more recent commit, since rodio has no release yet with CPAL 0.18. Rodio should have a new release in the next month or so that exposes the crucial realtime feature -- without it android has an extra ~250ms of audio latency. I'll maybe put up a draft PR in anticipation of this release

@mnmaita mnmaita closed this Aug 3, 2026
@dependabot @github

dependabot Bot commented on behalf of github Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@github-project-automation github-project-automation Bot moved this from Needs SME Triage to Done in Audio Aug 3, 2026
@dependabot
dependabot Bot deleted the dependabot/cargo/cpal-0.18 branch August 3, 2026 05:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

A-Audio Sounds playback and modification C-Dependencies A change to the crates that Bevy depends on D-Trivial Nice and easy! A great choice to get started with Bevy S-Needs-Testing Testing must be done to verify an issue or fix

Projects

Audio
Status: Done

Milestone

0.20

Development

Successfully merging this pull request may close these issues.

3 participants

@mnmaita @JamJomJim @alice-i-cecile