annotate plugins/Silence.cpp @ 24:eb246395f576

* Fix substantial amount of wrongness in getRemainingFeatures

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Vamp feature extraction plugins using Paul Brossier's Aubio library.

    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006-2008 Chris Cannam and QMUL.
    
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#include <math.h>
#include "Silence.h"

using std::string;
using std::vector;
using std::cerr;
using std::endl;

Silence::Silence(float inputSampleRate, unsigned int apiVersion) :
    Plugin(inputSampleRate),
    m_apiVersion(apiVersion),
    m_ibuf(0),
    m_pbuf(0),
    m_tmpptrs(0),
    m_threshold(-80),
    m_prevSilent(false),
    m_first(true)
{
    if (m_apiVersion == 1) {
        cerr << "vamp-aubio: WARNING: using compatibility version 1 of the Vamp API for silence\n"
             << "detector plugin: upgrade your host to v2 for proper duration support" << endl;
    }
}

Silence::~Silence()
{
    if (m_ibuf) del_fvec(m_ibuf);
    if (m_pbuf) del_fvec(m_pbuf);
    if (m_tmpptrs) delete[] m_tmpptrs;
}

string
Silence::getIdentifier() const
{
    return "aubiosilence";
}

string
Silence::getName() const
{
    return "Aubio Silence Detector";
}

string
Silence::getDescription() const
{
    return "Detect levels below a certain threshold";
}

string
Silence::getMaker() const
{
    return "Paul Brossier (plugin by Chris Cannam)";
}

int
Silence::getPluginVersion() const
{
    if (m_apiVersion == 1) return 2;
    return 3;
}

string
Silence::getCopyright() const
{
    return "GPL";
}

bool
Silence::initialise(size_t channels, size_t stepSize, size_t blockSize)
{
    m_channelCount = channels;
    m_stepSize = stepSize;
    m_blockSize = blockSize;

    m_ibuf = new_fvec(stepSize, channels);
    m_pbuf = new_fvec(stepSize, channels);
    m_tmpptrs = new smpl_t *[channels];

    return true;
}

void
Silence::reset()
{
    m_first = true;
}

size_t
Silence::getPreferredStepSize() const
{
    return 1024;
}

size_t
Silence::getPreferredBlockSize() const
{
    return 1024;
}

Silence::ParameterList
Silence::getParameterDescriptors() const
{
    ParameterList list;
    ParameterDescriptor desc;

    desc = ParameterDescriptor();
    desc.identifier = "silencethreshold";
    desc.name = "Silence Threshold";
    desc.minValue = -120;
    desc.maxValue = 0;
    desc.defaultValue = -80;
    desc.unit = "dB";
    desc.isQuantized = false;
    list.push_back(desc);

    return list;
}

float
Silence::getParameter(std::string param) const
{
    if (param == "silencethreshold") {
        return m_threshold;
    } else {
        return 0.0;
    }
}

void
Silence::setParameter(std::string param, float value)
{
    if (param == "silencethreshold") {
        m_threshold = value;
    }
}

Silence::OutputList
Silence::getOutputDescriptors() const
{
    OutputList list;

    OutputDescriptor d;

    if (m_apiVersion == 1) {

        d.identifier = "silencestart";
        d.name = "Beginnings of Silent Regions";
        d.description = "Return a single instant at the point where each silent region begins";
        d.hasFixedBinCount = true;
        d.binCount = 0;
        d.hasKnownExtents = false;
        d.sampleType = OutputDescriptor::VariableSampleRate;
        d.sampleRate = 0;
        list.push_back(d);

        d.identifier = "silenceend";
        d.name = "Ends of Silent Regions";
        d.description = "Return a single instant at the point where each silent region ends";
        d.hasFixedBinCount = true;
        d.binCount = 0;
        d.hasKnownExtents = false;
        d.sampleType = OutputDescriptor::VariableSampleRate;
        d.sampleRate = 0;
        list.push_back(d);

    } else {

        d.identifier = "silent";
        d.name = "Silent Regions";
        d.description = "Return an interval covering each silent region";
        d.hasFixedBinCount = true;
        d.binCount = 0;
        d.hasKnownExtents = false;
        d.sampleType = OutputDescriptor::VariableSampleRate;
        d.sampleRate = 0;
        d.hasDuration = true;
        list.push_back(d);

        d.identifier = "noisy";
        d.name = "Non-Silent Regions";
        d.description = "Return an interval covering each non-silent region";
        d.hasFixedBinCount = true;
        d.binCount = 0;
        d.hasKnownExtents = false;
        d.sampleType = OutputDescriptor::VariableSampleRate;
        d.sampleRate = 0;
        d.hasDuration = true;
        list.push_back(d);
    }

    d.identifier = "silencelevel";
    d.name = "Silence Test";
    d.description = "Return a function that switches from 1 to 0 when silence falls, and back again when it ends";
    d.hasFixedBinCount = true;
    d.binCount = 1;
    d.hasKnownExtents = true;
    d.minValue = 0;
    d.maxValue = 1;
    d.isQuantized = true;
    d.quantizeStep = 1;
    d.sampleType = OutputDescriptor::VariableSampleRate;
    d.sampleRate = 0;
    list.push_back(d);

    return list;
}

Silence::FeatureSet
Silence::process(const float *const *inputBuffers,
                 Vamp::RealTime timestamp)
{
    for (size_t i = 0; i < m_stepSize; ++i) {
        for (size_t j = 0; j < m_channelCount; ++j) {
            fvec_write_sample(m_ibuf, inputBuffers[j][i], j, i);
        }
    }

    bool silent = aubio_silence_detection(m_ibuf, m_threshold);
    FeatureSet returnFeatures;

    if (m_first || m_prevSilent != silent) {

        Vamp::RealTime featureStamp = timestamp;

        if ((silent && !m_first) || !silent) {
        
            // refine our result

            long off = 0;
            size_t incr = 16;
            if (incr > m_stepSize/8) incr = m_stepSize/8;

            fvec_t vec;
            vec.length = incr * 4;
            vec.channels = m_channelCount;
            vec.data = m_tmpptrs;
            
            for (size_t i = 0; i < m_stepSize - incr * 4; i += incr) {
                for (size_t j = 0; j < m_channelCount; ++j) {
                    m_tmpptrs[j] = m_ibuf->data[j] + i;
                }
                bool subsilent = aubio_silence_detection(&vec, m_threshold);
                if (silent == subsilent) {
                    off = i;
                    break;
                }
            }

            if (silent && (off == 0)) {
                for (size_t i = 0; i < m_stepSize - incr; i += incr) {
                    for (size_t j = 0; j < m_channelCount; ++j) {
                        m_tmpptrs[j] = m_pbuf->data[j] + m_stepSize - i - incr;
                    }
                    bool subsilent = aubio_silence_detection(&vec, m_threshold);
                    if (!subsilent) {
                        off = -(long)i;
                        break;
                    }
                }
            } else {
            }                

            featureStamp = timestamp + Vamp::RealTime::frame2RealTime
                (off, lrintf(m_inputSampleRate));
        }

        Feature feature;
        feature.hasTimestamp = true;
        feature.timestamp = featureStamp;
        feature.values.push_back(silent ? 0 : 1);
        returnFeatures[2].push_back(feature);

        feature.values.clear();

        if (m_apiVersion == 1) {
            if (silent) {
                // silencestart feature
                returnFeatures[0].push_back(feature);
            } else {
                // silenceend feature
                returnFeatures[1].push_back(feature);
            }
        } else {
            if (!m_first) {
                feature.timestamp = m_lastChange;
                feature.hasDuration = true;
                feature.duration = featureStamp - m_lastChange;
                if (silent) {
                    // non-silent regions feature
                    // (becoming silent, so this is a non-silent region)
                    returnFeatures[1].push_back(feature);
                } else {
                    // silent regions feature
                    // (becoming non-silent, so this is a silent region)
                    returnFeatures[0].push_back(feature);
                }                    
            }
            m_lastChange = featureStamp;
        }

        m_prevSilent = silent;
        m_first = false;
    }

    // swap ibuf and pbuf data pointers, so that this block's data is
    // available in pbuf when processing the next block, without
    // having to allocate new storage for it
    smpl_t **tmpdata = m_ibuf->data;
    m_ibuf->data = m_pbuf->data;
    m_pbuf->data = tmpdata;

    m_lastTimestamp = timestamp;

    return returnFeatures;
}

Silence::FeatureSet
Silence::getRemainingFeatures()
{
    FeatureSet returnFeatures;
    
//    std::cerr << "Silence::getRemainingFeatures: m_lastTimestamp = " << m_lastTimestamp << ", m_lastChange = " << m_lastChange << ", m_apiVersion = " << m_apiVersion << ", m_prevSilent = " << m_prevSilent << std::endl;

    if (m_lastTimestamp > m_lastChange) {

        Feature feature;
        feature.hasTimestamp = true;

        if (m_apiVersion == 1) {
            if (m_prevSilent) {
                // silenceend feature
                feature.timestamp = m_lastTimestamp;
                returnFeatures[1].push_back(feature);
            }
        } else {

            feature.timestamp = m_lastChange;
            feature.hasDuration = true;
            feature.duration = m_lastTimestamp - m_lastChange;
            if (m_prevSilent) {
                // silent regions feature
                returnFeatures[0].push_back(feature);
            } else {
                // non-silent regions feature
                returnFeatures[1].push_back(feature);
            }                
        }

        if (!m_prevSilent) {
            Feature silenceTestFeature;
            silenceTestFeature.hasTimestamp = true;
            silenceTestFeature.timestamp = m_lastTimestamp;
            silenceTestFeature.values.push_back(0);
            returnFeatures[2].push_back(silenceTestFeature);
        }
    }

    return returnFeatures;
}