pocketstation 1.0.0

Source-aware desktop audio Session SDK
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

use assert_no_alloc::{assert_no_alloc, AllocDisabler};
use pocketstation::internal::frame::{
    AudioBufferHandle, AudioBufferPool, AudioFrame, ClockDomainId, FrameLineage,
    LineagedAudioFrame, SampleFormat, SampleSpec, SessionId, SourceId, StemId, StreamId,
};
use pocketstation::internal::graph::compiler::Compiler;
use pocketstation::internal::graph::dsl::Pipeline;
use pocketstation::internal::graph::node::{NodeConfig, PrepareContext};
use pocketstation::internal::graph::planner::RuntimePlanner;
use pocketstation::internal::graph::register_builtins;
use pocketstation::internal::graph::registry::NodeRegistry;
use pocketstation::internal::runtime::{
    plan_source_channel, PlanEdgeRouter, PlanRunnerCancellation, PlanSourceSendOutcome,
    RealtimePlanExecutor, RealtimePlanRunner,
};

#[global_allocator]
static ALLOCATOR: AllocDisabler = AllocDisabler;

fn with_lineage(frame: AudioFrame) -> LineagedAudioFrame {
    let lineage = FrameLineage::try_new(
        SessionId::new(42),
        frame.source_id(),
        StemId::new(frame.source_id().get()),
        ClockDomainId::new(3),
        frame.sequence_number(),
        frame.timestamp_ns(),
        20_000_000,
        4,
        5,
        6,
    )
    .unwrap();
    LineagedAudioFrame::new(frame, lineage).unwrap()
}

fn audio_frame(
    stream_id: StreamId,
    source_id: SourceId,
    sequence_number: u64,
    timestamp_ns: u64,
    buffer: AudioBufferHandle,
) -> AudioFrame {
    AudioFrame::try_new(
        stream_id,
        source_id,
        sequence_number,
        timestamp_ns,
        SampleSpec::new(48_000, 1, SampleFormat::F32Interleaved),
        buffer,
    )
    .unwrap()
}

#[test]
fn given_preallocated_three_edge_router_when_frame_dispatched_then_no_heap_allocation_occurs() {
    // Given
    let mut registry = NodeRegistry::new();
    register_builtins(&mut registry).unwrap();
    let mut graph = Pipeline::new();
    let source = graph.add_node("passthrough", NodeConfig::new());
    let source_id = source.id();
    for _ in 0..3 {
        let sink = graph.add_node("passthrough", NodeConfig::new());
        graph.connect(source.out("out"), sink.in_("in"));
    }
    let ir = Compiler::new()
        .compile(graph.into_spec(), &registry)
        .unwrap();
    let plan = RuntimePlanner::new().plan(&ir).unwrap();
    let (mut router, _receivers) = PlanEdgeRouter::new(&plan, &ir).unwrap();
    let pool = AudioBufferPool::new(1, 2);
    let mut buffer = pool.acquire().unwrap();
    buffer.try_copy_from_slice(&[0.25, -0.5]).unwrap();
    let frame = with_lineage(audio_frame(
        StreamId::new(1),
        SourceId::new(2),
        3,
        4,
        buffer,
    ));

    // When
    let summary = assert_no_alloc(|| router.dispatch_from(source_id, "out", frame, 5));

    // Then
    assert_eq!(summary.enqueued_edges, 3);
    assert_eq!(summary.dropped_edges, 0);
}

#[test]
fn given_prepared_realtime_plan_when_connected_nodes_execute_then_no_heap_allocation_occurs() {
    // Given
    let mut registry = NodeRegistry::new();
    register_builtins(&mut registry).unwrap();
    let mut graph = Pipeline::new();
    let source = graph.add_node("passthrough", NodeConfig::new());
    let source_id = source.id();
    for _ in 0..3 {
        let sink = graph.add_node("passthrough", NodeConfig::new());
        graph.connect(source.out("out"), sink.in_("in"));
    }
    let ir = Compiler::new()
        .compile(graph.into_spec(), &registry)
        .unwrap();
    let plan = RuntimePlanner::new().plan(&ir).unwrap();
    let context = PrepareContext::new(pocketstation::internal::frame::SampleSpec::new(
        48_000,
        1,
        pocketstation::internal::frame::SampleFormat::F32Interleaved,
    ));
    let (mut executor, workers) =
        RealtimePlanExecutor::new(&plan, &ir, &registry, &context).unwrap();
    assert!(workers.is_empty());
    let pool = AudioBufferPool::new(1, 2);
    let mut buffer = pool.acquire().unwrap();
    buffer.try_copy_from_slice(&[0.25, -0.5]).unwrap();
    let frame = with_lineage(audio_frame(
        StreamId::new(1),
        SourceId::new(2),
        3,
        4,
        buffer,
    ));

    // When
    let summary = assert_no_alloc(|| executor.execute_from(source_id, frame, 5)).unwrap();

    // Then
    assert_eq!(summary.nodes_executed, 4);
    assert_eq!(summary.edges_enqueued, 3);
    assert_eq!(summary.edges_dropped, 0);
}

#[test]
fn given_prepared_multi_source_runner_when_ready_frames_process_then_no_heap_allocation_occurs() {
    // Given
    let mut registry = NodeRegistry::new();
    register_builtins(&mut registry).unwrap();
    let mut graph = Pipeline::new();
    let first_source = graph.add_node("passthrough", NodeConfig::new());
    let second_source = graph.add_node("passthrough", NodeConfig::new());
    let first_sink = graph.add_node("passthrough", NodeConfig::new());
    let second_sink = graph.add_node("passthrough", NodeConfig::new());
    graph.connect(first_source.out("out"), first_sink.in_("in"));
    graph.connect(second_source.out("out"), second_sink.in_("in"));
    let ir = Compiler::new()
        .compile(graph.into_spec(), &registry)
        .unwrap();
    let plan = RuntimePlanner::new().plan(&ir).unwrap();
    let context = PrepareContext::new(pocketstation::internal::frame::SampleSpec::new(
        48_000,
        1,
        pocketstation::internal::frame::SampleFormat::F32Interleaved,
    ));
    let (executor, workers) = RealtimePlanExecutor::new(&plan, &ir, &registry, &context).unwrap();
    assert!(workers.is_empty());
    let cancellation = PlanRunnerCancellation::new();
    let (mut first_sender, first_input) =
        plan_source_channel(first_source.id(), 1, cancellation.clone()).unwrap();
    let (mut second_sender, second_input) =
        plan_source_channel(second_source.id(), 1, cancellation.clone()).unwrap();
    let mut runner =
        RealtimePlanRunner::new(executor, vec![first_input, second_input], cancellation).unwrap();
    let first_pool = AudioBufferPool::new(1, 2);
    let second_pool = AudioBufferPool::new(1, 2);
    let mut first_buffer = first_pool.acquire().unwrap();
    let mut second_buffer = second_pool.acquire().unwrap();
    first_buffer.try_copy_from_slice(&[0.25, -0.5]).unwrap();
    second_buffer.try_copy_from_slice(&[-0.25, 0.5]).unwrap();
    assert!(matches!(
        first_sender.try_send(with_lineage(audio_frame(
            StreamId::new(1),
            SourceId::new(1),
            1,
            1,
            first_buffer,
        ))),
        PlanSourceSendOutcome::Enqueued
    ));
    assert!(matches!(
        second_sender.try_send(with_lineage(audio_frame(
            StreamId::new(2),
            SourceId::new(2),
            1,
            1,
            second_buffer,
        ))),
        PlanSourceSendOutcome::Enqueued
    ));

    // When
    let summary = assert_no_alloc(|| runner.process_ready(2)).unwrap();

    // Then
    assert_eq!(summary.source_frames_processed_total, 2);
    assert_eq!(summary.execution.nodes_executed, 4);
    assert_eq!(summary.execution.edges_enqueued, 2);
    assert_eq!(summary.execution.edges_dropped, 0);
}