forked from plugdata-team/JUCE
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAUBase.cpp
2061 lines (1763 loc) · 68.4 KB
/
AUBase.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
/*!
@file AudioUnitSDK/AUBase.cpp
@copyright © 2000-2021 Apple Inc. All rights reserved.
*/
#include <AudioUnitSDK/AUBase.h>
#include <AudioUnitSDK/AUInputElement.h>
#include <AudioUnitSDK/AUOutputElement.h>
#include <AudioUnitSDK/AUUtility.h>
#include <algorithm>
#include <array>
#include <cassert>
#include <limits>
namespace ausdk {
#if TARGET_OS_MAC && (TARGET_CPU_X86 || TARGET_CPU_X86_64)
class DenormalDisabler {
public:
DenormalDisabler() : mSavedMXCSR(GetCSR()) { SetCSR(mSavedMXCSR | 0x8040); }
DenormalDisabler(const DenormalDisabler&) = delete;
DenormalDisabler(DenormalDisabler&&) = delete;
DenormalDisabler& operator=(const DenormalDisabler&) = delete;
DenormalDisabler& operator=(DenormalDisabler&&) = delete;
~DenormalDisabler() { SetCSR(mSavedMXCSR); }
private:
#if 0 // not sure if this is right: // #if __has_include(<xmmintrin.h>)
static unsigned GetCSR() { return _mm_getcsr(); }
static void SetCSR(unsigned x) { _mm_setcsr(x); }
#else
// our compiler does ALL floating point with SSE
static unsigned GetCSR()
{
unsigned result{};
asm volatile("stmxcsr %0" : "=m"(*&result)); // NOLINT asm
return result;
}
static void SetCSR(unsigned a)
{
unsigned temp = a;
asm volatile("ldmxcsr %0" : : "m"(*&temp)); // NOLINT asm
}
#endif
unsigned const mSavedMXCSR;
};
#else
// while denormals can be flushed to zero on ARM processors, there is no performance benefit
class DenormalDisabler {
public:
DenormalDisabler() = default;
};
#endif
static std::once_flag sAUBaseCFStringsInitialized{}; // NOLINT non-const global
// this is used for the presets
static CFStringRef kUntitledString = nullptr; // NOLINT non-const global
// these are the current keys for the class info document
static CFStringRef kVersionString = nullptr; // NOLINT non-const global
static CFStringRef kTypeString = nullptr; // NOLINT non-const global
static CFStringRef kSubtypeString = nullptr; // NOLINT non-const global
static CFStringRef kManufacturerString = nullptr; // NOLINT non-const global
static CFStringRef kDataString = nullptr; // NOLINT non-const global
static CFStringRef kNameString = nullptr; // NOLINT non-const global
static CFStringRef kRenderQualityString = nullptr; // NOLINT non-const global
static CFStringRef kElementNameString = nullptr; // NOLINT non-const global
static CFStringRef kPartString = nullptr; // NOLINT non-const global
static constexpr auto kNoLastRenderedSampleTime = std::numeric_limits<Float64>::lowest();
//_____________________________________________________________________________
//
AUBase::AUBase(AudioComponentInstance inInstance, UInt32 numInputElements, UInt32 numOutputElements,
UInt32 numGroupElements)
: ComponentBase(inInstance), mInitNumInputEls(numInputElements),
mInitNumOutputEls(numOutputElements), mInitNumGroupEls(numGroupElements),
mLogString(CreateLoggingString())
{
ResetRenderTime();
std::call_once(sAUBaseCFStringsInitialized, []() {
kUntitledString = CFSTR("Untitled"); // NOLINT
kVersionString = CFSTR(kAUPresetVersionKey); // NOLINT
kTypeString = CFSTR(kAUPresetTypeKey); // NOLINT
kSubtypeString = CFSTR(kAUPresetSubtypeKey); // NOLINT
kManufacturerString = CFSTR(kAUPresetManufacturerKey); // NOLINT
kDataString = CFSTR(kAUPresetDataKey); // NOLINT
kNameString = CFSTR(kAUPresetNameKey); // NOLINT
kRenderQualityString = CFSTR(kAUPresetRenderQualityKey); // NOLINT
kElementNameString = CFSTR(kAUPresetElementNameKey); // NOLINT
kPartString = CFSTR(kAUPresetPartKey); // NOLINT
});
GlobalScope().Initialize(this, kAudioUnitScope_Global, 1);
mCurrentPreset.presetNumber = -1;
CFRetain(mCurrentPreset.presetName = kUntitledString);
}
//_____________________________________________________________________________
//
AUBase::~AUBase()
{
if (mCurrentPreset.presetName != nullptr) {
CFRelease(mCurrentPreset.presetName);
}
}
//_____________________________________________________________________________
//
void AUBase::PostConstructorInternal()
{
// invoked after construction because they are virtual methods and/or call virtual methods
if (mMaxFramesPerSlice == 0) {
SetMaxFramesPerSlice(kAUDefaultMaxFramesPerSlice);
}
CreateElements();
}
//_____________________________________________________________________________
//
void AUBase::PreDestructorInternal()
{
// this is called from the ComponentBase dispatcher, which doesn't know anything about our
// (optional) lock
const AUEntryGuard guard(mAUMutex);
DoCleanup();
}
//_____________________________________________________________________________
//
void AUBase::CreateElements()
{
if (!mElementsCreated) {
Inputs().Initialize(this, kAudioUnitScope_Input, mInitNumInputEls);
Outputs().Initialize(this, kAudioUnitScope_Output, mInitNumOutputEls);
Groups().Initialize(this, kAudioUnitScope_Group, mInitNumGroupEls);
CreateExtendedElements();
mElementsCreated = true;
}
}
//_____________________________________________________________________________
//
void AUBase::SetMaxFramesPerSlice(UInt32 nFrames)
{
if (nFrames == mMaxFramesPerSlice) {
return;
}
mMaxFramesPerSlice = nFrames;
if (mBuffersAllocated) {
ReallocateBuffers();
}
PropertyChanged(kAudioUnitProperty_MaximumFramesPerSlice, kAudioUnitScope_Global, 0);
}
//_____________________________________________________________________________
//
OSStatus AUBase::CanSetMaxFrames() const
{
return IsInitialized() ? kAudioUnitErr_Initialized : OSStatus(noErr);
}
//_____________________________________________________________________________
//
void AUBase::ReallocateBuffers()
{
CreateElements();
const UInt32 nOutputs = Outputs().GetNumberOfElements();
for (UInt32 i = 0; i < nOutputs; ++i) {
Output(i).AllocateBuffer(); // does no work if already allocated
}
const UInt32 nInputs = Inputs().GetNumberOfElements();
for (UInt32 i = 0; i < nInputs; ++i) {
Input(i).AllocateBuffer(); // does no work if already allocated
}
mBuffersAllocated = true;
}
//_____________________________________________________________________________
//
void AUBase::DeallocateIOBuffers()
{
if (!mBuffersAllocated) {
return;
}
const UInt32 nOutputs = Outputs().GetNumberOfElements();
for (UInt32 i = 0; i < nOutputs; ++i) {
Output(i).DeallocateBuffer();
}
const UInt32 nInputs = Inputs().GetNumberOfElements();
for (UInt32 i = 0; i < nInputs; ++i) {
Input(i).DeallocateBuffer();
}
mBuffersAllocated = false;
}
//_____________________________________________________________________________
//
OSStatus AUBase::DoInitialize()
{
OSStatus result = noErr;
if (!mInitialized) {
result = Initialize();
if (result == noErr) {
if (CanScheduleParameters()) {
mParamEventList.reserve(24); // NOLINT magic #
}
mHasBegunInitializing = true;
ReallocateBuffers(); // calls CreateElements()
mInitialized = true; // signal that it's okay to render
std::atomic_thread_fence(std::memory_order_seq_cst);
}
}
return result;
}
//_____________________________________________________________________________
//
OSStatus AUBase::Initialize() { return noErr; }
//_____________________________________________________________________________
//
void AUBase::DoCleanup()
{
if (mInitialized) {
Cleanup();
}
DeallocateIOBuffers();
ResetRenderTime();
mInitialized = false;
mHasBegunInitializing = false;
}
//_____________________________________________________________________________
//
void AUBase::Cleanup() {}
//_____________________________________________________________________________
//
OSStatus AUBase::Reset(AudioUnitScope /*inScope*/, AudioUnitElement /*inElement*/)
{
ResetRenderTime();
return noErr;
}
//_____________________________________________________________________________
//
OSStatus AUBase::DispatchGetPropertyInfo(AudioUnitPropertyID inID, AudioUnitScope inScope,
AudioUnitElement inElement, UInt32& outDataSize, bool& outWritable)
{
OSStatus result = noErr;
bool validateElement = true;
switch (inID) {
case kAudioUnitProperty_MakeConnection:
AUSDK_Require(inScope == kAudioUnitScope_Input || inScope == kAudioUnitScope_Global,
kAudioUnitErr_InvalidScope);
outDataSize = sizeof(AudioUnitConnection);
outWritable = true;
break;
case kAudioUnitProperty_SetRenderCallback:
AUSDK_Require(inScope == kAudioUnitScope_Input || inScope == kAudioUnitScope_Global,
kAudioUnitErr_InvalidScope);
outDataSize = sizeof(AURenderCallbackStruct);
outWritable = true;
break;
case kAudioUnitProperty_StreamFormat:
outDataSize = sizeof(AudioStreamBasicDescription);
outWritable = IsStreamFormatWritable(inScope, inElement);
break;
case kAudioUnitProperty_SampleRate:
outDataSize = sizeof(Float64);
outWritable = IsStreamFormatWritable(inScope, inElement);
break;
case kAudioUnitProperty_ClassInfo:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(CFPropertyListRef);
outWritable = true;
break;
case kAudioUnitProperty_FactoryPresets:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
AUSDK_Require_noerr(GetPresets(nullptr));
outDataSize = sizeof(CFArrayRef);
outWritable = false;
break;
case kAudioUnitProperty_PresentPreset:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(AUPreset);
outWritable = true;
break;
case kAudioUnitProperty_ElementName:
outDataSize = sizeof(CFStringRef);
outWritable = true;
break;
case kAudioUnitProperty_ParameterList: {
UInt32 nparams = 0;
AUSDK_Require_noerr(GetParameterList(inScope, nullptr, nparams));
outDataSize = sizeof(AudioUnitParameterID) * nparams;
outWritable = false;
validateElement = false;
break;
}
case kAudioUnitProperty_ParameterInfo:
outDataSize = sizeof(AudioUnitParameterInfo);
outWritable = false;
validateElement = false;
break;
case kAudioUnitProperty_ParameterHistoryInfo:
outDataSize = sizeof(AudioUnitParameterHistoryInfo);
outWritable = false;
validateElement = false;
break;
case kAudioUnitProperty_ElementCount:
outDataSize = sizeof(UInt32);
outWritable = BusCountWritable(inScope);
validateElement = false;
break;
case kAudioUnitProperty_Latency:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(Float64);
outWritable = false;
break;
case kAudioUnitProperty_TailTime:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
AUSDK_Require(SupportsTail(), kAudioUnitErr_InvalidProperty);
outDataSize = sizeof(Float64);
outWritable = false;
break;
case kAudioUnitProperty_MaximumFramesPerSlice:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(UInt32);
outWritable = true;
break;
case kAudioUnitProperty_LastRenderError:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(OSStatus);
outWritable = false;
break;
case kAudioUnitProperty_SupportedNumChannels: {
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
const UInt32 num = SupportedNumChannels(nullptr);
AUSDK_Require(num != 0u, kAudioUnitErr_InvalidProperty);
outDataSize = sizeof(AUChannelInfo) * num;
outWritable = false;
break;
}
case kAudioUnitProperty_SupportedChannelLayoutTags: {
const auto tags = GetChannelLayoutTags(inScope, inElement);
AUSDK_Require(!tags.empty(), kAudioUnitErr_InvalidProperty);
outDataSize = static_cast<UInt32>(tags.size() * sizeof(AudioChannelLayoutTag));
outWritable = false;
validateElement = false; // already done it
break;
}
case kAudioUnitProperty_AudioChannelLayout: {
outWritable = false;
outDataSize = GetAudioChannelLayout(inScope, inElement, nullptr, outWritable);
if (outDataSize != 0u) {
result = noErr;
} else {
const auto tags = GetChannelLayoutTags(inScope, inElement);
return tags.empty() ? kAudioUnitErr_InvalidProperty
: kAudioUnitErr_InvalidPropertyValue;
}
validateElement = false; // already done it
break;
}
case kAudioUnitProperty_ShouldAllocateBuffer:
AUSDK_Require((inScope == kAudioUnitScope_Input || inScope == kAudioUnitScope_Output),
kAudioUnitErr_InvalidScope);
outWritable = true;
outDataSize = sizeof(UInt32);
break;
case kAudioUnitProperty_ParameterValueStrings:
AUSDK_Require_noerr(GetParameterValueStrings(inScope, inElement, nullptr));
outDataSize = sizeof(CFArrayRef);
outWritable = false;
validateElement = false;
break;
case kAudioUnitProperty_HostCallbacks:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(mHostCallbackInfo);
outWritable = true;
break;
case kAudioUnitProperty_ContextName:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(CFStringRef);
outWritable = true;
break;
#if !TARGET_OS_IPHONE
case kAudioUnitProperty_IconLocation:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
AUSDK_Require(HasIcon(), kAudioUnitErr_InvalidProperty);
outWritable = false;
outDataSize = sizeof(CFURLRef);
break;
#endif
case kAudioUnitProperty_ParameterClumpName:
outDataSize = sizeof(AudioUnitParameterNameInfo);
outWritable = false;
break;
case 61: // kAudioUnitProperty_LastRenderSampleTime
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(Float64);
outWritable = false;
break;
case kAudioUnitProperty_NickName:
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
outDataSize = sizeof(CFStringRef);
outWritable = true;
break;
default:
result = GetPropertyInfo(inID, inScope, inElement, outDataSize, outWritable);
validateElement = false;
break;
}
if ((result == noErr) && validateElement) {
AUSDK_Require(GetElement(inScope, inElement) != nullptr, kAudioUnitErr_InvalidElement);
}
return result;
}
//_____________________________________________________________________________
//
// NOLINTNEXTLINE(misc-no-recursion) with SaveState
OSStatus AUBase::DispatchGetProperty(
AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement, void* outData)
{
// NOTE: We're currently only called from AUBase::ComponentEntryDispatch, which
// calls DispatchGetPropertyInfo first, which performs validation of the scope/element,
// and ensures that the outData buffer is non-null and large enough.
OSStatus result = noErr;
switch (inID) {
case kAudioUnitProperty_StreamFormat:
*static_cast<AudioStreamBasicDescription*>(outData) = GetStreamFormat(inScope, inElement);
break;
case kAudioUnitProperty_SampleRate:
*static_cast<Float64*>(outData) = GetStreamFormat(inScope, inElement).mSampleRate;
break;
case kAudioUnitProperty_ParameterList: {
UInt32 nparams = 0;
result = GetParameterList(inScope, static_cast<AudioUnitParameterID*>(outData), nparams);
break;
}
case kAudioUnitProperty_ParameterInfo:
*static_cast<AudioUnitParameterInfo*>(outData) = {};
result =
GetParameterInfo(inScope, inElement, *static_cast<AudioUnitParameterInfo*>(outData));
break;
case kAudioUnitProperty_ParameterHistoryInfo: {
auto* const info = static_cast<AudioUnitParameterHistoryInfo*>(outData);
result = GetParameterHistoryInfo(
inScope, inElement, info->updatesPerSecond, info->historyDurationInSeconds);
break;
}
case kAudioUnitProperty_ClassInfo: {
*static_cast<CFPropertyListRef*>(outData) = nullptr;
result = SaveState(static_cast<CFPropertyListRef*>(outData));
break;
}
case kAudioUnitProperty_FactoryPresets: {
*static_cast<CFArrayRef*>(outData) = nullptr;
result = GetPresets(static_cast<CFArrayRef*>(outData));
break;
}
case kAudioUnitProperty_PresentPreset: {
*static_cast<AUPreset*>(outData) = mCurrentPreset;
// retain current string (as client owns a reference to it and will release it)
if ((inID == kAudioUnitProperty_PresentPreset) && (mCurrentPreset.presetName != nullptr)) {
CFRetain(mCurrentPreset.presetName);
}
result = noErr;
break;
}
case kAudioUnitProperty_ElementName: {
const AUElement* const element = GetElement(inScope, inElement);
const CFStringRef name = *element->GetName();
AUSDK_Require(name != nullptr, kAudioUnitErr_PropertyNotInUse);
CFRetain(name); // must return a +1 reference
*static_cast<CFStringRef*>(outData) = name;
break;
}
case kAudioUnitProperty_ElementCount:
*static_cast<UInt32*>(outData) = GetScope(inScope).GetNumberOfElements();
break;
case kAudioUnitProperty_Latency:
*static_cast<Float64*>(outData) = GetLatency();
break;
case kAudioUnitProperty_TailTime:
AUSDK_Require(SupportsTail(), kAudioUnitErr_InvalidProperty);
*static_cast<Float64*>(outData) = GetTailTime();
break;
case kAudioUnitProperty_MaximumFramesPerSlice:
*static_cast<UInt32*>(outData) = mMaxFramesPerSlice;
break;
case kAudioUnitProperty_LastRenderError:
*static_cast<OSStatus*>(outData) = mLastRenderError;
mLastRenderError = 0;
break;
case kAudioUnitProperty_SupportedNumChannels: {
const AUChannelInfo* infoPtr = nullptr;
const UInt32 num = SupportedNumChannels(&infoPtr);
if (num != 0 && infoPtr != nullptr) {
memcpy(outData, infoPtr, num * sizeof(AUChannelInfo));
}
break;
}
case kAudioUnitProperty_SupportedChannelLayoutTags: {
const auto tags = GetChannelLayoutTags(inScope, inElement);
AUSDK_Require(!tags.empty(), kAudioUnitErr_InvalidProperty);
AudioChannelLayoutTag* const ptr =
outData != nullptr ? static_cast<AudioChannelLayoutTag*>(outData) : nullptr;
if (ptr != nullptr) {
memcpy(ptr, tags.data(), tags.size() * sizeof(AudioChannelLayoutTag));
}
break;
}
case kAudioUnitProperty_AudioChannelLayout: {
AudioChannelLayout* const ptr =
outData != nullptr ? static_cast<AudioChannelLayout*>(outData) : nullptr;
bool writable = false;
const UInt32 dataSize = GetAudioChannelLayout(inScope, inElement, ptr, writable);
AUSDK_Require(dataSize != 0, kAudioUnitErr_InvalidProperty);
break;
}
case kAudioUnitProperty_ShouldAllocateBuffer: {
const auto& element = IOElement(inScope, inElement);
*static_cast<UInt32*>(outData) = static_cast<UInt32>(element.WillAllocateBuffer());
break;
}
case kAudioUnitProperty_ParameterValueStrings:
result = GetParameterValueStrings(inScope, inElement, static_cast<CFArrayRef*>(outData));
break;
case kAudioUnitProperty_HostCallbacks:
memcpy(outData, &mHostCallbackInfo, sizeof(mHostCallbackInfo));
break;
case kAudioUnitProperty_ContextName:
if (const CFStringRef name = *mContextName) {
CFRetain(name); // must return a +1 reference
*static_cast<CFStringRef*>(outData) = name;
result = noErr;
} else {
*static_cast<CFStringRef*>(outData) = nullptr;
result = kAudioUnitErr_PropertyNotInUse;
}
break;
#if !TARGET_OS_IPHONE
case kAudioUnitProperty_IconLocation: {
const CFURLRef iconLocation = CopyIconLocation();
AUSDK_Require(iconLocation != nullptr, kAudioUnitErr_InvalidProperty);
*static_cast<CFURLRef*>(outData) = iconLocation;
break;
}
#endif
case kAudioUnitProperty_ParameterClumpName: {
auto* const ioClumpInfo = static_cast<AudioUnitParameterNameInfo*>(outData);
AUSDK_Require(ioClumpInfo->inID != kAudioUnitClumpID_System,
kAudioUnitErr_InvalidPropertyValue); // this ID value is reserved
result = CopyClumpName(inScope, ioClumpInfo->inID,
static_cast<UInt32>(std::max(ioClumpInfo->inDesiredLength, SInt32(0))),
&ioClumpInfo->outName);
// this is provided for compatbility with existing implementations that don't know
// about this new mechanism
if (result == kAudioUnitErr_InvalidProperty) {
result = GetProperty(inID, inScope, inElement, outData);
}
break;
}
case 61: // kAudioUnitProperty_LastRenderSampleTime
*static_cast<Float64*>(outData) = mCurrentRenderTime.mSampleTime;
break;
case kAudioUnitProperty_NickName:
// Ownership follows Core Foundation's 'Copy Rule'
if (const auto* const name = *mNickName) {
CFRetain(name);
*static_cast<CFStringRef*>(outData) = name;
} else {
*static_cast<CFStringRef*>(outData) = nullptr;
}
break;
default:
result = GetProperty(inID, inScope, inElement, outData);
break;
}
return result;
}
//_____________________________________________________________________________
//
// Note: We can be sure inData is non-null; otherwise RemoveProperty would have been called.
// NOLINTNEXTLINE(misc-no-recursion) with RestoreState
OSStatus AUBase::DispatchSetProperty(AudioUnitPropertyID inID, AudioUnitScope inScope,
AudioUnitElement inElement, const void* inData, UInt32 inDataSize)
{
OSStatus result = noErr;
switch (inID) {
case kAudioUnitProperty_MakeConnection: {
AUSDK_Require(
inDataSize >= sizeof(AudioUnitConnection), kAudioUnitErr_InvalidPropertyValue);
const auto& connection = *static_cast<const AudioUnitConnection*>(inData);
result = SetConnection(connection);
break;
}
case kAudioUnitProperty_SetRenderCallback: {
AUSDK_Require(
inDataSize >= sizeof(AURenderCallbackStruct), kAudioUnitErr_InvalidPropertyValue);
const auto& callback = *static_cast<const AURenderCallbackStruct*>(inData);
result = SetInputCallback(kAudioUnitProperty_SetRenderCallback, inElement,
callback.inputProc, callback.inputProcRefCon);
break;
}
case kAudioUnitProperty_ElementCount:
AUSDK_Require(inDataSize == sizeof(UInt32), kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require(BusCountWritable(inScope), kAudioUnitErr_PropertyNotWritable);
result = SetBusCount(inScope, *static_cast<const UInt32*>(inData));
if (result == noErr) {
PropertyChanged(inID, inScope, inElement);
}
break;
case kAudioUnitProperty_MaximumFramesPerSlice:
AUSDK_Require(inDataSize == sizeof(UInt32), kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require_noerr(CanSetMaxFrames());
SetMaxFramesPerSlice(*static_cast<const UInt32*>(inData));
break;
case kAudioUnitProperty_StreamFormat: {
constexpr static UInt32 kMinimumValidASBDSize = 36;
AUSDK_Require(inDataSize >= kMinimumValidASBDSize, kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require(GetElement(inScope, inElement) != nullptr, kAudioUnitErr_InvalidElement);
AudioStreamBasicDescription newDesc = {};
// now we're going to be ultra conservative! because of discrepancies between
// sizes of this struct based on aligment padding inconsistencies
memcpy(&newDesc, inData, kMinimumValidASBDSize);
AUSDK_Require(ASBD::MinimalSafetyCheck(newDesc), kAudioUnitErr_FormatNotSupported);
AUSDK_Require(ValidFormat(inScope, inElement, newDesc), kAudioUnitErr_FormatNotSupported);
const AudioStreamBasicDescription curDesc = GetStreamFormat(inScope, inElement);
if (!ASBD::IsEqual(curDesc, newDesc)) {
AUSDK_Require(
IsStreamFormatWritable(inScope, inElement), kAudioUnitErr_PropertyNotWritable);
result = ChangeStreamFormat(inScope, inElement, curDesc, newDesc);
}
break;
}
case kAudioUnitProperty_SampleRate: {
AUSDK_Require(inDataSize == sizeof(Float64), kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require(GetElement(inScope, inElement) != nullptr, kAudioUnitErr_InvalidElement);
const AudioStreamBasicDescription curDesc = GetStreamFormat(inScope, inElement);
AudioStreamBasicDescription newDesc = curDesc;
newDesc.mSampleRate = *static_cast<const Float64*>(inData);
AUSDK_Require(ValidFormat(inScope, inElement, newDesc), kAudioUnitErr_FormatNotSupported);
if (!ASBD::IsEqual(curDesc, newDesc)) {
AUSDK_Require(
IsStreamFormatWritable(inScope, inElement), kAudioUnitErr_PropertyNotWritable);
result = ChangeStreamFormat(inScope, inElement, curDesc, newDesc);
}
break;
}
case kAudioUnitProperty_AudioChannelLayout: {
const auto& layout = *static_cast<const AudioChannelLayout*>(inData);
constexpr size_t headerSize = sizeof(AudioChannelLayout) - sizeof(AudioChannelDescription);
AUSDK_Require(inDataSize >= offsetof(AudioChannelLayout, mNumberChannelDescriptions) +
sizeof(AudioChannelLayout::mNumberChannelDescriptions),
kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require(inDataSize >= headerSize + layout.mNumberChannelDescriptions *
sizeof(AudioChannelDescription),
kAudioUnitErr_InvalidPropertyValue);
result = SetAudioChannelLayout(inScope, inElement, &layout);
if (result == noErr) {
PropertyChanged(inID, inScope, inElement);
}
break;
}
case kAudioUnitProperty_ClassInfo:
AUSDK_Require(inDataSize == sizeof(CFPropertyListRef*), kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
result = RestoreState(*static_cast<const CFPropertyListRef*>(inData));
break;
case kAudioUnitProperty_PresentPreset: {
AUSDK_Require(inDataSize == sizeof(AUPreset), kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
const auto& newPreset = *static_cast<const AUPreset*>(inData);
if (newPreset.presetNumber >= 0) {
result = NewFactoryPresetSet(newPreset);
// NewFactoryPresetSet SHOULD call SetAFactoryPreset if the preset is valid
// from its own list of preset number->name
if (result == noErr) {
PropertyChanged(inID, inScope, inElement);
}
} else if (newPreset.presetName != nullptr) {
result = NewCustomPresetSet(newPreset);
if (result == noErr) {
PropertyChanged(inID, inScope, inElement);
}
} else {
result = kAudioUnitErr_InvalidPropertyValue;
}
break;
}
case kAudioUnitProperty_ElementName: {
AUSDK_Require(GetElement(inScope, inElement) != nullptr, kAudioUnitErr_InvalidElement);
AUSDK_Require(inDataSize == sizeof(CFStringRef), kAudioUnitErr_InvalidPropertyValue);
const auto element = GetScope(inScope).GetElement(inElement);
const CFStringRef inStr = *static_cast<const CFStringRef*>(inData);
element->SetName(inStr);
PropertyChanged(inID, inScope, inElement);
break;
}
case kAudioUnitProperty_ShouldAllocateBuffer: {
AUSDK_Require((inScope == kAudioUnitScope_Input || inScope == kAudioUnitScope_Output),
kAudioUnitErr_InvalidScope);
AUSDK_Require(GetElement(inScope, inElement) != nullptr, kAudioUnitErr_InvalidElement);
AUSDK_Require(inDataSize == sizeof(UInt32), kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require(!IsInitialized(), kAudioUnitErr_Initialized);
auto& element = IOElement(inScope, inElement);
element.SetWillAllocateBuffer(*static_cast<const UInt32*>(inData) != 0);
break;
}
case kAudioUnitProperty_HostCallbacks: {
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
const UInt32 availSize =
std::min(inDataSize, static_cast<UInt32>(sizeof(HostCallbackInfo)));
const bool hasChanged = memcmp(&mHostCallbackInfo, inData, availSize) == 0;
mHostCallbackInfo = {};
memcpy(&mHostCallbackInfo, inData, availSize);
if (hasChanged) {
PropertyChanged(inID, inScope, inElement);
}
break;
}
case kAudioUnitProperty_ContextName: {
AUSDK_Require(inDataSize == sizeof(CFStringRef), kAudioUnitErr_InvalidPropertyValue);
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
const CFStringRef inStr = *static_cast<const CFStringRef*>(inData);
mContextName = inStr;
PropertyChanged(inID, inScope, inElement);
break;
}
case kAudioUnitProperty_NickName: {
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
AUSDK_Require(inDataSize == sizeof(CFStringRef), kAudioUnitErr_InvalidPropertyValue);
const CFStringRef inStr = *static_cast<const CFStringRef*>(inData);
mNickName = inStr;
PropertyChanged(inID, inScope, inElement);
break;
}
default:
result = SetProperty(inID, inScope, inElement, inData, inDataSize);
if (result == noErr) {
PropertyChanged(inID, inScope, inElement);
}
break;
}
return result;
}
//_____________________________________________________________________________
//
OSStatus AUBase::DispatchRemovePropertyValue(
AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement)
{
OSStatus result = noErr;
switch (inID) {
case kAudioUnitProperty_AudioChannelLayout: {
result = RemoveAudioChannelLayout(inScope, inElement);
if (result == noErr) {
PropertyChanged(inID, inScope, inElement);
}
break;
}
case kAudioUnitProperty_HostCallbacks: {
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
bool hasValue = false;
const void* const ptr = &mHostCallbackInfo;
for (size_t i = 0; i < sizeof(HostCallbackInfo); ++i) {
if (static_cast<const char*>(ptr)[i] != 0) { // NOLINT
hasValue = true;
break;
}
}
if (hasValue) {
mHostCallbackInfo = {};
PropertyChanged(inID, inScope, inElement);
}
break;
}
case kAudioUnitProperty_ContextName:
mContextName = nullptr;
result = noErr;
break;
case kAudioUnitProperty_NickName: {
AUSDK_Require(inScope == kAudioUnitScope_Global, kAudioUnitErr_InvalidScope);
mNickName = nullptr;
PropertyChanged(inID, inScope, inElement);
break;
}
default:
result = RemovePropertyValue(inID, inScope, inElement);
break;
}
return result;
}
//_____________________________________________________________________________
//
OSStatus AUBase::GetPropertyInfo(AudioUnitPropertyID /*inID*/, AudioUnitScope /*inScope*/,
AudioUnitElement /*inElement*/, UInt32& /*outDataSize*/, bool& /*outWritable*/)
{
return kAudioUnitErr_InvalidProperty;
}
//_____________________________________________________________________________
//
OSStatus AUBase::GetProperty(AudioUnitPropertyID /*inID*/, AudioUnitScope /*inScope*/,
AudioUnitElement /*inElement*/, void* /*outData*/)
{
return kAudioUnitErr_InvalidProperty;
}
//_____________________________________________________________________________
//
OSStatus AUBase::SetProperty(AudioUnitPropertyID /*inID*/, AudioUnitScope /*inScope*/,
AudioUnitElement /*inElement*/, const void* /*inData*/, UInt32 /*inDataSize*/)
{
return kAudioUnitErr_InvalidProperty;
}
//_____________________________________________________________________________
//
OSStatus AUBase::RemovePropertyValue(
AudioUnitPropertyID /*inID*/, AudioUnitScope /*inScope*/, AudioUnitElement /*inElement*/)
{
return kAudioUnitErr_InvalidPropertyValue;
}
//_____________________________________________________________________________
//
OSStatus AUBase::AddPropertyListener(
AudioUnitPropertyID inID, AudioUnitPropertyListenerProc inProc, void* inProcRefCon)
{
const PropertyListener pl{
.propertyID = inID, .listenerProc = inProc, .listenerRefCon = inProcRefCon
};
if (mPropertyListeners.empty()) {
mPropertyListeners.reserve(32); // NOLINT magic#
}
mPropertyListeners.push_back(pl);
return noErr;
}
//_____________________________________________________________________________
//
OSStatus AUBase::RemovePropertyListener(AudioUnitPropertyID inID,
AudioUnitPropertyListenerProc inProc, void* inProcRefCon, bool refConSpecified)
{
const auto iter =
std::remove_if(mPropertyListeners.begin(), mPropertyListeners.end(), [&](auto& item) {
return item.propertyID == inID && item.listenerProc == inProc &&
(!refConSpecified || item.listenerRefCon == inProcRefCon);
});
if (iter != mPropertyListeners.end()) {
mPropertyListeners.erase(iter, mPropertyListeners.end());
}
return noErr;
}
//_____________________________________________________________________________
//
void AUBase::PropertyChanged(
AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement)
{
for (const auto& pl : mPropertyListeners) {
if (pl.propertyID == inID) {
(pl.listenerProc)(pl.listenerRefCon, GetComponentInstance(), inID, inScope, inElement);
}
}
}
//_____________________________________________________________________________
//
OSStatus AUBase::SetRenderNotification(AURenderCallback inProc, void* inRefCon)
{
if (inProc == nullptr) {
return kAudio_ParamError;
}
mRenderCallbacksTouched = true;
mRenderCallbacks.add(RenderCallback(inProc, inRefCon));
// this will do nothing if it's already in the list
return noErr;
}