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 2 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 @@ -93,6 +93,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 @@ -41,6 +41,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.|
|symphonia-all|AAC, FLAC, MP4, MP3, Vorbis, WAV support by Symphonia.|
|symphonia-flac|FLAC audio format support by Symphonia.|
Copy link
Member

Choose a reason for hiding this comment

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

It would be nice to have a short explanation of how this is different than the flac feature (same for mp3 and wav)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do I put the explanation in this cargo_features file as well? Besides, AFAIK they are just different libraries. Both can be used to process audio files. A benefit I could think of using Symphonia is easily change audio formats used by games since it can probe the media source and decode accordingly instead of changing bunch of code when you need to change audio file from wav = hound to mp3 = minimp3.

Copy link
Member

Choose a reason for hiding this comment

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

Bevy completely abstracts over the file loaded, so changing from wav to Flac would just mean changing the feature and the file extension.

I would like to see in this file why someone would enable a feature, and I'm not sure "support by Symphonia" is enough of a difference with the flac feature to help users decide which they need.

Copy link
Member

Choose a reason for hiding this comment

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

Internally, rodio parses audio files using the following libraries:

Format Library
flac claxon
vorbis lewton
wav hound
mp3 minimp3

Symphonia support parsing all of the mentioned file formats and more, however it is much "heavier" due to having support of more file formats. Therefore symphonia is not enabled by default.

Symphonia is usually enabled if:

  1. You have audio files not supported by any of the four audio files mentioned. (I don't think there's even a library for parsing aac files that is widely used and tested)
  2. You support a multitude of audio file formats and would not like to compile five different crates that essentially do the same thing (well, more than five, since symphonia have its own subcrates)

In this scenario, symphonia is just an implementation detail. Perhaps we can indicate that when enabling symphonia, they should disable other features to avoid redundancies. (also when you enable both mp3 and symphonia-mp3 features, the mp3 will actually be disable and symphonia will take priority. see here)

As such, enabling all the aformentioned features plus symphonia-all will simply render the above four features useless, while still compiling the corresponding libraries (i think. haven't delved deep into how rust compile dependencies).

Maybe the best thing to do is to link symphonia to its docs.rs page, and mention this comment (or put it) on symphonia-all's description.

Copy link
Member

Choose a reason for hiding this comment

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

I'd be very happy to add a modified version of this comment to the feature list.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just a few more info to chip in after researching a bit.

On the codec mp3, the rodio is most likely also switching to symphonia due to cross compilations, potentially unsafe code and perhaps ios rejection as discussed here.

And also over here, it seems symphonia has more momentums compared to lewton for vorbis and therefore, could reiterate more often and provide more features/fixes perhaps?

|symphonia-isomp4|MP4 audio format support by Symphonia.|
|symphonia-mp3|MP3 audio format support by Symphonia.|
|symphonia-vorbis|Vorbis audio format support by Symphonia.|
|symphonia-wav|WAV audio format support by Symphonia.|
|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