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
|
/* -*- 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 SV_MODEL_TRANSFORMER_FACTORY_H
#define SV_MODEL_TRANSFORMER_FACTORY_H
#include "Transform.h"
#include "TransformDescription.h"
#include "FeatureExtractionModelTransformer.h"
#include "ModelTransformer.h"
#include <vamp-hostsdk/PluginBase.h>
#include <QMap>
#include <QMutex>
#include <map>
#include <set>
#include <vector>
#include <memory>
namespace sv {
class AudioPlaySource;
class ModelTransformerFactory : public QObject
{
Q_OBJECT
public:
virtual ~ModelTransformerFactory();
static ModelTransformerFactory *getInstance();
class UserConfigurator {
public:
virtual ~UserConfigurator() { }
virtual bool configure(ModelTransformer::Input &input,
Transform &transform,
std::shared_ptr<Vamp::PluginBase> plugin,
ModelId &inputModel,
AudioPlaySource *source,
sv_frame_t startFrame,
sv_frame_t duration,
const QMap<QString, ModelId> &modelMap,
QStringList candidateModelNames,
QString defaultModelName) = 0;
};
/**
* Fill out the configuration for the given transform (may include
* asking the user by calling back on the UserConfigurator).
* Returns the selected input model and channel if the transform
* is acceptable, or an input with no model if the operation
* should be cancelled. Audio play source may be used to audition
* effects plugins, if provided.
*/
ModelTransformer::Input
getConfigurationForTransform(Transform &transform,
std::vector<ModelId> candidateInputModels,
ModelId defaultInputModel,
AudioPlaySource *source = 0,
sv_frame_t startFrame = 0,
sv_frame_t duration = 0,
UserConfigurator *configurator = 0);
class AdditionalModelHandler {
public:
virtual ~AdditionalModelHandler() { }
// Exactly one of these functions will be called
virtual void moreModelsAvailable(std::vector<ModelId> models) = 0;
virtual void noMoreModelsAvailable() = 0;
};
/**
* Return the output model resulting from applying the named
* transform to the given input model. The transform may still be
* working in the background when the model is returned; check the
* output model's isReady completion status for more details. To
* cancel a background transform, call cancel() supplying its
* output model.
*
* If the transform is unknown or the input model is not an
* appropriate type for the given transform, or if some other
* problem occurs, return 0. Set message if there is any error or
* warning to report.
*
* Some transforms may return additional models at the end of
* processing. (For example, a transform that splits an output
* into multiple one-per-bin models.) If an additionalModelHandler
* is provided here, its moreModelsAvailable method will be called
* when those models become available, and ownership of those
* models will be transferred to the handler. Otherwise (if the
* handler is null) any such models will be discarded.
*
* The returned model is owned by the caller and must be deleted
* when no longer needed.
*/
ModelId transform(const Transform &transform,
const ModelTransformer::Input &input,
QString &message,
AdditionalModelHandler *handler = nullptr,
ModelTransformer::CompletionReporter *reporter = nullptr);
/**
* Return the multiple output models resulting from applying the
* named transforms to the given input model. The transforms may
* differ only in output identifier for the plugin: they must all
* use the same plugin, parameters, and programs. The plugin will
* be run once only, but more than one output will be harvested
* (as appropriate). Models will be returned in the same order as
* the transforms were given. The plugin may still be working in
* the background when the model is returned; check the output
* models' isReady completion statuses for more details. To cancel
* a background transform, call cancel() supplying its output model.
*
* If a transform is unknown or the transforms are insufficiently
* closely related or the input model is not an appropriate type
* for the given transform, or if some other problem occurs,
* return 0. Set message if there is any error or warning to
* report.
*
* Some transforms may return additional models at the end of
* processing. (For example, a transform that splits an output
* into multiple one-per-bin models.) If an additionalModelHandler
* is provided here, its moreModelsAvailable method will be called
* when those models become available, and ownership of those
* models will be transferred to the handler. Otherwise (if the
* handler is null) any such models will be discarded. Note that
* calling cancel() with any one of the models returned by
* transformMultiple is sufficient to cancel all background
* transform activity associated with these output models.
*
* The returned models are owned by the caller and must be deleted
* when no longer needed.
*/
std::vector<ModelId> transformMultiple(const Transforms &transform,
const ModelTransformer::Input &input,
QString &message,
AdditionalModelHandler *handler = nullptr,
ModelTransformer::CompletionReporter *reporter = nullptr);
bool haveRunningTransformers() const;
/**
* Cancel any running transform associated with the given output
* model, waiting for the transform to stop and any associated
* threads or processes to exit before returning. The output model
* IDs for that transform are unmodified and remain valid.
*
* Return false if there is no running transform associated with
* this model.
*/
bool cancel(ModelId);
signals:
void transformFailed(QString transformName, QString message);
protected slots:
void transformerFinished();
protected:
ModelTransformer *createTransformer(const Transforms &transforms,
const ModelTransformer::Input &input,
ModelTransformer::CompletionReporter *);
mutable QMutex m_mutex;
typedef std::map<TransformId, QString> TransformerConfigurationMap;
TransformerConfigurationMap m_lastConfigurations;
typedef std::set<ModelTransformer *> TransformerSet;
TransformerSet m_runningTransformers;
typedef std::map<ModelTransformer *, AdditionalModelHandler *> HandlerMap;
HandlerMap m_handlers;
static ModelTransformerFactory *m_instance;
};
} // end namespace sv
#endif
|
