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 _TEXT_MODEL_H_
Chris@147: #define _TEXT_MODEL_H_
Chris@147: 
Chris@147: #include "SparseModel.h"
Chris@302: #include "base/XmlExportable.h"
Chris@147: #include "base/RealTime.h"
Chris@147: 
Chris@423: #include <QStringList>
Chris@423: 
Chris@147: /**
Chris@147:  * Text point type for use in a SparseModel.  This represents a piece
Chris@147:  * of text at a given time and y-value in the [0,1) range (indicative
Chris@147:  * of height on the window).  Intended for casual textual annotations.
Chris@147:  */
Chris@147: 
Chris@302: struct TextPoint : public XmlExportable
Chris@147: {
Chris@147: public:
Chris@1038:     TextPoint(sv_frame_t _frame) : frame(_frame), height(0.0f) { }
Chris@1038:     TextPoint(sv_frame_t _frame, float _height, QString _label) : 
Chris@1429:         frame(_frame), height(_height), label(_label) { }
Chris@147: 
Chris@147:     int getDimensions() const { return 2; }
Chris@147:     
Chris@1038:     sv_frame_t frame;
Chris@147:     float height;
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@1429:         stream << QString("%1<point frame=\"%2\" height=\"%3\" label=\"%4\" %5/>\n")
Chris@1429:             .arg(indent).arg(frame).arg(height)
Chris@302:             .arg(encodeEntities(label)).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(height);
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 TextPoint &p1,
Chris@1429:                         const TextPoint &p2) const {
Chris@1429:             if (p1.frame != p2.frame) return p1.frame < p2.frame;
Chris@1429:             if (p1.height != p2.height) return p1.height < p2.height;
Chris@1429:             return p1.label < p2.label;
Chris@1429:         }
Chris@147:     };
Chris@147:     
Chris@147:     struct OrderComparator {
Chris@1429:         bool operator()(const TextPoint &p1,
Chris@1429:                         const TextPoint &p2) const {
Chris@1429:             return p1.frame < p2.frame;
Chris@1429:         }
Chris@147:     };
Chris@147: };
Chris@147: 
Chris@147: 
Chris@147: // Make this a class rather than a typedef so it can be predeclared.
Chris@147: 
Chris@147: class TextModel : public SparseModel<TextPoint>
Chris@147: {
Chris@423:     Q_OBJECT
Chris@423:     
Chris@147: public:
Chris@1040:     TextModel(sv_samplerate_t sampleRate, int resolution, bool notifyOnAdd = true) :
Chris@1429:         SparseModel<TextPoint>(sampleRate, resolution, notifyOnAdd)
Chris@147:     { }
Chris@147: 
Chris@288:     virtual void toXml(QTextStream &out,
Chris@288:                        QString indent = "",
Chris@288:                        QString extraAttributes = "") const
Chris@147:     {
Chris@288:         SparseModel<TextPoint>::toXml
Chris@1429:             (out, 
Chris@288:              indent,
Chris@1429:              QString("%1 subtype=\"text\"")
Chris@1429:              .arg(extraAttributes));
Chris@147:     }
Chris@345: 
Chris@345:     QString getTypeName() const { return tr("Text"); }
Chris@424: 
Chris@424:     /**
Chris@424:      * TabularModel methods.  
Chris@424:      */
Chris@424:     
Chris@424:     virtual int getColumnCount() const
Chris@424:     {
Chris@424:         return 4;
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("Height");
Chris@424:         case 3: 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 SparseModel<TextPoint>::getData
Chris@425:                 (row, column, role);
Chris@425:         }
Chris@425: 
Chris@608:         PointListConstIterator i = getPointListIteratorForRow(row);
Chris@424:         if (i == m_points.end()) return QVariant();
Chris@424: 
Chris@424:         switch (column) {
Chris@424:         case 2: return i->height;
Chris@424:         case 3: 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 SparseModel<TextPoint>::getSetDataCommand
Chris@425:                 (row, column, value, role);
Chris@425:         }
Chris@425: 
Chris@740:         if (role != Qt::EditRole) return 0;
Chris@424:         PointListIterator 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@1038:         case 2: point.height = float(value.toDouble()); break;
Chris@424:         case 3: 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 == 3) return SortAlphabetical;
Chris@424:         return SortNumeric;
Chris@424:     }
Chris@424: 
Chris@147: };
Chris@147: 
Chris@147: 
Chris@147: #endif
Chris@147: 
Chris@147: 
Chris@147: