Chris@8: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@8: 
Chris@8: /*
Chris@8:   Vamp feature extraction plugin for the BeatRoot beat tracker.
Chris@8: 
Chris@8:   Centre for Digital Music, Queen Mary, University of London.
Chris@8:   This file copyright 2011 Simon Dixon, Chris Cannam and QMUL.
Chris@8:     
Chris@8:   This program is free software; you can redistribute it and/or
Chris@8:   modify it under the terms of the GNU General Public License as
Chris@8:   published by the Free Software Foundation; either version 2 of the
Chris@8:   License, or (at your option) any later version.  See the file
Chris@8:   COPYING included with this distribution for more information.
Chris@8: */
Chris@8: 
Chris@8: #ifndef _AGENT_LIST_H_
Chris@8: #define _AGENT_LIST_H_
Chris@8: 
Chris@8: #include "Agent.h"
Chris@8: #include "Event.h"
Chris@8: 
Chris@8: #include <algorithm>
Chris@8: 
Chris@8: /** Class for maintaining the set of all Agents involved in beat tracking a piece of music.
Chris@8:  */
Chris@8: class AgentList
Chris@8: {
Chris@8: public:
Chris@8:     typedef std::vector<Agent> Container;
Chris@8:     typedef Container::iterator iterator;
Chris@8: 
Chris@8: protected:
Chris@8:     Container list;
Chris@8: 
Chris@8: public:
Chris@8:     // expose some vector methods
Chris@8:     //!!! can we remove these again once the rest of AgentList is implemented?
Chris@8:     bool empty() const { return list.empty(); }
Chris@8:     Container::iterator begin() { return list.begin(); }
Chris@8:     Container::iterator end() { return list.end(); }
Chris@8:     void push_back(const Agent &a) { list.push_back(a); }
Chris@8: 
Chris@11:     /** Flag for choice between sum and average beat salience values for Agent scores.
Chris@11:      *  The use of summed saliences favours faster tempi or lower metrical levels. */
Chris@11:     static bool useAverageSalience;
Chris@8: 	
Chris@11:     /** For the purpose of removing duplicate agents, the default JND of IBI */
Chris@11:     static const double DEFAULT_BI;
Chris@8: 	
Chris@11:     /** For the purpose of removing duplicate agents, the default JND of phase */
Chris@11:     static const double DEFAULT_BT;
Chris@8: 
Chris@11:     /** Inserts newAgent into the list in ascending order of beatInterval */
Chris@11:     void add(Agent a) {
Chris@11: 	add(a, true);
Chris@11:     } // add()/1
Chris@8: 
Chris@11:     /** Appends newAgent to list (sort==false), or inserts newAgent into the list
Chris@11:      *  in ascending order of beatInterval
Chris@11:      *  @param newAgent The agent to be added to the list
Chris@11:      *  @param sort Flag indicating whether the list is sorted or not
Chris@11:      */
Chris@11:     void add(Agent newAgent, bool sort){
Chris@11: 	list.push_back(newAgent);
Chris@11: 	if (sort) this->sort();
Chris@11:     } // add()/2
Chris@8: 
Chris@11:     /** Sorts the AgentList by increasing beatInterval. */
Chris@11:     void sort() {
Chris@11: 	std::sort(list.begin(), list.end());
Chris@11:     } // sort()
Chris@8: 
Chris@11:     /** Removes the given item from the list.
Chris@11:      *  @param ptr Points to the Agent which is removed from the list
Chris@11:      */
Chris@11:     void remove(iterator itr) {
Chris@11: 	list.erase(itr);
Chris@11:     } // remove()
Chris@8: 
Chris@8: protected:
Chris@11:     /** Removes Agents from the list which are duplicates of other Agents.
Chris@11:      *  A duplicate is defined by the tempo and phase thresholds
Chris@11:      *  thresholdBI and thresholdBT respectively.
Chris@11:      */
Chris@11:     void removeDuplicates() {
Chris@11: 	sort();
Chris@11: 	for (iterator itr = begin(); itr != end(); ++itr) {
Chris@11: 	    if (itr->phaseScore < 0.0) // already flagged for deletion
Chris@11: 		continue;
Chris@11: 	    iterator itr2 = itr;
Chris@11: 	    for (++itr2; itr2 != end(); ++itr2) {
Chris@11: 		if (itr2->beatInterval - itr->beatInterval > DEFAULT_BI)
Chris@11: 		    break;
Chris@11: 		if (fabs(itr->beatTime - itr2->beatTime) > DEFAULT_BT)
Chris@11: 		    continue;
Chris@11: 		if (itr->phaseScore < itr2->phaseScore) {
Chris@11: 		    itr->phaseScore = -1.0;	// flag for deletion
Chris@11: 		    if (itr2->topScoreTime < itr->topScoreTime)
Chris@11: 			itr2->topScoreTime = itr->topScoreTime;
Chris@11: 		    break;
Chris@11: 		} else {
Chris@11: 		    itr2->phaseScore = -1.0;	// flag for deletion
Chris@11: 		    if (itr->topScoreTime < itr2->topScoreTime)
Chris@11: 			itr->topScoreTime = itr2->topScoreTime;
Chris@11: 		}
Chris@11: 	    }
Chris@11: 	}
Chris@11: 	for (iterator itr = begin(); itr != end(); ) {
Chris@11: 	    if (itr->phaseScore < 0.0) {
Chris@11: 		list.erase(itr);
Chris@11: 	    } else {
Chris@11: 		++itr;
Chris@11: 	    }
Chris@11: 	}
Chris@11:     } // removeDuplicates()
Chris@8: 
Chris@8: public:
Chris@11:     /** Perform beat tracking on a list of events (onsets).
Chris@11:      *  @param el The list of onsets (or events or peaks) to beat track
Chris@11:      */
Chris@11:     void beatTrack(EventList el) {
Chris@11: 	beatTrack(el, -1.0);
Chris@11:     } // beatTrack()/1
Chris@8: 	
Chris@11:     /** Perform beat tracking on a list of events (onsets).
Chris@11:      *  @param el The list of onsets (or events or peaks) to beat track.
Chris@11:      *  @param stop Do not find beats after <code>stop</code> seconds.
Chris@11:      */
Chris@11:     void beatTrack(EventList el, double stop) {
Chris@11: 	EventList::iterator ei = el.begin();
Chris@11: 	bool phaseGiven = !empty() && (begin()->beatTime >= 0); // if given for one, assume given for others
Chris@11: 	while (ei != el.end()) {
Chris@11: 	    Event ev = *ei;
Chris@11: 	    ++ei;
Chris@11: 	    if ((stop > 0) && (ev.time > stop))
Chris@11: 		break;
Chris@11: 	    bool created = phaseGiven;
Chris@11: 	    double prevBeatInterval = -1.0;
Chris@11: 	    // cc: Duplicate our list of agents, and scan through
Chris@11: 	    // the (now immutable) copy.  This means we can safely
Chris@11: 	    // add agents to our own list while scanning without
Chris@11: 	    // disrupting our scan.
Chris@11: 	    Container currentAgents = list;
Chris@11: 	    for (Container::iterator ai = currentAgents.begin();
Chris@11: 		 ai != currentAgents.end(); ++ai) {
Chris@11: 		Agent currentAgent = *ai;
Chris@11: 		if (currentAgent.beatInterval != prevBeatInterval) {
Chris@11: 		    if ((prevBeatInterval>=0) && !created && (ev.time<5.0)) {
Chris@11: 			// Create new agent with different phase
Chris@11: 			Agent newAgent(prevBeatInterval);
Chris@11: 			// This may add an agent to our list
Chris@11: 			newAgent.considerAsBeat(ev, *this);
Chris@8: 		    }
Chris@11: 		    prevBeatInterval = currentAgent.beatInterval;
Chris@11: 		    created = phaseGiven;
Chris@11: 		}
Chris@11: 		if (currentAgent.considerAsBeat(ev, *this))
Chris@11: 		    created = true;
Chris@11: 	    } // loop for each agent
Chris@11: 	    removeDuplicates();
Chris@11: 	} // loop for each event
Chris@11:     } // beatTrack()
Chris@8: 
Chris@11:     /** Finds the Agent with the highest score in the list, or NULL if beat tracking has failed.
Chris@11:      *  @return The Agent with the highest score
Chris@11:      */
Chris@11:     Agent *bestAgent() {
Chris@11: 	double best = -1.0;
Chris@11: 	Agent *bestAg = 0;
Chris@11: 	for (iterator itr = begin(); itr != end(); ++itr) {
Chris@11: 	    if (itr->events.empty()) continue;
Chris@11: 	    double startTime = itr->events.begin()->time;
Chris@11: 	    double conf = (itr->phaseScore + itr->tempoScore) /
Chris@11: 		(useAverageSalience? (double)itr->beatCount: 1.0);
Chris@11: 	    if (conf > best) {
Chris@11: 		bestAg = &(*itr);
Chris@11: 		best = conf;
Chris@8: 	    }
Chris@11: 	}
Chris@11: 	return bestAg;
Chris@11:     } // bestAgent()
Chris@8: 
Chris@8: 
Chris@8: }; // class AgentList
Chris@8: 
Chris@8: #endif
Chris@8: