Chris@320
|
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
|
Chris@320
|
2
|
Chris@320
|
3 /*
|
Chris@320
|
4 Sonic Visualiser
|
Chris@320
|
5 An audio file viewer and annotation editor.
|
Chris@320
|
6 Centre for Digital Music, Queen Mary, University of London.
|
Chris@320
|
7 This file copyright 2006 Chris Cannam.
|
Chris@320
|
8
|
Chris@320
|
9 This program is free software; you can redistribute it and/or
|
Chris@320
|
10 modify it under the terms of the GNU General Public License as
|
Chris@320
|
11 published by the Free Software Foundation; either version 2 of the
|
Chris@320
|
12 License, or (at your option) any later version. See the file
|
Chris@320
|
13 COPYING included with this distribution for more information.
|
Chris@320
|
14 */
|
Chris@320
|
15
|
Chris@329
|
16 #ifndef _TRANSFORMER_H_
|
Chris@329
|
17 #define _TRANSFORMER_H_
|
Chris@320
|
18
|
Chris@320
|
19 #include "base/Thread.h"
|
Chris@320
|
20
|
Chris@320
|
21 #include "data/model/Model.h"
|
Chris@320
|
22
|
Chris@350
|
23 #include "Transform.h"
|
Chris@350
|
24
|
Chris@320
|
25 /**
|
Chris@331
|
26 * A ModelTransformer turns one data model into another.
|
Chris@320
|
27 *
|
Chris@331
|
28 * Typically in this application, a ModelTransformer might have a
|
Chris@320
|
29 * DenseTimeValueModel as its input (e.g. an audio waveform) and a
|
Chris@320
|
30 * SparseOneDimensionalModel (e.g. detected beats) as its output.
|
Chris@320
|
31 *
|
Chris@331
|
32 * The ModelTransformer typically runs in the background, as a
|
Chris@331
|
33 * separate thread populating the output model. The model is
|
Chris@331
|
34 * available to the user of the ModelTransformer immediately, but may
|
Chris@331
|
35 * be initially empty until the background thread has populated it.
|
Chris@320
|
36 */
|
Chris@320
|
37
|
Chris@331
|
38 class ModelTransformer : public Thread
|
Chris@320
|
39 {
|
Chris@320
|
40 public:
|
Chris@331
|
41 virtual ~ModelTransformer();
|
Chris@320
|
42
|
Chris@849
|
43 typedef std::vector<Model *> Models;
|
Chris@849
|
44
|
Chris@350
|
45 class Input {
|
Chris@350
|
46 public:
|
Chris@350
|
47 Input(Model *m) : m_model(m), m_channel(-1) { }
|
Chris@350
|
48 Input(Model *m, int c) : m_model(m), m_channel(c) { }
|
Chris@350
|
49
|
Chris@350
|
50 Model *getModel() const { return m_model; }
|
Chris@350
|
51 void setModel(Model *m) { m_model = m; }
|
Chris@350
|
52
|
Chris@350
|
53 int getChannel() const { return m_channel; }
|
Chris@350
|
54 void setChannel(int c) { m_channel = c; }
|
Chris@350
|
55
|
Chris@350
|
56 protected:
|
Chris@350
|
57 Model *m_model;
|
Chris@350
|
58 int m_channel;
|
Chris@350
|
59 };
|
Chris@350
|
60
|
Chris@361
|
61 /**
|
Chris@361
|
62 * Hint to the processing thread that it should give up, for
|
Chris@361
|
63 * example because the process is going to exit or we want to get
|
Chris@361
|
64 * rid of the input model. Caller should still wait() and/or
|
Chris@361
|
65 * delete the transform before assuming its input and output
|
Chris@361
|
66 * models are no longer required.
|
Chris@361
|
67 */
|
Chris@320
|
68 void abandon() { m_abandoned = true; }
|
Chris@320
|
69
|
Chris@361
|
70 /**
|
Chris@361
|
71 * Return the input model for the transform.
|
Chris@361
|
72 */
|
Chris@350
|
73 Model *getInputModel() { return m_input.getModel(); }
|
Chris@361
|
74
|
Chris@361
|
75 /**
|
Chris@361
|
76 * Return the input channel spec for the transform.
|
Chris@361
|
77 */
|
Chris@350
|
78 int getInputChannel() { return m_input.getChannel(); }
|
Chris@350
|
79
|
Chris@361
|
80 /**
|
Chris@849
|
81 * Return the set of output models created by the transform or
|
Chris@849
|
82 * transforms. Returns an empty list if any transform could not
|
Chris@849
|
83 * be initialised; an error message may be available via
|
Chris@849
|
84 * getMessage() in this situation.
|
Chris@361
|
85 */
|
Chris@849
|
86 Models getOutputModels() { return m_outputs; }
|
Chris@361
|
87
|
Chris@361
|
88 /**
|
Chris@849
|
89 * Return the set of output models, also detaching them from the
|
Chris@849
|
90 * transformer so that they will not be deleted when the
|
Chris@849
|
91 * transformer is. The caller takes ownership of the models.
|
Chris@361
|
92 */
|
Chris@849
|
93 Models detachOutputModels() { m_detached = true; return m_outputs; }
|
Chris@320
|
94
|
Chris@361
|
95 /**
|
Chris@361
|
96 * Return a warning or error message. If getOutputModel returned
|
Chris@361
|
97 * a null pointer, this should contain a fatal error message for
|
Chris@361
|
98 * the transformer; otherwise it may contain a warning to show to
|
Chris@361
|
99 * the user about e.g. suboptimal block size or whatever.
|
Chris@361
|
100 */
|
Chris@361
|
101 QString getMessage() const { return m_message; }
|
Chris@361
|
102
|
Chris@320
|
103 protected:
|
Chris@350
|
104 ModelTransformer(Input input, const Transform &transform);
|
Chris@849
|
105 ModelTransformer(Input input, const Transforms &transforms);
|
Chris@320
|
106
|
Chris@849
|
107 Transforms m_transforms;
|
Chris@350
|
108 Input m_input; // I don't own the model in this
|
Chris@849
|
109 Models m_outputs; // I own this, unless...
|
Chris@320
|
110 bool m_detached; // ... this is true.
|
Chris@320
|
111 bool m_abandoned;
|
Chris@361
|
112 QString m_message;
|
Chris@320
|
113 };
|
Chris@320
|
114
|
Chris@320
|
115 #endif
|