rill-core-dsp 0.5.0-beta.6

Core DSP abstractions and algorithms for Rill
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

//! Macro for creating a generator
//!
//! # Example
//! use rill_core_dsp::generator_algorithm;
//! use rill_core::math::Transcendental;
//!
//! generator_algorithm! {
//!     /// Sine generator
//!     #[derive(Debug, Clone, Copy)]
//!     pub struct SineGen<T: Transcendental> {
//!         params: {
//!             freq: T = T::from_f32(440.0),
//!             amp: T = T::from_f32(0.5),
//!         },
//!         state: {
//!             phase: T = T::ZERO,
//!         },
//!         generate: |this| {
//!             let output = (this.phase * T::from_f32(2.0 * std::f32::consts::PI)).sin() * this.amp;
//!             let phase_inc = this.freq / T::from_f32(this.sample_rate);
//!             this.phase = (this.phase + phase_inc) % T::from_f32(1.0);
//!             output
//!         }
//!     }
//! }

/// Macro for creating a generator
///
/// # Example
/// use rill_core_dsp::generator_algorithm;
/// use rill_core::math::Transcendental;
///
/// generator_algorithm! {
///     /// Sine generator
///     #[derive(Debug, Clone, Copy)]
///     pub struct SineGen<T: Transcendental> {
///         params: {
///             freq: T = T::from_f32(440.0),
///             amp: T = T::from_f32(0.5),
///         },
///         state: {
///             phase: T = T::ZERO,
///         },
///         generate: |this| {
///             let output = (this.phase * T::from_f32(2.0 * std::f32::consts::PI)).sin() * this.amp;
///             let phase_inc = this.freq / T::from_f32(this.sample_rate);
///             this.phase = (this.phase + phase_inc) % T::from_f32(1.0);
///             output
///         }
///     }
/// }
#[macro_export]
macro_rules! generator_algorithm {
    (
        $(#[$struct_meta:meta])*
        $vis:vis struct $name:ident<$($generic:ident: $bound:path),+> {
            params: {
                $(
                    $(#[$param_meta:meta])*
                    $param_name:ident : $param_type:ty = $param_default:expr
                ),* $(,)?
            },
            state: {
                $(
                    $(#[$state_meta:meta])*
                    $state_name:ident : $state_type:ty = $state_default:expr
                ),* $(,)?
            },
            generate: $generate:expr
        }
    ) => {
        $(#[$struct_meta])*
        $vis struct $name<$($generic: $bound),+> {
            $(
                $(#[$param_meta])*
                pub $param_name: $param_type,
            )*

            $(
                $(#[$state_meta])*
                pub $state_name: $state_type,
            )*

            /// Sample rate
            pub sample_rate: f32,
        }

        impl<$($generic: $bound),+> $name<$($generic),+> {
            /// Create a new generator instance
            pub fn new($($param_name: $param_type),*) -> Self {
                Self {
                    $($param_name),*,
                    $($state_name: $state_default),*,
                    sample_rate: 44100.0,
                }
            }
        }

        impl<$($generic: $bound),+> rill_core::traits::algorithm::Algorithm<T> for $name<$($generic),+>
        where
            T: rill_core::math::Transcendental,
        {
            fn init(&mut self, sample_rate: f32) {
                self.sample_rate = sample_rate;
            }

            fn reset(&mut self) {
                $(
                    self.$state_name = $state_default;
                )*
            }

            fn process(
                &mut self,
                _input: Option<&[T]>,
                output: &mut [T],
            ) -> rill_core::traits::ProcessResult<()> {
                let generate_fn: fn(&mut Self) -> T = $generate;
                for out in output.iter_mut() {
                    *out = generate_fn(self);
                }
                Ok(())
            }

            fn metadata(&self) -> rill_core::traits::algorithm::AlgorithmMetadata {
                rill_core::traits::algorithm::AlgorithmMetadata {
                    name: stringify!($name),
                    category: rill_core::traits::algorithm::AlgorithmCategory::Generator,
                    description: stringify!($name),
                    author: "Rill",
                    version: env!("CARGO_PKG_VERSION"),
                }
            }
        }
    };
}