annotate data/model/SparseModel.h @ 1060:57633d605547 tonioni

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