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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
use std::{
collections::VecDeque,
sync::{
atomic::{AtomicI64, AtomicUsize, Ordering},
Arc, RwLock,
},
thread::{self, JoinHandle},
time::{Duration, Instant},
};
use crossbeam_channel::{unbounded, Receiver};
use crate::AudioStreamParams;
use super::AudioPipe;
/// Holds the statistics for an instance of BufferedRenderer.
#[derive(Debug, Clone)]
struct BufferedRendererStats {
samples: Arc<AtomicI64>,
last_samples_after_read: Arc<AtomicI64>,
last_request_samples: Arc<AtomicI64>,
render_time: Arc<RwLock<VecDeque<f64>>>,
render_size: Arc<AtomicUsize>,
}
/// Reads the statistics of an instance of BufferedRenderer in a usable way.
pub struct BufferedRendererStatsReader {
stats: BufferedRendererStats,
}
impl BufferedRendererStatsReader {
/// The number of samples currently buffered.
/// Can be negative if the reader is waiting for more samples.
pub fn samples(&self) -> i64 {
self.stats.samples.load(Ordering::Relaxed)
}
/// The number of samples that were in the buffer after the last read.
pub fn last_samples_after_read(&self) -> i64 {
self.stats.last_samples_after_read.load(Ordering::Relaxed)
}
/// The last number of samples last requested by the read command.
pub fn last_request_samples(&self) -> i64 {
self.stats.last_request_samples.load(Ordering::Relaxed)
}
/// The number of samples to render each iteration.
pub fn render_size(&self) -> usize {
self.stats.render_size.load(Ordering::Relaxed)
}
/// The average render time percentages (0 to 1)
/// of how long the render thread spent rendering, from the max allowed time.
pub fn average_renderer_load(&self) -> f64 {
let queue = self.stats.render_time.read().unwrap();
let total = queue.len();
queue.iter().sum::<f64>() / total as f64
}
/// The last render time percentage (0 to 1)
/// of how long the render thread spent rendering, from the max allowed time.
pub fn last_renderer_load(&self) -> f64 {
let queue = self.stats.render_time.read().unwrap();
*queue.front().unwrap_or(&0.0)
}
}
/// The helper struct for deferred sample rendering.
/// Helps avoid stutter when the render time is exceding the max time allowed by the audio driver.
///
/// Instead, it renders in a separate thread with much smaller sample sizes, causing a minimal impact on latency
/// while allowing more time to render per sample.
///
/// Designed to be used in realtime playback only.
pub struct BufferedRenderer {
stats: BufferedRendererStats,
/// The receiver for samples (the render thread has the sender).
receive: Receiver<Vec<f32>>,
/// Remainder of samples from the last received samples vec.
remainder: Vec<f32>,
/// Whether the render thread should be killed.
killed: Arc<RwLock<bool>>,
/// The thread handle to wait for at the end.
thread_handle: Option<JoinHandle<()>>,
stream_params: AudioStreamParams,
}
impl BufferedRenderer {
/// Creates a new instance of BufferedRenderer.
///
/// - `render`: An object implementing the AudioPipe struct for BufferedRenderer to
/// read samples from
/// - `stream_params`: Parameters of the output audio
/// - `render_size`: The number of samples to render each iteration
pub fn new<F: 'static + AudioPipe + Send>(
mut render: F,
stream_params: AudioStreamParams,
render_size: usize,
) -> Self {
let (tx, rx) = unbounded();
let samples = Arc::new(AtomicI64::new(0));
let last_request_samples = Arc::new(AtomicI64::new(0));
let render_size = Arc::new(AtomicUsize::new(render_size));
let last_samples_after_read = Arc::new(AtomicI64::new(0));
let render_time = Arc::new(RwLock::new(VecDeque::new()));
let killed = Arc::new(RwLock::new(false));
let thread_handle = {
let samples = samples.clone();
let last_request_samples = last_request_samples.clone();
let render_size = render_size.clone();
let render_time = render_time.clone();
let killed = killed.clone();
thread::Builder::new()
.name("xsynth_buffered_rendering".to_string())
.spawn(move || loop {
let size = render_size.load(Ordering::SeqCst);
// The expected render time per iteration. It is slightly smaller (*90/100) than
// the real time so the render thread can catch up if it's behind.
let delay =
Duration::from_secs(1) * size as u32 / stream_params.sample_rate * 90 / 100;
// If the render thread is ahead by over ~10%, wait until more samples are required.
loop {
let samples = samples.load(Ordering::SeqCst);
let last_requested = last_request_samples.load(Ordering::SeqCst);
if samples > last_requested * 110 / 100 {
spin_sleep::sleep(delay / 10);
} else {
break;
}
if *killed.read().unwrap() {
return;
}
}
let start = Instant::now();
let end = start + delay;
// Create the vec and write the samples
let mut vec =
vec![Default::default(); size * stream_params.channels.count() as usize];
render.read_samples(&mut vec);
// Send the samples, break if the pipe is broken
samples.fetch_add(vec.len() as i64, Ordering::SeqCst);
match tx.send(vec) {
Ok(_) => {}
Err(_) => break,
};
// Write the elapsed render time percentage to the render_time queue
{
let mut queue = render_time.write().unwrap();
let elaspsed = start.elapsed().as_secs_f64();
let total = delay.as_secs_f64();
queue.push_front(elaspsed / total);
if queue.len() > 100 {
queue.pop_back();
}
}
// Sleep until the next iteration
let now = Instant::now();
if end > now {
spin_sleep::sleep(end - now);
}
})
.unwrap()
};
Self {
stats: BufferedRendererStats {
samples,
last_request_samples,
render_time,
render_size,
last_samples_after_read,
},
receive: rx,
remainder: Vec::new(),
stream_params,
thread_handle: Some(thread_handle),
killed,
}
}
/// Reads samples from the remainder and the output queue into the destination array.
pub fn read(&mut self, dest: &mut [f32]) {
dest.fill(0.0);
let mut i: usize = 0;
let len = dest.len().min(self.remainder.len());
let samples = self
.stats
.samples
.fetch_sub(dest.len() as i64, Ordering::SeqCst);
self.stats
.last_request_samples
.store(dest.len() as i64, Ordering::SeqCst);
// Read from current remainder
for r in self.remainder.drain(0..len) {
dest[i] = r;
i += 1;
}
// Read from output queue, leave the remainder if there is any
while self.remainder.is_empty() {
let mut buf = self.receive.recv().unwrap();
let len = buf.len().min(dest.len() - i);
for r in buf.drain(0..len) {
dest[i] = r;
i += 1;
}
self.remainder = buf;
}
self.stats
.last_samples_after_read
.store(samples, Ordering::Relaxed);
}
/// Sets the number of samples that should be rendered each iteration.
pub fn set_render_size(&self, size: usize) {
self.stats.render_size.store(size, Ordering::SeqCst);
}
/// Returns a statistics reader.
/// See the `BufferedRendererStatsReader` documentation for more information.
pub fn get_buffer_stats(&self) -> BufferedRendererStatsReader {
BufferedRendererStatsReader {
stats: self.stats.clone(),
}
}
}
impl Drop for BufferedRenderer {
fn drop(&mut self) {
*self.killed.write().unwrap() = true;
self.thread_handle.take().unwrap().join().unwrap();
}
}
impl AudioPipe for BufferedRenderer {
fn stream_params(&self) -> &'_ AudioStreamParams {
&self.stream_params
}
fn read_samples_unchecked(&mut self, to: &mut [f32]) {
self.read(to)
}
}