rs-audio 1.2.2

A retro audio engine for making music programmatically.
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

use std::f64::consts::PI;

/**
This enum is used for declaring waveform types.<br>
Types:
- <b>Sine</b><br>
The standard note
- <b>Square</b>
- <b>Sawtooth</b>
- <b>Triangle</b>
- <b>Rest</b><br>
Silence
*/
#[derive(Clone, Copy, PartialEq, Debug, serde::Deserialize, serde::Serialize)]
pub enum WaveForm {
    Sine,
    Square,
    Sawtooth,
    Triangle,
    Rest, // silence
}

impl Default for WaveForm {
    fn default() -> Self {
        Self::Sine
    }
}

// generates a sample using a waveform
// only intended for use by the library
pub(crate) fn generate_sample(waveform: &WaveForm, phase: f64) -> f64 {
    match waveform {
        // equations
        WaveForm::Sine => (phase * 2.0 * PI).sin(),
        WaveForm::Square => {
            if phase < 0.5 {
                1.0
            } else {
                -1.0
            }
        }
        WaveForm::Sawtooth => 2.0 * phase - 1.0,
        WaveForm::Triangle => {
            if phase < 0.5 {
                -1.0 + 4.0 * phase
            } else {
                1.0 - 4.0 * (phase - 0.5)
            }
        }
        WaveForm::Rest => 0.0, // silence
    }
}