Chris@1785
|
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
|
Chris@1785
|
2
|
Chris@1785
|
3 /*
|
Chris@1785
|
4 Sonic Visualiser
|
Chris@1785
|
5 An audio file viewer and annotation editor.
|
Chris@1785
|
6 Centre for Digital Music, Queen Mary, University of London.
|
Chris@1785
|
7
|
Chris@1785
|
8 This program is free software; you can redistribute it and/or
|
Chris@1785
|
9 modify it under the terms of the GNU General Public License as
|
Chris@1785
|
10 published by the Free Software Foundation; either version 2 of the
|
Chris@1785
|
11 License, or (at your option) any later version. See the file
|
Chris@1785
|
12 COPYING included with this distribution for more information.
|
Chris@1785
|
13 */
|
Chris@1785
|
14
|
Chris@1785
|
15 #ifndef SV_TIME_FREQUENCY_BOX_MODEL_H
|
Chris@1785
|
16 #define SV_TIME_FREQUENCY_BOX_MODEL_H
|
Chris@1785
|
17
|
Chris@1785
|
18 #include "EventCommands.h"
|
Chris@1785
|
19 #include "TabularModel.h"
|
Chris@1785
|
20 #include "Model.h"
|
Chris@1785
|
21 #include "DeferredNotifier.h"
|
Chris@1785
|
22
|
Chris@1785
|
23 #include "base/RealTime.h"
|
Chris@1785
|
24 #include "base/EventSeries.h"
|
Chris@1785
|
25 #include "base/UnitDatabase.h"
|
Chris@1785
|
26
|
Chris@1785
|
27 #include "system/System.h"
|
Chris@1785
|
28
|
Chris@1785
|
29 #include <QMutex>
|
Chris@1785
|
30
|
Chris@1785
|
31 /**
|
Chris@1785
|
32 * TimeFrequencyBoxModel -- a model for annotations having start time,
|
Chris@1785
|
33 * duration, and a frequency range. We use Events as usual for these,
|
Chris@1785
|
34 * but treat the "value" as the lower frequency and "level" as the
|
Chris@1785
|
35 * difference between lower and upper frequencies, which is expected
|
Chris@1785
|
36 * to be non-negative (if it is negative, abs(level) will be used).
|
Chris@1785
|
37 */
|
Chris@1785
|
38 class TimeFrequencyBoxModel : public Model,
|
Chris@1785
|
39 public TabularModel,
|
Chris@1785
|
40 public EventEditable
|
Chris@1785
|
41 {
|
Chris@1785
|
42 Q_OBJECT
|
Chris@1785
|
43
|
Chris@1785
|
44 public:
|
Chris@1785
|
45 TimeFrequencyBoxModel(sv_samplerate_t sampleRate,
|
Chris@1785
|
46 int resolution,
|
Chris@1785
|
47 bool notifyOnAdd = true) :
|
Chris@1785
|
48 m_sampleRate(sampleRate),
|
Chris@1785
|
49 m_resolution(resolution),
|
Chris@1785
|
50 m_frequencyMinimum(0.f),
|
Chris@1785
|
51 m_frequencyMaximum(0.f),
|
Chris@1785
|
52 m_haveExtents(false),
|
Chris@1785
|
53 m_notifier(this,
|
Chris@1785
|
54 getId(),
|
Chris@1785
|
55 notifyOnAdd ?
|
Chris@1785
|
56 DeferredNotifier::NOTIFY_ALWAYS :
|
Chris@1785
|
57 DeferredNotifier::NOTIFY_DEFERRED),
|
Chris@1785
|
58 m_completion(100) {
|
Chris@1785
|
59 }
|
Chris@1785
|
60
|
Chris@1785
|
61 TimeFrequencyBoxModel(sv_samplerate_t sampleRate, int resolution,
|
Chris@1785
|
62 float frequencyMinimum, float frequencyMaximum,
|
Chris@1785
|
63 bool notifyOnAdd = true) :
|
Chris@1785
|
64 m_sampleRate(sampleRate),
|
Chris@1785
|
65 m_resolution(resolution),
|
Chris@1785
|
66 m_frequencyMinimum(frequencyMinimum),
|
Chris@1785
|
67 m_frequencyMaximum(frequencyMaximum),
|
Chris@1785
|
68 m_haveExtents(true),
|
Chris@1785
|
69 m_notifier(this,
|
Chris@1785
|
70 getId(),
|
Chris@1785
|
71 notifyOnAdd ?
|
Chris@1785
|
72 DeferredNotifier::NOTIFY_ALWAYS :
|
Chris@1785
|
73 DeferredNotifier::NOTIFY_DEFERRED),
|
Chris@1785
|
74 m_completion(100) {
|
Chris@1785
|
75 }
|
Chris@1785
|
76
|
Chris@1785
|
77 virtual ~TimeFrequencyBoxModel() {
|
Chris@1785
|
78 }
|
Chris@1785
|
79
|
Chris@1785
|
80 QString getTypeName() const override { return tr("Time-Frequency Box"); }
|
Chris@1785
|
81 bool isSparse() const override { return true; }
|
Chris@1785
|
82 bool isOK() const override { return true; }
|
Chris@1785
|
83
|
Chris@1785
|
84 sv_frame_t getStartFrame() const override {
|
Chris@1785
|
85 return m_events.getStartFrame();
|
Chris@1785
|
86 }
|
Chris@1785
|
87 sv_frame_t getTrueEndFrame() const override {
|
Chris@1785
|
88 if (m_events.isEmpty()) return 0;
|
Chris@1785
|
89 sv_frame_t e = m_events.getEndFrame();
|
Chris@1785
|
90 if (e % m_resolution == 0) return e;
|
Chris@1785
|
91 else return (e / m_resolution + 1) * m_resolution;
|
Chris@1785
|
92 }
|
Chris@1785
|
93
|
Chris@1785
|
94 sv_samplerate_t getSampleRate() const override { return m_sampleRate; }
|
Chris@1785
|
95 int getResolution() const { return m_resolution; }
|
Chris@1785
|
96
|
Chris@1785
|
97 QString getScaleUnits() const { return "Hz"; }
|
Chris@1785
|
98
|
Chris@1785
|
99 float getFrequencyMinimum() const { return m_frequencyMinimum; }
|
Chris@1785
|
100 float getFrequencyMaximum() const { return m_frequencyMaximum; }
|
Chris@1785
|
101
|
Chris@1785
|
102 int getCompletion() const override { return m_completion; }
|
Chris@1785
|
103
|
Chris@1785
|
104 void setCompletion(int completion, bool update = true) {
|
Chris@1785
|
105
|
Chris@1785
|
106 { QMutexLocker locker(&m_mutex);
|
Chris@1785
|
107 if (m_completion == completion) return;
|
Chris@1785
|
108 m_completion = completion;
|
Chris@1785
|
109 }
|
Chris@1785
|
110
|
Chris@1785
|
111 if (update) {
|
Chris@1785
|
112 m_notifier.makeDeferredNotifications();
|
Chris@1785
|
113 }
|
Chris@1785
|
114
|
Chris@1785
|
115 emit completionChanged(getId());
|
Chris@1785
|
116
|
Chris@1785
|
117 if (completion == 100) {
|
Chris@1785
|
118 // henceforth:
|
Chris@1785
|
119 m_notifier.switchMode(DeferredNotifier::NOTIFY_ALWAYS);
|
Chris@1785
|
120 emit modelChanged(getId());
|
Chris@1785
|
121 }
|
Chris@1785
|
122 }
|
Chris@1785
|
123
|
Chris@1785
|
124 /**
|
Chris@1785
|
125 * Query methods.
|
Chris@1785
|
126 */
|
Chris@1785
|
127 int getEventCount() const {
|
Chris@1785
|
128 return m_events.count();
|
Chris@1785
|
129 }
|
Chris@1785
|
130 bool isEmpty() const {
|
Chris@1785
|
131 return m_events.isEmpty();
|
Chris@1785
|
132 }
|
Chris@1785
|
133 bool containsEvent(const Event &e) const {
|
Chris@1785
|
134 return m_events.contains(e);
|
Chris@1785
|
135 }
|
Chris@1785
|
136 EventVector getAllEvents() const {
|
Chris@1785
|
137 return m_events.getAllEvents();
|
Chris@1785
|
138 }
|
Chris@1785
|
139 EventVector getEventsSpanning(sv_frame_t f, sv_frame_t duration) const {
|
Chris@1785
|
140 return m_events.getEventsSpanning(f, duration);
|
Chris@1785
|
141 }
|
Chris@1785
|
142 EventVector getEventsCovering(sv_frame_t f) const {
|
Chris@1785
|
143 return m_events.getEventsCovering(f);
|
Chris@1785
|
144 }
|
Chris@1785
|
145 EventVector getEventsWithin(sv_frame_t f, sv_frame_t duration) const {
|
Chris@1785
|
146 return m_events.getEventsWithin(f, duration);
|
Chris@1785
|
147 }
|
Chris@1785
|
148 EventVector getEventsStartingWithin(sv_frame_t f, sv_frame_t duration) const {
|
Chris@1785
|
149 return m_events.getEventsStartingWithin(f, duration);
|
Chris@1785
|
150 }
|
Chris@1785
|
151 EventVector getEventsStartingAt(sv_frame_t f) const {
|
Chris@1785
|
152 return m_events.getEventsStartingAt(f);
|
Chris@1785
|
153 }
|
Chris@1785
|
154 bool getNearestEventMatching(sv_frame_t startSearchAt,
|
Chris@1785
|
155 std::function<bool(Event)> predicate,
|
Chris@1785
|
156 EventSeries::Direction direction,
|
Chris@1785
|
157 Event &found) const {
|
Chris@1785
|
158 return m_events.getNearestEventMatching
|
Chris@1785
|
159 (startSearchAt, predicate, direction, found);
|
Chris@1785
|
160 }
|
Chris@1785
|
161
|
Chris@1785
|
162 /**
|
Chris@1785
|
163 * Editing methods.
|
Chris@1785
|
164 */
|
Chris@1785
|
165 void add(Event e) override {
|
Chris@1785
|
166
|
Chris@1785
|
167 bool allChange = false;
|
Chris@1785
|
168
|
Chris@1785
|
169 {
|
Chris@1785
|
170 QMutexLocker locker(&m_mutex);
|
Chris@1785
|
171 m_events.add(e);
|
Chris@1785
|
172
|
Chris@1785
|
173 float f0 = e.getValue();
|
Chris@1785
|
174 float f1 = f0 + fabsf(e.getLevel());
|
Chris@1785
|
175
|
Chris@1785
|
176 if (!m_haveExtents || f0 < m_frequencyMinimum) {
|
Chris@1785
|
177 m_frequencyMinimum = f0; allChange = true;
|
Chris@1785
|
178 }
|
Chris@1785
|
179 if (!m_haveExtents || f1 > m_frequencyMaximum) {
|
Chris@1785
|
180 m_frequencyMaximum = f1; allChange = true;
|
Chris@1785
|
181 }
|
Chris@1785
|
182 m_haveExtents = true;
|
Chris@1785
|
183 }
|
Chris@1785
|
184
|
Chris@1785
|
185 m_notifier.update(e.getFrame(), e.getDuration() + m_resolution);
|
Chris@1785
|
186
|
Chris@1785
|
187 if (allChange) {
|
Chris@1785
|
188 emit modelChanged(getId());
|
Chris@1785
|
189 }
|
Chris@1785
|
190 }
|
Chris@1785
|
191
|
Chris@1785
|
192 void remove(Event e) override {
|
Chris@1785
|
193 {
|
Chris@1785
|
194 QMutexLocker locker(&m_mutex);
|
Chris@1785
|
195 m_events.remove(e);
|
Chris@1785
|
196 }
|
Chris@1785
|
197 emit modelChangedWithin(getId(),
|
Chris@1785
|
198 e.getFrame(),
|
Chris@1785
|
199 e.getFrame() + e.getDuration() + m_resolution);
|
Chris@1785
|
200 }
|
Chris@1785
|
201
|
Chris@1785
|
202 /**
|
Chris@1785
|
203 * TabularModel methods.
|
Chris@1785
|
204 */
|
Chris@1785
|
205
|
Chris@1785
|
206 int getRowCount() const override {
|
Chris@1785
|
207 return m_events.count();
|
Chris@1785
|
208 }
|
Chris@1785
|
209
|
Chris@1785
|
210 int getColumnCount() const override {
|
Chris@1786
|
211 return 6;
|
Chris@1785
|
212 }
|
Chris@1785
|
213
|
Chris@1785
|
214 bool isColumnTimeValue(int column) const override {
|
Chris@1785
|
215 // NB duration is not a "time value" -- that's for columns
|
Chris@1785
|
216 // whose sort ordering is exactly that of the frame time
|
Chris@1785
|
217 return (column < 2);
|
Chris@1785
|
218 }
|
Chris@1785
|
219
|
Chris@1785
|
220 sv_frame_t getFrameForRow(int row) const override {
|
Chris@1785
|
221 if (row < 0 || row >= m_events.count()) {
|
Chris@1785
|
222 return 0;
|
Chris@1785
|
223 }
|
Chris@1785
|
224 Event e = m_events.getEventByIndex(row);
|
Chris@1785
|
225 return e.getFrame();
|
Chris@1785
|
226 }
|
Chris@1785
|
227
|
Chris@1785
|
228 int getRowForFrame(sv_frame_t frame) const override {
|
Chris@1785
|
229 return m_events.getIndexForEvent(Event(frame));
|
Chris@1785
|
230 }
|
Chris@1785
|
231
|
Chris@1785
|
232 QString getHeading(int column) const override {
|
Chris@1785
|
233 switch (column) {
|
Chris@1785
|
234 case 0: return tr("Time");
|
Chris@1785
|
235 case 1: return tr("Frame");
|
Chris@1785
|
236 case 2: return tr("Duration");
|
Chris@1786
|
237 case 3: return tr("Min Freq");
|
Chris@1786
|
238 case 4: return tr("Max Freq");
|
Chris@1785
|
239 case 5: return tr("Label");
|
Chris@1785
|
240 default: return tr("Unknown");
|
Chris@1785
|
241 }
|
Chris@1785
|
242 }
|
Chris@1785
|
243
|
Chris@1785
|
244 SortType getSortType(int column) const override {
|
Chris@1785
|
245 if (column == 5) return SortAlphabetical;
|
Chris@1785
|
246 return SortNumeric;
|
Chris@1785
|
247 }
|
Chris@1785
|
248
|
Chris@1785
|
249 QVariant getData(int row, int column, int role) const override {
|
Chris@1785
|
250
|
Chris@1785
|
251 if (row < 0 || row >= m_events.count()) {
|
Chris@1785
|
252 return QVariant();
|
Chris@1785
|
253 }
|
Chris@1785
|
254
|
Chris@1785
|
255 Event e = m_events.getEventByIndex(row);
|
Chris@1785
|
256
|
Chris@1785
|
257 switch (column) {
|
Chris@1785
|
258 case 0: return adaptFrameForRole(e.getFrame(), getSampleRate(), role);
|
Chris@1785
|
259 case 1: return int(e.getFrame());
|
Chris@1785
|
260 case 2: return int(e.getDuration());
|
Chris@1785
|
261 case 3: return adaptValueForRole(e.getValue(), getScaleUnits(), role);
|
Chris@1785
|
262 case 4: return adaptValueForRole(e.getValue() + fabsf(e.getLevel()),
|
Chris@1785
|
263 getScaleUnits(), role);
|
Chris@1785
|
264 case 5: return e.getLabel();
|
Chris@1785
|
265 default: return QVariant();
|
Chris@1785
|
266 }
|
Chris@1785
|
267 }
|
Chris@1785
|
268
|
Chris@1785
|
269 Command *getSetDataCommand(int row, int column, const QVariant &value,
|
Chris@1785
|
270 int role) override {
|
Chris@1785
|
271
|
Chris@1785
|
272 if (row < 0 || row >= m_events.count()) return nullptr;
|
Chris@1785
|
273 if (role != Qt::EditRole) return nullptr;
|
Chris@1785
|
274
|
Chris@1785
|
275 Event e0 = m_events.getEventByIndex(row);
|
Chris@1785
|
276 Event e1;
|
Chris@1785
|
277
|
Chris@1785
|
278 switch (column) {
|
Chris@1785
|
279 case 0: e1 = e0.withFrame(sv_frame_t(round(value.toDouble() *
|
Chris@1785
|
280 getSampleRate()))); break;
|
Chris@1785
|
281 case 1: e1 = e0.withFrame(value.toInt()); break;
|
Chris@1785
|
282 case 2: e1 = e0.withDuration(value.toInt()); break;
|
Chris@1785
|
283 case 3: e1 = e0.withValue(float(value.toDouble())); break;
|
Chris@1785
|
284 case 4: e1 = e0.withLevel(fabsf(float(value.toDouble()) -
|
Chris@1785
|
285 e0.getValue())); break;
|
Chris@1785
|
286 case 5: e1 = e0.withLabel(value.toString()); break;
|
Chris@1785
|
287 }
|
Chris@1785
|
288
|
Chris@1785
|
289 auto command = new ChangeEventsCommand(getId().untyped, tr("Edit Data"));
|
Chris@1785
|
290 command->remove(e0);
|
Chris@1785
|
291 command->add(e1);
|
Chris@1785
|
292 return command->finish();
|
Chris@1785
|
293 }
|
Chris@1785
|
294
|
Chris@1785
|
295
|
Chris@1785
|
296 /**
|
Chris@1785
|
297 * XmlExportable methods.
|
Chris@1785
|
298 */
|
Chris@1785
|
299 void toXml(QTextStream &out,
|
Chris@1785
|
300 QString indent = "",
|
Chris@1785
|
301 QString extraAttributes = "") const override {
|
Chris@1785
|
302
|
Chris@1785
|
303 Model::toXml
|
Chris@1785
|
304 (out,
|
Chris@1785
|
305 indent,
|
Chris@1789
|
306 QString("type=\"sparse\" dimensions=\"2\" resolution=\"%1\" "
|
Chris@1785
|
307 "notifyOnAdd=\"%2\" dataset=\"%3\" subtype=\"%4\" "
|
Chris@1785
|
308 "minimum=\"%5\" maximum=\"%6\" units=\"%7\" %8")
|
Chris@1785
|
309 .arg(m_resolution)
|
Chris@1785
|
310 .arg("true") // always true after model reaches 100% -
|
Chris@1785
|
311 // subsequent events are always notified
|
Chris@1785
|
312 .arg(m_events.getExportId())
|
Chris@1789
|
313 .arg("timefrequencybox")
|
Chris@1785
|
314 .arg(m_frequencyMinimum)
|
Chris@1785
|
315 .arg(m_frequencyMaximum)
|
Chris@1785
|
316 .arg(encodeEntities(m_units))
|
Chris@1785
|
317 .arg(extraAttributes));
|
Chris@1789
|
318
|
Chris@1789
|
319 Event::ExportNameOptions options;
|
Chris@1789
|
320 options.valueAttributeName = "frequency";
|
Chris@1789
|
321 options.levelAttributeName = "extent";
|
Chris@1785
|
322
|
Chris@1789
|
323 m_events.toXml(out, indent, QString("dimensions=\"2\""), options);
|
Chris@1785
|
324 }
|
Chris@1785
|
325
|
Chris@1785
|
326 QString toDelimitedDataString(QString delimiter,
|
Chris@1789
|
327 DataExportOptions,
|
Chris@1785
|
328 sv_frame_t startFrame,
|
Chris@1785
|
329 sv_frame_t duration) const override {
|
Chris@1786
|
330
|
Chris@1786
|
331 // We need a custom format here
|
Chris@1786
|
332
|
Chris@1786
|
333 EventVector ee = m_events.getEventsSpanning(startFrame, duration);
|
Chris@1786
|
334
|
Chris@1786
|
335 QString s;
|
Chris@1786
|
336
|
Chris@1786
|
337 for (auto e: ee) {
|
Chris@1786
|
338
|
Chris@1786
|
339 QStringList list;
|
Chris@1786
|
340
|
Chris@1786
|
341 list << RealTime::frame2RealTime
|
Chris@1786
|
342 (e.getFrame(), getSampleRate())
|
Chris@1786
|
343 .toString().c_str()
|
Chris@1786
|
344 << RealTime::frame2RealTime
|
Chris@1786
|
345 (e.getFrame() + e.getDuration(), getSampleRate())
|
Chris@1786
|
346 .toString().c_str()
|
Chris@1786
|
347 << QString("%1").arg(e.getValue())
|
Chris@1786
|
348 << QString("%1").arg(e.getValue() + fabsf(e.getLevel()));
|
Chris@1786
|
349
|
Chris@1786
|
350 if (e.getLabel() != "") {
|
Chris@1786
|
351 list << e.getLabel();
|
Chris@1786
|
352 }
|
Chris@1786
|
353
|
Chris@1786
|
354 s += list.join(delimiter) + "\n";
|
Chris@1786
|
355 }
|
Chris@1786
|
356
|
Chris@1786
|
357 return s;
|
Chris@1785
|
358 }
|
Chris@1785
|
359
|
Chris@1785
|
360 protected:
|
Chris@1785
|
361 sv_samplerate_t m_sampleRate;
|
Chris@1785
|
362 int m_resolution;
|
Chris@1785
|
363
|
Chris@1785
|
364 float m_frequencyMinimum;
|
Chris@1785
|
365 float m_frequencyMaximum;
|
Chris@1785
|
366 bool m_haveExtents;
|
Chris@1785
|
367 QString m_units;
|
Chris@1785
|
368 DeferredNotifier m_notifier;
|
Chris@1785
|
369 int m_completion;
|
Chris@1785
|
370
|
Chris@1785
|
371 EventSeries m_events;
|
Chris@1785
|
372
|
Chris@1785
|
373 mutable QMutex m_mutex;
|
Chris@1785
|
374 };
|
Chris@1785
|
375
|
Chris@1785
|
376 #endif
|