use ogg by default instead of mp3 (#3421)

mockersf · mockersf · commit aeba9faf0451 · 2021-12-23T19:19:15.000Z
# Objective

- mp3 feature of rodio has dependencies that are not maintained with security issues
- mp3 feature of rodio doesn't build in wasm
- mp3 feature of rodio uses internal memory allocation that cause rejection from Apple appstore

## Solution

- Use vorbis instead of mp3 by default


Co-authored-by: François &lt;8672791+mockersf@users.noreply.github.com&gt;
diff --git a/Cargo.toml b/Cargo.toml
@@ -23,7 +23,7 @@ default = [
   "render",
   "png",
   "hdr",
-  "mp3",
+  "vorbis",
   "x11",
   "filesystem_watcher",
 ]
diff --git a/assets/sounds/Windless Slopes.mp3 b/assets/sounds/Windless Slopes.mp3
diff --git a/assets/sounds/Windless Slopes.ogg b/assets/sounds/Windless Slopes.ogg
diff --git a/deny.toml b/deny.toml
@@ -7,8 +7,6 @@ yanked = "deny"
 notice = "deny"
 ignore = [
     "RUSTSEC-2020-0056", # from gilrs v0.8.1 - unmaintained - https://github.com/koute/stdweb/issues/403
-    "RUSTSEC-2020-0158", # from rodio v0.14.0 - unmaintained - https://github.com/gnzlbg/slice_deque/issues/94
-    "RUSTSEC-2021-0047", # from rodio v0.14.0 - unsafety - https://github.com/gnzlbg/slice_deque/issues/90
     "RUSTSEC-2020-0095", # from crevice dev dependency - unmaintained - https://github.com/johannhof/difference.rs/issues/45
     "RUSTSEC-2021-0119", # from rodio 0.14.0 - unsafety - https://github.com/nix-rust/nix/issues/1541
 ]
diff --git a/docs/cargo_features.md b/docs/cargo_features.md
@@ -11,7 +11,7 @@
 |render|The render pipeline and all render related plugins.|
 |png|PNG picture format support.|
 |hdr|[HDR](https://en.wikipedia.org/wiki/High_dynamic_range) support.|
-|mp3|MP3 audio format support.|
+|vorbis|Ogg Vorbis audio format support.|
 |x11|Make GUI applications use X11 protocol. You could enable wayland feature to override this.|
 |filesystem_watcher|Enable watching the file system for asset hot reload|
 
@@ -30,8 +30,8 @@
 |jpeg|JPEG picture format support.|
 |bmp|BMP picture format support.|
 |flac|FLAC audio format support. It's included in bevy_audio feature.|
+|mp3|MP3 audio format support.|
 |wav|WAV audio format support.|
-|vorbis|Vorbis audio format support.|
 |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.|
diff --git a/examples/audio/audio.rs b/examples/audio/audio.rs
@@ -9,6 +9,6 @@ fn main() {
 }
 
 fn setup(asset_server: Res<AssetServer>, audio: Res<Audio>) {
-    let music = asset_server.load("sounds/Windless Slopes.mp3");
+    let music = asset_server.load("sounds/Windless Slopes.ogg");
     audio.play(music);
 }
diff --git a/examples/ios/Cargo.toml b/examples/ios/Cargo.toml
@@ -15,7 +15,7 @@ bevy = { path = "../../", features = [
   "bevy_audio",
   "bevy_winit",
   "render",
-  "mp3",
+  "vorbis",
   "x11",
   "filesystem_watcher"
 ], default-features = false}
diff --git a/examples/ios/src/lib.rs b/examples/ios/src/lib.rs
@@ -91,6 +91,6 @@ fn setup_scene(
 }
 
 fn setup_music(asset_server: Res<AssetServer>, audio: Res<Audio>) {
-    let music = asset_server.load("sounds/Windless Slopes.mp3");
+    let music = asset_server.load("sounds/Windless Slopes.ogg");
     audio.play(music);
 }

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ default = [`
`23`	`23`	`"render",`
`24`	`24`	`"png",`
`25`	`25`	`"hdr",`
`26`		`- "mp3",`
	`26`	`+ "vorbis",`
`27`	`27`	`"x11",`
`28`	`28`	`"filesystem_watcher",`
`29`	`29`	`]`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,6 @@ yanked = "deny"`
`7`	`7`	`notice = "deny"`
`8`	`8`	`ignore = [`
`9`	`9`	`"RUSTSEC-2020-0056", # from gilrs v0.8.1 - unmaintained - https://github.com/koute/stdweb/issues/403`
`10`		`- "RUSTSEC-2020-0158", # from rodio v0.14.0 - unmaintained - https://github.com/gnzlbg/slice_deque/issues/94`
`11`		`- "RUSTSEC-2021-0047", # from rodio v0.14.0 - unsafety - https://github.com/gnzlbg/slice_deque/issues/90`
`12`	`10`	`"RUSTSEC-2020-0095", # from crevice dev dependency - unmaintained - https://github.com/johannhof/difference.rs/issues/45`
`13`	`11`	`"RUSTSEC-2021-0119", # from rodio 0.14.0 - unsafety - https://github.com/nix-rust/nix/issues/1541`
`14`	`12`	`]`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@ fn main() {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`fn setup(asset_server: Res<AssetServer>, audio: Res<Audio>) {`
`12`		`- let music = asset_server.load("sounds/Windless Slopes.mp3");`
	`12`	`+ let music = asset_server.load("sounds/Windless Slopes.ogg");`
`13`	`13`	`audio.play(music);`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,6 @@ fn setup_scene(`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`fn setup_music(asset_server: Res<AssetServer>, audio: Res<Audio>) {`
`94`		`- let music = asset_server.load("sounds/Windless Slopes.mp3");`
	`94`	`+ let music = asset_server.load("sounds/Windless Slopes.ogg");`
`95`	`95`	`audio.play(music);`
`96`	`96`	`}`