annotate data/model/Model.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 2006 Chris Cannam.
    
    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 "Model.h"
#include "AlignmentModel.h"

#include <QTextStream>

#include <iostream>

//#define DEBUG_COMPLETION 1

Model::~Model()
{
    SVDEBUG << "Model::~Model: " << this << " with id " << getId() << endl;
}

void
Model::setSourceModel(ModelId modelId)
{
    QMutexLocker locker(&m_mutex);
    
    m_sourceModel = modelId;

    auto model = ModelById::get(m_sourceModel);
    if (model) {
        connect(model.get(), SIGNAL(alignmentCompletionChanged(ModelId)),
                this, SIGNAL(alignmentCompletionChanged(ModelId)));
    }
}

void
Model::setAlignment(ModelId alignmentModel)
{
    QMutexLocker locker(&m_mutex);

    SVDEBUG << "Model(" << this << "): accepting alignment model "
            << alignmentModel << endl;

    if (auto model = ModelById::get(m_alignmentModel)) {
        disconnect(model.get(), SIGNAL(completionChanged(ModelId)),
                   this, SLOT(alignmentModelCompletionChanged(ModelId)));
    }
    
    m_alignmentModel = alignmentModel;

    if (auto model = ModelById::get(m_alignmentModel)) {
        connect(model.get(), SIGNAL(completionChanged(ModelId)),
                this, SLOT(alignmentModelCompletionChanged(ModelId)));
    }
}

void
Model::alignmentModelCompletionChanged(ModelId)
{
    emit alignmentCompletionChanged(getId());
}

const ModelId
Model::getAlignment() const
{
    QMutexLocker locker(&m_mutex);
    return m_alignmentModel;
}

const ModelId
Model::getAlignmentReference() const
{
    QMutexLocker locker(&m_mutex);
    auto model = ModelById::getAs<AlignmentModel>(m_alignmentModel);
    if (model) return model->getReferenceModel();
    else return {};
}

sv_frame_t
Model::alignToReference(sv_frame_t frame) const
{
    ModelId alignmentModelId, sourceModelId;
    {
        QMutexLocker locker(&m_mutex);
        alignmentModelId = m_alignmentModel;
        sourceModelId = m_sourceModel;
    }
    
    auto alignmentModel = ModelById::getAs<AlignmentModel>(alignmentModelId);
    
    if (!alignmentModel) {
        auto sourceModel = ModelById::get(sourceModelId);
        if (sourceModel) {
            return sourceModel->alignToReference(frame);
        }
        return frame;
    }
    
    sv_frame_t refFrame = alignmentModel->toReference(frame);
    auto refModel = ModelById::get(alignmentModel->getReferenceModel());
    if (refModel && refFrame > refModel->getEndFrame()) {
        refFrame = refModel->getEndFrame();
    }
    return refFrame;
}

sv_frame_t
Model::alignFromReference(sv_frame_t refFrame) const
{
    ModelId alignmentModelId, sourceModelId;
    {
        QMutexLocker locker(&m_mutex);
        alignmentModelId = m_alignmentModel;
        sourceModelId = m_sourceModel;
    }

    auto alignmentModel = ModelById::getAs<AlignmentModel>(alignmentModelId);
   
    if (!alignmentModel) {
        auto sourceModel = ModelById::get(sourceModelId);
        if (sourceModel) {
            return sourceModel->alignFromReference(refFrame);
        }
        return refFrame;
    }
    
    sv_frame_t frame = alignmentModel->fromReference(refFrame);
    if (frame > getEndFrame()) frame = getEndFrame();
    return frame;
}

int
Model::getAlignmentCompletion() const
{
    ModelId alignmentModelId, sourceModelId;
    {
        QMutexLocker locker(&m_mutex);
        alignmentModelId = m_alignmentModel;
        sourceModelId = m_sourceModel;
    }

#ifdef DEBUG_COMPLETION
    SVCERR << "Model(" << this
           << ")::getAlignmentCompletion: m_alignmentModel = "
           << m_alignmentModel << endl;
#endif

    auto alignmentModel = ModelById::getAs<AlignmentModel>(alignmentModelId);
    
    if (!alignmentModel) {
        auto sourceModel = ModelById::get(sourceModelId);
        if (sourceModel) {
            return sourceModel->getAlignmentCompletion();
        }
        return 100;
    }
    
    int completion = 0;
    (void)alignmentModel->isReady(&completion);
#ifdef DEBUG_COMPLETION
    SVCERR << "Model(" << this
           << ")::getAlignmentCompletion: completion = " << completion
           << endl;
#endif
    return completion;
}

QString
Model::getTitle() const
{
    QMutexLocker locker(&m_mutex);
    auto source = ModelById::get(m_sourceModel);
    if (source) return source->getTitle();
    else return "";
}

QString
Model::getMaker() const
{
    QMutexLocker locker(&m_mutex);
    auto source = ModelById::get(m_sourceModel);
    if (source) return source->getMaker();
    else return "";
}

QString
Model::getLocation() const
{
    QMutexLocker locker(&m_mutex);
    auto source = ModelById::get(m_sourceModel);
    if (source) return source->getLocation();
    else return "";
}

void
Model::toXml(QTextStream &stream, QString indent,
             QString extraAttributes) const
{
    stream << indent;
    stream << QString("<model id=\"%1\" name=\"%2\" sampleRate=\"%3\" start=\"%4\" end=\"%5\" %6/>\n")
        .arg(getExportId())
        .arg(encodeEntities(objectName()))
        .arg(getSampleRate())
        .arg(getStartFrame())
        .arg(getEndFrame())
        .arg(extraAttributes);
}