annotate dsp/tonal/TCSgram.h @ 298:255e431ae3d4

* Key detector: when returning key strengths, use the peak value of the
  three underlying chromagram correlations (from 36-bin chromagram)
  corresponding to each key, instead of the mean.
  Rationale: This is the same method as used when returning the key value,
  and it's nice to have the same results in both returned value and plot.
  The peak performed better than the sum with a simple test set of triads,
  so it seems reasonable to change the plot to match the key output rather
  than the other way around.

* FFT: kiss_fftr returns only the non-conjugate bins, synthesise the rest
  rather than leaving them (perhaps dangerously) undefined.  Fixes an
  uninitialised data error in chromagram that could cause garbage results
  from key detector.

* Constant Q: remove precalculated values again, I reckon they're not
  proving such a good tradeoff.

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

/*
    QM DSP Library

    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006 Martin Gasser.
    All rights reserved.
*/

#ifndef _TCSGram_
#define _TCSGram_

#include <vector>
#include <valarray>
#include <utility>

#include "TonalEstimator.h"

typedef std::vector<std::pair<long, TCSVector> > vectorlist_t;

class TCSGram
{
public:	
	TCSGram();
	~TCSGram();
	void getTCSVector(int, TCSVector&) const;
	void addTCSVector(const TCSVector&);
	long getTime(size_t) const;
	long getDuration() const;
	void printDebug();
	int getSize() const { return m_VectorList.size(); }
	void reserve(size_t uSize) { m_VectorList.reserve(uSize); }
	void clear() { m_VectorList.clear(); }
	void setFrameDuration(const double dFrameDurationMS) { m_dFrameDurationMS = dFrameDurationMS; }
	void setNumBins(const unsigned int uNumBins) { m_uNumBins = uNumBins; }
	void normalize();
protected:
	vectorlist_t m_VectorList;
	unsigned int m_uNumBins;
	double m_dFrameDurationMS;
};

#endif