SinTracking.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 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 _SinTracking__
#define _SinTracking__
#include <typeinfo>

#include "DataTypes.hxx"
#include "Processing.hxx"
#include "SpectralPeakArray.hxx"
#include "Array.hxx"
#include "SinTrackingConfig.hxx"
#include "InPort.hxx"
#include "OutPort.hxx"
#include "InControl.hxx"

namespace CLAM {

        class Fundamental;      
        class SpectralPeak;
        class ProcessingConfig;
        
        /* SinTrackingConfig moved to SinTrackingConfig.hxx */

        typedef struct SGuide
        {
                TData freq;
                TData mag;
                int trackId;
                bool isDead;//true if track died in previous step, false else
        }TGuide;


        class SinTracking: public Processing
        {
                mutable SinTrackingConfig mConfig;

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

                virtual bool ConcreteConfigure(const ProcessingConfig&);

                InPort<SpectralPeakArray> mInput;
                OutPort<SpectralPeakArray> mOutput;
                FloatInControl mFundFreqValue;

        public:

                SinTracking();
                SinTracking(const SinTrackingConfig &c);
                ~SinTracking();

                //Configuration accessor
                const ProcessingConfig &GetConfig() const { return mConfig;};           

                //Peak Continuation for one frame
                bool Do(const SpectralPeakArray& iPeakArray, SpectralPeakArray& oPeakArray);
                bool Do(void);

                int GetnTracks() const {return mNextTrackId;};

        private:

                bool DoHarmonic(const SpectralPeakArray& in, SpectralPeakArray& out,TData funFreq);
                bool DoInharmonic(const SpectralPeakArray& in, SpectralPeakArray& out);
        

                void Initialization(const SpectralPeakArray& iPeakArray, SpectralPeakArray& oPeakArray);

                void InitHarmonicTracks(SpectralPeakArray& peaks, TData funFreq);

                
                void AddNewTrack(int trackPosition, const SpectralPeak& currentPeak,SpectralPeakArray& oPeakArray) const;
                
                void Tracking(const SpectralPeakArray& iPeakArray, SpectralPeakArray& oPeakArray, TIndex processedPeakPos) const;

                void HarmonicTracking(const SpectralPeakArray& in,SpectralPeakArray& out,TData funFreq);

                inline bool IsPeakAssigned(const SpectralPeakArray &peakArray, TIndex peakIndex) const;

                inline bool IsCandidate(const SpectralPeak& fixedPeak,const SpectralPeak& candidate) const;

                inline bool ThereIsCandidate(TData currentFramePeakFreq, 
                        const SpectralPeakArray& iPeakArray,SpectralPeakArray& oPeakArray) const;
                
                inline TIndex GetCandidate(TData currentFramePeakFreq, 
                                                const SpectralPeakArray& nextFramePeakArray,TData& distance) const;
  
                inline bool IsBestCandidate(TData candidateFreq, TData currentFreq) const;

                  
                inline TIndex GetFirstNonAssignedPeakPos(const SpectralPeakArray& framePeakArray, TIndex beginAt) const;
  
                inline void Match(TIndex trackId, TIndex peakIndex,const SpectralPeak& currentPeak, SpectralPeakArray& oPeakArray) const;
  
                inline void KillTrack(int trackPosition) const;

                void KillAll();
  
                
  
                void CheckForNewBornTracks(const SpectralPeakArray& iPeakArray,
                                                SpectralPeakArray& oPeakArray) const;

                TIndex GetMatchedPeak(const SpectralPeakArray &iPeakArray, TIndex peakIndex) const;
  
                TIndex GetFirstNonMatchedPeakPos(const SpectralPeakArray& iPeakArray, TIndex beginAt) const;
        


        //Member variables
                TData mThreshold;
                mutable bool mInitialized;
                SpectralPeakArray mPreviousPeakArray;
                mutable Array<TGuide> mGuideArray;
                int mnMaxSines;
                mutable int mnActiveGuides;             
                mutable int mNextTrackId;
                bool mHarmonic;//TODO: this should be a runtime modificable control

                bool mLastHarmonic;

        };

};//namespace

#endif