Release 0.21.0 #721
+118
−35
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,63 @@ | ||
| This guide will help you update your code when upgrading from older versions of rodio. | ||
|
|
||
| # rodio 0.21 to current GitHub version | ||
|
|
||
| nothing | ||
|
|
||
| # rodio 0.20 or earlier to 0.21 | ||
|
|
||
| ## Features | ||
| - If you disable the rodio default features with `default_features = false` in `Cargo.toml` you need to add a new feature `playback`. | ||
|
|
||
| ## Source implementations | ||
| - Source had a required method `current_frame_len`. In the latest version of rodio *frame* has been renamed to *span*. You will need to change every occurrence of `current_frame_len` to `current_span_len`. | ||
| - Source was generic over sample type. It no longer is. | ||
| - Remove any generics (`::<f32>`, `::<u16>` or `::<i16>`) that cause errors. | ||
| - Remove `SampleConvertor` it is no longer needed and has been removed. | ||
| - Remove any calls to `source.convert_samples()` they are no longer needed and | ||
| removed | ||
|
|
||
| ## OutputStream | ||
| The output stream is now more configurable. Where you used `OutputStream::try_default()` you have a choice: | ||
| - *(recommended)* Get an error when the default stream could not be opened: `OutputStreamBuilder::open_default_stream()?` | ||
| - Stay close to the old behavior using: `OutputStreamBuilder::open_stream_or_fallback()`, which tries to open the default (audio) stream. If that fails it tries all other combinations of device and settings. The old behavior was only trying all settings of the default device. | ||
|
|
||
| ## Sink & SpatialSink | ||
| - Replace `Sink::try_new` with `sink::connect_new`. It now takes an `&Mixer` | ||
| instead of a `OutputStreamHandle`. You get an `&Mixer` by calling `mixer()` on | ||
| `OutputStream`. | ||
| - Replace `Sink::new_idle` with `Sink::new`, | ||
|
|
||
| ### Example | ||
| The following Rodio *0.20.1* code: | ||
| ```rust | ||
| let (_stream, handle) = rodio::OutputStream::try_default()?; | ||
| let sink = rodio::Sink::try_new(&handle)?; | ||
| ``` | ||
| Should be written like this in Rodio *0.21.0*: | ||
| ```rust | ||
| let stream_handle = rodio::OutputStreamBuilder::open_default_stream()?; | ||
| let sink = rodio::Sink::connect_new(stream_handle.mixer()); | ||
| ``` | ||
|
|
||
| The `SpatialSink` changes mirror those in `Sink` described above. | ||
|
|
||
| ## Dynamic mixer | ||
| Replace `DynamicMixerController` with `Mixer` and `DynamicMixer` with `MixerSource`. | ||
|
|
||
| ## Decoder | ||
| - `Decoder::new_mp4` no longer takes an `Mp4Type` as hint. You can remove the argument | ||
| - Symphonia now longer assumes all sources are seek-able. Use | ||
| `DecoderBuilder::with_seekable` or `try_from` on a `File` or `Bufreader`. | ||
|
|
||
| The following Rodio *0.20.1* code | ||
| ```rust | ||
| let file = File::open("music.ogg")?; | ||
| let reader = BufReader::new(file); | ||
| let source = Decoder::new(reader); | ||
| ``` | ||
| Should be written like this in Rodio *0.21.0*: | ||
| ```rust | ||
| let file = File::open("music.ogg")?; | ||
| let source = Decoder::try_from(music.ogg)?; | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <!--- | ||
| When 0.21.0 is released this announcement will be posted to r/rust and the | ||
| rust user forum. Also post in rust audio discord: https://discord.gg/8qW6q2k | ||
| --> | ||
|
|
||
| # Announcing rodio 0.21 | ||
|
|
||
| Rodio is an audio playback library. It can decode audio files, synthesize new | ||
| sounds, apply effects to sounds & mix them. Rodio has been part of the Rust | ||
| ecosystem for 9 years now! 🎉. | ||
|
|
||
| ## New release | ||
| It's been 5 months since our last release. Since the our team has grown to 3 | ||
| maintainers! Thank you Petr and Roderick! And a big thanks for the countless | ||
| other contributors helping out. Thanks to you all this release: | ||
|
|
||
| - Makes the API easier to use: | ||
| - Its now impossible to accidentally drop the `Outputstream`. | ||
dvdsk marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. unfortunately this is not true, I must have misremembered... (at least a quick check with the |
||
| - Our types are no longer generic over sample type. | ||
| - Adds new functionality: | ||
| - Amplify using decibals or perceptually. | ||
| - Add a distortion effect. | ||
| - You can use rodio without `cpal` to generate `wav` files! | ||
|
There was a problem hiding this comment. Want to highlight the decoder builder as well? |
||
|
|
||
| There have also been many fixes and smaller additions, take a look at the | ||
| [changelog](https://github.com/RustAudio/rodio/blob/89dac52/CHANGELOG.md)! | ||
|
|
||
| ## The future | ||
| The rust audio organization will keep working on audio in Rust. We hope to | ||
| release an announcement regarding that soon! | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We may also want to add: