SpectralAnalysis.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 __SpectralAnalysis__
#define __SpectralAnalysis__

//Uncomment this line if you want to use Ooura fft instead of fftw
//#define CLAM_OOURA

#include "WindowGenerator.hxx"
#include "CircularShift.hxx"
#include "SpectralAnalysisConfig.hxx"
#include "Audio.hxx"
#include "AudioMultiplier.hxx"
#include "ProcessingComposite.hxx"

#include "FFT.hxx"

#include "Spectrum.hxx"
#include "AudioInPort.hxx"
#include "OutPort.hxx"

namespace CLAM {

class Frame;
class Segment;
class ProcessingConfig;

class SpectralAnalysis:public ProcessingComposite
{

public:
        
// Processing Object compliance methods.

        const char *GetClassName() const {return "SpectralAnalysis";}


        SpectralAnalysis(SpectralAnalysisConfig& config);
        SpectralAnalysis();
        ~SpectralAnalysis();
        
                        
        const ProcessingConfig &GetConfig() const {return mConfig;}

        bool Do(void);

        bool Do(const Audio& in,Spectrum& outSp);

        bool Do(Frame& in);

        bool Do(Segment& in);
private:

        SpectralAnalysisConfig mConfig;

// The internal Processing Objects

        WindowGenerator mPO_WinGen;

        AudioMultiplier mPO_AProduct;

        CircularShift   mPO_CShift;

        FFT             mPO_FFT;

//Internal DataObjects

        Audio mAudioFrame;
        Audio mWindow; 
        Spectrum mSpec;

        // Internal convenience methods.

        void AttachChildren();
        bool ConfigureChildren();
        void ConfigureData();

        
        bool ConcreteConfigure(const ProcessingConfig&);

        AudioInPort     mInput;
        OutPort<Spectrum> mOutput;

};

} //namespace

#endif