How serenity-rs/songbird works
Songbird is a Rust voice system for Discord, combining gateway integration, audio input and playback, and a voice driver. A typical flow starts with a bot joining a guild voice channel, supplying an audio source, and playing it as a controllable track; the driver mixes and sends audio to Discord. Separate capabilities include queues, event handling, optional voice receive, and multiple gateway frontends. The source excerpts show key message dispatch and connection links; some indexed runtime modules were not sampled, so uncertain internal links are omitted.
Main entry points: driver/mod.rs Voice driver · mix_logic.rs Audio mixer · tasks/mod.rs Core task dispatcher · manager.rs Call manager
Components 25
Gateway integration
- Call manager
src/manager.rs - Call handler
src/handler.rs - Serenity adapter
src/serenity.rs - Shard integration
src/shards.rs - Guild identifiers
src/id.rs
Audio inputs
- Audio sources
src/input/sources/mod.rs - Playable input
src/input/mod.rs - Source metadata
src/input/metadata/mod.rs
Track playback
- Track model
src/tracks/mod.rs - Track controls
src/tracks/handle.rs - Track queue
src/tracks/queue.rs
Voice runtime
- Driver configuration
src/config.rs - Voice connection
src/driver/connection/mod.rs - Voice crypto
src/driver/crypto.rs - Voice driver
src/driver/mod.rs - Core task dispatcher
src/driver/tasks/mod.rs - Audio mixer
src/driver/tasks/mixer/mix_logic.rs - Idle scheduler
src/driver/scheduler/idle.rs - Live scheduler
src/driver/scheduler/live.rs - Gateway socket task
src/driver/tasks/ws.rs
Events and receive
- Event processor
src/driver/tasks/events.rs - Event API
src/events/mod.rs - Voice receive
src/driver/tasks/udp_rx/mod.rs
Other components
- Bot application
- Discord voice service
Connections 27
- Bot application → Call manager: uses gateway
README.md - Call manager → Call handler: updates call
src/manager.rs - Call manager → Shard integration: uses sharder
src/manager.rs - Serenity adapter → Call manager: integrates gateway
src/manager.rs - Call handler → Voice driver: controls driver
src/handler.rs - Voice driver → Core task dispatcher: dispatches messages
src/driver/mod.rs - Core task dispatcher → Voice connection: opens connection
src/driver/tasks/mod.rs - Core task dispatcher → Audio mixer: sends mixer messages
src/driver/tasks/mod.rs - Core task dispatcher → Event processor: sends event messages
src/driver/tasks/mod.rs - Voice connection → Audio mixer: sets connection
src/driver/connection/mod.rs - Voice connection → Gateway socket task: delivers socket messages
src/driver/connection/mod.rs - Discord voice service → Voice connection: voice protocol
README.md - Bot application → Audio sources: selects audio
README.md - Audio sources → Playable input: creates input
src/input/sources/mod.rs - Playable input → Source metadata: exposes metadata
src/input/metadata/mod.rs - Playable input → Track model: provides audio
src/tracks/mod.rs - Track model → Voice driver: plays track
src/driver/mod.rs - Voice driver → Track queue: enqueues track
src/driver/mod.rs - Track model → Track controls: creates controls
src/tracks/mod.rs - Audio mixer → Event processor: sends track events
- Event API → Event processor: defines handlers
src/events/mod.rs - Discord voice service → Voice receive: sends voice packets
- Voice driver → Voice crypto: uses encryption
src/driver/mod.rs - Voice driver → Driver configuration: uses settings
- Audio mixer → Idle scheduler: scheduled by
- Audio mixer → Live scheduler: scheduled by
- Bot application → Event API: registers listeners
README.md