From 54153914d22180777b25a1d4f5089ed2ae2839df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Wed, 13 Jan 2021 23:19:05 +0100 Subject: de-pub links on mumlib channels --- mumd/src/state/channel.rs | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) (limited to 'mumd/src') diff --git a/mumd/src/state/channel.rs b/mumd/src/state/channel.rs index 6995e1e..2ed05c5 100644 --- a/mumd/src/state/channel.rs +++ b/mumd/src/state/channel.rs @@ -169,13 +169,10 @@ pub fn into_channel( impl From<&Channel> for mumlib::state::Channel { fn from(channel: &Channel) -> Self { - mumlib::state::Channel { - description: channel.description.clone(), - links: Vec::new(), - max_users: channel.max_users, - name: channel.name.clone(), - children: Vec::new(), - users: Vec::new(), - } + mumlib::state::Channel::new( + channel.name.clone(), + channel.description.clone(), + channel.max_users, + ) } } -- cgit v1.2.1 From 64978fa17b6e0882d6bacb6e626b0bc9ead2c81d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Thu, 8 Apr 2021 14:42:18 +0200 Subject: document mumd::audio --- mumd/src/audio.rs | 25 ++++++++++++++++++++++++- mumd/src/audio/input.rs | 12 ++++++++++++ mumd/src/audio/output.rs | 16 ++++++++++++++++ 3 files changed, 52 insertions(+), 1 deletion(-) (limited to 'mumd/src') diff --git a/mumd/src/audio.rs b/mumd/src/audio.rs index 2e20583..46f7050 100644 --- a/mumd/src/audio.rs +++ b/mumd/src/audio.rs @@ -1,3 +1,7 @@ +//! All things audio. +//! +//! Audio is handled mostly as signals from [dasp_signal]. Input/output is handled by [cpal]. + pub mod input; pub mod output; pub mod transformers; @@ -27,8 +31,11 @@ use strum::IntoEnumIterator; use strum_macros::EnumIter; use tokio::sync::watch; +/// The sample rate used internally. const SAMPLE_RATE: u32 = 48000; +/// All types of notifications that can be shown. Each notification can be bound to its own audio +/// file. #[derive(Debug, Eq, PartialEq, Clone, Copy, Hash, EnumIter)] pub enum NotificationEvents { ServerConnect, @@ -65,9 +72,11 @@ impl TryFrom<&str> for NotificationEvents { } } +/// Input audio state. pub struct AudioInput { device: DefaultAudioInputDevice, + /// Voice packets received from the network. channel_receiver: Arc> + Unpin>>>, } @@ -114,10 +123,15 @@ impl AudioInput { pub struct AudioOutput { device: DefaultAudioOutputDevice, + /// The volume and mute-status of a user ID. user_volumes: Arc>>, + /// The client stream per user ID. A separate stream is kept for UDP and TCP. + /// + /// Shared with [DefaultAudioOutputDevice]. client_streams: Arc>, + /// Which sound effect should be played on an event. sounds: HashMap>, } @@ -140,6 +154,7 @@ impl AudioOutput { Ok(res) } + /// Loads sound effects, getting unspecified effects from [get_default_sfx]. pub fn load_sound_effects(&mut self, sound_effects: &[SoundEffect]) { let overrides: HashMap<_, _> = sound_effects .iter() @@ -153,6 +168,7 @@ impl AudioOutput { }) .collect(); + // This makes sure that every [NotificationEvent] is present in [self.sounds]. self.sounds = NotificationEvents::iter() .map(|event| { let bytes = overrides @@ -195,6 +211,7 @@ impl AudioOutput { .collect(); } + /// Decodes a voice packet. pub fn decode_packet_payload( &self, stream_type: VoiceStreamType, @@ -207,11 +224,13 @@ impl AudioOutput { .decode_packet((stream_type, session_id), payload); } + /// Sets the volume of the output device. pub fn set_volume(&self, output_volume: f32) { self.device.set_volume(output_volume); } - pub fn set_user_volume(&self, id: u32, volume: f32) { + /// Sets the incoming volume of a user. + pub(crate) fn set_user_volume(&self, id: u32, volume: f32) { match self.user_volumes.lock().unwrap().entry(id) { Entry::Occupied(mut entry) => { entry.get_mut().0 = volume; @@ -222,6 +241,7 @@ impl AudioOutput { } } + /// Mutes another user. pub fn set_mute(&self, id: u32, mute: bool) { match self.user_volumes.lock().unwrap().entry(id) { Entry::Occupied(mut entry) => { @@ -233,12 +253,14 @@ impl AudioOutput { } } + /// Queues a sound effect. pub fn play_effect(&self, effect: NotificationEvents) { let samples = self.sounds.get(&effect).unwrap(); self.client_streams.lock().unwrap().extend(None, samples); } } +/// Reads a sound effect from disk. // moo fn get_sfx(file: &str) -> Cow<'static, [u8]> { let mut buf: Vec = Vec::new(); @@ -251,6 +273,7 @@ fn get_sfx(file: &str) -> Cow<'static, [u8]> { } } +/// Gets the default sound effect. fn get_default_sfx() -> Cow<'static, [u8]> { Cow::from(include_bytes!("fallback_sfx.wav").as_ref()) } diff --git a/mumd/src/audio/input.rs b/mumd/src/audio/input.rs index a1227e3..10aea91 100644 --- a/mumd/src/audio/input.rs +++ b/mumd/src/audio/input.rs @@ -1,3 +1,4 @@ +//! Listens to the microphone and sends it to the networking. use cpal::traits::{DeviceTrait, HostTrait, StreamTrait}; use cpal::{InputCallbackInfo, Sample, SampleFormat, SampleRate, StreamConfig}; use log::*; @@ -8,6 +9,7 @@ use crate::audio::transformers::{NoiseGate, Transformer}; use crate::error::{AudioError, AudioStream}; use crate::state::StatePhase; +/// Generates a callback that receives [Sample]s and sends them as floats to a [futures_channel::mpsc::Sender]. pub fn callback( mut input_sender: futures_channel::mpsc::Sender>, mut transformers: Vec>, @@ -44,10 +46,15 @@ pub fn callback( } pub trait AudioInputDevice { + /// Starts the device. fn play(&self) -> Result<(), AudioError>; + /// Stops the device. fn pause(&self) -> Result<(), AudioError>; + /// Sets the input volume of the device. fn set_volume(&self, volume: f32); + /// Returns a receiver to this device's values. fn sample_receiver(&mut self) -> Option>>; + /// The amount of channels this device has. fn num_channels(&self) -> usize; } @@ -59,6 +66,7 @@ pub struct DefaultAudioInputDevice { } impl DefaultAudioInputDevice { + /// Initializes the default audio input. pub fn new( input_volume: f32, phase_watcher: watch::Receiver, @@ -162,17 +170,21 @@ impl AudioInputDevice for DefaultAudioInputDevice { .play() .map_err(|e| AudioError::InputPlayError(e)) } + fn pause(&self) -> Result<(), AudioError> { self.stream .pause() .map_err(|e| AudioError::InputPauseError(e)) } + fn set_volume(&self, volume: f32) { self.volume_sender.send(volume).unwrap(); } + fn sample_receiver(&mut self) -> Option>> { self.sample_receiver.take() } + fn num_channels(&self) -> usize { self.channels as usize } diff --git a/mumd/src/audio/output.rs b/mumd/src/audio/output.rs index a2f6bcc..3d886d6 100644 --- a/mumd/src/audio/output.rs +++ b/mumd/src/audio/output.rs @@ -1,3 +1,4 @@ +//! Receives audio packets from the networking and plays them. use crate::audio::SAMPLE_RATE; use crate::error::{AudioError, AudioStream}; use crate::network::VoiceStreamType; @@ -13,6 +14,7 @@ use tokio::sync::watch; type ClientStreamKey = (VoiceStreamType, u32); +/// Collected state for client opus decoders and sound effects. pub struct ClientStream { buffer_clients: HashMap, opus::Decoder)>, //TODO ring buffer? buffer_effects: VecDeque, @@ -44,6 +46,7 @@ impl ClientStream { }) } + /// Decodes a voice packet. pub fn decode_packet(&mut self, client: ClientStreamKey, payload: VoicePacketPayload) { match payload { VoicePacketPayload::Opus(bytes, _eot) => { @@ -61,6 +64,7 @@ impl ClientStream { } } + /// Extends either a decoder queue or the buffer effect queue with some received values. pub fn extend(&mut self, client: Option, values: &[f32]) { let buffer = match client { Some(x) => &mut self.get_client(x).0, @@ -70,6 +74,12 @@ impl ClientStream { } } +/// Adds two values in some saturating way. +/// +/// Since we support [f32], [i16] and [u16] we need some way of adding two values +/// without peaking above/below the edge values. This trait ensures that we can +/// use all three primitive types as a generic parameter. + pub trait SaturatingAdd { fn saturating_add(self, rhs: Self) -> Self; } @@ -107,11 +117,16 @@ pub trait AudioOutputDevice { pub struct DefaultAudioOutputDevice { config: StreamConfig, stream: cpal::Stream, + /// The client stream per user ID. A separate stream is kept for UDP and TCP. + /// + /// Shared with [super::AudioOutput]. client_streams: Arc>, + /// Output volume configuration. volume_sender: watch::Sender, } impl DefaultAudioOutputDevice { + /// Initializes the default audio output. pub fn new( output_volume: f32, user_volumes: Arc>>, @@ -211,6 +226,7 @@ impl AudioOutputDevice for DefaultAudioOutputDevice { } } +/// Over-engineered way of handling multiple types of samples. pub fn curry_callback( user_bufs: Arc>, output_volume_receiver: watch::Receiver, -- cgit v1.2.1 From 0f94d30e5ab7945582e1fc7124bbe50c42f37a45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 12:51:46 +0200 Subject: incoming -> outgoing packets --- mumd/src/audio.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'mumd/src') diff --git a/mumd/src/audio.rs b/mumd/src/audio.rs index 46f7050..b3c809d 100644 --- a/mumd/src/audio.rs +++ b/mumd/src/audio.rs @@ -76,7 +76,7 @@ impl TryFrom<&str> for NotificationEvents { pub struct AudioInput { device: DefaultAudioInputDevice, - /// Voice packets received from the network. + /// Outgoing voice packets that should be sent over the network. channel_receiver: Arc> + Unpin>>>, } -- cgit v1.2.1 From 9350dd303bbfc1534f61f996bd4206b1e10e5f34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 12:52:48 +0200 Subject: more audioinput --- mumd/src/audio.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'mumd/src') diff --git a/mumd/src/audio.rs b/mumd/src/audio.rs index b3c809d..f52389a 100644 --- a/mumd/src/audio.rs +++ b/mumd/src/audio.rs @@ -72,7 +72,8 @@ impl TryFrom<&str> for NotificationEvents { } } -/// Input audio state. +/// Input audio state. Input audio is picket up from an [AudioInputDevice] (e.g. +/// a microphone) and sent over the network. pub struct AudioInput { device: DefaultAudioInputDevice, -- cgit v1.2.1 From bbaf2c576b324cf2f519220930d5c99b0496023e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 12:54:19 +0200 Subject: audioouput doc --- mumd/src/audio.rs | 3 +++ 1 file changed, 3 insertions(+) (limited to 'mumd/src') diff --git a/mumd/src/audio.rs b/mumd/src/audio.rs index f52389a..6c20d08 100644 --- a/mumd/src/audio.rs +++ b/mumd/src/audio.rs @@ -122,6 +122,9 @@ impl AudioInput { } } +/// Audio output state. The audio is received from each client over the network, +/// decoded, merged and finally played to an [AudioOutputDevice] (e.g. speaker, +/// headphones, ...). pub struct AudioOutput { device: DefaultAudioOutputDevice, /// The volume and mute-status of a user ID. -- cgit v1.2.1 From 988ac16195e24c71ba17c4103448addb299c58bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 12:54:52 +0200 Subject: ~~pub(crate)~~ --- mumd/src/audio.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'mumd/src') diff --git a/mumd/src/audio.rs b/mumd/src/audio.rs index 6c20d08..78e10b9 100644 --- a/mumd/src/audio.rs +++ b/mumd/src/audio.rs @@ -234,7 +234,7 @@ impl AudioOutput { } /// Sets the incoming volume of a user. - pub(crate) fn set_user_volume(&self, id: u32, volume: f32) { + pub fn set_user_volume(&self, id: u32, volume: f32) { match self.user_volumes.lock().unwrap().entry(id) { Entry::Occupied(mut entry) => { entry.get_mut().0 = volume; -- cgit v1.2.1 From bc270b506270a17fe830cc1a41426708fedcbdb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 13:21:37 +0200 Subject: doc trait audioinputdevice --- mumd/src/audio/input.rs | 3 +++ 1 file changed, 3 insertions(+) (limited to 'mumd/src') diff --git a/mumd/src/audio/input.rs b/mumd/src/audio/input.rs index 10aea91..5721996 100644 --- a/mumd/src/audio/input.rs +++ b/mumd/src/audio/input.rs @@ -45,6 +45,9 @@ pub fn callback( } } +/// Something that can listen to audio and send it somewhere. +/// +/// One sample is assumed to be an encoded opus frame. See [opus::Encoder]. pub trait AudioInputDevice { /// Starts the device. fn play(&self) -> Result<(), AudioError>; -- cgit v1.2.1 From b97645143c70b8c69d659e46e5d0cfce97220b44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 13:25:16 +0200 Subject: saturating add method doc --- mumd/src/audio/output.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'mumd/src') diff --git a/mumd/src/audio/output.rs b/mumd/src/audio/output.rs index 3d886d6..3c00116 100644 --- a/mumd/src/audio/output.rs +++ b/mumd/src/audio/output.rs @@ -1,4 +1,5 @@ //! Receives audio packets from the networking and plays them. + use crate::audio::SAMPLE_RATE; use crate::error::{AudioError, AudioStream}; use crate::network::VoiceStreamType; @@ -79,8 +80,8 @@ impl ClientStream { /// Since we support [f32], [i16] and [u16] we need some way of adding two values /// without peaking above/below the edge values. This trait ensures that we can /// use all three primitive types as a generic parameter. - pub trait SaturatingAdd { + /// Adds two values in some saturating way. See trait documentation. fn saturating_add(self, rhs: Self) -> Self; } -- cgit v1.2.1 From 17feef9da27aa7740c1b553a8ac331d10a1a391c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 13:26:08 +0200 Subject: default audio ouput device --- mumd/src/audio/output.rs | 1 + 1 file changed, 1 insertion(+) (limited to 'mumd/src') diff --git a/mumd/src/audio/output.rs b/mumd/src/audio/output.rs index 3c00116..597dcf0 100644 --- a/mumd/src/audio/output.rs +++ b/mumd/src/audio/output.rs @@ -115,6 +115,7 @@ pub trait AudioOutputDevice { fn client_streams(&self) -> Arc>; } +/// The default audio output device, as determined by [cpal]. pub struct DefaultAudioOutputDevice { config: StreamConfig, stream: cpal::Stream, -- cgit v1.2.1 From 1aec4a2385cc134ffd189e122f8b77c975e3dcb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Tue, 15 Jun 2021 13:29:58 +0200 Subject: better curry callback --- mumd/src/audio/output.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'mumd/src') diff --git a/mumd/src/audio/output.rs b/mumd/src/audio/output.rs index 597dcf0..a3ce064 100644 --- a/mumd/src/audio/output.rs +++ b/mumd/src/audio/output.rs @@ -228,7 +228,8 @@ impl AudioOutputDevice for DefaultAudioOutputDevice { } } -/// Over-engineered way of handling multiple types of samples. +/// Returns a function that fills a buffer with audio from client streams +/// modified according to some audio configuration. pub fn curry_callback( user_bufs: Arc>, output_volume_receiver: watch::Receiver, -- cgit v1.2.1