/
spatialize_effect.cpp
1478 lines (1288 loc) · 50.8 KB
/
spatialize_effect.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
//
// Copyright 2017-2023 Valve Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include <assert.h>
#include <string.h>
#include <algorithm>
#include <atomic>
#include "steamaudio_fmod.h"
namespace SteamAudioFMOD {
extern std::shared_ptr<SourceManager> gSourceManager;
namespace SpatializeEffect {
/**
* DSP parameters for the "Steam Audio Spatializer" effect.
*/
enum Params
{
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_DATA`
*
* World-space position of the source. Automatically written by FMOD Studio.
*/
SOURCE_POSITION,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_DATA`
*
* Overall linear gain of this effect. Automatically read by FMOD Studio.
*/
OVERALL_GAIN,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* **Range**: 0 to 2.
*
* How to render distance attenuation.
*
* - `0`: Don't render distance attenuation.
* - `1`: Use a distance attenuation value calculated using the default physics-based model.
* - `2`: Use a distance attenuation value calculated using the curve specified in the FMOD Studio UI.
*/
APPLY_DISTANCEATTENUATION,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* **Range**: 0 to 2.
*
* How to render air absorption.
*
* - `0`: Don't render air absorption.
* - `1`: Use air absorption values calculated using the default exponential decay model.
* - `2`: Use air absorption values specified in the \c AIRABSORPTION_LOW, \c AIRABSORPTION_MID, and
* \c AIRABSORPTION_HIGH parameters.
*/
APPLY_AIRABSORPTION,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* **Range**: 0 to 2.
*
* How to render directivity.
*
* - `0`: Don't render directivity.
* - `1`: Use a directivity value calculated using the default dipole model, driven by the
* \c DIRECTIVITY_DIPOLEWEIGHT and \c DIRECTIVITY_DIPOLEPOWER parameters.
* - `2`: Use the directivity value specified in the \c DIRECTIVITY parameter.
*/
APPLY_DIRECTIVITY,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* **Range**: 0 to 2.
*
* How to render occlusion.
*
* - `0`: Don't render occlusion.
* - `1`: Use the occlusion value calculated by the game engine using simulation, and provided via the
* \c SIMULATION_OUTPUTS parameter.
* - `2`: Use the occlusion value specified in the \c OCCLUSION parameter.
*/
APPLY_OCCLUSION,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* **Range**: 0 to 2.
*
* How to render transmission.
*
* - `0`: Don't render transmission.
* - `1`: Use the transmission values calculated by the game engine using simulation, and provided via the
* \c SIMULATION_OUTPUTS parameter.
* - `2`: Use the transmission values specified in the \c TRANSMISSION_LOW, \c TRANSMISSION_MID, and
* \c TRANSMISSION_HIGH parameters.
*/
APPLY_TRANSMISSION,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_BOOL`
*
* If true, reflections are rendered, using the data calculated by the game engine using simulation, and provided
* via the \c SIMULATION_OUTPUTS parameter.
*/
APPLY_REFLECTIONS,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_BOOL`
*
* If true, pathing is rendered, using the data calculated by the game engine using simulation, and provided
* via the \c SIMULATION_OUTPUTS parameter.
*/
APPLY_PATHING,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* **Range**: 0 to 1.
*
* Controls how HRTFs are interpolated when the source moves relative to the listener.
*
* - `0`: Nearest-neighbor interpolation.
* - `1`: Bilinear interpolation.
*/
HRTF_INTERPOLATION,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* Not currently used.
*/
DISTANCEATTENUATION,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* **Range**: 0 to 4.
*
* Type of distance attenuation curve preset to use when \c APPLY_DISTANCEATTENUATION is \c 1.
*
* - `0`: Linear squared rolloff.
* - `1`: Linear rolloff.
* - `2`: Inverse rolloff.
* - `3`: Inverse squared rolloff.
* - `4`: Custom rolloff.
*/
DISTANCEATTENUATION_ROLLOFFTYPE,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 10000.
*
* Minimum distance value for the distance attenuation curve.
*/
DISTANCEATTENUATION_MINDISTANCE,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 10000.
*
* Maximum distance value for the distance attenuation curve.
*/
DISTANCEATTENUATION_MAXDISTANCE,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The low frequency (up to 800 Hz) EQ value for air absorption. Only used if \c APPLY_AIRABSORPTION is set to
* \c 2. 0 = low frequencies are completely attenuated, 1 = low frequencies are not attenuated at all.
*/
AIRABSORPTION_LOW,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The middle frequency (800 Hz - 8 kHz) EQ value for air absorption. Only used if \c APPLY_AIRABSORPTION is set
* to \c 2. 0 = middle frequencies are completely attenuated, 1 = middle frequencies are not attenuated at all.
*/
AIRABSORPTION_MID,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The high frequency (8 kHz and above) EQ value for air absorption. Only used if \c APPLY_AIRABSORPTION is set to
* \c 2. 0 = high frequencies are completely attenuated, 1 = high frequencies are not attenuated at all.
*/
AIRABSORPTION_HIGH,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The directivity attenuation value. Only used if \c APPLY_DIRECTIVITY is set to \c 2. 0 = sound is completely
* attenuated, 1 = sound is not attenuated at all.
*/
DIRECTIVITY,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* Blends between monopole (omnidirectional) and dipole directivity patterns. 0 = pure monopole (sound is emitted
* in all directions with equal intensity), 1 = pure dipole (sound is focused to the front and back of the source).
* At 0.5, the source has a cardioid directivity, with most of the sound emitted to the front of the source. Only
* used if \c APPLY_DIRECTIVITY is set to \c 1.
*/
DIRECTIVITY_DIPOLEWEIGHT,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 4.
*
* Controls how focused the dipole directivity is. Higher values result in sharper directivity patterns. Only used
* if \c APPLY_DIRECTIVITY is set to \c 1.
*/
DIRECTIVITY_DIPOLEPOWER,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The occlusion attenuation value. Only used if \c APPLY_OCCLUSION is set to \c 2. 0 = sound is completely
* attenuated, 1 = sound is not attenuated at all.
*/
OCCLUSION,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* **Range**: 0 to 1.
*
* Specifies how the transmission filter is applied.
*
* - `0`: Transmission is modeled as a single attenuation factor.
* - `1`: Transmission is modeled as a 3-band EQ.
*/
TRANSMISSION_TYPE,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The low frequency (up to 800 Hz) EQ value for transmission. Only used if \c APPLY_TRANSMISSION is set to \c 2.
* 0 = low frequencies are completely attenuated, 1 = low frequencies are not attenuated at all.
*/
TRANSMISSION_LOW,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The middle frequency (800 Hz to 8 kHz) EQ value for transmission. Only used if \c APPLY_TRANSMISSION is set to
* \c 2. 0 = middle frequencies are completely attenuated, 1 = middle frequencies are not attenuated at all.
*/
TRANSMISSION_MID,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The high frequency (8 kHz and above) EQ value for transmission. Only used if \c APPLY_TRANSMISSION is set to
* \c 2. 0 = high frequencies are completely attenuated, 1 = high frequencies are not attenuated at all.
*/
TRANSMISSION_HIGH,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 1.
*
* The contribution of the direct sound path to the overall mix for this event. Lower values reduce the
* contribution more.
*/
DIRECT_MIXLEVEL,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_BOOL`
*
* If true, applies HRTF-based 3D audio rendering to reflections. Results in an improvement in spatialization
* quality when using convolution or hybrid reverb, at the cost of slightly increased CPU usage.
*/
REFLECTIONS_BINAURAL,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 10.
*
* The contribution of reflections to the overall mix for this event. Lower values reduce the contribution more.
*/
REFLECTIONS_MIXLEVEL,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_BOOL`
*
* If true, applies HRTF-based 3D audio rendering to pathing. Results in an improvement in spatialization
* quality, at the cost of slightly increased CPU usage.
*/
PATHING_BINAURAL,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_FLOAT`
*
* **Range**: 0 to 10.
*
* The contribution of pathing to the overall mix for this event. Lower values reduce the contribution more.
*/
PATHING_MIXLEVEL,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_DATA`
*
* **DEPRECATED**
*
* Pointer to the `IPLSimulationOutputs` structure containing simulation results.
*/
SIMULATION_OUTPUTS,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_BOOL`
*
* If true, applies HRTF-based 3D audio rendering to the direct sound path. Otherwise, sound is panned based on
* the speaker configuration.
*/
DIRECT_BINAURAL,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_DATA`
*
* (FMOD Studio 2.02+) The event's min/max distance range. Automatically set by FMOD Studio.
*/
DISTANCE_ATTENUATION_RANGE,
/**
* **Type**: `FMOD_DSP_PARAMETER_TYPE_INT`
*
* Handle of the `IPLSource` object to use for obtaining simulation results. The handle can
* be obtained by calling `iplFMODAddSource`.
*/
SIMULATION_OUTPUTS_HANDLE,
/** The number of parameters in this effect. */
NUM_PARAMS
};
FMOD_DSP_PARAMETER_DESC gParams[] = {
{ FMOD_DSP_PARAMETER_TYPE_DATA, "SourcePos", "", "Position of the source." },
{ FMOD_DSP_PARAMETER_TYPE_DATA, "OverallGain", "", "Overall gain." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "ApplyDA", "", "Apply distance attenuation." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "ApplyAA", "", "Apply air absorption." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "ApplyDir", "", "Apply directivity." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "ApplyOccl", "", "Apply occlusion." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "ApplyTrans", "", "Apply transmission." },
{ FMOD_DSP_PARAMETER_TYPE_BOOL, "ApplyRefl", "", "Apply reflections." },
{ FMOD_DSP_PARAMETER_TYPE_BOOL, "ApplyPath", "", "Apply pathing." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "Interpolation", "", "HRTF interpolation." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "DistAtt", "", "Distance attenuation." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "DAType", "", "Distance attenuation rolloff type." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "DAMinDist", "", "Distance attenuation min distance." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "DAMaxDist", "", "Distance attenuation max distance." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "AirAbsLow", "", "Air absorption (low frequency)." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "AirAbsMid", "", "Air absorption (mid frequency)." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "AirAbsHigh", "", "Air absorption (high frequency)." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "Directivity", "", "Directivity." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "DipoleWeight", "", "Directivity dipole weight." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "DipolePower", "", "Directivity dipole power." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "Occlusion", "", "Occlusion." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "TransType", "", "Transmission type." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "TransLow", "", "Transmission (low frequency)." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "TransMid", "", "Transmission (mid frequency)." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "TransHigh", "", "Transmission (high frequency)." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "DirMixLevel", "", "Direct mix level." },
{ FMOD_DSP_PARAMETER_TYPE_BOOL, "ReflBinaural", "", "Apply HRTF to reflections." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "ReflMixLevel", "", "Reflections mix level." },
{ FMOD_DSP_PARAMETER_TYPE_BOOL, "PathBinaural", "", "Apply HRTF to pathing." },
{ FMOD_DSP_PARAMETER_TYPE_FLOAT, "PathMixLevel", "", "Pathing mix level." },
{ FMOD_DSP_PARAMETER_TYPE_DATA, "SimOutputs", "", "Simulation outputs." },
{ FMOD_DSP_PARAMETER_TYPE_BOOL, "DirectBinaural", "", "Apply HRTF to direct path." },
{ FMOD_DSP_PARAMETER_TYPE_DATA, "DistRange", "", "Distance attenuation range." },
{ FMOD_DSP_PARAMETER_TYPE_INT, "SimOutHandle", "", "Simulation outputs handle." },
};
FMOD_DSP_PARAMETER_DESC* gParamsArray[NUM_PARAMS];
const char* gParameterApplyTypeValues[] = {"Off", "Simulation-Defined", "User-Defined"};
const char* gDistanceAttenuationTypeValues[] = {"Off", "Physics-Based", "Curve-Driven"};
const char* gHRTFInterpolationValues[] = {"Nearest", "Bilinear"};
const char* gTransmissionTypeValues[] = {"Frequency Independent", "Frequency Dependent"};
const char* gRolloffTypeValues[] = {"Linear Squared", "Linear", "Inverse", "Inverse Squared", "Custom"};
void initParamDescs()
{
for (auto i = 0; i < NUM_PARAMS; ++i)
{
gParamsArray[i] = &gParams[i];
}
gParams[SOURCE_POSITION].datadesc = {FMOD_DSP_PARAMETER_DATA_TYPE_3DATTRIBUTES};
gParams[OVERALL_GAIN].datadesc = {FMOD_DSP_PARAMETER_DATA_TYPE_OVERALLGAIN};
gParams[APPLY_DISTANCEATTENUATION].intdesc = {0, 2, 0, false, gDistanceAttenuationTypeValues};
gParams[APPLY_AIRABSORPTION].intdesc = {0, 2, 0, false, gParameterApplyTypeValues};
gParams[APPLY_DIRECTIVITY].intdesc = {0, 2, 0, false, gParameterApplyTypeValues};
gParams[APPLY_OCCLUSION].intdesc = {0, 2, 0, false, gParameterApplyTypeValues};
gParams[APPLY_TRANSMISSION].intdesc = {0, 2, 0, false, gParameterApplyTypeValues};
gParams[APPLY_REFLECTIONS].booldesc = {false};
gParams[APPLY_PATHING].booldesc = {false};
gParams[HRTF_INTERPOLATION].intdesc = {0, 1, 0, false, gHRTFInterpolationValues};
gParams[DISTANCEATTENUATION].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[DISTANCEATTENUATION_ROLLOFFTYPE].intdesc = {0, 4, 2, false, gRolloffTypeValues};
gParams[DISTANCEATTENUATION_MINDISTANCE].floatdesc = {0.0f, 10000.0f, 1.0f};
gParams[DISTANCEATTENUATION_MAXDISTANCE].floatdesc = {0.0f, 10000.0f, 20.0f};
gParams[AIRABSORPTION_LOW].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[AIRABSORPTION_MID].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[AIRABSORPTION_HIGH].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[DIRECTIVITY].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[DIRECTIVITY_DIPOLEWEIGHT].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[DIRECTIVITY_DIPOLEPOWER].floatdesc = {1.0f, 4.0f, 1.0f};
gParams[OCCLUSION].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[TRANSMISSION_TYPE].intdesc = {0, 1, 0, false, gTransmissionTypeValues};
gParams[TRANSMISSION_LOW].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[TRANSMISSION_MID].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[TRANSMISSION_HIGH].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[DIRECT_MIXLEVEL].floatdesc = {0.0f, 1.0f, 1.0f};
gParams[REFLECTIONS_BINAURAL].booldesc = {false};
gParams[REFLECTIONS_MIXLEVEL].floatdesc = {0.0f, 10.0f, 1.0f};
gParams[PATHING_BINAURAL].booldesc = {false};
gParams[PATHING_MIXLEVEL].floatdesc = {0.0f, 10.0f, 1.0f};
gParams[SIMULATION_OUTPUTS].datadesc = {FMOD_DSP_PARAMETER_DATA_TYPE_USER};
gParams[DIRECT_BINAURAL].booldesc = {true};
gParams[DISTANCE_ATTENUATION_RANGE].datadesc = {FMOD_DSP_PARAMETER_DATA_TYPE_ATTENUATION_RANGE};
gParams[SIMULATION_OUTPUTS_HANDLE].intdesc = {-1, 10000, -1};
}
struct State
{
FMOD_DSP_PARAMETER_3DATTRIBUTES source;
FMOD_DSP_PARAMETER_OVERALLGAIN overallGain;
ParameterApplyType applyDistanceAttenuation;
ParameterApplyType applyAirAbsorption;
ParameterApplyType applyDirectivity;
ParameterApplyType applyOcclusion;
ParameterApplyType applyTransmission;
bool applyReflections;
bool applyPathing;
bool directBinaural;
IPLHRTFInterpolation hrtfInterpolation;
float distanceAttenuation;
FMOD_DSP_PAN_3D_ROLLOFF_TYPE distanceAttenuationRolloffType;
float distanceAttenuationMinDistance;
float distanceAttenuationMaxDistance;
float airAbsorption[3];
float directivity;
float dipoleWeight;
float dipolePower;
float occlusion;
IPLTransmissionType transmissionType;
float transmission[3];
float directMixLevel;
bool reflectionsBinaural;
float reflectionsMixLevel;
bool pathingBinaural;
float pathingMixLevel;
FMOD_DSP_PARAMETER_ATTENUATION_RANGE attenuationRange;
std::atomic<bool> attenuationRangeSet;
IPLSource simulationSource[2];
std::atomic<bool> newSimulationSourceWritten;
float prevDirectMixLevel;
float prevReflectionsMixLevel;
float prevPathingMixLevel;
IPLAudioBuffer inBuffer;
IPLAudioBuffer outBuffer;
IPLAudioBuffer directBuffer;
IPLAudioBuffer monoBuffer;
IPLAudioBuffer reflectionsBuffer;
IPLAudioBuffer reflectionsSpatializedBuffer;
IPLPanningEffect panningEffect;
IPLBinauralEffect binauralEffect;
IPLDirectEffect directEffect;
IPLReflectionEffect reflectionEffect;
IPLPathEffect pathEffect;
IPLAmbisonicsDecodeEffect ambisonicsEffect;
};
enum InitFlags
{
INIT_NONE = 0,
INIT_DIRECTAUDIOBUFFERS = 1 << 0,
INIT_REFLECTIONAUDIOBUFFERS = 1 << 1,
INIT_DIRECTEFFECT = 1 << 2,
INIT_BINAURALEFFECT = 1 << 3,
INIT_REFLECTIONEFFECT = 1 << 4,
INIT_PATHEFFECT = 1 << 5,
INIT_AMBISONICSEFFECT = 1 << 6
};
InitFlags lazyInit(FMOD_DSP_STATE* state,
int numChannelsIn,
int numChannelsOut)
{
auto initFlags = INIT_NONE;
IPLAudioSettings audioSettings;
state->functions->getsamplerate(state, &audioSettings.samplingRate);
state->functions->getblocksize(state, reinterpret_cast<unsigned int*>(&audioSettings.frameSize));
if (!gContext && isRunningInEditor())
{
initContextAndDefaultHRTF(audioSettings);
}
if (!gContext)
return initFlags;
if (!gHRTF[1])
return initFlags;
auto effect = reinterpret_cast<State*>(state->plugindata);
auto status = IPL_STATUS_SUCCESS;
if (numChannelsOut > 0)
{
if (!effect->panningEffect)
{
IPLPanningEffectSettings effectSettings{};
effectSettings.speakerLayout = speakerLayoutForNumChannels(numChannelsOut);
status = iplPanningEffectCreate(gContext, &audioSettings, &effectSettings, &effect->panningEffect);
}
if (status == IPL_STATUS_SUCCESS)
{
if (!effect->binauralEffect)
{
IPLBinauralEffectSettings effectSettings;
effectSettings.hrtf = gHRTF[1];
status = iplBinauralEffectCreate(gContext, &audioSettings, &effectSettings, &effect->binauralEffect);
}
}
if (status == IPL_STATUS_SUCCESS)
initFlags = static_cast<InitFlags>(initFlags | INIT_BINAURALEFFECT);
}
if (numChannelsIn > 0)
{
status = IPL_STATUS_SUCCESS;
if (!effect->directEffect)
{
IPLDirectEffectSettings effectSettings;
effectSettings.numChannels = numChannelsIn;
status = iplDirectEffectCreate(gContext, &audioSettings, &effectSettings, &effect->directEffect);
}
if (status == IPL_STATUS_SUCCESS)
initFlags = static_cast<InitFlags>(initFlags | INIT_DIRECTEFFECT);
}
if (effect->applyReflections && gIsSimulationSettingsValid)
{
status = IPL_STATUS_SUCCESS;
if (!effect->reflectionEffect)
{
IPLReflectionEffectSettings effectSettings;
effectSettings.type = gSimulationSettings.reflectionType;
effectSettings.numChannels = numChannelsForOrder(gSimulationSettings.maxOrder);
effectSettings.irSize = numSamplesForDuration(gSimulationSettings.maxDuration, audioSettings.samplingRate);
status = iplReflectionEffectCreate(gContext, &audioSettings, &effectSettings, &effect->reflectionEffect);
}
if (status == IPL_STATUS_SUCCESS)
initFlags = static_cast<InitFlags>(initFlags | INIT_REFLECTIONEFFECT);
}
if (effect->applyPathing && gIsSimulationSettingsValid)
{
status = IPL_STATUS_SUCCESS;
if (!effect->pathEffect)
{
IPLPathEffectSettings effectSettings{};
effectSettings.maxOrder = gSimulationSettings.maxOrder;
effectSettings.spatialize = IPL_TRUE;
effectSettings.speakerLayout = speakerLayoutForNumChannels(numChannelsOut);
effectSettings.hrtf = gHRTF[1];
status = iplPathEffectCreate(gContext, &audioSettings, &effectSettings, &effect->pathEffect);
}
if (status == IPL_STATUS_SUCCESS)
initFlags = static_cast<InitFlags>(initFlags | INIT_PATHEFFECT);
}
if (numChannelsOut > 0 && gIsSimulationSettingsValid)
{
status = IPL_STATUS_SUCCESS;
if (!effect->ambisonicsEffect)
{
IPLAmbisonicsDecodeEffectSettings effectSettings;
effectSettings.speakerLayout = speakerLayoutForNumChannels(numChannelsOut);
effectSettings.hrtf = gHRTF[1];
effectSettings.maxOrder = gSimulationSettings.maxOrder;
status = iplAmbisonicsDecodeEffectCreate(gContext, &audioSettings, &effectSettings, &effect->ambisonicsEffect);
}
if (status == IPL_STATUS_SUCCESS)
initFlags = static_cast<InitFlags>(initFlags | INIT_AMBISONICSEFFECT);
}
if (numChannelsIn > 0 && numChannelsOut > 0)
{
if (!effect->inBuffer.data)
iplAudioBufferAllocate(gContext, numChannelsIn, audioSettings.frameSize, &effect->inBuffer);
if (!effect->outBuffer.data)
iplAudioBufferAllocate(gContext, numChannelsOut, audioSettings.frameSize, &effect->outBuffer);
if (!effect->directBuffer.data)
iplAudioBufferAllocate(gContext, numChannelsIn, audioSettings.frameSize, &effect->directBuffer);
if (!effect->monoBuffer.data)
iplAudioBufferAllocate(gContext, 1, audioSettings.frameSize, &effect->monoBuffer);
initFlags = static_cast<InitFlags>(initFlags | INIT_DIRECTAUDIOBUFFERS);
if ((effect->applyReflections || effect->applyPathing) && gIsSimulationSettingsValid)
{
auto numAmbisonicChannels = numChannelsForOrder(gSimulationSettings.maxOrder);
if (!effect->reflectionsBuffer.data)
iplAudioBufferAllocate(gContext, numAmbisonicChannels, audioSettings.frameSize, &effect->reflectionsBuffer);
if (!effect->reflectionsSpatializedBuffer.data)
iplAudioBufferAllocate(gContext, numChannelsOut, audioSettings.frameSize, &effect->reflectionsSpatializedBuffer);
initFlags = static_cast<InitFlags>(initFlags | INIT_REFLECTIONAUDIOBUFFERS);
}
}
return initFlags;
}
void reset(FMOD_DSP_STATE* state)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
if (!effect)
return;
effect->applyDistanceAttenuation = PARAMETER_USERDEFINED;
effect->applyAirAbsorption = PARAMETER_DISABLE;
effect->applyDirectivity = PARAMETER_DISABLE;
effect->applyOcclusion = PARAMETER_DISABLE;
effect->applyTransmission = PARAMETER_DISABLE;
effect->applyReflections = false;
effect->applyPathing = false;
effect->directBinaural = true;
effect->hrtfInterpolation = IPL_HRTFINTERPOLATION_NEAREST;
effect->distanceAttenuation = 1.0f;
effect->distanceAttenuationRolloffType = FMOD_DSP_PAN_3D_ROLLOFF_INVERSE;
effect->distanceAttenuationMinDistance = 1.0f;
effect->distanceAttenuationMaxDistance = 20.0f;
effect->airAbsorption[0] = 1.0f;
effect->airAbsorption[1] = 1.0f;
effect->airAbsorption[2] = 1.0f;
effect->directivity = 1.0f;
effect->dipoleWeight = 0.0f;
effect->dipolePower = 1.0f;
effect->occlusion = 1.0f;
effect->transmissionType = IPL_TRANSMISSIONTYPE_FREQINDEPENDENT;
effect->transmission[0] = 1.0f;
effect->transmission[1] = 1.0f;
effect->transmission[2] = 1.0f;
effect->reflectionsBinaural = false;
effect->reflectionsMixLevel = 1.0f;
effect->pathingBinaural = false;
effect->pathingMixLevel = 1.0f;
effect->attenuationRange.min = 1.0f;
effect->attenuationRange.max = 20.0f;
effect->attenuationRangeSet = false;
effect->simulationSource[0] = nullptr;
effect->simulationSource[1] = nullptr;
effect->newSimulationSourceWritten = false;
effect->prevDirectMixLevel = 1.0f;
effect->prevReflectionsMixLevel = 0.0f;
effect->prevPathingMixLevel = 0.0f;
}
FMOD_RESULT F_CALL create(FMOD_DSP_STATE* state)
{
state->plugindata = new State();
reset(state);
lazyInit(state, 0, 0);
return FMOD_OK;
}
FMOD_RESULT F_CALL release(FMOD_DSP_STATE* state)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
iplAudioBufferFree(gContext, &effect->inBuffer);
iplAudioBufferFree(gContext, &effect->outBuffer);
iplAudioBufferFree(gContext, &effect->directBuffer);
iplAudioBufferFree(gContext, &effect->monoBuffer);
iplAudioBufferFree(gContext, &effect->reflectionsBuffer);
iplAudioBufferFree(gContext, &effect->reflectionsSpatializedBuffer);
iplPanningEffectRelease(&effect->panningEffect);
iplBinauralEffectRelease(&effect->binauralEffect);
iplDirectEffectRelease(&effect->directEffect);
iplReflectionEffectRelease(&effect->reflectionEffect);
iplPathEffectRelease(&effect->pathEffect);
iplAmbisonicsDecodeEffectRelease(&effect->ambisonicsEffect);
effect->newSimulationSourceWritten = false;
iplSourceRelease(&effect->simulationSource[0]);
iplSourceRelease(&effect->simulationSource[1]);
delete state->plugindata;
return FMOD_OK;
}
FMOD_RESULT F_CALL getBool(FMOD_DSP_STATE* state,
int index,
FMOD_BOOL* value,
char*)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
switch (index)
{
case DIRECT_BINAURAL:
*value = effect->directBinaural;
break;
case APPLY_REFLECTIONS:
*value = effect->applyReflections;
break;
case APPLY_PATHING:
*value = effect->applyPathing;
break;
case REFLECTIONS_BINAURAL:
*value = effect->reflectionsBinaural;
break;
case PATHING_BINAURAL:
*value = effect->pathingBinaural;
break;
default:
return FMOD_ERR_INVALID_PARAM;
}
return FMOD_OK;
}
FMOD_RESULT F_CALL getInt(FMOD_DSP_STATE* state,
int index,
int* value,
char*)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
switch (index)
{
case APPLY_DISTANCEATTENUATION:
*value = static_cast<int>(effect->applyDistanceAttenuation);
break;
case APPLY_AIRABSORPTION:
*value = static_cast<int>(effect->applyAirAbsorption);
break;
case APPLY_DIRECTIVITY:
*value = static_cast<int>(effect->applyDirectivity);
break;
case APPLY_OCCLUSION:
*value = static_cast<int>(effect->applyOcclusion);
break;
case APPLY_TRANSMISSION:
*value = static_cast<int>(effect->applyTransmission);
break;
case HRTF_INTERPOLATION:
*value = static_cast<int>(effect->hrtfInterpolation);
break;
case DISTANCEATTENUATION_ROLLOFFTYPE:
*value = static_cast<int>(effect->distanceAttenuationRolloffType);
break;
case TRANSMISSION_TYPE:
*value = static_cast<int>(effect->transmissionType);
break;
case SIMULATION_OUTPUTS_HANDLE:
*value = -1;
break;
default:
return FMOD_ERR_INVALID_PARAM;
}
return FMOD_OK;
}
FMOD_RESULT F_CALL getFloat(FMOD_DSP_STATE* state,
int index,
float* value,
char*)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
switch (index)
{
case DISTANCEATTENUATION:
*value = effect->distanceAttenuation;
break;
case DISTANCEATTENUATION_MINDISTANCE:
*value = effect->distanceAttenuationMinDistance;
break;
case DISTANCEATTENUATION_MAXDISTANCE:
*value = effect->distanceAttenuationMaxDistance;
break;
case AIRABSORPTION_LOW:
*value = effect->airAbsorption[0];
break;
case AIRABSORPTION_MID:
*value = effect->airAbsorption[1];
break;
case AIRABSORPTION_HIGH:
*value = effect->airAbsorption[2];
break;
case DIRECTIVITY:
*value = effect->directivity;
break;
case DIRECTIVITY_DIPOLEWEIGHT:
*value = effect->dipoleWeight;
break;
case DIRECTIVITY_DIPOLEPOWER:
*value = effect->dipolePower;
break;
case OCCLUSION:
*value = effect->occlusion;
break;
case TRANSMISSION_LOW:
*value = effect->transmission[0];
break;
case TRANSMISSION_MID:
*value = effect->transmission[1];
break;
case TRANSMISSION_HIGH:
*value = effect->transmission[2];
break;
case DIRECT_MIXLEVEL:
*value = effect->directMixLevel;
break;
case REFLECTIONS_MIXLEVEL:
*value = effect->reflectionsMixLevel;
break;
case PATHING_MIXLEVEL:
*value = effect->pathingMixLevel;
break;
default:
return FMOD_ERR_INVALID_PARAM;
}
return FMOD_OK;
}
FMOD_RESULT F_CALL getData(FMOD_DSP_STATE* state,
int index,
void** value,
unsigned int* length,
char*)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
switch (index)
{
case OVERALL_GAIN:
*value = static_cast<void*>(&effect->overallGain);
*length = sizeof(effect->overallGain);
break;
default:
return FMOD_ERR_INVALID_PARAM;
}
return FMOD_OK;
}
FMOD_RESULT F_CALL setBool(FMOD_DSP_STATE* state,
int index,
FMOD_BOOL value)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
switch (index)
{
case DIRECT_BINAURAL:
effect->directBinaural = value;
break;
case APPLY_REFLECTIONS:
effect->applyReflections = value;
break;
case APPLY_PATHING:
effect->applyPathing = value;
break;
case REFLECTIONS_BINAURAL:
effect->reflectionsBinaural = value;
break;
case PATHING_BINAURAL:
effect->pathingBinaural = value;
break;
default:
return FMOD_ERR_INVALID_PARAM;
}
return FMOD_OK;
}
void setSource(FMOD_DSP_STATE* state,
IPLSource source)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
if (source == effect->simulationSource[1])
return;
if (!effect->newSimulationSourceWritten)
{
iplSourceRelease(&effect->simulationSource[1]);
effect->simulationSource[1] = iplSourceRetain(source);
effect->newSimulationSourceWritten = true;
}
}
FMOD_RESULT F_CALL setInt(FMOD_DSP_STATE* state,
int index,
int value)
{
auto effect = reinterpret_cast<State*>(state->plugindata);
switch (index)
{
case APPLY_DISTANCEATTENUATION:
effect->applyDistanceAttenuation = static_cast<ParameterApplyType>(value);
break;
case APPLY_AIRABSORPTION:
effect->applyAirAbsorption = static_cast<ParameterApplyType>(value);
break;
case APPLY_DIRECTIVITY:
effect->applyDirectivity = static_cast<ParameterApplyType>(value);
break;
case APPLY_OCCLUSION:
effect->applyOcclusion = static_cast<ParameterApplyType>(value);
break;
case APPLY_TRANSMISSION:
effect->applyTransmission = static_cast<ParameterApplyType>(value);
break;
case HRTF_INTERPOLATION: