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@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@147:     TextPoint(long _frame) : frame(_frame), height(0.0f) { }
Chris@147:     TextPoint(long _frame, float _height, QString _label) : 
Chris@147: 	frame(_frame), height(_height), label(_label) { }
Chris@147: 
Chris@147:     int getDimensions() const { return 2; }
Chris@147:     
Chris@147:     long frame;
Chris@147:     float height;
Chris@147:     QString 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\" height=\"%3\" label=\"%4\" %5/>\n")
Chris@302: 	    .arg(indent).arg(frame).arg(height)
Chris@302:             .arg(encodeEntities(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(height);
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 TextPoint &p1,
Chris@147: 			const TextPoint &p2) const {
Chris@147: 	    if (p1.frame != p2.frame) return p1.frame < p2.frame;
Chris@147: 	    if (p1.height != p2.height) return p1.height < p2.height;
Chris@147: 	    return p1.label < p2.label;
Chris@147: 	}
Chris@147:     };
Chris@147:     
Chris@147:     struct OrderComparator {
Chris@147: 	bool operator()(const TextPoint &p1,
Chris@147: 			const TextPoint &p2) const {
Chris@147: 	    return p1.frame < p2.frame;
Chris@147: 	}
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@147: public:
Chris@147:     TextModel(size_t sampleRate, size_t resolution, bool notifyOnAdd = true) :
Chris@147: 	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@288: 	    (out, 
Chris@288:              indent,
Chris@147: 	     QString("%1 subtype=\"text\"")
Chris@147: 	     .arg(extraAttributes));
Chris@147:     }
Chris@147: };
Chris@147: 
Chris@147: 
Chris@147: #endif
Chris@147: 
Chris@147: 
Chris@147: