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 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
|
#include "PluginClient.h"
#include "Log.h"
#include "MiscUtils.h"
#include "FileUtils.h"
#include <algorithm>
#include <sstream>
#include <cassert>
#if DEBUG_CLIENT_PROCESS
# define LOG_PROCESS(x) LOG_DEBUG(x)
#else
# define LOG_PROCESS(x)
#endif
namespace vst {
/*/////////////////////// PluginClient /////////////////////////////*/
#define FORBIDDEN_METHOD(name) throw Error(Error::PluginError, "PluginClient: must not call " name "()");
#define UNSUPPORTED_METHOD(name) LOG_WARNING(name "() not supported with bit bridging/sandboxing");
IPlugin::ptr createBridgedPlugin(IFactory::const_ptr factory, const std::string& name,
bool editor, bool sandbox)
{
auto info = factory->findPlugin(name); // should never fail
if (!info){
throw Error(Error::PluginError, "couldn't find subplugin");
}
return std::make_unique<PluginClient>(factory, info, sandbox, editor);
}
PluginClient::PluginClient(IFactory::const_ptr f, PluginDesc::const_ptr desc,
bool sandbox, bool editor)
: factory_(std::move(f)), info_(std::move(desc))
{
if ((reinterpret_cast<uintptr_t>(this) & (CACHELINE_SIZE-1)) != 0){
LOG_WARNING("PluginClient is not properly aligned!");
}
static std::atomic<uint32_t> nextID{0};
id_ = ++nextID; // atomic increment!
int numParams = info_->numParameters();
if (info_->numParameters() > 0){
paramValueCache_.reset(new std::atomic<float>[numParams]{}); // !
paramDisplayCache_ = std::make_unique<ParamDisplay[]>(numParams);
}
int numPrograms = info_->numPrograms();
if (info_->numPrograms() > 0){
programNameCache_ = std::make_unique<ProgramName[]>(numPrograms);
}
if (sandbox){
LOG_DEBUG("PluginClient (" << id_ << "): create sandbox");
bridge_ = PluginBridge::create(factory_->arch());
} else {
LOG_DEBUG("PluginClient (" << id_ << "): get plugin bridge");
bridge_ = PluginBridge::getShared(factory_->arch());
}
// create plugin
std::stringstream ss;
info_->serialize(ss);
auto info = ss.str();
LOG_DEBUG("PluginClient (" << id_ << "): open plugin (info size: "
<< info.size() << ")");
auto cmdSize = sizeof(ShmCommand) + info.size();
auto data = std::make_unique<char[]>(cmdSize);
auto cmd = new (data.get()) ShmCommand(Command::CreatePlugin, id());
cmd->plugin.size = info.size();
memcpy(cmd->plugin.data, info.c_str(), info.size());
auto chn = bridge_->getNRTChannel();
if (chn.addCommand(cmd, cmdSize)){
LOG_DEBUG("PluginClient (" << id_ << "): wait for Server");
chn.send();
} else {
// info too large, try to transmit via tmp file
LOG_DEBUG("PluginClient (" << id_ << "): send info via tmp file (" << info.size() << " bytes)");
std::stringstream ss;
ss << getTmpDirectory() << "/vst_" << (void *)this;
std::string path = ss.str();
TmpFile file(path, File::WRITE);
if (!file){
throw Error(Error::SystemError,
"PluginClient: couldn't create tmp file");
}
file << info;
if (!file){
throw Error(Error::SystemError,
"PluginClient: couldn't write info to tmp file");
}
cmdSize = sizeof(ShmCommand) + path.size() + 1;
cmd->plugin.size = 0; // !
memcpy(cmd->plugin.data, path.c_str(), path.size() + 1);
if (!chn.addCommand(cmd, cmdSize)){
throw Error(Error::PluginError,
"PluginClient: couldn't send plugin info");
}
LOG_DEBUG("PluginClient (" << id_ << "): wait for Server");
chn.send(); // tmp file is still in scope!
}
// in case the process has already crashed during creation...
if (!bridge_->alive()){
throw Error(Error::PluginError, "plugin crashed");
}
LOG_DEBUG("PluginClient (" << id_ << "): plugin created");
// collect replies (after check!)
const ShmCommand *reply;
while (chn.getReply(reply)){
dispatchReply(*reply);
}
if (editor && info_->editor()) {
window_ = std::make_unique<WindowClient>(*this);
}
LOG_DEBUG("PluginClient (" << id_ << "): done!");
}
PluginClient::~PluginClient(){
if (listener_){
bridge_->removeUIClient(id_);
}
// destroy window
window_ = nullptr;
// destroy plugin
// (not necessary with exlusive bridge)
if (bridge_->shared() && bridge_->alive()){
ShmCommand cmd(Command::DestroyPlugin, id());
auto chn = bridge_->getNRTChannel();
chn.AddCommand(cmd, empty);
chn.send();
}
// avoid memleak with param string and sysex command
for (auto& cmd : commands_){
if (cmd.type == Command::SetParamString){
delete[] cmd.paramString.str;
} else if (cmd.type == Command::SendSysex){
delete[] cmd.sysex.data;
}
}
LOG_DEBUG("PluginClient (" << id_ << "): free");
}
bool PluginClient::check() {
return bridge_->alive();
}
void PluginClient::setupProcessing(double sampleRate, int maxBlockSize,
ProcessPrecision precision, ProcessMode mode){
if (!check()){
return;
}
LOG_DEBUG("PluginClient (" << id_ << "): setupProcessing");
ShmCommand cmd(Command::SetupProcessing);
cmd.id = id();
cmd.setup.sampleRate = sampleRate;
cmd.setup.maxBlockSize = maxBlockSize;
cmd.setup.precision = static_cast<uint8_t>(precision);
cmd.setup.mode = static_cast<uint8_t>(mode);
auto chn = bridge().getNRTChannel();
chn.AddCommand(cmd, setup);
chn.send();
chn.checkError();
}
template<typename T>
void PluginClient::doProcess(ProcessData& data){
if (!check()){
bypass(data);
commands_.clear(); // avoid commands piling up!
return;
}
LOG_PROCESS("PluginClient (" << id_ << "): start processing");
auto channel = bridge().getRTChannel();
LOG_PROCESS("PluginClient (" << id_ << "): send process command");
// send process command
ShmCommand cmd(Command::Process);
cmd.id = id();
cmd.process.numSamples = data.numSamples;
cmd.process.precision = (uint8_t)data.precision;
cmd.process.mode = (uint8_t)data.mode;
cmd.process.numInputs = data.numInputs;
cmd.process.numOutputs = data.numOutputs;
channel.AddCommand(cmd, process);
// send input busses
for (int i = 0; i < data.numInputs; ++i){
auto& bus = data.inputs[i];
// write all channels sequentially to avoid additional copying.
LOG_PROCESS("PluginClient (" << id_ << "): write input bus " << i << " with "
<< bus.numChannels << " channels");
for (int j = 0; j < bus.numChannels; ++j){
channel.addCommand((const T *)bus.channelData32[j], sizeof(T) * data.numSamples);
}
}
// add commands (parameter changes, MIDI messages, etc.)
LOG_PROCESS("PluginClient (" << id_ << "): send commands");
sendCommands(channel);
// send and wait for reply
LOG_PROCESS("PluginClient (" << id_ << "): wait");
channel.send();
// check if host is still alive
if (!check()){
bypass(data);
commands_.clear(); // avoid commands piling up!
return;
}
// read output busses
for (int i = 0; i < data.numOutputs; ++i){
auto& bus = data.outputs[i];
LOG_PROCESS("PluginClient (" << id_ << "): read output bus " << i << " with "
<< bus.numChannels << " channels");
// read channels
for (int j = 0; j < bus.numChannels; ++j){
auto chn = (T *)bus.channelData32[j];
const T* reply;
size_t size;
if (channel.getReply(reply, size)){
// size can be larger because of message
// alignment - don't use in std::copy!
assert(size >= data.numSamples * sizeof(T));
std::copy(reply, reply + data.numSamples, chn);
} else {
std::fill(chn, chn + data.numSamples, 0);
LOG_ERROR("PluginClient (" << id_ << "): missing channel " << j
<< " for audio output bus " << i);
}
}
}
// get replies (parameter changes, MIDI messages, etc.)
LOG_PROCESS("PluginClient (" << id_ << "): read replies");
const ShmCommand* reply;
while (channel.getReply(reply)){
dispatchReply(*reply);
}
LOG_PROCESS("PluginClient (" << id_ << "): finished processing");
}
void PluginClient::sendCommands(RTChannel& channel){
for (auto& cmd : commands_){
// We have to handle some commands specially because their
// struct layout differs from the corresponding ShmCommand.
switch (cmd.type){
case Command::SetParamValue:
channel.AddCommand(cmd, paramValue); // optimize for space!
break;
case Command::SetParamString:
{
auto& param = cmd.paramString;
// NB: use extra byte from pstr[1] for pascal string size!
assert(param.size < 256); // TODO: use proper constant
auto cmdSize = CommandSize(ShmCommand, paramString, param.size);
auto shmCmd = (ShmCommand *)alloca(cmdSize);
new (shmCmd) ShmCommand(Command::SetParamString);
shmCmd->paramString.index = param.index;
shmCmd->paramString.offset = param.offset;
shmCmd->paramString.pstr[0] = param.size;
memcpy(&shmCmd->paramString.pstr[1], param.str, param.size);
channel.addCommand(shmCmd, cmdSize);
delete[] cmd.paramString.str; // free!
break;
}
case Command::SetParamStringShort:
{
auto& param = cmd.paramStringShort;
auto psize = param.pstr[0];
assert(psize <= Command::maxShortStringSize);
// NB: use extra byte from pstr[1] for pascal string size!
auto cmdSize = CommandSize(ShmCommand, paramString, psize);
auto shmCmd = (ShmCommand *)alloca(cmdSize);
new (shmCmd) ShmCommand(Command::SetParamString);
shmCmd->paramString.index = param.index;
shmCmd->paramString.offset = param.offset;
shmCmd->paramString.pstr[0] = psize;
memcpy(&shmCmd->paramString.pstr[1], ¶m.pstr[1], psize);
channel.addCommand(shmCmd, cmdSize);
break;
}
case Command::SetProgramName:
{
auto len = strlen(cmd.s) + 1;
auto cmdSize = CommandSize(ShmCommand, s, len);
auto shmCmd = (ShmCommand *)alloca(cmdSize);
new (shmCmd) ShmCommand(Command::SetProgramName);
memcpy(shmCmd->s, cmd.s, len);
delete[] cmd.s; // free!
channel.addCommand(shmCmd, cmdSize);
break;
}
case Command::SendMidi:
channel.AddCommand(cmd, midi);
break;
case Command::SendSysex:
{
auto cmdSize = CommandSize(ShmCommand, sysex, cmd.sysex.size);
auto shmCmd = (ShmCommand *)alloca(cmdSize);
new (shmCmd) ShmCommand(Command::SendSysex);
shmCmd->sysex.delta = cmd.sysex.delta;
shmCmd->sysex.size = cmd.sysex.size;
memcpy(shmCmd->sysex.data, cmd.sysex.data, cmd.sysex.size);
delete[] cmd.sysex.data; // free!
channel.addCommand(shmCmd, cmdSize);
break;
}
// All other commands are layout compatible with ShmCommand.
// They all take max. 12 bytes and are rare enough that we
// don't have to optimize for space
default:
channel.AddCommand(cmd, d);
break;
}
}
commands_.clear(); // !
}
void PluginClient::dispatchReply(const ShmCommand& reply){
// LOG_DEBUG("PluginClient (" << id_ << "): got reply " << reply.type);
switch (reply.type){
case Command::ParamAutomated:
case Command::ParameterUpdate:
{
auto index = reply.paramState.index;
auto value = reply.paramState.value;
auto pstr = reply.paramState.pstr;
paramValueCache_[index].store(value, std::memory_order_relaxed);
{
auto& cache = paramDisplayCache_[index];
auto size = std::min<size_t>(pstr[0], cache.size() - 1);
// must be thread-safe!
std::lock_guard lock(cacheLock_);
cache[0] = size; // pascal string!
memcpy(&cache[1], &pstr[1], size);
}
if (reply.type == Command::ParamAutomated){
if (listener_){
listener_->parameterAutomated(index, value);
}
LOG_DEBUG("PluginClient (" << id_ << "): parameter " << index
<< " automated ");
} else {
LOG_DEBUG("PluginClient (" << id_ << "): parameter " << index
<< " updated to " << value << " "
<< std::string((char *)&pstr[1], pstr[0]));
}
break;
}
case Command::ProgramNameIndexed:
if (info().numPrograms() > 0) {
auto index = reply.programName.index;
auto name = reply.programName.name;
auto& cache = programNameCache_[index];
auto size = std::min(strlen(name), cache.size() - 1);
// must be thread-safe!
std::lock_guard lock(cacheLock_);
cache[0] = size; // pascal string!
memcpy(&cache[1], name, size);
}
break;
case Command::ProgramNumber:
program_ = reply.i;
break;
case Command::LatencyChanged:
latency_ = reply.i;
if (listener_){
listener_->latencyChanged(latency_);
}
break;
case Command::UpdateDisplay:
if (listener_){
listener_->updateDisplay();
}
break;
case Command::MidiReceived:
if (listener_){
listener_->midiEvent(reply.midi);
}
break;
case Command::SysexReceived:
if (listener_){
SysexEvent sysex;
sysex.delta = reply.sysex.delta;
sysex.size = reply.sysex.size;
sysex.data = reply.sysex.data;
listener_->sysexEvent(sysex);
}
break;
case Command::Error:
reply.throwError();
break;
default:
LOG_ERROR("PluginClient: got unknown reply " << reply.type);
break;
}
}
void PluginClient::process(ProcessData& data){
if (data.precision == ProcessPrecision::Double){
doProcess<double>(data);
} else {
doProcess<float>(data);
}
}
void PluginClient::suspend(){
if (!check()){
return;
}
LOG_DEBUG("PluginClient (" << id_ << "): suspend");
ShmCommand cmd(Command::Suspend, id());
auto chn = bridge().getNRTChannel();
chn.AddCommand(cmd, empty);
chn.send();
chn.checkError();
}
void PluginClient::resume(){
if (!check()){
return;
}
LOG_DEBUG("PluginClient (" << id_ << "): resume");
ShmCommand cmd(Command::Resume, id());
auto chn = bridge().getNRTChannel();
chn.AddCommand(cmd, empty);
chn.send();
chn.checkError();
}
void PluginClient::setNumSpeakers(int *input, int numInputs,
int *output, int numOutputs){
if (!check()){
return;
}
LOG_DEBUG("requested bus arrangement:");
for (int i = 0; i < numInputs; ++i){
LOG_DEBUG("input bus " << i << ": " << input[i] << "ch");
}
for (int i = 0; i < numOutputs; ++i){
LOG_DEBUG("output bus " << i << ": " << output[i] << "ch");
}
int size = sizeof(int32_t) * (numInputs + numOutputs);
auto totalSize = CommandSize(ShmCommand, speakers, size);
auto cmd = (ShmCommand *)alloca(totalSize);
new (cmd) ShmCommand(Command::SetNumSpeakers, id());
cmd->speakers.numInputs = numInputs;
cmd->speakers.numOutputs = numOutputs;
// copy input and output arrangements
for (int i = 0; i < numInputs; ++i){
cmd->speakers.speakers[i] = input[i];
}
for (int i = 0; i < numOutputs; ++i){
cmd->speakers.speakers[i + numInputs] = output[i];
}
auto chn = bridge().getNRTChannel();
chn.addCommand(cmd, totalSize);
chn.send();
// check if host is still alive!
if (!check()){
return;
}
// get reply
const ShmCommand* reply;
if (chn.getReply(reply)){
if (reply->type == Command::SpeakerArrangement){
// get actual input and output arrangements
assert(reply->speakers.numInputs == numInputs);
assert(reply->speakers.numOutputs == numOutputs);
for (int i = 0; i < numInputs; ++i){
input[i] = reply->speakers.speakers[i];
}
for (int i = 0; i < numOutputs; ++i){
output[i] = reply->speakers.speakers[i + numInputs];
}
} else if (reply->type == Command::Error){
reply->throwError();
} else {
LOG_ERROR("PluginClient::setNumSpeakers: unknown reply");
}
} else {
LOG_ERROR("PluginClient::setNumSpeakers: missing reply!");
}
LOG_DEBUG("actual bus arrangement:");
for (int i = 0; i < numInputs; ++i){
LOG_DEBUG("input bus " << i << ": " << input[i] << "ch");
}
for (int i = 0; i < numOutputs; ++i){
LOG_DEBUG("output bus " << i << ": " << output[i] << "ch");
}
}
int PluginClient::getLatencySamples(){
return latency_;
}
void PluginClient::setListener(IPluginListener* listener) {
listener_ = listener;
if (listener){
if (bridge_->alive()){
bridge_->addUIClient(id_, listener);
} else {
// in case the plugin has crashed during setup,
// but we didn't have a chance to get a notification
listener->pluginCrashed();
}
} else {
bridge_->removeUIClient(id_);
}
}
double PluginClient::getTransportPosition() const {
// TODO
return transport_;
}
void PluginClient::setParameter(int index, float value, int sampleOffset){
// don't cache immediately, so that value and display stay in sync.
#if 0
paramValueCache_[index].store(value, std::memory_order_relaxed); // cache value
#endif
DeferredPlugin::setParameter(index, value, sampleOffset);
}
bool PluginClient::setParameter(int index, std::string_view str, int sampleOffset){
// don't cache immediately, so that value and display stay in sync.
#if 0
{
auto& cache = paramDisplayCache_[index];
auto size = std::min(str.size(), cache.size() - 1);
// must be thread-safe!
std::lock_guard lock(cacheLock_);
cache[0] = size; // pascal string!
memcpy(&cache[1], str.data(), size);
}
#endif
return DeferredPlugin::setParameter(index, str, sampleOffset);
}
float PluginClient::getParameter(int index) const {
return paramValueCache_[index].load(std::memory_order_relaxed);
}
size_t PluginClient::getParameterString(int index, ParamStringBuffer& buffer) const {
// must be thread-safe!
std::lock_guard lock(cacheLock_);
auto& param = paramDisplayCache_[index];
auto size = param[0];
assert(size < param.size());
// NB: pascal strings are not null-terminated!
memcpy(buffer.data(), ¶m[1], size);
buffer[size] = 0;
return size;
}
void PluginClient::setProgram(int index) {
// let's cache immediately
#if 1
program_ = index;
#endif
DeferredPlugin::setProgram(index);
}
int PluginClient::getProgram() const {
return program_;
}
void PluginClient::setProgramName(std::string_view name) {
// let's cache immediately
#if 1
{
auto& cache = programNameCache_[program_];
auto size = std::min(name.size(), cache.size() - 1);
// must be thread-safe!
std::lock_guard lock(cacheLock_);
cache[0] = size; // pascal string!
memcpy(&cache[1], name.data(), size);
}
#endif
Command cmd(Command::SetProgramName);
cmd.s = new char[name.size() + 1];
memcpy(cmd.s, name.data(), name.size() + 1);
commands_.push_back(cmd);
}
std::string PluginClient::getProgramName() const {
return getProgramNameIndexed(program_);
}
std::string PluginClient::getProgramNameIndexed(int index) const {
// must be thread-safe!
std::lock_guard lock(cacheLock_);
auto& name = programNameCache_[index];
assert(name[0] < name.size()); // pascal string!
return std::string((char *)&name[1], name[0]);
}
void PluginClient::readProgramFile(const std::string& path){
LOG_DEBUG("PluginClient (" << id_ << "): readProgramFile");
sendFile(Command::ReadProgramFile, path);
}
void PluginClient::readProgramData(const char *data, size_t size){
LOG_DEBUG("PluginClient (" << id_ << "): readProgramData");
sendData(Command::ReadProgramData, data, size);
}
void PluginClient::readBankFile(const std::string& path){
LOG_DEBUG("PluginClient (" << id_ << "): readBankFile");
sendFile(Command::ReadBankFile, path);
}
void PluginClient::readBankData(const char *data, size_t size){
LOG_DEBUG("PluginClient (" << id_ << "): readBankData");
sendData(Command::ReadBankData, data, size);
}
void PluginClient::writeProgramFile(const std::string& path){
LOG_DEBUG("PluginClient (" << id_ << "): writeProgramFile");
sendFile(Command::WriteProgramFile, path);
}
void PluginClient::writeProgramData(std::string& buffer){
LOG_DEBUG("PluginClient (" << id_ << "): writeProgramData");
receiveData(Command::WriteProgramData, buffer);
}
void PluginClient::writeBankFile(const std::string& path){
LOG_DEBUG("PluginClient (" << id_ << "): writeBankFile");
sendFile(Command::WriteBankFile, path);
}
void PluginClient::writeBankData(std::string& buffer){
LOG_DEBUG("PluginClient (" << id_ << "): writeBankData");
receiveData(Command::WriteBankData, buffer);
}
void PluginClient::sendFile(Command::Type type, const std::string &path) {
if (!check()){
return;
}
auto pathSize = path.size() + 1;
auto cmdSize = CommandSize(ShmCommand, buffer, pathSize);
auto cmd = (ShmCommand *)alloca(cmdSize);
new (cmd) ShmCommand(type, id());
cmd->buffer.size = pathSize;
memcpy(cmd->buffer.data, path.data(), pathSize);
auto chn = bridge().getNRTChannel();
if (!chn.addCommand(cmd, cmdSize)) {
throw Error(Error::PluginError,
"PluginClient: could not send file path");
}
chn.send();
// check if host is still alive!
if (!check()){
return;
}
// get replies
const ShmCommand* reply;
while (chn.getReply(reply)){
dispatchReply(*reply);
}
}
void PluginClient::sendData(Command::Type type, const char *data, size_t size){
if (!check()){
return;
}
auto totalSize = sizeof(ShmCommand) + size;
auto chn = bridge().getNRTChannel();
if (totalSize > chn.capacity()) {
// plugin data too large, try to transmit via tmp file
LOG_DEBUG("PluginClient (" << id_ << "): send plugin data via tmp file (size: "
<< size << ", capacity: " << chn.capacity() << ")");
std::stringstream ss;
ss << getTmpDirectory() << "/vst_" << (void *)this;
std::string path = ss.str();
TmpFile file(path, File::WRITE);
if (!file){
throw Error(Error::SystemError,
"PluginClient: couldn't create tmp file");
}
file.write(data, size);
if (!file){
throw Error(Error::SystemError,
"PluginClient: couldn't write plugin data to tmp file");
}
// avoid dead lock in sendFile()!
{
auto dummy = std::move(chn);
}
auto cmd = (type == Command::ReadProgramData) ?
Command::ReadProgramFile : Command::ReadBankFile;
sendFile(cmd, path);
return; // !
}
ShmCommand cmd(type, id());
cmd.i = size; // save actual size!
chn.AddCommand(cmd, buffer);
// send data as seperate command to avoid needless copy
if (!chn.addCommand(data, size)) {
throw Error("plugin data too large!"); // shouldn't happen
}
chn.send();
// check if host is still alive!
if (!check()){
return;
}
// get replies
const ShmCommand* reply;
while (chn.getReply(reply)){
dispatchReply(*reply);
}
}
void PluginClient::receiveData(Command::Type type, std::string &buffer){
if (!check()){
return;
}
ShmCommand cmd(type, id());
auto chn = bridge().getNRTChannel();
chn.AddCommand(cmd, empty);
chn.send();
// check if host is still alive!
if (!check()){
return;
}
const ShmCommand *reply;
if (chn.getReply(reply)){
if (reply->type == Command::PluginData){
auto realSize = reply->i;
// data is in a seperate message (avoids unncessary copy)!
const char *data;
size_t size;
if (chn.getReply(data, size)){
assert(size >= realSize); // 'size' can be larger because of padding!
buffer.assign(data, realSize);
} else {
throw Error(Error::PluginError,
"PluginClient::receiveData: missing data message");
}
} else if (reply->type == Command::PluginDataFile) {
// data is transmitted in a tmp file
auto path = reply->buffer.data;
File file(path, File::READ);
if (!file){
throw Error(Error::SystemError, "PluginClient: couldn't open tmp file");
}
buffer = file.readAll();
if (!file){
throw Error(Error::SystemError, "PluginClient: couldn't read tmp file");
}
file.close();
// we have to remove the tmp file!
if (!removeFile(path)) {
LOG_ERROR("PluginClient (" << id_ << "): couldn't remove tmp file");
}
} else if (reply->type == Command::Error) {
reply->throwError();
} else {
throw Error(Error::PluginError,
"PluginClient::receiveData: unexpected reply message " + std::to_string(reply->type));
}
} else {
throw Error(Error::PluginError,
"PluginClient::receiveData: missing reply message");
}
}
void PluginClient::openEditor(void * window){
FORBIDDEN_METHOD("openEditor")
}
void PluginClient::closeEditor(){
FORBIDDEN_METHOD("closeEditor")
}
bool PluginClient::getEditorRect(Rect& rect) const {
FORBIDDEN_METHOD("getEditorRect")
}
void PluginClient::updateEditor() {
FORBIDDEN_METHOD("updateEditor")
}
void PluginClient::checkEditorSize(int& width, int& height) const {
FORBIDDEN_METHOD("checkEditorSize")
}
void PluginClient::resizeEditor(int width, int height) {
FORBIDDEN_METHOD("resizeEditor")
}
// VST2 only
int PluginClient::canDo(const char *what) const {
UNSUPPORTED_METHOD("canDo")
return 0;
}
intptr_t PluginClient::vendorSpecific(int index, intptr_t value, void *p, float opt){
UNSUPPORTED_METHOD("vendorSpecific");
return 0;
}
/*///////////////////// WindowClient ////////////////////*/
WindowClient::WindowClient(PluginClient& plugin)
: plugin_(&plugin) {}
WindowClient::~WindowClient(){}
void WindowClient::open(){
LOG_DEBUG("WindowOpen");
ShmUICommand cmd(Command::WindowOpen, plugin_->id());
plugin_->bridge().postUIThread(cmd);
}
void WindowClient::close(){
LOG_DEBUG("WindowClose");
ShmUICommand cmd(Command::WindowClose, plugin_->id());
plugin_->bridge().postUIThread(cmd);
}
void WindowClient::setPos(int x, int y){
LOG_DEBUG("WindowSetPos");
ShmUICommand cmd(Command::WindowSetPos, plugin_->id());
cmd.windowPos.x = x;
cmd.windowPos.y = y;
plugin_->bridge().postUIThread(cmd);
}
void WindowClient::setSize(int w, int h){
LOG_DEBUG("WindowSetSize");
ShmUICommand cmd(Command::WindowSetSize, plugin_->id());
cmd.windowSize.width = w;
cmd.windowSize.height = h;
plugin_->bridge().postUIThread(cmd);
}
} // vst
|