Mercurial > hg > piper-vamp-js

annotate VamPipePluginLibrary.cpp @ 81:5e6ff69b4209

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Make base64/text selectable when serialising process and feature blocks; add base64 version as an output format for vampipe-convert; make VamPipePluginLibrary switch to returning base64 encoding as soon as it is fed any as input
author Chris Cannam <c.cannam@qmul.ac.uk>
date Thu, 08 Sep 2016 15:27:48 +0100
parents c2a90b45642e
children a313ce2577ea
rev   line source
c@69 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
c@69 2
c@69 3 /*
c@69 4 VamPipe
c@69 5
c@69 6 Centre for Digital Music, Queen Mary, University of London.
c@69 7 Copyright 2015-2016 QMUL.
c@69 8
c@69 9 Permission is hereby granted, free of charge, to any person
c@69 10 obtaining a copy of this software and associated documentation
c@69 11 files (the "Software"), to deal in the Software without
c@69 12 restriction, including without limitation the rights to use, copy,
c@69 13 modify, merge, publish, distribute, sublicense, and/or sell copies
c@69 14 of the Software, and to permit persons to whom the Software is
c@69 15 furnished to do so, subject to the following conditions:
c@69 16
c@69 17 The above copyright notice and this permission notice shall be
c@69 18 included in all copies or substantial portions of the Software.
c@69 19
c@69 20 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
c@69 21 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
c@69 22 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
c@69 23 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
c@69 24 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
c@69 25 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
c@69 26 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
c@69 27
c@69 28 Except as contained in this notice, the names of the Centre for
c@69 29 Digital Music; Queen Mary, University of London; and Chris Cannam
c@69 30 shall not be used in advertising or otherwise to promote the sale,
c@69 31 use or other dealings in this Software without prior written
c@69 32 authorization.
c@69 33 */
c@69 34
c@69 35 #include "VamPipePluginLibrary.h"
c@69 36 #include "VamPipeAdapter.h"
c@69 37 #include "json/VampJson.h"
c@69 38
c@69 39 using namespace std;
c@69 40 using namespace json11;
c@69 41
c@69 42 namespace vampipe {
c@69 43
c@69 44 //!!! too many explicit namespaces here
c@69 45
c@69 46 //!!! dup with vampipe-convert
c@69 47 static Json
c@69 48 convertRequestJson(string input)
c@69 49 {
c@69 50 string err;
c@69 51 Json j = Json::parse(input, err);
c@69 52 if (err != "") {
c@69 53 throw VampJson::Failure("invalid json: " + err);
c@69 54 }
c@69 55 if (!j.is_object()) {
c@69 56 throw VampJson::Failure("object expected at top level");
c@69 57 }
c@69 58 if (!j["type"].is_string()) {
c@69 59 throw VampJson::Failure("string expected for type field");
c@69 60 }
c@71 61 if (!j["content"].is_null() && !j["content"].is_object()) {
c@69 62 throw VampJson::Failure("object expected for content field");
c@69 63 }
c@69 64 return j;
c@69 65 }
c@69 66
c@81 67 VamPipePluginLibrary::VamPipePluginLibrary(vector<VamPipeAdapterBase *> pp) :
c@81 68 m_useBase64(false)
c@69 69 {
c@69 70 for (VamPipeAdapterBase *p: pp) {
c@69 71 string key = p->getStaticData().pluginKey;
c@69 72 m_adapters[key] = p;
c@69 73 }
c@69 74 }
c@69 75
c@69 76 RequestOrResponse
c@81 77 VamPipePluginLibrary::readRequest(string req)
c@69 78 {
c@69 79 RequestOrResponse rr;
c@69 80 rr.direction = RequestOrResponse::Request;
c@69 81
c@69 82 Json j = convertRequestJson(req);
c@69 83
c@69 84 //!!! reduce, reduce
c@69 85 rr.type = VampJson::getRequestResponseType(j);
c@81 86 VampJson::BufferSerialisation serialisation = VampJson::BufferSerialisation::Text;
c@69 87
c@69 88 switch (rr.type) {
c@69 89
c@69 90 case RRType::List:
c@69 91 VampJson::toVampRequest_List(j); // type check only
c@69 92 break;
c@69 93 case RRType::Load:
c@69 94 rr.loadRequest = VampJson::toVampRequest_Load(j);
c@69 95 break;
c@69 96 case RRType::Configure:
c@69 97 rr.configurationRequest = VampJson::toVampRequest_Configure(j, m_mapper);
c@69 98 break;
c@69 99 case RRType::Process:
c@81 100 rr.processRequest = VampJson::toVampRequest_Process(j, m_mapper, serialisation);
c@69 101 break;
c@69 102 case RRType::Finish:
c@69 103 rr.finishPlugin = VampJson::toVampRequest_Finish(j, m_mapper);
c@69 104 break;
c@69 105 case RRType::NotValid:
c@69 106 break;
c@69 107 }
c@69 108
c@81 109 if (serialisation == VampJson::BufferSerialisation::Base64) {
c@81 110 m_useBase64 = true;
c@81 111 }
c@81 112
c@69 113 return rr;
c@69 114 }
c@69 115
c@69 116 string
c@69 117 VamPipePluginLibrary::writeResponse(const RequestOrResponse &rr) const
c@69 118 {
c@69 119 Json j;
c@69 120
c@81 121 VampJson::BufferSerialisation serialisation =
c@81 122 (m_useBase64 ?
c@81 123 VampJson::BufferSerialisation::Base64 :
c@81 124 VampJson::BufferSerialisation::Text);
c@81 125
c@69 126 switch (rr.type) {
c@69 127
c@69 128 case RRType::List:
c@69 129 j = VampJson::fromVampResponse_List("", rr.listResponse);
c@69 130 break;
c@69 131 case RRType::Load:
c@69 132 j = VampJson::fromVampResponse_Load(rr.loadResponse, m_mapper);
c@69 133 break;
c@69 134 case RRType::Configure:
c@69 135 j = VampJson::fromVampResponse_Configure(rr.configurationResponse);
c@69 136 break;
c@69 137 case RRType::Process:
c@81 138 j = VampJson::fromVampResponse_Process(rr.processResponse, serialisation);
c@69 139 break;
c@69 140 case RRType::Finish:
c@81 141 j = VampJson::fromVampResponse_Finish(rr.finishResponse, serialisation);
c@69 142 break;
c@69 143 case RRType::NotValid:
c@69 144 break;
c@69 145 }
c@69 146
c@69 147 return j.dump();
c@69 148 }
c@69 149
c@69 150 vector<Vamp::HostExt::PluginStaticData>
c@69 151 VamPipePluginLibrary::listPluginData() const
c@69 152 {
c@69 153 vector<Vamp::HostExt::PluginStaticData> data;
c@69 154 for (auto a: m_adapters) {
c@69 155 data.push_back(a.second->getStaticData());
c@69 156 }
c@69 157 return data;
c@69 158 }
c@69 159
c@69 160 Vamp::HostExt::LoadResponse
c@69 161 VamPipePluginLibrary::loadPlugin(Vamp::HostExt::LoadRequest req) const
c@69 162 {
c@69 163 string key = req.pluginKey;
c@69 164 if (m_adapters.find(key) != m_adapters.end()) {
c@69 165 return m_adapters.at(key)->loadPlugin(req);
c@69 166 } else {
c@69 167 throw runtime_error("no adapter for plugin key " + key);
c@69 168 }
c@69 169 }
c@69 170
c@69 171 Vamp::HostExt::ConfigurationResponse
c@69 172 VamPipePluginLibrary::configurePlugin(Vamp::HostExt::ConfigurationRequest req) const
c@69 173 {
c@69 174 for (Vamp::HostExt::PluginConfiguration::ParameterMap::const_iterator i =
c@69 175 req.configuration.parameterValues.begin();
c@69 176 i != req.configuration.parameterValues.end(); ++i) {
c@69 177 req.plugin->setParameter(i->first, i->second);
c@69 178 }
c@69 179
c@69 180 if (req.configuration.currentProgram != "") {
c@69 181 req.plugin->selectProgram(req.configuration.currentProgram);
c@69 182 }
c@69 183
c@69 184 Vamp::HostExt::ConfigurationResponse response;
c@69 185
c@69 186 if (req.plugin->initialise(req.configuration.channelCount,
c@69 187 req.configuration.stepSize,
c@69 188 req.configuration.blockSize)) {
c@69 189 response.outputs = req.plugin->getOutputDescriptors();
c@69 190 }
c@69 191
c@69 192 return response;
c@69 193 }
c@69 194
c@69 195 string
c@69 196 VamPipePluginLibrary::requestJsonImpl(string req)
c@69 197 {
c@70 198 RequestOrResponse request;
c@70 199
c@70 200 try {
c@70 201 request = readRequest(req);
c@70 202 } catch (const std::exception &e) {
c@81 203 std::cerr << "FAILURE" << std::endl;
c@70 204 return VampJson::fromException(e, RRType::NotValid).dump();
c@70 205 }
c@69 206
c@69 207 RequestOrResponse response;
c@69 208 response.direction = RequestOrResponse::Response;
c@69 209 response.type = request.type;
c@69 210
c@70 211 try {
c@70 212 switch (request.type) {
c@69 213
c@70 214 case RRType::List:
c@70 215 response.listResponse = listPluginData();
c@70 216 response.success = true;
c@70 217 break;
c@69 218
c@70 219 case RRType::Load:
c@70 220 response.loadResponse = loadPlugin(request.loadRequest);
c@70 221 if (response.loadResponse.plugin) {
c@70 222 m_mapper.addPlugin(response.loadResponse.plugin);
c@70 223 response.success = true;
c@70 224 }
c@70 225 break;
c@69 226
c@70 227 case RRType::Configure:
c@70 228 {
c@70 229 auto &creq = request.configurationRequest;
c@70 230 auto h = m_mapper.pluginToHandle(creq.plugin);
c@70 231 if (m_mapper.isConfigured(h)) {
c@70 232 throw runtime_error("plugin has already been configured");
c@70 233 }
c@70 234
c@70 235 response.configurationResponse = configurePlugin(creq);
c@70 236
c@70 237 if (!response.configurationResponse.outputs.empty()) {
c@70 238 m_mapper.markConfigured
c@70 239 (h, creq.configuration.channelCount, creq.configuration.blockSize);
c@70 240 response.success = true;
c@70 241 }
c@70 242 break;
c@69 243 }
c@69 244
c@70 245 case RRType::Process:
c@70 246 {
c@70 247 auto &preq = request.processRequest;
c@70 248 auto h = m_mapper.pluginToHandle(preq.plugin);
c@70 249 if (!m_mapper.isConfigured(h)) {
c@70 250 throw runtime_error("plugin has not been configured");
c@70 251 }
c@70 252
c@70 253 int channels = int(preq.inputBuffers.size());
c@70 254 if (channels != m_mapper.getChannelCount(h)) {
c@70 255 throw runtime_error("wrong number of channels supplied to process");
c@70 256 }
c@70 257
c@70 258 const float **fbuffers = new const float *[channels];
c@70 259 for (int i = 0; i < channels; ++i) {
c@70 260 if (int(preq.inputBuffers[i].size()) != m_mapper.getBlockSize(h)) {
c@70 261 delete[] fbuffers;
c@70 262 throw runtime_error("wrong block size supplied to process");
c@70 263 }
c@70 264 fbuffers[i] = preq.inputBuffers[i].data();
c@70 265 }
c@70 266
c@70 267 response.processResponse.features =
c@81 268 preq.plugin->process(fbuffers, preq.timestamp);
c@69 269 response.success = true;
c@69 270
c@70 271 delete[] fbuffers;
c@70 272 break;
c@69 273 }
c@69 274
c@70 275 case RRType::Finish:
c@70 276 {
c@70 277 auto h = m_mapper.pluginToHandle(request.finishPlugin);
c@70 278
c@70 279 response.finishResponse.features =
c@70 280 request.finishPlugin->getRemainingFeatures();
c@70 281
c@70 282 m_mapper.removePlugin(h);
c@70 283 delete request.finishPlugin;
c@70 284 response.success = true;
c@70 285 break;
c@69 286 }
c@69 287
c@70 288 case RRType::NotValid:
c@70 289 break;
c@70 290 }
c@70 291
c@70 292 return writeResponse(response);
c@69 293
c@70 294 } catch (const std::exception &e) {
c@70 295 return VampJson::fromException(e, request.type).dump();
c@69 296 }
c@69 297 }
c@69 298
c@69 299 }
c@69 300