1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
use std::error::Error;
use crate::buffer::{AudioBuffer, AudioBufferOptions};
use crate::media::MediaStream;
use crate::RENDER_QUANTUM_SIZE;
use crate::context::AudioContextOptions;
use crossbeam_channel::Sender;
use crate::buffer::ChannelData;
use crate::io::{self, AudioBackendManager};
use crossbeam_channel::{Receiver, TryRecvError};
/// Microphone input stream
///
/// The Microphone can set up a [`MediaStream`](crate::media::MediaStream) value which can be used
/// inside a [`MediaStreamAudioSourceNode`](crate::node::MediaStreamAudioSourceNode).
///
/// It is okay for the Microphone struct to go out of scope, any corresponding stream will still be
/// kept alive and emit audio buffers. Call the `close()` method if you want to stop the microphone
/// input and release all system resources.
///
/// # Warning
///
/// This abstraction is not part of the Web Audio API and does not aim at implementing
/// the full MediaDevices API. It is only provided for convenience reasons.
///
/// # Example
///
/// ```no_run
/// use web_audio_api::context::{BaseAudioContext, AudioContext};
/// use web_audio_api::context::{AudioContextLatencyCategory, AudioContextOptions};
/// use web_audio_api::media::Microphone;
/// use web_audio_api::node::AudioNode;
///
/// let context = AudioContext::default();
///
/// // Request an input sample rate of 44.1 kHz and default latency (buffer size 128, if available)
/// let opts = AudioContextOptions {
/// sample_rate: Some(44100.),
/// ..AudioContextOptions::default()
/// };
/// let mic = Microphone::new(opts);
/// // or you can create Microphone with default options
/// // let stream = Microphone::default();
///
/// // register as media element in the audio context
/// let background = context.create_media_stream_source(mic.stream());
/// // connect the node directly to the destination node (speakers)
/// background.connect(&context.destination());
///
/// // enjoy listening
/// std::thread::sleep(std::time::Duration::from_secs(4));
/// ```
pub struct Microphone {
receiver: Receiver<AudioBuffer>,
number_of_channels: usize,
sample_rate: f32,
backend: Box<dyn AudioBackendManager>,
}
impl Microphone {
/// Setup the default microphone input stream
///
/// Note: the specified `latency_hint` is currently ignored, follow our progress at
/// <https://github.com/orottier/web-audio-api-rs/issues/51>
pub fn new(options: AudioContextOptions) -> Self {
// select backend based on cargo features
let (backend, receiver) = io::build_input(options);
Self {
receiver,
number_of_channels: backend.number_of_channels(),
sample_rate: backend.sample_rate(),
backend,
}
}
/// Suspends the input stream, temporarily halting audio hardware access and reducing
/// CPU/battery usage in the process.
///
/// # Panics
///
/// Will panic if:
///
/// * The input device is not available
/// * For a `BackendSpecificError`
pub fn suspend(&self) {
self.backend.suspend();
}
/// Resumes the input stream that has previously been suspended/paused.
///
/// # Panics
///
/// Will panic if:
///
/// * The input device is not available
/// * For a `BackendSpecificError`
pub fn resume(&self) {
self.backend.resume();
}
/// Closes the microphone input stream, releasing the system resources being used.
#[allow(clippy::missing_panics_doc)]
pub fn close(self) {
self.backend.close()
}
/// A [`MediaStream`] iterator producing audio buffers from the microphone input
///
/// Note that while you can call this function multiple times and poll all iterators
/// concurrently, this could lead to unexpected behavior as the buffers will only be offered
/// once.
pub fn stream(&self) -> impl MediaStream {
MicrophoneStream {
receiver: self.receiver.clone(),
number_of_channels: self.number_of_channels,
sample_rate: self.sample_rate,
_stream: self.backend.boxed_clone(),
}
}
}
impl Default for Microphone {
fn default() -> Self {
Self::new(AudioContextOptions::default())
}
}
// no need for public documentation because the concrete type is never returned (an impl
// MediaStream is returned instead)
#[doc(hidden)]
pub struct MicrophoneStream {
receiver: Receiver<AudioBuffer>,
number_of_channels: usize,
sample_rate: f32,
_stream: Box<dyn AudioBackendManager>,
}
impl Iterator for MicrophoneStream {
type Item = Result<AudioBuffer, Box<dyn Error + Send + Sync>>;
fn next(&mut self) -> Option<Self::Item> {
let next = match self.receiver.try_recv() {
Ok(buffer) => {
// new frame was ready
buffer
}
Err(TryRecvError::Empty) => {
// frame not received in time, emit silence
// log::debug!("input frame delayed");
let options = AudioBufferOptions {
number_of_channels: self.number_of_channels,
length: RENDER_QUANTUM_SIZE,
sample_rate: self.sample_rate,
};
AudioBuffer::new(options)
}
Err(TryRecvError::Disconnected) => {
// MicrophoneRender has stopped, close stream
return None;
}
};
Some(Ok(next))
}
}
pub(crate) struct MicrophoneRender {
number_of_channels: usize,
sample_rate: f32,
sender: Sender<AudioBuffer>,
}
impl MicrophoneRender {
pub fn new(number_of_channels: usize, sample_rate: f32, sender: Sender<AudioBuffer>) -> Self {
Self {
number_of_channels,
sample_rate,
sender,
}
}
pub fn render<S: crate::Sample>(&self, data: &[S]) {
let mut channels = Vec::with_capacity(self.number_of_channels);
// copy rendered audio into output slice
for i in 0..self.number_of_channels {
channels.push(ChannelData::from(
data.iter()
.skip(i)
.step_by(self.number_of_channels)
.map(|v| v.to_f32())
.collect(),
));
}
let buffer = AudioBuffer::from_channels(channels, self.sample_rate);
let result = self.sender.try_send(buffer); // can fail (frame dropped)
if result.is_err() {
log::debug!("input frame dropped");
}
}
}
impl Drop for MicrophoneRender {
fn drop(&mut self) {
log::debug!("Microphone input has been dropped");
}
}