cannam@34: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@153: /*
Chris@153:     Copyright (c) 2005 Centre for Digital Music ( C4DM )
Chris@153:                        Queen Mary Univesrity of London
cannam@34: 
Chris@153:     This program is free software; you can redistribute it and/or
Chris@153:     modify it under the terms of the GNU General Public License as
Chris@153:     published by the Free Software Foundation; either version 2 of the
Chris@153:     License, or (at your option) any later version.  See the file
Chris@153:     COPYING included with this distribution for more information.
Chris@153: */
cannam@7: // GetKeyMode.cpp: implementation of the CGetKeyMode class.
cannam@7: //
cannam@7: //////////////////////////////////////////////////////////////////////
cannam@7: 
cannam@7: #include "GetKeyMode.h"
cannam@16: #include "maths/MathUtilities.h"
cannam@9: #include "base/Pitch.h"
cannam@9: 
cannam@9: #include <iostream>
cannam@7: 
cannam@47: #include <cstring>
cannam@47: #include <cstdlib>
cannam@47: 
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@40:     
cannam@7: 
cannam@7: //////////////////////////////////////////////////////////////////////
cannam@7: // Construction/Destruction
cannam@7: //////////////////////////////////////////////////////////////////////
cannam@7: 
cannam@9: GetKeyMode::GetKeyMode( int sampleRate, float tuningFrequency,
cannam@34: 			double hpcpAverage, double medianAverage ) :
cannam@34:     m_hpcpAverage( hpcpAverage ),
cannam@34:     m_medianAverage( medianAverage ),
cannam@34:     m_ChrPointer(0),
cannam@34:     m_DecimatedBuffer(0),
cannam@34:     m_ChromaBuffer(0),
cannam@34:     m_MeanHPCP(0),
cannam@34:     m_MajCorr(0),
cannam@34:     m_MinCorr(0),
cannam@34:     m_Keys(0),
cannam@34:     m_MedianFilterBuffer(0),
cannam@40:     m_SortedBuffer(0),
cannam@40:     m_keyStrengths(0)
cannam@7: {
cannam@34:     m_DecimationFactor = 8;
cannam@34:         
cannam@34:     // Chromagram configuration parameters
cannam@34:     m_ChromaConfig.normalise = MathUtilities::NormaliseUnitMax;
cannam@34:     m_ChromaConfig.FS = lrint(sampleRate/(double)m_DecimationFactor);
cannam@58:     if (m_ChromaConfig.FS < 1) m_ChromaConfig.FS = 1;
cannam@7: 
cannam@34:     // Set C (= MIDI #12) as our base :
cannam@34:     // This implies that key = 1 => Cmaj, key = 12 => Bmaj, key = 13 => Cmin, etc.
cannam@34:     m_ChromaConfig.min = Pitch::getFrequencyForPitch
cannam@40:         (48, 0, tuningFrequency);
cannam@34:     m_ChromaConfig.max = Pitch::getFrequencyForPitch
cannam@34:         (96, 0, tuningFrequency);
cannam@9: 
cannam@34:     m_ChromaConfig.BPO = 36;
cannam@34:     m_ChromaConfig.CQThresh = 0.0054;
cannam@9: 
cannam@34:     // Chromagram inst.
cannam@34:     m_Chroma = new Chromagram( m_ChromaConfig );
cannam@10: 
cannam@34:     // Get calculated parameters from chroma object
cannam@34:     m_ChromaFrameSize = m_Chroma->getFrameSize();
cannam@34:     // override hopsize for this application
cannam@34:     m_ChromaHopSize = m_ChromaFrameSize;
cannam@34:     m_BPO = m_ChromaConfig.BPO;
cannam@10: 
cannam@40: //    std::cerr << "chroma frame size = " << m_ChromaFrameSize << ", decimation factor = " << m_DecimationFactor << " therefore block size = " << getBlockSize() << std::endl;
cannam@40: 
cannam@34:     // Chromagram average and estimated key median filter lengths
cannam@34:     m_ChromaBuffersize = (int)ceil( m_hpcpAverage * m_ChromaConfig.FS/m_ChromaFrameSize );
cannam@34:     m_MedianWinsize = (int)ceil( m_medianAverage * m_ChromaConfig.FS/m_ChromaFrameSize );
cannam@34:     
cannam@34:     // Reset counters
cannam@34:     m_bufferindex = 0;
cannam@34:     m_ChromaBufferFilling = 0;
cannam@34:     m_MedianBufferFilling = 0;
cannam@9: 
cannam@34:     // Spawn objectc/arrays
cannam@34:     m_DecimatedBuffer = new double[m_ChromaFrameSize];
cannam@34:     
cannam@34:     m_ChromaBuffer = new double[m_BPO * m_ChromaBuffersize];
cannam@34:     memset( m_ChromaBuffer, 0, sizeof(double) * m_BPO * m_ChromaBuffersize);
cannam@34:     
cannam@34:     m_MeanHPCP = new double[m_BPO];
cannam@34:     
cannam@34:     m_MajCorr = new double[m_BPO];
cannam@34:     m_MinCorr = new double[m_BPO];
cannam@34:     m_Keys  = new double[2*m_BPO];
cannam@34:     
cannam@34:     m_MedianFilterBuffer = new int[ m_MedianWinsize ];
cannam@34:     memset( m_MedianFilterBuffer, 0, sizeof(int)*m_MedianWinsize);
cannam@34:     
cannam@34:     m_SortedBuffer = new int[ m_MedianWinsize ];
cannam@34:     memset( m_SortedBuffer, 0, sizeof(int)*m_MedianWinsize);	
cannam@34:     
cannam@34:     m_Decimator = new Decimator
cannam@34:         ( m_ChromaFrameSize*m_DecimationFactor, m_DecimationFactor );
cannam@40: 
cannam@40:     m_keyStrengths = new double[24];
cannam@7: }
cannam@7: 
cannam@7: GetKeyMode::~GetKeyMode()
cannam@7: {
cannam@7: 
cannam@34:     delete m_Chroma;
cannam@34:     delete m_Decimator;
cannam@34:     
cannam@34:     delete [] m_DecimatedBuffer;
cannam@34:     delete [] m_ChromaBuffer;
cannam@34:     delete [] m_MeanHPCP;
cannam@34:     delete [] m_MajCorr;
cannam@34:     delete [] m_MinCorr;
cannam@34:     delete [] m_Keys;
cannam@34:     delete [] m_MedianFilterBuffer;
cannam@34:     delete [] m_SortedBuffer;
cannam@40: 
cannam@40:     delete[] m_keyStrengths;
cannam@7: }
cannam@7: 
cannam@7: double GetKeyMode::krumCorr(double *pData1, double *pData2, unsigned int length)
cannam@7: {
cannam@34:     double retVal= 0.0;
cannam@34:     
cannam@34:     double num = 0;
cannam@34:     double den = 0;
cannam@34:     double mX = MathUtilities::mean( pData1, length );
cannam@34:     double mY = MathUtilities::mean( pData2, length );
cannam@34:     
cannam@34:     double sum1 = 0;
cannam@34:     double sum2 = 0;
cannam@34:     
cannam@34:     for( unsigned int i = 0; i <length; i++ )
cannam@34:     {
cannam@34:         num += ( pData1[i] - mX ) * ( pData2[i] - mY );
cannam@7: 
cannam@34:         sum1 += ( (pData1[i]-mX) * (pData1[i]-mX) );
cannam@34:         sum2 += ( (pData2[i]-mY) * (pData2[i]-mY) );
cannam@34:     }
cannam@34: 	
cannam@34:     den = sqrt(sum1 * sum2);
cannam@34: 	
cannam@34:     if( den>0 )
cannam@34:         retVal = num/den;
cannam@34:     else
cannam@34:         retVal = 0;
cannam@7: 
cannam@7: 
cannam@34:     return retVal;
cannam@7: }
cannam@7: 
cannam@7: int GetKeyMode::process(double *PCMData)
cannam@7: {
cannam@34:     int key;
cannam@7: 
cannam@34:     unsigned int j,k;
cannam@7: 
cannam@34:     //////////////////////////////////////////////
cannam@34:     m_Decimator->process( PCMData, m_DecimatedBuffer);
cannam@7: 
cannam@34:     m_ChrPointer = m_Chroma->process( m_DecimatedBuffer );		
cannam@7: 
chriss@15: 	
cannam@34:     // Move bins such that the centre of the base note is in the
cannam@34:     // middle of its three bins :
cannam@34:     // Added 21.11.07 by Chris Sutton based on debugging with Katy
cannam@34:     // Noland + comparison with Matlab equivalent.
cannam@34:     MathUtilities::circShift( m_ChrPointer, m_BPO, 1);
cannam@23: /*
cannam@73:     std::cout << "raw chroma: ";
cannam@73:     for (int ii = 0; ii < m_BPO; ++ii) {
cannam@73:       if (ii % (m_BPO/12) == 0) std::cout << "\n";
cannam@73:         std::cout << m_ChrPointer[ii] << " ";
cannam@73:     }
cannam@73:     std::cout << std::endl;
cannam@23: */
cannam@34:     // populate hpcp values;
cannam@34:     int cbidx;
cannam@34:     for( j = 0; j < m_BPO; j++ )
cannam@34:     {
cannam@34:         cbidx = (m_bufferindex * m_BPO) + j;
cannam@34:         m_ChromaBuffer[ cbidx ] = m_ChrPointer[j];
cannam@34:     }
cannam@7: 
cannam@34:     //keep track of input buffers;
cannam@34:     if( m_bufferindex++ >= m_ChromaBuffersize - 1) 
cannam@34:         m_bufferindex = 0;
cannam@7: 
cannam@34:     // track filling of chroma matrix
cannam@34:     if( m_ChromaBufferFilling++ >= m_ChromaBuffersize)
cannam@34:         m_ChromaBufferFilling = m_ChromaBuffersize;
cannam@7: 
cannam@34:     //calculate mean 		
cannam@34:     for( k = 0; k < m_BPO; k++ )
cannam@34:     {
cannam@34:         double mnVal = 0.0;
cannam@34:         for( j = 0; j < m_ChromaBufferFilling; j++ )
cannam@34:         {
cannam@34:             mnVal += m_ChromaBuffer[ k + (j*m_BPO) ];
cannam@34:         }
cannam@7: 
cannam@34:         m_MeanHPCP[k] = mnVal/(double)m_ChromaBufferFilling;
cannam@34:     }
cannam@7: 
cannam@7: 
cannam@34:     for( k = 0; k < m_BPO; k++ )
cannam@34:     {
cannam@34:         m_MajCorr[k] = krumCorr( m_MeanHPCP, MajProfile, m_BPO );
cannam@34:         m_MinCorr[k] = krumCorr( m_MeanHPCP, MinProfile, m_BPO );
cannam@7: 
cannam@34:         MathUtilities::circShift( MajProfile, m_BPO, 1 );
cannam@34:         MathUtilities::circShift( MinProfile, m_BPO, 1 );
cannam@34:     }
chriss@15: 	
cannam@34:     for( k = 0; k < m_BPO; k++ )
cannam@34:     {
cannam@34:         m_Keys[k] = m_MajCorr[k];
cannam@34:         m_Keys[k+m_BPO] = m_MinCorr[k];
cannam@34:     }
chriss@15: 
cannam@40:     for (k = 0; k < 24; ++k) {
cannam@40:         m_keyStrengths[k] = 0;
cannam@40:     }
cannam@40: 
cannam@40:     for( k = 0; k < m_BPO*2; k++ )
cannam@40:     {
cannam@73:         int idx = k / (m_BPO/12);
cannam@73:         int rem = k % (m_BPO/12);
cannam@73:         if (rem == 0 || m_Keys[k] > m_keyStrengths[idx]) {
cannam@73:             m_keyStrengths[idx] = m_Keys[k];
cannam@73:         }
cannam@73: 
cannam@73: //        m_keyStrengths[k/(m_BPO/12)] += m_Keys[k];
cannam@40:     }
chriss@15: 
cannam@23: /*
cannam@34:   std::cout << "raw keys: ";
cannam@34:   for (int ii = 0; ii < 2*m_BPO; ++ii) {
cannam@73:       if (ii % (m_BPO/12) == 0) std::cout << "\n";
cannam@73:       std::cout << m_Keys[ii] << " ";
cannam@73:   }
cannam@73:   std::cout << std::endl;
cannam@73: 
cannam@73:   std::cout << "key strengths: ";
cannam@73:   for (int ii = 0; ii < 24; ++ii) {
cannam@73:       if (ii % 6 == 0) std::cout << "\n";
cannam@73:       std::cout << m_keyStrengths[ii] << " ";
cannam@34:   }
cannam@34:   std::cout << std::endl;
cannam@23: */
cannam@34:     double dummy;
cannam@34:     // '1 +' because we number keys 1-24, not 0-23.
cannam@34:     key = 1 + (int)ceil( (double)MathUtilities::getMax( m_Keys, 2* m_BPO, &dummy )/3 );
cannam@9: 
cannam@73: //    std::cout << "key pre-sorting: " << key << std::endl;
cannam@7: 
cannam@7: 
cannam@34:     //Median filtering
cannam@7: 
cannam@34:     // track Median buffer initial filling
cannam@34:     if( m_MedianBufferFilling++ >= m_MedianWinsize)
cannam@34:         m_MedianBufferFilling = m_MedianWinsize;
cannam@7: 		
cannam@34:     //shift median buffer
cannam@34:     for( k = 1; k < m_MedianWinsize; k++ )
cannam@34:     {
cannam@34:         m_MedianFilterBuffer[ k - 1 ] = m_MedianFilterBuffer[ k ];
cannam@34:     }
cannam@7: 
cannam@34:     //write new key value into median buffer
cannam@34:     m_MedianFilterBuffer[ m_MedianWinsize - 1 ] = key;
cannam@7: 
cannam@7: 
cannam@34:     //Copy median into sorting buffer, reversed
cannam@34:     unsigned int ijx = 0;
cannam@34:     for( k = 0; k < m_MedianWinsize; k++ )
cannam@34:     {
cannam@34:         m_SortedBuffer[k] = m_MedianFilterBuffer[m_MedianWinsize-1-ijx];
cannam@34:         ijx++;
cannam@34:     }
cannam@7: 
cannam@34:     qsort(m_SortedBuffer, m_MedianBufferFilling, sizeof(unsigned int),
cannam@34:           MathUtilities::compareInt);
cannam@34: /*
cannam@34:   std::cout << "sorted: ";
cannam@34:   for (int ii = 0; ii < m_MedianBufferFilling; ++ii) {
cannam@34:   std::cout << m_SortedBuffer[ii] << " ";
cannam@34:   }
cannam@34:   std::cout << std::endl;
cannam@34: */
cannam@34:     int sortlength = m_MedianBufferFilling;
cannam@34:     int midpoint = (int)ceil((double)sortlength/2);
cannam@7: 
cannam@73: //  std::cout << "midpoint = " << midpoint << endl;
cannam@73: 
cannam@34:     if( midpoint <= 0 )
cannam@34:         midpoint = 1;
cannam@7: 
cannam@34:     key = m_SortedBuffer[midpoint-1];
cannam@7: 
cannam@73: // std::cout << "returning key = " << key << endl;
cannam@73: 
cannam@34:     return key;
cannam@7: }
cannam@7: 
cannam@7: 
cannam@43: bool GetKeyMode::isModeMinor( int key )
cannam@7: { 
cannam@34:     return (key > 12);
cannam@7: }