FFT_base.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */


#ifndef _FFT_base_
#define _FFT_base_

#include <typeinfo> // for bad_cast definition
#include "Processing.hxx"
#include "AudioInPort.hxx"
#include "OutPort.hxx"
#include <string>
#include "FFTConfig.hxx"
#include "SpecTypeFlags.hxx"
#include "Spectrum.hxx"

namespace CLAM {

    class Storage;
    class ProcessingConfig;
    class Audio;
    class Spectrum;

    class FFT_base: public Processing
    {
    protected:

        static SpecTypeFlags mComplexflags;

        Spectrum mComplexSpectrum;
        
        FFTConfig mConfig;
        int mSize;

        /* FFT possible execution states.
         */
        typedef enum {
                sComplex, // We just need to write the complex array.
                sComplexSync, // We write the complex array and synchronize.
                sOther // The complex array is not present.
        } FFTState;

        FFTState mState;
        
        FFTState mBackupState;

        AudioInPort     mInput;
        OutPort<Spectrum> mOutput;

        TData* fftbuffer;

        // Control change callback function
        void ChangeSize(int n);
        int GetSize() {return mSize;}

        virtual bool ConcreteConfigure(const ProcessingConfig&) = 0;

    public:

        FFT_base();
        virtual ~FFT_base();

        const ProcessingConfig &GetConfig() const { return mConfig;}
        
        virtual bool Do(void) = 0;

        virtual bool Do(const Audio& in, Spectrum &out)= 0;

        // Input/Output configuration methods

        bool SetPrototypes(const Audio& in,const Spectrum &out);

        bool SetPrototypes() {return false;}

        bool UnsetPrototypes();

        void CheckTypes(const Audio& in, const Spectrum &out) const;


        // Enable/Disable methods. Maybe we should not be deriving
        // these ones in FFT subclasses. (FFT implementations will
        // probably be always memoryless.

        virtual bool MayDisableExecution() const {return false;}

        virtual bool DisableExecution() {return false;}

        virtual bool EnableExecution() {return false;}

        // Output conversions

        virtual void ToComplex(Spectrum &out) = 0;

        virtual void ToOther(Spectrum &out);            

    };


};//namespace CLAM


#endif // _FFT_base_