Model.h

Go to the documentation of this file.

/* -*- 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.
*/

#ifndef SV_MODEL_H
#define SV_MODEL_H

#include <vector>
#include <atomic>

#include <QObject>
#include <QMutex>

#include "base/ById.h"
#include "base/XmlExportable.h"
#include "base/Playable.h"
#include "base/BaseTypes.h"
#include "base/DataExportOptions.h"

class ZoomConstraint;
class AlignmentModel;

class Model : public QObject,
              public WithTypedId<Model>,
              public XmlExportable,
              public Playable
{
    Q_OBJECT

public:
    typedef Id ModelId;
    
    virtual ~Model();

    virtual bool isOK() const = 0;

    virtual sv_frame_t getStartFrame() const = 0;

    sv_frame_t getEndFrame() const {
        sv_frame_t trueEnd = getTrueEndFrame();
        if (m_extendTo > trueEnd) {
            return m_extendTo;
        } else {
            return trueEnd;
        }
    }

    virtual sv_frame_t getTrueEndFrame() const = 0;

    void extendEndFrame(sv_frame_t to) {
        m_extendTo = to;
    }

    virtual sv_samplerate_t getSampleRate() const = 0;

    virtual sv_samplerate_t getNativeRate() const { return getSampleRate(); }

    virtual QString getTitle() const;

    virtual QString getMaker() const;

    virtual QString getLocation() const;

    virtual QString getTypeName() const = 0;

    virtual bool isSparse() const { return false; }

    virtual bool isReady(int *cp = nullptr) const {
        int c = getCompletion();
        if (cp) *cp = c;
        if (!isOK()) return false;
        else return (c == 100);
    }
    
    virtual int getCompletion() const = 0;

    virtual const ZoomConstraint *getZoomConstraint() const {
        return 0;
    }

    virtual ModelId getSourceModel() const {
        return m_sourceModel;
    }

    virtual void setSourceModel(ModelId model);

    virtual void setAlignment(ModelId alignmentModel);

    virtual const ModelId getAlignment() const;

    virtual const ModelId getAlignmentReference() const;

    virtual sv_frame_t alignToReference(sv_frame_t frame) const;

    virtual sv_frame_t alignFromReference(sv_frame_t referenceFrame) const;

    virtual int getAlignmentCompletion() const;

    void setRDFTypeURI(QString uri) { m_typeUri = uri; }

    QString getRDFTypeURI() const { return m_typeUri; }

    void toXml(QTextStream &stream,
               QString indent = "",
               QString extraAttributes = "") const override;

    virtual QVector<QString>
    getStringExportHeaders(DataExportOptions options) const = 0;
    
    virtual QVector<QVector<QString>>
    toStringExportRows(DataExportOptions options,
                       sv_frame_t startFrame,
                       sv_frame_t duration) const = 0;

signals:
    void modelChanged(ModelId myId);

    void modelChangedWithin(ModelId myId, sv_frame_t startFrame, sv_frame_t endFrame);

    void completionChanged(ModelId myId);

    void ready(ModelId myId);

    void alignmentCompletionChanged(ModelId myId);

private slots:
    void alignmentModelCompletionChanged(ModelId);
    
protected:
    Model() : m_extendTo(0) { }

    // Not provided.
    Model(const Model &) =delete;
    Model &operator=(const Model &) =delete;

    mutable QMutex m_mutex;
    ModelId m_sourceModel;
    ModelId m_alignmentModel;
    QString m_typeUri;
    std::atomic<sv_frame_t> m_extendTo;
};

typedef Model::Id ModelId;
typedef TypedById<Model, Model::Id> ModelById;

#endif