comparison data/model/NoteModel.h @ 147:3a13b0d4934e

* Reorganising code base.  This revision will not compile.

+/* -*- 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 _NOTE_MODEL_H_
+#define _NOTE_MODEL_H_
+
+#include "SparseValueModel.h"
+#include "PlayParameterRepository.h"
+#include "base/RealTime.h"
+
+/**
+ * Note type for use in a SparseModel or SparseValueModel.  All we
+ * mean by a "note" is something that has an onset time, a single
+ * value, and a duration.  Like other points, it can also have a
+ * label.  With this point type, the model can be thought of as
+ * representing a simple MIDI-type piano roll, except that the y
+ * coordinates (values) do not have to be discrete integers.
+ */
+
+struct Note
+{
+public:
+    Note(long _frame) : frame(_frame), value(0.0f), duration(0) { }
+    Note(long _frame, float _value, size_t _duration, QString _label) :
+	frame(_frame), value(_value), duration(_duration), label(_label) { }
+
+    int getDimensions() const { return 3; }
+
+    long frame;
+    float value;
+    size_t duration;
+    QString label;
+
+    QString toXmlString(QString indent = "",
+			QString extraAttributes = "") const
+    {
+	return QString("%1<point frame=\"%2\" value=\"%3\" duration=\"%4\" label=\"%5\" %6/>\n")
+	    .arg(indent).arg(frame).arg(value).arg(duration).arg(label).arg(extraAttributes);
+    }
+
+    QString toDelimitedDataString(QString delimiter, size_t sampleRate) const
+    {
+        QStringList list;
+        list << RealTime::frame2RealTime(frame, sampleRate).toString().c_str();
+        list << QString("%1").arg(value);
+        list << QString("%1").arg(duration);
+        list << label;
+        return list.join(delimiter);
+    }
+
+    struct Comparator {
+	bool operator()(const Note &p1,
+			const Note &p2) const {
+	    if (p1.frame != p2.frame) return p1.frame < p2.frame;
+	    if (p1.value != p2.value) return p1.value < p2.value;
+	    if (p1.duration != p2.duration) return p1.duration < p2.duration;
+	    return p1.label < p2.label;
+	}
+    };
+    
+    struct OrderComparator {
+	bool operator()(const Note &p1,
+			const Note &p2) const {
+	    return p1.frame < p2.frame;
+	}
+    };
+};
+
+
+class NoteModel : public SparseValueModel<Note>
+{
+public:
+    NoteModel(size_t sampleRate, size_t resolution,
+	      float valueMinimum, float valueMaximum,
+	      bool notifyOnAdd = true) :
+	SparseValueModel<Note>(sampleRate, resolution,
+			       valueMinimum, valueMaximum,
+			       notifyOnAdd),
+	m_valueQuantization(0)
+    {
+	PlayParameterRepository::getInstance()->addModel(this);
+    }
+
+    float getValueQuantization() const { return m_valueQuantization; }
+    void setValueQuantization(float q) { m_valueQuantization = q; }
+
+    /**
+     * Notes have a duration, so this returns all points that span any
+     * of the given range (as well as the usual additional few before
+     * and after).  Consequently this can be very slow (optimised data
+     * structures still to be done!).
+     */
+    virtual PointList getPoints(long start, long end) const;
+
+    /**
+     * Notes have a duration, so this returns all points that span the
+     * given frame.  Consequently this can be very slow (optimised
+     * data structures still to be done!).
+     */
+    virtual PointList getPoints(long frame) const;
+
+    virtual QString toXmlString(QString indent = "",
+				QString extraAttributes = "") const
+    {
+	return SparseValueModel<Note>::toXmlString
+	    (indent,
+	     QString("%1 valueQuantization=\"%2\"")
+	     .arg(extraAttributes).arg(m_valueQuantization));
+    }
+
+protected:
+    float m_valueQuantization;
+};
+
+#endif