conformal_vst_wrapper 0.6.5

Implements a VST3-compatible plug-in for audio processors implemented with the conformal audio plug-in framework.
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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
use vst3::{
    Class, ComWrapper,
    Steinberg::Vst::{
        AudioBusBuffers__type0, IAudioProcessorTrait, IComponentTrait, IEventList, IEventListTrait,
        IHostApplication, IHostApplicationTrait, IParameterChanges, IParameterChangesTrait,
    },
};

use conformal_component::{
    ProcessingMode,
    events::{NoteID, NoteIDInternals},
    parameters::hash_id,
    synth::NumericPerNoteExpression,
};

use super::PartialProcessingEnvironment;

pub(super) const DEFAULT_ENV: PartialProcessingEnvironment = PartialProcessingEnvironment {
    sampling_rate: 44100.0,
    max_samples_per_process_call: 512,
    processing_mode: ProcessingMode::Realtime,
};

pub(super) fn process_setup(
    env: &PartialProcessingEnvironment,
) -> vst3::Steinberg::Vst::ProcessSetup {
    vst3::Steinberg::Vst::ProcessSetup {
        processMode: match env.processing_mode {
            ProcessingMode::Realtime => vst3::Steinberg::Vst::ProcessModes_::kRealtime,
            ProcessingMode::Prefetch => vst3::Steinberg::Vst::ProcessModes_::kPrefetch,
            ProcessingMode::Offline => vst3::Steinberg::Vst::ProcessModes_::kOffline,
        } as i32,
        symbolicSampleSize: vst3::Steinberg::Vst::SymbolicSampleSizes_::kSample32 as i32,
        maxSamplesPerBlock: env.max_samples_per_process_call as i32,
        sampleRate: env.sampling_rate as f64,
    }
}

pub unsafe fn activate_busses<P: IComponentTrait>(proc: &P) {
    unsafe {
        assert_eq!(
            proc.activateBus(
                vst3::Steinberg::Vst::MediaTypes_::kAudio as i32,
                vst3::Steinberg::Vst::BusDirections_::kOutput as i32,
                0,
                1
            ),
            vst3::Steinberg::kResultOk
        );
        assert_eq!(
            proc.activateBus(
                vst3::Steinberg::Vst::MediaTypes_::kEvent as i32,
                vst3::Steinberg::Vst::BusDirections_::kInput as i32,
                0,
                1
            ),
            vst3::Steinberg::kResultOk
        );
    }
}

pub unsafe fn activate_effect_busses<P: IComponentTrait>(proc: &P) {
    unsafe {
        assert_eq!(
            proc.activateBus(
                vst3::Steinberg::Vst::MediaTypes_::kAudio as i32,
                vst3::Steinberg::Vst::BusDirections_::kOutput as i32,
                0,
                1
            ),
            vst3::Steinberg::kResultOk
        );
        assert_eq!(
            proc.activateBus(
                vst3::Steinberg::Vst::MediaTypes_::kAudio as i32,
                vst3::Steinberg::Vst::BusDirections_::kInput as i32,
                0,
                1
            ),
            vst3::Steinberg::kResultOk
        );
    }
}

pub unsafe fn setup_proc<
    P: IAudioProcessorTrait + IComponentTrait,
    H: IHostApplicationTrait + Class,
>(
    proc: &P,
    host: &ComWrapper<H>,
) {
    unsafe {
        let host_ref = host.as_com_ref::<IHostApplication>().unwrap();
        assert_eq!(
            proc.initialize(host_ref.cast().unwrap().as_ptr()),
            vst3::Steinberg::kResultOk
        );
        assert_eq!(
            proc.setupProcessing(&mut process_setup(&DEFAULT_ENV)),
            vst3::Steinberg::kResultOk
        );
        let mut out_arrangement = vst3::Steinberg::Vst::SpeakerArr::kStereo;
        assert_eq!(
            proc.setBusArrangements(std::ptr::null_mut(), 0, &mut out_arrangement, 1),
            vst3::Steinberg::kResultOk
        );
        activate_busses(proc);
        assert_eq!(proc.setActive(1u8), vst3::Steinberg::kResultOk);
        assert_eq!(proc.setProcessing(1u8), vst3::Steinberg::kResultOk);
    }
}

pub unsafe fn setup_proc_effect<
    P: IAudioProcessorTrait + IComponentTrait,
    H: IHostApplicationTrait + Class,
>(
    proc: &P,
    host: &ComWrapper<H>,
) {
    unsafe {
        let host_ref = host.as_com_ref::<IHostApplication>().unwrap();
        assert_eq!(
            proc.initialize(host_ref.cast().unwrap().as_ptr()),
            vst3::Steinberg::kResultOk
        );
        assert_eq!(
            proc.setupProcessing(&mut process_setup(&DEFAULT_ENV)),
            vst3::Steinberg::kResultOk
        );
        let mut out_arrangement = vst3::Steinberg::Vst::SpeakerArr::kStereo;
        let mut in_arrangement = vst3::Steinberg::Vst::SpeakerArr::kStereo;
        assert_eq!(
            proc.setBusArrangements(&mut in_arrangement, 1, &mut out_arrangement, 1),
            vst3::Steinberg::kResultOk
        );
        activate_effect_busses(proc);
        assert_eq!(proc.setActive(1u8), vst3::Steinberg::kResultOk);
        assert_eq!(proc.setProcessing(1u8), vst3::Steinberg::kResultOk);
    }
}

pub struct ParameterValueQueuePoint {
    pub sample_offset: usize,
    pub value: f64,
}

pub struct ParameterValueQueueImpl {
    pub param_id: String,
    pub points: Vec<ParameterValueQueuePoint>,
}

impl vst3::Steinberg::Vst::IParamValueQueueTrait for ParameterValueQueueImpl {
    unsafe fn getParameterId(&self) -> vst3::Steinberg::Vst::ParamID {
        hash_id(&self.param_id).internal_hash()
    }

    unsafe fn getPointCount(&self) -> vst3::Steinberg::int32 {
        self.points.len() as i32
    }

    unsafe fn getPoint(
        &self,
        index: vst3::Steinberg::int32,
        sample_offset: *mut vst3::Steinberg::int32,
        value: *mut vst3::Steinberg::Vst::ParamValue,
    ) -> vst3::Steinberg::tresult {
        unsafe {
            if let Some(point) = self.points.get(index as usize) {
                *sample_offset = point.sample_offset as i32;
                *value = point.value;
                vst3::Steinberg::kResultOk
            } else {
                vst3::Steinberg::kInvalidArgument
            }
        }
    }

    unsafe fn addPoint(
        &self,
        _sample_offset: vst3::Steinberg::int32,
        _value: vst3::Steinberg::Vst::ParamValue,
        _index: *mut vst3::Steinberg::int32,
    ) -> vst3::Steinberg::tresult {
        vst3::Steinberg::kNotImplemented
    }
}

impl Class for ParameterValueQueueImpl {
    type Interfaces = (vst3::Steinberg::Vst::IParamValueQueue,);
}

struct ParameterChangesImpl {
    queues: Vec<vst3::ComPtr<vst3::Steinberg::Vst::IParamValueQueue>>,
}

impl ParameterChangesImpl {
    fn new(queues: Vec<ParameterValueQueueImpl>) -> Self {
        ParameterChangesImpl {
            queues: queues
                .into_iter()
                .map(|x| ComWrapper::new(x).to_com_ptr().unwrap())
                .collect::<Vec<_>>(),
        }
    }
}

impl IParameterChangesTrait for ParameterChangesImpl {
    unsafe fn getParameterCount(&self) -> vst3::Steinberg::int32 {
        self.queues.len() as i32
    }

    unsafe fn getParameterData(
        &self,
        index: vst3::Steinberg::int32,
    ) -> *mut vst3::Steinberg::Vst::IParamValueQueue {
        if let Some(queue) = self.queues.get(index as usize) {
            queue.as_ptr()
        } else {
            std::ptr::null_mut()
        }
    }

    unsafe fn addParameterData(
        &self,
        _id: *const vst3::Steinberg::Vst::ParamID,
        _index: *mut vst3::Steinberg::int32,
    ) -> *mut vst3::Steinberg::Vst::IParamValueQueue {
        std::ptr::null_mut()
    }
}

impl Class for ParameterChangesImpl {
    type Interfaces = (IParameterChanges,);
}

#[derive(Clone, Debug, PartialEq)]
pub enum MockData {
    NoteOn {
        id: NoteID,
        pitch: u8,
        velocity: f32,
        tuning: f32,
    },
    NoteOff {
        id: NoteID,
        pitch: u8,
        velocity: f32,
        tuning: f32,
    },
    NoteExpressionChange {
        id: NoteID,
        expression: NumericPerNoteExpression,
        value: f32,
    },
}
pub struct MockEvent {
    pub sample_offset: usize,
    pub data: MockData,
}

struct EventList {
    events: Vec<MockEvent>,
}

fn event_to_vst3_event(event: &MockEvent) -> vst3::Steinberg::Vst::Event {
    match event.data {
        MockData::NoteOn {
            id,
            pitch,
            velocity,
            tuning,
        } => vst3::Steinberg::Vst::Event {
            busIndex: 0,
            sampleOffset: event.sample_offset as i32,
            ppqPosition: 0f64,
            flags: 0,
            r#type: vst3::Steinberg::Vst::Event_::EventTypes_::kNoteOnEvent as u16,
            __field0: vst3::Steinberg::Vst::Event__type0 {
                noteOn: vst3::Steinberg::Vst::NoteOnEvent {
                    channel: match id.internals {
                        NoteIDInternals::NoteIDFromChannelID(channel) => channel,
                        _ => 0,
                    },
                    pitch: pitch as i16,
                    tuning,
                    velocity,
                    length: 0,
                    noteId: match id.internals {
                        NoteIDInternals::NoteIDWithID(id) => id,
                        _ => -1,
                    },
                },
            },
        },
        MockData::NoteOff {
            id,
            pitch,
            velocity,
            tuning,
        } => vst3::Steinberg::Vst::Event {
            busIndex: 0,
            sampleOffset: event.sample_offset as i32,
            ppqPosition: 0f64,
            flags: 0,
            r#type: vst3::Steinberg::Vst::Event_::EventTypes_::kNoteOffEvent as u16,
            __field0: vst3::Steinberg::Vst::Event__type0 {
                noteOff: vst3::Steinberg::Vst::NoteOffEvent {
                    channel: match id.internals {
                        NoteIDInternals::NoteIDFromChannelID(channel) => channel,
                        _ => 0,
                    },
                    pitch: pitch as i16,
                    tuning,
                    velocity,
                    noteId: match id.internals {
                        NoteIDInternals::NoteIDWithID(id) => id,
                        _ => -1,
                    },
                },
            },
        },
        MockData::NoteExpressionChange {
            id,
            expression,
            value,
        } => match expression {
            NumericPerNoteExpression::PitchBend | NumericPerNoteExpression::Timbre => {
                let (value, type_id) = match expression {
                    NumericPerNoteExpression::PitchBend => (
                        (value / 240.0 + 0.5) as f64,
                        vst3::Steinberg::Vst::NoteExpressionTypeIDs_::kTuningTypeID,
                    ),
                    NumericPerNoteExpression::Timbre => (
                        value as f64,
                        crate::processor::NOTE_EXPRESSION_TIMBRE_TYPE_ID,
                    ),
                    NumericPerNoteExpression::Aftertouch => unreachable!(),
                };
                vst3::Steinberg::Vst::Event {
                    busIndex: 0,
                    sampleOffset: event.sample_offset as i32,
                    ppqPosition: 0f64,
                    flags: 0,
                    r#type: vst3::Steinberg::Vst::Event_::EventTypes_::kNoteExpressionValueEvent
                        as u16,
                    __field0: vst3::Steinberg::Vst::Event__type0 {
                        noteExpressionValue: vst3::Steinberg::Vst::NoteExpressionValueEvent {
                            noteId: match id.internals {
                                NoteIDInternals::NoteIDWithID(id) => id,
                                _ => -1,
                            },
                            value,
                            typeId: type_id,
                        },
                    },
                }
            }
            NumericPerNoteExpression::Aftertouch => vst3::Steinberg::Vst::Event {
                busIndex: 0,
                sampleOffset: event.sample_offset as i32,
                ppqPosition: 0f64,
                flags: 0,
                r#type: vst3::Steinberg::Vst::Event_::EventTypes_::kPolyPressureEvent as u16,
                __field0: vst3::Steinberg::Vst::Event__type0 {
                    polyPressure: vst3::Steinberg::Vst::PolyPressureEvent {
                        channel: match id.internals {
                            NoteIDInternals::NoteIDFromChannelID(channel) => channel,
                            _ => 0,
                        },
                        pitch: 0,
                        noteId: match id.internals {
                            NoteIDInternals::NoteIDWithID(id) => id,
                            _ => -1,
                        },
                        pressure: value,
                    },
                },
            },
        },
    }
}

impl IEventListTrait for EventList {
    unsafe fn getEventCount(&self) -> vst3::Steinberg::int32 {
        self.events.len() as i32
    }

    unsafe fn getEvent(
        &self,
        index: vst3::Steinberg::int32,
        e: *mut vst3::Steinberg::Vst::Event,
    ) -> vst3::Steinberg::tresult {
        unsafe {
            if let Some(event) = self.events.get(index as usize) {
                (*e) = event_to_vst3_event(event);
                vst3::Steinberg::kResultOk
            } else {
                vst3::Steinberg::kInvalidArgument
            }
        }
    }

    unsafe fn addEvent(&self, _e: *mut vst3::Steinberg::Vst::Event) -> vst3::Steinberg::tresult {
        unimplemented!()
    }
}

impl Class for EventList {
    type Interfaces = (IEventList,);
}

pub const SAMPLE_COUNT: usize = 512;

pub unsafe fn mock_process_mod<
    D: IAudioProcessorTrait,
    F: FnOnce(&mut vst3::Steinberg::Vst::ProcessData) -> (),
>(
    channel_count: usize,
    events: Vec<MockEvent>,
    params: Vec<ParameterValueQueueImpl>,
    processor: &D,
    mod_data: F,
) -> Option<Vec<Vec<f32>>> {
    unsafe {
        let input_parameter_changes = ComWrapper::new(ParameterChangesImpl::new(params))
            .to_com_ptr::<IParameterChanges>()
            .unwrap();
        let input_events = ComWrapper::new(EventList { events })
            .to_com_ptr::<IEventList>()
            .unwrap();

        let mut output_audio_channels = vec![vec![0f32; SAMPLE_COUNT]; channel_count];
        let mut output_audio_channels_ptr = output_audio_channels
            .iter_mut()
            .map(|x| x.as_mut_ptr())
            .collect::<Vec<_>>();
        let mut audio_buffer_struct = Box::new(vst3::Steinberg::Vst::AudioBusBuffers {
            numChannels: channel_count as i32,
            silenceFlags: 0,
            __field0: AudioBusBuffers__type0 {
                channelBuffers32: output_audio_channels_ptr.as_mut_ptr(),
            },
        });

        let mut process_data = vst3::Steinberg::Vst::ProcessData {
            processMode: vst3::Steinberg::Vst::ProcessModes_::kRealtime as i32,
            symbolicSampleSize: vst3::Steinberg::Vst::SymbolicSampleSizes_::kSample32 as i32,
            numSamples: SAMPLE_COUNT as i32,
            numInputs: 0,
            numOutputs: 1,
            inputs: std::ptr::null_mut(),
            outputs: audio_buffer_struct.as_mut(),
            inputParameterChanges: input_parameter_changes.as_ptr(),
            outputParameterChanges: std::ptr::null_mut(),
            inputEvents: input_events.as_ptr(),
            outputEvents: std::ptr::null_mut(),
            processContext: std::ptr::null_mut(),
        };
        mod_data(&mut process_data);
        if vst3::Steinberg::kResultOk == processor.process(&mut process_data) {
            Some(output_audio_channels)
        } else {
            None
        }
    }
}

pub unsafe fn mock_process<D: IAudioProcessorTrait>(
    channel_count: usize,
    events: Vec<MockEvent>,
    params: Vec<ParameterValueQueueImpl>,
    processor: &D,
) -> Option<Vec<Vec<f32>>> {
    unsafe { mock_process_mod(channel_count, events, params, processor, |_| ()) }
}

pub unsafe fn mock_process_effect<D: IAudioProcessorTrait>(
    inputs: Vec<Vec<f32>>,
    params: Vec<ParameterValueQueueImpl>,
    processor: &D,
) -> Option<Vec<Vec<f32>>> {
    unsafe {
        let input_parameter_changes = ComWrapper::new(ParameterChangesImpl::new(params))
            .to_com_ptr::<IParameterChanges>()
            .unwrap();

        let mut input_audio_channels_ptr = inputs
            .iter()
            .map(|x| x.as_ptr() as *mut f32)
            .collect::<Vec<_>>();

        let mut output_audio_channels = vec![vec![0f32; inputs[0].len()]; inputs.len()];
        let mut output_audio_channels_ptr = output_audio_channels
            .iter_mut()
            .map(|x| x.as_mut_ptr())
            .collect::<Vec<_>>();
        let mut input_audio_buffer_struct = Box::new(vst3::Steinberg::Vst::AudioBusBuffers {
            numChannels: inputs.len() as i32,
            silenceFlags: 0,
            __field0: AudioBusBuffers__type0 {
                channelBuffers32: input_audio_channels_ptr.as_mut_ptr(),
            },
        });

        let mut output_audio_buffer_struct = Box::new(vst3::Steinberg::Vst::AudioBusBuffers {
            numChannels: inputs.len() as i32,
            silenceFlags: 0,
            __field0: AudioBusBuffers__type0 {
                channelBuffers32: output_audio_channels_ptr.as_mut_ptr(),
            },
        });
        let mut process_data = vst3::Steinberg::Vst::ProcessData {
            processMode: vst3::Steinberg::Vst::ProcessModes_::kRealtime as i32,
            symbolicSampleSize: vst3::Steinberg::Vst::SymbolicSampleSizes_::kSample32 as i32,
            numSamples: inputs[0].len() as i32,
            numInputs: 1,
            numOutputs: 1,
            inputs: input_audio_buffer_struct.as_mut(),
            outputs: output_audio_buffer_struct.as_mut(),
            inputParameterChanges: input_parameter_changes.as_ptr(),
            outputParameterChanges: std::ptr::null_mut(),
            inputEvents: std::ptr::null_mut(),
            outputEvents: std::ptr::null_mut(),
            processContext: std::ptr::null_mut(),
        };
        if vst3::Steinberg::kResultOk == processor.process(&mut process_data) {
            Some(output_audio_channels)
        } else {
            None
        }
    }
}

// We need `dead_code` here since some members keep alive raw pointers
// in `process_data`.
#[allow(dead_code)]
pub struct MockNoAudioProcessData {
    input_parameter_changes: vst3::ComPtr<IParameterChanges>,
    input_events: vst3::ComPtr<IEventList>,
    pub process_data: vst3::Steinberg::Vst::ProcessData,
}

pub unsafe fn mock_no_audio_process_data(
    events: Vec<MockEvent>,
    parameters: Vec<ParameterValueQueueImpl>,
) -> MockNoAudioProcessData {
    let input_parameter_changes = ComWrapper::new(ParameterChangesImpl::new(parameters))
        .to_com_ptr::<IParameterChanges>()
        .unwrap();
    let input_events = ComWrapper::new(EventList { events })
        .to_com_ptr::<IEventList>()
        .unwrap();
    let process_data = vst3::Steinberg::Vst::ProcessData {
        processMode: vst3::Steinberg::Vst::ProcessModes_::kRealtime as i32,
        symbolicSampleSize: vst3::Steinberg::Vst::SymbolicSampleSizes_::kSample32 as i32,
        numSamples: 0,
        numInputs: 0,
        numOutputs: 0,
        inputs: std::ptr::null_mut(),
        outputs: std::ptr::null_mut(),
        inputParameterChanges: input_parameter_changes.as_ptr(),
        outputParameterChanges: std::ptr::null_mut(),
        inputEvents: input_events.as_ptr(),
        outputEvents: std::ptr::null_mut(),
        processContext: std::ptr::null_mut(),
    };
    MockNoAudioProcessData {
        input_parameter_changes,
        input_events,
        process_data,
    }
}