Chris@0
|
1 /* -*- c-basic-offset: 4 -*- vi:set ts=8 sts=4 sw=4: */
|
Chris@0
|
2
|
Chris@0
|
3 /*
|
Chris@0
|
4 A waveform viewer and audio annotation editor.
|
Chris@2
|
5 Chris Cannam, Queen Mary University of London, 2005-2006
|
Chris@0
|
6
|
Chris@0
|
7 This is experimental software. Not for distribution.
|
Chris@0
|
8 */
|
Chris@0
|
9
|
Chris@0
|
10 #ifndef _CANVAS_H_
|
Chris@0
|
11 #define _CANVAS_H_
|
Chris@0
|
12
|
Chris@0
|
13 #include <QFrame>
|
Chris@0
|
14 #include <QProgressBar>
|
Chris@0
|
15
|
Chris@0
|
16 #include "base/ZoomConstraint.h"
|
Chris@0
|
17 #include "base/PropertyContainer.h"
|
Chris@8
|
18 #include "base/ViewManager.h"
|
Chris@3
|
19 #include "base/XmlExportable.h"
|
Chris@0
|
20
|
Chris@0
|
21 class Layer;
|
Chris@29
|
22 class ViewPropertyContainer;
|
Chris@0
|
23
|
Chris@0
|
24 #include <map>
|
Chris@0
|
25
|
Chris@0
|
26 /**
|
Chris@0
|
27 * View is the base class of widgets that display one or more
|
Chris@0
|
28 * overlaid views of data against a horizontal time scale.
|
Chris@0
|
29 *
|
Chris@0
|
30 * A View may have any number of attached Layers, each of which
|
Chris@0
|
31 * is expected to have one data Model (although multiple views may
|
Chris@0
|
32 * share the same model).
|
Chris@0
|
33 *
|
Chris@0
|
34 * A View may be panned in time and zoomed, although the
|
Chris@0
|
35 * mechanisms for doing so (as well as any other operations and
|
Chris@0
|
36 * properties available) depend on the subclass.
|
Chris@0
|
37 */
|
Chris@0
|
38
|
Chris@0
|
39 class View : public QFrame,
|
Chris@3
|
40 public XmlExportable
|
Chris@0
|
41 {
|
Chris@0
|
42 Q_OBJECT
|
Chris@0
|
43
|
Chris@0
|
44 public:
|
Chris@0
|
45 /**
|
Chris@0
|
46 * Deleting a View deletes all its views. However, it is
|
Chris@0
|
47 * also acceptable for the views to be deleted by other code (in
|
Chris@0
|
48 * which case they will remove themselves from this View
|
Chris@0
|
49 * automatically), or to be removed explicitly without deleting
|
Chris@0
|
50 * using removeLayer.
|
Chris@38
|
51 **!!!!!!
|
Chris@0
|
52 */
|
Chris@0
|
53 virtual ~View();
|
Chris@0
|
54
|
Chris@0
|
55 /**
|
Chris@0
|
56 * Retrieve the first visible sample frame on the widget.
|
Chris@0
|
57 * This is a calculated value based on the centre-frame, widget
|
Chris@0
|
58 * width and zoom level. The result may be negative.
|
Chris@0
|
59 */
|
Chris@0
|
60 virtual long getStartFrame() const;
|
Chris@0
|
61
|
Chris@0
|
62 /**
|
Chris@0
|
63 * Set the widget pan based on the given first visible frame. The
|
Chris@0
|
64 * frame value may be negative.
|
Chris@0
|
65 */
|
Chris@0
|
66 virtual void setStartFrame(long);
|
Chris@0
|
67
|
Chris@0
|
68 /**
|
Chris@0
|
69 * Return the centre frame of the visible widget. This is an
|
Chris@0
|
70 * exact value that does not depend on the zoom block size. Other
|
Chris@0
|
71 * frame values (start, end) are calculated from this based on the
|
Chris@0
|
72 * zoom and other factors.
|
Chris@0
|
73 */
|
Chris@0
|
74 virtual size_t getCentreFrame() const { return m_centreFrame; }
|
Chris@0
|
75
|
Chris@0
|
76 /**
|
Chris@0
|
77 * Set the centre frame of the visible widget.
|
Chris@0
|
78 */
|
Chris@0
|
79 virtual void setCentreFrame(size_t f) { setCentreFrame(f, true); }
|
Chris@0
|
80
|
Chris@0
|
81 /**
|
Chris@0
|
82 * Retrieve the last visible sample frame on the widget.
|
Chris@0
|
83 * This is a calculated value based on the centre-frame, widget
|
Chris@0
|
84 * width and zoom level.
|
Chris@0
|
85 */
|
Chris@0
|
86 virtual size_t getEndFrame() const;
|
Chris@0
|
87
|
Chris@0
|
88 /**
|
Chris@15
|
89 * Return the pixel x-coordinate corresponding to a given sample
|
Chris@15
|
90 * frame (which may be negative).
|
Chris@15
|
91 */
|
Chris@15
|
92 int getXForFrame(long frame) const;
|
Chris@15
|
93
|
Chris@15
|
94 /**
|
Chris@15
|
95 * Return the closest frame to the given pixel x-coordinate.
|
Chris@15
|
96 */
|
Chris@15
|
97 long getFrameForX(int x) const;
|
Chris@15
|
98
|
Chris@15
|
99 /**
|
Chris@33
|
100 * Return the pixel y-coordinate corresponding to a given
|
Chris@33
|
101 * frequency, if the frequency range is as specified. This does
|
Chris@33
|
102 * not imply any policy about layer frequency ranges, but it might
|
Chris@33
|
103 * be useful for layers to match theirs up if desired.
|
Chris@33
|
104 *
|
Chris@33
|
105 * Not thread-safe in logarithmic mode. Call only from GUI thread.
|
Chris@33
|
106 */
|
Chris@33
|
107 float getYForFrequency(float frequency, float minFreq, float maxFreq,
|
Chris@33
|
108 bool logarithmic) const;
|
Chris@33
|
109
|
Chris@33
|
110 /**
|
Chris@33
|
111 * Return the closest frequency to the given pixel y-coordinate,
|
Chris@33
|
112 * if the frequency range is as specified.
|
Chris@33
|
113 *
|
Chris@33
|
114 * Not thread-safe in logarithmic mode. Call only from GUI thread.
|
Chris@33
|
115 */
|
Chris@33
|
116 float getFrequencyForY(int y, float minFreq, float maxFreq,
|
Chris@33
|
117 bool logarithmic) const;
|
Chris@33
|
118
|
Chris@33
|
119 /**
|
Chris@22
|
120 * Return the zoom level, i.e. the number of frames per pixel
|
Chris@0
|
121 */
|
Chris@22
|
122 int getZoomLevel() const;
|
Chris@0
|
123
|
Chris@0
|
124 /**
|
Chris@0
|
125 * Set the zoom level, i.e. the number of frames per pixel. The
|
Chris@0
|
126 * centre frame will be unchanged; the start and end frames will
|
Chris@0
|
127 * change.
|
Chris@0
|
128 */
|
Chris@0
|
129 virtual void setZoomLevel(size_t z);
|
Chris@0
|
130
|
Chris@0
|
131 /**
|
Chris@0
|
132 * Zoom in or out.
|
Chris@0
|
133 */
|
Chris@0
|
134 virtual void zoom(bool in);
|
Chris@0
|
135
|
Chris@12
|
136 /**
|
Chris@12
|
137 * Scroll left or right by a smallish or largish amount.
|
Chris@12
|
138 */
|
Chris@12
|
139 virtual void scroll(bool right, bool lots);
|
Chris@12
|
140
|
Chris@0
|
141 virtual void addLayer(Layer *v);
|
Chris@0
|
142 virtual void removeLayer(Layer *v); // does not delete the layer
|
Chris@0
|
143 virtual int getLayerCount() const { return m_layers.size(); }
|
Chris@0
|
144
|
Chris@0
|
145 /**
|
Chris@0
|
146 * Return a layer, counted in stacking order. That is, layer 0 is
|
Chris@0
|
147 * the bottom layer and layer "getLayerCount()-1" is the top one.
|
Chris@0
|
148 */
|
Chris@0
|
149 virtual Layer *getLayer(int n) { return m_layers[n]; }
|
Chris@0
|
150
|
Chris@8
|
151 /**
|
Chris@8
|
152 * Return the layer last selected by the user. This is normally
|
Chris@8
|
153 * the top layer, the same as getLayer(getLayerCount()-1).
|
Chris@8
|
154 * However, if the user has selected the pane itself more recently
|
Chris@8
|
155 * than any of the layers on it, this function will return 0. It
|
Chris@8
|
156 * will also return 0 if there are no layers.
|
Chris@8
|
157 */
|
Chris@8
|
158 virtual Layer *getSelectedLayer();
|
Chris@36
|
159 virtual const Layer *getSelectedLayer() const;
|
Chris@8
|
160
|
Chris@0
|
161 virtual void setViewManager(ViewManager *m);
|
Chris@0
|
162
|
Chris@0
|
163 virtual void setFollowGlobalPan(bool f);
|
Chris@0
|
164 virtual bool getFollowGlobalPan() const { return m_followPan; }
|
Chris@0
|
165
|
Chris@0
|
166 virtual void setFollowGlobalZoom(bool f);
|
Chris@0
|
167 virtual bool getFollowGlobalZoom() const { return m_followZoom; }
|
Chris@0
|
168
|
Chris@0
|
169 virtual void setLightBackground(bool lb) { m_lightBackground = lb; }
|
Chris@0
|
170 virtual bool hasLightBackground() const { return m_lightBackground; }
|
Chris@0
|
171
|
Chris@36
|
172 virtual bool shouldIlluminateLocalFeatures(const Layer *, QPoint &) const {
|
Chris@0
|
173 return false;
|
Chris@0
|
174 }
|
Chris@36
|
175 virtual bool shouldIlluminateLocalSelection(QPoint &, bool &, bool &) const {
|
Chris@34
|
176 return false;
|
Chris@34
|
177 }
|
Chris@0
|
178
|
Chris@0
|
179 enum PlaybackFollowMode {
|
Chris@0
|
180 PlaybackScrollContinuous,
|
Chris@0
|
181 PlaybackScrollPage,
|
Chris@0
|
182 PlaybackIgnore
|
Chris@0
|
183 };
|
Chris@0
|
184 virtual void setPlaybackFollow(PlaybackFollowMode m);
|
Chris@0
|
185 virtual PlaybackFollowMode getPlaybackFollow() const { return m_followPlay; }
|
Chris@0
|
186
|
Chris@30
|
187 typedef PropertyContainer::PropertyName PropertyName;
|
Chris@30
|
188
|
Chris@29
|
189 // We implement the PropertyContainer API, although we don't
|
Chris@29
|
190 // actually subclass PropertyContainer. We have our own
|
Chris@29
|
191 // PropertyContainer that we can return on request that just
|
Chris@29
|
192 // delegates back to us.
|
Chris@29
|
193 virtual PropertyContainer::PropertyList getProperties() const;
|
Chris@30
|
194 virtual PropertyContainer::PropertyType getPropertyType(const PropertyName &) const;
|
Chris@30
|
195 virtual int getPropertyRangeAndValue(const PropertyName &,
|
Chris@29
|
196 int *min, int *max) const;
|
Chris@30
|
197 virtual QString getPropertyValueLabel(const PropertyName &,
|
Chris@0
|
198 int value) const;
|
Chris@30
|
199 virtual void setProperty(const PropertyName &, int value);
|
Chris@0
|
200 virtual QString getPropertyContainerName() const {
|
Chris@0
|
201 return objectName();
|
Chris@0
|
202 }
|
Chris@30
|
203 virtual QString getPropertyContainerIconName() const = 0;
|
Chris@0
|
204
|
Chris@29
|
205 virtual size_t getPropertyContainerCount() const;
|
Chris@29
|
206
|
Chris@29
|
207 virtual const PropertyContainer *getPropertyContainer(size_t i) const;
|
Chris@29
|
208 virtual PropertyContainer *getPropertyContainer(size_t i);
|
Chris@29
|
209
|
Chris@3
|
210 virtual QString toXmlString(QString indent = "",
|
Chris@3
|
211 QString extraAttributes = "") const;
|
Chris@3
|
212
|
Chris@0
|
213 signals:
|
Chris@0
|
214 void propertyContainerAdded(PropertyContainer *pc);
|
Chris@0
|
215 void propertyContainerRemoved(PropertyContainer *pc);
|
Chris@0
|
216 void propertyContainerPropertyChanged(PropertyContainer *pc);
|
Chris@0
|
217 void propertyContainerNameChanged(PropertyContainer *pc);
|
Chris@30
|
218 void propertyChanged(PropertyName);
|
Chris@0
|
219
|
Chris@0
|
220 void centreFrameChanged(void *, unsigned long, bool);
|
Chris@0
|
221 void zoomLevelChanged(void *, unsigned long, bool);
|
Chris@0
|
222
|
Chris@0
|
223 public slots:
|
Chris@0
|
224 virtual void modelChanged();
|
Chris@0
|
225 virtual void modelChanged(size_t startFrame, size_t endFrame);
|
Chris@0
|
226 virtual void modelCompletionChanged();
|
Chris@0
|
227 virtual void modelReplaced();
|
Chris@0
|
228 virtual void layerParametersChanged();
|
Chris@0
|
229 virtual void layerNameChanged();
|
Chris@0
|
230
|
Chris@0
|
231 virtual void viewManagerCentreFrameChanged(void *, unsigned long, bool);
|
Chris@0
|
232 virtual void viewManagerPlaybackFrameChanged(unsigned long);
|
Chris@0
|
233 virtual void viewManagerZoomLevelChanged(void *, unsigned long, bool);
|
Chris@0
|
234
|
Chris@0
|
235 virtual void propertyContainerSelected(PropertyContainer *pc);
|
Chris@0
|
236
|
Chris@9
|
237 virtual void selectionChanged();
|
Chris@8
|
238 virtual void toolModeChanged();
|
Chris@8
|
239
|
Chris@0
|
240 protected:
|
Chris@0
|
241 View(QWidget *, bool showProgress);
|
Chris@0
|
242 virtual void paintEvent(QPaintEvent *e);
|
Chris@9
|
243 virtual void drawSelections(QPainter &);
|
Chris@10
|
244 virtual bool shouldLabelSelections() const { return true; }
|
Chris@0
|
245
|
Chris@0
|
246 typedef std::vector<Layer *> LayerList;
|
Chris@0
|
247
|
Chris@0
|
248 size_t getModelsStartFrame() const;
|
Chris@0
|
249 size_t getModelsEndFrame() const;
|
Chris@0
|
250 int getModelsSampleRate() const;
|
Chris@0
|
251 bool areLayersScrollable() const;
|
Chris@31
|
252 LayerList getScrollableBackLayers(bool testChanged, bool &changed) const;
|
Chris@31
|
253 LayerList getNonScrollableFrontLayers(bool testChanged, bool &changed) const;
|
Chris@0
|
254 size_t getZoomConstraintBlockSize(size_t blockSize,
|
Chris@0
|
255 ZoomConstraint::RoundingDirection dir =
|
Chris@0
|
256 ZoomConstraint::RoundNearest) const;
|
Chris@0
|
257
|
Chris@10
|
258 bool setCentreFrame(size_t f, bool doEmit);
|
Chris@0
|
259
|
Chris@0
|
260 void checkProgress(void *object);
|
Chris@0
|
261
|
Chris@3
|
262 size_t m_centreFrame;
|
Chris@3
|
263 int m_zoomLevel;
|
Chris@3
|
264 bool m_followPan;
|
Chris@3
|
265 bool m_followZoom;
|
Chris@3
|
266 PlaybackFollowMode m_followPlay;
|
Chris@3
|
267 size_t m_playPointerFrame;
|
Chris@3
|
268 bool m_lightBackground;
|
Chris@3
|
269 bool m_showProgress;
|
Chris@0
|
270
|
Chris@3
|
271 QPixmap *m_cache;
|
Chris@3
|
272 size_t m_cacheCentreFrame;
|
Chris@3
|
273 int m_cacheZoomLevel;
|
Chris@9
|
274 bool m_selectionCached;
|
Chris@0
|
275
|
Chris@3
|
276 bool m_deleting;
|
Chris@0
|
277
|
Chris@3
|
278 LayerList m_layers; // I don't own these, but see dtor note above
|
Chris@8
|
279 bool m_haveSelectedLayer;
|
Chris@0
|
280
|
Chris@0
|
281 // caches for use in getScrollableBackLayers, getNonScrollableFrontLayers
|
Chris@0
|
282 mutable LayerList m_lastScrollableBackLayers;
|
Chris@0
|
283 mutable LayerList m_lastNonScrollableBackLayers;
|
Chris@0
|
284
|
Chris@0
|
285 class LayerProgressBar : public QProgressBar {
|
Chris@0
|
286 public:
|
Chris@16
|
287 LayerProgressBar(QWidget *parent);
|
Chris@0
|
288 virtual QString text() const { return m_text; }
|
Chris@0
|
289 virtual void setText(QString text) { m_text = text; }
|
Chris@0
|
290 protected:
|
Chris@0
|
291 QString m_text;
|
Chris@0
|
292 };
|
Chris@0
|
293
|
Chris@0
|
294 typedef std::map<Layer *, LayerProgressBar *> ProgressMap;
|
Chris@0
|
295 ProgressMap m_progressBars; // I own the ProgressBars
|
Chris@0
|
296
|
Chris@0
|
297 ViewManager *m_manager; // I don't own this
|
Chris@29
|
298 ViewPropertyContainer *m_propertyContainer; // I own this
|
Chris@29
|
299 };
|
Chris@29
|
300
|
Chris@29
|
301
|
Chris@29
|
302 // Use this for delegation, because we can't subclass from
|
Chris@29
|
303 // PropertyContainer (which is a QObject) ourselves because of
|
Chris@29
|
304 // ambiguity with QFrame parent
|
Chris@29
|
305
|
Chris@29
|
306 class ViewPropertyContainer : public PropertyContainer
|
Chris@29
|
307 {
|
Chris@29
|
308 Q_OBJECT
|
Chris@29
|
309
|
Chris@29
|
310 public:
|
Chris@29
|
311 ViewPropertyContainer(View *v);
|
Chris@29
|
312 PropertyList getProperties() const { return m_v->getProperties(); }
|
Chris@29
|
313 PropertyType getPropertyType(const PropertyName &n) const {
|
Chris@29
|
314 return m_v->getPropertyType(n);
|
Chris@29
|
315 }
|
Chris@29
|
316 int getPropertyRangeAndValue(const PropertyName &n, int *min, int *max) const {
|
Chris@29
|
317 return m_v->getPropertyRangeAndValue(n, min, max);
|
Chris@29
|
318 }
|
Chris@29
|
319 QString getPropertyValueLabel(const PropertyName &n, int value) const {
|
Chris@29
|
320 return m_v->getPropertyValueLabel(n, value);
|
Chris@29
|
321 }
|
Chris@29
|
322 QString getPropertyContainerName() const {
|
Chris@29
|
323 return m_v->getPropertyContainerName();
|
Chris@29
|
324 }
|
Chris@29
|
325 QString getPropertyContainerIconName() const {
|
Chris@30
|
326 return m_v->getPropertyContainerIconName();
|
Chris@29
|
327 }
|
Chris@29
|
328
|
Chris@29
|
329 public slots:
|
Chris@29
|
330 virtual void setProperty(const PropertyName &n, int value) {
|
Chris@29
|
331 m_v->setProperty(n, value);
|
Chris@29
|
332 }
|
Chris@29
|
333
|
Chris@29
|
334 protected:
|
Chris@29
|
335 View *m_v;
|
Chris@0
|
336 };
|
Chris@0
|
337
|
Chris@0
|
338 #endif
|
Chris@0
|
339
|