SMSPitchShift.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 _SMSPitchShift_
#define _SMSPitchShift_

#include "InPort.hxx"
#include "OutPort.hxx"
#include "InControl.hxx"
#include "FrameTransformation.hxx"
#include "SpectralEnvelopeExtract.hxx"
#include "SpectralEnvelopeApply.hxx"
#include "FDCombFilter.hxx"
#include "SpectralPeakArray.hxx"
#include "Frame.hxx"

#include "FrameTransformationConfig.hxx"
#include "SegmentTransformationConfig.hxx"


namespace CLAM{


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

                InPort<SpectralPeakArray> mInPeaks;
                OutPort<SpectralPeakArray> mOutPeaks;
                InPort<Fundamental> mInFundamental;
                OutPort<Fundamental> mOutFundamental;
                InPort<Spectrum> mInSpectrum;
                OutPort<Spectrum> mOutSpectrum;

                FloatInControl mIsHarmonic;
                FloatInControl mPitchSteps;
        public:
                SMSPitchShift()
                        :
                        mInPeaks("In SpectralPeaks", this),
                        mOutPeaks("Out SpectralPeaks", this),
                        mInFundamental("In Fundamental", this),
                        mOutFundamental("Out Fundamental", this),
                        mInSpectrum("In Spectrum", this),
                        mOutSpectrum("Out Spectrum", this),
                        mIsHarmonic("Harmonic", this),
                        mPitchSteps("PitchSteps", this),
                        mIgnoreResidual("IgnoreResidual", this)
                {
                        Configure( SegmentTransformationConfig() );
                }

                ~SMSPitchShift() {}

                bool ConcreteConfigure( const ProcessingConfig& config )
                {
                        mPitchSteps.SetBounds(1,100);
                        mPitchSteps.SetDefaultValue(1); //no pitch shift
                        mPitchSteps.DoControl(1);

                        mIgnoreResidual.SetBounds(0.,1.);
                        mIgnoreResidual.SetDefaultValue(0.);
                        mIgnoreResidual.DoControl(0.);
                        return true;
                }

                bool Do(const SpectralPeakArray& inPeaks,
                        const Fundamental& inFund,
                        const Spectrum& inRes,
                        SpectralPeakArray& outPeaks,
                        Fundamental& outFund,
                        Spectrum& outRes);

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

                bool Do()
                {
                        bool result = Do(mInPeaks.GetData(),
                                        mInFundamental.GetData(),
                                        mInSpectrum.GetData(),
                                        mOutPeaks.GetData(),
                                        mOutFundamental.GetData(),
                                        mOutSpectrum.GetData()
                                        );

                        mInPeaks.Consume();
                        mOutPeaks.Produce();
                        mInFundamental.Consume();
                        mOutFundamental.Produce();
                        mInSpectrum.Consume();
                        mOutSpectrum.Produce();

                        return result;
                }

        private:
                SpectralEnvelopeExtract mSpectralEnvelopeExtract;
                SpectralEnvelopeApply mSpectralEnvelopeApply;
                FDCombFilter mFDCombFilter;
                Spectrum mSpectralEnvelope;
        public:
                FloatInControl mIgnoreResidual;
        };              
}       //namespace CLAM

#endif // _SMSPitchShift_