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 _SPARSE_ONE_DIMENSIONAL_MODEL_H_
Chris@147: #define _SPARSE_ONE_DIMENSIONAL_MODEL_H_
Chris@147: 
Chris@147: #include "SparseModel.h"
Chris@852: #include "NoteData.h"
Chris@150: #include "base/PlayParameterRepository.h"
Chris@147: #include "base/RealTime.h"
Chris@147: 
Chris@387: #include <QStringList>
Chris@387: 
Chris@147: struct OneDimensionalPoint
Chris@147: {
Chris@147: public:
Chris@147:     OneDimensionalPoint(long _frame) : frame(_frame) { }
Chris@147:     OneDimensionalPoint(long _frame, QString _label) : frame(_frame), label(_label) { }
Chris@147: 
Chris@147:     int getDimensions() const { return 1; }
Chris@147:     
Chris@147:     long frame;
Chris@147:     QString label;
Chris@338: 
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 << QString("%1<point frame=\"%2\" label=\"%3\" %4/>\n")
Chris@603: 	    .arg(indent).arg(frame).arg(XmlExportable::encodeEntities(label))
Chris@603:             .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@318:         if (label != "") list << label;
Chris@147:         return list.join(delimiter);
Chris@147:     }
Chris@147: 
Chris@147:     struct Comparator {
Chris@147: 	bool operator()(const OneDimensionalPoint &p1,
Chris@147: 			const OneDimensionalPoint &p2) const {
Chris@147: 	    if (p1.frame != p2.frame) return p1.frame < p2.frame;
Chris@147: 	    return p1.label < p2.label;
Chris@147: 	}
Chris@147:     };
Chris@147:     
Chris@147:     struct OrderComparator {
Chris@147: 	bool operator()(const OneDimensionalPoint &p1,
Chris@147: 			const OneDimensionalPoint &p2) const {
Chris@147: 	    return p1.frame < p2.frame;
Chris@147: 	}
Chris@147:     };
Chris@147: };
Chris@147: 
Chris@147: 
Chris@852: class SparseOneDimensionalModel : public SparseModel<OneDimensionalPoint>,
Chris@852:                                   public NoteExportable
Chris@147: {
Chris@423:     Q_OBJECT
Chris@423:     
Chris@147: public:
Chris@147:     SparseOneDimensionalModel(size_t sampleRate, size_t resolution,
Chris@147: 			      bool notifyOnAdd = true) :
Chris@147: 	SparseModel<OneDimensionalPoint>(sampleRate, resolution, notifyOnAdd)
Chris@147:     {
Chris@391: 	PlayParameterRepository::getInstance()->addPlayable(this);
Chris@391:     }
Chris@391: 
Chris@391:     virtual ~SparseOneDimensionalModel()
Chris@391:     {
Chris@391:         PlayParameterRepository::getInstance()->removePlayable(this);
Chris@391:     }
Chris@391: 
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=\"tap\"/>";
Chris@147:     }
Chris@147: 
Chris@420:     int getIndexOf(const Point &point)
Chris@420:     {
Chris@147: 	// slow
Chris@147: 	int i = 0;
Chris@147: 	Point::Comparator comparator;
Chris@147: 	for (PointList::const_iterator j = m_points.begin();
Chris@147: 	     j != m_points.end(); ++j, ++i) {
Chris@147: 	    if (!comparator(*j, point) && !comparator(point, *j)) return i;
Chris@147: 	}
Chris@147: 	return -1;
Chris@147:     }
Chris@345: 
Chris@345:     QString getTypeName() const { return tr("Sparse 1-D"); }
Chris@420: 
Chris@420:     /**
Chris@420:      * TabularModel methods.  
Chris@420:      */
Chris@420:     
Chris@420:     virtual int getColumnCount() const
Chris@420:     {
Chris@420:         return 3;
Chris@420:     }
Chris@420: 
Chris@420:     virtual QString getHeading(int column) const
Chris@420:     {
Chris@420:         switch (column) {
Chris@420:         case 0: return tr("Time");
Chris@420:         case 1: return tr("Frame");
Chris@420:         case 2: return tr("Label");
Chris@420:         default: return tr("Unknown");
Chris@420:         }
Chris@420:     }
Chris@420: 
Chris@420:     virtual QVariant getData(int row, int column, int role) const
Chris@420:     {
Chris@425:         if (column < 2) {
Chris@425:             return SparseModel<OneDimensionalPoint>::getData
Chris@425:                 (row, column, role);
Chris@425:         }
Chris@425: 
Chris@606:         PointListConstIterator i = getPointListIteratorForRow(row);
Chris@420:         if (i == m_points.end()) return QVariant();
Chris@420: 
Chris@420:         switch (column) {
Chris@422:         case 2: return i->label;
Chris@420:         default: return QVariant();
Chris@420:         }
Chris@420:     }
Chris@420: 
Chris@424:     virtual Command *getSetDataCommand(int row, int column, const QVariant &value, int role)
Chris@424:     {
Chris@425:         if (column < 2) {
Chris@425:             return SparseModel<OneDimensionalPoint>::getSetDataCommand
Chris@425:                 (row, column, value, role);
Chris@425:         }
Chris@425: 
Chris@740:         if (role != Qt::EditRole) return 0;
Chris@606:         PointListConstIterator i = getPointListIteratorForRow(row);
Chris@740:         if (i == m_points.end()) return 0;
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 2: point.label = value.toString(); break;
Chris@424:         }
Chris@424: 
Chris@424:         command->addPoint(point);
Chris@424:         return command->finish();
Chris@424:     }
Chris@424: 
Chris@427: 
Chris@420:     virtual bool isColumnTimeValue(int column) const
Chris@420:     {
Chris@420:         return (column < 2); 
Chris@420:     }
Chris@422: 
Chris@422:     virtual SortType getSortType(int column) const
Chris@422:     {
Chris@422:         if (column == 2) return SortAlphabetical;
Chris@422:         return SortNumeric;
Chris@422:     }
Chris@852: 
Chris@852:     /**
Chris@852:      * NoteExportable methods.
Chris@852:      */
Chris@852: 
Chris@852:     NoteList getNotes() const {
Chris@852:         return getNotes(getStartFrame(), getEndFrame());
Chris@852:     }
Chris@852: 
Chris@852:     NoteList getNotes(size_t startFrame, size_t endFrame) const {
Chris@852:         
Chris@852: 	PointList points = getPoints(startFrame, endFrame);
Chris@852:         NoteList notes;
Chris@852: 
Chris@852: 	for (PointList::iterator pli =
Chris@852: 		 points.begin(); pli != points.end(); ++pli) {
Chris@852: 
Chris@852:             notes.push_back
Chris@852:                 (NoteData(pli->frame,
Chris@852:                           getSampleRate() / 6, // arbitrary short duration
Chris@852:                           64,   // default pitch
Chris@852:                           100)); // default velocity
Chris@852:         }
Chris@852: 
Chris@852:         return notes;
Chris@852:     }
Chris@147: };
Chris@147: 
Chris@147: #endif
Chris@147: 
Chris@147: 
Chris@147: