Chris@147: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@147: 
Chris@147: /*
Chris@147:     Sonic Visualiser
Chris@147:     An audio file viewer and annotation editor.
Chris@147:     Centre for Digital Music, Queen Mary, University of London.
Chris@147:     This file copyright 2006 Chris Cannam.
Chris@147:     
Chris@147:     This program is free software; you can redistribute it and/or
Chris@147:     modify it under the terms of the GNU General Public License as
Chris@147:     published by the Free Software Foundation; either version 2 of the
Chris@147:     License, or (at your option) any later version.  See the file
Chris@147:     COPYING included with this distribution for more information.
Chris@147: */
Chris@147: 
Chris@147: #ifndef _NOTE_MODEL_H_
Chris@147: #define _NOTE_MODEL_H_
Chris@147: 
Chris@147: #include "SparseValueModel.h"
Chris@391: #include "base/RealTime.h"
Chris@150: #include "base/PlayParameterRepository.h"
Chris@147: 
Chris@147: /**
Chris@147:  * Note type for use in a SparseModel or SparseValueModel.  All we
Chris@147:  * mean by a "note" is something that has an onset time, a single
Chris@147:  * value, and a duration.  Like other points, it can also have a
Chris@147:  * label.  With this point type, the model can be thought of as
Chris@147:  * representing a simple MIDI-type piano roll, except that the y
Chris@147:  * coordinates (values) do not have to be discrete integers.
Chris@147:  */
Chris@147: 
Chris@147: struct Note
Chris@147: {
Chris@147: public:
Chris@340:     Note(long _frame) : frame(_frame), value(0.0f), duration(0), level(1.f) { }
Chris@340:     Note(long _frame, float _value, size_t _duration, float _level, QString _label) :
Chris@340: 	frame(_frame), value(_value), duration(_duration), level(_level), label(_label) { }
Chris@147: 
Chris@147:     int getDimensions() const { return 3; }
Chris@147: 
Chris@147:     long frame;
Chris@147:     float value;
Chris@147:     size_t duration;
Chris@340:     float level;
Chris@147:     QString label;
Chris@147: 
Chris@338:     QString getLabel() const { return label; }
Chris@338:     
Chris@314:     void toXml(QTextStream &stream,
Chris@314:                QString indent = "",
Chris@314:                QString extraAttributes = "") const
Chris@147:     {
Chris@314: 	stream <<
Chris@340:             QString("%1<point frame=\"%2\" value=\"%3\" duration=\"%4\" level=\"%5\" label=\"%6\" %7/>\n")
Chris@340: 	    .arg(indent).arg(frame).arg(value).arg(duration).arg(level).arg(label).arg(extraAttributes);
Chris@147:     }
Chris@147: 
Chris@147:     QString toDelimitedDataString(QString delimiter, size_t sampleRate) const
Chris@147:     {
Chris@147:         QStringList list;
Chris@147:         list << RealTime::frame2RealTime(frame, sampleRate).toString().c_str();
Chris@147:         list << QString("%1").arg(value);
Chris@340:         list << RealTime::frame2RealTime(duration, sampleRate).toString().c_str();
Chris@340:         list << QString("%1").arg(level);
Chris@318:         if (label != "") list << label;
Chris@147:         return list.join(delimiter);
Chris@147:     }
Chris@147: 
Chris@147:     struct Comparator {
Chris@147: 	bool operator()(const Note &p1,
Chris@147: 			const Note &p2) const {
Chris@147: 	    if (p1.frame != p2.frame) return p1.frame < p2.frame;
Chris@147: 	    if (p1.value != p2.value) return p1.value < p2.value;
Chris@147: 	    if (p1.duration != p2.duration) return p1.duration < p2.duration;
Chris@340:             if (p1.level != p2.level) return p1.level < p2.level;
Chris@147: 	    return p1.label < p2.label;
Chris@147: 	}
Chris@147:     };
Chris@147:     
Chris@147:     struct OrderComparator {
Chris@147: 	bool operator()(const Note &p1,
Chris@147: 			const Note &p2) const {
Chris@147: 	    return p1.frame < p2.frame;
Chris@147: 	}
Chris@147:     };
Chris@147: };
Chris@147: 
Chris@147: 
Chris@147: class NoteModel : public SparseValueModel<Note>
Chris@147: {
Chris@423:     Q_OBJECT
Chris@423:     
Chris@147: public:
Chris@147:     NoteModel(size_t sampleRate, size_t resolution,
Chris@256: 	      bool notifyOnAdd = true) :
Chris@256: 	SparseValueModel<Note>(sampleRate, resolution,
Chris@256: 			       notifyOnAdd),
Chris@256: 	m_valueQuantization(0)
Chris@256:     {
Chris@391: 	PlayParameterRepository::getInstance()->addPlayable(this);
Chris@256:     }
Chris@256: 
Chris@256:     NoteModel(size_t sampleRate, size_t resolution,
Chris@147: 	      float valueMinimum, float valueMaximum,
Chris@147: 	      bool notifyOnAdd = true) :
Chris@147: 	SparseValueModel<Note>(sampleRate, resolution,
Chris@147: 			       valueMinimum, valueMaximum,
Chris@147: 			       notifyOnAdd),
Chris@147: 	m_valueQuantization(0)
Chris@147:     {
Chris@391: 	PlayParameterRepository::getInstance()->addPlayable(this);
Chris@391:     }
Chris@391: 
Chris@391:     virtual ~NoteModel()
Chris@391:     {
Chris@391:         PlayParameterRepository::getInstance()->removePlayable(this);
Chris@147:     }
Chris@147: 
Chris@147:     float getValueQuantization() const { return m_valueQuantization; }
Chris@147:     void setValueQuantization(float q) { m_valueQuantization = q; }
Chris@147: 
Chris@147:     /**
Chris@147:      * Notes have a duration, so this returns all points that span any
Chris@147:      * of the given range (as well as the usual additional few before
Chris@147:      * and after).  Consequently this can be very slow (optimised data
Chris@147:      * structures still to be done!).
Chris@147:      */
Chris@147:     virtual PointList getPoints(long start, long end) const;
Chris@147: 
Chris@147:     /**
Chris@147:      * Notes have a duration, so this returns all points that span the
Chris@147:      * given frame.  Consequently this can be very slow (optimised
Chris@147:      * data structures still to be done!).
Chris@147:      */
Chris@147:     virtual PointList getPoints(long frame) const;
Chris@147: 
Chris@345:     QString getTypeName() const { return tr("Note"); }
Chris@345: 
Chris@391:     virtual bool canPlay() const { return true; }
Chris@391: 
Chris@391:     virtual QString getDefaultPlayPluginId() const
Chris@391:     {
Chris@391:         return "dssi:_builtin:sample_player";
Chris@391:     }
Chris@391: 
Chris@391:     virtual QString getDefaultPlayPluginConfiguration() const
Chris@391:     {
Chris@391:         return "<plugin program=\"piano\"/>";
Chris@391:     }
Chris@391: 
Chris@288:     virtual void toXml(QTextStream &out,
Chris@288:                        QString indent = "",
Chris@288:                        QString extraAttributes = "") const
Chris@147:     {
Chris@318:         std::cerr << "NoteModel::toXml: extraAttributes = \"" 
Chris@318:                   << extraAttributes.toStdString() << std::endl;
Chris@318: 
Chris@314:         SparseValueModel<Note>::toXml
Chris@288: 	    (out,
Chris@288:              indent,
Chris@147: 	     QString("%1 valueQuantization=\"%2\"")
Chris@147: 	     .arg(extraAttributes).arg(m_valueQuantization));
Chris@147:     }
Chris@147: 
Chris@424:     /**
Chris@424:      * TabularModel methods.  
Chris@424:      */
Chris@424:     
Chris@424:     virtual int getColumnCount() const
Chris@424:     {
Chris@424:         return 6;
Chris@424:     }
Chris@424: 
Chris@424:     virtual QString getHeading(int column) const
Chris@424:     {
Chris@424:         switch (column) {
Chris@424:         case 0: return tr("Time");
Chris@424:         case 1: return tr("Frame");
Chris@424:         case 2: return tr("Pitch");
Chris@424:         case 3: return tr("Duration");
Chris@424:         case 4: return tr("Level");
Chris@424:         case 5: return tr("Label");
Chris@424:         default: return tr("Unknown");
Chris@424:         }
Chris@424:     }
Chris@424: 
Chris@424:     virtual QVariant getData(int row, int column, int role) const
Chris@424:     {
Chris@425:         if (column < 2) {
Chris@425:             return SparseValueModel<Note>::getData
Chris@425:                 (row, column, role);
Chris@425:         }
Chris@425: 
Chris@424:         PointListIterator i = getPointListIteratorForRow(row);
Chris@424:         if (i == m_points.end()) return QVariant();
Chris@424: 
Chris@424:         switch (column) {
Chris@424:         case 2:
Chris@424:             if (role == Qt::EditRole || role == SortRole) return i->value;
Chris@424:             else return QString("%1 %2").arg(i->value).arg(getScaleUnits());
Chris@424:         case 3: return int(i->duration);
Chris@424:         case 4: return i->level;
Chris@424:         case 5: return i->label;
Chris@424:         default: return QVariant();
Chris@424:         }
Chris@424:     }
Chris@424: 
Chris@424:     virtual Command *getSetDataCommand(int row, int column, const QVariant &value, int role)
Chris@424:     {
Chris@425:         if (column < 2) {
Chris@425:             return SparseValueModel<Note>::getSetDataCommand
Chris@425:                 (row, column, value, role);
Chris@425:         }
Chris@425: 
Chris@424:         if (role != Qt::EditRole) return false;
Chris@424:         PointListIterator i = getPointListIteratorForRow(row);
Chris@424:         if (i == m_points.end()) return false;
Chris@424:         EditCommand *command = new EditCommand(this, tr("Edit Data"));
Chris@424: 
Chris@424:         Point point(*i);
Chris@424:         command->deletePoint(point);
Chris@424: 
Chris@424:         switch (column) {
Chris@424:         case 0: case 1: point.frame = value.toInt(); break; 
Chris@424:         case 2: point.value = value.toDouble(); break;
Chris@424:         case 3: point.duration = value.toInt(); break;
Chris@424:         case 4: point.level = value.toDouble(); break;
Chris@424:         case 5: point.label = value.toString(); break;
Chris@424:         }
Chris@424: 
Chris@424:         command->addPoint(point);
Chris@424:         return command->finish();
Chris@424:     }
Chris@424: 
Chris@424:     virtual bool isColumnTimeValue(int column) const
Chris@424:     {
Chris@424:         return (column < 2); 
Chris@424:     }
Chris@424: 
Chris@424:     virtual SortType getSortType(int column) const
Chris@424:     {
Chris@424:         if (column == 5) return SortAlphabetical;
Chris@424:         return SortNumeric;
Chris@424:     }
Chris@424: 
Chris@147: protected:
Chris@147:     float m_valueQuantization;
Chris@147: };
Chris@147: 
Chris@147: #endif