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 _TEXT_MODEL_H_
lbajardsilogic@0: #define _TEXT_MODEL_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include "SparseModel.h"
lbajardsilogic@0: #include "base/RealTime.h"
lbajardsilogic@0: 
lbajardsilogic@0: /**
lbajardsilogic@0:  * Text point type for use in a SparseModel.  This represents a piece
lbajardsilogic@0:  * of text at a given time and y-value in the [0,1) range (indicative
lbajardsilogic@0:  * of height on the window).  Intended for casual textual annotations.
lbajardsilogic@0:  */
lbajardsilogic@0: 
lbajardsilogic@0: struct TextPoint
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     TextPoint(long _frame) : frame(_frame), height(0.0f) { }
lbajardsilogic@0:     TextPoint(long _frame, float _height, QString _label) : 
lbajardsilogic@0: 	frame(_frame), height(_height), label(_label) { }
lbajardsilogic@0: 
lbajardsilogic@0:     int getDimensions() const { return 2; }
lbajardsilogic@0:     
lbajardsilogic@0:     long frame;
lbajardsilogic@0:     float height;
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\" height=\"%3\" label=\"%4\" %5/>\n")
lbajardsilogic@0: 	    .arg(indent).arg(frame).arg(height).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(height);
lbajardsilogic@0:         list << label;
lbajardsilogic@0:         return list.join(delimiter);
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     struct Comparator {
lbajardsilogic@0: 	bool operator()(const TextPoint &p1,
lbajardsilogic@0: 			const TextPoint &p2) const {
lbajardsilogic@0: 	    if (p1.frame != p2.frame) return p1.frame < p2.frame;
lbajardsilogic@0: 	    if (p1.height != p2.height) return p1.height < p2.height;
lbajardsilogic@0: 	    return p1.label < p2.label;
lbajardsilogic@0: 	}
lbajardsilogic@0:     };
lbajardsilogic@0:     
lbajardsilogic@0:     struct OrderComparator {
lbajardsilogic@0: 	bool operator()(const TextPoint &p1,
lbajardsilogic@0: 			const TextPoint &p2) const {
lbajardsilogic@0: 	    return p1.frame < p2.frame;
lbajardsilogic@0: 	}
lbajardsilogic@0:     };
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: 
lbajardsilogic@0: // Make this a class rather than a typedef so it can be predeclared.
lbajardsilogic@0: 
lbajardsilogic@0: class TextModel : public SparseModel<TextPoint>
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     TextModel(size_t sampleRate, size_t resolution, bool notifyOnAdd = true) :
lbajardsilogic@0: 	SparseModel<TextPoint>(sampleRate, resolution, notifyOnAdd)
lbajardsilogic@0:     { }
lbajardsilogic@0: 
lbajardsilogic@0:     virtual QString toXmlString(QString indent = "",
lbajardsilogic@0: 				QString extraAttributes = "") const
lbajardsilogic@0:     {
lbajardsilogic@0: 	return SparseModel<TextPoint>::toXmlString
lbajardsilogic@0: 	    (indent,
lbajardsilogic@0: 	     QString("%1 subtype=\"text\"")
lbajardsilogic@0: 	     .arg(extraAttributes));
lbajardsilogic@0:     }
lbajardsilogic@49: 
lbajardsilogic@49: 	virtual void toXml(QTextStream &out,
lbajardsilogic@49:                 QString indent = "",
lbajardsilogic@49:                 QString extraAttributes = "") const
lbajardsilogic@49:     {
lbajardsilogic@49: 	SparseModel<TextPoint>::toXml
lbajardsilogic@49: 	    (out,
lbajardsilogic@49: 		 indent,
lbajardsilogic@49: 	     QString("%1 subtype=\"text\"").arg(extraAttributes));
lbajardsilogic@49:     }
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: 
lbajardsilogic@0: #endif
lbajardsilogic@0: 
lbajardsilogic@0: 
lbajardsilogic@0: