lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _NOTE_MODEL_H_
lbajardsilogic@0: #define _NOTE_MODEL_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include "SparseValueModel.h"
lbajardsilogic@0: #include "base/PlayParameterRepository.h"
lbajardsilogic@0: #include "base/RealTime.h"
lbajardsilogic@0: 
lbajardsilogic@0: /**
lbajardsilogic@0:  * Note type for use in a SparseModel or SparseValueModel.  All we
lbajardsilogic@0:  * mean by a "note" is something that has an onset time, a single
lbajardsilogic@0:  * value, and a duration.  Like other points, it can also have a
lbajardsilogic@0:  * label.  With this point type, the model can be thought of as
lbajardsilogic@0:  * representing a simple MIDI-type piano roll, except that the y
lbajardsilogic@0:  * coordinates (values) do not have to be discrete integers.
lbajardsilogic@0:  */
lbajardsilogic@0: 
lbajardsilogic@0: struct Note
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     Note(long _frame) : frame(_frame), value(0.0f), duration(0) { }
lbajardsilogic@0:     Note(long _frame, float _value, size_t _duration, QString _label) :
lbajardsilogic@0: 	frame(_frame), value(_value), duration(_duration), label(_label) { }
lbajardsilogic@0: 
lbajardsilogic@0:     int getDimensions() const { return 3; }
lbajardsilogic@0: 
lbajardsilogic@0:     long frame;
lbajardsilogic@0:     float value;
lbajardsilogic@0:     size_t duration;
lbajardsilogic@0:     QString label;
lbajardsilogic@0: 
lbajardsilogic@0:     QString toXmlString(QString indent = "",
lbajardsilogic@0: 			QString extraAttributes = "") const
lbajardsilogic@0:     {
lbajardsilogic@0: 	return QString("%1<point frame=\"%2\" value=\"%3\" duration=\"%4\" label=\"%5\" %6/>\n")
lbajardsilogic@0: 	    .arg(indent).arg(frame).arg(value).arg(duration).arg(label).arg(extraAttributes);
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     QString toDelimitedDataString(QString delimiter, size_t sampleRate) const
lbajardsilogic@0:     {
lbajardsilogic@0:         QStringList list;
lbajardsilogic@0:         list << RealTime::frame2RealTime(frame, sampleRate).toString().c_str();
lbajardsilogic@0:         list << QString("%1").arg(value);
lbajardsilogic@0:         list << QString("%1").arg(duration);
lbajardsilogic@0:         list << label;
lbajardsilogic@0:         return list.join(delimiter);
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     struct Comparator {
lbajardsilogic@0: 	bool operator()(const Note &p1,
lbajardsilogic@0: 			const Note &p2) const {
lbajardsilogic@0: 	    if (p1.frame != p2.frame) return p1.frame < p2.frame;
lbajardsilogic@0: 	    if (p1.value != p2.value) return p1.value < p2.value;
lbajardsilogic@0: 	    if (p1.duration != p2.duration) return p1.duration < p2.duration;
lbajardsilogic@0: 	    return p1.label < p2.label;
lbajardsilogic@0: 	}
lbajardsilogic@0:     };
lbajardsilogic@0:     
lbajardsilogic@0:     struct OrderComparator {
lbajardsilogic@0: 	bool operator()(const Note &p1,
lbajardsilogic@0: 			const Note &p2) const {
lbajardsilogic@0: 	    return p1.frame < p2.frame;
lbajardsilogic@0: 	}
lbajardsilogic@0:     };
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: 
lbajardsilogic@0: class NoteModel : public SparseValueModel<Note>
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     NoteModel(size_t sampleRate, size_t resolution,
lbajardsilogic@0: 	      bool notifyOnAdd = true) :
lbajardsilogic@0: 	SparseValueModel<Note>(sampleRate, resolution,
lbajardsilogic@0: 			       notifyOnAdd),
lbajardsilogic@0: 	m_valueQuantization(0)
lbajardsilogic@0:     {
lbajardsilogic@0: 	PlayParameterRepository::getInstance()->addModel(this);
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     NoteModel(size_t sampleRate, size_t resolution,
lbajardsilogic@0: 	      float valueMinimum, float valueMaximum,
lbajardsilogic@0: 	      bool notifyOnAdd = true) :
lbajardsilogic@0: 	SparseValueModel<Note>(sampleRate, resolution,
lbajardsilogic@0: 			       valueMinimum, valueMaximum,
lbajardsilogic@0: 			       notifyOnAdd),
lbajardsilogic@0: 	m_valueQuantization(0)
lbajardsilogic@0:     {
lbajardsilogic@0: 	PlayParameterRepository::getInstance()->addModel(this);
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     float getValueQuantization() const { return m_valueQuantization; }
lbajardsilogic@0:     void setValueQuantization(float q) { m_valueQuantization = q; }
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Notes have a duration, so this returns all points that span any
lbajardsilogic@0:      * of the given range (as well as the usual additional few before
lbajardsilogic@0:      * and after).  Consequently this can be very slow (optimised data
lbajardsilogic@0:      * structures still to be done!).
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual PointList getPoints(long start, long end) const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Notes have a duration, so this returns all points that span the
lbajardsilogic@0:      * given frame.  Consequently this can be very slow (optimised
lbajardsilogic@0:      * data structures still to be done!).
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual PointList getPoints(long frame) const;
lbajardsilogic@0: 
lbajardsilogic@0:     virtual QString toXmlString(QString indent = "",
lbajardsilogic@0: 				QString extraAttributes = "") const
lbajardsilogic@0:     {
lbajardsilogic@0: 	return SparseValueModel<Note>::toXmlString
lbajardsilogic@0: 	    (indent,
lbajardsilogic@0: 	     QString("%1 valueQuantization=\"%2\"")
lbajardsilogic@0: 	     .arg(extraAttributes).arg(m_valueQuantization));
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     float m_valueQuantization;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif