summaryrefslogtreecommitdiff
path: root/src/lib.rs
blob: 23fffe203e4373c3116a6e1c6d400fdd684d01f2 (plain)
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
//! This crate implements a simple utility to make music as pure
//! numbers.

use std::{
    fmt::{self, Display, Formatter},
    ops::{Deref, DerefMut},
};

macro_rules! deftype {
    ($($x:ident),*) => {
        $(
            #[derive(Debug, Copy, Clone)]
            pub struct $x(f64);

            impl From<f64> for $x {
                fn from(n: f64) -> Self {
                    Self(n)
                }
            }

            impl Deref for $x {
                type Target = f64;

                fn deref(&self) -> &Self::Target {
                    &self.0
                }
            }

            impl DerefMut for $x {
                fn deref_mut(&mut self) -> &mut Self::Target {
                    &mut self.0
                }
            }
        )*
    };
}

deftype!(Volume, Samples, Hertz, Seconds, Pulse, BPM, Beats, Semitones);

impl Display for Semitones {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let translated = **self + 9f64;

        let quotient = translated.div_euclid(12f64) as i64;

        let octave_string = (quotient + 4).to_string();

        let remainder = translated.rem_euclid(12f64) as i64;

        // Due to round-off error, there is the possibility that the
        // remainder is equal to the divider's absolute value,
        // according to the official documentation, so one more
        // conversion is necessary.
        let remainder = if remainder == 12i64 { 0i64 } else { remainder };

        let note_string = match remainder {
            0i64 => String::from("C"),
            1i64 => String::from("C#"),
            2i64 => String::from("D"),
            3i64 => String::from("D#"),
            4i64 => String::from("E"),
            5i64 => String::from("F"),
            6i64 => String::from("F#"),
            7i64 => String::from("G"),
            8i64 => String::from("G#"),
            9i64 => String::from("A"),
            10i64 => String::from("A#"),
            11i64 => String::from("B"),
            _ => panic!("remainder not in the range [0, 11]: {remainder}"),
        };

        write!(f, "{note_string}{octave_string}")
    }
}

#[allow(clippy::derivable_impls)]
impl Default for Pulse {
    fn default() -> Self {
        Self(f64::default())
    }
}

#[derive(Debug, Clone, Default)]
pub struct Wave {
    pulses: Vec<Pulse>,
}

impl Wave {
    /// Construct a new wave
    pub fn new(pulses: Vec<Pulse>) -> Self {
        Self { pulses }
    }

    /// Return the vector contained inside it
    pub fn to_vec(self) -> Vec<Pulse> {
        self.pulses
    }
}

#[allow(dead_code)]
fn mix_waves_no_divide(waves: Vec<Wave>) -> Wave {
    let mut index = 0;

    let mut result_pulses = Vec::new();

    loop {
        let mut count = 0usize;
        let mut local_result = 0f64;

        for wave in waves.iter() {
            if index < wave.len() {
                local_result += *wave[index];
                count += 1;
            }
        }

        match count {
            0 => {
                break;
            }
            _ => {
                result_pulses.push(local_result.into());
            }
        }

        index += 1;
    }

    Wave::new(result_pulses)
}

#[allow(dead_code)]
fn mix_waves_exact(waves: Vec<Wave>) -> Wave {
    let mut index = 0;

    let mut result_pulses = Vec::new();

    let waves_len = waves.len();

    loop {
        let mut count = 0usize;
        let mut local_result = 0f64;

        for wave in waves.iter() {
            if index < wave.len() {
                local_result += *wave[index];
                count += 1;
            }
        }

        match count {
            0 => {
                break;
            }
            _ => {
                result_pulses.push((local_result / waves_len as f64).into());
            }
        }

        index += 1;
    }

    Wave::new(result_pulses)
}

#[allow(dead_code)]
fn mix_waves(waves: Vec<Wave>) -> Wave {
    let mut index = 0;

    let mut result_pulses = Vec::new();

    loop {
        let mut count = 0usize;
        let mut local_result = 0f64;

        for wave in waves.iter() {
            if index < wave.len() {
                local_result += *wave[index];
                count += 1;
            }
        }

        match count {
            0 => {
                break;
            }
            1 => {
                result_pulses.push(local_result.into());
            }
            _ => {
                result_pulses.push((local_result / count as f64).into());
            }
        }

        index += 1;
    }

    Wave::new(result_pulses)
}

impl Deref for Wave {
    type Target = [Pulse];

    fn deref(&self) -> &Self::Target {
        &self.pulses
    }
}

// The twelveth root of two.
const STD_BASE: Hertz = Hertz(1.059463094359295f64);

impl Default for Volume {
    fn default() -> Self {
        1f64.into()
    }
}

impl Default for BPM {
    fn default() -> Self {
        120f64.into()
    }
}

impl Default for Beats {
    fn default() -> Self {
        1f64.into()
    }
}

impl From<BPM> for Seconds {
    fn from(b: BPM) -> Self {
        (60f64 / *b).into()
    }
}

impl Default for Samples {
    fn default() -> Self {
        48000f64.into()
    }
}

impl Default for Hertz {
    fn default() -> Self {
        440f64.into()
    }
}

impl Semitones {
    /// Return the octave of the semitone.
    fn octave(self) -> (usize, usize) {
        let translated = *self + 9f64;

        let quotient = translated.div_euclid(12f64) as i64;

        let rem = translated.rem_euclid(12f64) as usize;

        ((quotient + 4) as usize, rem)
    }
}

impl From<Semitones> for Hertz {
    fn from(st: Semitones) -> Self {
        (*Self::default() * STD_BASE.powf(*st)).into()
    }
}

pub mod instruments;
pub mod output;
pub mod sheet;

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

    #[test]
    fn test_stoh() {
        let st: Semitones = 1f64.into();

        let hertz: Hertz = st.into();

        println!("hertz = {hertz:?}");
    }

    #[test]
    fn test_btos() {
        let b = BPM::default();

        let s: Seconds = b.into();

        println!("second = {s:?}");
    }
}