annotate YinUtil.h @ 140:c2b426f4d841 vamp-fft-revision

size_t -> int, remove some unnecessary work: marginally quicker. Also remove meaningless const from pass-by-value args

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    pYIN - A fundamental frequency estimator for monophonic audio
    Centre for Digital Music, Queen Mary, University of London.
    
    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.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef _YINUTIL_H_
#define _YINUTIL_H_

#include <cmath>

#include <iostream>
#include <vector>
#include <exception>

#include "vamp-sdk/FFT.h"

using std::vector;

class YinUtil
{
public:
    YinUtil(int yinBufferSize);
    ~YinUtil();
    
    double sumSquare(const double *in, int startInd, int endInd);
    void difference(const double *in, double *yinBuffer);
    void fastDifference(const double *in, double *yinBuffer);
    void slowDifference(const double *in, double *yinBuffer);
    void cumulativeDifference(double *yinBuffer);
    int absoluteThreshold(const double *yinBuffer, double thresh);
    vector<double> yinProb(const double *yinBuffer, int prior,
                           int minTau = 0, int maxTau = 0);
    double parabolicInterpolation(const double *yinBuffer, int tau);

private:
    const int m_yinBufferSize;
    Vamp::FFTReal m_fft;
};

#endif