Chris@14: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@14: 
Chris@14: /*
Chris@14:     Vamp
Chris@14: 
Chris@14:     An API for audio analysis and feature extraction plugins.
Chris@14: 
Chris@14:     Centre for Digital Music, Queen Mary, University of London.
Chris@14:     Copyright 2006-2012 Chris Cannam and QMUL.
Chris@14:   
Chris@14:     Permission is hereby granted, free of charge, to any person
Chris@14:     obtaining a copy of this software and associated documentation
Chris@14:     files (the "Software"), to deal in the Software without
Chris@14:     restriction, including without limitation the rights to use, copy,
Chris@14:     modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@14:     of the Software, and to permit persons to whom the Software is
Chris@14:     furnished to do so, subject to the following conditions:
Chris@14: 
Chris@14:     The above copyright notice and this permission notice shall be
Chris@14:     included in all copies or substantial portions of the Software.
Chris@14: 
Chris@14:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@14:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@14:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@14:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@14:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@14:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@14:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@14: 
Chris@14:     Except as contained in this notice, the names of the Centre for
Chris@14:     Digital Music; Queen Mary, University of London; and Chris Cannam
Chris@14:     shall not be used in advertising or otherwise to promote the sale,
Chris@14:     use or other dealings in this Software without prior written
Chris@14:     authorization.
Chris@14: */
Chris@14: 
Chris@14: #ifndef _VAMP_FFT_H_
Chris@14: #define _VAMP_FFT_H_
Chris@14: 
Chris@14: #include "plugguard.h"
Chris@14: _VAMP_SDK_PLUGSPACE_BEGIN(FFT.h)
Chris@14: 
Chris@14: namespace Vamp {
Chris@14: 
Chris@14: /**
Chris@14:  * A simple FFT implementation provided for convenience of plugin
Chris@14:  * authors.
Chris@14:  * 
Chris@14:  * This class provides double-precision FFTs in power-of-two sizes
Chris@14:  * only. It is slower than more sophisticated library
Chris@14:  * implementations. If these requirements aren't suitable, make other
Chris@14:  * arrangements.
Chris@14:  *
Chris@14:  * The inverse transform is scaled by 1/n.
Chris@14:  *
Chris@14:  * The implementation is from Don Cross's public domain FFT code.
Chris@14:  */
Chris@14: class FFT
Chris@14: {
Chris@14: public:
Chris@14:     /**
Chris@14:      * Calculate a forward transform of size n.
Chris@14:      *
Chris@14:      * ri and ii must point to the real and imaginary component arrays
Chris@14:      * of the input. For real input, ii may be NULL.
Chris@14:      *
Chris@14:      * ro and io must point to enough space to receive the real and
Chris@14:      * imaginary component arrays of the output.
Chris@14:      *
Chris@14:      * All input and output arrays are of size n.
Chris@14:      */
Chris@14:     static void forward(unsigned int n,
Chris@14:                         const double *ri, const double *ii,
Chris@14:                         double *ro, double *io);
Chris@14: 
Chris@14:     /**
Chris@14:      * Calculate an inverse transform of size n.
Chris@14:      *
Chris@14:      * ri and ii must point to the real and imaginary component arrays
Chris@14:      * of the input. For real input, ii may be NULL.
Chris@14:      *
Chris@14:      * ro and io must point to enough space to receive the real and
Chris@14:      * imaginary component arrays of the output. The output is scaled
Chris@14:      * by 1/n. The output pointers may not be NULL, even if the output
Chris@14:      * is expected to be real.
Chris@14:      *
Chris@14:      * All input and output arrays are of size n.
Chris@14:      */
Chris@14:     static void inverse(unsigned int n,
Chris@14:                         const double *ri, const double *ii,
Chris@14:                         double *ro, double *io);
Chris@14: };
Chris@14: 
Chris@14: }
Chris@14: 
Chris@14: _VAMP_SDK_PLUGSPACE_END(FFT.h)
Chris@14: 
Chris@14: #endif