Merge pull request #697 from roderickvd/refactor/decoder-improvements

Decoder builder with additional settings

Author: dvdsk

CHANGELOG.md

@@ -19,6 +19,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Minimal builds without `cpal` audio output are now supported.
   See `README.md` for instructions. (#349)
 - Added `Sample::is_zero()` method for checking zero samples.
+- Added `DecoderBuilder` for improved configuration.
+- Using `Decoder::TryFrom` for `File` now automatically wraps in `BufReader` and sets `byte_len`.
+  `TryFrom<Cursor<T>>` and `TryFrom<BufReader>` are also supported.
 
 ### Changed
 - Breaking: `OutputStreamBuilder` should now be used to initialize an audio output stream.
@@ -29,9 +32,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Breaking: In the `Source` trait, the method `current_frame_len()` was renamed to `current_span_len()`.
 - Breaking: `Decoder` now outputs `f32` samples.
 - Breaking: The term 'frame' was renamed to 'span' in the crate and documentation.
-- Breaking: Sources now use `f32` samples. To convert to and from other types of samples use functions from
-  `dasp_sample` crate. For example `DaspSample::from_sample(sample)`. Remove `integer-decoder` feature.
-
+- Breaking: `LoopedDecoder` now returns `None` if seeking fails during loop reset.
+- Breaking: `ReadSeekSource::new()` now takes `Settings`.
+- Breaking: Sources now use `f32` samples. To convert to and from other types of samples use
+            functions from `dasp_sample` crate. For example `DaspSample::from_sample(sample)`.
 
 ### Fixed
 - `ChannelVolume` no longer clips/overflows when converting from many channels to
@@ -40,12 +44,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - An issue with `SignalGenerator` that caused it to create increasingly distorted waveforms
   over long run times has been corrected. (#201)
 - WAV and FLAC decoder duration calculation now calculated once and handles very large files
-  correctly
-- Removed unwrap() calls in MP3, WAV, FLAC and Vorbis format detection for better error handling
+  correctly.
+- Removed unwrap() calls in MP3, WAV, FLAC and Vorbis format detection for better error handling.
+- `LoopedDecoder::size_hint` now correctly indicates an infinite stream.
+- Symphonia decoder `total_duration` for Vorbis now return the correct value (#696).
+- Symphonia decoder for MP4 now seeks correctly (#577).
 
 ### Deprecated
 - Deprecated `Sample::zero_value()` function in favor of `Sample::ZERO_VALUE` constant
 
+### Removed
+- Breaking: Removed `Mp4Type` enum in favor of using MIME type string "audio/mp4" for MP4 format detection with `Decoder::new_mp4` (#612).
+
 # Version 0.20.1 (2024-11-08)
 
 ### Fixed

Cargo.lock

@@ -48,12 +48,14 @@ symphonia-all = [
     "symphonia-flac",
     "symphonia-isomp4",
     "symphonia-mp3",
+    "symphonia-ogg",
     "symphonia-vorbis",
     "symphonia-wav",
 ]
 symphonia-flac = ["symphonia/flac"]
 symphonia-isomp4 = ["symphonia/isomp4"]
 symphonia-mp3 = ["symphonia/mp3"]
+symphonia-ogg = ["symphonia/ogg"]
 symphonia-vorbis = ["symphonia/vorbis"]
 symphonia-wav = ["symphonia/wav", "symphonia/pcm", "symphonia/adpcm"]
 symphonia-alac = ["symphonia/isomp4", "symphonia/alac"]

Cargo.toml

@@ -2,7 +2,6 @@ use rodio::source::Source;
 use rodio::Decoder;
 use std::error::Error;
 use std::fs::File;
-use std::io::BufReader;
 use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::Arc;
 use std::thread;
@@ -13,8 +12,8 @@ fn main() -> Result<(), Box<dyn Error>> {
     let sink = rodio::Sink::connect_new(&stream_handle.mixer());
 
     // Decode the sound file into a source
-    let file = BufReader::new(File::open("assets/music.flac")?);
-    let source = Decoder::new(file)?;
+    let file = File::open("assets/music.flac")?;
+    let source = Decoder::try_from(file)?;
 
     // Apply automatic gain control to the source
     let agc_source = source.automatic_gain_control(1.0, 4.0, 0.005, 5.0);

examples/automatic_gain_control.rs

@@ -1,5 +1,4 @@
 use std::error::Error;
-use std::io::BufReader;
 use std::sync::atomic::{AtomicU32, Ordering};
 use std::sync::Arc;
 
@@ -8,7 +7,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     let sink = rodio::Sink::connect_new(&stream_handle.mixer());
 
     let file = std::fs::File::open("assets/music.wav")?;
-    sink.append(rodio::Decoder::new(BufReader::new(file))?);
+    sink.append(rodio::Decoder::try_from(file)?);
 
     // lets increment a number after `music.wav` has played. We are going to use atomics
     // however you could also use a `Mutex` or send a message through a `std::sync::mpsc`.

examples/callback_on_end.rs

@@ -1,13 +1,12 @@
 use rodio::{output_to_wav, Source};
 use std::error::Error;
-use std::io::BufReader;
 
 /// Converts mp3 file to a wav file.
 /// This example does not use any audio devices
 /// and can be used in build configurations without `cpal` feature enabled.
 fn main() -> Result<(), Box<dyn Error>> {
     let file = std::fs::File::open("assets/music.mp3")?;
-    let mut audio = rodio::Decoder::new(BufReader::new(file))?
+    let mut audio = rodio::Decoder::try_from(file)?
         .automatic_gain_control(1.0, 4.0, 0.005, 3.0)
         .speed(0.8);
 

examples/into_file.rs

@@ -1,12 +1,11 @@
 use std::error::Error;
-use std::io::BufReader;
 
 fn main() -> Result<(), Box<dyn Error>> {
     let stream_handle = rodio::OutputStreamBuilder::open_default_stream()?;
     let sink = rodio::Sink::connect_new(&stream_handle.mixer());
 
     let file = std::fs::File::open("assets/music.flac")?;
-    sink.append(rodio::Decoder::new(BufReader::new(file))?);
+    sink.append(rodio::Decoder::try_from(file)?);
 
     sink.sleep_until_end();
 

examples/music_flac.rs

@@ -1,12 +1,11 @@
 use std::error::Error;
-use std::io::BufReader;
 
 fn main() -> Result<(), Box<dyn Error>> {
     let stream_handle = rodio::OutputStreamBuilder::open_default_stream()?;
     let sink = rodio::Sink::connect_new(&stream_handle.mixer());
 
     let file = std::fs::File::open("assets/music.m4a")?;
-    sink.append(rodio::Decoder::new(BufReader::new(file))?);
+    sink.append(rodio::Decoder::try_from(file)?);
 
     sink.sleep_until_end();
 

examples/music_m4a.rs

@@ -1,12 +1,11 @@
 use std::error::Error;
-use std::io::BufReader;
 
 fn main() -> Result<(), Box<dyn Error>> {
     let stream_handle = rodio::OutputStreamBuilder::open_default_stream()?;
     let sink = rodio::Sink::connect_new(&stream_handle.mixer());
 
     let file = std::fs::File::open("assets/music.mp3")?;
-    sink.append(rodio::Decoder::new(BufReader::new(file))?);
+    sink.append(rodio::Decoder::try_from(file)?);
 
     sink.sleep_until_end();
 

examples/music_mp3.rs

@@ -1,12 +1,11 @@
 use std::error::Error;
-use std::io::BufReader;
 
 fn main() -> Result<(), Box<dyn Error>> {
     let stream_handle = rodio::OutputStreamBuilder::open_default_stream()?;
     let sink = rodio::Sink::connect_new(&stream_handle.mixer());
 
     let file = std::fs::File::open("assets/music.ogg")?;
-    sink.append(rodio::Decoder::new(BufReader::new(file))?);
+    sink.append(rodio::Decoder::try_from(file)?);
 
     sink.sleep_until_end();