Mercurial > hg > svcore
view data/model/Labeller.h @ 1483:7459f4c4d7c3
Merge from branch plugin-path-config
author | Chris Cannam |
---|---|
date | Mon, 11 Jun 2018 14:40:09 +0100 |
parents | 114de081a42d |
children | ad5f892c0c4d |
line wrap: on
line source
/* -*- 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-2007 Chris Cannam and QMUL. 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. */ #ifndef _LABELLER_H_ #define _LABELLER_H_ #include "SparseModel.h" #include "SparseValueModel.h" #include "base/Selection.h" #include <QObject> #include <map> #include <iostream> class Labeller : public QObject { Q_OBJECT public: enum ValueType { ValueNone, ValueFromSimpleCounter, ValueFromCyclicalCounter, ValueFromTwoLevelCounter, ValueFromFrameNumber, ValueFromRealTime, ValueFromDurationFromPrevious, ValueFromDurationToNext, ValueFromTempoFromPrevious, ValueFromTempoToNext, ValueFromExistingNeighbour, ValueFromLabel }; // uses: // // 1. when adding points to a time-value model, generate values // for those points based on their times or labels or a counter // // 2. when adding a single point to a time-instant model, generate // a label for it based on its time and that of the previous point // or a counter // // 3. when adding a single point to a time-instant model, generate // a label for the previous point based on its time and that of // the point just added (as tempo is based on time to the next // point, not the previous one) // // 4. re-label a set of points that have already been added to a // model Labeller(ValueType type = ValueNone) : m_type(type), m_counter(1), m_counter2(1), m_cycle(4), m_dp(10), m_rate(0) { } Labeller(const Labeller &l) : QObject(), m_type(l.m_type), m_counter(l.m_counter), m_counter2(l.m_counter2), m_cycle(l.m_cycle), m_dp(l.m_dp), m_rate(l.m_rate) { } virtual ~Labeller() { } typedef std::map<ValueType, QString> TypeNameMap; TypeNameMap getTypeNames() const { TypeNameMap m; m[ValueNone] = tr("No numbering"); m[ValueFromSimpleCounter] = tr("Simple counter"); m[ValueFromCyclicalCounter] = tr("Cyclical counter"); m[ValueFromTwoLevelCounter] = tr("Cyclical two-level counter (bar/beat)"); m[ValueFromFrameNumber] = tr("Audio sample frame number"); m[ValueFromRealTime] = tr("Time in seconds"); m[ValueFromDurationToNext] = tr("Duration to the following item"); m[ValueFromTempoToNext] = tr("Tempo (bpm) based on duration to following item"); m[ValueFromDurationFromPrevious] = tr("Duration since the previous item"); m[ValueFromTempoFromPrevious] = tr("Tempo (bpm) based on duration since previous item"); m[ValueFromExistingNeighbour] = tr("Same as the nearest previous item"); m[ValueFromLabel] = tr("Value extracted from the item's label (where possible)"); return m; } ValueType getType() const { return m_type; } void setType(ValueType type) { m_type = type; } int getCounterValue() const { return m_counter; } void setCounterValue(int v) { m_counter = v; } int getSecondLevelCounterValue() const { return m_counter2; } void setSecondLevelCounterValue(int v) { m_counter2 = v; } int getCounterCycleSize() const { return m_cycle; } void setCounterCycleSize(int s) { m_cycle = s; m_dp = 1; while (s > 0) { s /= 10; m_dp *= 10; } if (m_counter > m_cycle) m_counter = 1; } void setSampleRate(sv_samplerate_t rate) { m_rate = rate; } void resetCounters() { m_counter = 1; m_counter2 = 1; m_cycle = 4; } void incrementCounter() { m_counter++; if (m_type == ValueFromCyclicalCounter || m_type == ValueFromTwoLevelCounter) { if (m_counter > m_cycle) { m_counter = 1; m_counter2++; } } } template <typename PointType> void label(PointType &newPoint, PointType *prevPoint = 0) { if (m_type == ValueNone) { newPoint.label = ""; } else if (m_type == ValueFromTwoLevelCounter) { newPoint.label = tr("%1.%2").arg(m_counter2).arg(m_counter); incrementCounter(); } else if (m_type == ValueFromFrameNumber) { // avoid going through floating-point value newPoint.label = tr("%1").arg(newPoint.frame); } else { float value = getValueFor<PointType>(newPoint, prevPoint); if (actingOnPrevPoint() && prevPoint) { prevPoint->label = QString("%1").arg(value); } else { newPoint.label = QString("%1").arg(value); } } } /** * Relabel all points in the given model that lie within the given * multi-selection, according to the labelling properties of this * labeller. Return a command that has been executed but not yet * added to the history. */ template <typename PointType> Command *labelAll(SparseModel<PointType> &model, MultiSelection *ms) { auto points(model.getPoints()); auto command = new typename SparseModel<PointType>::EditCommand (&model, tr("Label Points")); PointType prevPoint(0); bool havePrevPoint(false); for (auto p: points) { if (ms) { Selection s(ms->getContainingSelection(p.frame, false)); if (!s.contains(p.frame)) { prevPoint = p; havePrevPoint = true; continue; } } if (actingOnPrevPoint()) { if (havePrevPoint) { command->deletePoint(prevPoint); label<PointType>(p, &prevPoint); command->addPoint(prevPoint); } } else { command->deletePoint(p); label<PointType>(p, &prevPoint); command->addPoint(p); } prevPoint = p; havePrevPoint = true; } return command->finish(); } /** * For each point in the given model (except the last), if that * point lies within the given multi-selection, add n-1 new points * at equally spaced intervals between it and the following point. * Return a command that has been executed but not yet added to * the history. */ template <typename PointType> Command *subdivide(SparseModel<PointType> &model, MultiSelection *ms, int n) { auto points(model.getPoints()); auto command = new typename SparseModel<PointType>::EditCommand (&model, tr("Subdivide Points")); for (auto i = points.begin(); i != points.end(); ++i) { auto j = i; // require a "next point" even if it's not in selection if (++j == points.end()) { break; } if (ms) { Selection s(ms->getContainingSelection(i->frame, false)); if (!s.contains(i->frame)) { continue; } } PointType p(*i); PointType nextP(*j); // n is the number of subdivisions, so we add n-1 new // points equally spaced between p and nextP for (int m = 1; m < n; ++m) { sv_frame_t f = p.frame + (m * (nextP.frame - p.frame)) / n; PointType newPoint(p); newPoint.frame = f; newPoint.label = tr("%1.%2").arg(p.label).arg(m+1); command->addPoint(newPoint); } } return command->finish(); } /** * Return a command that has been executed but not yet added to * the history. */ template <typename PointType> Command *winnow(SparseModel<PointType> &model, MultiSelection *ms, int n) { auto points(model.getPoints()); auto command = new typename SparseModel<PointType>::EditCommand (&model, tr("Winnow Points")); int counter = 0; for (auto p: points) { if (ms) { Selection s(ms->getContainingSelection(p.frame, false)); if (!s.contains(p.frame)) { counter = 0; continue; } } ++counter; if (counter == n+1) counter = 1; if (counter == 1) { // this is an Nth instant, don't remove it continue; } command->deletePoint(p); } return command->finish(); } template <typename PointType> void setValue(PointType &newPoint, PointType *prevPoint = 0) { if (m_type == ValueFromExistingNeighbour) { if (!prevPoint) { std::cerr << "ERROR: Labeller::setValue: Previous point required but not provided" << std::endl; } else { newPoint.value = prevPoint->value; } } else { float value = getValueFor<PointType>(newPoint, prevPoint); if (actingOnPrevPoint() && prevPoint) { prevPoint->value = value; } else { newPoint.value = value; } } } bool requiresPrevPoint() const { return (m_type == ValueFromDurationFromPrevious || m_type == ValueFromDurationToNext || m_type == ValueFromTempoFromPrevious || m_type == ValueFromDurationToNext); } bool actingOnPrevPoint() const { return (m_type == ValueFromDurationToNext || m_type == ValueFromTempoToNext); } protected: template <typename PointType> float getValueFor(PointType &newPoint, PointType *prevPoint) { float value = 0.f; switch (m_type) { case ValueNone: value = 0; break; case ValueFromSimpleCounter: case ValueFromCyclicalCounter: value = float(m_counter); incrementCounter(); break; case ValueFromTwoLevelCounter: value = float(m_counter2 + double(m_counter) / double(m_dp)); incrementCounter(); break; case ValueFromFrameNumber: value = float(newPoint.frame); break; case ValueFromRealTime: if (m_rate == 0.0) { std::cerr << "ERROR: Labeller::getValueFor: Real-time conversion required, but no sample rate set" << std::endl; } else { value = float(double(newPoint.frame) / m_rate); } break; case ValueFromDurationToNext: case ValueFromTempoToNext: case ValueFromDurationFromPrevious: case ValueFromTempoFromPrevious: if (m_rate == 0.0) { std::cerr << "ERROR: Labeller::getValueFor: Real-time conversion required, but no sample rate set" << std::endl; } else if (!prevPoint) { std::cerr << "ERROR: Labeller::getValueFor: Time difference required, but only one point provided" << std::endl; } else { sv_frame_t f0 = prevPoint->frame, f1 = newPoint.frame; if (m_type == ValueFromDurationToNext || m_type == ValueFromDurationFromPrevious) { value = float(double(f1 - f0) / m_rate); } else { if (f1 > f0) { value = float((60.0 * m_rate) / double(f1 - f0)); } } } break; case ValueFromExistingNeighbour: // need to deal with this in the calling function, as this // function must handle points that don't have values to // read from break; case ValueFromLabel: if (newPoint.label != "") { // more forgiving than QString::toFloat() value = float(atof(newPoint.label.toLocal8Bit())); } else { value = 0.f; } break; } return value; } ValueType m_type; int m_counter; int m_counter2; int m_cycle; int m_dp; sv_samplerate_t m_rate; }; #endif