sim-lib-audio-graph-live 0.2.0

Preallocated live audio graph runner for host callback integration.
Documentation 
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

use sim_lib_audio_graph_core::{PrepareConfig, ProcessBlock, Processor};

use crate::{LiveGraphConfig, LivePlacedNode, LivePlacementSite, LiveTransportClock};

#[derive(Clone, Copy, Debug)]
struct GainProcessor {
    gain: f32,
    realtime_pin: bool,
}

impl GainProcessor {
    fn portable(gain: f32) -> Self {
        Self {
            gain,
            realtime_pin: false,
        }
    }

    fn pinned(gain: f32) -> Self {
        Self {
            gain,
            realtime_pin: true,
        }
    }
}

impl Processor for GainProcessor {
    fn prepare(&mut self, _cfg: PrepareConfig) {}

    fn reset(&mut self) {}

    fn process(&mut self, block: &mut ProcessBlock<'_>) {
        let frames = block.frames as usize;
        for (input, output) in block.in_audio.iter().zip(block.out_audio.iter_mut()) {
            for (source, target) in input.iter().zip(output.iter_mut()).take(frames) {
                *target = *source * self.gain;
            }
        }
    }

    fn realtime_pin(&self) -> bool {
        self.realtime_pin
    }
}

#[test]
fn local_site_names_are_recorded() {
    let names = LivePlacementSite::all()
        .iter()
        .map(|site| site.name())
        .collect::<Vec<_>>();
    let symbols = LivePlacementSite::all()
        .iter()
        .map(|site| site.symbol().as_qualified_str())
        .collect::<Vec<_>>();

    assert_eq!(names, ["coroutine", "thread", "host-callback", "process"]);
    assert_eq!(
        symbols,
        [
            "stream/site/coroutine",
            "stream/site/thread",
            "stream/site/host-callback",
            "stream/site/process"
        ]
    );
}

#[test]
fn coroutine_thread_and_process_sites_render_deterministically() {
    let coroutine = render_at_site(LivePlacementSite::Coroutine);
    let thread = render_at_site(LivePlacementSite::Thread);
    let process = render_at_site(LivePlacementSite::Process);

    assert_eq!(coroutine, [0.5, -0.5, 0.25, -0.25]);
    assert_eq!(thread, coroutine);
    assert_eq!(process, coroutine);
}

#[test]
fn realtime_pinned_nodes_stay_on_host_callback_site() {
    let config = LiveGraphConfig::stereo(48_000, 4).unwrap();
    let host = LivePlacedNode::new(
        GainProcessor::pinned(1.0),
        config,
        LivePlacementSite::HostCallback,
    )
    .unwrap();
    assert_eq!(host.site(), LivePlacementSite::HostCallback);

    for site in [
        LivePlacementSite::Coroutine,
        LivePlacementSite::Thread,
        LivePlacementSite::Process,
    ] {
        let err = LivePlacedNode::new(GainProcessor::pinned(1.0), config, site).unwrap_err();
        assert!(err.to_string().contains("realtime-pinned"));
        assert!(err.to_string().contains(site.name()));
    }
}

#[test]
fn process_site_keeps_preallocated_steady_state_capacity() {
    let config = LiveGraphConfig::stereo(48_000, 4).unwrap();
    let mut node = LivePlacedNode::new(
        GainProcessor::portable(0.25),
        config,
        LivePlacementSite::Process,
    )
    .unwrap();
    let before = node.steady_state_snapshot();
    let input = [1.0, -1.0, 0.5, -0.5];
    let mut output = [0.0; 4];
    let transport = LiveTransportClock::sample_frame(48_000)
        .unwrap()
        .transport_at(0, true);

    node.process_interleaved_f32(Some(&input), &mut output, 2, transport)
        .unwrap();
    node.process_interleaved_f32(Some(&input), &mut output, 2, transport)
        .unwrap();

    assert_eq!(node.steady_state_snapshot(), before);
    assert_eq!(before.process_request_ring().unwrap().allocated_slots(), 1);
    assert_eq!(before.process_response_ring().unwrap().allocated_slots(), 1);
}

fn render_at_site(site: LivePlacementSite) -> [f32; 4] {
    let config = LiveGraphConfig::stereo(48_000, 4).unwrap();
    let mut node = LivePlacedNode::new(GainProcessor::portable(0.5), config, site).unwrap();
    let mut output = [0.0; 4];
    node.process_interleaved_f32(
        Some(&[1.0, -1.0, 0.5, -0.5]),
        &mut output,
        2,
        LiveTransportClock::sample_frame(48_000)
            .unwrap()
            .transport_at(128, true),
    )
    .unwrap();
    output
}