cannam@7: // GetKeyMode.cpp: implementation of the CGetKeyMode class.
cannam@7: //
cannam@7: //////////////////////////////////////////////////////////////////////
cannam@7: 
cannam@7: #include "GetKeyMode.h"
cannam@7: #include "dsp/maths/MathUtilities.h"
cannam@9: #include "base/Pitch.h"
cannam@9: 
cannam@9: #include <iostream>
cannam@7: 
cannam@7: // Chords profile
cannam@7: static double MajProfile[36] = 
cannam@7: { 0.0384, 0.0629, 0.0258, 0.0121, 0.0146, 0.0106, 0.0364, 0.0610, 0.0267,
chriss@15:   0.0126, 0.0121, 0.0086, 0.0364, 0.0623, 0.0279, 0.0275, 0.0414, 0.0186, 
cannam@7:   0.0173, 0.0248, 0.0145, 0.0364, 0.0631, 0.0262, 0.0129, 0.0150, 0.0098,
cannam@7:   0.0312, 0.0521, 0.0235, 0.0129, 0.0142, 0.0095, 0.0289, 0.0478, 0.0239};
cannam@7: 
cannam@7: static double MinProfile[36] =
cannam@7: { 0.0375, 0.0682, 0.0299, 0.0119, 0.0138, 0.0093, 0.0296, 0.0543, 0.0257,
cannam@7:   0.0292, 0.0519, 0.0246, 0.0159, 0.0234, 0.0135, 0.0291, 0.0544, 0.0248,
cannam@7:   0.0137, 0.0176, 0.0104, 0.0352, 0.0670, 0.0302, 0.0222, 0.0349, 0.0164,
cannam@7:   0.0174, 0.0297, 0.0166, 0.0222, 0.0401, 0.0202, 0.0175, 0.0270, 0.0146};
cannam@7: //
cannam@7: 
cannam@7: //////////////////////////////////////////////////////////////////////
cannam@7: // Construction/Destruction
cannam@7: //////////////////////////////////////////////////////////////////////
cannam@7: 
cannam@9: GetKeyMode::GetKeyMode( int sampleRate, float tuningFrequency,
cannam@9: 			double hpcpAverage, double medianAverage )
cannam@7: :
cannam@7: m_hpcpAverage( hpcpAverage ),
cannam@7: m_medianAverage( medianAverage ),
cannam@7: m_ChrPointer(0),
cannam@7: m_DecimatedBuffer(0),
cannam@7: m_ChromaBuffer(0),
cannam@7: m_MeanHPCP(0),
cannam@7: m_MajCorr(0),
cannam@7: m_MinCorr(0),
cannam@7: m_Keys(0),
cannam@7: m_MedianFilterBuffer(0),
cannam@7: m_SortedBuffer(0)
cannam@7: {
cannam@7: 	m_DecimationFactor = 8;
cannam@7: 
cannam@7: 	//Chromagram configuration parameters
cannam@9: 	m_ChromaConfig.isNormalised = 1;
cannam@9: 	m_ChromaConfig.FS = lrint(sampleRate/(double)m_DecimationFactor);
cannam@9: 
cannam@9: //	m_ChromaConfig.min = 111.0641;
cannam@9: //	m_ChromaConfig.max = 1.7770e+003;
cannam@9: 
chriss@15: 	// Set C (= MIDI #12) as our base :
chriss@15: 	// This implies that key = 1 => Cmaj, key = 12 => Bmaj, key = 13 => Cmin, etc.
chriss@15: 	m_ChromaConfig.min = Pitch::getFrequencyForPitch
chriss@15: 		(12, 0, tuningFrequency);
chriss@15: 	m_ChromaConfig.max = Pitch::getFrequencyForPitch
chriss@15: 		(96, 0, tuningFrequency);
cannam@10: 
cannam@10: 	// The chromagram minimum pitch is 1/6 of a tone above A, two
cannam@10: 	// octaves below middle C (for a 36-bin chromagram).  The
cannam@10: 	// maximum pitch is four octaves higher.
chriss@15: /*	m_ChromaConfig.min = Pitch::getFrequencyForPitch
cannam@10: 		(45, 1.f / 3.f, tuningFrequency);
cannam@10: 
cannam@10: 	m_ChromaConfig.max = m_ChromaConfig.min * 2;
cannam@10: 	m_ChromaConfig.max = m_ChromaConfig.max * 2;
cannam@10: 	m_ChromaConfig.max = m_ChromaConfig.max * 2;
cannam@10: 	m_ChromaConfig.max = m_ChromaConfig.max * 2;
chriss@15: */
cannam@10: 	std::cerr << "Chromagram range: " << m_ChromaConfig.min << " -> " << m_ChromaConfig.max << std::endl;
cannam@9: 
cannam@9: 	m_ChromaConfig.BPO = 36;
cannam@9: 	m_ChromaConfig.CQThresh = 0.0054;
cannam@7: 
cannam@7: 	//Chromagram inst.
cannam@9: 	m_Chroma = new Chromagram( m_ChromaConfig );
cannam@7: 
cannam@7: 	//Get calculated parameters from chroma object
cannam@7: 	m_ChromaFrameSize = m_Chroma->getFrameSize();
cannam@7: 	//override hopsize for this application
cannam@7: 	m_ChromaHopSize = m_ChromaFrameSize;//m_Chroma->GetHopSize();
cannam@9: 	m_BPO = m_ChromaConfig.BPO;
cannam@7: 
cannam@7: 	//Chromagram average and estimated key median filter lengths
cannam@9: 	m_ChromaBuffersize = (int)ceil( m_hpcpAverage * m_ChromaConfig.FS/m_ChromaFrameSize );
cannam@9: 	m_MedianWinsize = (int)ceil( m_medianAverage * m_ChromaConfig.FS/m_ChromaFrameSize );
cannam@7: 
cannam@7: 	//Reset counters
cannam@7: 	m_bufferindex = 0;
cannam@7: 	m_ChromaBufferFilling = 0;
cannam@7: 	m_MedianBufferFilling = 0;
cannam@7: 
cannam@7: 
cannam@7: 	//Spawn objectc/arrays
cannam@7: 	m_DecimatedBuffer = new double[m_ChromaFrameSize];
cannam@7: 
cannam@7: 	m_ChromaBuffer = new double[m_BPO * m_ChromaBuffersize];
cannam@7: 	memset( m_ChromaBuffer, 0, sizeof(double) * m_BPO * m_ChromaBuffersize);
cannam@7: 	
cannam@7: 	m_MeanHPCP = new double[m_BPO];
cannam@7: 
cannam@7: 	m_MajCorr = new double[m_BPO];
cannam@7: 	m_MinCorr = new double[m_BPO];
cannam@7: 	m_Keys  = new double[2*m_BPO];
cannam@7: 	
cannam@7: 	m_MedianFilterBuffer = new int[ m_MedianWinsize ];
cannam@7: 	memset( m_MedianFilterBuffer, 0, sizeof(int)*m_MedianWinsize);
cannam@7: 	
cannam@7: 	m_SortedBuffer = new int[ m_MedianWinsize ];
cannam@7: 	memset( m_SortedBuffer, 0, sizeof(int)*m_MedianWinsize);	
cannam@7: 
cannam@7: 	m_Decimator = new Decimator( m_ChromaFrameSize*m_DecimationFactor, m_DecimationFactor );
cannam@7: }
cannam@7: 
cannam@7: GetKeyMode::~GetKeyMode()
cannam@7: {
cannam@7: 
cannam@7: 	delete m_Chroma;
cannam@7: 	delete m_Decimator;
cannam@7: 
cannam@7: 	delete [] m_DecimatedBuffer;
cannam@7: 	delete [] m_ChromaBuffer;
cannam@7: 	delete [] m_MeanHPCP;
cannam@7: 	delete [] m_MajCorr;
cannam@7: 	delete [] m_MinCorr;
cannam@7: 	delete [] m_Keys;
cannam@7: 	delete [] m_MedianFilterBuffer;
cannam@7: 	delete [] m_SortedBuffer;
cannam@7: }
cannam@7: 
cannam@7: double GetKeyMode::krumCorr(double *pData1, double *pData2, unsigned int length)
cannam@7: {
cannam@7: 	double retVal= 0.0;
cannam@7: 		
cannam@7: 	double num = 0;
cannam@7: 	double den = 0;
cannam@7: 	double mX = MathUtilities::mean( pData1, length );
cannam@7: 	double mY = MathUtilities::mean( pData2, length );
cannam@7: 
cannam@7: 	double sum1 = 0;
cannam@7: 	double sum2 = 0;
cannam@7: 
cannam@7: 	for( unsigned int i = 0; i <length; i++ )
cannam@7: 	{
cannam@7: 		num += ( pData1[i] - mX ) * ( pData2[i] - mY );
cannam@7: 
cannam@7: 		sum1 += ( (pData1[i]-mX) * (pData1[i]-mX) );
cannam@7: 		sum2 += ( (pData2[i]-mY) * (pData2[i]-mY) );
cannam@7: 	}
cannam@7: 	
cannam@7: 	den = sqrt(sum1 * sum2);
cannam@7: 	
cannam@7: 	if( den>0 )
cannam@7: 		retVal = num/den;
cannam@7: 	else
cannam@7: 		retVal = 0;
cannam@7: 
cannam@7: 
cannam@7: 	return retVal;
cannam@7: }
cannam@7: 
cannam@7: int GetKeyMode::process(double *PCMData)
cannam@7: {
cannam@7: 	int key;
cannam@7: 
cannam@7: 	unsigned int j,k;
cannam@7: 
cannam@7: 	//////////////////////////////////////////////
cannam@7: 	m_Decimator->process( PCMData, m_DecimatedBuffer);
cannam@7: 
cannam@7: 	m_ChrPointer = m_Chroma->process( m_DecimatedBuffer );		
cannam@7: 
chriss@15: 	
chriss@15: 	// Move bins such that the centre of the base note is in the middle of its three bins :
chriss@15: 	// Added 21.11.07 by Chris Sutton based on debugging with Katy Noland + comparison with Matlab equivalent.
chriss@15: 	MathUtilities::circShift( m_ChrPointer, m_BPO, 1);
chriss@15: 
cannam@9: 	std::cout << "raw chroma: ";
cannam@9: 	for (int ii = 0; ii < m_BPO; ++ii) {
cannam@9: 		std::cout << m_ChrPointer[ii] << " ";
cannam@9: 	}
cannam@9: 	std::cout << std::endl;
cannam@9: 
cannam@7: 	// populate hpcp values;
cannam@7: 	int cbidx;
cannam@7: 	for( j = 0; j < m_BPO; j++ )
cannam@7: 	{
cannam@7: 		cbidx = (m_bufferindex * m_BPO) + j;
cannam@7: 		m_ChromaBuffer[ cbidx ] = m_ChrPointer[j];
cannam@7: 	}
cannam@7: 
cannam@7: 	//keep track of input buffers;
cannam@7: 	if( m_bufferindex++ >= m_ChromaBuffersize - 1) 
cannam@7: 		m_bufferindex = 0;
cannam@7: 
cannam@7: 	// track filling of chroma matrix
cannam@7: 	if( m_ChromaBufferFilling++ >= m_ChromaBuffersize)
cannam@7: 		m_ChromaBufferFilling = m_ChromaBuffersize;
cannam@7: 
cannam@7: 	//calculate mean 		
cannam@7: 	for( k = 0; k < m_BPO; k++ )
cannam@7: 	{
cannam@7: 		double mnVal = 0.0;
cannam@7: 		for( j = 0; j < m_ChromaBufferFilling; j++ )
cannam@7: 		{
cannam@7: 			mnVal += m_ChromaBuffer[ k + (j*m_BPO) ];
cannam@7: 		}
cannam@7: 
cannam@7: 		m_MeanHPCP[k] = mnVal/(double)m_ChromaBufferFilling;
cannam@7: 	}
cannam@7: 
cannam@7: 
cannam@7: 	for( k = 0; k < m_BPO; k++ )
cannam@7: 	{
cannam@7: 		m_MajCorr[k] = krumCorr( m_MeanHPCP, MajProfile, m_BPO );
cannam@7: 		m_MinCorr[k] = krumCorr( m_MeanHPCP, MinProfile, m_BPO );
cannam@7: 
cannam@7: 		MathUtilities::circShift( MajProfile, m_BPO, 1 );
cannam@7: 		MathUtilities::circShift( MinProfile, m_BPO, 1 );
cannam@7: 	}
chriss@15: 	
cannam@7: 	for( k = 0; k < m_BPO; k++ )
cannam@7: 	{
cannam@7: 		m_Keys[k] = m_MajCorr[k];
cannam@7: 		m_Keys[k+m_BPO] = m_MinCorr[k];
cannam@7: 	}
chriss@15: 
chriss@15: 
cannam@9: 	std::cout << "raw keys: ";
cannam@9: 	for (int ii = 0; ii < 2*m_BPO; ++ii) {
cannam@9: 		std::cout << m_Keys[ii] << " ";
cannam@9: 	}
cannam@9: 	std::cout << std::endl;
chriss@15: 
cannam@7: 	double dummy;
chriss@15: 	// '1 +' because we number keys 1-24, not 0-23.
chriss@15: 	key = 1 + (int)ceil( (double)MathUtilities::getMax( m_Keys, 2* m_BPO, &dummy )/3 );
cannam@9: 
chriss@15: 	std::cout << "key pre-sorting: " << key << std::endl;
cannam@7: 
cannam@7: 
cannam@7: 	//Median filtering
cannam@7: 
cannam@7: 	// track Median buffer initial filling
cannam@7: 	if( m_MedianBufferFilling++ >= m_MedianWinsize)
cannam@7: 		m_MedianBufferFilling = m_MedianWinsize;
cannam@7: 		
cannam@7: 	//shift median buffer
cannam@7: 	for( k = 1; k < m_MedianWinsize; k++ )
cannam@7: 	{
cannam@7: 		m_MedianFilterBuffer[ k - 1 ] = m_MedianFilterBuffer[ k ];
cannam@7: 	}
cannam@7: 
cannam@7: 	//write new key value into median buffer
cannam@7: 	m_MedianFilterBuffer[ m_MedianWinsize - 1 ] = key;
cannam@7: 
cannam@7: 
cannam@7: 	//Copy median into sorting buffer, reversed
cannam@7: 	unsigned int ijx = 0;
cannam@7: 	for( k = 0; k < m_MedianWinsize; k++ )
cannam@7: 	{
cannam@7: 		m_SortedBuffer[k] = m_MedianFilterBuffer[m_MedianWinsize-1-ijx];
cannam@7: 		ijx++;
cannam@7: 	}
cannam@7: 
cannam@7: 
cannam@7: 	//quicksort 
cannam@7: 	qsort(m_SortedBuffer, m_MedianBufferFilling, sizeof(unsigned int), MathUtilities::compareInt);
chriss@15: 
cannam@9: 	std::cout << "sorted: ";
cannam@9: 	for (int ii = 0; ii < m_MedianBufferFilling; ++ii) {
cannam@9: 		std::cout << m_SortedBuffer[ii] << " ";
cannam@9: 	}
cannam@9: 	std::cout << std::endl;
chriss@15: 
cannam@7: 	int sortlength = m_MedianBufferFilling;
cannam@7: 	int midpoint = (int)ceil((double)sortlength/2);
cannam@7: 
cannam@7: 	if( midpoint <= 0 )
cannam@7: 		midpoint = 1;
cannam@7: 
cannam@7: 	key = m_SortedBuffer[midpoint-1];
cannam@7: 
cannam@7: 	return key;
cannam@7: }
cannam@7: 
cannam@7: 
cannam@7: int GetKeyMode::isModeMinor( int key )
cannam@7: { 
cannam@8: //	return ((key-1 - (int)MathUtilities::mod((double)(key-1),(double)12))/12); 
cannam@8: 	return (key > 12);
cannam@7: }