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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
|
#include "PluginDictionary.h"
#include "FileUtils.h"
#include "Log.h"
#if USE_WINE
# include "CpuArch.h"
#endif
#include <cstdlib>
#include <sstream>
#include <algorithm>
namespace vst {
void PluginDictionary::addFactory(const std::string& path, IFactory::ptr factory) {
std::lock_guard lock(mutex_);
factories_[path] = std::move(factory);
}
IFactory::const_ptr PluginDictionary::findFactory(const std::string& path) const {
std::shared_lock lock(mutex_);
auto factory = factories_.find(path);
if (factory != factories_.end()){
return factory->second;
} else {
return nullptr;
}
}
void PluginDictionary::addException(const std::string &path){
std::lock_guard lock(mutex_);
exceptions_.insert(path);
}
bool PluginDictionary::isException(const std::string& path) const {
std::shared_lock lock(mutex_);
return exceptions_.count(path) != 0;
}
void PluginDictionary::addPlugin(const std::string& key, PluginDesc::const_ptr plugin) {
std::lock_guard lock(mutex_);
int index = plugin->bridged() ? BRIDGED : NATIVE;
#if USE_WINE
if (index == BRIDGED){
// prefer 64-bit Wine plugins
auto it = plugins_[index].find(key);
if (it != plugins_[index].end()){
if (it->second->arch() == CpuArch::pe_amd64 &&
plugin->arch() == CpuArch::pe_i386) {
LOG_DEBUG("ignore 32-bit Windows DLL");
return;
}
}
}
#endif
// LOG_DEBUG("add plugin " << key << ((index == BRIDGED) ? " [bridged]" : ""));
plugins_[index][key] = std::move(plugin);
}
PluginDesc::const_ptr PluginDictionary::findPlugin(const std::string& key) const {
std::shared_lock lock(mutex_);
// first try to find native plugin
auto it = plugins_[NATIVE].find(key);
if (it != plugins_[NATIVE].end()){
return it->second;
}
// then try to find bridged plugin
it = plugins_[BRIDGED].find(key);
if (it != plugins_[BRIDGED].end()){
return it->second;
}
return nullptr;
}
std::vector<PluginDesc::const_ptr> PluginDictionary::pluginList() const {
std::shared_lock lock(mutex_);
// inverse mapping (plugin -> keys)
std::unordered_set<PluginDesc::const_ptr> pluginSet;
for (auto& plugins : plugins_){
for (auto& [_, desc] : plugins){
pluginSet.insert(desc);
}
}
std::vector<PluginDesc::const_ptr> plugins;
plugins.reserve(pluginSet.size());
for (auto& plugin : pluginSet){
plugins.push_back(plugin);
}
return plugins;
}
void PluginDictionary::clear() {
std::lock_guard lock(mutex_);
factories_.clear();
for (auto& plugins : plugins_){
plugins.clear();
}
exceptions_.clear();
}
// PluginDesc.cpp
bool getLine(std::istream& stream, std::string& line);
int getCount(const std::string& line);
static double getPluginTimestamp(const std::string& path) {
// LOG_DEBUG("getPluginTimestamp: " << path);
if (isFile(path)) {
return fileTimeLastModified(path);
} else {
// bundle: find newest timestamp of all contained binaries
double timestamp = 0;
vst::search(path + "/Contents", [&](auto& path){
double t = fileTimeLastModified(path);
if (t > timestamp) {
timestamp = t;
}
}, false); // don't filter by extensions (because of macOS)!
return timestamp;
}
}
void PluginDictionary::read(const std::string& path, bool update){
std::shared_lock lock(mutex_);
int versionMajor = 0, versionMinor = 0, versionBugfix = 0;
bool outdated = false;
double timestamp = fileTimeLastModified(path);
// LOG_DEBUG("cache file timestamp: " << timestamp);
File file(path);
std::string line;
while (getLine(file, line)){
if (line == "[version]"){
std::getline(file, line);
char *pos = (char *)line.c_str();
if (*pos){
versionMajor = std::strtol(pos, &pos, 10);
if (*pos++ == '.'){
versionMinor = std::strtol(pos, &pos, 10);
if (*pos++ == '.'){
versionBugfix = std::strtol(pos, &pos, 10);
}
}
// there was a breaking change between 0.4 and 0.5
// (introduction of audio input/output busses)
if ((versionMajor != VERSION_MAJOR)
|| (versionMajor == 0 && versionMinor < 5)){
throw Error(Error::PluginError,
"The plugin cache file is incompatible with this version. "
"Please perform a new search!");
}
}
} else if (line == "[plugins]"){
std::getline(file, line);
int numPlugins = getCount(line);
while (numPlugins--){
// read a single plugin description
auto plugin = doReadPlugin(file, timestamp, versionMajor,
versionMinor, versionBugfix);
// always collect keys, otherwise reading the cache file
// would throw an error if a plugin had been removed
std::vector<std::string> keys;
std::string line;
while (getLine(file, line)){
if (line == "[keys]"){
std::getline(file, line);
int n = getCount(line);
while (n-- && std::getline(file, line)){
keys.push_back(std::move(line));
}
break;
} else {
throw Error("bad format");
}
}
if (plugin){
LOG_DEBUG("read plugin " << plugin->key());
// store plugin at keys
for (auto& key : keys){
int index = plugin->bridged() ? BRIDGED : NATIVE;
plugins_[index][key] = plugin;
}
} else {
// plugin has been changed or removed - update the cache
outdated = true;
}
}
} else if (line == "[ignore]"){
std::getline(file, line);
int numExceptions = getCount(line);
while (numExceptions-- && std::getline(file, line)){
// check if plugin has been changed or removed
if (pathExists(line)) {
try {
auto t = getPluginTimestamp(line);
if (t < timestamp) {
exceptions_.insert(line);
} else {
LOG_INFO("Black-listed plugin " << line << " has changed");
outdated = true;
}
} catch (const Error& e) {
LOG_ERROR("Could not get timestamp for " << line << ": " << e.what());
outdated = true;
}
} else {
LOG_INFO("Black-listed plugin " << line << " has been removed");
outdated = true;
}
}
} else {
throw Error("Bad data: " + line);
}
}
if (update && outdated){
// overwrite file
file.close();
try {
doWrite(path);
} catch (const Error& e){
throw Error("couldn't update cache file: " + std::string(e.what()));
}
LOG_INFO("Updated cache file");
}
LOG_DEBUG("Cache file version: v" << versionMajor
<< "." << versionMinor << "." << versionBugfix);
}
PluginDesc::const_ptr PluginDictionary::readPlugin(std::istream& stream){
std::lock_guard lock(mutex_);
return doReadPlugin(stream, -1, VERSION_MAJOR,
VERSION_MINOR, VERSION_PATCH);
}
PluginDesc::const_ptr PluginDictionary::doReadPlugin(std::istream& stream, double timestamp,
int versionMajor, int versionMinor, int versionPatch){
// deserialize plugin
auto desc = std::make_shared<PluginDesc>(nullptr);
try {
desc->deserialize(stream, versionMajor, versionMinor, versionPatch);
} catch (const Error& e){
LOG_ERROR("VSTPlugin: couldn't deserialize plugin info for '" << desc->name << "': " << e.what());
return nullptr;
}
// check if the plugin has been removed or changed since the last cache file update
if (!pathExists(desc->path())) {
LOG_WARNING("VSTPlugin: plugin " << desc->path() << " has been removed");
return nullptr; // skip
}
try {
if (timestamp >= 0 && getPluginTimestamp(desc->path()) > timestamp) {
LOG_WARNING("VSTPlugin: plugin " << desc->path() << " has changed");
return nullptr; // skip
}
} catch (const Error& e) {
LOG_ERROR("VSTPlugin: could not get timestamp for " << desc->path()
<< ": " << e.what());
return nullptr; // skip
}
// load the factory (if not already loaded)
IFactory::ptr factory;
if (!factories_.count(desc->path())){
try {
factory = IFactory::load(desc->path());
factories_[desc->path()] = factory;
} catch (const Error& e){
LOG_WARNING("couldn't load '" << desc->name <<
"' (" << desc->path() << "): " << e.what());
return nullptr; // skip
}
} else {
factory = factories_[desc->path()];
// check if plugin has already been added
auto result = factory->findPlugin(desc->name);
if (result){
// return existing plugin descriptor
return result;
}
}
// associate plugin and factory
desc->setFactory(factory);
factory->addPlugin(desc);
// scan presets
desc->scanPresets();
return desc;
}
void PluginDictionary::write(const std::string &path) const {
std::lock_guard lock(mutex_);
doWrite(path);
}
void PluginDictionary::doWrite(const std::string& path) const {
File file(path, File::WRITE);
if (!file.is_open()){
throw Error("couldn't create file " + path);
}
// inverse mapping (plugin -> keys)
std::unordered_map<PluginDesc::const_ptr, std::vector<std::string>> pluginMap;
for (auto& plugins : plugins_) {
for (auto& [key, value] : plugins){
pluginMap[value].push_back(key);
}
}
// write version number
file << "[version]\n";
file << VERSION_MAJOR << "." << VERSION_MINOR << "." << VERSION_PATCH << "\n";
// serialize exceptions
// NOTE: do this before serializing the plugins because it is more robust;
// otherwise we might get swallowed if a plugin desc is broken.
file << "[ignore]\n";
file << "n=" << exceptions_.size() << "\n";
for (auto& e : exceptions_){
file << e << "\n";
}
// serialize plugins
file << "[plugins]\n";
file << "n=" << pluginMap.size() << "\n";
for (auto& [desc, keys] : pluginMap){
// serialize plugin info
desc->serialize(file);
// serialize keys
file << "[keys]\n";
file << "n=" << keys.size() << "\n";
// sort by length, so that the short key comes first
std::sort(keys.begin(), keys.end(),
[](auto& a, auto& b) { return a.size() < b.size(); });
for (auto& key : keys){
file << key << "\n";
}
}
LOG_DEBUG("wrote cache file: " << path);
}
} // vst
|