dsp-chain 0.13.1

Provides a Node trait and a Graph type for chaining together audio generators/processors in a dsp graph.
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

use {Frame, Sample};

/// Types to be used as a **Node** within the DSP **Graph**.
pub trait Node<F> where F: Frame {

    /// Request audio from the **Node** given some `sample_hz` (aka sample rate in hertz).
    /// If the **Node** has no inputs, the `buffer` will be zeroed.
    /// If the **Node** has some inputs, the `buffer` will consist of the inputs summed together.
    ///
    /// Any source/generator type nodes should simply render straight to the buffer.
    /// Any effects/processor type nodes should mutate the buffer directly.
    fn audio_requested(&mut self, buffer: &mut [F], sample_hz: f64);

    /// Following the call to the `Node`'s `audio_requested` method, the `Graph` will sum together
    /// some of the original (dry) signal with some of the processed (wet) signal.
    ///
    /// This method specifies the amount of the dry signal to be used (0.0 ... 1.0).
    ///
    /// By default, we don't want any of the original signal. This default is useful for generator
    /// types, where the original signal is often 0.0 anyway.
    ///
    /// For processors and effects, this should be overridden to return the amount of the
    /// non-processed signal that should be summed with the processed.
    ///
    /// Note: overriding this method will be more efficient than implementing your own dry/wet
    /// summing in audio_requested, as `Graph` reserves a single buffer especially for this.
    fn dry(&self) -> <F::Sample as Sample>::Float { Sample::equilibrium() }

    /// Following the call to the `Node`'s `audio_requested` method, the `Graph` will sum together
    /// some of the original (dry) signal with some of the processed (wet) signal.
    ///
    /// This method specifies the amount of the wet signal to be used (0.0 ... 1.0).
    ///
    /// By default, we want only the fully wet signal (1.0). This default is useful for generator
    /// types where we are generating a brand new signal.
    ///
    /// For processors and effects, this should be overridden to return the amount of the processed
    /// signal that should be summed with the non-processed.
    ///
    /// Note: overriding this method will be more efficient than implementing your own dry/wet
    /// summing in audio_requested, as `Graph` reserves a single buffer especially for this.
    fn wet(&self) -> <F::Sample as Sample>::Float { <F::Sample as Sample>::identity() }

}

impl<F> Node<F> for Box<Node<F>> where F: Frame {
    #[inline]
    fn audio_requested(&mut self, buffer: &mut [F], sample_hz: f64) {
        (**self).audio_requested(buffer, sample_hz);
    }
    #[inline]
    fn dry(&self) -> <F::Sample as Sample>::Float {
        (**self).dry()
    }
    #[inline]
    fn wet(&self) -> <F::Sample as Sample>::Float {
        (**self).wet()
    }
}