SWIPE_PitchEstimation.h

Go to the documentation of this file.

//=====================================================================================
//=====================================================================================
#pragma once
#include "../krotos_eigen_updated/unsupported/Eigen/Polynomials"
 
namespace krotos
{
    //==============================================================================
    class SWIPE_PitchEstimation
    {
      public:
        /* Constructor
         *  @param sampleRate       sampling rate in Hz
         *  @param timeStep         pitch estimated every timeStep seconds
         *  @param log2PitchStep    pitch samples samples distributed every DLOG2P units on a base-2 logarithmic scale of
         *Hertz
         *  @param ERBStep          spectrum is sampled uniformly in the ERB scale with a step size
         *  @param normOverlap      spectrum is computed using a Hann window with an overlap normOverlap between 0 and 1
         *  @param strenThresh      pitch estimates with a strength lower than strenThresh are treated as undefined
         *
         */
        SWIPE_PitchEstimation(const float sampleRate, const float timeStep, const float log2PitchStep,
                              const float ERBStep, const float normOverlap, const float strenThresh);
 
        void initVectors();
 
        std::pair<Eigen::VectorXf, Eigen::VectorXf> calculatePitchStrengthPairs(std::vector<float>& signal);
 
        Eigen::VectorXf getTimes() { return m_times; };
 
      private:
        Eigen::VectorXf calculateLog2PitchCands(float log2PitchStep);
        Eigen::VectorXf calculatePitchCands(const Eigen::VectorXf& log2PitchCands);
 
        std::pair<Eigen::VectorXf, Eigen::VectorXf> selectCandidatesForWindowSize(size_t winSizeIDx);
 
        Eigen::VectorXf getERBsSubset(const Eigen::VectorXf& pitchCandsSubset);
 
        Eigen::MatrixXf pitchStrengthAllCandidates(const Eigen::VectorXf& ERBs, Eigen::MatrixXf& ERBsDistrValues,
                                                   const Eigen::VectorXf& pitchCands);
 
        Eigen::VectorXf pitchStrengthOneCandidate(const Eigen::VectorXf& ERBS,
                                                  const Eigen::MatrixXf& normERBsDistrValues, float pitchCand);
 
        std::pair<Eigen::VectorXf, Eigen::VectorXf> fineTunePitch(Eigen::MatrixXf globStrMatrix);
 
        Eigen::VectorXi primes(int n);
        Eigen::MatrixXf cumsum(const Eigen::MatrixXf& input);
 
        Eigen::VectorXf polyfit(const Eigen::VectorXf& x, const Eigen::VectorXf& y, int n);
 
        Eigen::MatrixXf computeN(const Eigen::MatrixXf& ERBsDistrValues);
 
        float m_sampleRate{-1.0f}, m_timeStep{-1.0f}, m_log2PitchStep{-1.0f}, m_ERBStep{-1.0f}, m_normOverlap{-1.0f},
                m_strenThresh{-1.0f};
 
        Eigen::Vector2f m_pitchLims;
        Eigen::VectorXf m_times;
        Eigen::VectorXf m_pitchCands;
        Eigen::VectorXf m_winSizes;
        Eigen::VectorXf m_log2DistWin1OptPitchAndPitchCands;
        Eigen::VectorXf m_ERBs;
    };
} // namespace krotos