Chris@48: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@48: /*
Chris@48:   This file is Copyright (c) 2012 Chris Cannam
Chris@48:   
Chris@48:   Permission is hereby granted, free of charge, to any person
Chris@48:   obtaining a copy of this software and associated documentation
Chris@48:   files (the "Software"), to deal in the Software without
Chris@48:   restriction, including without limitation the rights to use, copy,
Chris@48:   modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@48:   of the Software, and to permit persons to whom the Software is
Chris@48:   furnished to do so, subject to the following conditions:
Chris@48: 
Chris@48:   The above copyright notice and this permission notice shall be
Chris@48:   included in all copies or substantial portions of the Software.
Chris@48: 
Chris@48:   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@48:   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@48:   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@48:   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@48:   ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@48:   CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@48:   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@48: */
Chris@48: 
Chris@48: /*
Chris@48:   This unit test suite for the Vamp SDK FFT implementation is included
Chris@48:   here mostly for illustrative purposes!
Chris@48: */
Chris@48: 
Chris@48: #include "vamp-sdk/FFT.h"
Chris@48: 
Chris@48: #define BOOST_TEST_DYN_LINK
Chris@48: #define BOOST_TEST_MAIN
Chris@48: 
Chris@48: #include <boost/test/unit_test.hpp>
Chris@48: 
Chris@48: BOOST_AUTO_TEST_SUITE(TestFFT)
Chris@48: 
Chris@48: #define COMPARE_CONST(a, n) \
Chris@48:     for (int cmp_i = 0; cmp_i < (int)(sizeof(a)/sizeof(a[0])); ++cmp_i) { \
Chris@49:         BOOST_CHECK_SMALL(a[cmp_i] - n, 1e-14);				\
Chris@48:     }
Chris@48: 
Chris@48: #define COMPARE_ARRAY(a, b)						\
Chris@48:     for (int cmp_i = 0; cmp_i < (int)(sizeof(a)/sizeof(a[0])); ++cmp_i) { \
Chris@49:         BOOST_CHECK_SMALL(a[cmp_i] - b[cmp_i], 1e-14);			\
Chris@48:     }
Chris@48: 
Chris@48: BOOST_AUTO_TEST_CASE(dc)
Chris@48: {
Chris@48:     // DC-only signal. The DC bin is purely real
Chris@48:     double in[] = { 1, 1, 1, 1 };
Chris@48:     double re[4], im[4];
Chris@48:     Vamp::FFT::forward(4, in, 0, re, im);
Chris@48:     BOOST_CHECK_EQUAL(re[0], 4.0);
Chris@48:     BOOST_CHECK_EQUAL(re[1], 0.0);
Chris@48:     BOOST_CHECK_EQUAL(re[2], 0.0);
Chris@48:     COMPARE_CONST(im, 0.0);
Chris@48:     double back[4];
Chris@48:     double backim[4];
Chris@48:     Vamp::FFT::inverse(4, re, im, back, backim);
Chris@48:     COMPARE_ARRAY(back, in);
Chris@48: }
Chris@48: 
Chris@48: BOOST_AUTO_TEST_CASE(sine)
Chris@48: {
Chris@48:     // Sine. Output is purely imaginary
Chris@48:     double in[] = { 0, 1, 0, -1 };
Chris@48:     double re[4], im[4];
Chris@48:     Vamp::FFT::forward(4, in, 0, re, im);
Chris@48:     COMPARE_CONST(re, 0.0);
Chris@48:     BOOST_CHECK_EQUAL(im[0], 0.0);
Chris@48:     BOOST_CHECK_EQUAL(im[1], -2.0);
Chris@48:     BOOST_CHECK_EQUAL(im[2], 0.0);
Chris@48:     double back[4];
Chris@48:     double backim[4];
Chris@48:     Vamp::FFT::inverse(4, re, im, back, backim);
Chris@48:     COMPARE_ARRAY(back, in);
Chris@48: }
Chris@48: 
Chris@48: BOOST_AUTO_TEST_CASE(cosine)
Chris@48: {
Chris@48:     // Cosine. Output is purely real
Chris@48:     double in[] = { 1, 0, -1, 0 };
Chris@48:     double re[4], im[4];
Chris@48:     Vamp::FFT::forward(4, in, 0, re, im);
Chris@48:     BOOST_CHECK_EQUAL(re[0], 0.0);
Chris@48:     BOOST_CHECK_EQUAL(re[1], 2.0);
Chris@48:     BOOST_CHECK_EQUAL(re[2], 0.0);
Chris@48:     COMPARE_CONST(im, 0.0);
Chris@48:     double back[4];
Chris@48:     double backim[4];
Chris@48:     Vamp::FFT::inverse(4, re, im, back, backim);
Chris@48:     COMPARE_ARRAY(back, in);
Chris@48: }
Chris@48: 	
Chris@48: BOOST_AUTO_TEST_CASE(sineCosine)
Chris@48: {
Chris@48:     // Sine and cosine mixed
Chris@48:     double in[] = { 0.5, 1, -0.5, -1 };
Chris@48:     double re[4], im[4];
Chris@48:     Vamp::FFT::forward(4, in, 0, re, im);
Chris@48:     BOOST_CHECK_EQUAL(re[0], 0.0);
Chris@49:     BOOST_CHECK_CLOSE(re[1], 1.0, 1e-12);
Chris@48:     BOOST_CHECK_EQUAL(re[2], 0.0);
Chris@48:     BOOST_CHECK_EQUAL(im[0], 0.0);
Chris@49:     BOOST_CHECK_CLOSE(im[1], -2.0, 1e-12);
Chris@48:     BOOST_CHECK_EQUAL(im[2], 0.0);
Chris@48:     double back[4];
Chris@48:     double backim[4];
Chris@48:     Vamp::FFT::inverse(4, re, im, back, backim);
Chris@48:     COMPARE_ARRAY(back, in);
Chris@48: }
Chris@48: 
Chris@48: BOOST_AUTO_TEST_CASE(nyquist)
Chris@48: {
Chris@48:     double in[] = { 1, -1, 1, -1 };
Chris@48:     double re[4], im[4];
Chris@48:     Vamp::FFT::forward(4, in, 0, re, im);
Chris@48:     BOOST_CHECK_EQUAL(re[0], 0.0);
Chris@48:     BOOST_CHECK_EQUAL(re[1], 0.0);
Chris@48:     BOOST_CHECK_EQUAL(re[2], 4.0);
Chris@48:     COMPARE_CONST(im, 0.0);
Chris@48:     double back[4];
Chris@48:     double backim[4];
Chris@48:     Vamp::FFT::inverse(4, re, im, back, backim);
Chris@48:     COMPARE_ARRAY(back, in);
Chris@48: }
Chris@48: 
Chris@48: BOOST_AUTO_TEST_CASE(dirac)
Chris@48: {
Chris@48:     double in[] = { 1, 0, 0, 0 };
Chris@48:     double re[4], im[4];
Chris@48:     Vamp::FFT::forward(4, in, 0, re, im);
Chris@48:     BOOST_CHECK_EQUAL(re[0], 1.0);
Chris@48:     BOOST_CHECK_EQUAL(re[1], 1.0);
Chris@48:     BOOST_CHECK_EQUAL(re[2], 1.0);
Chris@48:     COMPARE_CONST(im, 0.0);
Chris@48:     double back[4];
Chris@48:     double backim[4];
Chris@48:     Vamp::FFT::inverse(4, re, im, back, backim);
Chris@48:     COMPARE_ARRAY(back, in);
Chris@48: }
Chris@48: 
Chris@48: BOOST_AUTO_TEST_CASE(forwardArrayBounds)
Chris@48: {
Chris@48:     // initialise bins to something recognisable, so we can tell
Chris@48:     // if they haven't been written
Chris@48:     double in[] = { 1, 1, -1, -1 };
Chris@48:     double re[] = { 999, 999, 999, 999, 999, 999 };
Chris@48:     double im[] = { 999, 999, 999, 999, 999, 999 };
Chris@48:     Vamp::FFT::forward(4, in, 0, re+1, im+1);
Chris@48:     // And check we haven't overrun the arrays
Chris@48:     BOOST_CHECK_EQUAL(re[0], 999.0);
Chris@48:     BOOST_CHECK_EQUAL(im[0], 999.0);
Chris@48:     BOOST_CHECK_EQUAL(re[5], 999.0);
Chris@48:     BOOST_CHECK_EQUAL(im[5], 999.0);
Chris@48: }
Chris@48: 
Chris@48: BOOST_AUTO_TEST_CASE(inverseArrayBounds)
Chris@48: {
Chris@48:     // initialise bins to something recognisable, so we can tell
Chris@48:     // if they haven't been written
Chris@48:     double re[] = { 0, 1, 0 };
Chris@48:     double im[] = { 0, -2, 0 };
Chris@48:     double outre[] = { 999, 999, 999, 999, 999, 999 };
Chris@48:     double outim[] = { 999, 999, 999, 999, 999, 999 };
Chris@48:     Vamp::FFT::forward(4, re, im, outre+1, outim+1);
Chris@48:     // And check we haven't overrun the arrays
Chris@48:     BOOST_CHECK_EQUAL(outre[0], 999.0);
Chris@48:     BOOST_CHECK_EQUAL(outim[0], 999.0);
Chris@48:     BOOST_CHECK_EQUAL(outre[5], 999.0);
Chris@48:     BOOST_CHECK_EQUAL(outim[5], 999.0);
Chris@48: }
Chris@48: 
Chris@48: BOOST_AUTO_TEST_SUITE_END()
Chris@48: