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 _MODEL_H_
#define _MODEL_H_

#include <vector>
#include <QObject>

#include "base/XmlExportable.h"
#include "base/Playable.h"

typedef std::vector<float> SampleBlock;

class ZoomConstraint;
class AlignmentModel;

class Model : public QObject,
              public XmlExportable,
              public Playable
{
    Q_OBJECT

public:
    virtual ~Model();

    virtual bool isOK() const = 0;

    virtual int getStartFrame() const = 0;

    virtual int getEndFrame() const = 0;

    virtual int getSampleRate() const = 0;

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

    virtual QString getTitle() const;

    virtual QString getMaker() const;

    virtual QString getLocation() const;

    virtual QString getTypeName() const = 0;

    virtual Model *clone() const = 0;

    virtual void abandon() {
        m_abandoning = true;
    }

    virtual bool isAbandoning() const { 
        return m_abandoning;
    }

    virtual bool isReady(int *completion = 0) const {
        bool ok = isOK();
        if (completion) *completion = (ok ? 100 : 0);
        return ok;
    }
    static const int COMPLETION_UNKNOWN;

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

    virtual Model *getSourceModel() const {
        return m_sourceModel;
    }

    virtual void setSourceModel(Model *model);

    virtual void setAlignment(AlignmentModel *alignment);

    virtual const AlignmentModel *getAlignment() const;

    virtual const Model *getAlignmentReference() const;

    virtual int alignToReference(int frame) const;

    virtual int alignFromReference(int referenceFrame) const;

    virtual int getAlignmentCompletion() const;

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

    QString getRDFTypeURI() const { return m_typeUri; }

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

    virtual QString toDelimitedDataString(QString delimiter) const {
        return toDelimitedDataStringSubset(delimiter, getStartFrame(), getEndFrame());
    }
    virtual QString toDelimitedDataStringSubset(QString, int /* f0 */, int /* f1 */) const {
        return "";
    }

public slots:
    void aboutToDelete();
    void sourceModelAboutToBeDeleted();

signals:
    void modelChanged();

    void modelChangedWithin(int startFrame, int endFrame);

    void completionChanged();

    void ready();

    void alignmentCompletionChanged();

    void aboutToBeDeleted();

protected:
    Model() : 
        m_sourceModel(0), 
        m_alignment(0), 
        m_abandoning(false), 
        m_aboutToDelete(false) { }

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

    Model *m_sourceModel;
    AlignmentModel *m_alignment;
    QString m_typeUri;
    bool m_abandoning;
    bool m_aboutToDelete;
};

#endif