/
DistrhoPluginVST3.cpp
3755 lines (3122 loc) · 131 KB
/
DistrhoPluginVST3.cpp
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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* DISTRHO Plugin Framework (DPF)
* Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
*
* Permission to use, copy, modify, and/or distribute this software for any purpose with
* or without fee is hereby granted, provided that the above copyright notice and this
* permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
* TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
* NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include "DistrhoPluginInternal.hpp"
#include "../extra/ScopedPointer.hpp"
#if DISTRHO_PLUGIN_HAS_UI && ! DISTRHO_PLUGIN_HAS_EMBED_UI
# undef DISTRHO_PLUGIN_HAS_UI
# define DISTRHO_PLUGIN_HAS_UI 0
#endif
#if DISTRHO_PLUGIN_HAS_UI && ! defined(HAVE_DGL) && ! DISTRHO_PLUGIN_HAS_EXTERNAL_UI
# undef DISTRHO_PLUGIN_HAS_UI
# define DISTRHO_PLUGIN_HAS_UI 0
#endif
#if DISTRHO_PLUGIN_HAS_UI
# include "../extra/RingBuffer.hpp"
#endif
#include "travesty/audio_processor.h"
#include "travesty/component.h"
#include "travesty/edit_controller.h"
#include "travesty/factory.h"
#include "travesty/host.h"
#ifdef DISTRHO_PROPER_CPP11_SUPPORT
# include <atomic>
#else
// quick and dirty std::atomic replacement for the things we need
namespace std {
struct atomic_int {
volatile int value;
explicit atomic_int(volatile int v) noexcept : value(v) {}
int operator++() volatile noexcept { return __atomic_add_fetch(&value, 1, __ATOMIC_RELAXED); }
int operator--() volatile noexcept { return __atomic_sub_fetch(&value, 1, __ATOMIC_RELAXED); }
operator int() volatile noexcept { return __atomic_load_n(&value, __ATOMIC_RELAXED); }
};
}
#endif
#include <map>
#include <string>
#include <vector>
/* TODO items:
* - parameter enumeration as lists
* - hide parameter outputs?
* - hide program parameter?
* - deal with parameter triggers
* - MIDI CC changes (need to store value to give to the host?)
* - MIDI program changes
* - MIDI sysex
* - append MIDI input events in a sorted way
* - bus arrangements
* - optional audio buses, create dummy buffer of max_block_size length for them
* - routing info, do we care?
* - set sidechain bus name from port group
* - implement getParameterValueForString (use names from enumeration if available, fallback to std::atof)
* - set factory email (needs new DPF API, useful for LV2 as well)
* - do something with get_controller_class_id and set_io_mode?
*/
START_NAMESPACE_DISTRHO
// --------------------------------------------------------------------------------------------------------------------
#if ! DISTRHO_PLUGIN_WANT_MIDI_OUTPUT
static constexpr const writeMidiFunc writeMidiCallback = nullptr;
#endif
#if ! DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST
static constexpr const requestParameterValueChangeFunc requestParameterValueChangeCallback = nullptr;
#endif
typedef std::map<const String, String> StringMap;
// --------------------------------------------------------------------------------------------------------------------
// custom v3_tuid compatible type
typedef uint32_t dpf_tuid[4];
#ifdef DISTRHO_PROPER_CPP11_SUPPORT
static_assert(sizeof(v3_tuid) == sizeof(dpf_tuid), "uid size mismatch");
#endif
// --------------------------------------------------------------------------------------------------------------------
// custom, constant uids related to DPF
static constexpr const uint32_t dpf_id_entry = d_cconst('D', 'P', 'F', ' ');
static constexpr const uint32_t dpf_id_clas = d_cconst('c', 'l', 'a', 's');
static constexpr const uint32_t dpf_id_comp = d_cconst('c', 'o', 'm', 'p');
static constexpr const uint32_t dpf_id_ctrl = d_cconst('c', 't', 'r', 'l');
static constexpr const uint32_t dpf_id_proc = d_cconst('p', 'r', 'o', 'c');
static constexpr const uint32_t dpf_id_view = d_cconst('v', 'i', 'e', 'w');
// --------------------------------------------------------------------------------------------------------------------
// plugin specific uids (values are filled in during plugin init)
static dpf_tuid dpf_tuid_class = { dpf_id_entry, dpf_id_clas, 0, 0 };
static dpf_tuid dpf_tuid_component = { dpf_id_entry, dpf_id_comp, 0, 0 };
static dpf_tuid dpf_tuid_controller = { dpf_id_entry, dpf_id_ctrl, 0, 0 };
static dpf_tuid dpf_tuid_processor = { dpf_id_entry, dpf_id_proc, 0, 0 };
static dpf_tuid dpf_tuid_view = { dpf_id_entry, dpf_id_view, 0, 0 };
// --------------------------------------------------------------------------------------------------------------------
// Utility functions
const char* tuid2str(const v3_tuid iid)
{
static constexpr const struct {
v3_tuid iid;
const char* name;
} extra_known_iids[] = {
{ V3_ID(0x00000000,0x00000000,0x00000000,0x00000000), "(nil)" },
// edit-controller
{ V3_ID(0xF040B4B3,0xA36045EC,0xABCDC045,0xB4D5A2CC), "{v3_component_handler2|NOT}" },
{ V3_ID(0x7F4EFE59,0xF3204967,0xAC27A3AE,0xAFB63038), "{v3_edit_controller2|NOT}" },
{ V3_ID(0x067D02C1,0x5B4E274D,0xA92D90FD,0x6EAF7240), "{v3_component_handler_bus_activation|NOT}" },
{ V3_ID(0xC1271208,0x70594098,0xB9DD34B3,0x6BB0195E), "{v3_edit_controller_host_editing|NOT}" },
// units
{ V3_ID(0x8683B01F,0x7B354F70,0xA2651DEC,0x353AF4FF), "{v3_program_list_data|NOT}" },
{ V3_ID(0x6C389611,0xD391455D,0xB870B833,0x94A0EFDD), "{v3_unit_data|NOT}" },
{ V3_ID(0x4B5147F8,0x4654486B,0x8DAB30BA,0x163A3C56), "{v3_unit_handler|NOT}" },
{ V3_ID(0xF89F8CDF,0x699E4BA5,0x96AAC9A4,0x81452B01), "{v3_unit_handler2|NOT}" },
{ V3_ID(0x3D4BD6B5,0x913A4FD2,0xA886E768,0xA5EB92C1), "{v3_unit_info|NOT}" },
// misc
{ V3_ID(0x0F194781,0x8D984ADA,0xBBA0C1EF,0xC011D8D0), "{v3_info_listener|NOT}" },
};
if (v3_tuid_match(iid, v3_audio_processor_iid))
return "{v3_audio_processor}";
if (v3_tuid_match(iid, v3_attribute_list_iid))
return "{v3_attribute_list_iid}";
if (v3_tuid_match(iid, v3_bstream_iid))
return "{v3_bstream}";
if (v3_tuid_match(iid, v3_component_iid))
return "{v3_component}";
if (v3_tuid_match(iid, v3_component_handler_iid))
return "{v3_component_handler}";
if (v3_tuid_match(iid, v3_connection_point_iid))
return "{v3_connection_point_iid}";
if (v3_tuid_match(iid, v3_edit_controller_iid))
return "{v3_edit_controller}";
if (v3_tuid_match(iid, v3_event_handler_iid))
return "{v3_event_handler_iid}";
if (v3_tuid_match(iid, v3_event_list_iid))
return "{v3_event_list}";
if (v3_tuid_match(iid, v3_funknown_iid))
return "{v3_funknown}";
if (v3_tuid_match(iid, v3_host_application_iid))
return "{v3_host_application_iid}";
if (v3_tuid_match(iid, v3_message_iid))
return "{v3_message_iid}";
if (v3_tuid_match(iid, v3_midi_mapping_iid))
return "{v3_midi_mapping_iid}";
if (v3_tuid_match(iid, v3_param_value_queue_iid))
return "{v3_param_value_queue}";
if (v3_tuid_match(iid, v3_param_changes_iid))
return "{v3_param_changes}";
if (v3_tuid_match(iid, v3_plugin_base_iid))
return "{v3_plugin_base}";
if (v3_tuid_match(iid, v3_plugin_factory_iid))
return "{v3_plugin_factory}";
if (v3_tuid_match(iid, v3_plugin_factory_2_iid))
return "{v3_plugin_factory_2}";
if (v3_tuid_match(iid, v3_plugin_factory_3_iid))
return "{v3_plugin_factory_3}";
if (v3_tuid_match(iid, v3_plugin_frame_iid))
return "{v3_plugin_frame}";
if (v3_tuid_match(iid, v3_plugin_view_iid))
return "{v3_plugin_view}";
if (v3_tuid_match(iid, v3_plugin_view_content_scale_iid))
return "{v3_plugin_view_content_scale_iid}";
if (v3_tuid_match(iid, v3_plugin_view_parameter_finder_iid))
return "{v3_plugin_view_parameter_finder}";
if (v3_tuid_match(iid, v3_process_context_requirements_iid))
return "{v3_process_context_requirements}";
if (v3_tuid_match(iid, v3_run_loop_iid))
return "{v3_run_loop_iid}";
if (v3_tuid_match(iid, v3_timer_handler_iid))
return "{v3_timer_handler_iid}";
if (std::memcmp(iid, dpf_tuid_class, sizeof(dpf_tuid)) == 0)
return "{dpf_tuid_class}";
if (std::memcmp(iid, dpf_tuid_component, sizeof(dpf_tuid)) == 0)
return "{dpf_tuid_component}";
if (std::memcmp(iid, dpf_tuid_controller, sizeof(dpf_tuid)) == 0)
return "{dpf_tuid_controller}";
if (std::memcmp(iid, dpf_tuid_processor, sizeof(dpf_tuid)) == 0)
return "{dpf_tuid_processor}";
if (std::memcmp(iid, dpf_tuid_view, sizeof(dpf_tuid)) == 0)
return "{dpf_tuid_view}";
for (size_t i=0; i<ARRAY_SIZE(extra_known_iids); ++i)
{
if (v3_tuid_match(iid, extra_known_iids[i].iid))
return extra_known_iids[i].name;
}
static char buf[46];
std::snprintf(buf, sizeof(buf), "{0x%08X,0x%08X,0x%08X,0x%08X}",
(uint32_t)d_cconst(iid[ 0], iid[ 1], iid[ 2], iid[ 3]),
(uint32_t)d_cconst(iid[ 4], iid[ 5], iid[ 6], iid[ 7]),
(uint32_t)d_cconst(iid[ 8], iid[ 9], iid[10], iid[11]),
(uint32_t)d_cconst(iid[12], iid[13], iid[14], iid[15]));
return buf;
}
// --------------------------------------------------------------------------------------------------------------------
static void strncpy(char* const dst, const char* const src, const size_t length)
{
DISTRHO_SAFE_ASSERT_RETURN(length > 0,);
if (const size_t len = std::min(std::strlen(src), length-1U))
{
std::memcpy(dst, src, len);
dst[len] = '\0';
}
else
{
dst[0] = '\0';
}
}
void strncpy_utf16(int16_t* const dst, const char* const src, const size_t length)
{
DISTRHO_SAFE_ASSERT_RETURN(length > 0,);
if (const size_t len = std::min(std::strlen(src), length-1U))
{
for (size_t i=0; i<len; ++i)
{
// skip non-ascii chars
if ((uint8_t)src[i] >= 0x80)
continue;
dst[i] = src[i];
}
dst[len] = 0;
}
else
{
dst[0] = 0;
}
}
// --------------------------------------------------------------------------------------------------------------------
template<typename T>
static void snprintf_t(char* const dst, const T value, const char* const format, const size_t size)
{
DISTRHO_SAFE_ASSERT_RETURN(size > 0,);
std::snprintf(dst, size-1, format, value);
dst[size-1] = '\0';
}
template<typename T>
static void snprintf_utf16_t(int16_t* const dst, const T value, const char* const format, const size_t size)
{
DISTRHO_SAFE_ASSERT_RETURN(size > 0,);
char* const tmpbuf = (char*)std::malloc(size);
DISTRHO_SAFE_ASSERT_RETURN(tmpbuf != nullptr,);
std::snprintf(tmpbuf, size-1, format, value);
tmpbuf[size-1] = '\0';
strncpy_utf16(dst, tmpbuf, size);
std::free(tmpbuf);
}
static inline
void snprintf_u32(char* const dst, const uint32_t value, const size_t size)
{
return snprintf_t<uint32_t>(dst, value, "%u", size);
}
static inline
void snprintf_f32_utf16(int16_t* const dst, const float value, const size_t size)
{
return snprintf_utf16_t<float>(dst, value, "%f", size);
}
// --------------------------------------------------------------------------------------------------------------------
// handy way to create a utf16 string on the current function scope, used for message strings
struct ScopedUTF16String {
int16_t* str;
ScopedUTF16String(const char* const s) noexcept;
~ScopedUTF16String() noexcept;
operator int16_t*() const noexcept;
};
// --------------------------------------------------------------------------------------------------------------------
ScopedUTF16String::ScopedUTF16String(const char* const s) noexcept
: str(nullptr)
{
const size_t len = strlen(s);
str = (int16_t*)malloc(sizeof(int16_t) * len);
DISTRHO_SAFE_ASSERT_RETURN(str != nullptr,);
strncpy_utf16(str, s, len);
}
ScopedUTF16String::~ScopedUTF16String() noexcept
{
std::free(str);
}
ScopedUTF16String::operator int16_t*() const noexcept
{
return str;
}
// --------------------------------------------------------------------------------------------------------------------
// dpf_plugin_view_create (implemented on UI side)
v3_plugin_view** dpf_plugin_view_create(v3_host_application** host, void* instancePointer, double sampleRate);
// --------------------------------------------------------------------------------------------------------------------
/**
* VST3 DSP class.
*
* All the dynamic things from VST3 get implemented here, free of complex low-level VST3 pointer things.
* The DSP is created during the "initialize" component event, and destroyed during "terminate".
*
* The low-level VST3 stuff comes after.
*/
class PluginVst3
{
/* buses: we provide 1 for the main audio (if there is any) plus 1 for each sidechain or cv port.
* Main audio comes first, if available.
* Then sidechain, also if available.
* And finally each CV port individually.
*
* MIDI will have a single bus, nothing special there.
*/
struct BusInfo {
uint8_t audio; // either 0 or 1
uint8_t sidechain; // either 0 or 1
uint32_t numMainAudio;
uint32_t numSidechain;
uint32_t numCV;
BusInfo()
: audio(0),
sidechain(0),
numMainAudio(0),
numSidechain(0),
numCV(0) {}
} inputBuses, outputBuses;
public:
PluginVst3(v3_host_application** const context)
: fPlugin(this, writeMidiCallback, requestParameterValueChangeCallback),
fComponentHandler(nullptr),
#if DISTRHO_PLUGIN_HAS_UI
fConnection(nullptr),
fHostContext(context),
#endif
fParameterOffset(fPlugin.getParameterOffset()),
fRealParameterCount(fParameterOffset + fPlugin.getParameterCount()),
fParameterValues(nullptr),
fChangedParameterValues(nullptr)
#if DISTRHO_PLUGIN_HAS_UI
, fConnectedToUI(false)
, fNextSampleRate(0.0)
#endif
#if DISTRHO_PLUGIN_WANT_LATENCY
, fLastKnownLatency(fPlugin.getLatency())
#endif
#if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT
, fHostEventOutputHandle(nullptr)
#endif
#if DISTRHO_PLUGIN_WANT_PROGRAMS
, fCurrentProgram(0)
, fProgramCountMinusOne(fPlugin.getProgramCount()-1)
#endif
{
#if DISTRHO_PLUGIN_NUM_INPUTS > 0
for (uint32_t i=0; i<DISTRHO_PLUGIN_NUM_INPUTS; ++i)
{
const uint32_t hints = fPlugin.getAudioPortHints(true, i);
if (hints & kAudioPortIsCV)
++inputBuses.numCV;
else
++inputBuses.numMainAudio;
if (hints & kAudioPortIsSidechain)
++inputBuses.numSidechain;
}
if (inputBuses.numMainAudio != 0)
inputBuses.audio = 1;
if (inputBuses.numSidechain != 0)
inputBuses.sidechain = 1;
uint32_t cvInputBusId = 0;
for (uint32_t i=0; i<DISTRHO_PLUGIN_NUM_INPUTS; ++i)
{
AudioPortWithBusId& port(fPlugin.getAudioPort(true, i));
if (port.hints & kAudioPortIsCV)
port.busId = inputBuses.audio + inputBuses.sidechain + cvInputBusId++;
else if (port.hints & kAudioPortIsSidechain)
port.busId = 1;
else
port.busId = 0;
}
#endif
#if DISTRHO_PLUGIN_NUM_OUTPUTS > 0
for (uint32_t i=0; i<DISTRHO_PLUGIN_NUM_OUTPUTS; ++i)
{
const uint32_t hints = fPlugin.getAudioPortHints(false, i);
if (hints & kAudioPortIsCV)
++outputBuses.numCV;
else
++outputBuses.numMainAudio;
if (hints & kAudioPortIsSidechain)
++outputBuses.numSidechain;
}
if (outputBuses.numMainAudio != 0)
outputBuses.audio = 1;
if (outputBuses.numSidechain != 0)
outputBuses.sidechain = 1;
uint32_t cvOutputBusId = 0;
for (uint32_t i=0; i<DISTRHO_PLUGIN_NUM_OUTPUTS; ++i)
{
AudioPortWithBusId& port(fPlugin.getAudioPort(false, i));
if (port.hints & kAudioPortIsCV)
port.busId = outputBuses.audio + outputBuses.sidechain + cvOutputBusId++;
else if (port.hints & kAudioPortIsSidechain)
port.busId = 1;
else
port.busId = 0;
}
#endif
if (const uint32_t parameterCount = fPlugin.getParameterCount())
{
fParameterValues = new float[parameterCount];
for (uint32_t i=0; i < parameterCount; ++i)
fParameterValues[i] = fPlugin.getParameterDefault(i);
}
if (fRealParameterCount != 0)
{
fChangedParameterValues = new bool[fRealParameterCount];
std::memset(fChangedParameterValues, 0, sizeof(bool)*fRealParameterCount);
}
#if DISTRHO_PLUGIN_WANT_STATE
for (uint32_t i=0, count=fPlugin.getStateCount(); i<count; ++i)
{
const String& dkey(fPlugin.getStateKey(i));
fStateMap[dkey] = fPlugin.getStateDefaultValue(i);
}
#endif
#if !DISTRHO_PLUGIN_HAS_UI
// unused
return; (void)context;
#endif
}
~PluginVst3()
{
if (fParameterValues != nullptr)
{
delete[] fParameterValues;
fParameterValues = nullptr;
}
if (fChangedParameterValues != nullptr)
{
delete[] fChangedParameterValues;
fChangedParameterValues = nullptr;
}
}
// ----------------------------------------------------------------------------------------------------------------
// stuff called for UI creation
void* getInstancePointer() const noexcept
{
return fPlugin.getInstancePointer();
}
double getSampleRate() const noexcept
{
return fPlugin.getSampleRate();
}
// ----------------------------------------------------------------------------------------------------------------
// v3_component interface calls
int32_t getBusCount(const int32_t mediaType, const int32_t busDirection) const noexcept
{
switch (mediaType)
{
case V3_AUDIO:
if (busDirection == V3_INPUT)
return inputBuses.audio + inputBuses.sidechain + inputBuses.numCV;
if (busDirection == V3_OUTPUT)
return outputBuses.audio + outputBuses.sidechain + outputBuses.numCV;
break;
case V3_EVENT:
#if DISTRHO_PLUGIN_WANT_MIDI_INPUT
if (busDirection == V3_INPUT)
return 1;
#endif
#if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT
if (busDirection == V3_OUTPUT)
return 1;
#endif
break;
}
return 0;
}
v3_result getBusInfo(const int32_t mediaType,
const int32_t busDirection,
const int32_t busIndex,
v3_bus_info* const info) const
{
DISTRHO_SAFE_ASSERT_INT_RETURN(mediaType == V3_AUDIO || mediaType == V3_EVENT, mediaType, V3_INVALID_ARG);
DISTRHO_SAFE_ASSERT_INT_RETURN(busDirection == V3_INPUT || busDirection == V3_OUTPUT, busDirection, V3_INVALID_ARG);
DISTRHO_SAFE_ASSERT_INT_RETURN(busIndex >= 0, busIndex, V3_INVALID_ARG);
#if DISTRHO_PLUGIN_NUM_INPUTS+DISTRHO_PLUGIN_NUM_OUTPUTS > 0 || DISTRHO_PLUGIN_WANT_MIDI_INPUT || DISTRHO_PLUGIN_WANT_MIDI_OUTPUT
const uint32_t busId = static_cast<uint32_t>(busIndex);
#endif
if (mediaType == V3_AUDIO)
{
#if DISTRHO_PLUGIN_NUM_INPUTS+DISTRHO_PLUGIN_NUM_OUTPUTS > 0
int32_t numChannels;
v3_bus_flags flags;
v3_bus_types busType;
v3_str_128 busName = {};
if (busDirection == V3_INPUT)
{
#if DISTRHO_PLUGIN_NUM_INPUTS > 0
switch (busId)
{
case 0:
if (inputBuses.audio)
{
numChannels = inputBuses.numMainAudio;
busType = V3_MAIN;
flags = V3_DEFAULT_ACTIVE;
break;
}
// fall-through
case 1:
if (inputBuses.sidechain)
{
numChannels = inputBuses.numSidechain;
busType = V3_AUX;
flags = v3_bus_flags(0);
break;
}
// fall-through
default:
numChannels = 1;
busType = V3_AUX;
flags = V3_IS_CONTROL_VOLTAGE;
break;
}
if (busType == V3_MAIN)
{
strncpy_utf16(busName, "Audio Input", 128);
}
else
{
for (uint32_t i=0; i<DISTRHO_PLUGIN_NUM_INPUTS; ++i)
{
const AudioPortWithBusId& port(fPlugin.getAudioPort(true, i));
// TODO find port group name for sidechain buses
if (port.busId == busId)
{
strncpy_utf16(busName, port.name, 128);
break;
}
}
}
#else
return V3_INVALID_ARG;
#endif // DISTRHO_PLUGIN_NUM_INPUTS
}
else
{
#if DISTRHO_PLUGIN_NUM_OUTPUTS > 0
switch (busId)
{
case 0:
if (outputBuses.audio)
{
numChannels = outputBuses.numMainAudio;
busType = V3_MAIN;
flags = V3_DEFAULT_ACTIVE;
break;
}
// fall-through
case 1:
if (outputBuses.sidechain)
{
numChannels = outputBuses.numSidechain;
busType = V3_AUX;
flags = v3_bus_flags(0);
break;
}
// fall-through
default:
numChannels = 1;
busType = V3_AUX;
flags = V3_IS_CONTROL_VOLTAGE;
break;
}
if (busType == V3_MAIN)
{
strncpy_utf16(busName, "Audio Output", 128);
}
else
{
for (uint32_t i=0; i<DISTRHO_PLUGIN_NUM_OUTPUTS; ++i)
{
const AudioPortWithBusId& port(fPlugin.getAudioPort(false, i));
// TODO find port group name for sidechain buses
if (port.busId == busId)
{
strncpy_utf16(busName, port.name, 128);
break;
}
}
}
#else
return V3_INVALID_ARG;
#endif // DISTRHO_PLUGIN_NUM_OUTPUTS
}
std::memset(info, 0, sizeof(v3_bus_info));
info->media_type = V3_AUDIO;
info->direction = busDirection;
info->channel_count = numChannels;
std::memcpy(info->bus_name, busName, sizeof(busName));
info->bus_type = busType;
info->flags = flags;
return V3_OK;
#else
return V3_INVALID_ARG;
#endif // DISTRHO_PLUGIN_NUM_INPUTS+DISTRHO_PLUGIN_NUM_OUTPUTS
}
else
{
if (busDirection == V3_INPUT)
{
#if DISTRHO_PLUGIN_WANT_MIDI_INPUT
DISTRHO_SAFE_ASSERT_RETURN(busId == 0, V3_INVALID_ARG);
#else
return V3_INVALID_ARG;
#endif
}
else
{
#if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT
DISTRHO_SAFE_ASSERT_RETURN(busId == 0, V3_INVALID_ARG);
#else
return V3_INVALID_ARG;
#endif
}
info->media_type = V3_EVENT;
info->direction = busDirection;
info->channel_count = 1;
strncpy_utf16(info->bus_name, busDirection == V3_INPUT ? "Event/MIDI Input"
: "Event/MIDI Output", 128);
info->bus_type = V3_MAIN;
info->flags = V3_DEFAULT_ACTIVE;
return V3_OK;
}
}
v3_result getRoutingInfo(v3_routing_info*, v3_routing_info*)
{
// TODO
return V3_NOT_IMPLEMENTED;
}
v3_result activateBus(const int32_t /* mediaType */,
const int32_t /* busDirection */,
const int32_t /* busIndex */,
const bool /* state */)
{
// TODO, returning ok to make bitwig happy
return V3_OK;
}
v3_result setActive(const bool active)
{
if (active)
fPlugin.activate();
else
fPlugin.deactivateIfNeeded();
return V3_OK;
}
/* state: we pack pairs of key-value strings each separated by a null/zero byte.
* current-program comes first, then dpf key/value states and then parameters.
* parameters are simply converted to/from strings and floats.
* the parameter symbol is used as the "key", so it is possible to reorder them or even remove and add safely.
* there are markers for begin and end of state and parameters, so they never conflict.
*/
v3_result setState(v3_bstream** const stream)
{
#if DISTRHO_PLUGIN_HAS_UI
const bool connectedToUI = fConnection != nullptr && fConnectedToUI;
#endif
const uint32_t paramCount = fPlugin.getParameterCount();
String key, value;
bool fillingKey = true; // if filling key or value
char queryingType = 'i'; // can be 'n', 's' or 'p' (none, states, parameters)
char buffer[512], orig;
buffer[sizeof(buffer)-1] = '\xff';
v3_result res;
for (int32_t pos = 0, term = 0, read; term == 0; pos += read)
{
res = v3_cpp_obj(stream)->read(stream, buffer, sizeof(buffer)-1, &read);
DISTRHO_SAFE_ASSERT_INT_RETURN(res == V3_OK, res, res);
DISTRHO_SAFE_ASSERT_INT_RETURN(read > 0, read, V3_INTERNAL_ERR);
for (int32_t i = 0; i < read; ++i)
{
// found terminator, stop here
if (buffer[i] == '\xfe')
{
term = 1;
break;
}
// store character at read position
orig = buffer[read];
// place null character to create valid string
buffer[read] = '\0';
// append to temporary vars
if (fillingKey)
key += buffer + i;
else
value += buffer + i;
// increase buffer offset by length of string
i += std::strlen(buffer + i);
// restore read character
buffer[read] = orig;
// if buffer offset points to null, we found the end of a string, lets check
if (buffer[i] == '\0')
{
// special keys
if (key == "__dpf_state_begin__")
{
DISTRHO_SAFE_ASSERT_INT_RETURN(queryingType == 'i' || queryingType == 'n',
queryingType, V3_INTERNAL_ERR);
queryingType = 's';
key.clear();
value.clear();
continue;
}
if (key == "__dpf_state_end__")
{
DISTRHO_SAFE_ASSERT_INT_RETURN(queryingType == 's', queryingType, V3_INTERNAL_ERR);
queryingType = 'n';
key.clear();
value.clear();
continue;
}
if (key == "__dpf_parameters_begin__")
{
DISTRHO_SAFE_ASSERT_INT_RETURN(queryingType == 'i' || queryingType == 'n',
queryingType, V3_INTERNAL_ERR);
queryingType = 'p';
key.clear();
value.clear();
continue;
}
if (key == "__dpf_parameters_end__")
{
DISTRHO_SAFE_ASSERT_INT_RETURN(queryingType == 'p', queryingType, V3_INTERNAL_ERR);
queryingType = 'x';
key.clear();
value.clear();
continue;
}
// no special key, swap between reading real key and value
fillingKey = !fillingKey;
// if there is no value yet keep reading until we have one (TODO check empty values on purpose)
if (value.isEmpty())
continue;
if (key == "__dpf_program__")
{
DISTRHO_SAFE_ASSERT_INT_RETURN(queryingType == 'i', queryingType, V3_INTERNAL_ERR);
queryingType = 'n';
d_stdout("found program '%s'", value.buffer());
#if DISTRHO_PLUGIN_WANT_PROGRAMS
const int program = std::atoi(value.buffer());
DISTRHO_SAFE_ASSERT_CONTINUE(program >= 0);
fCurrentProgram = static_cast<uint32_t>(program);
fPlugin.loadProgram(fCurrentProgram);
# if DISTRHO_PLUGIN_HAS_UI
if (connectedToUI)
{
fChangedParameterValues[0] = false;
sendParameterChangeToUI(0, fCurrentProgram);
}
# endif
#endif
}
else if (queryingType == 's')
{
d_stdout("found state '%s' '%s'", key.buffer(), value.buffer());
#if DISTRHO_PLUGIN_WANT_STATE
if (fPlugin.wantStateKey(key))
{
fStateMap[key] = value;
fPlugin.setState(key, value);
# if DISTRHO_PLUGIN_HAS_UI
if (connectedToUI)
sendStateChangeToUI(key, value);
# endif
}
#endif
}
else if (queryingType == 'p')
{
d_stdout("found parameter '%s' '%s'", key.buffer(), value.buffer());
// find parameter with this symbol, and set its value
for (uint32_t j=0; j < paramCount; ++j)
{
if (fPlugin.isParameterOutputOrTrigger(j))
continue;
if (fPlugin.getParameterSymbol(j) != key)
continue;
const float fvalue = fParameterValues[j] = std::atof(value.buffer());
fPlugin.setParameterValue(j, fvalue);
#if DISTRHO_PLUGIN_HAS_UI
if (connectedToUI)
{
// UI parameter updates are handled outside the read loop (after host param restart)
fChangedParameterValues[j + fParameterOffset] = true;
}
#endif
break;
}
}
key.clear();
value.clear();
}
}
}
if (paramCount != 0)
{
if (fComponentHandler != nullptr)
v3_cpp_obj(fComponentHandler)->restart_component(fComponentHandler, V3_RESTART_PARAM_VALUES_CHANGED);
#if DISTRHO_PLUGIN_HAS_UI
if (connectedToUI)
{
for (uint32_t i=0; i < paramCount; ++i)
{
if (fPlugin.isParameterOutputOrTrigger(i))
continue;
fChangedParameterValues[i + fParameterOffset] = false;
sendParameterChangeToUI(i + fParameterOffset, fParameterValues[i]);
}
}
#endif
}
return V3_OK;
}
v3_result getState(v3_bstream** const stream)
{
const uint32_t paramCount = fPlugin.getParameterCount();
#if DISTRHO_PLUGIN_WANT_STATE
const uint32_t stateCount = fPlugin.getStateCount();
#else
const uint32_t stateCount = 0;
#endif
if (stateCount == 0 && paramCount == 0)
{
char buffer = '\0';
int32_t ignored;
return v3_cpp_obj(stream)->write(stream, &buffer, 1, &ignored);
}
#if DISTRHO_PLUGIN_WANT_FULL_STATE
// Update current state
for (StringMap::const_iterator cit=fStateMap.begin(), cite=fStateMap.end(); cit != cite; ++cit)
{
const String& key = cit->first;
fStateMap[key] = fPlugin.getState(key);
}
#endif
String state;
#if DISTRHO_PLUGIN_WANT_PROGRAMS
{
String tmpStr("__dpf_program__\xff");
tmpStr += String(fCurrentProgram);
tmpStr += "\xff";
state += tmpStr;
}
#endif
#if DISTRHO_PLUGIN_WANT_STATE
if (stateCount != 0)
{
state += "__dpf_state_begin__\xff";
for (StringMap::const_iterator cit=fStateMap.begin(), cite=fStateMap.end(); cit != cite; ++cit)
{
const String& key = cit->first;
const String& value = cit->second;
// join key and value
String tmpStr;
tmpStr = key;
tmpStr += "\xff";
tmpStr += value;
tmpStr += "\xff";
state += tmpStr;
}
state += "__dpf_state_end__\xff";
}
#endif
if (paramCount != 0)
{
state += "__dpf_parameters_begin__\xff";
for (uint32_t i=0; i<paramCount; ++i)
{
if (fPlugin.isParameterOutputOrTrigger(i))
continue;
// join key and value
String tmpStr;