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