Mercurial > hg > svcore
comparison plugin/transform/Transform.h @ 320:32e50b620a6c
* Move some things around to facilitate plundering libraries for other
applications without needing to duplicate so much code.
sv/osc -> data/osc
sv/audioio -> audioio
sv/transform -> plugin/transform
sv/document -> document (will rename to framework in next commit)
author | Chris Cannam |
---|---|
date | Wed, 24 Oct 2007 16:34:31 +0000 (2007-10-24) |
parents | |
children | 21bd032ae791 |
comparison
equal
deleted
inserted
replaced
319:3ff8f571da09 | 320:32e50b620a6c |
---|---|
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ | |
2 | |
3 /* | |
4 Sonic Visualiser | |
5 An audio file viewer and annotation editor. | |
6 Centre for Digital Music, Queen Mary, University of London. | |
7 This file copyright 2006 Chris Cannam. | |
8 | |
9 This program is free software; you can redistribute it and/or | |
10 modify it under the terms of the GNU General Public License as | |
11 published by the Free Software Foundation; either version 2 of the | |
12 License, or (at your option) any later version. See the file | |
13 COPYING included with this distribution for more information. | |
14 */ | |
15 | |
16 #ifndef _TRANSFORM_H_ | |
17 #define _TRANSFORM_H_ | |
18 | |
19 #include "base/Thread.h" | |
20 | |
21 #include "data/model/Model.h" | |
22 | |
23 typedef QString TransformId; | |
24 | |
25 /** | |
26 * A Transform turns one data model into another. | |
27 * | |
28 * Typically in this application, a Transform might have a | |
29 * DenseTimeValueModel as its input (e.g. an audio waveform) and a | |
30 * SparseOneDimensionalModel (e.g. detected beats) as its output. | |
31 * | |
32 * The Transform typically runs in the background, as a separate | |
33 * thread populating the output model. The model is available to the | |
34 * user of the Transform immediately, but may be initially empty until | |
35 * the background thread has populated it. | |
36 */ | |
37 | |
38 class Transform : public Thread | |
39 { | |
40 public: | |
41 virtual ~Transform(); | |
42 | |
43 // Just a hint to the processing thread that it should give up. | |
44 // Caller should still wait() and/or delete the transform before | |
45 // assuming its input and output models are no longer required. | |
46 void abandon() { m_abandoned = true; } | |
47 | |
48 Model *getInputModel() { return m_input; } | |
49 Model *getOutputModel() { return m_output; } | |
50 Model *detachOutputModel() { m_detached = true; return m_output; } | |
51 | |
52 protected: | |
53 Transform(Model *m); | |
54 | |
55 Model *m_input; // I don't own this | |
56 Model *m_output; // I own this, unless... | |
57 bool m_detached; // ... this is true. | |
58 bool m_abandoned; | |
59 }; | |
60 | |
61 #endif |