Skip to content

Releases: serenity-rs/songbird

v0.4.2

08 Jul 11:07
@FelixMcFelix FelixMcFelix
v0.4.2
25d59a6
Compare
Choose a tag to compare
v0.4.2

This patch release adds in support for HLS and M3U8 stream playback, in addition to several bugfixes.

Thanks to the following for their contributions:

Changed

Assets 2
Loading

v0.4.1

29 Feb 23:11
@FelixMcFelix FelixMcFelix
v0.4.1
b07e9b4
Compare
Choose a tag to compare
v0.4.1 Latest
Latest

This patch release includes several fixes to how audio tasks behave when moved between channels, and prevents a crash on zero-length packets in 48kHz Ogg Vorbis files.
We've also added to YoutubeDl so you can now make use of ytdl's built-in search functionality.

Thanks to the following for their contributions:

Added

Changed

Fixed

Assets 2
Loading

v0.4.0 — Nightingale

27 Nov 22:25
@FelixMcFelix FelixMcFelix
v0.4.0
873aeae
Compare
Choose a tag to compare
v0.4.0 — Nightingale

Possessing a beautiful, creative, and evocative song through both night and day, the humble Nightingale has long been seen as a symbol of poetry and love.

In keeping with the spirit of this release's passerine of choice, songbird now sings more melodiously than ever!
This release has been a long time coming, and as such Nightingale brings several huge changes to how songbird is used and how it performs.

The largest change by far is a complete overhaul of all code relating to audio decoding, mixing, and loading from different locations, driven by Symphonia.
Broadly, this means that we handle every part of the audio pipeline in-process and ffmpeg is entirely removed, saving significant memory and CPU and letting you scale to more voice calls on one box.
Another boon is that reading in-memory audio now Just Works: if you can treat it as a &[u8], then you're good to go!
Having this level of control also lets us expand our list of file-formats supporting direct Opus passthrough to include Ogg Opus and WebM/MKV, as well as the DCA format.
Given that many sites will serve WebM, this is a significant saving on CPU time for many playback use cases.
Additionally, we now handle HTTP reconnection logic internally, offering more reliable behaviour than certain downloader -> ffmpeg process chains would provide.
Symphonia format support is significant, and you can enable and disable exactly the codecs and containers you need at compile-time.

Voice receive has been given its own fair share of improvements.
Most importantly, all receive sessions now make use of per-user jitter buffers – songbird will now delay decoding of all users to correctly reorder audio packets, smooth out network latency jitter, and to help synchronize playback of several speakers.
Receive functionality is now feature-gated and disabled by default, and so won't affect compile-time or runtime performance if you don't want to make use of it.

Finally, songbird now includes a new deadline-aware audio scheduler, which will pack as many concurrent Calls as possible onto a single thread.
Compared to the previous model we now reduce thread counts, CPU use, and context switching – for context, up to 660 live Opus-passthrough-enabled calls can run on a single thread on a Ryzen 5700X.
This is also helped by how we now park all Calls without any active Tracks onto a single shared event handling async task.

All in all, we're really excited to see what you build with these new tools and performance improvements.

Thanks to the following for their contributions:

Upgrade Pathway

Inputs:

  • ytdl etc. are removed and replaced with new lazy initialisers – read the docs on how to create sources from a URL or local path.
  • All inputs are now lazy by default, so Restartable is no longer needed.
  • Inputs can no longer directly output raw audio, as symphonia must always parse a container/codec pair. We've included a custom RawReader container format and the RawAdapter transform to support this.
  • Metadata is now split according to what you can learn when creating a source (AuxMetadata, e.g. info learned from a web scrape) and what metadata is encoded in a track itself (Metadata). Metadata can only be read once a track is fully initialised and parsed.
  • Songbird can now better encode an audio source's lifecycle from uninitialised, to readable, to having its headers fully parsed. Read the examples on how they can be manipulated, particularly if you want to make use of metadata.
  • Songbird's audio systems have undergone the most change in this release, so this list is non-exhaustive.

Tracks:

  • TrackHandle::action now gives temporary access to a View object – a set of current track state and extracted metadata – which can be used to fire more complex commands like seeking or pre-loading a Track by returning an Action.
  • TrackHandles are now created only from Driver::play/play_input and related methods.
  • tracks::create_player is removed in favour of the above methods on Driver.

Voice Receive:

  • Users of voice receive will now need to enable the "receive" feature.
  • CoreEvent::VoicePacket has now split into two events: RtpPacket and VoiceTick.
    RtpPacket corresponds to raw RTP packets received from each user and does not decode audio, while VoiceTick fires every 20ms and includes the reordered (and decoded, if so configured) audio for every user, synchronised and ready to use.
  • Per-user jitter buffer sizes can be configured using Config::playout_buffer_length and ::playout_spike_length.

Added

  • [driver] Driver: Implement audio scheduler (#179) ([@FelixMcFelix]) [c:3daf11f]
  • [gateway] Gateway: Add Songbird::iter (#166) ([@fee1-dead]) [c:5bc8430]
  • [driver] Driver/receive: Implement audio reorder/jitter buffer (#156) ([@FelixMcFelix]) [c:c60c454]
  • [driver] Driver: Split receive into its own feature (#141) ([@FelixMcFelix]) [c:2277595]
  • [driver] Driver: Add toggle for softclip (#137) ([@FelixMcFelix]) [c:13946b4]
  • [driver] Support simd_json (#105) ([@vicky5124]) [c:cb0a74f]
  • [driver] Driver/Input: Migrate audio backend to Symphonia (#89) ([@FelixMcFelix]) [c:8cc7a22]

Changed

  • [driver] Driver: Remove RwLock from ThreadPool (#206) ([@kane50613]) [c:1ec569b]
  • [clippy] Chore: Cleanup clippy lints ([@FelixMcFelix]) [c:91640f6]
  • [deps] Chore: Upgrade serenity to 0.12.0-rc ([@FelixMcFelix]) [c:1487da1]
  • [deps] Chore: Bump DiscoRTP version ([@FelixMcFelix]) [c:0ef0e4f]
  • [clippy] Fix clippy pedantic warnings (#204) ([@GnomedDev]) [c:3d307aa]
  • [deps] Update simd-json to 0.13 (#203) ([@GnomedDev]) [c:63d48ee]
  • [deps] Chore: Update Rubato -> 0.14.1 ([@FelixMcFelix]) [c:67b3b3e]
  • [deps] Chore: Update (most) dependencies ([@FelixMcFelix]) [c:4220c1f]
  • [clippy] Chore: Rust 1.72.0 Clippy lints, adjust MSRV ([@FelixMcFelix]) [c:6f80156]
  • [deps] Driver: Replace xsalsa20poly1305 with crypto_secretbox (#198) ([@Sebbl0508]) [c:77a9b46]
  • [ci] Chore(ci): Update rust, cargo and cache actions (#177) ([@jontze]) [c:5ddc8f4]
  • [ci] chore(docs): Update rust setup action and cache (#176) ([@jontze]) [c:4eadeb6]
  • [ci] chore(workflows): Update checkout action to v3 (#175) ([@jontze]) [c:841224e]
  • [driver] Driver: Retune threadpool keepalive time ([@FelixMcFelix]) [c:9ab5be8]
  • [driver] Driver: Downgrade failed scheduler message delivery to info ([@FelixMcFelix]) [c:02c9812]
  • [clippy] Chore: Clippy fixes to match new MSRV. ([@FelixMcFelix]) [c:9fa063f]
  • [deps] Chore: Update dependencies, MSRV. ([@FelixMcFelix]) [c:1bf17d1]
  • [deps] Chore: Update dependencies. ([@FelixMcFelix]) [c:a5f7d3f]
  • [ci] Repo: Update issue templates ([@FelixMcFelix]) [c:6cd3097]
  • [deps] Gateway: Twilight 0.15 support (#171) ([@Erk-]) [c:b2507f3]
  • [clippy] Chore: Fix clippy warnings (#167) ([@fee1-dead]) [c:6e6d8e7]
  • [ci] CI: Disable Windows, MacOS Testing ([@FelixMcFelix]) [c:2de071f]
  • [input] Input: Clarify YoutubeDl error if command missing (#160) ([@FelixMcFelix]) [c:53ebc3c]
  • [deps] Deps: Move to published symphonia v0.5.2 from git ([@FelixMcFelix]) [c:fdd0d83]
  • [gateway] Gateway: Simplify return value of join/join_gateway (#157) ([@FelixMcFelix]) [c:f2fbbfe]
  • [deps] Chore: Update tokio-tungstenite, typemap_rev ([@FelixMcFelix]) [c:5d06a42]
  • [deps] Chore: Apply latest nightly clippy lints ([@FelixMcFelix]) [c:125c803]
  • [driver] Driver: remove copy to receive &mut for softclip (#143) ([@FelixMcFelix]) [c:ab18f9e]
  • [deps] Deps: Move symphonia back to mainline repo. ([@FelixMcFelix]) [c:b7e40ab]
  • [deps] Deps: Update dev-dependencies ([@FelixMcFelix]) [c:f72175b]
  • [deps] Deps: Update Ringbuf, Serde-Aux, Simd-Json, Typemap ([@FelixMcFelix]) [c:6a38fc8]
  • [clippy] Chore: Fix new(er) Clippy lints ([@FelixMcFelix]) [c:662debd]
  • [deps] Deps: Update Twilight -> v0.14 ([@FelixMcFelix]) [c:646190e]
  • [deps] Deps: Update twilight to 0.13 (#147) ([@Erk-]) [c:372156e]
  • [deps] Chore: Update xsalsa20poly1305 -> 0.9 ([@FelixMcFelix]) [c:48db45f]
  • [deps] Chore: Rework crate features (#139) ([@FelixMcFelix]) [c:d8061d5]
  • [driver] Driver: Migrate to tokio_tungstenite (#138) ([@FelixMcFelix]) [c:76c9851]
  • [input] Input: lazy_static -> once_cell::sync::Lazy (#136) ([@GnomedDev]) [c:0beb0f0]

Fixed

  • [examples] Chore: Fixup examples, bump version pre-push ([@FelixMcFelix]) [c:22ceb17]
  • [deps] Re-disable default Serenity features ([@FelixMcFelix]) [c:cc53312]
  • [gateway] Fix compiling with latest serenity (#199) ([@GnomedDev]) [c:509743f]
  • [driver] Driver: Correct buffer instantiation for Rubato ([@FelixMcFelix]) [c:935171d]
  • [tests] Chore: Update test URL for playlist. ([@FelixMcFelix]) [c:c55a313]
  • [driver] Driver: Don't trim recv_buffer on MacOS ([@FelixMcFelix]) [c:019ac27]
  • [driver] Driver: Fix scheduler crash after task closure ([@FelixMcFelix]) [c:77e3916]
  • [input] Input: Add HTTP Status Code Checks (#190) ([@maxall41]) [c:c976d50]
  • [driver] Fix: Move WS error handling (#174) ([@Erk-]) [c:500d679]
  • [gateway] Gateway: Fix serenity breaking changes (#173) ([@tazz4843]) [c:4d0c1c0]
  • [driver] fix(ws): Songbird would fail if it could not deserialize ws payload. (#170) ([@Erk-]) [c:c73f498]
  • [repo] Chore: Fix README.md CI badge (#161) ([@FelixMcFelix]) [c:50dbc62]
  • [input] Input: Pass --no-playlist for YoutubeDl (#168) ([@fee1-dead]) [c:296f0e5]
  • [docs] Docs: Fix a link in constant doc...
Read more
Assets 2
Loading

v0.4.0-rc — Nightingale

20 Nov 03:00
@FelixMcFelix FelixMcFelix
v0.4.0-rc
3809616
Compare
Choose a tag to compare
v0.4.0-rc — Nightingale Pre-release
Pre-release

Possessing a beautiful, creative, and evocative song through both night and day, the humble Nightingale has long been seen as a symbol of poetry and love.

In keeping with the spirit of this release's passerine of choice, songbird now sings more melodiously than ever!
This release has been a long time coming, and as such Nightingale brings several huge changes to how songbird is used and how it performs.

The largest change by far is a complete overhaul of all code relating to audio decoding, mixing, and loading from different locations, driven by Symphonia.
Broadly, this means that we handle every part of the audio pipeline in-process and ffmpeg is entirely removed, saving significant memory and CPU and letting you scale to more voice calls on one box.
Another boon is that reading in-memory audio now Just Works: if you can treat it as a &[u8], then you're good to go!
Having this level of control also lets us expand our list of file-formats supporting direct Opus passthrough to include Ogg Opus and WebM/MKV, as well as the DCA format.
Given that many sites will serve WebM, this is a significant saving on CPU time for many playback use cases.
Additionally, we now handle HTTP reconnection logic internally, offering more reliable behaviour than certain downloader -> ffmpeg process chains would provide.
Symphonia format support is significant, and you can enable and disable exactly the codecs and containers you need at compile-time.

Voice receive has been given its own fair share of improvements.
Most importantly, all receive sessions now make use of per-user jitter buffers – songbird will now delay decoding of all users to correctly reorder audio packets, smooth out network latency jitter, and to help synchronize playback of several speakers.
Receive functionality is now feature-gated and disabled by default, and so won't affect compile-time or runtime performance if you don't want to make use of it.

Finally, songbird now includes a new deadline-aware audio scheduler, which will pack as many concurrent Calls as possible onto a single thread.
Compared to the previous model we now reduce thread counts, CPU use, and context switching – for context, up to 660 live Opus-passthrough-enabled calls can run on a single thread on a Ryzen 5700X.
This is also helped by how we now park all Calls without any active Tracks onto a single shared event handling async task.

All in all, we're really excited to see what you build with these new tools and performance improvements.

Thanks to the following for their contributions:

Upgrade Pathway

Inputs:

  • ytdl etc. are removed and replaced with new lazy initialisers – read the docs on how to create sources from a URL or local path.
  • All inputs are now lazy by default, so Restartable is no longer needed.
  • Inputs can no longer directly output raw audio, as symphonia must always parse a container/codec pair. We've included a custom RawReader container format and the RawAdapter transform to support this.
  • Metadata is now split according to what you can learn when creating a source (AuxMetadata, e.g. info learned from a web scrape) and what metadata is encoded in a track itself (Metadata). Metadata can only be read once a track is fully initialised and parsed.
  • Songbird can now better encode an audio source's lifecycle from uninitialised, to readable, to having its headers fully parsed. Read the examples on how they can be manipulated, particularly if you want to make use of metadata.
  • Songbird's audio systems have undergone the most change in this release, so this list is non-exhaustive.

Tracks:

  • TrackHandle::action now gives temporary access to a View object – a set of current track state and extracted metadata – which can be used to fire more complex commands like seeking or pre-loading a Track by returning an Action.
  • TrackHandles are now created only from Driver::play/play_input and related methods.
  • tracks::create_player is removed in favour of the above methods on Driver.

Voice Receive:

  • Users of voice receive will now need to enable the "receive" feature.
  • CoreEvent::VoicePacket has now split into two events: RtpPacket and VoiceTick.
    RtpPacket corresponds to raw RTP packets received from each user and does not decode audio, while VoiceTick fires every 20ms and includes the reordered (and decoded, if so configured) audio for every user, synchronised and ready to use.
  • Per-user jitter buffer sizes can be configured using Config::playout_buffer_length and ::playout_spike_length.

Added

  • [driver] Driver: Implement audio scheduler (#179) ([@FelixMcFelix]) [c:3daf11f]
  • [gateway] Gateway: Add Songbird::iter (#166) ([@fee1-dead]) [c:5bc8430]
  • [driver] Driver/receive: Implement audio reorder/jitter buffer (#156) ([@FelixMcFelix]) [c:c60c454]
  • [driver] Driver: Split receive into its own feature (#141) ([@FelixMcFelix]) [c:2277595]
  • [driver] Driver: Add toggle for softclip (#137) ([@FelixMcFelix]) [c:13946b4]
  • [driver] Support simd_json (#105) ([@vicky5124]) [c:cb0a74f]
  • [driver] Driver/Input: Migrate audio backend to Symphonia (#89) ([@FelixMcFelix]) [c:8cc7a22]

Changed

  • [clippy] Chore: Cleanup clippy lints ([@FelixMcFelix]) [c:91640f6]
  • [deps] Chore: Upgrade serenity to 0.12.0-rc ([@FelixMcFelix]) [c:1487da1]
  • [deps] Chore: Bump DiscoRTP version ([@FelixMcFelix]) [c:0ef0e4f]
  • [clippy] Fix clippy pedantic warnings (#204) ([@GnomedDev]) [c:3d307aa]
  • [deps] Update simd-json to 0.13 (#203) ([@GnomedDev]) [c:63d48ee]
  • [deps] Chore: Update Rubato -> 0.14.1 ([@FelixMcFelix]) [c:67b3b3e]
  • [deps] Chore: Update (most) dependencies ([@FelixMcFelix]) [c:4220c1f]
  • [clippy] Chore: Rust 1.72.0 Clippy lints, adjust MSRV ([@FelixMcFelix]) [c:6f80156]
  • [deps] Driver: Replace xsalsa20poly1305 with crypto_secretbox (#198) ([@Sebbl0508]) [c:77a9b46]
  • [ci] Chore(ci): Update rust, cargo and cache actions (#177) ([@jontze]) [c:5ddc8f4]
  • [ci] chore(docs): Update rust setup action and cache (#176) ([@jontze]) [c:4eadeb6]
  • [ci] chore(workflows): Update checkout action to v3 (#175) ([@jontze]) [c:841224e]
  • [driver] Driver: Retune threadpool keepalive time ([@FelixMcFelix]) [c:9ab5be8]
  • [driver] Driver: Downgrade failed scheduler message delivery to info ([@FelixMcFelix]) [c:02c9812]
  • [clippy] Chore: Clippy fixes to match new MSRV. ([@FelixMcFelix]) [c:9fa063f]
  • [deps] Chore: Update dependencies, MSRV. ([@FelixMcFelix]) [c:1bf17d1]
  • [deps] Chore: Update dependencies. ([@FelixMcFelix]) [c:a5f7d3f]
  • [ci] Repo: Update issue templates ([@FelixMcFelix]) [c:6cd3097]
  • [deps] Gateway: Twilight 0.15 support (#171) ([@Erk-]) [c:b2507f3]
  • [clippy] Chore: Fix clippy warnings (#167) ([@fee1-dead]) [c:6e6d8e7]
  • [ci] CI: Disable Windows, MacOS Testing ([@FelixMcFelix]) [c:2de071f]
  • [input] Input: Clarify YoutubeDl error if command missing (#160) ([@FelixMcFelix]) [c:53ebc3c]
  • [deps] Deps: Move to published symphonia v0.5.2 from git ([@FelixMcFelix]) [c:fdd0d83]
  • [gateway] Gateway: Simplify return value of join/join_gateway (#157) ([@FelixMcFelix]) [c:f2fbbfe]
  • [deps] Chore: Update tokio-tungstenite, typemap_rev ([@FelixMcFelix]) [c:5d06a42]
  • [deps] Chore: Apply latest nightly clippy lints ([@FelixMcFelix]) [c:125c803]
  • [driver] Driver: remove copy to receive &mut for softclip (#143) ([@FelixMcFelix]) [c:ab18f9e]
  • [deps] Deps: Move symphonia back to mainline repo. ([@FelixMcFelix]) [c:b7e40ab]
  • [deps] Deps: Update dev-dependencies ([@FelixMcFelix]) [c:f72175b]
  • [deps] Deps: Update Ringbuf, Serde-Aux, Simd-Json, Typemap ([@FelixMcFelix]) [c:6a38fc8]
  • [clippy] Chore: Fix new(er) Clippy lints ([@FelixMcFelix]) [c:662debd]
  • [deps] Deps: Update Twilight -> v0.14 ([@FelixMcFelix]) [c:646190e]
  • [deps] Deps: Update twilight to 0.13 (#147) ([@Erk-]) [c:372156e]
  • [deps] Chore: Update xsalsa20poly1305 -> 0.9 ([@FelixMcFelix]) [c:48db45f]
  • [deps] Chore: Rework crate features (#139) ([@FelixMcFelix]) [c:d8061d5]
  • [driver] Driver: Migrate to tokio_tungstenite (#138) ([@FelixMcFelix]) [c:76c9851]
  • [input] Input: lazy_static -> once_cell::sync::Lazy (#136) ([@GnomedDev]) [c:0beb0f0]

Fixed

  • [gateway] Fix compiling with latest serenity (#199) ([@GnomedDev]) [c:509743f]
  • [driver] Driver: Correct buffer instantiation for Rubato ([@FelixMcFelix]) [c:935171d]
  • [tests] Chore: Update test URL for playlist. ([@FelixMcFelix]) [c:c55a313]
  • [driver] Driver: Don't trim recv_buffer on MacOS ([@FelixMcFelix]) [c:019ac27]
  • [driver] Driver: Fix scheduler crash after task closure ([@FelixMcFelix]) [c:77e3916]
  • [input] Input: Add HTTP Status Code Checks (#190) ([@maxall41]) [c:c976d50]
  • [driver] Fix: Move WS error handling (#174) ([@Erk-]) [c:500d679]
  • [gateway] Gateway: Fix serenity breaking changes (#173) ([@tazz4843]) [c:4d0c1c0]
  • [driver] fix(ws): Songbird would fail if it could not deserialize ws payload. (#170) ([@Erk-]) [c:c73f498]
  • [repo] Chore: Fix README.md CI badge (#161) ([@FelixMcFelix]) [c:50dbc62]
  • [input] Input: Pass --no-playlist for YoutubeDl (#168) ([@fee1-dead]) [c:296f0e5]
  • [docs] Docs: Fix a link in constant docstring (#169) ([@fee1-dead]) [c:3f6114c]
  • [input] Input: Fix high CPU use when initialising long files over HTTP (#163) ([@FelixMcFelix]) [c:50fa17f]
  • [deps] Docs: Correct version for symphonia codec support ([@FelixMcFelix]) [c:ed4be7c]
  • [driver] Avoid spawni...
Read more
Assets 2
Loading

v0.3.2

09 Apr 13:35
@arqunis arqunis
v0.3.2
2ae1d57
Compare
Choose a tag to compare
v0.3.2

This patch release fixes a WS disconnection that would occur when receiving a new opcode, which was happening due to Discord sending such an opcode upon connecting to a voice channel.

Thanks to the following for their contributions:

Fixed

Assets 2
Loading

v0.3.1

02 Mar 22:28
@FelixMcFelix FelixMcFelix
v0.3.1
4849043
Compare
Choose a tag to compare
v0.3.1

This patch release applies some minor fixes, while correcting documentation errors and adjusting some organisation in the repository.

Thanks to the following for their contributions:

Added

Fixed

Assets 2
Loading

v0.3.0 — Chaffinch

22 Jul 15:16
@FelixMcFelix FelixMcFelix
v0.3.0
6c6ffa7
Compare
Choose a tag to compare
v0.3.0 — Chaffinch

Abundant and ever-curious, chaffinches are a vibrant and welcome visitor in these spring and summer months.

Making a quick and colourful splash, this breaking release mainly bumps our own dependencies and support for Discord libraries without any sweeping changes -- while adding generic support for any future rust-based Discord library. However, we have now removed support for the v0.2 series of the Tokio runtime.

Thanks to the following for their contributions:

Upgrade Pathway

  • Tokio v0.2 support has been removed in parity with other Discord -- users must now migrate to v1.x.x.
  • Deprecated events (ClientConnect, DriverConnectFailed, DriverReconnectFailed and SsrcKnown) have been removed.
  • ClientConnect must now be detected using VoiceStateUpdate messages from your main gateway library of choice.
  • The remainder should be replaced with DriverDisconnect, and DriverConnect/DriverReconnect

Added

Changed

Fixed

Removed

Assets 2
Loading

v0.2.2

13 Feb 19:28
@FelixMcFelix FelixMcFelix
v0.2.2
16acfd4
Compare
Choose a tag to compare
v0.2.2

This patch release mskes it easier to create new ChildContainers, and deprecates the ClientConnect event. Users should instead make use of SpeakingStateUpdate events and Discord gateway events.

Thanks to the following for their contributions:

Added

Changed

Fixed

Assets 2
Loading

v0.2.1

05 Jan 10:43
@FelixMcFelix FelixMcFelix
v0.2.1
00295bd
Compare
Choose a tag to compare
v0.2.1

This patch release adds support for the yt-dlp fork of youtube-dl, and fixes track events to correctly fire events when multiple timed handlers are present on a track.

Thanks to the following for their contributions:

Added

Fixed

Assets 2
Loading

v0.2.0 — Magpie

17 Aug 13:14
@FelixMcFelix FelixMcFelix
v0.2.0
562723f
Compare
Choose a tag to compare
v0.2.0 — Magpie

Magpies are a common sight year-round; strong, intelligent, industrious, and loyal.

Taking after the humble magpie, this breaking release makes API changes favouring extensibility, patching some of the API rough spots, and adding resilience to some additional classes of failure.

Thanks to the following for their contributions:

Upgrade Pathway

  • References to songbird::{opus, Bitrate}; should now use songbird::driver::{opus, Bitrate};.
  • Custom Inputs (i.e., Reader::Extension/ExtensionSeek) now need to implement input::reader::MediaSource rather than just Read and/or Seek.
  • Sources which do not support seeking should have an unreachable!() function body or always return an error, as MediaSource::is_seekable() is used to gate support.
  • Many event handler types in songbird::EventContext have changed to unit enums, rather than struct variants.
  • New body types are included in songbird::events::context_data::*.
  • Config structs have been made non-exhaustive; they should be initialised via Config::default().
  • Channel join operations may now timeout after a default 10s—which should be handled.
  • Errors returned when joining a channel will now inform you whether you should try to leave a channel before rejoining.
  • Youtube-dl variants of songbird::input::error::Error have had their case altered from DL -> Dl.
  • TrackState sent from the driver are no longer boxed objects.
  • DriverDisconnect events have been introduced, which cover all disconnect events. As a result, DriverConnectFailed and DriverReconnectFailed are deprecated.
  • Tokio 0.2 support is deprecated. Related features will be removed as of Songbird 0.3.

Added

Changed

Fixed

Read more
Assets 2
Loading