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 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
|
#include "PluginServer.h"
#include "ShmInterface.h"
#include "Log.h"
#include "FileUtils.h"
#include "MiscUtils.h"
#include <cassert>
#include <cstring>
#include <sstream>
#if VST_HOST_SYSTEM != VST_WINDOWS
#include <signal.h>
#endif
#if DEBUG_SERVER_PROCESS
# define LOG_PROCESS(x) LOG_DEBUG(x)
#else
# define LOG_PROCESS(x)
#endif
namespace vst {
template<typename T>
void defer(const T& fn){
// call on UI thread and catch exceptions
Error err;
bool ok = UIThread::callSync([&](){
try {
fn();
} catch (const Error& e){
err = e;
} catch (const std::exception& e) {
err = Error(e.what());
}
});
if (ok){
if (err.code() != Error::NoError) {
throw err;
}
return;
} else {
LOG_ERROR("UIThread::callSync() failed");
}
}
/*///////////////// PluginHandle ///////////////*/
PluginHandle::PluginHandle(PluginServer& server, IPlugin::ptr plugin,
uint32_t id, ShmChannel& channel)
: server_(&server), plugin_(std::move(plugin)), id_(id)
{
LOG_DEBUG("PluginHandle::PluginHandle (" << id_ << ")");
// cache param state and send to client
channel.clear(); // !
auto nparams = plugin_->info().numParameters();
if (nparams > 0){
paramState_ = std::make_unique<float[]>(nparams);
}
for (int i = 0; i < nparams; ++i){
auto value = plugin_->getParameter(i);
paramState_[i] = value;
sendParam(channel, i, value, false);
}
plugin_->setListener(this);
}
PluginHandle::~PluginHandle() {
LOG_DEBUG("PluginHandle::~PluginHandle (" << id_ << ")");
}
void PluginHandle::handleRequest(const ShmCommand &cmd,
ShmChannel &channel)
{
// LOG_DEBUG("PluginHandle (" << id_ << "): got request " << cmd.type);
switch (cmd.type){
case Command::Process:
// LOG_DEBUG("PluginHandle (" << id_ << "): process");
process(cmd, channel);
break;
case Command::SetupProcessing:
{
LOG_DEBUG("PluginHandle (" << id_ << "): setupProcessing");
maxBlockSize_ = cmd.setup.maxBlockSize;
precision_ = static_cast<ProcessPrecision>(cmd.setup.precision);
auto mode = static_cast<ProcessMode>(cmd.setup.mode);
defer([&](){
plugin_->setupProcessing(cmd.setup.sampleRate, maxBlockSize_,
precision_, mode);
});
updateBuffer();
break;
}
case Command::SetNumSpeakers:
{
LOG_DEBUG("PluginHandle (" << id_ << "): setNumSpeakers");
int numInputs = cmd.speakers.numInputs;
int numOutputs = cmd.speakers.numOutputs;
auto speakers = cmd.speakers.speakers;
auto input = (int *)alloca(sizeof(int) * numInputs);
std::copy(speakers, speakers + numInputs, input);
auto output = (int *)alloca(sizeof(int) * numOutputs);
std::copy(speakers + numInputs,
speakers + numInputs + numOutputs, output);
defer([&](){
plugin_->setNumSpeakers(input, numInputs, output, numOutputs);
});
// create input busses
inputs_ = numInputs > 0 ? std::make_unique<Bus[]>(numInputs) : nullptr;
numInputs_ = numInputs;
for (int i = 0; i < numInputs; ++i){
inputs_[i] = Bus(input[i]);
}
// create output busses
outputs_ = numOutputs > 0 ? std::make_unique<Bus[]>(numOutputs) : nullptr;
numOutputs_ = numOutputs;
for (int i = 0; i < numOutputs; ++i){
outputs_[i] = Bus(output[i]);
}
updateBuffer();
// send actual speaker arrangement
channel.clear(); // !
int size = sizeof(uint32_t) * (numInputs_ + numOutputs_);
auto totalSize = CommandSize(ShmCommand, speakers, size);
auto reply = (ShmCommand *)alloca(totalSize);
reply->type = Command::SpeakerArrangement;
reply->speakers.numInputs = numInputs;
reply->speakers.numOutputs = numOutputs;
// copy input and output arrangements
for (int i = 0; i < numInputs; ++i){
reply->speakers.speakers[i] = input[i];
}
for (int i = 0; i < numOutputs; ++i){
reply->speakers.speakers[i + numInputs] = output[i];
}
addReply(channel, reply, totalSize);
break;
}
case Command::Suspend:
LOG_DEBUG("PluginHandle (" << id_ << "): suspend");
defer([&](){
plugin_->suspend();
});
break;
case Command::Resume:
LOG_DEBUG("PluginHandle (" << id_ << "): resume");
defer([&](){
plugin_->resume();
});
break;
case Command::ReadProgramFile:
LOG_DEBUG("PluginHandle (" << id_ << "): ReadProgramFile");
defer([&](){
// see parameterAutomated()
presetInProgress_ = true;
plugin_->readProgramFile(cmd.buffer.data);
presetInProgress_ = false;
});
channel.clear(); // !
sendParameterUpdate(channel);
sendPresetParamChanges(channel);
sendProgramUpdate(channel, false);
break;
case Command::ReadBankFile:
LOG_DEBUG("PluginHandle (" << id_ << "): ReadBankFile");
defer([&](){
// see parameterAutomated()
presetInProgress_ = true;
plugin_->readBankFile(cmd.buffer.data);
presetInProgress_ = false;
});
channel.clear(); // !
sendParameterUpdate(channel);
sendPresetParamChanges(channel);
sendProgramUpdate(channel, true);
break;
case Command::ReadProgramData:
{
LOG_DEBUG("PluginHandle (" << id_ << "): ReadProgramData");
auto realSize = cmd.i;
// data is in a seperate message!
const void *data;
size_t size;
if (channel.getMessage(data, size)){
assert(size >= realSize); // 'size' can be larger because of padding!
} else {
throw Error(Error::PluginError,
"PluginClient::ReadProgramData: missing data message");
}
defer([&](){
// see parameterAutomated()
presetInProgress_ = true;
plugin_->readProgramData((const char *)data, realSize);
presetInProgress_ = false;
});
channel.clear(); // !
sendParameterUpdate(channel);
sendPresetParamChanges(channel);
sendProgramUpdate(channel, false);
break;
}
case Command::ReadBankData:
{
LOG_DEBUG("PluginHandle (" << id_ << "): ReadBankData");
auto realSize = cmd.i;
// data is in a seperate message!
const void *data;
size_t size;
if (channel.getMessage(data, size)){
assert(size >= realSize); // 'size' can be larger because of padding!
} else {
throw Error(Error::PluginError,
"PluginClient::ReadBankData: missing data message");
}
defer([&](){
// see parameterAutomated()
presetInProgress_ = true;
plugin_->readBankData((const char *)data, realSize);
presetInProgress_ = false;
});
channel.clear(); // !
sendParameterUpdate(channel);
sendPresetParamChanges(channel);
sendProgramUpdate(channel, true);
break;
}
case Command::WriteProgramFile:
LOG_DEBUG("PluginHandle (" << id_ << "): WriteProgramFile");
defer([&](){
plugin_->writeProgramFile(cmd.buffer.data);
});
break;
case Command::WriteBankFile:
LOG_DEBUG("PluginHandle (" << id_ << "): WriteBankFile");
defer([&](){
plugin_->writeBankFile(cmd.buffer.data);
});
break;
case Command::WriteProgramData:
case Command::WriteBankData:
{
LOG_DEBUG("PluginHandle (" << id_ << "): WriteProgramData/WriteBankData");
// get data
std::string buffer;
defer([&](){
if (cmd.type == Command::WriteBankData){
plugin_->writeBankData(buffer);
} else {
plugin_->writeProgramData(buffer);
}
});
// send data
channel.clear(); // !
auto totalSize = sizeof(ShmCommand) + buffer.size();
if (totalSize > channel.capacity()) {
// plugin data too large for NRT channel, try to transmit via tmp file
LOG_DEBUG("PluginHandle (" << id_ << "): send plugin data via tmp file (size: "
<< buffer.size() << ", capacity: " << channel.capacity() << ")");
std::stringstream ss;
ss << getTmpDirectory() << "/vst_" << (void *)this;
std::string path = ss.str();
// NOTE: the file must be deleted by the client!
File file(path, File::WRITE);
if (!file){
throw Error(Error::SystemError,
"PluginHandle: couldn't create tmp file");
}
file.write(buffer.data(), buffer.size());
if (!file){
if (!removeFile(path)) {
LOG_ERROR("PluginHandle: can't remove tmp file");
}
throw Error(Error::SystemError,
"PluginHandle: couldn't write plugin data to tmp file");
}
auto pathLength = path.size() + 1;
auto replySize = CommandSize(ShmCommand, buffer, pathLength);
auto reply = (ShmCommand *)alloca(replySize);
new (reply) ShmCommand(Command::PluginDataFile, id_);
memcpy(reply->buffer.data, path.data(), pathLength);
reply->buffer.size = pathLength;
addReply(channel, reply, replySize);
} else {
ShmCommand reply(Command::PluginData, id_);
reply.i = buffer.size(); // save actual size!
addReply(channel, &reply, sizeof(reply));
// send actual data as a seperate message to avoid needless copy.
if (!addReply(channel, buffer.data(), buffer.size())){
throw Error("plugin data too large!"); // shouldn't happen
}
}
break;
}
default:
LOG_ERROR("PluginHandle (" << id_ << "): unknown NRT request " << cmd.type);
break;
}
}
void PluginHandle::handleUICommand(const ShmUICommand &cmd){
auto window = plugin_->getWindow();
if (window){
switch (cmd.type){
case Command::WindowOpen:
LOG_DEBUG("WindowOpen");
window->open();
break;
case Command::WindowClose:
LOG_DEBUG("WindowClose");
window->close();
break;
case Command::WindowSetPos:
LOG_DEBUG("WindowSetPos");
window->setPos(cmd.windowPos.x, cmd.windowPos.y);
break;
case Command::WindowSetSize:
LOG_DEBUG("WindowSetSize");
window->setSize(cmd.windowSize.width, cmd.windowSize.height);
break;
default:
LOG_ERROR("PluginHandle (" << id_ << "): unknown UI command " << cmd.type);
break;
}
} else {
LOG_ERROR("PluginHandle (" << id_ << "): can't handle UI command without window!");
}
}
void PluginHandle::parameterAutomated(int index, float value) {
if (UIThread::isCurrentThread()) {
if (presetInProgress_) {
LOG_DEBUG("PluginHandle: parameter " << index << " automated by preset change");
// If this method is called from within readProgram() or readProgramData(),
// the host is already blocking in the UI thread and thus won't be able to
// drain the queue! As a consequence, this could block for a long time if
// the plugin sends many parameter changes! Instead we push the values to
// a dedicated queue, see sendPresetParamChanges().
// NB: presets are currently *always* loaded on the UI thread, even if plugin
// has been opened without an editor!
presetParamChanges_.push_back({ index, value });
} else {
LOG_DEBUG("PluginHandle: parameter " << index << " automated on UI thread");
// UI queue is bounded! For now, just sleep until the other side has drained the queue.
ShmUICommand cmd(Command::ParamAutomated, id_);
cmd.paramAutomated.index = index;
cmd.paramAutomated.value = value;
int counter = 0;
while (!server_->postUIThread(cmd)){
std::this_thread::sleep_for(std::chrono::milliseconds(1));
counter++;
if (counter > 1000) {
LOG_WARNING("PluginHandle (" << id_ << "): postUIThread() blocked for over 1 second");
break;
}
}
paramAutomated_.emplace(index, value);
}
} else {
LOG_DEBUG("PluginHandle: parameter automated on RT thread");
Command cmd(Command::ParamAutomated);
cmd.paramAutomated.index = index;
cmd.paramAutomated.value = value;
events_.push_back(cmd);
}
}
void PluginHandle::latencyChanged(int nsamples) {
if (UIThread::isCurrentThread()){
LOG_DEBUG("UI thread: LatencyChanged");
ShmUICommand cmd(Command::LatencyChanged, id_);
cmd.latency = nsamples;
// UI queue is bounded!
if (!server_->postUIThread(cmd)) {
LOG_WARNING("PluginHandle (" << id_ << "): couldn't post latency change!");
}
} else {
Command cmd(Command::LatencyChanged);
cmd.i = nsamples;
events_.push_back(cmd);
}
}
void PluginHandle::updateDisplay() {
// don't send yet! we first need to update the parameter
// cache and send the new values to the client.
updateDisplay_.store(true);
}
void PluginHandle::midiEvent(const MidiEvent& event) {
if (UIThread::isCurrentThread()){
// ignore for now
} else {
Command cmd(Command::MidiReceived);
cmd.midi = event;
events_.push_back(cmd);
}
}
void PluginHandle::sysexEvent(const SysexEvent& event) {
if (UIThread::isCurrentThread()){
// ignore for now
} else {
// deep copy!
auto data = new char[event.size];
memcpy(data, event.data, event.size);
Command cmd(Command::SysexReceived);
cmd.sysex.data = data;
cmd.sysex.size = event.size;
cmd.sysex.delta = event.delta;
events_.push_back(cmd);
}
}
void PluginHandle::updateBuffer(){
int total = 0;
for (int i = 0; i < numInputs_; ++i){
total += inputs_[i].numChannels;
}
for (int i = 0; i < numOutputs_; ++i){
total += outputs_[i].numChannels;
}
const int incr = maxBlockSize_ *
(precision_ == ProcessPrecision::Double ? sizeof(double) : sizeof(float));
buffer_.clear(); // force zero initialization
buffer_.resize(total * incr);
// set buffer vectors
auto buf = buffer_.data();
auto setBuffers = [](auto& busses, int count, auto& bufptr, int incr){
for (int i = 0; i < count; ++i){
auto& bus = busses[i];
for (int j = 0; j < bus.numChannels; ++j){
bus.channelData32[j] = (float *)bufptr; // float* and double* have the same size
bufptr += incr;
}
}
};
setBuffers(inputs_, numInputs_, buf, incr);
setBuffers(outputs_, numOutputs_, buf, incr);
assert((buf - buffer_.data()) == buffer_.size());
}
void PluginHandle::process(const ShmCommand &cmd, ShmChannel &channel){
// how to handle channel numbers vs speaker numbers?
if (precision_ == ProcessPrecision::Double){
doProcess<double>(cmd, channel);
} else {
doProcess<float>(cmd, channel);
}
}
template<typename T>
void PluginHandle::doProcess(const ShmCommand& cmd, ShmChannel& channel){
LOG_PROCESS("PluginHandle (" << id_ << "): start processing");
assert(cmd.process.numInputs == numInputs_);
assert(cmd.process.numOutputs == numOutputs_);
ProcessData data;
data.numSamples = cmd.process.numSamples;
data.precision = static_cast<ProcessPrecision>(cmd.process.precision);
data.mode = static_cast<ProcessMode>(cmd.process.mode);
data.numInputs = numInputs_;
data.inputs = inputs_.get();
data.numOutputs = numOutputs_;
data.outputs = outputs_.get();
// read audio input data
for (int i = 0; i < data.numInputs; ++i){
auto& bus = data.inputs[i];
LOG_PROCESS("PluginHandle (" << id_ << "): read input bus " << i << " with "
<< bus.numChannels << " channels");
// read channels
for (int j = 0; j < bus.numChannels; ++j){
auto chn = (T *)bus.channelData32[j];
const void* msg;
size_t size;
if (channel.getMessage(msg, size)){
// size can be larger because of message
// alignment - don't use in std::copy!
assert(size >= data.numSamples * sizeof(T));
auto buf = (const float *)msg;
std::copy(buf, buf + data.numSamples, chn);
} else {
std::fill(chn, chn + data.numSamples, 0);
LOG_ERROR("PluginClient: missing channel " << j
<< " for audio input bus " << i);
}
}
}
// read and dispatch commands
LOG_PROCESS("PluginHandle (" << id_ << "): dispatch commands");
dispatchCommands(channel);
// process audio
LOG_PROCESS("PluginHandle (" << id_ << "): process");
plugin_->process(data);
// send audio output data
channel.clear(); // !
// send output busses
for (int i = 0; i < data.numOutputs; ++i){
auto& bus = data.outputs[i];
LOG_PROCESS("PluginHandle (" << id_ << "): write output bus " << i << " with "
<< bus.numChannels << " channels");
// write all channels sequentially to avoid additional copying.
for (int j = 0; j < bus.numChannels; ++j){
channel.addMessage(bus.channelData32[j], sizeof(T) * data.numSamples);
}
}
// send events
LOG_PROCESS("PluginHandle (" << id_ << "): send events");
sendEvents(channel);
// handle possible display update
if (updateDisplay_.exchange(false)){
sendParameterUpdate(channel);
ShmCommand cmd(Command::UpdateDisplay);
addReply(channel, &cmd, sizeof(ShmCommand));
}
LOG_PROCESS("PluginHandle (" << id_ << "): finished processing");
}
void PluginHandle::dispatchCommands(ShmChannel& channel){
const void *data;
size_t size;
while (channel.getMessage(data, size)){
auto cmd = (const ShmCommand *)data;
switch(cmd->type){
case Command::SetParamValue:
plugin_->setParameter(cmd->paramValue.index, cmd->paramValue.value,
cmd->paramValue.offset);
{
// parameter update event
Command event(Command::ParameterUpdate);
event.paramAutomated.index = cmd->paramValue.index;
event.paramAutomated.value = cmd->paramValue.value;
events_.push_back(event);
}
break;
case Command::SetParamString:
{
auto& param = cmd->paramString;
std::string str((char *)¶m.pstr[1], param.pstr[0]);
if (plugin_->setParameter(param.index, str, param.offset)) {
// parameter update event
Command event(Command::ParameterUpdate);
int index = cmd->paramValue.index;
event.paramAutomated.index = index;
event.paramAutomated.value = plugin_->getParameter(index);
events_.push_back(event);
}
break;
}
case Command::SetProgram:
plugin_->setProgram(cmd->i);
{
// special program change event which cause parameter updates
Command event(Command::ProgramChange);
event.i = cmd->i;
events_.push_back(event);
}
break;
case Command::SetProgramName:
plugin_->setProgramName(cmd->s);
break;
case Command::SetBypass:
plugin_->setBypass(static_cast<Bypass>(cmd->i));
break;
case Command::SetTempo:
plugin_->setTempoBPM(cmd->d);
break;
case Command::SetTimeSignature:
plugin_->setTimeSignature(cmd->timeSig.num, cmd->timeSig.denom);
break;
case Command::SetTransportPlaying:
plugin_->setTransportPlaying(cmd->i);
break;
case Command::SetTransportRecording:
plugin_->setTransportRecording(cmd->i);
break;
case Command::SetTransportAutomationWriting:
plugin_->setTransportAutomationWriting(cmd->i);
break;
case Command::SetTransportAutomationReading:
plugin_->setTransportAutomationReading(cmd->i);
break;
case Command::SetTransportCycleActive:
plugin_->setTransportCycleActive(cmd->i);
break;
case Command::SetTransportCycleStart:
plugin_->setTransportCycleStart(cmd->d);
break;
case Command::SetTransportCycleEnd:
plugin_->setTransportCycleEnd(cmd->d);
break;
case Command::SetTransportPosition:
plugin_->setTransportPosition(cmd->d);
break;
case Command::SendMidi:
plugin_->sendMidiEvent(cmd->midi);
break;
case Command::SendSysex:
{
SysexEvent sysex;
sysex.delta = cmd->sysex.delta;
sysex.size = cmd->sysex.size;
sysex.data =cmd->sysex.data;
plugin_->sendSysexEvent(sysex);
}
break;
default:
LOG_ERROR("PluginHandle (" << id_ << "): unknown RT command " << cmd->type);
break;
}
}
}
void PluginHandle::sendEvents(ShmChannel& channel){
for (auto& event : events_){
switch (event.type){
case Command::ParamAutomated:
case Command::ParameterUpdate:
{
auto index = event.paramAutomated.index;
auto value = event.paramAutomated.value;
paramState_[index] = value;
sendParam(channel, index, value,
event.type == Command::ParamAutomated);
break;
}
case Command::LatencyChanged:
addReply(channel, &event, sizeof(ShmCommand));
break;
case Command::UpdateDisplay:
addReply(channel, &event, sizeof(ShmCommand));
break;
case Command::MidiReceived:
addReply(channel, &event, sizeof(ShmCommand));
break;
case Command::SysexReceived:
{
auto size = CommandSize(ShmCommand, sysex, event.sysex.size);
auto reply = (ShmCommand *)alloca(size);
reply->type = event.type;
reply->sysex.delta = event.sysex.delta;
reply->sysex.size = event.sysex.size;
memcpy(reply->sysex.data, event.sysex.data, event.sysex.size);
addReply(channel, reply, size);
break;
}
case Command::ProgramChange:
sendParameterUpdate(channel);
break;
default:
LOG_ERROR("PluginHandle::sendEvents: unknown event type " << event.type);
break;
}
}
events_.clear(); // !
// handle parameter automation from UI thread
int count = 0;
Param param;
while (count < paramAutomationRateLimit &&
paramAutomated_.pop(param)){
// NOTE: this is only necessary to keep the parameter cache
// in the client and server in sync with the plugin state.
// The actual automation message is sent to the UI queue
// in parameterAutomated()!
//
// Check if the value has changed to avoid redundant messages.
// E.g. some bad plugins will send *hundreds* of paramter automation
// notifications when the user loads a preset in the plugin UI.
// (Good plugins send the UpdateDisplay instead.)
if (paramState_[param.index] != param.value) {
sendParam(channel, param.index, param.value, false);
paramState_[param.index] = param.value;
}
count++;
}
}
void PluginHandle::sendParameterUpdate(ShmChannel& channel){
// compare new param state with cached one
// and send all parameters that have changed
auto numParams = plugin_->info().numParameters();
for (int i = 0; i < numParams; ++i){
auto value = plugin_->getParameter(i);
if (value != paramState_[i]){
sendParam(channel, i, value, false);
paramState_[i] = value;
}
}
}
void PluginHandle::sendPresetParamChanges(ShmChannel& channel) {
// Dispatch parameter automations caught during preset change,
// see parameterAutomated().
// NB: in theory we should protect presetParamChanges_ with a mutex,
// but items are only ever pushed in the same call stack.
for (auto& p : presetParamChanges_) {
sendParam(channel, p.index, p.value, true);
}
presetParamChanges_.clear();
}
void PluginHandle::sendProgramUpdate(ShmChannel &channel, bool bank){
auto sendProgramName = [&](int index, std::string_view name){
auto size = CommandSize(ShmCommand, programName, name.size() + 1);
auto reply = (ShmCommand *)alloca(size);
reply->type = Command::ProgramNameIndexed;
reply->programName.index = index;
memcpy(reply->programName.name, name.data(), name.size() + 1);
addReply(channel, reply, size);
};
if (bank){
// send program number
ShmCommand reply(Command::ProgramNumber);
reply.i = plugin_->getProgram();
addReply(channel, &reply, sizeof(reply));
// send all program names
int numPrograms = plugin_->info().numPrograms();
for (int i = 0; i < numPrograms; ++i){
sendProgramName(i, plugin_->getProgramNameIndexed(i));
}
} else {
// send current program name
if (plugin_->info().numPrograms() > 0){
sendProgramName(plugin_->getProgram(), plugin_->getProgramName());
}
}
}
void PluginHandle::sendParam(ShmChannel &channel, int index,
float value, bool automated)
{
ParamStringBuffer display;
auto displaySize = plugin_->getParameterString(index, display);
// NB: use extra byte from pstr[1] for pascal string size!
auto cmdSize = CommandSize(ShmCommand, paramState, displaySize);
auto reply = (ShmCommand *)alloca(cmdSize);
new (reply) ShmCommand(automated ? Command::ParamAutomated
: Command::ParameterUpdate);
reply->paramState.index = index;
reply->paramState.value = value;
reply->paramState.pstr[0] = displaySize;
memcpy(&reply->paramState.pstr[1], display.data(), displaySize);
addReply(channel, reply, cmdSize);
}
bool PluginHandle::addReply(ShmChannel& channel, const void *cmd, size_t size){
return channel.addMessage(cmd, size);
}
/*////////////////// PluginServer ////////////////*/
PluginServer::PluginServer(int pid, const std::string& shmPath)
{
LOG_DEBUG("PluginServer: parent: " << pid << ", path: " << shmPath);
#if VST_HOST_SYSTEM == VST_WINDOWS
parent_ = OpenProcess(SYNCHRONIZE, FALSE, pid);
if (!parent_){
throw Error(Error::SystemError, "OpenProcess() failed: "
+ errorMessage(GetLastError()));
}
#else
parent_ = pid;
LOG_DEBUG("PluginServer: self: " << getpid() << ", parent: " << getppid());
#endif
shm_ = std::make_unique<ShmInterface>();
shm_->connect(shmPath);
LOG_DEBUG("PluginServer: connected to shared memory interface");
// check version (for now it must match exactly)
int major, minor, patch;
shm_->getVersion(major, minor, patch);
if (major == VERSION_MAJOR && minor == VERSION_MINOR
&& patch == VERSION_PATCH) {
LOG_DEBUG("version: " << major << "." << minor << "." << patch);
} else {
throw Error(Error::PluginError, "host app version mismatch");
}
// setup UI event loop
LOG_DEBUG("PluginServer: setup event loop");
UIThread::setup();
// install UI poll function
LOG_DEBUG("PluginServer: add UI poll function");
pollFunction_ = UIThread::addPollFunction([](void *x){
static_cast<PluginServer *>(x)->pollUIThread();
}, this);
// create threads for NRT + RT channels
LOG_DEBUG("PluginServer: create threads");
running_ = true;
for (int i = Channel::NRT; i < shm_->numChannels(); ++i){
auto thread = std::thread(&PluginServer::runThread,
this, &shm_->getChannel(i));
threads_.push_back(std::move(thread));
}
LOG_DEBUG("PluginServer: ready");
}
PluginServer::~PluginServer(){
LOG_DEBUG("PluginServer: free");
UIThread::removePollFunction(pollFunction_);
for (auto& thread : threads_){
thread.join();
}
// properly destruct all remaining plugins
// on the UI thread (in case the parent crashed)
if (!plugins_.empty()){
LOG_DEBUG("PluginServer: release remaining " << plugins_.size() << " plugins");
defer([&](){
plugins_.clear();
});
LOG_DEBUG("PluginServer: released plugins");
}
#if VST_HOST_SYSTEM == VST_WINDOWS
CloseHandle(parent_);
#endif
}
void PluginServer::run(){
LOG_DEBUG("PluginServer: run");
UIThread::run();
}
bool PluginServer::postUIThread(const ShmUICommand& cmd){
// sizeof(cmd) is a bit lazy, but we don't care about size here
auto& channel = shm_->getChannel(Channel::UISend);
return channel.writeMessage(&cmd, sizeof(cmd));
}
void PluginServer::pollUIThread(){
// poll UI events and dispatch to plugin
auto& channel = shm_->getChannel(Channel::UIReceive);
char buffer[64]; // larger than ShmCommand!
size_t size = sizeof(buffer);
// read all available events
while (channel.readMessage(buffer, size)){
auto cmd = (const ShmUICommand *)buffer;
auto plugin = findPlugin(cmd->id);
if (plugin){
plugin->handleUICommand(*cmd);
} else {
// UI commands run asynchronously, so they can be "late"
switch (cmd->type) {
case Command::WindowOpen:
case Command::WindowClose:
case Command::WindowSetPos:
case Command::WindowSetSize:
break;
default:
LOG_ERROR("PluginServer::pollUIThread: couldn't find plugin "
<< cmd->id << " for command " << cmd->type);
break;
}
}
size = sizeof(buffer); // reset size!
}
checkIfParentAlive();
}
void PluginServer::checkIfParentAlive(){
#if VST_HOST_SYSTEM == VST_WINDOWS
bool alive = WaitForSingleObject(parent_, 0) == WAIT_TIMEOUT;
#else
#ifndef __WINE__
bool alive = getppid() == parent_;
#else
// We can't do the above on Wine because we might have been
// forked in a Wine launcher app. Instead we use the kill()
// function to check if the parent is still alive.
bool alive = (kill(parent_, 0) == 0) || (errno == EPERM);
#endif
#endif
if (!alive){
// tell the shared memory interface that it is now the owner
// so that it will unlink the shared memory object (on Unix)
shm_->setOrphaned();
LOG_WARNING("PluginServer: parent (" << parent_ << ") terminated!");
quit();
}
}
void PluginServer::runThread(ShmChannel *channel){
// raise thread priority for RT threads, but not for dedicated NRT thread!
if (channel->name() != "nrt") {
setThreadPriority(Priority::High);
}
// while running, wait for requests and dispatch to plugin
// Quit command -> quit()
while (running_.load(std::memory_order_relaxed)) {
// LOG_DEBUG(channel->name() << ": wait");
channel->wait();
// LOG_DEBUG(channel->name() << ": wake up");
channel->reset();
const void *msg;
size_t size;
if (channel->getMessage(msg, size)){
handleCommand(*channel, *reinterpret_cast<const ShmCommand *>(msg));
} else if (running_) {
LOG_ERROR("PluginServer: '" << channel->name()
<< "': couldn't get message");
// ?
channel->postReply();
}
}
LOG_DEBUG(channel->name() << ": quit");
}
void PluginServer::handleCommand(ShmChannel& channel,
const ShmCommand &cmd){
PluginHandle *plugin;
try {
switch (cmd.type){
case Command::CreatePlugin:
createPlugin(cmd.id, cmd.plugin.data,
cmd.plugin.size, channel);
break;
case Command::DestroyPlugin:
destroyPlugin(cmd.id);
break;
case Command::Quit:
quit();
break;
default:
plugin = findPlugin(cmd.id);
if (plugin){
plugin->handleRequest(cmd, channel);
} else {
LOG_ERROR("PluginServer: couldn't find plugin " << cmd.id);
}
break;
}
} catch (const Error& e) {
LOG_DEBUG("exception: " << e.what());
channel.clear(); // !
std::string msg = e.what();
char buf[256]; // can't use alloca() in catch block
auto size = CommandSize(ShmCommand, error, msg.size() + 1);
auto reply = new (buf) ShmCommand(Command::Error);
reply->error.code = e.code();
memcpy(reply->error.msg, msg.c_str(), msg.size() + 1);
channel.addMessage(reply, size);
}
channel.postReply();
}
void PluginServer::createPlugin(uint32_t id, const char *data, size_t size,
ShmChannel& channel){
LOG_DEBUG("PluginServer: create plugin " << id);
PluginDesc::const_ptr info;
if (size){
// info is transmitted in place
std::stringstream ss;
ss << std::string(data, size);
info = pluginDict_.readPlugin(ss);
} else {
// info is transmitted via a tmp file
File file(data);
if (!file.is_open()){
throw Error(Error::PluginError, "couldn't read plugin info!");
}
info = pluginDict_.readPlugin(file);
}
LOG_DEBUG("PluginServer: did read plugin info");
if (!info){
// shouldn't happen...
throw Error(Error::PluginError, "plugin info out of date!");
}
// create on UI thread!
IPlugin::ptr plugin;
defer([&](){
// open with Mode::Native to avoid infinite recursion!
plugin = info->create(true, false, RunMode::Native);
});
assert(plugin != nullptr);
auto handle = std::make_unique<PluginHandle>(
*this, std::move(plugin), id, channel);
std::lock_guard lock(pluginMutex_);
plugins_.emplace(id, std::move(handle));
}
void PluginServer::destroyPlugin(uint32_t id){
LOG_DEBUG("PluginServer: destroy plugin " << id);
std::unique_lock lock(pluginMutex_);
auto it = plugins_.find(id);
if (it != plugins_.end()){
auto plugin = it->second.release();
plugins_.erase(it);
lock.unlock();
// move to UI thread and release there!
defer([plugin] () { delete plugin; });
} else {
LOG_ERROR("PluginServer::destroyPlugin: chouldn't find plugin " << id);
}
}
PluginHandle * PluginServer::findPlugin(uint32_t id){
std::shared_lock lock(pluginMutex_);
auto it = plugins_.find(id);
if (it != plugins_.end()){
return it->second.get();
} else {
return nullptr;
}
}
void PluginServer::quit(){
LOG_DEBUG("PluginServer: quit");
running_.store(false);
// wake up all threads
for (int i = Channel::NRT; i < shm_->numChannels(); ++i){
shm_->getChannel(i).post();
}
// quit event loop
UIThread::quit();
}
} // vst
|