view test/TestNoteHypothesis.cpp @ 60:c06fe5350b34

But don't use a mid-stream low-confidence observation to reject a good ongoing hypothesis

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
/*
    This file is Copyright (c) 2012 Chris Cannam
  
    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use, copy,
    modify, merge, publish, distribute, sublicense, and/or sell copies
    of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#include "NoteHypothesis.h"

std::ostream &operator<<(std::ostream &out, const NoteHypothesis::Estimate &n)
{
    return out << "[" << n.freq << "@" << n.time << ":" << n.confidence << "]" << std::endl;
}

std::ostream &operator<<(std::ostream &out, const NoteHypothesis::Estimates &e)
{
    out << "( ";
    for (int i = 0; i < (int)e.size(); ++i) out << e[i] << "; ";
    out << " )";
    return out;
}

std::ostream &operator<<(std::ostream &out, const NoteHypothesis::Note &n)
{
    return out << "[" << n.freq << "@" << n.time << ":" << n.duration << "]" << std::endl;
}

#define BOOST_TEST_DYN_LINK
#define BOOST_TEST_MAIN

#include <boost/test/unit_test.hpp>

using Vamp::RealTime;

BOOST_AUTO_TEST_SUITE(TestNoteHypothesis)

BOOST_AUTO_TEST_CASE(emptyAccept)
{
    // An empty hypothesis should accept any estimate with a
    // non-negligible confidence, and enter provisional state
    NoteHypothesis h;
    NoteHypothesis::Estimate e; // default estimate has confidence 1
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
}

BOOST_AUTO_TEST_CASE(noConfidence)
{
    // A hypothesis should reject any estimate that has a negligible
    // confidence
    NoteHypothesis h;
    NoteHypothesis::Estimate e;
    e.confidence = 0;
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(!h.accept(e));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Rejected);
}

BOOST_AUTO_TEST_CASE(noConfidenceIgnore)
{
    // But if we're already in process we don't go to rejected state,
    // we just ignore this hypothesis
    NoteHypothesis h;
    NoteHypothesis::Estimate e;
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    e.confidence = 0;
    BOOST_CHECK(!h.accept(e));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
}
		
BOOST_AUTO_TEST_CASE(tooSlow)
{
    // Having accepted a first estimate, a hypothesis should reject a
    // second (and enter rejected state) if there is too long a gap
    // between them for them to belong to a single note
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(500, RealTime::fromMilliseconds(0), 1);
    NoteHypothesis::Estimate e2(500, RealTime::fromMilliseconds(50), 1);
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(!h.accept(e2));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Rejected);
}

BOOST_AUTO_TEST_CASE(simpleSatisfy)
{
    // A hypothesis should enter satisfied state after accepting three
    // consistent estimates, and then remain satisfied while accepting
    // further consistent estimates
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(500, RealTime::fromMilliseconds(0), 1);
    NoteHypothesis::Estimate e2(500, RealTime::fromMilliseconds(10), 1);
    NoteHypothesis::Estimate e3(500, RealTime::fromMilliseconds(20), 1);
    NoteHypothesis::Estimate e4(500, RealTime::fromMilliseconds(30), 1);
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e2));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK(h.accept(e4));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
}

BOOST_AUTO_TEST_CASE(expiry)
{
    // A hypothesis that has been satisfied, but that is subsequently
    // offered an estimate that follows too long a gap, should enter
    // expired state rather than rejected state (showing that it has a
    // valid note but that the note has apparently finished)
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(500, RealTime::fromMilliseconds(0), 1);
    NoteHypothesis::Estimate e2(500, RealTime::fromMilliseconds(10), 1);
    NoteHypothesis::Estimate e3(500, RealTime::fromMilliseconds(20), 1);
    NoteHypothesis::Estimate e4(500, RealTime::fromMilliseconds(30), 1);
    NoteHypothesis::Estimate e5(500, RealTime::fromMilliseconds(80), 1);
    NoteHypothesis::Estimate e6(500, RealTime::fromMilliseconds(90), 1);
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e2));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK(h.accept(e4));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK(!h.accept(e5));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Expired);
    BOOST_CHECK(!h.accept(e6));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Expired);
}
	
BOOST_AUTO_TEST_CASE(strayReject1)
{
    // A wildly different frequency occurring in the middle of a
    // provisionally accepted note should be ignored
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(500, RealTime::fromMilliseconds(0), 1);
    NoteHypothesis::Estimate e2(1000, RealTime::fromMilliseconds(10), 1);
    NoteHypothesis::Estimate e3(500, RealTime::fromMilliseconds(20), 1);
    NoteHypothesis::Estimate e4(500, RealTime::fromMilliseconds(30), 1);
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(!h.accept(e2));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e4));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
}

BOOST_AUTO_TEST_CASE(strayReject2)
{
    // A wildly different frequency occurring in the middle of a
    // satisfied note should be ignored
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(500, RealTime::fromMilliseconds(0), 1);
    NoteHypothesis::Estimate e2(500, RealTime::fromMilliseconds(10), 1);
    NoteHypothesis::Estimate e3(500, RealTime::fromMilliseconds(20), 1);
    NoteHypothesis::Estimate e4(1000, RealTime::fromMilliseconds(30), 1);
    NoteHypothesis::Estimate e5(500, RealTime::fromMilliseconds(40), 1);
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e2));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK(!h.accept(e4));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK(h.accept(e5));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
}
	
BOOST_AUTO_TEST_CASE(weakSatisfy)
{
    // Behaviour with slightly varying frequencies should be as for
    // that with fixed frequency
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(500, RealTime::fromMilliseconds(0), 0.5);
    NoteHypothesis::Estimate e2(502, RealTime::fromMilliseconds(10), 0.5);
    NoteHypothesis::Estimate e3(504, RealTime::fromMilliseconds(20), 0.5);
    NoteHypothesis::Estimate e4(506, RealTime::fromMilliseconds(30), 0.5);
    NoteHypothesis::Estimate e5(508, RealTime::fromMilliseconds(40), 0.5);
    NoteHypothesis::Estimate e6(510, RealTime::fromMilliseconds(90), 0.5);
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e2));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e4));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e5));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK(!h.accept(e6));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Expired);
}
	
BOOST_AUTO_TEST_CASE(frequencyRange)
{
    // But there's a limit: outside a certain range we should reject
    //!!! (but what is this range? is it part of the spec?)
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(440, RealTime::fromMilliseconds(0), 1);
    NoteHypothesis::Estimate e2(448, RealTime::fromMilliseconds(10), 1);
    NoteHypothesis::Estimate e3(444, RealTime::fromMilliseconds(20), 1);
    NoteHypothesis::Estimate e4(470, RealTime::fromMilliseconds(30), 1);
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e2));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK(!h.accept(e4));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
}

BOOST_AUTO_TEST_CASE(acceptedEstimates)
{
    // Check that getAcceptedEstimates() returns the right result
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(440, RealTime::fromMilliseconds(0), 1);
    NoteHypothesis::Estimate e2(448, RealTime::fromMilliseconds(10), 1);
    NoteHypothesis::Estimate e3(444, RealTime::fromMilliseconds(20), 1);
    NoteHypothesis::Estimate e4(470, RealTime::fromMilliseconds(30), 1);
    NoteHypothesis::Estimate e5(444, RealTime::fromMilliseconds(90), 1);
    NoteHypothesis::Estimates es;
    es.push_back(e1);
    es.push_back(e2);
    es.push_back(e3);
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::New);
    BOOST_CHECK_EQUAL(h.getAcceptedEstimates(), NoteHypothesis::Estimates());
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK_EQUAL(h.getAcceptedEstimates(), NoteHypothesis::Estimates());
    BOOST_CHECK(h.accept(e2));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Provisional);
    BOOST_CHECK_EQUAL(h.getAcceptedEstimates(), NoteHypothesis::Estimates());
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK_EQUAL(h.getAcceptedEstimates(), es);
    BOOST_CHECK(!h.accept(e4));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Satisfied);
    BOOST_CHECK_EQUAL(h.getAcceptedEstimates(), es);
    BOOST_CHECK(!h.accept(e5));
    BOOST_CHECK_EQUAL(h.getState(), NoteHypothesis::Expired);
    BOOST_CHECK_EQUAL(h.getAcceptedEstimates(), es);
}
	
BOOST_AUTO_TEST_CASE(meanFrequency)
{
    // Check that the mean frequency is the mean of the frequencies
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(440, RealTime::fromMilliseconds(0), 1);
    NoteHypothesis::Estimate e2(448, RealTime::fromMilliseconds(10), 1);
    NoteHypothesis::Estimate e3(444, RealTime::fromMilliseconds(20), 1);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK(h.accept(e2));
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getMeanFrequency(), 444.0);
}

BOOST_AUTO_TEST_CASE(averagedNote)
{
    // Check that getAveragedNote returns something sane
    NoteHypothesis h;
    NoteHypothesis::Estimate e1(440, RealTime::fromMilliseconds(10), 1);
    NoteHypothesis::Estimate e2(448, RealTime::fromMilliseconds(20), 1);
    NoteHypothesis::Estimate e3(444, RealTime::fromMilliseconds(30), 1);
    BOOST_CHECK(h.accept(e1));
    BOOST_CHECK(h.accept(e2));
    BOOST_CHECK(h.accept(e3));
    BOOST_CHECK_EQUAL(h.getAveragedNote(), NoteHypothesis::Note
                      (444,
                       RealTime::fromMilliseconds(10),
                       RealTime::fromMilliseconds(20)));
}

//!!! Not yet tested: Confidence scores

BOOST_AUTO_TEST_SUITE_END()