SAF
Loading...
Searching...
No Matches
saf_test.h
Go to the documentation of this file.
1/*
2 * Copyright 2020-2021 Leo McCormack
3 *
4 * This software is dual-licensed. Please refer to the LICENCE.md file for more
5 * information.
6 *
7 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
8 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
10 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
11 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
12 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
13 * PERFORMANCE OF THIS SOFTWARE.
14 */
15
52#ifndef __SAF_TEST_H_INCLUDED__
53#define __SAF_TEST_H_INCLUDED__
54
55#include "unity.h" /* unit testing suite (MIT license) */
56#include "timer.h" /* for timing the individual tests */
57#include "saf.h" /* master framework include header */
58#include "saf_externals.h" /* to also include saf dependencies (cblas etc.) */
59#ifdef SAF_ENABLE_EXAMPLES_TESTS
60# include "ambi_bin.h"
61# include "ambi_dec.h"
62# include "ambi_drc.h"
63# include "ambi_enc.h"
64# include "ambi_roomsim.h"
65# include "array2sh.h"
66# include "beamformer.h"
67# include "binauraliser.h"
68# include "binauraliser_nf.h"
69# include "decorrelator.h"
70# include "dirass.h"
71# include "matrixconv.h"
72# include "multiconv.h"
73# include "panner.h"
74# include "pitch_shifter.h"
75# include "powermap.h"
76# include "rotator.h"
77# include "sldoa.h"
78# include "spreader.h"
79# include "tvconv.h"
80#endif /* SAF_ENABLE_EXAMPLES_TESTS */
81
82#ifdef __cplusplus
83extern "C" {
84#endif /* __cplusplus */
85
87int main_test(void);
88
89/* ========================================================================== */
90/* SAF utilities module unit tests */
91/* ========================================================================== */
92
95void test__cylindricalBesselFunctions(void);
98void test__sphericalBesselFunctions(void);
101void test__cart2sph(void);
104void test__delaunaynd(void);
108void test__quaternion(void);
112void test__saf_stft_50pc_overlap(void);
116void test__saf_stft_LTI(void);
119void test__saf_rfft(void);
122void test__saf_fft(void);
125void test__saf_matrixConv(void);
129void test__qmf(void);
133void test__smb_pitchShifter(void);
136void test__sortf(void);
140void test__sortz(void);
144void test__cmplxPairUp(void);
149void test__getVoronoiWeights(void);
152void test__unique_i(void);
156void test__latticeDecorrelator(void);
160void test__butterCoeffs(void);
164void test__evalIIRTransferFunction(void);
168void test__faf_IIRFilterbank(void);
172void test__gexpm(void);
176void test__dvf_calcDVFShelfParams(void);
180void test__dvf_interpDVFShelfParams(void);
184void test__dvf_dvfShelfCoeffs(void);
185
186
187/* ========================================================================== */
188/* SAF cdf4sap module unit tests */
189/* ========================================================================== */
190
194void test__formulate_M_and_Cr(void);
198void test__formulate_M_and_Cr_cmplx(void);
199
200
201/* ========================================================================== */
202/* SAF hoa module unit tests */
203/* ========================================================================== */
204
208void test__getLoudspeakerDecoderMtx(void);
211void test__truncationEQ(void);
212
213
214/* ========================================================================== */
215/* SAF sh module unit tests */
216/* ========================================================================== */
217
220void test__getSHreal(void);
224void test__getSHreal_recur(void);
228void test__getSHreal_part(void);
231void test__getSHcomplex(void);
234void test__getSHrotMtxReal(void);
238void test__real2complexSHMtx(void);
242void test__complex2realSHMtx(void);
246void test__computeSectorCoeffsEP(void);
249void test__checkCondNumberSHTReal(void);
252void test__calculateGridWeights(void);
255void test__sphMUSIC(void);
258void test__sphPWD(void);
261void test__sphESPRIT(void);
264void test__sphModalCoeffs(void);
267void test__arraySHTmatrices(void);
268
269
270/* ========================================================================== */
271/* SAF hrir module unit tests */
272/* ========================================================================== */
273
276void test__resampleHRIRs(void);
277
278
279/* ========================================================================== */
280/* SAF reverb module unit tests */
281/* ========================================================================== */
282
286void test__ims_shoebox_TD(void);
290void test__ims_shoebox_RIR(void);
291
292
293/* ========================================================================== */
294/* SAF vbap module unit tests */
295/* ========================================================================== */
296
297
298/* ========================================================================== */
299/* SAF sofa reader module unit tests */
300/* ========================================================================== */
301
302#ifdef SAF_ENABLE_SOFA_READER_MODULE
303
306void test__saf_sofa_open(void);
309void test__mysofa_load(void);
312void test__sofa_comparison(void);
313
314#endif /* SAF_ENABLE_SOFA_READER_MODULE */
315
316
317/* ========================================================================== */
318/* SAF tracker module unit tests */
319/* ========================================================================== */
320
321#ifdef SAF_ENABLE_TRACKER_MODULE
322
326void test__tracker3d(void);
327
328#endif /* SAF_ENABLE_TRACKER_MODULE */
329
330
331/* ========================================================================== */
332/* SAF HADES module unit tests */
333/* ========================================================================== */
334
335#ifdef SAF_ENABLE_HADES_MODULE
336
338void test__hades(void);
339
340#endif /* SAF_ENABLE_HADES_MODULE */
341
342
343/* ========================================================================== */
344/* SAF resources unit tests */
345/* ========================================================================== */
346
350void test__afSTFT(void);
354void test__realloc2d_r(void);
357void test__malloc4d(void);
360void test__malloc5d(void);
363void test__malloc6d(void);
364
365
366/* ========================================================================== */
367/* SAF examples unit tests */
368/* ========================================================================== */
369
370#ifdef SAF_ENABLE_EXAMPLES_TESTS
371
375void test__saf_example_ambi_bin(void);
379void test__saf_example_ambi_dec(void);
383void test__saf_example_ambi_enc(void);
387void test__saf_example_array2sh(void);
391void test__saf_example_rotator(void);
395void test__saf_example_spreader(void);
396
397#endif /* SAF_ENABLE_EXAMPLES_TESTS */
398
399
400/* ========================================================================== */
401/* SAF DVF module unit tests */
402/* ========================================================================== */
403
404
405
406#ifdef __cplusplus
407} /* extern "C" */
408#endif /* __cplusplus */
409
410#endif /* __SAF_TEST_H_INCLUDED__ */
ambi_bin.h
A binaural Ambisonic decoder for reproducing Ambisonic sound scenes over headphones.
ambi_dec.h
A frequency-dependent Ambisonic decoder for reproducing Ambisonic sound scenes over loudspeakers.
ambi_drc.h
A frequency-dependent Ambisonic sound scene dynamic range compressor (DRC)
ambi_enc.h
A basic Ambisonic encoder.
ambi_roomsim.h
A simple shoebox room Ambisonic encoder.
array2sh.h
Spatially encodes spherical microphone array signals into spherical harmonic signals (aka: Ambisonic ...
beamformer.h
Generates beamformers/virtual microphones in arbitrary directions with several different beam pattern...
binauraliser.h
Convolves input audio (up to 64 channels) with interpolated HRTFs in the time-frequency domain.
binauraliser_nf.h
Convolves input audio (up to 64 channels) with interpolated HRTFs in the time-frequency domain,...
decorrelator.h
A multi-channel decorrelator.
dirass.h
A sound-field visualiser based on the directional re-assignment of beamformer energy based on local D...
matrixconv.h
A standard matrix convolver.
multiconv.h
A multi-channel convolver.
panner.h
A frequency-dependent 3D panner based on the Vector-base Amplitude Panning (VBAP) method [1],...
pitch_shifter.h
A very basic multichannel pitch shifter.
powermap.h
A sound-field visualiser, which utilises spherical harmonic signals as input; note this code is a rem...
rotator.h
A basic spherical harmonic/ Ambisonic signals rotator, based on the recursive approach detailed in [1...
saf.h
Main include header for the Spatial_Audio_Framework (SAF)
saf_externals.h
Include header for SAF externals.
test__real2complexSHMtx
void test__real2complexSHMtx(void)
Testing the real to complex spherical harmonic conversion, using getSHcomplex() as the reference.
Definition test__sh_module.c:263
test__formulate_M_and_Cr
void test__formulate_M_and_Cr(void)
Testing the formulate_M_and_Cr() function, and verifying that the output mixing matrices yield signal...
Definition test__cdf4sap_module.c:27
test__calculateGridWeights
void test__calculateGridWeights(void)
Test grid weight approximation.
Definition test__sh_module.c:458
test__sphPWD
void test__sphPWD(void)
Testing the DoA estimation performance of sphPWD()
Definition test__sh_module.c:561
test__saf_fft
void test__saf_fft(void)
Testing the forward and backward complex-complex FFT (saf_fft)
Definition test__utilities_module.c:413
test__realloc2d_r
void test__realloc2d_r(void)
Testing the realloc2d_r() function (reallocating 2-D array, while retaining the previous data order; ...
Definition test__resources.c:102
test__evalIIRTransferFunction
void test__evalIIRTransferFunction(void)
Testing that the magnitudes and phases returned by evalIIRTransferFunction() are numerically similar ...
Definition test__utilities_module.c:993
test__getSHreal_recur
void test__getSHreal_recur(void)
Testing that the getSHreal_recur() function is somewhat numerically identical to the full-fat getSHre...
Definition test__sh_module.c:84
test__getVoronoiWeights
void test__getVoronoiWeights(void)
Testing that the weights from the getVoronoiWeights() function sum to 4pi and that the weights are al...
Definition test__utilities_module.c:681
test__sphericalBesselFunctions
void test__sphericalBesselFunctions(void)
Testing bessel_jn(), bessel_in(), bessel_yn(), and bessel_kn()
Definition test__utilities_module.c:54
test__truncationEQ
void test__truncationEQ(void)
Testing the truncation EQ.
Definition test__hoa_module.c:106
test__ims_shoebox_RIR
void test__ims_shoebox_RIR(void)
Testing the ims shoebox simulator, when generating room impulse respones (RIRs) from the computed ech...
Definition test__reverb_module.c:27
test__getSHreal
void test__getSHreal(void)
Testing the orthogonality of the getSHreal() function.
Definition test__sh_module.c:27
test__saf_stft_50pc_overlap
void test__saf_stft_50pc_overlap(void)
Testing for perfect reconstruction of the saf_stft (when configured for 50% window overlap)
Definition test__utilities_module.c:207
test__butterCoeffs
void test__butterCoeffs(void)
Testing that the coefficients computed with butterCoeffs() are numerically similar to the "butter" fu...
Definition test__utilities_module.c:870
test__sortf
void test__sortf(void)
Testing the sortf() function (sorting real floating point numbers)
Definition test__utilities_module.c:560
test__cmplxPairUp
void test__cmplxPairUp(void)
Testing the cmplxPairUp() function (grouping up conjugate symmetric values)
Definition test__utilities_module.c:638
test__smb_pitchShifter
void test__smb_pitchShifter(void)
Testing that the smb_pitchShifter can shift the energy of input spectra by one octave down.
Definition test__utilities_module.c:520
test__arraySHTmatrices
void test__arraySHTmatrices(void)
Testing the arraySHTmatrices() function.
Definition test__sh_module.c:768
test__unique_i
void test__unique_i(void)
Testing that the unique_i() function operates correctly.
Definition test__utilities_module.c:736
test__getLoudspeakerDecoderMtx
void test__getLoudspeakerDecoderMtx(void)
Testing to assure that (given a uniform loudspeaker layout), the SAD, MMD and EPAD decoders are all e...
Definition test__hoa_module.c:27
test__saf_example_array2sh
void test__saf_example_array2sh(void)
Testing the SAF array2sh.h example (this may also serve as a tutorial on how to use it)
Definition test__examples.c:268
test__saf_example_rotator
void test__saf_example_rotator(void)
Testing the SAF rotator.h example (this may also serve as a tutorial on how to use it)
Definition test__examples.c:360
test__saf_rfft
void test__saf_rfft(void)
Testing the forward and backward real-(half)complex FFT (saf_rfft)
Definition test__utilities_module.c:374
test__getSHreal_part
void test__getSHreal_part(void)
Testing that the getSHreal_part() function is somewhat numerically identical to the full-fat getSHrea...
Definition test__sh_module.c:111
test__cylindricalBesselFunctions
void test__cylindricalBesselFunctions(void)
Testing bessel_Jn(), bessel_Yn()
Definition test__utilities_module.c:27
test__sphESPRIT
void test__sphESPRIT(void)
Testing the DoA estimation performance of sphESPRIT()
Definition test__sh_module.c:623
test__dvf_dvfShelfCoeffs
void test__dvf_dvfShelfCoeffs(void)
Test the generation of high shelf coeffs based on shelf gain and fc parameters.
Definition test__utilities_module.c:1398
test__delaunaynd
void test__delaunaynd(void)
Testing that the delaunaynd() function can triangulate basic shapes.
Definition test__utilities_module.c:123
test__malloc6d
void test__malloc6d(void)
Testing that malloc6d() works, and is truely contiguously allocated.
Definition test__resources.c:227
test__getSHrotMtxReal
void test__getSHrotMtxReal(void)
Testing the spherical harmonic rotation matrix function getSHrotMtxReal()
Definition test__sh_module.c:202
test__sphModalCoeffs
void test__sphModalCoeffs(void)
Testing the sphModalCoeffs() function.
Definition test__sh_module.c:722
test__afSTFT
void test__afSTFT(void)
Testing the alias-free STFT filterbank (near)-perfect reconstruction performance.
Definition test__resources.c:27
test__saf_example_ambi_enc
void test__saf_example_ambi_enc(void)
Testing the SAF ambi_enc.h example (this may also serve as a tutorial on how to use it)
Definition test__examples.c:195
test__saf_example_ambi_bin
void test__saf_example_ambi_bin(void)
Testing the SAF ambi_bin.h example (this may also serve as a tutorial on how to use it)
Definition test__examples.c:29
test__formulate_M_and_Cr_cmplx
void test__formulate_M_and_Cr_cmplx(void)
Testing the formulate_M_and_Cr_cmplx() function, and verifying that the output mixing matrices yield ...
Definition test__cdf4sap_module.c:181
test__complex2realSHMtx
void test__complex2realSHMtx(void)
Testing the complex to real spherical harmonic conversion, using getSHreal() as the reference.
Definition test__sh_module.c:324
test__computeSectorCoeffsEP
void test__computeSectorCoeffsEP(void)
Testing the computeSectorCoeffsEP() and computeVelCoeffsMtx() functions and comparing their output to...
Definition test__sh_module.c:380
test__faf_IIRFilterbank
void test__faf_IIRFilterbank(void)
Testing that the faf_IIRFilterbank can reconstruct the original signal power.
Definition test__utilities_module.c:1195
test__checkCondNumberSHTReal
void test__checkCondNumberSHTReal(void)
Testing that for T-designs, the condition numbers are all equal to 1.
Definition test__sh_module.c:421
test__qmf
void test__qmf(void)
Testing the (near)-perfect reconstruction performance of the QMF filterbank.
Definition test__utilities_module.c:454
test__hades
void test__hades(void)
Test for hades.
Definition test__hades_module.c:31
test__gexpm
void test__gexpm(void)
Testing computing the matrix exponential - comparing the output to that of the "expm" function in Mat...
Definition test__utilities_module.c:1268
test__dvf_interpDVFShelfParams
void test__dvf_interpDVFShelfParams(void)
Test the interpolation of high shelf parameters based on distance and incidence angle parameters.
Definition test__utilities_module.c:1348
test__sortz
void test__sortz(void)
Testing the sortz() function (sorting complex double-floating point numbers)
Definition test__utilities_module.c:592
test__cart2sph
void test__cart2sph(void)
Testing cart2sph() and sph2cart() are reversible.
Definition test__utilities_module.c:99
test__mysofa_load
void test__mysofa_load(void)
Testing the dependency free mysofa SOFA reader.
Definition test__sofa_reader_module.c:43
test__dvf_calcDVFShelfParams
void test__dvf_calcDVFShelfParams(void)
Calculate high shelf parameters, g0, gInf, fc, from the lookup table coefficients (10 degree steps)
Definition test__utilities_module.c:1304
test__tracker3d
void test__tracker3d(void)
Testing that the particle-filtering based tracker is able to correctly track two simultaneous targets...
Definition test__tracker_module.c:31
main_test
int main_test(void)
Main unit testing program.
Definition saf_test.c:73
test__saf_example_spreader
void test__saf_example_spreader(void)
Testing the SAF spreader.h example (this may also serve as a tutorial on how to use it)
Definition test__examples.c:445
test__malloc5d
void test__malloc5d(void)
Testing that malloc5d() works, and is truely contiguously allocated.
Definition test__resources.c:193
test__getSHcomplex
void test__getSHcomplex(void)
Testing the orthogonality of the getSHcomplex() function.
Definition test__sh_module.c:143
test__malloc4d
void test__malloc4d(void)
Testing that malloc4d() works, and is truely contiguously allocated.
Definition test__resources.c:162
test__saf_matrixConv
void test__saf_matrixConv(void)
Testing the saf_matrixConv.
Definition test__utilities_module.c:330
test__sphMUSIC
void test__sphMUSIC(void)
Testing the DoA estimation performance of sphMUSIC()
Definition test__sh_module.c:486
test__saf_sofa_open
void test__saf_sofa_open(void)
Testing the SAF SOFA reader that uses the netcdf library.
Definition test__sofa_reader_module.c:33
test__ims_shoebox_TD
void test__ims_shoebox_TD(void)
Testing the ims shoebox simulator, when applying the echograms in the time- domain.
Definition test__reverb_module.c:98
test__latticeDecorrelator
void test__latticeDecorrelator(void)
Testing the performance of the latticeDecorrelator, verifying that the inter- channel cross-correlati...
Definition test__utilities_module.c:768
test__saf_example_ambi_dec
void test__saf_example_ambi_dec(void)
Testing the SAF ambi_dec.h example (this may also serve as a tutorial on how to use it)
Definition test__examples.c:112
test__saf_stft_LTI
void test__saf_stft_LTI(void)
Testing for perfect reconstruction of the saf_stft (when configured for linear time-invariant (LTI) f...
Definition test__utilities_module.c:271
test__sofa_comparison
void test__sofa_comparison(void)
Testing that the two SOFA readers produce the same results.
Definition test__sofa_reader_module.c:52
test__resampleHRIRs
void test__resampleHRIRs(void)
Testing that resampleHRIRs() is resampling adequately.
Definition test__hrir_module.c:27
test__quaternion
void test__quaternion(void)
Testing that quaternion2rotationMatrix() and rotationMatrix2quaternion() are reversible.
Definition test__utilities_module.c:170
sldoa.h
A spatially-localised active-intensity (SLAI) based direction-of- arrival estimator (SLDoA)
spreader.h
An arbitrary array panner (HRIRs, microphone array IRs, etc.) with coherent and incoherent spreading ...
tvconv.h
A time-varying multi-channel convolver.