comparison layer/TextLayer.cpp @ 0:fc9323a41f5a

start base : Sonic Visualiser sv1-1.0rc1

+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    Sonic Visualiser
+    An audio file viewer and annotation editor.
+    Centre for Digital Music, Queen Mary, University of London.
+    This file copyright 2006 Chris Cannam.
+    
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation; either version 2 of the
+    License, or (at your option) any later version.  See the file
+    COPYING included with this distribution for more information.
+*/
+
+#include "TextLayer.h"
+
+#include "data/model/Model.h"
+#include "base/RealTime.h"
+#include "base/Profiler.h"
+#include "view/View.h"
+
+#include "data/model/TextModel.h"
+
+#include <QPainter>
+#include <QMouseEvent>
+#include <QInputDialog>
+
+#include <iostream>
+#include <cmath>
+
+TextLayer::TextLayer() :
+    Layer(),
+    m_model(0),
+    m_editing(false),
+    m_originalPoint(0, 0.0, tr("Empty Label")),
+    m_editingPoint(0, 0.0, tr("Empty Label")),
+    m_editingCommand(0),
+    m_colour(255, 150, 50) // orange
+{
+    
+}
+
+void
+TextLayer::setModel(TextModel *model)
+{
+    if (m_model == model) return;
+    m_model = model;
+
+    connect(m_model, SIGNAL(modelChanged()), this, SIGNAL(modelChanged()));
+    connect(m_model, SIGNAL(modelChanged(size_t, size_t)),
+	    this, SIGNAL(modelChanged(size_t, size_t)));
+
+    connect(m_model, SIGNAL(completionChanged()),
+	    this, SIGNAL(modelCompletionChanged()));
+
+//    std::cerr << "TextLayer::setModel(" << model << ")" << std::endl;
+
+    emit modelReplaced();
+}
+
+Layer::PropertyList
+TextLayer::getProperties() const
+{
+    PropertyList list;
+    list.push_back("Colour");
+    return list;
+}
+
+QString
+TextLayer::getPropertyLabel(const PropertyName &name) const
+{
+    if (name == "Colour") return tr("Colour");
+    return "";
+}
+
+Layer::PropertyType
+TextLayer::getPropertyType(const PropertyName &) const
+{
+    return ValueProperty;
+}
+
+int
+TextLayer::getPropertyRangeAndValue(const PropertyName &name,
+				    int *min, int *max, int *deflt) const
+{
+    //!!! factor this colour handling stuff out into a colour manager class
+
+    int val = 0;
+
+    if (name == "Colour") {
+
+	if (min) *min = 0;
+	if (max) *max = 5;
+        if (deflt) *deflt = 0;
+
+	if (m_colour == Qt::black) val = 0;
+	else if (m_colour == Qt::darkRed) val = 1;
+	else if (m_colour == Qt::darkBlue) val = 2;
+	else if (m_colour == Qt::darkGreen) val = 3;
+	else if (m_colour == QColor(200, 50, 255)) val = 4;
+	else if (m_colour == QColor(255, 150, 50)) val = 5;
+
+    } else {
+	
+	val = Layer::getPropertyRangeAndValue(name, min, max, deflt);
+    }
+
+    return val;
+}
+
+QString
+TextLayer::getPropertyValueLabel(const PropertyName &name,
+				 int value) const
+{
+    if (name == "Colour") {
+	switch (value) {
+	default:
+	case 0: return tr("Black");
+	case 1: return tr("Red");
+	case 2: return tr("Blue");
+	case 3: return tr("Green");
+	case 4: return tr("Purple");
+	case 5: return tr("Orange");
+	}
+    }
+    return tr("<unknown>");
+}
+
+void
+TextLayer::setProperty(const PropertyName &name, int value)
+{
+    if (name == "Colour") {
+	switch (value) {
+	default:
+	case 0:	setBaseColour(Qt::black); break;
+	case 1: setBaseColour(Qt::darkRed); break;
+	case 2: setBaseColour(Qt::darkBlue); break;
+	case 3: setBaseColour(Qt::darkGreen); break;
+	case 4: setBaseColour(QColor(200, 50, 255)); break;
+	case 5: setBaseColour(QColor(255, 150, 50)); break;
+	}
+    }
+}
+
+bool
+TextLayer::getValueExtents(float &, float &, bool &, QString &) const
+{
+    return false;
+}
+
+void
+TextLayer::setBaseColour(QColor colour)
+{
+    if (m_colour == colour) return;
+    m_colour = colour;
+    emit layerParametersChanged();
+}
+
+bool
+TextLayer::isLayerScrollable(const View *v) const
+{
+    QPoint discard;
+    return !v->shouldIlluminateLocalFeatures(this, discard);
+}
+
+
+TextModel::PointList
+TextLayer::getLocalPoints(View *v, int x, int y) const
+{
+    if (!m_model) return TextModel::PointList();
+
+    long frame0 = v->getFrameForX(-150);
+    long frame1 = v->getFrameForX(v->width() + 150);
+    
+    TextModel::PointList points(m_model->getPoints(frame0, frame1));
+
+    TextModel::PointList rv;
+    QFontMetrics metrics = QPainter().fontMetrics();
+
+    for (TextModel::PointList::iterator i = points.begin();
+	 i != points.end(); ++i) {
+
+	const TextModel::Point &p(*i);
+
+	int px = v->getXForFrame(p.frame);
+	int py = getYForHeight(v, p.height);
+
+	QString label = p.label;
+	if (label == "") {
+	    label = tr("<no text>");
+	}
+
+	QRect rect = metrics.boundingRect
+	    (QRect(0, 0, 150, 200),
+	     Qt::AlignLeft | Qt::AlignTop | Qt::TextWordWrap, label);
+
+	if (py + rect.height() > v->height()) {
+	    if (rect.height() > v->height()) py = 0;
+	    else py = v->height() - rect.height() - 1;
+	}
+
+	if (x >= px && x < px + rect.width() &&
+	    y >= py && y < py + rect.height()) {
+	    rv.insert(p);
+	}
+    }
+
+    return rv;
+}
+
+QString
+TextLayer::getFeatureDescription(View *v, QPoint &pos) const
+{
+    int x = pos.x();
+
+    if (!m_model || !m_model->getSampleRate()) return "";
+
+    TextModel::PointList points = getLocalPoints(v, x, pos.y());
+
+    if (points.empty()) {
+	if (!m_model->isReady()) {
+	    return tr("In progress");
+	} else {
+	    return "";
+	}
+    }
+
+    long useFrame = points.begin()->frame;
+
+    RealTime rt = RealTime::frame2RealTime(useFrame, m_model->getSampleRate());
+    
+    QString text;
+
+    if (points.begin()->label == "") {
+	text = QString(tr("Time:\t%1\nHeight:\t%2\nLabel:\t%3"))
+	    .arg(rt.toText(true).c_str())
+	    .arg(points.begin()->height)
+	    .arg(points.begin()->label);
+    }
+
+    pos = QPoint(v->getXForFrame(useFrame),
+		 getYForHeight(v, points.begin()->height));
+    return text;
+}
+
+
+//!!! too much overlap with TimeValueLayer/TimeInstantLayer
+
+bool
+TextLayer::snapToFeatureFrame(View *v, int &frame,
+			      size_t &resolution,
+			      SnapType snap) const
+{
+    if (!m_model) {
+	return Layer::snapToFeatureFrame(v, frame, resolution, snap);
+    }
+
+    resolution = m_model->getResolution();
+    TextModel::PointList points;
+
+    if (snap == SnapNeighbouring) {
+	
+	points = getLocalPoints(v, v->getXForFrame(frame), -1);
+	if (points.empty()) return false;
+	frame = points.begin()->frame;
+	return true;
+    }    
+
+    points = m_model->getPoints(frame, frame);
+    int snapped = frame;
+    bool found = false;
+
+    for (TextModel::PointList::const_iterator i = points.begin();
+	 i != points.end(); ++i) {
+
+	if (snap == SnapRight) {
+
+	    if (i->frame > frame) {
+		snapped = i->frame;
+		found = true;
+		break;
+	    }
+
+	} else if (snap == SnapLeft) {
+
+	    if (i->frame <= frame) {
+		snapped = i->frame;
+		found = true; // don't break, as the next may be better
+	    } else {
+		break;
+	    }
+
+	} else { // nearest
+
+	    TextModel::PointList::const_iterator j = i;
+	    ++j;
+
+	    if (j == points.end()) {
+
+		snapped = i->frame;
+		found = true;
+		break;
+
+	    } else if (j->frame >= frame) {
+
+		if (j->frame - frame < frame - i->frame) {
+		    snapped = j->frame;
+		} else {
+		    snapped = i->frame;
+		}
+		found = true;
+		break;
+	    }
+	}
+    }
+
+    frame = snapped;
+    return found;
+}
+
+int
+TextLayer::getYForHeight(View *v, float height) const
+{
+    int h = v->height();
+    return h - int(height * h);
+}
+
+float
+TextLayer::getHeightForY(View *v, int y) const
+{
+    int h = v->height();
+    return float(h - y) / h;
+}
+
+void
+TextLayer::paint(View *v, QPainter &paint, QRect rect) const
+{
+    if (!m_model || !m_model->isOK()) return;
+
+    int sampleRate = m_model->getSampleRate();
+    if (!sampleRate) return;
+
+//    Profiler profiler("TextLayer::paint", true);
+
+    int x0 = rect.left(), x1 = rect.right();
+    long frame0 = v->getFrameForX(x0);
+    long frame1 = v->getFrameForX(x1);
+
+    TextModel::PointList points(m_model->getPoints(frame0, frame1));
+    if (points.empty()) return;
+
+    QColor brushColour(m_colour);
+
+    int h, s, val;
+    brushColour.getHsv(&h, &s, &val);
+    brushColour.setHsv(h, s, 255, 100);
+
+    QColor penColour;
+    if (v->hasLightBackground()) {
+	penColour = Qt::black;
+    } else {
+	penColour = Qt::white;
+    }
+
+//    std::cerr << "TextLayer::paint: resolution is "
+//	      << m_model->getResolution() << " frames" << std::endl;
+
+    QPoint localPos;
+    long illuminateFrame = -1;
+
+    if (v->shouldIlluminateLocalFeatures(this, localPos)) {
+	TextModel::PointList localPoints = getLocalPoints(v, localPos.x(),
+							  localPos.y());
+	if (!localPoints.empty()) illuminateFrame = localPoints.begin()->frame;
+    }
+
+    int boxMaxWidth = 150;
+    int boxMaxHeight = 200;
+
+    paint.save();
+    paint.setClipRect(rect.x(), 0, rect.width() + boxMaxWidth, v->height());
+    
+    for (TextModel::PointList::const_iterator i = points.begin();
+	 i != points.end(); ++i) {
+
+	const TextModel::Point &p(*i);
+
+	int x = v->getXForFrame(p.frame);
+	int y = getYForHeight(v, p.height);
+
+	if (illuminateFrame == p.frame) {
+	    paint.setBrush(penColour);
+	    if (v->hasLightBackground()) {
+		paint.setPen(Qt::white);
+	    } else {
+		paint.setPen(Qt::black);
+	    }
+	} else {
+	    paint.setPen(penColour);
+	    paint.setBrush(brushColour);
+	}
+
+	QString label = p.label;
+	if (label == "") {
+	    label = tr("<no text>");
+	}
+
+	QRect boxRect = paint.fontMetrics().boundingRect
+	    (QRect(0, 0, boxMaxWidth, boxMaxHeight),
+	     Qt::AlignLeft | Qt::AlignTop | Qt::TextWordWrap, label);
+
+	QRect textRect = QRect(3, 2, boxRect.width(), boxRect.height());
+	boxRect = QRect(0, 0, boxRect.width() + 6, boxRect.height() + 2);
+
+	if (y + boxRect.height() > v->height()) {
+	    if (boxRect.height() > v->height()) y = 0;
+	    else y = v->height() - boxRect.height() - 1;
+	}
+
+	boxRect = QRect(x, y, boxRect.width(), boxRect.height());
+	textRect = QRect(x + 3, y + 2, textRect.width(), textRect.height());
+
+//	boxRect = QRect(x, y, boxRect.width(), boxRect.height());
+//	textRect = QRect(x + 3, y + 2, textRect.width(), textRect.height());
+
+	paint.setRenderHint(QPainter::Antialiasing, false);
+	paint.drawRect(boxRect);
+
+	paint.setRenderHint(QPainter::Antialiasing, true);
+	paint.drawText(textRect,
+		       Qt::AlignLeft | Qt::AlignTop | Qt::TextWordWrap,
+		       label);
+
+///	if (p.label != "") {
+///	    paint.drawText(x + 5, y - paint.fontMetrics().height() + paint.fontMetrics().ascent(), p.label);
+///	}
+    }
+
+    paint.restore();
+
+    // looks like save/restore doesn't deal with this:
+    paint.setRenderHint(QPainter::Antialiasing, false);
+}
+
+void
+TextLayer::drawStart(View *v, QMouseEvent *e)
+{
+//    std::cerr << "TextLayer::drawStart(" << e->x() << "," << e->y() << ")" << std::endl;
+
+    if (!m_model) {
+	std::cerr << "TextLayer::drawStart: no model" << std::endl;
+	return;
+    }
+
+    long frame = v->getFrameForX(e->x());
+    if (frame < 0) frame = 0;
+    frame = frame / m_model->getResolution() * m_model->getResolution();
+
+    float height = getHeightForY(v, e->y());
+
+    m_editingPoint = TextModel::Point(frame, height, "");
+    m_originalPoint = m_editingPoint;
+
+    if (m_editingCommand) m_editingCommand->finish();
+    m_editingCommand = new TextModel::EditCommand(m_model, "Add Label");
+    m_editingCommand->addPoint(m_editingPoint);
+
+    m_editing = true;
+}
+
+void
+TextLayer::drawDrag(View *v, QMouseEvent *e)
+{
+//    std::cerr << "TextLayer::drawDrag(" << e->x() << "," << e->y() << ")" << std::endl;
+
+    if (!m_model || !m_editing) return;
+
+    long frame = v->getFrameForX(e->x());
+    if (frame < 0) frame = 0;
+    frame = frame / m_model->getResolution() * m_model->getResolution();
+
+    float height = getHeightForY(v, e->y());
+
+    m_editingCommand->deletePoint(m_editingPoint);
+    m_editingPoint.frame = frame;
+    m_editingPoint.height = height;
+    m_editingCommand->addPoint(m_editingPoint);
+}
+
+void
+TextLayer::drawEnd(View *v, QMouseEvent *)
+{
+//    std::cerr << "TextLayer::drawEnd(" << e->x() << "," << e->y() << ")" << std::endl;
+    if (!m_model || !m_editing) return;
+
+    bool ok = false;
+    QString label = QInputDialog::getText(v, tr("Enter label"),
+					  tr("Please enter a new label:"),
+					  QLineEdit::Normal, "", &ok);
+
+    if (ok) {
+	TextModel::RelabelCommand *command =
+	    new TextModel::RelabelCommand(m_model, m_editingPoint, label);
+	m_editingCommand->addCommand(command);
+    }
+
+    m_editingCommand->finish();
+    m_editingCommand = 0;
+    m_editing = false;
+}
+
+void
+TextLayer::editStart(View *v, QMouseEvent *e)
+{
+//    std::cerr << "TextLayer::editStart(" << e->x() << "," << e->y() << ")" << std::endl;
+
+    if (!m_model) return;
+
+    TextModel::PointList points = getLocalPoints(v, e->x(), e->y());
+    if (points.empty()) return;
+
+    m_editOrigin = e->pos();
+    m_editingPoint = *points.begin();
+    m_originalPoint = m_editingPoint;
+
+    if (m_editingCommand) {
+	m_editingCommand->finish();
+	m_editingCommand = 0;
+    }
+
+    m_editing = true;
+}
+
+void
+TextLayer::editDrag(View *v, QMouseEvent *e)
+{
+    if (!m_model || !m_editing) return;
+
+    long frameDiff = v->getFrameForX(e->x()) - v->getFrameForX(m_editOrigin.x());
+    float heightDiff = getHeightForY(v, e->y()) - getHeightForY(v, m_editOrigin.y());
+
+    long frame = m_originalPoint.frame + frameDiff;
+    float height = m_originalPoint.height + heightDiff;
+
+//    long frame = v->getFrameForX(e->x());
+    if (frame < 0) frame = 0;
+    frame = (frame / m_model->getResolution()) * m_model->getResolution();
+
+//    float height = getHeightForY(v, e->y());
+
+    if (!m_editingCommand) {
+	m_editingCommand = new TextModel::EditCommand(m_model, tr("Drag Label"));
+    }
+
+    m_editingCommand->deletePoint(m_editingPoint);
+    m_editingPoint.frame = frame;
+    m_editingPoint.height = height;
+    m_editingCommand->addPoint(m_editingPoint);
+}
+
+void
+TextLayer::editEnd(View *, QMouseEvent *)
+{
+//    std::cerr << "TextLayer::editEnd(" << e->x() << "," << e->y() << ")" << std::endl;
+    if (!m_model || !m_editing) return;
+
+    if (m_editingCommand) {
+
+	QString newName = m_editingCommand->getName();
+
+	if (m_editingPoint.frame != m_originalPoint.frame) {
+	    if (m_editingPoint.height != m_originalPoint.height) {
+		newName = tr("Move Label");
+	    } else {
+		newName = tr("Move Label Horizontally");
+	    }
+	} else {
+	    newName = tr("Move Label Vertically");
+	}
+
+	m_editingCommand->setName(newName);
+	m_editingCommand->finish();
+    }
+    
+    m_editingCommand = 0;
+    m_editing = false;
+}
+
+void
+TextLayer::editOpen(View *v, QMouseEvent *e)
+{
+    std::cerr << "TextLayer::editOpen" << std::endl;
+
+    if (!m_model) return;
+
+    TextModel::PointList points = getLocalPoints(v, e->x(), e->y());
+    if (points.empty()) return;
+
+    QString label = points.begin()->label;
+
+    bool ok = false;
+    label = QInputDialog::getText(v, tr("Enter label"),
+				  tr("Please enter a new label:"),
+				  QLineEdit::Normal, label, &ok);
+    if (ok && label != points.begin()->label) {
+	TextModel::RelabelCommand *command =
+	    new TextModel::RelabelCommand(m_model, *points.begin(), label);
+	CommandHistory::getInstance()->addCommand(command);
+    }
+}    
+
+void
+TextLayer::moveSelection(Selection s, size_t newStartFrame)
+{
+    if (!m_model) return;
+
+    TextModel::EditCommand *command =
+	new TextModel::EditCommand(m_model, tr("Drag Selection"));
+
+    TextModel::PointList points =
+	m_model->getPoints(s.getStartFrame(), s.getEndFrame());
+
+    for (TextModel::PointList::iterator i = points.begin();
+	 i != points.end(); ++i) {
+
+	if (s.contains(i->frame)) {
+	    TextModel::Point newPoint(*i);
+	    newPoint.frame = i->frame + newStartFrame - s.getStartFrame();
+	    command->deletePoint(*i);
+	    command->addPoint(newPoint);
+	}
+    }
+
+    command->finish();
+}
+
+void
+TextLayer::resizeSelection(Selection s, Selection newSize)
+{
+    if (!m_model) return;
+
+    TextModel::EditCommand *command =
+	new TextModel::EditCommand(m_model, tr("Resize Selection"));
+
+    TextModel::PointList points =
+	m_model->getPoints(s.getStartFrame(), s.getEndFrame());
+
+    double ratio =
+	double(newSize.getEndFrame() - newSize.getStartFrame()) /
+	double(s.getEndFrame() - s.getStartFrame());
+
+    for (TextModel::PointList::iterator i = points.begin();
+	 i != points.end(); ++i) {
+
+	if (s.contains(i->frame)) {
+
+	    double target = i->frame;
+	    target = newSize.getStartFrame() + 
+		double(target - s.getStartFrame()) * ratio;
+
+	    TextModel::Point newPoint(*i);
+	    newPoint.frame = lrint(target);
+	    command->deletePoint(*i);
+	    command->addPoint(newPoint);
+	}
+    }
+
+    command->finish();
+}
+
+void
+TextLayer::deleteSelection(Selection s)
+{
+    if (!m_model) return;
+
+    TextModel::EditCommand *command =
+	new TextModel::EditCommand(m_model, tr("Delete Selection"));
+
+    TextModel::PointList points =
+	m_model->getPoints(s.getStartFrame(), s.getEndFrame());
+
+    for (TextModel::PointList::iterator i = points.begin();
+	 i != points.end(); ++i) {
+	if (s.contains(i->frame)) command->deletePoint(*i);
+    }
+
+    command->finish();
+}
+
+void
+TextLayer::copy(Selection s, Clipboard &to)
+{
+    if (!m_model) return;
+
+    TextModel::PointList points =
+	m_model->getPoints(s.getStartFrame(), s.getEndFrame());
+
+    for (TextModel::PointList::iterator i = points.begin();
+	 i != points.end(); ++i) {
+	if (s.contains(i->frame)) {
+            Clipboard::Point point(i->frame, i->height, i->label);
+            to.addPoint(point);
+        }
+    }
+}
+
+bool
+TextLayer::paste(const Clipboard &from, int frameOffset, bool /* interactive */)
+{
+    if (!m_model) return false;
+
+    const Clipboard::PointList &points = from.getPoints();
+
+    TextModel::EditCommand *command =
+	new TextModel::EditCommand(m_model, tr("Paste"));
+
+    float valueMin = 0.0, valueMax = 1.0;
+    for (Clipboard::PointList::const_iterator i = points.begin();
+         i != points.end(); ++i) {
+        if (i->haveValue()) {
+            if (i->getValue() < valueMin) valueMin = i->getValue();
+            if (i->getValue() > valueMax) valueMax = i->getValue();
+        }
+    }
+    if (valueMax < valueMin + 1.0) valueMax = valueMin + 1.0;
+
+    for (Clipboard::PointList::const_iterator i = points.begin();
+         i != points.end(); ++i) {
+        
+        if (!i->haveFrame()) continue;
+        size_t frame = 0;
+        if (frameOffset > 0 || -frameOffset < i->getFrame()) {
+            frame = i->getFrame() + frameOffset;
+        }
+        TextModel::Point newPoint(frame);
+
+        if (i->haveValue()) {
+            newPoint.height = (i->getValue() - valueMin) / (valueMax - valueMin);
+        } else {
+            newPoint.height = 0.5;
+        }
+
+        if (i->haveLabel()) {
+            newPoint.label = i->getLabel();
+        } else if (i->haveValue()) {
+            newPoint.label = QString("%1").arg(i->getValue());
+        } else {
+            newPoint.label = tr("New Point");
+        }
+        
+        command->addPoint(newPoint);
+    }
+
+    command->finish();
+    return true;
+}
+
+QString
+TextLayer::toXmlString(QString indent, QString extraAttributes) const
+{
+    return Layer::toXmlString(indent, extraAttributes +
+			      QString(" colour=\"%1\"")
+			      .arg(encodeColour(m_colour)));
+}
+
+void
+TextLayer::setProperties(const QXmlAttributes &attributes)
+{
+    QString colourSpec = attributes.value("colour");
+    if (colourSpec != "") {
+	QColor colour(colourSpec);
+	if (colour.isValid()) {
+	    setBaseColour(QColor(colourSpec));
+	}
+    }
+}
+