1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
\r
6 Centre for Digital Music, Queen Mary, University of London.
\r
7 This file copyright 2005-2006 Christian Landone.and Matthew Davies.
\r
9 This program is free software; you can redistribute it and/or
10 modify it under the terms of the GNU General Public License as
11 published by the Free Software Foundation; either version 2 of the
12 License, or (at your option) any later version. See the file
13 COPYING included with this distribution for more information.
\r
16 #include "TempoTrack.h"
\r
18 #include "maths/MathAliases.h"
\r
19 #include "maths/MathUtilities.h"
\r
25 //#define DEBUG_TEMPO_TRACK 1
\r
30 //////////////////////////////////////////////////////////////////////
\r
31 // Construction/Destruction
\r
32 //////////////////////////////////////////////////////////////////////
\r
34 TempoTrack::TempoTrack( TTParams Params )
\r
36 m_tempoScratch = NULL;
\r
37 m_rawDFFrame = NULL;
\r
38 m_smoothDFFrame = NULL;
\r
50 initialise( Params );
\r
53 TempoTrack::~TempoTrack()
\r
58 void TempoTrack::initialise( TTParams Params )
\r
60 m_winLength = Params.winLength;
\r
61 m_lagLength = Params.lagLength;
\r
64 m_sigma = sqrt(3.9017);
\r
65 m_DFWVNnorm = exp( ( log( 2.0 ) / m_rayparam ) * ( m_winLength + 2 ) );
\r
67 m_rawDFFrame = new double[ m_winLength ];
\r
68 m_smoothDFFrame = new double[ m_winLength ];
\r
69 m_frameACF = new double[ m_winLength ];
\r
70 m_tempoScratch = new double[ m_lagLength ];
\r
71 m_smoothRCF = new double[ m_lagLength ];
\r
74 unsigned int winPre = Params.WinT.pre;
\r
75 unsigned int winPost = Params.WinT.post;
\r
77 m_DFFramer.configure( m_winLength, m_lagLength );
\r
79 m_DFPParams.length = m_winLength;
\r
80 m_DFPParams.AlphaNormParam = Params.alpha;
\r
81 m_DFPParams.LPOrd = Params.LPOrd;
\r
82 m_DFPParams.LPACoeffs = Params.LPACoeffs;
\r
83 m_DFPParams.LPBCoeffs = Params.LPBCoeffs;
\r
84 m_DFPParams.winPre = Params.WinT.pre;
\r
85 m_DFPParams.winPost = Params.WinT.post;
\r
86 m_DFPParams.isMedianPositive = true;
\r
88 m_DFConditioning = new DFProcess( m_DFPParams );
\r
91 // these are parameters for smoothing m_tempoScratch
\r
92 m_RCFPParams.length = m_lagLength;
\r
93 m_RCFPParams.AlphaNormParam = Params.alpha;
\r
94 m_RCFPParams.LPOrd = Params.LPOrd;
\r
95 m_RCFPParams.LPACoeffs = Params.LPACoeffs;
\r
96 m_RCFPParams.LPBCoeffs = Params.LPBCoeffs;
\r
97 m_RCFPParams.winPre = Params.WinT.pre;
\r
98 m_RCFPParams.winPost = Params.WinT.post;
\r
99 m_RCFPParams.isMedianPositive = true;
\r
101 m_RCFConditioning = new DFProcess( m_RCFPParams );
\r
105 void TempoTrack::deInitialise()
\r
107 delete [] m_rawDFFrame;
\r
109 delete [] m_smoothDFFrame;
\r
111 delete [] m_smoothRCF;
\r
113 delete [] m_frameACF;
\r
115 delete [] m_tempoScratch;
\r
117 delete m_DFConditioning;
\r
119 delete m_RCFConditioning;
\r
123 void TempoTrack::createCombFilter(double* Filter, unsigned int winLength, unsigned int TSig, double beatLag)
\r
129 for( i = 0; i < winLength; i++ )
\r
131 Filter[ i ] = ( ( i + 1 ) / pow( m_rayparam, 2.0) ) * exp( ( -pow(( i + 1 ),2.0 ) / ( 2.0 * pow( m_rayparam, 2.0))));
\r
136 m_sigma = beatLag/4;
\r
137 for( i = 0; i < winLength; i++ )
\r
139 double dlag = (double)(i+1) - beatLag;
\r
140 Filter[ i ] = exp(-0.5 * pow(( dlag / m_sigma), 2.0) ) / (sqrt( 2 * PI) * m_sigma);
\r
145 double TempoTrack::tempoMM(double* ACF, double* weight, int tsig)
\r
149 double maxValRCF = 0.0;
\r
150 unsigned int maxIndexRCF = 0;
\r
154 unsigned int maxIndexTemp;
\r
156 unsigned int count;
\r
158 unsigned int numelem,i,j;
\r
161 for( i = 0; i < m_lagLength; i++ )
\r
162 m_tempoScratch[ i ] = 0.0;
\r
166 //if time sig is unknown, use metrically unbiased version of Filterbank
\r
174 #ifdef DEBUG_TEMPO_TRACK
\r
175 std::cerr << "tempoMM: m_winLength = " << m_winLength << ", m_lagLength = " << m_lagLength << ", numelem = " << numelem << std::endl;
\r
178 for(i=1;i<m_lagLength-1;i++)
\r
180 //first and last output values are left intentionally as zero
\r
181 for (a=1;a<=numelem;a++)
\r
183 for(b=(1-a);b<a;b++)
\r
187 m_tempoScratch[i] += ACF[a*(i+1)+b-1] * (1.0 / (2.0 * (double)a-1)) * weight[i];
\r
191 m_tempoScratch[i] += ACF[a*(i+1)+b-1] * 1 * weight[i];
\r
198 //////////////////////////////////////////////////
\r
199 // MODIFIED BEAT PERIOD EXTRACTION //////////////
\r
200 /////////////////////////////////////////////////
\r
202 // find smoothed version of RCF ( as applied to Detection Function)
\r
203 m_RCFConditioning->process( m_tempoScratch, m_smoothRCF);
\r
205 if (tsig != 0) // i.e. in context dependent state
\r
207 // NOW FIND MAX INDEX OF ACFOUT
\r
208 for( i = 0; i < m_lagLength; i++)
\r
210 if( m_tempoScratch[ i ] > maxValRCF)
\r
212 maxValRCF = m_tempoScratch[ i ];
\r
217 else // using rayleigh weighting
\r
219 vector <vector<double> > rcfMat;
\r
221 double sumRcf = 0.;
\r
223 double maxVal = 0.;
\r
224 // now find the two values which minimise rcfMat
\r
225 double minVal = 0.;
\r
226 int p_i = 1; // periodicity for row i;
\r
227 int p_j = 1; //periodicity for column j;
\r
230 for ( i=0; i<m_lagLength; i++)
\r
232 m_tempoScratch[i] =m_smoothRCF[i];
\r
235 // normalise m_tempoScratch so that it sums to zero.
\r
236 for ( i=0; i<m_lagLength; i++)
\r
238 sumRcf += m_tempoScratch[i];
\r
241 for( i=0; i<m_lagLength; i++)
\r
243 m_tempoScratch[i] /= sumRcf;
\r
246 // create a matrix to store m_tempoScratchValues modified by log2 ratio
\r
247 for ( i=0; i<m_lagLength; i++)
\r
249 rcfMat.push_back ( vector<double>() ); // adds a new row...
\r
252 for (i=0; i<m_lagLength; i++)
\r
254 for (j=0; j<m_lagLength; j++)
\r
256 rcfMat[i].push_back (0.);
\r
260 // the 'i' and 'j' indices deliberately start from '1' and not '0'
\r
261 for ( i=1; i<m_lagLength; i++)
\r
263 for (j=1; j<m_lagLength; j++)
\r
265 double log2PeriodRatio = log( static_cast<double>(i)/static_cast<double>(j) ) / log(2.0);
\r
266 rcfMat[i][j] = ( abs(1.0-abs(log2PeriodRatio)) );
\r
267 rcfMat[i][j] += ( 0.01*( 1./(m_tempoScratch[i]+m_tempoScratch[j]) ) );
\r
271 // set diagonal equal to maximum value in rcfMat
\r
272 // we don't want to pick one strong middle peak - we need a combination of two peaks.
\r
274 for ( i=1; i<m_lagLength; i++)
\r
276 for (j=1; j<m_lagLength; j++)
\r
278 if (rcfMat[i][j] > maxVal)
\r
280 maxVal = rcfMat[i][j];
\r
285 for ( i=1; i<m_lagLength; i++)
\r
287 rcfMat[i][i] = maxVal;
\r
290 // now find the row and column number which minimise rcfMat
\r
293 for ( i=1; i<m_lagLength; i++)
\r
295 for ( j=1; j<m_lagLength; j++)
\r
297 if (rcfMat[i][j] < minVal)
\r
299 minVal = rcfMat[i][j];
\r
307 // initially choose p_j (arbitrary) - saves on an else statement
\r
308 int beatPeriod = p_j;
\r
309 if (m_tempoScratch[p_i] > m_tempoScratch[p_j])
\r
314 // now write the output
\r
315 maxIndexRCF = static_cast<int>(beatPeriod);
\r
319 double locked = 5168.f / maxIndexRCF;
\r
320 if (locked >= 30 && locked <= 180) {
\r
321 m_lockedTempo = locked;
\r
324 #ifdef DEBUG_TEMPO_TRACK
\r
325 std::cerr << "tempoMM: locked tempo = " << m_lockedTempo << std::endl;
\r
332 #ifdef DEBUG_TEMPO_TRACK
\r
333 std::cerr << "tempoMM: maxIndexRCF = " << maxIndexRCF << std::endl;
\r
338 #ifdef DEBUG_TEMPO_TRACK
\r
339 std::cerr << "tsig == 4" << std::endl;
\r
342 pdPeaks = new double[ 4 ];
\r
343 for( i = 0; i < 4; i++ ){ pdPeaks[ i ] = 0.0;}
\r
345 pdPeaks[ 0 ] = ( double )maxIndexRCF + 1;
\r
351 for( i = (2 * maxIndexRCF + 1) - 1; i < (2 * maxIndexRCF + 1) + 2; i++ )
\r
353 if( ACF[ i ] > maxValTemp )
\r
355 maxValTemp = ACF[ i ];
\r
356 maxIndexTemp = count;
\r
360 pdPeaks[ 1 ] = (double)( maxIndexTemp + 1 + ( (2 * maxIndexRCF + 1 ) - 2 ) + 1 )/2;
\r
366 for( i = (3 * maxIndexRCF + 2 ) - 2; i < (3 * maxIndexRCF + 2 ) + 3; i++ )
\r
368 if( ACF[ i ] > maxValTemp )
\r
370 maxValTemp = ACF[ i ];
\r
371 maxIndexTemp = count;
\r
375 pdPeaks[ 2 ] = (double)( maxIndexTemp + 1 + ( (3 * maxIndexRCF + 2) - 4 ) + 1 )/3;
\r
381 for( i = ( 4 * maxIndexRCF + 3) - 3; i < ( 4 * maxIndexRCF + 3) + 4; i++ )
\r
383 if( ACF[ i ] > maxValTemp )
\r
385 maxValTemp = ACF[ i ];
\r
386 maxIndexTemp = count;
\r
390 pdPeaks[ 3 ] = (double)( maxIndexTemp + 1 + ( (4 * maxIndexRCF + 3) - 9 ) + 1 )/4 ;
\r
393 period = MathUtilities::mean( pdPeaks, 4 );
\r
397 #ifdef DEBUG_TEMPO_TRACK
\r
398 std::cerr << "tsig != 4" << std::endl;
\r
401 pdPeaks = new double[ 3 ];
\r
402 for( i = 0; i < 3; i++ ){ pdPeaks[ i ] = 0.0;}
\r
404 pdPeaks[ 0 ] = ( double )maxIndexRCF + 1;
\r
410 for( i = (2 * maxIndexRCF + 1) - 1; i < (2 * maxIndexRCF + 1) + 2; i++ )
\r
412 if( ACF[ i ] > maxValTemp )
\r
414 maxValTemp = ACF[ i ];
\r
415 maxIndexTemp = count;
\r
419 pdPeaks[ 1 ] = (double)( maxIndexTemp + 1 + ( (2 * maxIndexRCF + 1 ) - 2 ) + 1 )/2;
\r
425 for( i = (3 * maxIndexRCF + 2 ) - 2; i < (3 * maxIndexRCF + 2 ) + 3; i++ )
\r
427 if( ACF[ i ] > maxValTemp )
\r
429 maxValTemp = ACF[ i ];
\r
430 maxIndexTemp = count;
\r
434 pdPeaks[ 2 ] = (double)( maxIndexTemp + 1 + ( (3 * maxIndexRCF + 2) - 4 ) + 1 )/3;
\r
437 period = MathUtilities::mean( pdPeaks, 3 );
\r
445 void TempoTrack::stepDetect( double* periodP, double* periodG, int currentIdx, int* flag )
\r
447 double stepthresh = 1 * 3.9017;
\r
451 if(abs(periodG[ currentIdx ] - periodP[ currentIdx ]) > stepthresh)
\r
458 if(fabs(periodG[ currentIdx ]-periodP[ currentIdx ]) > stepthresh)
\r
465 void TempoTrack::constDetect( double* periodP, int currentIdx, int* flag )
\r
467 double constthresh = 2 * 3.9017;
\r
469 if( fabs( 2 * periodP[ currentIdx ] - periodP[ currentIdx - 1] - periodP[ currentIdx - 2] ) < constthresh)
\r
479 int TempoTrack::findMeter(double *ACF, unsigned int len, double period)
\r
482 int p = (int)MathUtilities::round( period );
\r
485 double Energy_3 = 0.0;
\r
486 double Energy_4 = 0.0;
\r
488 double temp3A = 0.0;
\r
489 double temp3B = 0.0;
\r
490 double temp4A = 0.0;
\r
491 double temp4B = 0.0;
\r
493 double* dbf = new double[ len ]; int t = 0;
\r
494 for( unsigned int u = 0; u < len; u++ ){ dbf[ u ] = 0.0; }
\r
496 if( (double)len < 6 * p + 2 )
\r
498 for( i = ( 3 * p - 2 ); i < ( 3 * p + 2 ) + 1; i++ )
\r
500 temp3A += ACF[ i ];
\r
501 dbf[ t++ ] = ACF[ i ];
\r
504 for( i = ( 4 * p - 2 ); i < ( 4 * p + 2 ) + 1; i++ )
\r
506 temp4A += ACF[ i ];
\r
514 for( i = ( 3 * p - 2 ); i < ( 3 * p + 2 ) + 1; i++ )
\r
516 temp3A += ACF[ i ];
\r
519 for( i = ( 4 * p - 2 ); i < ( 4 * p + 2 ) + 1; i++ )
\r
521 temp4A += ACF[ i ];
\r
524 for( i = ( 6 * p - 2 ); i < ( 6 * p + 2 ) + 1; i++ )
\r
526 temp3B += ACF[ i ];
\r
529 for( i = ( 2 * p - 2 ); i < ( 2 * p + 2 ) + 1; i++ )
\r
531 temp4B += ACF[ i ];
\r
534 Energy_3 = temp3A + temp3B;
\r
535 Energy_4 = temp4A + temp4B;
\r
538 if (Energy_3 > Energy_4)
\r
551 void TempoTrack::createPhaseExtractor(double *Filter, unsigned int winLength, double period, unsigned int fsp, unsigned int lastBeat)
\r
553 int p = (int)MathUtilities::round( period );
\r
554 int predictedOffset = 0;
\r
556 #ifdef DEBUG_TEMPO_TRACK
\r
557 std::cerr << "TempoTrack::createPhaseExtractor: period = " << period << ", p = " << p << std::endl;
\r
561 std::cerr << "TempoTrack::createPhaseExtractor: WARNING! Highly implausible period value " << p << "!" << std::endl;
\r
562 period = 5168 / 120;
\r
565 double* phaseScratch = new double[ p*2 + 2 ];
\r
566 for (int i = 0; i < p*2 + 2; ++i) phaseScratch[i] = 0.0;
\r
569 if( lastBeat != 0 )
\r
571 lastBeat = (int)MathUtilities::round((double)lastBeat );///(double)winLength);
\r
573 predictedOffset = lastBeat + p - fsp;
\r
575 if (predictedOffset < 0)
\r
581 if( lastBeat != 0 )
\r
584 double sigma = (double)p/8;
\r
585 double PhaseMin = 0.0;
\r
586 double PhaseMax = 0.0;
\r
587 unsigned int scratchLength = p*2;
\r
590 for( int i = 0; i < scratchLength; i++ )
\r
592 phaseScratch[ i ] = exp( -0.5 * pow( ( i - mu ) / sigma, 2 ) ) / ( sqrt( 2*PI ) *sigma );
\r
595 MathUtilities::getFrameMinMax( phaseScratch, scratchLength, &PhaseMin, &PhaseMax );
\r
597 for(int i = 0; i < scratchLength; i ++)
\r
599 temp = phaseScratch[ i ];
\r
600 phaseScratch[ i ] = (temp - PhaseMin)/PhaseMax;
\r
603 #ifdef DEBUG_TEMPO_TRACK
\r
604 std::cerr << "predictedOffset = " << predictedOffset << std::endl;
\r
607 unsigned int index = 0;
\r
608 for (int i = p - ( predictedOffset - 1); i < p + ( p - predictedOffset) + 1; i++)
\r
610 #ifdef DEBUG_TEMPO_TRACK
\r
611 std::cerr << "assigning to filter index " << index << " (size = " << p*2 << ")" << " value " << phaseScratch[i] << " from scratch index " << i << std::endl;
\r
613 Filter[ index++ ] = phaseScratch[ i ];
\r
618 for( int i = 0; i < p; i ++)
\r
624 delete [] phaseScratch;
\r
627 int TempoTrack::phaseMM(double *DF, double *weighting, unsigned int winLength, double period)
\r
630 int p = (int)MathUtilities::round( period );
\r
634 double* y = new double[ winLength ];
\r
635 double* align = new double[ p ];
\r
637 for( int i = 0; i < winLength; i++ )
\r
639 y[ i ] = (double)( -i + winLength )/(double)winLength;
\r
640 y[ i ] = pow(y [i ],2.0); // raise to power 2.
\r
643 for( int o = 0; o < p; o++ )
\r
646 for(int i = 1 + (o - 1); i< winLength; i += (p + 1))
\r
648 temp = temp + DF[ i ] * y[ i ];
\r
650 align[ o ] = temp * weighting[ o ];
\r
654 double valTemp = 0.0;
\r
655 for(int i = 0; i < p; i++)
\r
657 if( align[ i ] > valTemp )
\r
659 valTemp = align[ i ];
\r
670 int TempoTrack::beatPredict(unsigned int FSP0, double alignment, double period, unsigned int step )
\r
674 int p = (int)MathUtilities::round( period );
\r
675 int align = (int)MathUtilities::round( alignment );
\r
676 int FSP = (int)MathUtilities::round( FSP0 );
\r
678 int FEP = FSP + ( step );
\r
680 beat = FSP + align;
\r
682 m_beats.push_back( beat );
\r
684 while( beat + p < FEP )
\r
688 m_beats.push_back( beat );
\r
696 vector<int> TempoTrack::process( vector <double> DF,
\r
697 vector <double> *tempoReturn )
\r
699 m_dataLength = DF.size();
\r
701 m_lockedTempo = 0.0;
\r
703 double period = 0.0;
\r
710 vector <double> causalDF;
\r
714 //Prepare Causal Extension DFData
\r
715 unsigned int DFCLength = m_dataLength + m_winLength;
\r
717 for( unsigned int j = 0; j < m_winLength; j++ )
\r
719 causalDF.push_back( 0 );
\r
723 double* RW = new double[ m_lagLength ];
\r
724 for( unsigned int clear = 0; clear < m_lagLength; clear++){ RW[ clear ] = 0.0;}
\r
726 double* GW = new double[ m_lagLength ];
\r
727 for(unsigned int clear = 0; clear < m_lagLength; clear++){ GW[ clear ] = 0.0;}
\r
729 double* PW = new double[ m_lagLength ];
\r
730 for(unsigned clear = 0; clear < m_lagLength; clear++){ PW[ clear ] = 0.0;}
\r
732 m_DFFramer.setSource( &causalDF[0], m_dataLength );
\r
734 unsigned int TTFrames = m_DFFramer.getMaxNoFrames();
\r
736 #ifdef DEBUG_TEMPO_TRACK
\r
737 std::cerr << "TTFrames = " << TTFrames << std::endl;
\r
740 double* periodP = new double[ TTFrames ];
\r
741 for(unsigned clear = 0; clear < TTFrames; clear++){ periodP[ clear ] = 0.0;}
\r
743 double* periodG = new double[ TTFrames ];
\r
744 for(unsigned clear = 0; clear < TTFrames; clear++){ periodG[ clear ] = 0.0;}
\r
746 double* alignment = new double[ TTFrames ];
\r
747 for(unsigned clear = 0; clear < TTFrames; clear++){ alignment[ clear ] = 0.0;}
\r
751 createCombFilter( RW, m_lagLength, 0, 0 );
\r
753 int TTLoopIndex = 0;
\r
755 for( unsigned int i = 0; i < TTFrames; i++ )
\r
757 m_DFFramer.getFrame( m_rawDFFrame );
\r
759 m_DFConditioning->process( m_rawDFFrame, m_smoothDFFrame );
\r
761 m_correlator.doAutoUnBiased( m_smoothDFFrame, m_frameACF, m_winLength );
\r
763 periodP[ TTLoopIndex ] = tempoMM( m_frameACF, RW, 0 );
\r
767 periodG[ TTLoopIndex ] = tempoMM( m_frameACF, GW, tsig );
\r
771 periodG[ TTLoopIndex ] = 0.0;
\r
774 stepDetect( periodP, periodG, TTLoopIndex, &stepFlag );
\r
778 constDetect( periodP, TTLoopIndex, &constFlag );
\r
791 if( constFlag != 0)
\r
793 tsig = findMeter( m_frameACF, m_winLength, periodP[ TTLoopIndex ] );
\r
795 createCombFilter( GW, m_lagLength, tsig, periodP[ TTLoopIndex ] );
\r
797 periodG[ TTLoopIndex ] = tempoMM( m_frameACF, GW, tsig );
\r
799 period = periodG[ TTLoopIndex ];
\r
801 #ifdef DEBUG_TEMPO_TRACK
\r
802 std::cerr << "TempoTrack::process: constFlag == " << constFlag << ", TTLoopIndex = " << TTLoopIndex << ", period from periodG = " << period << std::endl;
\r
805 createPhaseExtractor( PW, m_winLength, period, FSP, 0 );
\r
814 period = periodG[ TTLoopIndex ];
\r
816 #ifdef DEBUG_TEMPO_TRACK
\r
817 std::cerr << "TempoTrack::process: GW[0] == " << GW[0] << ", TTLoopIndex = " << TTLoopIndex << ", period from periodG = " << period << std::endl;
\r
820 if (period > 10000) {
\r
821 std::cerr << "TempoTrack::process: WARNING! Highly implausible period value " << period << "!" << std::endl;
\r
822 std::cerr << "periodG contains (of " << TTFrames << " frames): " << std::endl;
\r
823 for (int i = 0; i < TTLoopIndex + 3 && i < TTFrames; ++i) {
\r
824 std::cerr << i << " -> " << periodG[i] << std::endl;
\r
826 std::cerr << "periodP contains (of " << TTFrames << " frames): " << std::endl;
\r
827 for (int i = 0; i < TTLoopIndex + 3 && i < TTFrames; ++i) {
\r
828 std::cerr << i << " -> " << periodP[i] << std::endl;
\r
830 period = 5168 / 120;
\r
833 createPhaseExtractor( PW, m_winLength, period, FSP, lastBeat );
\r
838 period = periodP[ TTLoopIndex ];
\r
840 #ifdef DEBUG_TEMPO_TRACK
\r
841 std::cerr << "TempoTrack::process: GW[0] == " << GW[0] << ", TTLoopIndex = " << TTLoopIndex << ", period from periodP = " << period << std::endl;
\r
844 createPhaseExtractor( PW, m_winLength, period, FSP, 0 );
\r
848 alignment[ TTLoopIndex ] = phaseMM( m_rawDFFrame, PW, m_winLength, period );
\r
850 lastBeat = beatPredict(FSP, alignment[ TTLoopIndex ], period, m_lagLength );
\r
852 FSP += (m_lagLength);
\r
854 if (tempoReturn) tempoReturn->push_back(m_lockedTempo);
\r
862 delete [] alignment;
\r