annotate data/model/EditableDenseThreeDimensionalModel.h @ 1151:def42cbba8bc 3.0-integration

Adjust locking when filling range cache in background thread, so as to spend less time waiting on locks
author Chris Cannam
date Fri, 22 Jan 2016 09:52:30 +0000
parents 1517d4c60e88
children aa588c391d1a
rev   line source
Chris@152 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@152 2
Chris@152 3 /*
Chris@152 4 Sonic Visualiser
Chris@152 5 An audio file viewer and annotation editor.
Chris@152 6 Centre for Digital Music, Queen Mary, University of London.
Chris@202 7 This file copyright 2006 Chris Cannam and QMUL.
Chris@152 8
Chris@152 9 This program is free software; you can redistribute it and/or
Chris@152 10 modify it under the terms of the GNU General Public License as
Chris@152 11 published by the Free Software Foundation; either version 2 of the
Chris@152 12 License, or (at your option) any later version. See the file
Chris@152 13 COPYING included with this distribution for more information.
Chris@152 14 */
Chris@152 15
Chris@152 16 #ifndef _EDITABLE_DENSE_THREE_DIMENSIONAL_MODEL_H_
Chris@152 17 #define _EDITABLE_DENSE_THREE_DIMENSIONAL_MODEL_H_
Chris@152 18
Chris@152 19 #include "DenseThreeDimensionalModel.h"
Chris@152 20
Chris@536 21 #include <QReadWriteLock>
Chris@536 22
Chris@533 23 #include <vector>
Chris@533 24
Chris@152 25 class EditableDenseThreeDimensionalModel : public DenseThreeDimensionalModel
Chris@152 26 {
Chris@152 27 Q_OBJECT
Chris@152 28
Chris@152 29 public:
Chris@535 30
Chris@535 31 // EditableDenseThreeDimensionalModel supports a basic compression
Chris@535 32 // method that reduces the size of multirate data (e.g. wavelet
Chris@535 33 // transform outputs) that are stored as plain 3d grids by about
Chris@535 34 // 60% or thereabouts. However, it can only be used for models
Chris@535 35 // whose columns are set in order from 0 and never subsequently
Chris@535 36 // changed. If the model is going to be actually edited, it must
Chris@535 37 // have NoCompression.
Chris@535 38
Chris@535 39 enum CompressionType
Chris@535 40 {
Chris@535 41 NoCompression,
Chris@535 42 BasicMultirateCompression
Chris@535 43 };
Chris@535 44
Chris@1040 45 EditableDenseThreeDimensionalModel(sv_samplerate_t sampleRate,
Chris@929 46 int resolution,
Chris@929 47 int yBinCount,
Chris@535 48 CompressionType compression,
Chris@152 49 bool notifyOnAdd = true);
Chris@152 50
Chris@152 51 virtual bool isOK() const;
Chris@152 52
Chris@1040 53 virtual sv_samplerate_t getSampleRate() const;
Chris@1038 54 virtual sv_frame_t getStartFrame() const;
Chris@1038 55 virtual sv_frame_t getEndFrame() const;
Chris@152 56
Chris@152 57 /**
Chris@611 58 * Set the frame offset of the first column.
Chris@611 59 */
Chris@1038 60 virtual void setStartFrame(sv_frame_t);
Chris@611 61
Chris@611 62 /**
Chris@152 63 * Return the number of sample frames covered by each set of bins.
Chris@152 64 */
Chris@929 65 virtual int getResolution() const;
Chris@152 66
Chris@152 67 /**
Chris@152 68 * Set the number of sample frames covered by each set of bins.
Chris@152 69 */
Chris@929 70 virtual void setResolution(int sz);
Chris@152 71
Chris@152 72 /**
Chris@182 73 * Return the number of columns.
Chris@182 74 */
Chris@929 75 virtual int getWidth() const;
Chris@182 76
Chris@182 77 /**
Chris@152 78 * Return the number of bins in each set of bins.
Chris@152 79 */
Chris@929 80 virtual int getHeight() const;
Chris@152 81
Chris@152 82 /**
Chris@152 83 * Set the number of bins in each set of bins.
Chris@152 84 */
Chris@929 85 virtual void setHeight(int sz);
Chris@152 86
Chris@152 87 /**
Chris@152 88 * Return the minimum value of the value in each bin.
Chris@152 89 */
Chris@152 90 virtual float getMinimumLevel() const;
Chris@152 91
Chris@152 92 /**
Chris@152 93 * Set the minimum value of the value in a bin.
Chris@152 94 */
Chris@152 95 virtual void setMinimumLevel(float sz);
Chris@152 96
Chris@152 97 /**
Chris@152 98 * Return the maximum value of the value in each bin.
Chris@152 99 */
Chris@152 100 virtual float getMaximumLevel() const;
Chris@152 101
Chris@152 102 /**
Chris@152 103 * Set the maximum value of the value in a bin.
Chris@152 104 */
Chris@152 105 virtual void setMaximumLevel(float sz);
Chris@152 106
Chris@182 107 /**
Chris@182 108 * Return true if there are data available for the given column.
Chris@182 109 */
Chris@929 110 virtual bool isColumnAvailable(int x) const { return x < getWidth(); }
Chris@152 111
Chris@152 112 /**
Chris@182 113 * Get the set of bin values at the given column.
Chris@152 114 */
Chris@929 115 virtual Column getColumn(int x) const;
Chris@152 116
Chris@152 117 /**
Chris@182 118 * Get a single value, from the n'th bin of the given column.
Chris@152 119 */
Chris@929 120 virtual float getValueAt(int x, int n) const;
Chris@152 121
Chris@152 122 /**
Chris@182 123 * Set the entire set of bin values at the given column.
Chris@152 124 */
Chris@929 125 virtual void setColumn(int x, const Column &values);
Chris@152 126
Chris@881 127 /**
Chris@881 128 * Return the name of bin n. This is a single label per bin that
Chris@881 129 * does not vary from one column to the next.
Chris@881 130 */
Chris@929 131 virtual QString getBinName(int n) const;
Chris@881 132
Chris@881 133 /**
Chris@881 134 * Set the name of bin n.
Chris@881 135 */
Chris@929 136 virtual void setBinName(int n, QString);
Chris@881 137
Chris@881 138 /**
Chris@881 139 * Set the names of all bins.
Chris@881 140 */
Chris@152 141 virtual void setBinNames(std::vector<QString> names);
Chris@152 142
Chris@881 143 /**
Chris@886 144 * Return true if the bins have values as well as names. (The
Chris@886 145 * values may have been derived from the names, e.g. by parsing
Chris@886 146 * numbers from them.) If this returns true, getBinValue() may be
Chris@886 147 * used to retrieve the values.
Chris@886 148 */
Chris@886 149 virtual bool hasBinValues() const;
Chris@886 150
Chris@886 151 /**
Chris@886 152 * Return the value of bin n, if any. This is a "vertical scale"
Chris@886 153 * value which does not vary from one column to the next. This is
Chris@886 154 * only meaningful if hasBinValues() returns true.
Chris@886 155 */
Chris@929 156 virtual float getBinValue(int n) const;
Chris@886 157
Chris@886 158 /**
Chris@886 159 * Set the values of all bins (separate from their labels). These
Chris@886 160 * are "vertical scale" values which do not vary from one column
Chris@886 161 * to the next.
Chris@886 162 */
Chris@886 163 virtual void setBinValues(std::vector<float> values);
Chris@886 164
Chris@886 165 /**
Chris@886 166 * Obtain the name of the unit of the values returned from
Chris@886 167 * getBinValue(), if any.
Chris@886 168 */
Chris@886 169 virtual QString getBinValueUnit() const;
Chris@886 170
Chris@886 171 /**
Chris@886 172 * Set the name of the unit of the values return from
Chris@886 173 * getBinValue() if any.
Chris@886 174 */
Chris@886 175 virtual void setBinValueUnit(QString unit);
Chris@886 176
Chris@886 177 /**
Chris@881 178 * Return true if the distribution of values in the bins is such
Chris@881 179 * as to suggest a log scale (mapping to colour etc) may be better
Chris@881 180 * than a linear one.
Chris@881 181 */
Chris@478 182 bool shouldUseLogValueScale() const;
Chris@478 183
Chris@333 184 virtual void setCompletion(int completion, bool update = true);
Chris@152 185 virtual int getCompletion() const { return m_completion; }
Chris@152 186
Chris@345 187 QString getTypeName() const { return tr("Editable Dense 3-D"); }
Chris@345 188
Chris@318 189 virtual QString toDelimitedDataString(QString delimiter) const;
Chris@1038 190 virtual QString toDelimitedDataStringSubset(QString delimiter, sv_frame_t f0, sv_frame_t f1) const;
Chris@318 191
Chris@152 192 virtual void toXml(QTextStream &out,
Chris@152 193 QString indent = "",
Chris@152 194 QString extraAttributes = "") const;
Chris@152 195
Chris@152 196 protected:
Chris@533 197 typedef QVector<Column> ValueMatrix;
Chris@152 198 ValueMatrix m_data;
Chris@152 199
Chris@535 200 // m_trunc is used for simple compression. If at least the top N
Chris@535 201 // elements of column x (for N = some proportion of the column
Chris@535 202 // height) are equal to those of an earlier column x', then
Chris@535 203 // m_trunc[x] will contain x-x' and column x will be truncated so
Chris@535 204 // as to remove the duplicate elements. If the equal elements are
Chris@535 205 // at the bottom, then m_trunc[x] will contain x'-x (a negative
Chris@535 206 // value). If m_trunc[x] is 0 then the whole of column x is
Chris@535 207 // stored.
Chris@535 208 std::vector<signed char> m_trunc;
Chris@929 209 void truncateAndStore(int index, const Column & values);
Chris@929 210 Column expandAndRetrieve(int index) const;
Chris@534 211
Chris@152 212 std::vector<QString> m_binNames;
Chris@886 213 std::vector<float> m_binValues;
Chris@886 214 QString m_binValueUnit;
Chris@152 215
Chris@1038 216 sv_frame_t m_startFrame;
Chris@1040 217 sv_samplerate_t m_sampleRate;
Chris@929 218 int m_resolution;
Chris@929 219 int m_yBinCount;
Chris@535 220 CompressionType m_compression;
Chris@152 221 float m_minimum;
Chris@152 222 float m_maximum;
Chris@256 223 bool m_haveExtents;
Chris@152 224 bool m_notifyOnAdd;
Chris@1110 225 sv_frame_t m_sinceLastNotifyMin;
Chris@1110 226 sv_frame_t m_sinceLastNotifyMax;
Chris@152 227 int m_completion;
Chris@152 228
Chris@536 229 mutable QReadWriteLock m_lock;
Chris@152 230 };
Chris@152 231
Chris@152 232 #endif