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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
use note_freq::NoteFreqGenerator;
use std;
use unit::{NoteHz, NoteVelocity};
use voice::{self, NoteState, Voice};


/// The "mode" with which the `Instrument` will handle notes.
///
/// The `Mode` manages several areas of logic:
///
/// 1. Conversion of input hz to target hz using note_freq_gen and detune.
/// 2. Distribution of new notes between voices.
/// 3. Resetting voice playheads on note-offs or voice-stealing.
pub trait Mode {

    /// Handle a `note_on` event.
    fn note_on<NFG>(&mut self,
                    note_hz: NoteHz,
                    note_velocity: NoteVelocity,
                    detune: f32,
                    note_freq_gen: &NFG,
                    voices: &mut [Voice<NFG::NoteFreq>])
        where NFG: NoteFreqGenerator;

    /// Handle a `note_off` event.
    fn note_off<NFG>(&mut self,
                     note_hz: NoteHz,
                     detune: f32,
                     note_freq_gen: &NFG,
                     voices: &mut [Voice<NFG::NoteFreq>])
        where NFG: NoteFreqGenerator;

    /// Handle a `stop` event.
    fn stop(&mut self) {}

}


/// Monophonic playback.
#[derive(Clone, Debug, PartialEq)]
pub struct Mono(pub MonoKind, pub Vec<NoteHz>);

/// The state of monophony.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum MonoKind {
    /// New notes will reset the voice's playheads
    Retrigger,
    /// If a note is already playing, new notes will not reset the voice's playheads.
    /// A stack of notes is kept - if a NoteOff occurs on the current note, it is replaced with the
    /// note at the top of the stack if there is one. The stacked notes are reset if the voice
    /// becomes inactive.
    Legato,
}

/// Polyphonic playback.
#[derive(Copy, Clone, Debug, PartialEq)]
pub struct Poly;

/// The mode in which the Synth will handle notes.
#[derive(Clone, Debug, PartialEq)]
pub enum Dynamic {
    /// Single voice (normal or legato) with a stack of fallback notes.
    Mono(Mono),
    /// Multiple voices.
    Poly(Poly),
}


/// Does the given `hz` match the `target_hz`?
pub fn does_hz_match(hz: NoteHz, target_hz: NoteHz) -> bool {
    const HZ_VARIANCE: NoteHz = 0.25;
    let (min_hz, max_hz) = (target_hz - HZ_VARIANCE, target_hz + HZ_VARIANCE);
    hz > min_hz && hz < max_hz
}

/// Is the given `voice` currently playing a note that matches the `target_hz`?
fn does_voice_match<NF>(voice: &Voice<NF>, target_hz: NoteHz) -> bool {
    match voice.note {
        Some(voice::Note { state: NoteState::Playing, hz, .. }) =>
            does_hz_match(hz, target_hz),
        _ => false,
    }
}


impl Mono {
    /// Construct a default Retrigger mono mode.
    pub fn retrigger() -> Mono {
        Mono(MonoKind::Retrigger, Vec::with_capacity(16))
    }
    /// construct a default Legato mono mode.
    pub fn legato() -> Mono {
        Mono(MonoKind::Legato, Vec::with_capacity(16))
    }
}


impl Dynamic {
    /// Construct a default Retrigger mono mode.
    pub fn retrigger() -> Dynamic {
        Dynamic::Mono(Mono::retrigger())
    }
    /// Construct a default Legato mono mode.
    pub fn legato() -> Dynamic {
        Dynamic::Mono(Mono::legato())
    }
    /// Construct a default Poly mode.
    pub fn poly() -> Dynamic {
        Dynamic::Poly(Poly)
    }
}


impl Mode for Mono {

    /// Handle a note_on event.
    fn note_on<NFG>(&mut self,
                    note_hz: NoteHz,
                    note_vel: NoteVelocity,
                    detune: f32,
                    note_freq_gen: &NFG,
                    voices: &mut [Voice<NFG::NoteFreq>])
        where NFG: NoteFreqGenerator,
    {
        // To ensure that we don't double-stack notes when multiple `note_on`s are given for the
        // same note, we first release the note if it exists.
        self.note_off(note_hz, detune, note_freq_gen, voices);

        let Mono(kind, ref mut notes) = *self;

        // If a note was already playing, move it onto the stack
        if let Some(voice::Note { state: NoteState::Playing, hz, .. }) = voices[0].note {
            notes.push(hz);

            // If in Retrigger mode, reset the playheads.
            if let MonoKind::Retrigger = kind {
                for voice in voices.iter_mut() {
                    voice.reset_playhead();
                }
            }
        }
        // Otherwise if there were no notes currently playing, reset the playheads anyway.
        else {
            notes.clear();
            for voice in voices.iter_mut() {
                voice.reset_playhead();
            }
        }

        // Generate a unique NoteFreq and trigger note_on for each voice.
        for voice in voices.iter_mut() {
            let freq = note_freq_gen.generate(note_hz, detune, Some(voice));
            voice.note_on(note_hz, freq, note_vel);
        }
    }

    /// Handle a note_off event.
    fn note_off<NFG>(&mut self,
                     note_hz: NoteHz,
                     detune: f32,
                     note_freq_gen: &NFG,
                     voices: &mut [Voice<NFG::NoteFreq>])
        where NFG: NoteFreqGenerator,
    {
        let Mono(kind, ref mut notes) = *self;

        if does_voice_match(&mut voices[0], note_hz) {
            if let Some(voice::Note { vel, .. }) = voices[0].note {
                // If there's a note still on the stack, fall back to it.
                if let Some(old_hz) = notes.pop() {

                    if let MonoKind::Retrigger = kind {
                        for voice in voices.iter_mut() {
                            voice.reset_playhead();
                        }
                    }

                    // Play the popped stack note on all voices.
                    for voice in voices.iter_mut() {
                        let freq = note_freq_gen.generate(old_hz, detune, Some(voice));
                        voice.note_on(old_hz, freq, vel);
                    }
                    return;
                }
            }
            for voice in voices.iter_mut() {
                voice.note_off();
            }
        } else {
            // If any notes in the note stack match the given note_off, remove them.
            for i in (0..notes.len()).rev() {
                if does_hz_match(notes[i], note_hz) {
                    notes.remove(i);
                }
            }
        }

    }

    /// Handle a stop event.
    fn stop(&mut self) {
        let Mono(_, ref mut notes) = *self;
        notes.clear();
    }

}


impl Mode for Poly {

    fn note_on<NFG>(&mut self,
                    note_hz: NoteHz,
                    note_vel: NoteVelocity,
                    detune: f32,
                    note_freq_gen: &NFG,
                    voices: &mut [Voice<NFG::NoteFreq>])
        where NFG: NoteFreqGenerator,
    {
        // Construct the new CurrentFreq for the new note.
        let freq = {
            // First, determine the current hz of the last note played if there is one.
            let mut active = voices.iter().filter(|voice| voice.note.is_some());

            // Find the most recent voice.
            let maybe_newest_voice = active.next().map(|voice| {
                active.fold(voice, |newest, voice| {
                    if voice.playhead < newest.playhead { voice }
                    else { newest }
                })
            });

            note_freq_gen.generate(note_hz, detune, maybe_newest_voice)
        };

        // Find the right voice to play the note.
        let mut oldest = None;
        let mut oldest_note_on = std::time::Instant::now();
        for voice in voices.iter_mut() {
            if voice.note.is_none() {
                voice.reset_playhead();
                voice.note_on(note_hz, freq, note_vel);
                return;
            }
            let time_of_note_on = voice.note.as_ref().unwrap().time_of_note_on;
            if time_of_note_on < oldest_note_on {
                oldest_note_on = time_of_note_on;
                oldest = Some(voice);
            }
        }
        if let Some(voice) = oldest {
            voice.reset_playhead();
            voice.note_on(note_hz, freq, note_vel);
        }

    }

    fn note_off<NFG>(&mut self,
                     note_hz: NoteHz,
                     _detune: f32,
                     _note_freq_gen: &NFG,
                     voices: &mut [Voice<NFG::NoteFreq>])
        where NFG: NoteFreqGenerator,
    {

        let maybe_voice = voices.iter_mut().fold(None, |maybe_current_match, voice| {
            if does_voice_match(voice, note_hz) {
                match maybe_current_match {
                    None => return Some(voice),
                    Some(ref current_match) => if voice.playhead >= current_match.playhead {
                        return Some(voice)
                    },
                }
            }
            maybe_current_match
        });

        if let Some(voice) = maybe_voice {
            voice.note_off();
        }
    }

}


impl Mode for Dynamic {

    /// Handle a note_on event.
    fn note_on<NFG>(&mut self,
                    note_hz: NoteHz,
                    note_vel: NoteVelocity,
                    detune: f32,
                    note_freq_gen: &NFG,
                    voices: &mut [Voice<NFG::NoteFreq>]) where NFG: NoteFreqGenerator {
        match *self {
            Dynamic::Mono(ref mut mono) =>
                mono.note_on(note_hz, note_vel, detune, note_freq_gen, voices),
            Dynamic::Poly(ref mut poly) =>
                poly.note_on(note_hz, note_vel, detune, note_freq_gen, voices),
        }
    }

    fn note_off<NFG>(&mut self,
                     note_hz: NoteHz,
                     detune: f32,
                     note_freq_gen: &NFG,
                     voices: &mut [Voice<NFG::NoteFreq>]) where NFG: NoteFreqGenerator {
        match *self {
            Dynamic::Mono(ref mut mono) =>
                mono.note_off(note_hz, detune, note_freq_gen, voices),
            Dynamic::Poly(ref mut poly) =>
                poly.note_off(note_hz, detune, note_freq_gen, voices),
        }
    }

    fn stop(&mut self) {
        match *self {
            Dynamic::Mono(ref mut mono) => mono.stop(),
            Dynamic::Poly(ref mut poly) => poly.stop(),
        }
    }

}