view data/model/Dense3DModelPeakCache.cpp @ 1881:b504df98c3be

Ensure completion on output model is started at zero, so if it's checked before the input model has become ready and the transform has begun, it is not accidentally reported as complete (affected re-aligning models in Sonic Lineup when replacing the session)

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

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2009 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 "Dense3DModelPeakCache.h"

#include "base/Profiler.h"

#include "base/HitCount.h"

Dense3DModelPeakCache::Dense3DModelPeakCache(ModelId sourceId,
                                             int columnsPerPeak) :
    m_source(sourceId),
    m_columnsPerPeak(columnsPerPeak),
    m_finalColumnIncomplete(false)
{
    auto source = ModelById::getAs<DenseThreeDimensionalModel>(m_source);
    if (!source) {
        SVCERR << "WARNING: Dense3DModelPeakCache constructed for unknown or wrong-type source model id " << m_source << endl;
        m_source = {};
        return;
    }

    connect(source.get(), SIGNAL(modelChanged(ModelId)),
            this, SLOT(sourceModelChanged(ModelId)));
}

Dense3DModelPeakCache::~Dense3DModelPeakCache()
{
}

Dense3DModelPeakCache::Column
Dense3DModelPeakCache::getColumn(int column) const
{
    if (!haveColumn(column)) fillColumn(column);
    return m_cache.at(column);
}

float
Dense3DModelPeakCache::getValueAt(int column, int n) const
{
    if (!haveColumn(column)) fillColumn(column);
    return m_cache.at(column).at(n);
}

void
Dense3DModelPeakCache::sourceModelChanged(ModelId)
{
    if (m_finalColumnIncomplete && m_coverage.size() > 0) {
        // The last peak came from an incomplete read, which may since
        // have been filled, so reset it
        m_coverage[m_coverage.size()-1] = false;
        m_finalColumnIncomplete = false;
    }
}

bool
Dense3DModelPeakCache::haveColumn(int column) const
{
    static HitCount count("Dense3DModelPeakCache");
    if (in_range_for(m_coverage, column) && m_coverage[column]) {
        count.hit();
        return true;
    } else {
        count.miss();
        return false;
    }
}

void
Dense3DModelPeakCache::fillColumn(int column) const
{
    Profiler profiler("Dense3DModelPeakCache::fillColumn");

    if (!in_range_for(m_coverage, column)) {
        if (m_finalColumnIncomplete && m_coverage.size() > 0) {
            // The last peak may have come from an incomplete read, which
            // may since have been filled, so reset it
            m_coverage[m_coverage.size()-1] = false;
            m_finalColumnIncomplete = false;
        }
        m_coverage.resize(column + 1, false);
        m_cache.resize(column + 1, {});
    }
    
    auto source = ModelById::getAs<DenseThreeDimensionalModel>(m_source);
    if (!source) {
        return;
    }
    
    int sourceWidth = source->getWidth();
    int sourceColumn = column * m_columnsPerPeak;
    if (sourceColumn >= sourceWidth) {
        return;
    }

    Column peak = source->getColumn(sourceColumn);
    int n = int(peak.size());
    
    for (int i = 1; i < m_columnsPerPeak; ++i) {

        ++sourceColumn;
        if (sourceColumn >= sourceWidth) {
            m_finalColumnIncomplete = true;
            break;
        }
        
        Column here = source->getColumn(sourceColumn);
        int m = std::min(n, int(here.size()));
        for (int j = 0; j < m; ++j) {
            peak[j] = std::max(here[j], peak[j]);
        }
    }

    m_cache[column] = peak;
    m_coverage[column] = true;
}