SMSOddEvenHarmonicRatio.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 _SMSOddEvenHarmonicRatio_
#define _SMSOddEvenHarmonicRatio_

#include "InPort.hxx"
#include "OutPort.hxx"
#include "InControl.hxx"
#include "SpectralPeakArray.hxx"
#include "Frame.hxx"
#include "SegmentTransformationConfig.hxx"
#include "FrameTransformation.hxx"
#include "FrameTransformationConfig.hxx"


namespace CLAM{


        class SMSOddEvenHarmonicRatio: public FrameTransformation
        {
                const char *GetClassName() const {return "SMSOddEvenHarmonicRatio";}

                InPort<SpectralPeakArray> mIn;
                OutPort<SpectralPeakArray> mOut;

                FloatInControl mOddFactor;
        public:

                SMSOddEvenHarmonicRatio() 
                        : 
                        mIn("In SpectralPeaks", this),
                        mOut("Out SpectralPeaks", this),
                        mOddFactor("Odd Factor", this)
                {
                        Configure( SegmentTransformationConfig() );

                }

                ~SMSOddEvenHarmonicRatio() {}
        
                bool Do(const Frame& in, Frame& out)
                {
                        return Do(in.GetSpectralPeakArray(), out.GetSpectralPeakArray());
                }

                bool Do(const SpectralPeakArray& in, SpectralPeakArray& out);

                bool Do()
                {
                        bool result = Do(mIn.GetData(), mOut.GetData());
                        mIn.Consume();
                        mOut.Produce();
                        return result;
                }

        };              
};//namespace CLAM

#endif // _SMSOddEvenHarmonicRatio_