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_TIME_VALUE_MODEL_H_
Chris@147: #define _SPARSE_TIME_VALUE_MODEL_H_
Chris@147: 
Chris@147: #include "SparseValueModel.h"
Chris@150: #include "base/PlayParameterRepository.h"
Chris@147: #include "base/RealTime.h"
Chris@147: 
Chris@147: /**
Chris@147:  * Time/value point type for use in a SparseModel or SparseValueModel.
Chris@147:  * With this point type, the model basically represents a wiggly-line
Chris@147:  * plot with points at arbitrary intervals of the model resolution.
Chris@147:  */
Chris@147: 
Chris@147: struct TimeValuePoint
Chris@147: {
Chris@147: public:
Chris@1110:     TimeValuePoint(sv_frame_t _frame) : frame(_frame), value(0.0f) { }
Chris@1110:     TimeValuePoint(sv_frame_t _frame, float _value, QString _label) : 
Chris@1429:         frame(_frame), value(_value), label(_label) { }
Chris@147: 
Chris@147:     int getDimensions() const { return 2; }
Chris@147:     
Chris@1110:     sv_frame_t frame;
Chris@147:     float value;
Chris@147:     QString label;
Chris@338: 
Chris@338:     QString getLabel() const { return label; }
Chris@147:     
Chris@314:     void toXml(QTextStream &stream, QString indent = "",
Chris@314:                QString extraAttributes = "") const
Chris@147:     {
Chris@314:         stream << QString("%1<point frame=\"%2\" value=\"%3\" label=\"%4\" %5/>\n")
Chris@1429:             .arg(indent).arg(frame).arg(value).arg(XmlExportable::encodeEntities(label))
Chris@603:             .arg(extraAttributes);
Chris@147:     }
Chris@147: 
Chris@1060:     QString toDelimitedDataString(QString delimiter, DataExportOptions, sv_samplerate_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@318:         if (label != "") list << label;
Chris@147:         return list.join(delimiter);
Chris@147:     }
Chris@147: 
Chris@147:     struct Comparator {
Chris@1429:         bool operator()(const TimeValuePoint &p1,
Chris@1429:                         const TimeValuePoint &p2) const {
Chris@1429:             if (p1.frame != p2.frame) return p1.frame < p2.frame;
Chris@1429:             if (p1.value != p2.value) return p1.value < p2.value;
Chris@1429:             return p1.label < p2.label;
Chris@1429:         }
Chris@147:     };
Chris@147:     
Chris@147:     struct OrderComparator {
Chris@1429:         bool operator()(const TimeValuePoint &p1,
Chris@1429:                         const TimeValuePoint &p2) const {
Chris@1429:             return p1.frame < p2.frame;
Chris@1429:         }
Chris@147:     };
Chris@147: };
Chris@147: 
Chris@147: 
Chris@147: class SparseTimeValueModel : public SparseValueModel<TimeValuePoint>
Chris@147: {
Chris@423:     Q_OBJECT
Chris@423:     
Chris@147: public:
Chris@1040:     SparseTimeValueModel(sv_samplerate_t sampleRate, int resolution,
Chris@1429:                          bool notifyOnAdd = true) :
Chris@1429:         SparseValueModel<TimeValuePoint>(sampleRate, resolution,
Chris@1429:                                          notifyOnAdd)
Chris@256:     {
Chris@868:         // Model is playable, but may not sound (if units not Hz or
Chris@868:         // range unsuitable)
Chris@1429:         PlayParameterRepository::getInstance()->addPlayable(this);
Chris@256:     }
Chris@256: 
Chris@1040:     SparseTimeValueModel(sv_samplerate_t sampleRate, int resolution,
Chris@1429:                          float valueMinimum, float valueMaximum,
Chris@1429:                          bool notifyOnAdd = true) :
Chris@1429:         SparseValueModel<TimeValuePoint>(sampleRate, resolution,
Chris@1429:                                          valueMinimum, valueMaximum,
Chris@1429:                                          notifyOnAdd)
Chris@147:     {
Chris@868:         // Model is playable, but may not sound (if units not Hz or
Chris@868:         // range unsuitable)
Chris@1429:         PlayParameterRepository::getInstance()->addPlayable(this);
Chris@868:     }
Chris@868: 
Chris@868:     virtual ~SparseTimeValueModel()
Chris@868:     {
Chris@1429:         PlayParameterRepository::getInstance()->removePlayable(this);
Chris@147:     }
Chris@345: 
Chris@345:     QString getTypeName() const { return tr("Sparse Time-Value"); }
Chris@420: 
Chris@868:     virtual bool canPlay() const { return true; }
Chris@952:     virtual bool getDefaultPlayAudible() const { return false; } // user must unmute
Chris@868: 
Chris@420:     /**
Chris@420:      * TabularModel methods.  
Chris@420:      */
Chris@420:     
Chris@420:     virtual int getColumnCount() const
Chris@420:     {
Chris@420:         return 4;
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("Value");
Chris@420:         case 3: 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 SparseValueModel<TimeValuePoint>::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@420:         case 2:
Chris@422:             if (role == Qt::EditRole || role == SortRole) return i->value;
Chris@420:             else return QString("%1 %2").arg(i->value).arg(getScaleUnits());
Chris@420:         case 3: 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@420:     {
Chris@425:         if (column < 2) {
Chris@425:             return SparseValueModel<TimeValuePoint>::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@420:         EditCommand *command = new EditCommand(this, tr("Edit Data"));
Chris@420: 
Chris@420:         Point point(*i);
Chris@420:         command->deletePoint(point);
Chris@420: 
Chris@420:         switch (column) {
Chris@1038:         case 2: point.value = float(value.toDouble()); break;
Chris@420:         case 3: point.label = value.toString(); break;
Chris@420:         }
Chris@420: 
Chris@420:         command->addPoint(point);
Chris@420:         return command->finish();
Chris@420:     }
Chris@420: 
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 == 3) return SortAlphabetical;
Chris@422:         return SortNumeric;
Chris@422:     }
Chris@147: };
Chris@147: 
Chris@147: 
Chris@147: #endif
Chris@147: 
Chris@147: 
Chris@147: