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

//! Ergonomic builder frontend. It only assembles a GraphSpec — it never executes.
//! Compilation (Wave 4) and execution (Wave 6) consume the spec downstream.

use crate::graph::node::{NodeConfig, NodeTypeId};
use crate::graph::ports::EdgeContract;
use crate::graph::spec::{
    EdgeId, EdgeSpec, GraphSpec, InputPortRef, NodeId, NodeSpec, OutputPortRef,
};

pub struct NodeHandle {
    id: NodeId,
}

impl NodeHandle {
    pub fn id(&self) -> NodeId {
        self.id
    }
    pub fn out(&self, port: &str) -> OutputPortRef {
        OutputPortRef {
            node: self.id,
            port: port.to_owned(),
        }
    }
    pub fn in_(&self, port: &str) -> InputPortRef {
        InputPortRef {
            node: self.id,
            port: port.to_owned(),
        }
    }
}

#[derive(Default)]
pub struct Pipeline {
    spec: GraphSpec,
    next_node: u32,
    next_edge: u32,
}

impl Pipeline {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn add_node(&mut self, type_id: impl Into<NodeTypeId>, config: NodeConfig) -> NodeHandle {
        let id = NodeId(self.next_node);
        self.next_node += 1;
        self.spec.nodes.push(NodeSpec {
            id,
            type_id: type_id.into(),
            config,
        });
        NodeHandle { id }
    }

    pub fn connect(&mut self, from: OutputPortRef, to: InputPortRef) -> EdgeId {
        self.push_edge(from, to, None)
    }

    pub fn connect_with(
        &mut self,
        from: OutputPortRef,
        to: InputPortRef,
        contract: EdgeContract,
    ) -> EdgeId {
        self.push_edge(from, to, Some(contract))
    }

    fn push_edge(
        &mut self,
        from: OutputPortRef,
        to: InputPortRef,
        requested: Option<EdgeContract>,
    ) -> EdgeId {
        let id = EdgeId(self.next_edge);
        self.next_edge += 1;
        self.spec.edges.push(EdgeSpec {
            id,
            from,
            to,
            requested,
        });
        id
    }

    #[cfg(any(test, feature = "internal-testing"))]
    pub fn spec(&self) -> &GraphSpec {
        &self.spec
    }

    pub fn into_spec(self) -> GraphSpec {
        self.spec
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn given_two_added_nodes_when_into_spec_then_specs_are_preserved_with_distinct_ids() {
        let mut graph = Pipeline::new();
        let mic = graph.add_node("source.mic", NodeConfig::new());
        let gain = graph.add_node("gain", NodeConfig::new().with("gain_db", "-6.0"));
        assert_ne!(mic.id(), gain.id());

        let spec = graph.into_spec();
        assert_eq!(spec.node_count(), 2);
        assert_eq!(spec.nodes[0].type_id.as_str(), "source.mic");
        assert_eq!(spec.nodes[1].type_id.as_str(), "gain");
        assert_eq!(spec.nodes[1].config.get("gain_db"), Some("-6.0"));
    }

    #[test]
    fn given_connected_nodes_when_into_spec_then_edge_records_endpoints() {
        let mut graph = Pipeline::new();
        let mic = graph.add_node("source.mic", NodeConfig::new());
        let gain = graph.add_node("gain", NodeConfig::new().with("gain_db", "0.0"));
        let edge = graph.connect(mic.out("audio"), gain.in_("audio"));
        assert_eq!(edge.index(), 0);

        let spec = graph.into_spec();
        assert_eq!(spec.edge_count(), 1);
        assert_eq!(spec.edges[0].from.node, mic.id());
        assert_eq!(spec.edges[0].to.node, gain.id());
        assert!(spec.edges[0].requested.is_none());
    }

    #[test]
    fn given_connect_with_contract_when_into_spec_then_edge_carries_requested_contract() {
        let mut graph = Pipeline::new();
        let a = graph.add_node("source.mic", NodeConfig::new());
        let b = graph.add_node("sink.browser", NodeConfig::new());
        graph.connect_with(
            a.out("audio"),
            b.in_("audio"),
            EdgeContract::realtime_audio(),
        );

        let spec = graph.into_spec();
        assert!(spec.edges[0].requested.is_some());
    }
}