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.

Sign up for GitHub

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 by Bors] - Expose symphonia features from rodio in bevy_audio and bevy #6388

Closed
wants to merge 5 commits into from
Closed

[Merged by Bors] - Expose symphonia features from rodio in bevy_audio and bevy #6388

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
af4401e
Add symphonia features in bevy_audio and bevy
ong-yy Oct 27, 2022
865258b
Add symphony features into optional feature docs
ong-yy Oct 29, 2022
0d5f0f8
Merge branch 'main' into expose-symphonia-from-rodio
ong-yy Jan 6, 2023
e50eb17
Add more details on cargo_features
ong-yy Jan 6, 2023
5908dfa
Add correction on features descriptions
ong-yy Jan 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,13 @@ flac = ["bevy_internal/flac"]
mp3 = ["bevy_internal/mp3"]
vorbis = ["bevy_internal/vorbis"]
wav = ["bevy_internal/wav"]
symphonia-aac = ["bevy_internal/symphonia-aac"]
symphonia-all = ["bevy_internal/symphonia-all"]
symphonia-flac = ["bevy_internal/symphonia-flac"]
symphonia-isomp4 = ["bevy_internal/symphonia-isomp4"]
symphonia-mp3 = ["bevy_internal/symphonia-mp3"]
Copy link
Member

Choose a reason for hiding this comment

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

Why expose this when there's another mp3 feature already? Same with wav and vorbis.

Copy link
Member

Choose a reason for hiding this comment

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

Symphonia is an alternative backend to what rodio uses, which depends on the features used (flac = claxon, vorbis = lewton, wav = hound, mp3 = minimp3).

imo these features should be available because:

  1. For completeness sake.
  2. When you want to support formats, where is only supported by symphonia (for example aac and wav) you'll have to compile both hound and symphonia. I think it's better as a user to just enable symphonia's wav feature instead of using hound to reduce compile times.

symphonia-vorbis = ["bevy_internal/symphonia-vorbis"]
symphonia-wav = ["bevy_internal/symphonia-wav"]

# Enable watching file system for asset hot reload
filesystem_watcher = ["bevy_internal/filesystem_watcher"]
Expand Down
7 changes: 7 additions & 0 deletions crates/bevy_audio/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,10 @@ mp3 = ["rodio/mp3"]
flac = ["rodio/flac"]
wav = ["rodio/wav"]
vorbis = ["rodio/vorbis"]
symphonia-aac = ["rodio/symphonia-aac"]
symphonia-all = ["rodio/symphonia-all"]
symphonia-flac = ["rodio/symphonia-flac"]
symphonia-isomp4 = ["rodio/symphonia-isomp4"]
symphonia-mp3 = ["rodio/symphonia-mp3"]
symphonia-vorbis = ["rodio/symphonia-vorbis"]
symphonia-wav = ["rodio/symphonia-wav"]
7 changes: 7 additions & 0 deletions crates/bevy_internal/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ flac = ["bevy_audio/flac"]
mp3 = ["bevy_audio/mp3"]
vorbis = ["bevy_audio/vorbis"]
wav = ["bevy_audio/wav"]
symphonia-aac = ["bevy_audio/symphonia-aac"]
symphonia-all = ["bevy_audio/symphonia-all"]
symphonia-flac = ["bevy_audio/symphonia-flac"]
symphonia-isomp4 = ["bevy_audio/symphonia-isomp4"]
symphonia-mp3 = ["bevy_audio/symphonia-mp3"]
symphonia-vorbis = ["bevy_audio/symphonia-vorbis"]
symphonia-wav = ["bevy_audio/symphonia-wav"]

# Enable watching file system for asset hot reload
filesystem_watcher = ["bevy_asset/filesystem_watcher"]
Expand Down
7 changes: 7 additions & 0 deletions docs/cargo_features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@
|flac|FLAC audio format support. It's included in bevy_audio feature.|
|mp3|MP3 audio format support.|
|wav|WAV audio format support.|
|symphonia-aac|AAC audio format support by Symphonia. More details see symphonia-all.|
ong-yy marked this conversation as resolved.
Show resolved Hide resolved
|symphonia-all|AAC, FLAC, MP4, MP3, Vorbis, WAV support by Symphonia. Supports parsing of multiple file formats in a crate instead of compiling different crates. Disable other audio features if enable this feature to avoid redundancies. [Docs](https://docs.rs/symphonia/latest/symphonia/) and [more info](https://github.com/bevyengine/bevy/pull/6388#discussion_r1009622883) |
ong-yy marked this conversation as resolved.
Show resolved Hide resolved
|symphonia-flac|FLAC audio format support by Symphonia. More details see symphonia-all.|
|symphonia-isomp4|MP4 audio format support by Symphonia. More details see symphonia-all.|
|symphonia-mp3|MP3 audio format support by Symphonia. More details see symphonia-all.|
|symphonia-vorbis|Vorbis audio format support by Symphonia. More details see symphonia-all.|
|symphonia-wav|WAV audio format support by Symphonia. More details see symphonia-all.|
|serialize|Enables serialization of `bevy_input` types.|
|wayland|Enable this to use Wayland display server protocol other than X11.|
|subpixel_glyph_atlas|Enable this to cache glyphs using subpixel accuracy. This increases texture memory usage as each position requires a separate sprite in the glyph atlas, but provide more accurate character spacing.|
Expand Down