annotate plugin/PiperVampPluginFactory.cpp @ 1370:54fabf5aceb8

Update piper-cpp to github repo, and adjust build for revised layout in it
author Chris Cannam
date Fri, 20 Jan 2017 18:05:41 +0000
parents a99641535e02
children da5f4d37988d b5728e69802b
rev   line source
Chris@49 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@0 2
Chris@0 3 /*
Chris@52 4 Sonic Visualiser
Chris@52 5 An audio file viewer and annotation editor.
Chris@52 6 Centre for Digital Music, Queen Mary, University of London.
Chris@1241 7 This file copyright 2006-2016 Chris Cannam and QMUL.
Chris@0 8
Chris@52 9 This program is free software; you can redistribute it and/or
Chris@52 10 modify it under the terms of the GNU General Public License as
Chris@52 11 published by the Free Software Foundation; either version 2 of the
Chris@52 12 License, or (at your option) any later version. See the file
Chris@52 13 COPYING included with this distribution for more information.
Chris@0 14 */
Chris@0 15
Chris@1249 16 #ifdef HAVE_PIPER
Chris@1249 17
Chris@1225 18 #include "PiperVampPluginFactory.h"
Chris@0 19 #include "PluginIdentifier.h"
Chris@0 20
Chris@150 21 #include "system/System.h"
Chris@66 22
Chris@1179 23 #include "PluginScan.h"
Chris@1179 24
Chris@1224 25 #ifdef _WIN32
Chris@1224 26 #undef VOID
Chris@1224 27 #undef ERROR
Chris@1224 28 #define CAPNP_LITE 1
Chris@1224 29 #endif
Chris@1225 30
Chris@1370 31 #include "vamp-client/qt/AutoPlugin.h"
Chris@1370 32 #include "vamp-client/qt/ProcessQtTransport.h"
Chris@1370 33 #include "vamp-client/CapnpRRClient.h"
Chris@1210 34
Chris@66 35 #include <QDir>
Chris@66 36 #include <QFile>
Chris@66 37 #include <QFileInfo>
Chris@165 38 #include <QTextStream>
Chris@1227 39 #include <QCoreApplication>
Chris@66 40
Chris@0 41 #include <iostream>
Chris@0 42
Chris@408 43 #include "base/Profiler.h"
Chris@1241 44 #include "base/HelperExecPath.h"
Chris@408 45
Chris@1164 46 using namespace std;
Chris@1164 47
Chris@249 48 //#define DEBUG_PLUGIN_SCAN_AND_INSTANTIATE 1
Chris@249 49
Chris@1264 50 class PiperVampPluginFactory::Logger : public piper_vamp::client::LogCallback {
Chris@1264 51 protected:
Chris@1264 52 void log(std::string message) const override {
Chris@1264 53 SVDEBUG << "PiperVampPluginFactory: " << message << endl;
Chris@1264 54 }
Chris@1264 55 };
Chris@1264 56
Chris@1264 57 PiperVampPluginFactory::PiperVampPluginFactory() :
Chris@1264 58 m_logger(new Logger)
Chris@66 59 {
Chris@1241 60 QString serverName = "piper-vamp-simple-server";
Chris@1240 61
Chris@1246 62 HelperExecPath hep(HelperExecPath::AllInstalled);
Chris@1246 63 m_servers = hep.getHelperExecutables(serverName);
Chris@1240 64
Chris@1246 65 for (auto n: m_servers) {
Chris@1247 66 SVDEBUG << "NOTE: PiperVampPluginFactory: Found server: "
Chris@1247 67 << n.executable << endl;
Chris@1246 68 }
Chris@1246 69
Chris@1240 70 if (m_servers.empty()) {
Chris@1247 71 SVDEBUG << "NOTE: No Piper Vamp servers found in installation;"
Chris@1247 72 << " found none of the following:" << endl;
Chris@1246 73 for (auto d: hep.getHelperCandidatePaths(serverName)) {
Chris@1247 74 SVDEBUG << "NOTE: " << d << endl;
Chris@1241 75 }
Chris@1240 76 }
Chris@1240 77 }
Chris@1240 78
Chris@1264 79 PiperVampPluginFactory::~PiperVampPluginFactory()
Chris@1264 80 {
Chris@1264 81 delete m_logger;
Chris@1264 82 }
Chris@1264 83
Chris@1164 84 vector<QString>
Chris@1227 85 PiperVampPluginFactory::getPluginIdentifiers(QString &errorMessage)
Chris@0 86 {
Chris@1225 87 Profiler profiler("PiperVampPluginFactory::getPluginIdentifiers");
Chris@408 88
Chris@1209 89 QMutexLocker locker(&m_mutex);
Chris@1209 90
Chris@1240 91 if (m_servers.empty()) {
Chris@1227 92 errorMessage = QObject::tr("External plugin host executable does not appear to be installed");
Chris@1227 93 return {};
Chris@1227 94 }
Chris@1227 95
Chris@1209 96 if (m_pluginData.empty()) {
Chris@1227 97 populate(errorMessage);
Chris@1209 98 }
Chris@1209 99
Chris@1164 100 vector<QString> rv;
Chris@1179 101
Chris@1209 102 for (const auto &d: m_pluginData) {
Chris@1225 103 rv.push_back(QString("vamp:") + QString::fromStdString(d.second.pluginKey));
Chris@66 104 }
Chris@66 105
Chris@0 106 return rv;
Chris@0 107 }
Chris@0 108
Chris@66 109 Vamp::Plugin *
Chris@1225 110 PiperVampPluginFactory::instantiatePlugin(QString identifier,
Chris@1225 111 sv_samplerate_t inputSampleRate)
Chris@0 112 {
Chris@1225 113 Profiler profiler("PiperVampPluginFactory::instantiatePlugin");
Chris@1225 114
Chris@1240 115 if (m_origins.find(identifier) == m_origins.end()) {
Chris@1240 116 cerr << "ERROR: No known server for identifier " << identifier << endl;
Chris@1247 117 SVDEBUG << "ERROR: No known server for identifier " << identifier << endl;
Chris@1240 118 return 0;
Chris@1240 119 }
Chris@1240 120
Chris@1225 121 auto psd = getPluginStaticData(identifier);
Chris@1225 122 if (psd.pluginKey == "") {
Chris@1225 123 return 0;
Chris@1225 124 }
Chris@1264 125
Chris@1264 126 SVDEBUG << "PiperVampPluginFactory: Creating Piper AutoPlugin for server "
Chris@1264 127 << m_origins[identifier] << ", identifier " << identifier << endl;
Chris@1210 128
Chris@1210 129 auto ap = new piper_vamp::client::AutoPlugin
Chris@1240 130 (m_origins[identifier].toStdString(),
Chris@1264 131 psd.pluginKey,
Chris@1264 132 float(inputSampleRate),
Chris@1264 133 0,
Chris@1264 134 m_logger);
Chris@1240 135
Chris@1210 136 if (!ap->isOK()) {
Chris@1210 137 delete ap;
Chris@1210 138 return 0;
Chris@1225 139 }
Chris@1225 140
Chris@1225 141 return ap;
Chris@1225 142 }
Chris@1225 143
Chris@1225 144 piper_vamp::PluginStaticData
Chris@1225 145 PiperVampPluginFactory::getPluginStaticData(QString identifier)
Chris@1225 146 {
Chris@1225 147 if (m_pluginData.find(identifier) != m_pluginData.end()) {
Chris@1225 148 return m_pluginData[identifier];
Chris@1210 149 } else {
Chris@1225 150 return {};
Chris@1210 151 }
Chris@298 152 }
Chris@298 153
Chris@165 154 QString
Chris@1225 155 PiperVampPluginFactory::getPluginCategory(QString identifier)
Chris@165 156 {
Chris@1223 157 if (m_taxonomy.find(identifier) != m_taxonomy.end()) {
Chris@1223 158 return m_taxonomy[identifier];
Chris@1223 159 } else {
Chris@1223 160 return {};
Chris@1223 161 }
Chris@165 162 }
Chris@165 163
Chris@165 164 void
Chris@1227 165 PiperVampPluginFactory::populate(QString &errorMessage)
Chris@165 166 {
Chris@1240 167 QString someError;
Chris@1227 168
Chris@1246 169 for (auto s: m_servers) {
Chris@1240 170
Chris@1240 171 populateFrom(s, someError);
Chris@1240 172
Chris@1240 173 if (someError != "" && errorMessage == "") {
Chris@1240 174 errorMessage = someError;
Chris@1240 175 }
Chris@1240 176 }
Chris@1240 177 }
Chris@1240 178
Chris@1240 179 void
Chris@1246 180 PiperVampPluginFactory::populateFrom(const HelperExecPath::HelperExec &server,
Chris@1246 181 QString &errorMessage)
Chris@1240 182 {
Chris@1246 183 QString tag = server.tag;
Chris@1246 184 string executable = server.executable.toStdString();
Chris@1246 185
Chris@1246 186 PluginScan *scan = PluginScan::getInstance();
Chris@1246 187 auto candidateLibraries =
Chris@1246 188 scan->getCandidateLibrariesFor(PluginScan::VampPlugin);
Chris@1246 189
Chris@1264 190 SVDEBUG << "PiperVampPluginFactory: Populating from " << executable << endl;
Chris@1250 191 SVDEBUG << "INFO: Have " << candidateLibraries.size()
Chris@1264 192 << " candidate Vamp plugin libraries from scanner" << endl;
Chris@1249 193
Chris@1246 194 vector<string> from;
Chris@1246 195 for (const auto &c: candidateLibraries) {
Chris@1246 196 if (c.helperTag == tag) {
Chris@1246 197 string soname = QFileInfo(c.libraryPath).baseName().toStdString();
Chris@1247 198 SVDEBUG << "INFO: For tag \"" << tag << "\" giving library " << soname << endl;
Chris@1246 199 from.push_back(soname);
Chris@1246 200 }
Chris@1246 201 }
Chris@1246 202
Chris@1246 203 if (from.empty()) {
Chris@1247 204 SVDEBUG << "PiperVampPluginFactory: No candidate libraries for tag \""
Chris@1246 205 << tag << "\"";
Chris@1246 206 if (scan->scanSucceeded()) {
Chris@1246 207 // we have to assume that they all failed to load (i.e. we
Chris@1246 208 // exclude them all) rather than sending an empty list
Chris@1246 209 // (which would mean no exclusions)
Chris@1247 210 SVDEBUG << ", skipping" << endl;
Chris@1246 211 return;
Chris@1246 212 } else {
Chris@1247 213 SVDEBUG << ", but it seems the scan failed, so bumbling on anyway" << endl;
Chris@1246 214 }
Chris@1246 215 }
Chris@1246 216
Chris@1264 217 piper_vamp::client::ProcessQtTransport transport(executable, "capnp", m_logger);
Chris@1227 218 if (!transport.isOK()) {
Chris@1264 219 SVDEBUG << "PiperVampPluginFactory: Failed to start Piper process transport" << endl;
Chris@1227 220 errorMessage = QObject::tr("Could not start external plugin host");
Chris@1227 221 return;
Chris@1227 222 }
Chris@1234 223
Chris@1264 224 piper_vamp::client::CapnpRRClient client(&transport, m_logger);
Chris@1248 225
Chris@1248 226 piper_vamp::ListRequest req;
Chris@1248 227 req.from = from;
Chris@1248 228
Chris@1248 229 piper_vamp::ListResponse resp;
Chris@1234 230
Chris@1234 231 try {
Chris@1248 232 resp = client.listPluginData(req);
Chris@1234 233 } catch (piper_vamp::client::ServerCrashed) {
Chris@1264 234 SVDEBUG << "PiperVampPluginFactory: Piper server crashed" << endl;
Chris@1234 235 errorMessage = QObject::tr
Chris@1234 236 ("External plugin host exited unexpectedly while listing plugins");
Chris@1234 237 return;
Chris@1235 238 } catch (const std::exception &e) {
Chris@1264 239 SVDEBUG << "PiperVampPluginFactory: Exception caught: " << e.what() << endl;
Chris@1235 240 errorMessage = QObject::tr("External plugin host invocation failed: %1")
Chris@1235 241 .arg(e.what());
Chris@1235 242 return;
Chris@1234 243 }
Chris@1213 244
Chris@1247 245 SVDEBUG << "PiperVampPluginFactory: server \"" << executable << "\" lists "
Chris@1248 246 << resp.available.size() << " plugin(s)" << endl;
Chris@1244 247
Chris@1248 248 for (const auto &pd: resp.available) {
Chris@1240 249
Chris@1213 250 QString identifier =
Chris@1213 251 QString("vamp:") + QString::fromStdString(pd.pluginKey);
Chris@1213 252
Chris@1240 253 if (m_origins.find(identifier) != m_origins.end()) {
Chris@1240 254 // have it already, from a higher-priority server
Chris@1240 255 // (e.g. 64-bit instead of 32-bit)
Chris@1240 256 continue;
Chris@1240 257 }
Chris@1240 258
Chris@1246 259 m_origins[identifier] = server.executable;
Chris@1240 260
Chris@1225 261 m_pluginData[identifier] = pd;
Chris@1225 262
Chris@1213 263 QStringList catlist;
Chris@1213 264 for (const auto &cs: pd.category) {
Chris@1213 265 catlist.push_back(QString::fromStdString(cs));
Chris@1213 266 }
Chris@1223 267
Chris@1213 268 m_taxonomy[identifier] = catlist.join(" > ");
Chris@1213 269 }
Chris@1209 270 }
Chris@165 271
Chris@1249 272 #endif