annotate data/model/SparseModel.h @ 1119:e22bfe8ca248 tonioni

fixes the problem that the last note was not exported to csv
author Matthias Mauch <mail@matthiasmauch.net>
date Fri, 14 Aug 2015 18:16:14 +0100
parents 9fc8823a73e9
children 39019ce29178
rev   line source
Chris@147 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@147 2
Chris@147 3 /*
Chris@147 4 Sonic Visualiser
Chris@147 5 An audio file viewer and annotation editor.
Chris@147 6 Centre for Digital Music, Queen Mary, University of London.
Chris@147 7 This file copyright 2006 Chris Cannam.
Chris@147 8
Chris@147 9 This program is free software; you can redistribute it and/or
Chris@147 10 modify it under the terms of the GNU General Public License as
Chris@147 11 published by the Free Software Foundation; either version 2 of the
Chris@147 12 License, or (at your option) any later version. See the file
Chris@147 13 COPYING included with this distribution for more information.
Chris@147 14 */
Chris@147 15
Chris@147 16 #ifndef _SPARSE_MODEL_H_
Chris@147 17 #define _SPARSE_MODEL_H_
Chris@147 18
Chris@150 19 #include "Model.h"
Chris@420 20 #include "TabularModel.h"
Chris@147 21 #include "base/Command.h"
Chris@425 22 #include "base/RealTime.h"
Chris@147 23
Chris@147 24 #include <iostream>
Chris@147 25
Chris@147 26 #include <set>
Chris@420 27 #include <vector>
Chris@420 28 #include <algorithm>
Chris@608 29 #include <iterator>
Chris@420 30
Chris@425 31 #include <cmath>
Chris@425 32
Chris@147 33 #include <QMutex>
Chris@147 34 #include <QTextStream>
Chris@147 35
Chris@147 36 /**
Chris@147 37 * Model containing sparse data (points with some properties). The
Chris@147 38 * properties depend on the point type.
Chris@147 39 */
Chris@147 40
Chris@147 41 template <typename PointType>
Chris@420 42 class SparseModel : public Model,
Chris@420 43 public TabularModel
Chris@147 44 {
Chris@147 45 public:
Chris@1040 46 SparseModel(sv_samplerate_t sampleRate, int resolution,
Chris@147 47 bool notifyOnAdd = true);
Chris@147 48 virtual ~SparseModel() { }
Chris@147 49
Chris@147 50 virtual bool isOK() const { return true; }
Chris@1038 51 virtual sv_frame_t getStartFrame() const;
Chris@1038 52 virtual sv_frame_t getEndFrame() const;
Chris@1040 53 virtual sv_samplerate_t getSampleRate() const { return m_sampleRate; }
Chris@147 54
Chris@147 55 // Number of frames of the underlying sample rate that this model
Chris@147 56 // is capable of resolving to. For example, if m_resolution == 10
Chris@147 57 // then every point in this model will be at a multiple of 10
Chris@147 58 // sample frames and should be considered to cover a window ending
Chris@147 59 // 10 sample frames later.
Chris@929 60 virtual int getResolution() const {
Chris@147 61 return m_resolution ? m_resolution : 1;
Chris@147 62 }
Chris@929 63 virtual void setResolution(int resolution);
Chris@147 64
Chris@1066 65 // Extend the end of the model. If this is set to something beyond
Chris@1066 66 // the end of the final point in the model, then getEndFrame()
Chris@1066 67 // will return this value. Otherwise getEndFrame() will return the
Chris@1066 68 // end of the final point.
Chris@1066 69 virtual void extendEndFrame(sv_frame_t to) { m_extendTo = to; }
Chris@1066 70
Chris@147 71 typedef PointType Point;
Chris@147 72 typedef std::multiset<PointType,
Chris@147 73 typename PointType::OrderComparator> PointList;
Chris@147 74 typedef typename PointList::iterator PointListIterator;
Chris@606 75 typedef typename PointList::const_iterator PointListConstIterator;
Chris@147 76
Chris@147 77 /**
Chris@147 78 * Return whether the model is empty or not.
Chris@147 79 */
Chris@147 80 virtual bool isEmpty() const;
Chris@147 81
Chris@147 82 /**
Chris@147 83 * Get the total number of points in the model.
Chris@147 84 */
Chris@929 85 virtual int getPointCount() const;
Chris@147 86
Chris@147 87 /**
Chris@459 88 * Get all points.
Chris@459 89 */
Chris@459 90 virtual const PointList &getPoints() const;
Chris@459 91
Chris@459 92 /**
Chris@147 93 * Get all of the points in this model between the given
Chris@147 94 * boundaries (in frames), as well as up to two points before and
Chris@147 95 * after the boundaries. If you need exact boundaries, check the
Chris@147 96 * point coordinates in the returned list.
Chris@147 97 */
Chris@1038 98 virtual PointList getPoints(sv_frame_t start, sv_frame_t end) const;
Chris@147 99
Chris@147 100 /**
Chris@147 101 * Get all points that cover the given frame number, taking the
Chris@147 102 * resolution of the model into account.
Chris@147 103 */
Chris@1038 104 virtual PointList getPoints(sv_frame_t frame) const;
Chris@147 105
Chris@147 106 /**
Chris@147 107 * Return all points that share the nearest frame number prior to
Chris@147 108 * the given one at which there are any points.
Chris@147 109 */
Chris@1038 110 virtual PointList getPreviousPoints(sv_frame_t frame) const;
Chris@147 111
Chris@147 112 /**
Chris@147 113 * Return all points that share the nearest frame number
Chris@147 114 * subsequent to the given one at which there are any points.
Chris@147 115 */
Chris@1038 116 virtual PointList getNextPoints(sv_frame_t frame) const;
Chris@147 117
Chris@147 118 /**
Chris@147 119 * Remove all points.
Chris@147 120 */
Chris@147 121 virtual void clear();
Chris@147 122
Chris@147 123 /**
Chris@147 124 * Add a point.
Chris@147 125 */
Chris@147 126 virtual void addPoint(const PointType &point);
Chris@147 127
Chris@147 128 /**
Chris@147 129 * Remove a point. Points are not necessarily unique, so this
Chris@147 130 * function will remove the first point that compares equal to the
Chris@147 131 * supplied one using Point::Comparator. Other identical points
Chris@147 132 * may remain in the model.
Chris@147 133 */
Chris@147 134 virtual void deletePoint(const PointType &point);
Chris@147 135
Chris@297 136 virtual bool isReady(int *completion = 0) const {
Chris@297 137 bool ready = isOK() && (m_completion == 100);
Chris@297 138 if (completion) *completion = m_completion;
Chris@297 139 return ready;
Chris@297 140 }
Chris@297 141
Chris@333 142 virtual void setCompletion(int completion, bool update = true);
Chris@147 143 virtual int getCompletion() const { return m_completion; }
Chris@147 144
Chris@147 145 virtual bool hasTextLabels() const { return m_hasTextLabels; }
Chris@147 146
Chris@345 147 QString getTypeName() const { return tr("Sparse"); }
Chris@345 148
Chris@407 149 virtual QString getXmlOutputType() const { return "sparse"; }
Chris@407 150
Chris@147 151 virtual void toXml(QTextStream &out,
Chris@147 152 QString indent = "",
Chris@147 153 QString extraAttributes = "") const;
Chris@147 154
Chris@1060 155 virtual QString toDelimitedDataString(QString delimiter) const {
Chris@1060 156 return toDelimitedDataStringWithOptions(delimiter, DataExportDefaults);
Chris@1060 157 }
Chris@1060 158
Chris@1060 159 virtual QString toDelimitedDataStringWithOptions(QString delimiter,
Chris@1064 160 DataExportOptions opts) const {
Chris@1064 161 return toDelimitedDataStringSubsetWithOptions
Chris@1064 162 (delimiter, opts,
Chris@1064 163 std::min(getStartFrame(), sv_frame_t(0)), getEndFrame());
Chris@147 164 }
Chris@147 165
Chris@1060 166 virtual QString toDelimitedDataStringSubset(QString delimiter, sv_frame_t f0, sv_frame_t f1) const {
Chris@1060 167 return toDelimitedDataStringSubsetWithOptions(delimiter, DataExportDefaults, f0, f1);
Chris@1060 168 }
Chris@1060 169
Chris@1064 170 virtual QString toDelimitedDataStringSubsetWithOptions(QString delimiter, DataExportOptions opts, sv_frame_t f0, sv_frame_t f1) const {
Chris@1064 171 if (opts & DataExportFillGaps) {
Chris@1064 172 return toDelimitedDataStringSubsetFilled(delimiter, opts, f0, f1);
Chris@1064 173 } else {
Chris@1064 174 QString s;
Chris@1064 175 for (PointListConstIterator i = m_points.begin(); i != m_points.end(); ++i) {
mail@1119 176 if (i->frame >= f0 && i->frame <= f1) {
Chris@1064 177 s += i->toDelimitedDataString(delimiter, opts, m_sampleRate) + "\n";
Chris@1064 178 }
Chris@838 179 }
Chris@1064 180 return s;
Chris@838 181 }
Chris@838 182 }
Chris@838 183
Chris@147 184 /**
Chris@147 185 * Command to add a point, with undo.
Chris@147 186 */
Chris@147 187 class AddPointCommand : public Command
Chris@147 188 {
Chris@147 189 public:
Chris@147 190 AddPointCommand(SparseModel<PointType> *model,
Chris@147 191 const PointType &point,
Chris@147 192 QString name = "") :
Chris@147 193 m_model(model), m_point(point), m_name(name) { }
Chris@147 194
Chris@147 195 virtual QString getName() const {
Chris@147 196 return (m_name == "" ? tr("Add Point") : m_name);
Chris@147 197 }
Chris@147 198
Chris@147 199 virtual void execute() { m_model->addPoint(m_point); }
Chris@147 200 virtual void unexecute() { m_model->deletePoint(m_point); }
Chris@147 201
Chris@147 202 const PointType &getPoint() const { return m_point; }
Chris@147 203
Chris@147 204 private:
Chris@147 205 SparseModel<PointType> *m_model;
Chris@147 206 PointType m_point;
Chris@147 207 QString m_name;
Chris@147 208 };
Chris@147 209
Chris@147 210
Chris@147 211 /**
Chris@147 212 * Command to remove a point, with undo.
Chris@147 213 */
Chris@147 214 class DeletePointCommand : public Command
Chris@147 215 {
Chris@147 216 public:
Chris@147 217 DeletePointCommand(SparseModel<PointType> *model,
Chris@147 218 const PointType &point) :
Chris@147 219 m_model(model), m_point(point) { }
Chris@147 220
Chris@147 221 virtual QString getName() const { return tr("Delete Point"); }
Chris@147 222
Chris@147 223 virtual void execute() { m_model->deletePoint(m_point); }
Chris@147 224 virtual void unexecute() { m_model->addPoint(m_point); }
Chris@147 225
Chris@147 226 const PointType &getPoint() const { return m_point; }
Chris@147 227
Chris@147 228 private:
Chris@147 229 SparseModel<PointType> *m_model;
Chris@147 230 PointType m_point;
Chris@147 231 };
Chris@147 232
Chris@147 233
Chris@147 234 /**
Chris@147 235 * Command to add or remove a series of points, with undo.
Chris@147 236 * Consecutive add/remove pairs for the same point are collapsed.
Chris@147 237 */
Chris@147 238 class EditCommand : public MacroCommand
Chris@147 239 {
Chris@147 240 public:
Chris@147 241 EditCommand(SparseModel<PointType> *model, QString commandName);
Chris@147 242
Chris@147 243 virtual void addPoint(const PointType &point);
Chris@147 244 virtual void deletePoint(const PointType &point);
Chris@147 245
Chris@147 246 /**
Chris@147 247 * Stack an arbitrary other command in the same sequence.
Chris@147 248 */
Chris@147 249 virtual void addCommand(Command *command) { addCommand(command, true); }
Chris@147 250
Chris@147 251 /**
Chris@387 252 * If any points have been added or deleted, return this
Chris@387 253 * command (so the caller can add it to the command history).
Chris@416 254 * Otherwise delete the command and return NULL.
Chris@147 255 */
Chris@416 256 virtual EditCommand *finish();
Chris@147 257
Chris@147 258 protected:
Chris@147 259 virtual void addCommand(Command *command, bool executeFirst);
Chris@147 260
Chris@147 261 SparseModel<PointType> *m_model;
Chris@147 262 };
Chris@147 263
Chris@147 264
Chris@147 265 /**
Chris@147 266 * Command to relabel a point.
Chris@147 267 */
Chris@147 268 class RelabelCommand : public Command
Chris@147 269 {
Chris@147 270 public:
Chris@147 271 RelabelCommand(SparseModel<PointType> *model,
Chris@147 272 const PointType &point,
Chris@147 273 QString newLabel) :
Chris@147 274 m_model(model), m_oldPoint(point), m_newPoint(point) {
Chris@147 275 m_newPoint.label = newLabel;
Chris@147 276 }
Chris@147 277
Chris@147 278 virtual QString getName() const { return tr("Re-Label Point"); }
Chris@147 279
Chris@147 280 virtual void execute() {
Chris@147 281 m_model->deletePoint(m_oldPoint);
Chris@147 282 m_model->addPoint(m_newPoint);
Chris@147 283 std::swap(m_oldPoint, m_newPoint);
Chris@147 284 }
Chris@147 285
Chris@147 286 virtual void unexecute() { execute(); }
Chris@147 287
Chris@147 288 private:
Chris@147 289 SparseModel<PointType> *m_model;
Chris@147 290 PointType m_oldPoint;
Chris@147 291 PointType m_newPoint;
Chris@147 292 };
Chris@147 293
Chris@420 294 /**
Chris@420 295 * TabularModel methods.
Chris@420 296 */
Chris@420 297
Chris@420 298 virtual int getRowCount() const
Chris@420 299 {
Chris@1038 300 return int(m_points.size());
Chris@420 301 }
Chris@420 302
Chris@1038 303 virtual sv_frame_t getFrameForRow(int row) const
Chris@420 304 {
Chris@606 305 PointListConstIterator i = getPointListIteratorForRow(row);
Chris@420 306 if (i == m_points.end()) return 0;
Chris@420 307 return i->frame;
Chris@420 308 }
Chris@420 309
Chris@1038 310 virtual int getRowForFrame(sv_frame_t frame) const
Chris@420 311 {
Chris@420 312 if (m_rows.empty()) rebuildRowVector();
Chris@1038 313 std::vector<sv_frame_t>::iterator i =
Chris@420 314 std::lower_bound(m_rows.begin(), m_rows.end(), frame);
Chris@1038 315 ssize_t row = std::distance(m_rows.begin(), i);
Chris@432 316 if (i != m_rows.begin() && (i == m_rows.end() || *i != frame)) {
Chris@432 317 --row;
Chris@432 318 }
Chris@1038 319 return int(row);
Chris@420 320 }
Chris@420 321
Chris@420 322 virtual int getColumnCount() const { return 1; }
Chris@425 323 virtual QVariant getData(int row, int column, int role) const
Chris@425 324 {
Chris@606 325 PointListConstIterator i = getPointListIteratorForRow(row);
Chris@425 326 if (i == m_points.end()) return QVariant();
Chris@425 327
Chris@425 328 switch (column) {
Chris@425 329 case 0: {
Chris@425 330 if (role == SortRole) return int(i->frame);
Chris@425 331 RealTime rt = RealTime::frame2RealTime(i->frame, getSampleRate());
Chris@425 332 if (role == Qt::EditRole) return rt.toString().c_str();
Chris@425 333 else return rt.toText().c_str();
Chris@425 334 }
Chris@425 335 case 1: return int(i->frame);
Chris@425 336 }
Chris@425 337
Chris@420 338 return QVariant();
Chris@420 339 }
Chris@427 340
Chris@425 341 virtual Command *getSetDataCommand(int row, int column,
Chris@425 342 const QVariant &value, int role)
Chris@425 343 {
Chris@740 344 if (role != Qt::EditRole) return 0;
Chris@425 345 PointListIterator i = getPointListIteratorForRow(row);
Chris@740 346 if (i == m_points.end()) return 0;
Chris@425 347 EditCommand *command = new EditCommand(this, tr("Edit Data"));
Chris@425 348
Chris@425 349 Point point(*i);
Chris@425 350 command->deletePoint(point);
Chris@425 351
Chris@425 352 switch (column) {
Chris@425 353 case 0: point.frame = lrint(value.toDouble() * getSampleRate()); break;
Chris@425 354 case 1: point.frame = value.toInt(); break;
Chris@425 355 }
Chris@425 356
Chris@425 357 command->addPoint(point);
Chris@425 358 return command->finish();
Chris@425 359 }
Chris@425 360
Chris@427 361 virtual Command *getInsertRowCommand(int row)
Chris@427 362 {
Chris@427 363 EditCommand *command = new EditCommand(this, tr("Insert Data Point"));
Chris@427 364 Point point(0);
Chris@427 365 PointListIterator i = getPointListIteratorForRow(row);
Chris@427 366 if (i == m_points.end() && i != m_points.begin()) --i;
Chris@427 367 if (i != m_points.end()) point = *i;
Chris@427 368 command->addPoint(point);
Chris@427 369 return command->finish();
Chris@427 370 }
Chris@427 371
Chris@427 372 virtual Command *getRemoveRowCommand(int row)
Chris@427 373 {
Chris@427 374 PointListIterator i = getPointListIteratorForRow(row);
Chris@427 375 if (i == m_points.end()) return 0;
Chris@978 376 EditCommand *command = new EditCommand(this, tr("Delete Data Point"));
Chris@427 377 command->deletePoint(*i);
Chris@427 378 return command->finish();
Chris@427 379 }
Chris@427 380
Chris@147 381 protected:
Chris@1040 382 sv_samplerate_t m_sampleRate;
Chris@929 383 int m_resolution;
Chris@1066 384 sv_frame_t m_extendTo;
Chris@147 385 bool m_notifyOnAdd;
Chris@1038 386 sv_frame_t m_sinceLastNotifyMin;
Chris@1038 387 sv_frame_t m_sinceLastNotifyMax;
Chris@147 388 bool m_hasTextLabels;
Chris@147 389
Chris@147 390 PointList m_points;
Chris@929 391 int m_pointCount;
Chris@147 392 mutable QMutex m_mutex;
Chris@147 393 int m_completion;
Chris@420 394
Chris@1038 395 void getPointIterators(sv_frame_t frame,
Chris@420 396 PointListIterator &startItr,
Chris@608 397 PointListIterator &endItr);
Chris@1038 398 void getPointIterators(sv_frame_t frame,
Chris@608 399 PointListConstIterator &startItr,
Chris@608 400 PointListConstIterator &endItr) const;
Chris@420 401
Chris@420 402 // This is only used if the model is called on to act in
Chris@420 403 // TabularModel mode
Chris@1038 404 mutable std::vector<sv_frame_t> m_rows; // map from row number to frame
Chris@420 405 void rebuildRowVector() const
Chris@420 406 {
Chris@420 407 m_rows.clear();
Chris@608 408 for (PointListConstIterator i = m_points.begin(); i != m_points.end(); ++i) {
Chris@777 409 // std::cerr << "rebuildRowVector: row " << m_rows.size() << " -> " << i->frame << std::endl;
Chris@420 410 m_rows.push_back(i->frame);
Chris@420 411 }
Chris@420 412 }
Chris@420 413
Chris@608 414 PointListIterator getPointListIteratorForRow(int row)
Chris@420 415 {
Chris@420 416 if (m_rows.empty()) rebuildRowVector();
Chris@425 417 if (row < 0 || row + 1 > int(m_rows.size())) return m_points.end();
Chris@420 418
Chris@1038 419 sv_frame_t frame = m_rows[row];
Chris@420 420 int indexAtFrame = 0;
Chris@420 421 int ri = row;
Chris@420 422 while (ri > 0 && m_rows[ri-1] == m_rows[row]) { --ri; ++indexAtFrame; }
Chris@420 423 int initialIndexAtFrame = indexAtFrame;
Chris@420 424
Chris@420 425 PointListIterator i0, i1;
Chris@420 426 getPointIterators(frame, i0, i1);
Chris@420 427 PointListIterator i = i0;
Chris@420 428
Chris@420 429 for (i = i0; i != i1; ++i) {
Chris@778 430 if (i->frame < (int)frame) { continue; }
Chris@420 431 if (indexAtFrame > 0) { --indexAtFrame; continue; }
Chris@420 432 return i;
Chris@420 433 }
Chris@420 434
Chris@420 435 if (indexAtFrame > 0) {
Chris@420 436 std::cerr << "WARNING: SparseModel::getPointListIteratorForRow: No iterator available for row " << row << " (frame = " << frame << ", index at frame = " << initialIndexAtFrame << ", leftover index " << indexAtFrame << ")" << std::endl;
Chris@420 437 }
Chris@420 438 return i;
Chris@420 439 }
Chris@608 440
Chris@608 441 PointListConstIterator getPointListIteratorForRow(int row) const
Chris@608 442 {
Chris@608 443 if (m_rows.empty()) rebuildRowVector();
Chris@608 444 if (row < 0 || row + 1 > int(m_rows.size())) return m_points.end();
Chris@608 445
Chris@1038 446 sv_frame_t frame = m_rows[row];
Chris@608 447 int indexAtFrame = 0;
Chris@608 448 int ri = row;
Chris@608 449 while (ri > 0 && m_rows[ri-1] == m_rows[row]) { --ri; ++indexAtFrame; }
Chris@608 450 int initialIndexAtFrame = indexAtFrame;
Chris@608 451
Chris@777 452 // std::cerr << "getPointListIteratorForRow " << row << ": initialIndexAtFrame = " << initialIndexAtFrame << std::endl;
Chris@777 453
Chris@608 454 PointListConstIterator i0, i1;
Chris@608 455 getPointIterators(frame, i0, i1);
Chris@608 456 PointListConstIterator i = i0;
Chris@608 457
Chris@608 458 for (i = i0; i != i1; ++i) {
Chris@785 459 // std::cerr << "i->frame is " << i->frame << ", wanting " << frame << std::endl;
Chris@785 460
Chris@778 461 if (i->frame < (int)frame) { continue; }
Chris@608 462 if (indexAtFrame > 0) { --indexAtFrame; continue; }
Chris@608 463 return i;
Chris@608 464 }
Chris@608 465
Chris@785 466 // std::cerr << "returning i with i->frame = " << i->frame << std::endl;
Chris@785 467
Chris@608 468 if (indexAtFrame > 0) {
Chris@608 469 std::cerr << "WARNING: SparseModel::getPointListIteratorForRow: No iterator available for row " << row << " (frame = " << frame << ", index at frame = " << initialIndexAtFrame << ", leftover index " << indexAtFrame << ")" << std::endl;
Chris@608 470 }
Chris@608 471 return i;
Chris@608 472 }
Chris@1064 473
Chris@1064 474 QString toDelimitedDataStringSubsetFilled(QString delimiter,
Chris@1064 475 DataExportOptions opts,
Chris@1064 476 sv_frame_t f0,
Chris@1064 477 sv_frame_t f1) const {
Chris@1064 478
Chris@1064 479 QString s;
Chris@1064 480 opts &= ~DataExportFillGaps;
Chris@1064 481
Chris@1064 482 // find frame time of first point in range (if any)
Chris@1064 483 sv_frame_t first = f0;
Chris@1064 484 for (auto &p: m_points) {
Chris@1064 485 if (p.frame >= f0) {
Chris@1064 486 first = p.frame;
Chris@1064 487 break;
Chris@1064 488 }
Chris@1064 489 }
Chris@1064 490
Chris@1064 491 // project back to first frame time in range according to
Chris@1064 492 // resolution. e.g. if f0 = 2, first = 9, resolution = 4 then
Chris@1064 493 // we start at 5 (because 1 is too early and we need to arrive
Chris@1064 494 // at 9 to match the first actual point). This method is
Chris@1064 495 // stupid but easy to understand:
Chris@1064 496 sv_frame_t f = first;
Chris@1064 497 while (f >= f0 + m_resolution) f -= m_resolution;
Chris@1064 498
Chris@1064 499 // now progress, either writing the next point (if within
Chris@1064 500 // distance) or a default point
Chris@1064 501 PointListConstIterator itr = m_points.begin();
Chris@1064 502
Chris@1064 503 while (f < f1) {
Chris@1064 504 if (itr != m_points.end() && itr->frame <= f) {
Chris@1064 505 s += itr->toDelimitedDataString(delimiter, opts, m_sampleRate);
Chris@1064 506 ++itr;
Chris@1064 507 } else {
Chris@1064 508 s += Point(f).toDelimitedDataString(delimiter, opts, m_sampleRate);
Chris@1064 509 }
Chris@1064 510 s += "\n";
Chris@1064 511 f += m_resolution;
Chris@1064 512 }
Chris@1064 513
Chris@1064 514 return s;
Chris@1064 515 }
Chris@147 516 };
Chris@147 517
Chris@147 518
Chris@147 519 template <typename PointType>
Chris@1040 520 SparseModel<PointType>::SparseModel(sv_samplerate_t sampleRate,
Chris@929 521 int resolution,
Chris@147 522 bool notifyOnAdd) :
Chris@147 523 m_sampleRate(sampleRate),
Chris@147 524 m_resolution(resolution),
Chris@1066 525 m_extendTo(0),
Chris@147 526 m_notifyOnAdd(notifyOnAdd),
Chris@147 527 m_sinceLastNotifyMin(-1),
Chris@147 528 m_sinceLastNotifyMax(-1),
Chris@147 529 m_hasTextLabels(false),
Chris@147 530 m_pointCount(0),
Chris@147 531 m_completion(100)
Chris@147 532 {
Chris@147 533 }
Chris@147 534
Chris@147 535 template <typename PointType>
Chris@1038 536 sv_frame_t
Chris@147 537 SparseModel<PointType>::getStartFrame() const
Chris@147 538 {
Chris@147 539 QMutexLocker locker(&m_mutex);
Chris@1038 540 sv_frame_t f = 0;
Chris@147 541 if (!m_points.empty()) {
Chris@147 542 f = m_points.begin()->frame;
Chris@147 543 }
Chris@147 544 return f;
Chris@147 545 }
Chris@147 546
Chris@147 547 template <typename PointType>
Chris@1038 548 sv_frame_t
Chris@147 549 SparseModel<PointType>::getEndFrame() const
Chris@147 550 {
Chris@147 551 QMutexLocker locker(&m_mutex);
Chris@1038 552 sv_frame_t f = 0;
Chris@147 553 if (!m_points.empty()) {
mail@1119 554 PointListConstIterator i(m_points.end());
mail@1119 555 f = (--i)->frame;
Chris@147 556 }
Chris@1066 557 if (m_extendTo > f) return m_extendTo;
Chris@1066 558 else return f;
Chris@147 559 }
Chris@147 560
Chris@147 561 template <typename PointType>
Chris@147 562 bool
Chris@147 563 SparseModel<PointType>::isEmpty() const
Chris@147 564 {
Chris@147 565 return m_pointCount == 0;
Chris@147 566 }
Chris@147 567
Chris@147 568 template <typename PointType>
Chris@929 569 int
Chris@147 570 SparseModel<PointType>::getPointCount() const
Chris@147 571 {
Chris@147 572 return m_pointCount;
Chris@147 573 }
Chris@147 574
Chris@147 575 template <typename PointType>
Chris@459 576 const typename SparseModel<PointType>::PointList &
Chris@459 577 SparseModel<PointType>::getPoints() const
Chris@459 578 {
Chris@459 579 return m_points;
Chris@459 580 }
Chris@459 581
Chris@459 582 template <typename PointType>
Chris@147 583 typename SparseModel<PointType>::PointList
Chris@1038 584 SparseModel<PointType>::getPoints(sv_frame_t start, sv_frame_t end) const
Chris@147 585 {
Chris@147 586 if (start > end) return PointList();
Chris@147 587 QMutexLocker locker(&m_mutex);
Chris@147 588
Chris@147 589 PointType startPoint(start), endPoint(end);
Chris@147 590
Chris@608 591 PointListConstIterator startItr = m_points.lower_bound(startPoint);
Chris@608 592 PointListConstIterator endItr = m_points.upper_bound(endPoint);
Chris@147 593
Chris@147 594 if (startItr != m_points.begin()) --startItr;
Chris@147 595 if (startItr != m_points.begin()) --startItr;
Chris@147 596 if (endItr != m_points.end()) ++endItr;
Chris@147 597 if (endItr != m_points.end()) ++endItr;
Chris@147 598
Chris@147 599 PointList rv;
Chris@147 600
Chris@608 601 for (PointListConstIterator i = startItr; i != endItr; ++i) {
Chris@147 602 rv.insert(*i);
Chris@147 603 }
Chris@147 604
Chris@147 605 return rv;
Chris@147 606 }
Chris@147 607
Chris@147 608 template <typename PointType>
Chris@147 609 typename SparseModel<PointType>::PointList
Chris@1038 610 SparseModel<PointType>::getPoints(sv_frame_t frame) const
Chris@147 611 {
Chris@608 612 PointListConstIterator startItr, endItr;
Chris@420 613 getPointIterators(frame, startItr, endItr);
Chris@147 614
Chris@147 615 PointList rv;
Chris@147 616
Chris@608 617 for (PointListConstIterator i = startItr; i != endItr; ++i) {
Chris@147 618 rv.insert(*i);
Chris@147 619 }
Chris@147 620
Chris@147 621 return rv;
Chris@147 622 }
Chris@147 623
Chris@147 624 template <typename PointType>
Chris@420 625 void
Chris@1038 626 SparseModel<PointType>::getPointIterators(sv_frame_t frame,
Chris@420 627 PointListIterator &startItr,
Chris@608 628 PointListIterator &endItr)
Chris@608 629 {
Chris@608 630 QMutexLocker locker(&m_mutex);
Chris@608 631
Chris@608 632 if (m_resolution == 0) {
Chris@608 633 startItr = m_points.end();
Chris@608 634 endItr = m_points.end();
Chris@608 635 return;
Chris@608 636 }
Chris@608 637
Chris@1038 638 sv_frame_t start = (frame / m_resolution) * m_resolution;
Chris@1038 639 sv_frame_t end = start + m_resolution;
Chris@608 640
Chris@608 641 PointType startPoint(start), endPoint(end);
Chris@777 642
Chris@608 643 startItr = m_points.lower_bound(startPoint);
Chris@608 644 endItr = m_points.upper_bound(endPoint);
Chris@608 645 }
Chris@608 646
Chris@608 647 template <typename PointType>
Chris@608 648 void
Chris@1038 649 SparseModel<PointType>::getPointIterators(sv_frame_t frame,
Chris@608 650 PointListConstIterator &startItr,
Chris@608 651 PointListConstIterator &endItr) const
Chris@420 652 {
Chris@420 653 QMutexLocker locker(&m_mutex);
Chris@420 654
Chris@420 655 if (m_resolution == 0) {
Chris@785 656 // std::cerr << "getPointIterators: resolution == 0, returning end()" << std::endl;
Chris@420 657 startItr = m_points.end();
Chris@420 658 endItr = m_points.end();
Chris@420 659 return;
Chris@420 660 }
Chris@420 661
Chris@1038 662 sv_frame_t start = (frame / m_resolution) * m_resolution;
Chris@1038 663 sv_frame_t end = start + m_resolution;
Chris@420 664
Chris@420 665 PointType startPoint(start), endPoint(end);
Chris@420 666
Chris@777 667 // std::cerr << "getPointIterators: start frame " << start << ", end frame " << end << ", m_resolution " << m_resolution << std::endl;
Chris@785 668
Chris@420 669 startItr = m_points.lower_bound(startPoint);
Chris@420 670 endItr = m_points.upper_bound(endPoint);
Chris@420 671 }
Chris@420 672
Chris@420 673 template <typename PointType>
Chris@147 674 typename SparseModel<PointType>::PointList
Chris@1038 675 SparseModel<PointType>::getPreviousPoints(sv_frame_t originFrame) const
Chris@147 676 {
Chris@147 677 QMutexLocker locker(&m_mutex);
Chris@147 678
Chris@147 679 PointType lookupPoint(originFrame);
Chris@147 680 PointList rv;
Chris@147 681
Chris@608 682 PointListConstIterator i = m_points.lower_bound(lookupPoint);
Chris@147 683 if (i == m_points.begin()) return rv;
Chris@147 684
Chris@147 685 --i;
Chris@1038 686 sv_frame_t frame = i->frame;
Chris@147 687 while (i->frame == frame) {
Chris@147 688 rv.insert(*i);
Chris@147 689 if (i == m_points.begin()) break;
Chris@147 690 --i;
Chris@147 691 }
Chris@147 692
Chris@147 693 return rv;
Chris@147 694 }
Chris@147 695
Chris@147 696 template <typename PointType>
Chris@147 697 typename SparseModel<PointType>::PointList
Chris@1038 698 SparseModel<PointType>::getNextPoints(sv_frame_t originFrame) const
Chris@147 699 {
Chris@147 700 QMutexLocker locker(&m_mutex);
Chris@147 701
Chris@147 702 PointType lookupPoint(originFrame);
Chris@147 703 PointList rv;
Chris@147 704
Chris@608 705 PointListConstIterator i = m_points.upper_bound(lookupPoint);
Chris@147 706 if (i == m_points.end()) return rv;
Chris@147 707
Chris@1038 708 sv_frame_t frame = i->frame;
Chris@147 709 while (i != m_points.end() && i->frame == frame) {
Chris@147 710 rv.insert(*i);
Chris@147 711 ++i;
Chris@147 712 }
Chris@147 713
Chris@147 714 return rv;
Chris@147 715 }
Chris@147 716
Chris@147 717 template <typename PointType>
Chris@147 718 void
Chris@929 719 SparseModel<PointType>::setResolution(int resolution)
Chris@147 720 {
Chris@147 721 {
Chris@147 722 QMutexLocker locker(&m_mutex);
Chris@147 723 m_resolution = resolution;
Chris@147 724 }
Chris@420 725 m_rows.clear();
Chris@147 726 emit modelChanged();
Chris@147 727 }
Chris@147 728
Chris@147 729 template <typename PointType>
Chris@147 730 void
Chris@147 731 SparseModel<PointType>::clear()
Chris@147 732 {
Chris@147 733 {
Chris@147 734 QMutexLocker locker(&m_mutex);
Chris@147 735 m_points.clear();
Chris@147 736 m_pointCount = 0;
Chris@147 737 }
Chris@420 738 m_rows.clear();
Chris@147 739 emit modelChanged();
Chris@147 740 }
Chris@147 741
Chris@147 742 template <typename PointType>
Chris@147 743 void
Chris@147 744 SparseModel<PointType>::addPoint(const PointType &point)
Chris@147 745 {
Chris@147 746 {
Chris@147 747 QMutexLocker locker(&m_mutex);
Chris@147 748 m_points.insert(point);
Chris@147 749 m_pointCount++;
Chris@338 750 if (point.getLabel() != "") m_hasTextLabels = true;
Chris@147 751 }
Chris@147 752
Chris@147 753 // Even though this model is nominally sparse, there may still be
Chris@147 754 // too many signals going on here (especially as they'll probably
Chris@147 755 // be queued from one thread to another), which is why we need the
Chris@147 756 // notifyOnAdd as an option rather than a necessity (the
Chris@147 757 // alternative is to notify on setCompletion).
Chris@147 758
Chris@147 759 if (m_notifyOnAdd) {
Chris@420 760 m_rows.clear(); //!!! inefficient
Chris@931 761 emit modelChangedWithin(point.frame, point.frame + m_resolution);
Chris@147 762 } else {
Chris@147 763 if (m_sinceLastNotifyMin == -1 ||
Chris@147 764 point.frame < m_sinceLastNotifyMin) {
Chris@147 765 m_sinceLastNotifyMin = point.frame;
Chris@147 766 }
Chris@147 767 if (m_sinceLastNotifyMax == -1 ||
Chris@147 768 point.frame > m_sinceLastNotifyMax) {
Chris@147 769 m_sinceLastNotifyMax = point.frame;
Chris@147 770 }
Chris@147 771 }
Chris@147 772 }
Chris@147 773
Chris@147 774 template <typename PointType>
Chris@147 775 void
Chris@147 776 SparseModel<PointType>::deletePoint(const PointType &point)
Chris@147 777 {
Chris@147 778 {
Chris@147 779 QMutexLocker locker(&m_mutex);
Chris@147 780
Chris@147 781 PointListIterator i = m_points.lower_bound(point);
Chris@147 782 typename PointType::Comparator comparator;
Chris@147 783 while (i != m_points.end()) {
Chris@147 784 if (i->frame > point.frame) break;
Chris@147 785 if (!comparator(*i, point) && !comparator(point, *i)) {
Chris@147 786 m_points.erase(i);
Chris@147 787 m_pointCount--;
Chris@147 788 break;
Chris@147 789 }
Chris@147 790 ++i;
Chris@147 791 }
Chris@147 792 }
Chris@147 793 // std::cout << "SparseOneDimensionalModel: emit modelChanged("
Chris@147 794 // << point.frame << ")" << std::endl;
Chris@420 795 m_rows.clear(); //!!! inefficient
Chris@931 796 emit modelChangedWithin(point.frame, point.frame + m_resolution);
Chris@147 797 }
Chris@147 798
Chris@147 799 template <typename PointType>
Chris@147 800 void
Chris@333 801 SparseModel<PointType>::setCompletion(int completion, bool update)
Chris@147 802 {
Chris@301 803 // std::cerr << "SparseModel::setCompletion(" << completion << ")" << std::endl;
Chris@191 804
Chris@147 805 if (m_completion != completion) {
Chris@147 806 m_completion = completion;
Chris@147 807
Chris@147 808 if (completion == 100) {
Chris@147 809
Chris@297 810 if (!m_notifyOnAdd) {
Chris@297 811 emit completionChanged();
Chris@297 812 }
Chris@297 813
Chris@147 814 m_notifyOnAdd = true; // henceforth
Chris@420 815 m_rows.clear(); //!!! inefficient
Chris@147 816 emit modelChanged();
Chris@147 817
Chris@147 818 } else if (!m_notifyOnAdd) {
Chris@147 819
Chris@333 820 if (update &&
Chris@333 821 m_sinceLastNotifyMin >= 0 &&
Chris@147 822 m_sinceLastNotifyMax >= 0) {
Chris@420 823 m_rows.clear(); //!!! inefficient
Chris@931 824 emit modelChangedWithin(m_sinceLastNotifyMin, m_sinceLastNotifyMax);
Chris@147 825 m_sinceLastNotifyMin = m_sinceLastNotifyMax = -1;
Chris@147 826 } else {
Chris@147 827 emit completionChanged();
Chris@147 828 }
Chris@147 829 } else {
Chris@147 830 emit completionChanged();
Chris@147 831 }
Chris@147 832 }
Chris@147 833 }
Chris@147 834
Chris@147 835 template <typename PointType>
Chris@147 836 void
Chris@147 837 SparseModel<PointType>::toXml(QTextStream &out,
Chris@147 838 QString indent,
Chris@147 839 QString extraAttributes) const
Chris@147 840 {
Chris@777 841 // std::cerr << "SparseModel::toXml: extraAttributes = \""
Chris@777 842 // << extraAttributes.toStdString() << std::endl;
Chris@318 843
Chris@407 844 QString type = getXmlOutputType();
Chris@407 845
Chris@147 846 Model::toXml
Chris@147 847 (out,
Chris@147 848 indent,
Chris@407 849 QString("type=\"%1\" dimensions=\"%2\" resolution=\"%3\" notifyOnAdd=\"%4\" dataset=\"%5\" %6")
Chris@407 850 .arg(type)
Chris@147 851 .arg(PointType(0).getDimensions())
Chris@147 852 .arg(m_resolution)
Chris@147 853 .arg(m_notifyOnAdd ? "true" : "false")
Chris@147 854 .arg(getObjectExportId(&m_points))
Chris@147 855 .arg(extraAttributes));
Chris@147 856
Chris@147 857 out << indent;
Chris@147 858 out << QString("<dataset id=\"%1\" dimensions=\"%2\">\n")
Chris@147 859 .arg(getObjectExportId(&m_points))
Chris@147 860 .arg(PointType(0).getDimensions());
Chris@147 861
Chris@608 862 for (PointListConstIterator i = m_points.begin(); i != m_points.end(); ++i) {
Chris@314 863 i->toXml(out, indent + " ");
Chris@147 864 }
Chris@147 865
Chris@147 866 out << indent;
Chris@147 867 out << "</dataset>\n";
Chris@147 868 }
Chris@147 869
Chris@147 870 template <typename PointType>
Chris@147 871 SparseModel<PointType>::EditCommand::EditCommand(SparseModel *model,
Chris@147 872 QString commandName) :
Chris@147 873 MacroCommand(commandName),
Chris@147 874 m_model(model)
Chris@147 875 {
Chris@147 876 }
Chris@147 877
Chris@147 878 template <typename PointType>
Chris@147 879 void
Chris@147 880 SparseModel<PointType>::EditCommand::addPoint(const PointType &point)
Chris@147 881 {
Chris@147 882 addCommand(new AddPointCommand(m_model, point), true);
Chris@147 883 }
Chris@147 884
Chris@147 885 template <typename PointType>
Chris@147 886 void
Chris@147 887 SparseModel<PointType>::EditCommand::deletePoint(const PointType &point)
Chris@147 888 {
Chris@147 889 addCommand(new DeletePointCommand(m_model, point), true);
Chris@147 890 }
Chris@147 891
Chris@147 892 template <typename PointType>
Chris@416 893 typename SparseModel<PointType>::EditCommand *
Chris@147 894 SparseModel<PointType>::EditCommand::finish()
Chris@147 895 {
Chris@147 896 if (!m_commands.empty()) {
Chris@387 897 return this;
Chris@147 898 } else {
Chris@147 899 delete this;
Chris@389 900 return 0;
Chris@147 901 }
Chris@147 902 }
Chris@147 903
Chris@147 904 template <typename PointType>
Chris@147 905 void
Chris@147 906 SparseModel<PointType>::EditCommand::addCommand(Command *command,
Chris@147 907 bool executeFirst)
Chris@147 908 {
Chris@147 909 if (executeFirst) command->execute();
Chris@147 910
Chris@147 911 if (!m_commands.empty()) {
Chris@147 912 DeletePointCommand *dpc = dynamic_cast<DeletePointCommand *>(command);
Chris@147 913 if (dpc) {
Chris@147 914 AddPointCommand *apc = dynamic_cast<AddPointCommand *>
Chris@147 915 (m_commands[m_commands.size() - 1]);
Chris@147 916 typename PointType::Comparator comparator;
Chris@147 917 if (apc) {
Chris@147 918 if (!comparator(apc->getPoint(), dpc->getPoint()) &&
Chris@147 919 !comparator(dpc->getPoint(), apc->getPoint())) {
Chris@147 920 deleteCommand(apc);
Chris@147 921 return;
Chris@147 922 }
Chris@147 923 }
Chris@147 924 }
Chris@147 925 }
Chris@147 926
Chris@147 927 MacroCommand::addCommand(command);
Chris@147 928 }
Chris@147 929
Chris@147 930
Chris@147 931 #endif
Chris@147 932
Chris@147 933
Chris@147 934