Struct OfflineRenderer 

pub struct OfflineRenderer { /* private fields */ }

The engine’s synthesiser with no audio device behind it.

It runs exactly the code the real-time thread runs (the same sources, filters, ducking, reverb and limiter), but you pull the samples out yourself. Use it to bounce sounds to a WAV file with crate::audio::wav::write_wav, to render audio for a captured video, or to test sound design on a machine with no sound card.

use proof_engine::audio::{AudioEvent, OfflineRenderer};
use proof_engine::audio::math_source::MathAudioSource;
use proof_engine::prelude::Vec3;

let mut synth = OfflineRenderer::new(48_000);
synth.emit(AudioEvent::SpawnSource {
    source: MathAudioSource::death_knell(Vec3::ZERO),
    position: Vec3::ZERO,
});
let stereo = synth.render(0.5);
assert_eq!(stereo.len(), 2 * 24_000);
assert!(stereo.iter().any(|s| s.abs() > 0.01));

Implementations

impl OfflineRenderer

pub fn new(sample_rate: u32) -> Self

A silent synthesiser running at sample_rate Hz.

pub fn with_seed(sample_rate: u32, seed: u32) -> Self

As new, with the seed of the noise generators, for renders that must differ from each other.

pub fn emit(&mut self, event: AudioEvent)

Queue an event. It takes effect at the start of the next render, as events do at the start of each buffer on the real-time thread.

pub fn render(&mut self, secs: f32) -> Vec<f32>

Render secs seconds as interleaved stereo (left, right, left, …), each sample in [-1, 1].

pub fn render_frames(&mut self, frames: usize) -> Vec<f32>

Render exactly frames stereo frames, interleaved.

pub fn sample_rate(&self) -> u32

The sample rate this renderer was made with.

pub fn time(&self) -> f32

Seconds of audio rendered so far.

pub fn active_sources(&self) -> usize

Sources still sounding (effects that have not ended, plus music).