Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `Sink` is now `Player`
- `SpatialSink` is now `SpatialPlayer`
- `StreamError` is now `OsSinkError`
- `SamplesBuffer::new(1, 16000, samples)` would now look like `SamplesBuffer::new(nz!(1), nz!(16000), samples)` using the new `nz!` macro
- `SamplesBuffer::new(1, 16000, samples)` would now look like `SamplesBuffer::new(nz!(1), nz!(16000), samples)` using the new `nz!` macro
- `output_to_wav` renamed to `wav_to_file` and now takes ownership of the `Source`.
- `Blue` noise generator uses uniform instead of Gaussian noise for better performance.
- `Gaussian` noise generator has standard deviation of 0.6 for perceptual equivalence.
Expand Down
24 changes: 22 additions & 2 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,29 @@ guide are very welcome!
The list below only contains required code changes. For a complete list of
changes and new features, see [CHANGELOG.md](CHANGELOG.md).

# rodio 0.21.1 to current GitHub version
# rodio 0.22 to current github version
Nothing yet!

No changes are required.
# rodio 0.21.1 to 0.22
- _Sink_ terms are replaced with _Player_ and _Stream_ terms replaced
with _Sink_. This is a simple rename, functionality is identical.

We recommend a search replace for the following terms, in no particular order:
- `OutputStream` is now `MixerDeviceSink` (in anticipation of future
`QueueDeviceSink`)
- `OutputStreamBuilder` is now `DeviceSinkBuilder`
- `open_stream_or_fallback` is now `open_sink_or_fallback`
- `open_default_stream` is now `open_default_sink`
- `open_stream` is now `open_mixer` (in anticipation of future `open_queue`)
- `Sink` is now `Player`
- `SpatialSink` is now `SpatialPlayer`
- `StreamError` is now `OsSinkError`
- `output_to_wav` renamed to `wav_to_file` and now takes ownership of the `Source`.
- `SamplesBuffer::new` now takes ChannelCount and SampleRate as arguments. Use
the `nz!` macro to easily create those from literals like this:
`SamplesBuffer::new(nz!(1), nz!(44100))`
or construct them at runtime like this:
`SamplesBuffer::new(NonZero::new(channel_count)?, NonZero::new(sample_rate)?)`;

# rodio 0.20 or earlier to 0.21.1

Expand Down