ruffbox_synth 0.14.0

A beatbox-oriented synthesizer library.
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
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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
use std::sync::Arc;

use rubato::{FftFixedIn, Resampler};

// crossbeam for the event queue
use crossbeam::atomic::AtomicCell;
use dashmap::DashMap;

use crate::building_blocks::{
    SampleBuffer, SynthParameterAddress, SynthParameterLabel, SynthParameterValue,
    resolve_parameter_value,
};
use crate::ruffbox::{ControlMessage, ScheduledEvent};
use crate::synths::*;

use crate::ruffbox::ScheduledSource;
use crate::synths::{KarPlusPlus, MultiOscillatorSynth};

/// thin wrapper around a scheduled event instasnce
pub struct PreparedInstance<const BUFSIZE: usize, const NCHAN: usize> {
    ev: ScheduledEvent<BUFSIZE, NCHAN>,
    sr: f32,
}

impl<const BUFSIZE: usize, const NCHAN: usize> PreparedInstance<BUFSIZE, NCHAN> {
    pub fn set_instance_parameter(
        &mut self,
        par: SynthParameterAddress,
        val: &SynthParameterValue,
    ) {
        self.ev.set_param_or_modulator(
            par,
            resolve_parameter_value::<BUFSIZE>(par.label, val, self.sr),
        );
    }
}

enum BufferType {
    Mono,
    Stereo,
}

/// These are the controls, the part which you use in your control thread
/// to control the Ruffbox, trigger playback, etc ...
pub struct RuffboxControls<const BUFSIZE: usize, const NCHAN: usize> {
    // Buffer lengths and types need to be known when initializing sampler instances,
    // which is why unfortunately we need to mirror them here in the controls.
    // Thanks to the magic of DashMap, we can get around having to
    // use &mut self. Maybe one day I'll find out how to make the controls
    // actually stateless, but until then, the interior mutability pattern
    // comes in handy ...
    buffer_counter: AtomicCell<usize>,
    buffer_lengths: DashMap<usize, usize>,
    buffer_types: DashMap<usize, BufferType>,
    freeze_buffer_offset: usize,
    num_live_buffers: usize,
    num_freeze_buffers: usize,
    max_buffers: usize,
    control_q_send: crossbeam::channel::Sender<ControlMessage<BUFSIZE, NCHAN>>,
    now: Arc<AtomicCell<f64>>, // shared reference to global time counter
    pub samplerate: f32,       // finally after all those years ...
}

impl<const BUFSIZE: usize, const NCHAN: usize> RuffboxControls<BUFSIZE, NCHAN> {
    pub(crate) fn new(
        samplerate: f64,
        live_buffers: usize,
        live_buffer_time: f64,
        max_buffers: usize,
        freeze_buffers: usize,
        now: &Arc<AtomicCell<f64>>,
        tx: crossbeam::channel::Sender<ControlMessage<BUFSIZE, NCHAN>>,
    ) -> RuffboxControls<BUFSIZE, NCHAN> {
        // dash map is strange, mutable without mut ...
        let buffer_lengths = DashMap::new();
        let buffer_types = DashMap::new();
        if live_buffers > 0 {
            // create buffer lenghts for live buffers and freeze buffers
            for b in 0..live_buffers + freeze_buffers {
                buffer_lengths.insert(b, (samplerate * live_buffer_time) as usize);
                buffer_types.insert(b, BufferType::Mono);
            }
        }

        RuffboxControls {
            buffer_counter: AtomicCell::new(if live_buffers > 0 {
                live_buffers + freeze_buffers
            } else {
                0
            }),
            freeze_buffer_offset: live_buffers,
            num_live_buffers: live_buffers,
            num_freeze_buffers: freeze_buffers,
            buffer_lengths,
            buffer_types,
            max_buffers,
            control_q_send: tx,
            samplerate: samplerate as f32,
            now: Arc::clone(now),
        }
    }

    /// prepare a sound source instance, return instance id
    pub fn prepare_instance(
        &self,
        src_type: SynthType,
        timestamp: f64,
        sample_buf: usize,
    ) -> Option<PreparedInstance<BUFSIZE, NCHAN>> {
        Some(PreparedInstance {
            sr: self.samplerate,
            ev: match src_type {
                SynthType::KarPlusPlus(desc) => ScheduledEvent::new(
                    timestamp,
                    if desc.ambisonic {
                        ScheduledSource::Ambi(Box::new(KarPlusPlus::new(desc, self.samplerate)))
                    } else {
                        ScheduledSource::Channel(Box::new(KarPlusPlus::new(desc, self.samplerate)))
                    },
                ),
                SynthType::SingleOscillator(desc) => ScheduledEvent::new(
                    timestamp,
                    if desc.ambisonic {
                        ScheduledSource::Ambi(Box::new(SingleOscillatorSynth::new(
                            desc,
                            self.samplerate,
                        )))
                    } else {
                        ScheduledSource::Channel(Box::new(SingleOscillatorSynth::new(
                            desc,
                            self.samplerate,
                        )))
                    },
                ),
                SynthType::MultiOscillator(desc) => ScheduledEvent::new(
                    timestamp,
                    if desc.ambisonic {
                        ScheduledSource::Ambi(Box::new(MultiOscillatorSynth::new(
                            desc,
                            self.samplerate,
                        )))
                    } else {
                        ScheduledSource::Channel(Box::new(MultiOscillatorSynth::new(
                            desc,
                            self.samplerate,
                        )))
                    },
                ),
                SynthType::RissetBell(ambi) => ScheduledEvent::new(
                    timestamp,
                    if ambi {
                        ScheduledSource::Ambi(Box::new(RissetBell::new(ambi, self.samplerate)))
                    } else {
                        ScheduledSource::Channel(Box::new(RissetBell::new(ambi, self.samplerate)))
                    },
                ),
                SynthType::Sampler(desc) => ScheduledEvent::new(
                    timestamp,
                    if desc.ambisonic {
                        // insert the right sampler type
                        match *self.buffer_types.get(&sample_buf).unwrap() {
                            BufferType::Mono => ScheduledSource::Ambi(Box::new(Sampler::new(
                                desc,
                                sample_buf,
                                *self.buffer_lengths.get(&sample_buf).unwrap(),
                                self.samplerate,
                            ))),
                            BufferType::Stereo => {
                                ScheduledSource::Ambi(Box::new(StereoSampler::new(
                                    desc,
                                    sample_buf,
                                    *self.buffer_lengths.get(&sample_buf).unwrap(),
                                    self.samplerate,
                                )))
                            }
                        }
                    } else {
                        // insert the right sampler type
                        match *self.buffer_types.get(&sample_buf).unwrap() {
                            BufferType::Mono => ScheduledSource::Channel(Box::new(Sampler::new(
                                desc,
                                sample_buf,
                                *self.buffer_lengths.get(&sample_buf).unwrap(),
                                self.samplerate,
                            ))),
                            BufferType::Stereo => {
                                ScheduledSource::Channel(Box::new(StereoSampler::new(
                                    desc,
                                    sample_buf,
                                    *self.buffer_lengths.get(&sample_buf).unwrap(),
                                    self.samplerate,
                                )))
                            }
                        }
                    },
                ),
                SynthType::LiveSampler(desc) if self.num_live_buffers > 0 => {
                    let final_bufnum = if sample_buf < self.num_live_buffers {
                        sample_buf
                    } else {
                        0
                    };
                    ScheduledEvent::new(
                        timestamp,
                        if desc.ambisonic {
                            ScheduledSource::Ambi(Box::new(Sampler::new(
                                desc,
                                final_bufnum,
                                *self.buffer_lengths.get(&final_bufnum).unwrap(),
                                self.samplerate,
                            )))
                        } else {
                            ScheduledSource::Channel(Box::new(Sampler::new(
                                desc,
                                final_bufnum,
                                *self.buffer_lengths.get(&final_bufnum).unwrap(),
                                self.samplerate,
                            )))
                        },
                    )
                }
                SynthType::FrozenSampler(desc) if self.num_freeze_buffers > 0 => {
                    let final_bufnum = if sample_buf < self.num_freeze_buffers {
                        sample_buf + self.freeze_buffer_offset
                    } else {
                        self.freeze_buffer_offset
                    };
                    ScheduledEvent::new(
                        timestamp,
                        if desc.ambisonic {
                            ScheduledSource::Ambi(Box::new(Sampler::new(
                                desc,
                                final_bufnum,
                                *self.buffer_lengths.get(&final_bufnum).unwrap(),
                                self.samplerate,
                            )))
                        } else {
                            ScheduledSource::Channel(Box::new(Sampler::new(
                                desc,
                                final_bufnum,
                                *self.buffer_lengths.get(&final_bufnum).unwrap(),
                                self.samplerate,
                            )))
                        },
                    )
                }
                _ => {
                    return None;
                } // jump out
            },
        })
    }

    pub fn set_global_parameter(
        &self,
        fx: super::GlobalEffect,
        par: SynthParameterLabel,
        val: SynthParameterValue,
    ) {
        self.control_q_send
            .send(ControlMessage::SetGlobalParamOrModulator(
                fx,
                par,
                resolve_parameter_value(par, &val, self.samplerate),
            ))
            .unwrap();
    }

    pub fn clear_all_buffers(&self) {
        self.control_q_send
            .send(ControlMessage::ClearAllBuffers)
            .unwrap();
    }

    pub fn clear_all_live_buffers(&self) {
        self.control_q_send
            .send(ControlMessage::ClearAllLiveBuffers)
            .unwrap();
    }

    pub fn clear_all_freeze_buffers(&self) {
        self.control_q_send
            .send(ControlMessage::ClearAllFreezeBuffers)
            .unwrap();
    }

    pub fn clear_live_buffer(&self, bufnum: usize) {
        self.control_q_send
            .send(ControlMessage::ClearLiveBuffer(bufnum))
            .unwrap();
    }

    pub fn clear_freeze_buffer(&self, bufnum: usize) {
        self.control_q_send
            .send(ControlMessage::ClearFreezeBuffer(bufnum))
            .unwrap();
    }

    /// triggers a synth for buffer reference or a synth
    pub fn trigger(&self, instance: PreparedInstance<BUFSIZE, NCHAN>) {
        self.control_q_send
            .send(ControlMessage::ScheduleEvent(instance.ev))
            .unwrap();
    }

    /// get the current timestamp
    pub fn get_now(&self) -> f64 {
        // this might cause locking on platforms where AtomicCell<float> isn't lockfree
        self.now.load()
    }

    /// transfer contents of live buffer to freeze buffer
    pub fn freeze_buffer(&self, freezbuf: usize, inbuf: usize) {
        // acutal buffer numbers are calculated here ...
        self.control_q_send
            .send(ControlMessage::FreezeBuffer(
                freezbuf + self.freeze_buffer_offset,
                inbuf,
            ))
            .unwrap();
    }

    /// transfer contents of live buffer to freeze buffer
    pub fn freeze_add_buffer(&self, freezbuf: usize, inbuf: usize) {
        // acutal buffer numbers are calculated here ...
        self.control_q_send
            .send(ControlMessage::FreezeAddBuffer(
                freezbuf + self.freeze_buffer_offset,
                inbuf,
            ))
            .unwrap();
    }

    /// transfer contents of live buffer to freeze buffer
    pub fn freeze_after_rec(&self, freezbuf: usize, inbuf: usize, time_secs: f64, add: bool) {
        let num_samples = (self.samplerate as f64 * time_secs).ceil() as usize;

        // acutal buffer numbers are calculated here ...
        self.control_q_send
            .send(ControlMessage::FreezeAfterRec(
                freezbuf + self.freeze_buffer_offset,
                inbuf,
                num_samples,
                add,
            ))
            .unwrap();
    }

    /// Loads a mono sample and returns the assigned buffer number.
    ///
    /// Resample to current samplerate if necessary and specified.
    /// The sample buffer is passed as mutable because the method adds
    /// interpolation samples without the need of a copy.
    pub fn load_mono_sample(&self, samples: &mut Vec<f32>, resample: bool, sr: f32) -> usize {
        let buffer_id = self.buffer_counter.fetch_add(1);

        if buffer_id > self.max_buffers {
            println!(
                "warning, this buffer won't be loaded, as the maximum allowed number of buffers has been reached!"
            );
            return buffer_id;
        }

        let (buflen, buffer) = if resample && (self.samplerate != sr) {
            // zero-pad for resampling blocks
            if (samples.len() as f32 % 1024.0) > 0.0 {
                let diff = 1024 - (samples.len() % 1024);
                samples.append(&mut vec![0.0; diff]);
            }

            let mut samples_resampled: Vec<f32> = Vec::new();
            let mut resampler =
                FftFixedIn::<f32>::new(sr as usize, self.samplerate as usize, 1024, 1, 1).unwrap();

            // interpolation samples, two at each end, as we can read and interpolate in both directions
            samples_resampled.push(0.0);
            samples_resampled.push(0.0);
            let num_chunks = samples.len() / 1024;
            for chunk in 0..num_chunks {
                let chunk = vec![samples[(1024 * chunk)..(1024 * (chunk + 1))].to_vec()];
                let mut waves_out = resampler.process(&chunk, None).unwrap();
                samples_resampled.append(&mut waves_out[0]);
            }
            // interpolation samples
            samples_resampled.push(0.0);
            samples_resampled.push(0.0);
            (samples_resampled.len() - 4, samples_resampled)
        } else {
            // interpolation samples, two at each end, as we can read and interpolate in both directions
            samples.insert(0, 0.0);
            samples.insert(0, 0.0);
            samples.push(0.0);
            samples.push(0.0);
            (samples.len() - 4, samples.to_vec())
        };

        self.buffer_lengths.insert(buffer_id, buflen);
        self.buffer_types.insert(buffer_id, BufferType::Mono);
        self.control_q_send
            .send(ControlMessage::LoadSample(
                buffer_id,
                buflen,
                SampleBuffer::Mono(buffer),
            ))
            .unwrap();
        // return bufnum
        buffer_id
    }

    /// Loads a stereo sample and returns the assigned buffer number.
    ///
    /// Resample to current samplerate if necessary and specified.
    /// The sample buffer is passed as mutable because the method adds
    /// interpolation samples without the need of a copy.
    pub fn load_stereo_sample(
        &self,
        samples_left: &mut Vec<f32>,
        samples_right: &mut Vec<f32>,
        resample: bool,
        sr: f32,
    ) -> usize {
        let buffer_id = self.buffer_counter.fetch_add(1);

        if buffer_id > self.max_buffers {
            println!(
                "warning, this buffer won't be loaded, as the maximum allowed number of buffers has been reached!"
            );
            return buffer_id;
        }

        if samples_right.len() < samples_left.len() {
            samples_right.append(&mut vec![0.0; samples_left.len() - samples_right.len()]);
        }

        let (buflen, buffer_left, buffer_right) = if resample && (self.samplerate != sr) {
            // zero-pad for resampling blocks
            if (samples_left.len() as f32 % 1024.0) > 0.0 {
                let diff = 1024 - (samples_left.len() % 1024);
                samples_left.append(&mut vec![0.0; diff]);
            }

            let mut samples_left_resampled: Vec<f32> = Vec::new();
            let mut samples_right_resampled: Vec<f32> = Vec::new();
            let mut resampler_l =
                FftFixedIn::<f32>::new(sr as usize, self.samplerate as usize, 1024, 1, 1).unwrap();
            let mut resampler_r =
                FftFixedIn::<f32>::new(sr as usize, self.samplerate as usize, 1024, 1, 1).unwrap();

            // interpolation samples, two on each end ...
            samples_left_resampled.push(0.0);
            samples_left_resampled.push(0.0);
            samples_right_resampled.push(0.0);
            samples_right_resampled.push(0.0);

            let num_chunks = samples_left.len() / 1024;

            for chunk in 0..num_chunks {
                let chunk_left = vec![samples_left[(1024 * chunk)..(1024 * (chunk + 1))].to_vec()];
                let mut waves_out_left = resampler_l.process(&chunk_left, None).unwrap();
                samples_left_resampled.append(&mut waves_out_left[0]);
                let chunk_right = vec![samples_left[(1024 * chunk)..(1024 * (chunk + 1))].to_vec()];
                let mut waves_out_right = resampler_r.process(&chunk_right, None).unwrap();
                samples_right_resampled.append(&mut waves_out_right[0]);
            }
            // interpolation samples
            samples_left_resampled.push(0.0);
            samples_left_resampled.push(0.0);
            samples_right_resampled.push(0.0);
            samples_right_resampled.push(0.0);
            (
                samples_left_resampled.len() - 4,
                samples_left_resampled,
                samples_right_resampled,
            )
        } else {
            // add interpolation samples
            samples_left.insert(0, 0.0);
            samples_left.insert(0, 0.0);
            samples_right.insert(0, 0.0);
            samples_right.insert(0, 0.0);
            samples_left.push(0.0);
            samples_left.push(0.0);
            samples_right.push(0.0);
            samples_right.push(0.0);
            (
                samples_left.len() - 4,
                samples_left.to_vec(),
                samples_right.to_vec(),
            )
        };

        self.buffer_lengths.insert(buffer_id, buflen);
        self.buffer_types.insert(buffer_id, BufferType::Stereo);
        self.control_q_send
            .send(ControlMessage::LoadSample(
                buffer_id,
                buflen,
                SampleBuffer::Stereo(buffer_left, buffer_right),
            ))
            .unwrap();
        // return bufnum
        buffer_id
    }
}