/* * Carla VST Plugin * Copyright (C) 2011-2013 Filipe Coelho * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation; either version 2 of * the License, or any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * For a full copy of the GNU General Public License see the GPL.txt file */ #include "CarlaPluginInternal.hpp" #ifdef WANT_VST #include "CarlaPluginGui.hpp" #include "CarlaVstUtils.hpp" //#ifdef Q_WS_X11 //# include //#endif CARLA_BACKEND_START_NAMESPACE #if 0 } #endif /*! * @defgroup PluginHints Plugin Hints * @{ */ const unsigned int PLUGIN_CAN_PROCESS_REPLACING = 0x1000; //!< VST Plugin cas use processReplacing() const unsigned int PLUGIN_HAS_COCKOS_EXTENSIONS = 0x2000; //!< VST Plugin has Cockos extensions const unsigned int PLUGIN_USES_OLD_VSTSDK = 0x4000; //!< VST Plugin uses an old VST SDK const unsigned int PLUGIN_WANTS_MIDI_INPUT = 0x8000; //!< VST Plugin wants MIDI input /**@}*/ class VstPlugin : public CarlaPlugin, public CarlaPluginGui::Callback { public: VstPlugin(CarlaEngine* const engine, const unsigned int id) : CarlaPlugin(engine, id), fUnique1(1), fEffect(nullptr), fLastChunk(nullptr), fMidiEventCount(0), fIsProcessing(false), fNeedIdle(false), fUnique2(2) { carla_debug("VstPlugin::VstPlugin(%p, %i)", engine, id); carla_zeroStruct(fMidiEvents, MAX_MIDI_EVENTS*2); carla_zeroStruct(fTimeInfo); for (unsigned short i=0; i < MAX_MIDI_EVENTS*2; ++i) fEvents.data[i] = (VstEvent*)&fMidiEvents[i]; kData->osc.thread.setMode(CarlaPluginThread::PLUGIN_THREAD_VST_GUI); // make plugin valid srand(id); fUnique1 = fUnique2 = rand(); } ~VstPlugin() override { carla_debug("VstPlugin::~VstPlugin()"); // close UI if (fHints & PLUGIN_HAS_GUI) { showGui(false); if (fGui.isOsc) { // Wait a bit first, then force kill if (kData->osc.thread.isRunning() && ! kData->osc.thread.wait(kData->engine->getOptions().oscUiTimeout)) { carla_stderr("VST OSC-GUI thread still running, forcing termination now"); kData->osc.thread.terminate(); } } } kData->singleMutex.lock(); kData->masterMutex.lock(); CARLA_ASSERT(! fIsProcessing); if (kData->active) { deactivate(); kData->active = false; } if (fEffect != nullptr) { dispatcher(effClose, 0, 0, nullptr, 0.0f); fEffect = nullptr; } // make plugin invalid fUnique2 += 1; if (fLastChunk != nullptr) { std::free(fLastChunk); fLastChunk = nullptr; } clearBuffers(); } // ------------------------------------------------------------------- // Information (base) PluginType type() const override { return PLUGIN_VST; } PluginCategory category() override { CARLA_ASSERT(fEffect != nullptr); const intptr_t category(dispatcher(effGetPlugCategory, 0, 0, nullptr, 0.0f)); switch (category) { case kPlugCategSynth: return PLUGIN_CATEGORY_SYNTH; case kPlugCategAnalysis: return PLUGIN_CATEGORY_UTILITY; case kPlugCategMastering: return PLUGIN_CATEGORY_DYNAMICS; case kPlugCategRoomFx: return PLUGIN_CATEGORY_DELAY; case kPlugCategRestoration: return PLUGIN_CATEGORY_UTILITY; case kPlugCategGenerator: return PLUGIN_CATEGORY_SYNTH; } if (fEffect->flags & effFlagsIsSynth) return PLUGIN_CATEGORY_SYNTH; return getPluginCategoryFromName(fName); } long uniqueId() const override { CARLA_ASSERT(fEffect != nullptr); return fEffect->uniqueID; } // ------------------------------------------------------------------- // Information (count) // nothing // ------------------------------------------------------------------- // Information (current data) int32_t chunkData(void** const dataPtr) override { CARLA_ASSERT(fOptions & PLUGIN_OPTION_USE_CHUNKS); CARLA_ASSERT(fEffect != nullptr); CARLA_ASSERT(dataPtr != nullptr); return dispatcher(effGetChunk, 0 /* bank */, 0, dataPtr, 0.0f); } // ------------------------------------------------------------------- // Information (per-plugin data) unsigned int availableOptions() override { CARLA_ASSERT(fEffect != nullptr); if (fEffect == nullptr) return 0x0; unsigned int options = 0x0; options |= PLUGIN_OPTION_MAP_PROGRAM_CHANGES; if (midiInCount() == 0) options |= PLUGIN_OPTION_FIXED_BUFFER; if (fEffect->flags & effFlagsProgramChunks) options |= PLUGIN_OPTION_USE_CHUNKS; if (vstPluginCanDo(fEffect, "receiveVstEvents") || vstPluginCanDo(fEffect, "receiveVstMidiEvent") || (fEffect->flags & effFlagsIsSynth) > 0 || (fHints & PLUGIN_WANTS_MIDI_INPUT)) { options |= PLUGIN_OPTION_SEND_CONTROL_CHANGES; options |= PLUGIN_OPTION_SEND_CHANNEL_PRESSURE; options |= PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH; options |= PLUGIN_OPTION_SEND_PITCHBEND; options |= PLUGIN_OPTION_SEND_ALL_SOUND_OFF; } return options; } float getParameterValue(const uint32_t parameterId) override { CARLA_ASSERT(fEffect != nullptr); CARLA_ASSERT(parameterId < kData->param.count); return fEffect->getParameter(fEffect, parameterId); } void getLabel(char* const strBuf) override { CARLA_ASSERT(fEffect != nullptr); strBuf[0] = '\0'; dispatcher(effGetProductString, 0, 0, strBuf, 0.0f); } void getMaker(char* const strBuf) override { CARLA_ASSERT(fEffect != nullptr); strBuf[0] = '\0'; dispatcher(effGetVendorString, 0, 0, strBuf, 0.0f); } void getCopyright(char* const strBuf) override { CARLA_ASSERT(fEffect != nullptr); strBuf[0] = '\0'; dispatcher(effGetVendorString, 0, 0, strBuf, 0.0f); } void getRealName(char* const strBuf) override { CARLA_ASSERT(fEffect != nullptr); strBuf[0] = '\0'; dispatcher(effGetEffectName, 0, 0, strBuf, 0.0f); } void getParameterName(const uint32_t parameterId, char* const strBuf) override { CARLA_ASSERT(fEffect != nullptr); CARLA_ASSERT(parameterId < kData->param.count); strBuf[0] = '\0'; dispatcher(effGetParamName, parameterId, 0, strBuf, 0.0f); } void getParameterText(const uint32_t parameterId, char* const strBuf) override { CARLA_ASSERT(fEffect != nullptr); CARLA_ASSERT(parameterId < kData->param.count); strBuf[0] = '\0'; dispatcher(effGetParamDisplay, parameterId, 0, strBuf, 0.0f); if (strBuf[0] == '\0') std::snprintf(strBuf, STR_MAX, "%f", getParameterValue(parameterId)); } void getParameterUnit(const uint32_t parameterId, char* const strBuf) override { CARLA_ASSERT(fEffect != nullptr); CARLA_ASSERT(parameterId < kData->param.count); strBuf[0] = '\0'; dispatcher(effGetParamLabel, parameterId, 0, strBuf, 0.0f); } // ------------------------------------------------------------------- // Set data (state) // nothing // ------------------------------------------------------------------- // Set data (internal stuff) void setName(const char* const newName) override { CarlaPlugin::setName(newName); if (kData->gui != nullptr) kData->gui->setWindowTitle(QString("%1 (GUI)").arg((const char*)fName)); } // ------------------------------------------------------------------- // Set data (plugin-specific stuff) void setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) override { CARLA_ASSERT(fEffect != nullptr); CARLA_ASSERT(parameterId < kData->param.count); const float fixedValue(kData->param.fixValue(parameterId, value)); fEffect->setParameter(fEffect, parameterId, fixedValue); CarlaPlugin::setParameterValue(parameterId, fixedValue, sendGui, sendOsc, sendCallback); } void setChunkData(const char* const stringData) override { CARLA_ASSERT(fOptions & PLUGIN_OPTION_USE_CHUNKS); CARLA_ASSERT(fEffect != nullptr); CARLA_ASSERT(stringData != nullptr); if (fLastChunk != nullptr) { std::free(fLastChunk); fLastChunk = nullptr; } QByteArray chunk(QByteArray::fromBase64(stringData)); CARLA_ASSERT(chunk.size() > 0); if (chunk.size() > 0) { fLastChunk = std::malloc(chunk.size()); std::memcpy(fLastChunk, chunk.constData(), chunk.size()); { const ScopedSingleProcessLocker spl(this, true); dispatcher(effSetChunk, 0 /* bank */, chunk.size(), fLastChunk, 0.0f); } // simulate an updateDisplay callback handleAudioMasterCallback(audioMasterUpdateDisplay, 0, 0, nullptr, 0.0f); } } void setProgram(int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) override { CARLA_ASSERT(fEffect != nullptr); CARLA_ASSERT(index >= -1 && index < static_cast(kData->prog.count)); if (index < -1) index = -1; else if (index > static_cast(kData->prog.count)) return; if (index >= 0) { const ScopedSingleProcessLocker spl(this, (sendGui || sendOsc || sendCallback)); dispatcher(effBeginSetProgram, 0, 0, nullptr, 0.0f); dispatcher(effSetProgram, 0, index, nullptr, 0.0f); dispatcher(effEndSetProgram, 0, 0, nullptr, 0.0f); } CarlaPlugin::setProgram(index, sendGui, sendOsc, sendCallback); } // ------------------------------------------------------------------- // Set gui stuff void showGui(const bool yesNo) override { if (fGui.isVisible == yesNo) return; if (fGui.isOsc) { if (yesNo) { kData->osc.thread.start(); } else { if (kData->osc.data.target != nullptr) { osc_send_hide(&kData->osc.data); osc_send_quit(&kData->osc.data); kData->osc.data.free(); } if (kData->osc.thread.isRunning() && ! kData->osc.thread.wait(kData->engine->getOptions().oscUiTimeout)) kData->osc.thread.terminate(); } } else { if (yesNo) { CARLA_ASSERT(kData->gui == nullptr); if (kData->gui == nullptr) { CarlaPluginGui::Options guiOptions; guiOptions.parented = true; guiOptions.resizable = false; kData->gui = new CarlaPluginGui(kData->engine, this, guiOptions); } int32_t value = 0; #ifdef Q_WS_X11 //value = (intptr_t)QX11Info::display(); #endif void* const ptr = kData->gui->getContainerWinId(); if (dispatcher(effEditOpen, 0, value, ptr, 0.0f) != 0) { ERect* vstRect = nullptr; dispatcher(effEditGetRect, 0, 0, &vstRect, 0.0f); if (vstRect != nullptr) { const int16_t width(vstRect->right - vstRect->left); const int16_t height(vstRect->bottom - vstRect->top); CARLA_SAFE_ASSERT_INT2(width > 1 && height > 1, width, height); if (width > 1 && height > 1) kData->gui->setSize(width, height); else if (fGui.lastWidth > 1 && fGui.lastHeight > 1) kData->gui->setSize(fGui.lastWidth, fGui.lastHeight); } kData->gui->setWindowTitle(QString("%1 (GUI)").arg((const char*)fName)); kData->gui->show(); } else { if (kData->gui != nullptr) { kData->gui->close(); delete kData->gui; kData->gui = nullptr; } kData->engine->callback(CALLBACK_ERROR, fId, 0, 0, 0.0f, "Plugin refused to open its own UI"); kData->engine->callback(CALLBACK_SHOW_GUI, fId, -1, 0, 0.0f, nullptr); return; } } else { CARLA_ASSERT(kData->gui != nullptr); dispatcher(effEditClose, 0, 0, nullptr, 0.0f); if (kData->gui != nullptr) { fGui.lastWidth = kData->gui->width(); fGui.lastHeight = kData->gui->height(); kData->gui->close(); delete kData->gui; kData->gui = nullptr; } } } fGui.isVisible = yesNo; } void idleGui() override { #ifdef VESTIGE_HEADER if (fEffect != nullptr /*&& effect->ptr1*/) #else if (fEffect != nullptr /*&& effect->resvd1*/) #endif { if (fNeedIdle) dispatcher(effIdle, 0, 0, nullptr, 0.0f); if (fGui.isVisible && ! fGui.isOsc) { dispatcher(effEditIdle, 0, 0, nullptr, 0.0f); //kData->gui->idle(); } } CarlaPlugin::idleGui(); } // ------------------------------------------------------------------- // Plugin state void reload() override { carla_debug("VstPlugin::reload() - start"); CARLA_ASSERT(kData->engine != nullptr); CARLA_ASSERT(fEffect != nullptr); if (kData->engine == nullptr) return; if (fEffect == nullptr) return; const ProcessMode processMode(kData->engine->getProccessMode()); // Safely disable plugin for reload const ScopedDisabler sd(this); if (kData->active) deactivate(); clearBuffers(); uint32_t aIns, aOuts, mIns, mOuts, params, j; bool needsCtrlIn, needsCtrlOut; needsCtrlIn = needsCtrlOut = false; aIns = fEffect->numInputs; aOuts = fEffect->numOutputs; params = fEffect->numParams; if (vstPluginCanDo(fEffect, "receiveVstEvents") || vstPluginCanDo(fEffect, "receiveVstMidiEvent") || (fEffect->flags & effFlagsIsSynth) > 0 || (fHints & PLUGIN_WANTS_MIDI_INPUT)) { mIns = 1; needsCtrlIn = true; } else mIns = 0; if (vstPluginCanDo(fEffect, "sendVstEvents") || vstPluginCanDo(fEffect, "sendVstMidiEvent")) { mOuts = 1; needsCtrlOut = true; } else mOuts = 0; if (aIns > 0) { kData->audioIn.createNew(aIns); } if (aOuts > 0) { kData->audioOut.createNew(aOuts); needsCtrlIn = true; } if (params > 0) { kData->param.createNew(params); needsCtrlIn = true; } const uint portNameSize(kData->engine->maxPortNameSize()); CarlaString portName; // Audio Ins for (j=0; j < aIns; ++j) { portName.clear(); if (processMode == PROCESS_MODE_SINGLE_CLIENT) { portName = fName; portName += ":"; } if (aIns > 1) { portName += "input_"; portName += CarlaString(j+1); } else portName += "input"; portName.truncate(portNameSize); kData->audioIn.ports[j].port = (CarlaEngineAudioPort*)kData->client->addPort(kEnginePortTypeAudio, portName, true); kData->audioIn.ports[j].rindex = j; } // Audio Outs for (j=0; j < aOuts; ++j) { portName.clear(); if (processMode == PROCESS_MODE_SINGLE_CLIENT) { portName = fName; portName += ":"; } if (aOuts > 1) { portName += "output_"; portName += CarlaString(j+1); } else portName += "output"; portName.truncate(portNameSize); kData->audioOut.ports[j].port = (CarlaEngineAudioPort*)kData->client->addPort(kEnginePortTypeAudio, portName, false); kData->audioOut.ports[j].rindex = j; } for (j=0; j < params; ++j) { kData->param.data[j].type = PARAMETER_INPUT; kData->param.data[j].index = j; kData->param.data[j].rindex = j; kData->param.data[j].hints = 0x0; kData->param.data[j].midiChannel = 0; kData->param.data[j].midiCC = -1; float min, max, def, step, stepSmall, stepLarge; VstParameterProperties prop; carla_zeroStruct(prop); if (fHints & PLUGIN_HAS_COCKOS_EXTENSIONS) { double range[2] = { 0.0, 1.0 }; if (dispatcher(effVendorSpecific, 0xdeadbef0, j, range, 0.0f) >= 0xbeef) { min = range[0]; max = range[1]; if (min > max) max = min; else if (max < min) min = max; if (max - min == 0.0f) { carla_stderr2("WARNING - Broken plugin parameter: max - min == 0.0f (with cockos extensions)"); max = min + 0.1f; } } else { min = 0.0f; max = 1.0f; } if (dispatcher(effVendorSpecific, kVstParameterUsesIntStep, j, nullptr, 0.0f) >= 0xbeef) { step = 1.0f; stepSmall = 1.0f; stepLarge = 10.0f; } else { float range = max - min; step = range/100.0f; stepSmall = range/1000.0f; stepLarge = range/10.0f; } } else if (dispatcher(effGetParameterProperties, j, 0, &prop, 0) == 1) { if (prop.flags & kVstParameterUsesIntegerMinMax) { min = float(prop.minInteger); max = float(prop.maxInteger); if (min > max) max = min; else if (max < min) min = max; if (max - min == 0.0f) { carla_stderr2("WARNING - Broken plugin parameter: max - min == 0.0f"); max = min + 0.1f; } } else { min = 0.0f; max = 1.0f; } if (prop.flags & kVstParameterIsSwitch) { step = max - min; stepSmall = step; stepLarge = step; kData->param.data[j].hints |= PARAMETER_IS_BOOLEAN; } else if (prop.flags & kVstParameterUsesIntStep) { step = float(prop.stepInteger); stepSmall = float(prop.stepInteger)/10; stepLarge = float(prop.largeStepInteger); kData->param.data[j].hints |= PARAMETER_IS_INTEGER; } else if (prop.flags & kVstParameterUsesFloatStep) { step = prop.stepFloat; stepSmall = prop.smallStepFloat; stepLarge = prop.largeStepFloat; } else { float range = max - min; step = range/100.0f; stepSmall = range/1000.0f; stepLarge = range/10.0f; } if (prop.flags & kVstParameterCanRamp) kData->param.data[j].hints |= PARAMETER_IS_LOGARITHMIC; } else { min = 0.0f; max = 1.0f; step = 0.001f; stepSmall = 0.0001f; stepLarge = 0.1f; } kData->param.data[j].hints |= PARAMETER_IS_ENABLED; #ifndef BUILD_BRIDGE kData->param.data[j].hints |= PARAMETER_USES_CUSTOM_TEXT; #endif if ((fHints & PLUGIN_USES_OLD_VSTSDK) != 0 || dispatcher(effCanBeAutomated, j, 0, nullptr, 0.0f) == 1) kData->param.data[j].hints |= PARAMETER_IS_AUTOMABLE; // no such thing as VST default parameters def = fEffect->getParameter(fEffect, j); if (def < min) def = min; else if (def > max) def = max; kData->param.ranges[j].min = min; kData->param.ranges[j].max = max; kData->param.ranges[j].def = def; kData->param.ranges[j].step = step; kData->param.ranges[j].stepSmall = stepSmall; kData->param.ranges[j].stepLarge = stepLarge; } if (needsCtrlIn) { portName.clear(); if (processMode == PROCESS_MODE_SINGLE_CLIENT) { portName = fName; portName += ":"; } portName += "events-in"; portName.truncate(portNameSize); kData->event.portIn = (CarlaEngineEventPort*)kData->client->addPort(kEnginePortTypeEvent, portName, true); } if (needsCtrlOut) { portName.clear(); if (processMode == PROCESS_MODE_SINGLE_CLIENT) { portName = fName; portName += ":"; } portName += "events-out"; portName.truncate(portNameSize); kData->event.portOut = (CarlaEngineEventPort*)kData->client->addPort(kEnginePortTypeEvent, portName, false); } // plugin hints const intptr_t vstCategory = dispatcher(effGetPlugCategory, 0, 0, nullptr, 0.0f); fHints = 0x0; if (vstCategory == kPlugCategSynth || vstCategory == kPlugCategGenerator) fHints |= PLUGIN_IS_SYNTH; if (fEffect->flags & effFlagsHasEditor) { fHints |= PLUGIN_HAS_GUI; if (! fGui.isOsc) fHints |= PLUGIN_HAS_SINGLE_THREAD; } if (dispatcher(effGetVstVersion, 0, 0, nullptr, 0.0f) < kVstVersion) fHints |= PLUGIN_USES_OLD_VSTSDK; if ((fEffect->flags & effFlagsCanReplacing) != 0 && fEffect->processReplacing != fEffect->process) fHints |= PLUGIN_CAN_PROCESS_REPLACING; if (fEffect->flags & effFlagsHasEditor) fHints |= PLUGIN_HAS_GUI; if (static_cast(dispatcher(effCanDo, 0, 0, (void*)"hasCockosExtensions", 0.0f)) == 0xbeef0000) fHints |= PLUGIN_HAS_COCKOS_EXTENSIONS; if (aOuts > 0 && (aIns == aOuts || aIns == 1)) fHints |= PLUGIN_CAN_DRYWET; if (aOuts > 0) fHints |= PLUGIN_CAN_VOLUME; if (aOuts >= 2 && aOuts % 2 == 0) fHints |= PLUGIN_CAN_BALANCE; // extra plugin hints kData->extraHints = 0x0; if (mIns > 0) kData->extraHints |= PLUGIN_HINT_HAS_MIDI_IN; if (mOuts > 0) kData->extraHints |= PLUGIN_HINT_HAS_MIDI_OUT; if (aIns <= 2 && aOuts <= 2 && (aIns == aOuts || aIns == 0 || aOuts == 0)) kData->extraHints |= PLUGIN_HINT_CAN_RUN_RACK; // dummy pre-start to get latency and wantEvents() on old plugins { activate(); deactivate(); } // check latency if (fHints & PLUGIN_CAN_DRYWET) { #ifdef VESTIGE_HEADER char* const empty3Ptr = &fEffect->empty3[0]; int32_t* initialDelayPtr = (int32_t*)empty3Ptr; kData->latency = *initialDelayPtr; #else kData->latency = fEffect->initialDelay; #endif kData->client->setLatency(kData->latency); kData->recreateLatencyBuffers(); } // special plugin fixes // 1. IL Harmless - disable threaded processing if (fEffect->uniqueID == 1229484653) { char strBuf[STR_MAX+1] = { '\0' }; getLabel(strBuf); if (std::strcmp(strBuf, "IL Harmless") == 0) { // TODO - disable threaded processing } } bufferSizeChanged(kData->engine->getBufferSize()); reloadPrograms(true); if (kData->active) activate(); carla_debug("VstPlugin::reload() - end"); } void reloadPrograms(const bool init) override { carla_debug("VstPlugin::reloadPrograms(%s)", bool2str(init)); uint32_t i, oldCount = kData->prog.count; const int32_t current = kData->prog.current; // Delete old programs kData->prog.clear(); // Query new programs uint32_t count = static_cast(fEffect->numPrograms); if (count > 0) { kData->prog.createNew(count); // Update names for (i=0; i < count; ++i) { char strBuf[STR_MAX+1] = { '\0' }; if (dispatcher(effGetProgramNameIndexed, i, 0, strBuf, 0.0f) != 1) { // program will be [re-]changed later dispatcher(effSetProgram, 0, i, nullptr, 0.0f); dispatcher(effGetProgramName, 0, 0, strBuf, 0.0f); } kData->prog.names[i] = strdup(strBuf); } } #ifndef BUILD_BRIDGE // Update OSC Names if (kData->engine->isOscControlRegistered()) { kData->engine->osc_send_control_set_program_count(fId, count); for (i=0; i < count; ++i) kData->engine->osc_send_control_set_program_name(fId, i, kData->prog.names[i]); } #endif if (init) { if (count > 0) setProgram(0, false, false, false); } else { // Check if current program is invalid bool programChanged = false; if (count == oldCount+1) { // one program added, probably created by user kData->prog.current = oldCount; programChanged = true; } else if (current < 0 && count > 0) { // programs exist now, but not before kData->prog.current = 0; programChanged = true; } else if (current >= 0 && count == 0) { // programs existed before, but not anymore kData->prog.current = -1; programChanged = true; } else if (current >= static_cast(count)) { // current program > count kData->prog.current = 0; programChanged = true; } else { // no change kData->prog.current = current; } if (programChanged) { setProgram(kData->prog.current, true, true, true); } else { // Program was changed during update, re-set it if (kData->prog.current >= 0) dispatcher(effSetProgram, 0, kData->prog.current, nullptr, 0.0f); } kData->engine->callback(CALLBACK_RELOAD_PROGRAMS, fId, 0, 0, 0.0f, nullptr); } } // ------------------------------------------------------------------- // Plugin processing void activate() override { dispatcher(effMainsChanged, 0, 1, nullptr, 0.0f); dispatcher(effStartProcess, 0, 0, nullptr, 0.0f); } void deactivate() override { dispatcher(effStopProcess, 0, 0, nullptr, 0.0f); dispatcher(effMainsChanged, 0, 0, nullptr, 0.0f); } void process(float** const inBuffer, float** const outBuffer, const uint32_t frames) override { uint32_t i, k; // -------------------------------------------------------------------------------------------------------- // Check if active if (! kData->active) { // disable any output sound for (i=0; i < kData->audioOut.count; ++i) carla_zeroFloat(outBuffer[i], frames); return; } fMidiEventCount = 0; carla_zeroStruct(fMidiEvents, MAX_MIDI_EVENTS*2); // -------------------------------------------------------------------------------------------------------- // Check if needs reset if (kData->needsReset) { if (fOptions & PLUGIN_OPTION_SEND_ALL_SOUND_OFF) { for (k=0, i=MAX_MIDI_CHANNELS; k < MAX_MIDI_CHANNELS; ++k) { fMidiEvents[k].type = kVstMidiType; fMidiEvents[k].byteSize = sizeof(VstMidiEvent); fMidiEvents[k].midiData[0] = MIDI_STATUS_CONTROL_CHANGE + k; fMidiEvents[k].midiData[1] = MIDI_CONTROL_ALL_NOTES_OFF; fMidiEvents[k+i].type = kVstMidiType; fMidiEvents[k+i].byteSize = sizeof(VstMidiEvent); fMidiEvents[k+i].midiData[0] = MIDI_STATUS_CONTROL_CHANGE + k; fMidiEvents[k+i].midiData[1] = MIDI_CONTROL_ALL_SOUND_OFF; } fMidiEventCount = MAX_MIDI_CHANNELS*2; } else if (kData->ctrlChannel >= 0 && kData->ctrlChannel < MAX_MIDI_CHANNELS) { for (k=0; k < MAX_MIDI_NOTE; ++k) { fMidiEvents[k].type = kVstMidiType; fMidiEvents[k].byteSize = sizeof(VstMidiEvent); fMidiEvents[k].midiData[0] = MIDI_STATUS_NOTE_OFF + kData->ctrlChannel; fMidiEvents[k].midiData[1] = k; } fMidiEventCount = MAX_MIDI_NOTE; } if (kData->latency > 0) { for (i=0; i < kData->audioIn.count; ++i) carla_zeroFloat(kData->latencyBuffers[i], kData->latency); } kData->needsReset = false; } CARLA_PROCESS_CONTINUE_CHECK; // -------------------------------------------------------------------------------------------------------- // Set TimeInfo const EngineTimeInfo& timeInfo(kData->engine->getTimeInfo()); fTimeInfo.flags = kVstTransportChanged; if (timeInfo.playing) fTimeInfo.flags |= kVstTransportPlaying; fTimeInfo.samplePos = timeInfo.frame; fTimeInfo.sampleRate = kData->engine->getSampleRate(); if (timeInfo.usecs != 0) { fTimeInfo.nanoSeconds = timeInfo.usecs/1000; fTimeInfo.flags |= kVstNanosValid; } if (timeInfo.valid & EngineTimeInfo::ValidBBT) { double ppqBar = double(timeInfo.bbt.bar - 1) * timeInfo.bbt.beatsPerBar; double ppqBeat = double(timeInfo.bbt.beat - 1); double ppqTick = double(timeInfo.bbt.tick) / timeInfo.bbt.ticksPerBeat; // PPQ Pos fTimeInfo.ppqPos = ppqBar + ppqBeat + ppqTick; fTimeInfo.flags |= kVstPpqPosValid; // Tempo fTimeInfo.tempo = timeInfo.bbt.beatsPerMinute; fTimeInfo.flags |= kVstTempoValid; // Bars fTimeInfo.barStartPos = ppqBar; fTimeInfo.flags |= kVstBarsValid; // Time Signature fTimeInfo.timeSigNumerator = timeInfo.bbt.beatsPerBar; fTimeInfo.timeSigDenominator = timeInfo.bbt.beatType; fTimeInfo.flags |= kVstTimeSigValid; } else { // Tempo fTimeInfo.tempo = 120.0; fTimeInfo.flags |= kVstTempoValid; // Time Signature fTimeInfo.timeSigNumerator = 4; fTimeInfo.timeSigDenominator = 4; fTimeInfo.flags |= kVstTimeSigValid; // Missing info fTimeInfo.ppqPos = 0.0; fTimeInfo.barStartPos = 0.0; } CARLA_PROCESS_CONTINUE_CHECK; // -------------------------------------------------------------------------------------------------------- // Event Input and Processing if (kData->event.portIn != nullptr) { // ---------------------------------------------------------------------------------------------------- // MIDI Input (External) if (kData->extNotes.mutex.tryLock()) { while (fMidiEventCount < MAX_MIDI_EVENTS*2 && ! kData->extNotes.data.isEmpty()) { const ExternalMidiNote& note(kData->extNotes.data.getFirst(true)); CARLA_ASSERT(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS); fMidiEvents[fMidiEventCount].type = kVstMidiType; fMidiEvents[fMidiEventCount].byteSize = sizeof(VstMidiEvent); fMidiEvents[fMidiEventCount].midiData[0] = (note.velo > 0) ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF; fMidiEvents[fMidiEventCount].midiData[0] += note.channel; fMidiEvents[fMidiEventCount].midiData[1] = note.note; fMidiEvents[fMidiEventCount].midiData[2] = note.velo; fMidiEventCount += 1; } kData->extNotes.mutex.unlock(); } // End of MIDI Input (External) // ---------------------------------------------------------------------------------------------------- // Event Input (System) bool allNotesOffSent = false; bool sampleAccurate = (fOptions & PLUGIN_OPTION_FIXED_BUFFER) == 0; uint32_t time, nEvents = kData->event.portIn->getEventCount(); uint32_t startTime = 0; uint32_t timeOffset = 0; for (i=0; i < nEvents; ++i) { const EngineEvent& event(kData->event.portIn->getEvent(i)); time = event.time; if (time >= frames) continue; CARLA_ASSERT_INT2(time >= timeOffset, time, timeOffset); if (time > timeOffset && sampleAccurate) { if (processSingle(inBuffer, outBuffer, time - timeOffset, timeOffset)) { startTime = 0; timeOffset = time; if (fMidiEventCount > 0) { carla_zeroStruct(fMidiEvents, fMidiEventCount); fMidiEventCount = 0; } } else startTime += timeOffset; } // Control change switch (event.type) { case kEngineEventTypeNull: break; case kEngineEventTypeControl: { const EngineControlEvent& ctrlEvent = event.ctrl; switch (ctrlEvent.type) { case kEngineControlEventTypeNull: break; case kEngineControlEventTypeParameter: { #ifndef BUILD_BRIDGE // Control backend stuff if (event.channel == kData->ctrlChannel) { float value; if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (fHints & PLUGIN_CAN_DRYWET) > 0) { value = ctrlEvent.value; setDryWet(value, false, false); postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_DRYWET, 0, value); continue; } if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (fHints & PLUGIN_CAN_VOLUME) > 0) { value = ctrlEvent.value*127.0f/100.0f; setVolume(value, false, false); postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_VOLUME, 0, value); continue; } if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (fHints & PLUGIN_CAN_BALANCE) > 0) { float left, right; value = ctrlEvent.value/0.5f - 1.0f; if (value < 0.0f) { left = -1.0f; right = (value*2.0f)+1.0f; } else if (value > 0.0f) { left = (value*2.0f)-1.0f; right = 1.0f; } else { left = -1.0f; right = 1.0f; } setBalanceLeft(left, false, false); setBalanceRight(right, false, false); postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_LEFT, 0, left); postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_RIGHT, 0, right); continue; } } #endif // Control plugin parameters for (k=0; k < kData->param.count; ++k) { if (kData->param.data[k].midiChannel != event.channel) continue; if (kData->param.data[k].midiCC != ctrlEvent.param) continue; if (kData->param.data[k].type != PARAMETER_INPUT) continue; if ((kData->param.data[k].hints & PARAMETER_IS_AUTOMABLE) == 0) continue; float value; if (kData->param.data[k].hints & PARAMETER_IS_BOOLEAN) { value = (ctrlEvent.value < 0.5f) ? kData->param.ranges[k].min : kData->param.ranges[k].max; } else { value = kData->param.ranges[i].unnormalizeValue(ctrlEvent.value); if (kData->param.data[k].hints & PARAMETER_IS_INTEGER) value = std::rint(value); } setParameterValue(k, value, false, false, false); postponeRtEvent(kPluginPostRtEventParameterChange, static_cast(k), 0, value); } break; } case kEngineControlEventTypeMidiBank: break; case kEngineControlEventTypeMidiProgram: if (event.channel == kData->ctrlChannel && (fOptions & PLUGIN_OPTION_MAP_PROGRAM_CHANGES) != 0) { if (ctrlEvent.param < kData->prog.count) { setProgram(ctrlEvent.param, false, false, false); postponeRtEvent(kPluginPostRtEventProgramChange, ctrlEvent.param, 0, 0.0f); break; } } break; case kEngineControlEventTypeAllSoundOff: if (fOptions & PLUGIN_OPTION_SEND_ALL_SOUND_OFF) { if (fMidiEventCount >= MAX_MIDI_EVENTS*2) continue; carla_zeroStruct(fMidiEvents[fMidiEventCount]); fMidiEvents[fMidiEventCount].type = kVstMidiType; fMidiEvents[fMidiEventCount].byteSize = sizeof(VstMidiEvent); fMidiEvents[fMidiEventCount].midiData[0] = MIDI_STATUS_CONTROL_CHANGE + event.channel; fMidiEvents[fMidiEventCount].midiData[1] = MIDI_CONTROL_ALL_SOUND_OFF; fMidiEvents[fMidiEventCount].deltaFrames = sampleAccurate ? startTime : time; fMidiEventCount += 1; } break; case kEngineControlEventTypeAllNotesOff: if (fOptions & PLUGIN_OPTION_SEND_ALL_SOUND_OFF) { if (event.channel == kData->ctrlChannel && ! allNotesOffSent) { allNotesOffSent = true; sendMidiAllNotesOffToCallback(); } if (fMidiEventCount >= MAX_MIDI_EVENTS*2) continue; carla_zeroStruct(fMidiEvents[fMidiEventCount]); fMidiEvents[fMidiEventCount].type = kVstMidiType; fMidiEvents[fMidiEventCount].byteSize = sizeof(VstMidiEvent); fMidiEvents[fMidiEventCount].midiData[0] = MIDI_STATUS_CONTROL_CHANGE + event.channel; fMidiEvents[fMidiEventCount].midiData[1] = MIDI_CONTROL_ALL_NOTES_OFF; fMidiEvents[fMidiEventCount].deltaFrames = sampleAccurate ? startTime : time; fMidiEventCount += 1; } break; } break; } case kEngineEventTypeMidi: { if (fMidiEventCount >= MAX_MIDI_EVENTS*2) continue; const EngineMidiEvent& midiEvent(event.midi); uint8_t status = MIDI_GET_STATUS_FROM_DATA(midiEvent.data); uint8_t channel = event.channel; if (MIDI_IS_STATUS_AFTERTOUCH(status) && (fOptions & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0) continue; if (MIDI_IS_STATUS_CONTROL_CHANGE(status) && (fOptions & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0) continue; if (MIDI_IS_STATUS_POLYPHONIC_AFTERTOUCH(status) && (fOptions & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0) continue; if (MIDI_IS_STATUS_PITCH_WHEEL_CONTROL(status) && (fOptions & PLUGIN_OPTION_SEND_PITCHBEND) == 0) continue; // Fix bad note-off if (status == MIDI_STATUS_NOTE_ON && midiEvent.data[2] == 0) status -= 0x10; carla_zeroStruct(fMidiEvents[fMidiEventCount]); fMidiEvents[fMidiEventCount].type = kVstMidiType; fMidiEvents[fMidiEventCount].byteSize = sizeof(VstMidiEvent); fMidiEvents[fMidiEventCount].midiData[0] = status + channel; fMidiEvents[fMidiEventCount].midiData[1] = midiEvent.data[1]; fMidiEvents[fMidiEventCount].midiData[2] = midiEvent.data[2]; fMidiEvents[fMidiEventCount].deltaFrames = sampleAccurate ? startTime : time; fMidiEventCount += 1; if (status == MIDI_STATUS_NOTE_ON) postponeRtEvent(kPluginPostRtEventNoteOn, channel, midiEvent.data[1], midiEvent.data[2]); else if (status == MIDI_STATUS_NOTE_OFF) postponeRtEvent(kPluginPostRtEventNoteOff, channel, midiEvent.data[1], 0.0f); break; } } } kData->postRtEvents.trySplice(); if (frames > timeOffset) processSingle(inBuffer, outBuffer, frames - timeOffset, timeOffset); } // End of Event Input and Processing // -------------------------------------------------------------------------------------------------------- // Plugin processing (no events) else { processSingle(inBuffer, outBuffer, frames, 0); } // End of Plugin processing (no events) CARLA_PROCESS_CONTINUE_CHECK; // -------------------------------------------------------------------------------------------------------- // MIDI Output if (kData->event.portOut != nullptr) { // reverse lookup MIDI events for (k = (MAX_MIDI_EVENTS*2)-1; k >= fMidiEventCount; --k) { if (fMidiEvents[k].type == 0) break; const uint8_t channel = MIDI_GET_CHANNEL_FROM_DATA(fMidiEvents[k].midiData); uint8_t midiData[3] = { 0 }; midiData[0] = fMidiEvents[k].midiData[0]; midiData[1] = fMidiEvents[k].midiData[1]; midiData[2] = fMidiEvents[k].midiData[2]; kData->event.portOut->writeMidiEvent(fMidiEvents[k].deltaFrames, channel, 0, midiData, 3); } } // End of Control and MIDI Output } bool processSingle(float** const inBuffer, float** const outBuffer, const uint32_t frames, const uint32_t timeOffset) { CARLA_ASSERT(frames > 0); if (frames == 0) return false; if (kData->audioIn.count > 0) { CARLA_ASSERT(inBuffer != nullptr); if (inBuffer == nullptr) return false; } if (kData->audioOut.count > 0) { CARLA_ASSERT(outBuffer != nullptr); if (outBuffer == nullptr) return false; } uint32_t i, k; // -------------------------------------------------------------------------------------------------------- // Try lock, silence otherwise if (kData->engine->isOffline()) { kData->singleMutex.lock(); } else if (! kData->singleMutex.tryLock()) { for (i=0; i < kData->audioOut.count; ++i) { for (k=0; k < frames; ++k) outBuffer[i][k+timeOffset] = 0.0f; } return false; } // -------------------------------------------------------------------------------------------------------- // Set audio buffers float* vstInBuffer[kData->audioIn.count]; float* vstOutBuffer[kData->audioOut.count]; for (i=0; i < kData->audioIn.count; ++i) vstInBuffer[i] = inBuffer[i]+timeOffset; for (i=0; i < kData->audioOut.count; ++i) vstOutBuffer[i] = outBuffer[i]+timeOffset; // -------------------------------------------------------------------------------------------------------- // Set MIDI events if (fMidiEventCount > 0) { fEvents.numEvents = fMidiEventCount; fEvents.reserved = 0; dispatcher(effProcessEvents, 0, 0, &fEvents, 0.0f); } // -------------------------------------------------------------------------------------------------------- // Run plugin fIsProcessing = true; if (fHints & PLUGIN_CAN_PROCESS_REPLACING) { fEffect->processReplacing(fEffect, (kData->audioIn.count > 0) ? vstInBuffer : nullptr, (kData->audioOut.count > 0) ? vstOutBuffer : nullptr, frames); } else { for (i=0; i < kData->audioOut.count; ++i) carla_zeroFloat(vstOutBuffer[i], frames); #if ! VST_FORCE_DEPRECATED fEffect->process(fEffect, (kData->audioIn.count > 0) ? vstInBuffer : nullptr, (kData->audioOut.count > 0) ? vstOutBuffer : nullptr, frames); #endif } fIsProcessing = false; fTimeInfo.samplePos += frames; #ifndef BUILD_BRIDGE // -------------------------------------------------------------------------------------------------------- // Post-processing (dry/wet, volume and balance) { const bool doVolume = (fHints & PLUGIN_CAN_VOLUME) != 0 && kData->postProc.volume != 1.0f; const bool doDryWet = (fHints & PLUGIN_CAN_DRYWET) != 0 && kData->postProc.dryWet != 1.0f; const bool doBalance = (fHints & PLUGIN_CAN_BALANCE) != 0 && (kData->postProc.balanceLeft != -1.0f || kData->postProc.balanceRight != 1.0f); bool isPair; float bufValue, oldBufLeft[doBalance ? frames : 1]; for (i=0; i < kData->audioOut.count; ++i) { // Dry/Wet if (doDryWet) { for (k=0; k < frames; ++k) { bufValue = inBuffer[(kData->audioIn.count == 1) ? 0 : i][k+timeOffset]; outBuffer[i][k+timeOffset] = (outBuffer[i][k+timeOffset] * kData->postProc.dryWet) + (bufValue * (1.0f - kData->postProc.dryWet)); } } // Balance if (doBalance) { isPair = (i % 2 == 0); if (isPair) { CARLA_ASSERT(i+1 < kData->audioOut.count); carla_copyFloat(oldBufLeft, outBuffer[i]+timeOffset, frames); } float balRangeL = (kData->postProc.balanceLeft + 1.0f)/2.0f; float balRangeR = (kData->postProc.balanceRight + 1.0f)/2.0f; for (k=0; k < frames; ++k) { if (isPair) { // left outBuffer[i][k+timeOffset] = oldBufLeft[k] * (1.0f - balRangeL); outBuffer[i][k+timeOffset] += outBuffer[i+1][k+timeOffset] * (1.0f - balRangeR); } else { // right outBuffer[i][k+timeOffset] = outBuffer[i][k+timeOffset] * balRangeR; outBuffer[i][k+timeOffset] += oldBufLeft[k] * balRangeL; } } } // Volume if (doVolume) { for (k=0; k < frames; ++k) outBuffer[i][k+timeOffset] *= kData->postProc.volume; } } } // End of Post-processing #endif // -------------------------------------------------------------------------------------------------------- kData->singleMutex.unlock(); return true; } void bufferSizeChanged(const uint32_t newBufferSize) override { CARLA_ASSERT_INT(newBufferSize > 0, newBufferSize); carla_debug("VstPlugin::bufferSizeChanged(%i)", newBufferSize); if (kData->active) deactivate(); #if ! VST_FORCE_DEPRECATED dispatcher(effSetBlockSizeAndSampleRate, 0, newBufferSize, nullptr, kData->engine->getSampleRate()); #endif dispatcher(effSetBlockSize, 0, newBufferSize, nullptr, 0.0f); if (kData->active) activate(); } void sampleRateChanged(const double newSampleRate) override { CARLA_ASSERT_INT(newSampleRate > 0.0, newSampleRate); carla_debug("VstPlugin::sampleRateChanged(%g)", newSampleRate); if (kData->active) deactivate(); #if ! VST_FORCE_DEPRECATED dispatcher(effSetBlockSizeAndSampleRate, 0, kData->engine->getBufferSize(), nullptr, newSampleRate); #endif dispatcher(effSetSampleRate, 0, 0, nullptr, newSampleRate); if (kData->active) activate(); } // ------------------------------------------------------------------- // Plugin buffers // nothing // ------------------------------------------------------------------- // Post-poned UI Stuff void uiParameterChange(const uint32_t index, const float value) override { CARLA_ASSERT(index < kData->param.count); if (index >= kData->param.count) return; if (! fGui.isOsc) return; if (kData->osc.data.target == nullptr) return; osc_send_control(&kData->osc.data, kData->param.data[index].rindex, value); } void uiProgramChange(const uint32_t index) override { CARLA_ASSERT(index < kData->prog.count); if (index >= kData->prog.count) return; if (! fGui.isOsc) return; if (kData->osc.data.target == nullptr) return; osc_send_program(&kData->osc.data, index); } void uiNoteOn(const uint8_t channel, const uint8_t note, const uint8_t velo) override { CARLA_ASSERT(channel < MAX_MIDI_CHANNELS); CARLA_ASSERT(note < MAX_MIDI_NOTE); CARLA_ASSERT(velo > 0 && velo < MAX_MIDI_VALUE); if (channel >= MAX_MIDI_CHANNELS) return; if (note >= MAX_MIDI_NOTE) return; if (velo >= MAX_MIDI_VALUE) return; if (! fGui.isOsc) return; if (kData->osc.data.target == nullptr) return; uint8_t midiData[4] = { 0 }; midiData[1] = MIDI_STATUS_NOTE_ON + channel; midiData[2] = note; midiData[3] = velo; osc_send_midi(&kData->osc.data, midiData); } void uiNoteOff(const uint8_t channel, const uint8_t note) override { CARLA_ASSERT(channel < MAX_MIDI_CHANNELS); CARLA_ASSERT(note < MAX_MIDI_NOTE); if (channel >= MAX_MIDI_CHANNELS) return; if (note >= MAX_MIDI_NOTE) return; if (! fGui.isOsc) return; if (kData->osc.data.target == nullptr) return; uint8_t midiData[4] = { 0 }; midiData[1] = MIDI_STATUS_NOTE_OFF + channel; midiData[2] = note; osc_send_midi(&kData->osc.data, midiData); } // ------------------------------------------------------------------- protected: void guiClosedCallback() override { showGui(false); kData->engine->callback(CALLBACK_SHOW_GUI, fId, 0, 0, 0.0f, nullptr); } intptr_t dispatcher(int32_t opcode, int32_t index, intptr_t value, void* ptr, float opt) { #if defined(DEBUG) && ! defined(CARLA_OS_WIN) if (opcode != effEditIdle && opcode != effProcessEvents) carla_debug("VstPlugin::dispatcher(%02i:%s, %i, " P_INTPTR ", %p, %f)", opcode, vstEffectOpcode2str(opcode), index, value, ptr, opt); #endif CARLA_ASSERT(fEffect != nullptr); return (fEffect != nullptr) ? fEffect->dispatcher(fEffect, opcode, index, value, ptr, opt) : 0; } intptr_t handleAudioMasterCallback(const int32_t opcode, const int32_t index, const intptr_t value, void* const ptr, const float opt) { #if 0 // Cockos VST extensions if (ptr != nullptr && static_cast(opcode) == 0xdeadbeef && static_cast(index) == 0xdeadf00d) { const char* const func = (char*)ptr; if (std::strcmp(func, "GetPlayPosition") == 0) return 0; if (std::strcmp(func, "GetPlayPosition2") == 0) return 0; if (std::strcmp(func, "GetCursorPosition") == 0) return 0; if (std::strcmp(func, "GetPlayState") == 0) return 0; if (std::strcmp(func, "SetEditCurPos") == 0) return 0; if (std::strcmp(func, "GetSetRepeat") == 0) return 0; if (std::strcmp(func, "GetProjectPath") == 0) return 0; if (std::strcmp(func, "OnPlayButton") == 0) return 0; if (std::strcmp(func, "OnStopButton") == 0) return 0; if (std::strcmp(func, "OnPauseButton") == 0) return 0; if (std::strcmp(func, "IsInRealTimeAudio") == 0) return 0; if (std::strcmp(func, "Audio_IsRunning") == 0) return 0; } #endif intptr_t ret = 0; switch (opcode) { case audioMasterAutomate: if (! fEnabled) break; // plugins should never do this: CARLA_SAFE_ASSERT_INT(index < static_cast(kData->param.count), index); if (index < 0 || index >= static_cast(kData->param.count)) break; if (fGui.isVisible && ! fIsProcessing) { // Called from GUI setParameterValue(index, opt, false, true, true); } else if (fIsProcessing) { // Called from engine const float fixedValue(kData->param.fixValue(index, opt)); if (kData->engine->isOffline()) { CarlaPlugin::setParameterValue(index, fixedValue, true, true, true); } else { CarlaPlugin::setParameterValue(index, fixedValue, false, false, false); postponeRtEvent(kPluginPostRtEventParameterChange, index, 0, fixedValue); } } else { carla_stdout("audioMasterAutomate called from unknown source"); } break; case audioMasterCurrentId: // TODO // if using old sdk, return effect->uniqueID break; case audioMasterIdle: if (fGui.isVisible) dispatcher(effEditIdle, 0, 0, nullptr, 0.0f); break; #if ! VST_FORCE_DEPRECATED case audioMasterPinConnected: // Deprecated in VST SDK 2.4 // TODO break; case audioMasterWantMidi: // Deprecated in VST SDK 2.4 fHints |= PLUGIN_WANTS_MIDI_INPUT; break; #endif case audioMasterGetTime: #ifdef VESTIGE_HEADER ret = getAddressFromPointer(&fTimeInfo); #else ret = ToVstPtr(&fTimeInfo); #endif break; case audioMasterProcessEvents: CARLA_ASSERT(fEnabled); CARLA_ASSERT(fIsProcessing); CARLA_ASSERT(kData->event.portOut != nullptr); CARLA_ASSERT(ptr != nullptr); if (! fEnabled) return 0; if (! fIsProcessing) return 0; if (kData->event.portOut == nullptr) return 0; if (ptr == nullptr) return 0; if (! fIsProcessing) { carla_stderr2("audioMasterProcessEvents(%p) - received MIDI out events outside audio thread, ignoring", ptr); return 0; } if (fMidiEventCount >= MAX_MIDI_EVENTS*2) return 0; { const VstEvents* const vstEvents((const VstEvents*)ptr); for (int32_t i=0; i < vstEvents->numEvents && i < MAX_MIDI_EVENTS*2; ++i) { if (vstEvents->events[i] == nullptr) break; const VstMidiEvent* const vstMidiEvent = (const VstMidiEvent*)vstEvents->events[i]; if (vstMidiEvent->type != kVstMidiType) continue; // reverse-find first free event, and put it there for (uint32_t j=(MAX_MIDI_EVENTS*2)-1; j >= fMidiEventCount; --j) { if (fMidiEvents[j].type == 0) { std::memcpy(&fMidiEvents[j], vstMidiEvent, sizeof(VstMidiEvent)); break; } } } } ret = 1; break; #if ! VST_FORCE_DEPRECATED case audioMasterSetTime: // Deprecated in VST SDK 2.4 break; case audioMasterTempoAt: // Deprecated in VST SDK 2.4 CARLA_ASSERT(fIsProcessing); ret = fTimeInfo.tempo * 10000; break; case audioMasterGetNumAutomatableParameters: // Deprecated in VST SDK 2.4 ret = carla_min(0, fEffect->numParams, kData->engine->getOptions().maxParameters); break; case audioMasterGetParameterQuantization: // Deprecated in VST SDK 2.4 ret = 1; // full single float precision break; #endif #if 0 case audioMasterIOChanged: CARLA_ASSERT(fEnabled); // TESTING if (! fEnabled) { ret = 1; break; } if (x_engine->getOptions().processMode == PROCESS_MODE_CONTINUOUS_RACK) { carla_stderr2("VstPlugin::handleAudioMasterIOChanged() - plugin asked IO change, but it's not supported in rack mode"); return 0; } engineProcessLock(); m_enabled = false; engineProcessUnlock(); if (m_active) { effect->dispatcher(effect, effStopProcess, 0, 0, nullptr, 0.0f); effect->dispatcher(effect, effMainsChanged, 0, 0, nullptr, 0.0f); } reload(); if (m_active) { effect->dispatcher(effect, effMainsChanged, 0, 1, nullptr, 0.0f); effect->dispatcher(effect, effStartProcess, 0, 0, nullptr, 0.0f); } x_engine->callback(CALLBACK_RELOAD_ALL, m_id, 0, 0, 0.0, nullptr); ret = 1; break; #endif case audioMasterNeedIdle: // Deprecated in VST SDK 2.4 fNeedIdle = true; ret = 1; break; case audioMasterSizeWindow: if (kData->gui != nullptr) { CARLA_SAFE_ASSERT(fGui.isVisible); if (fGui.isVisible) kData->gui->setSize(index, value); ret = 1; } break; case audioMasterGetSampleRate: ret = kData->engine->getSampleRate(); break; case audioMasterGetBlockSize: ret = kData->engine->getBufferSize(); break; case audioMasterGetInputLatency: ret = 0; break; case audioMasterGetOutputLatency: ret = 0; break; #if ! VST_FORCE_DEPRECATED case audioMasterGetPreviousPlug: // Deprecated in VST SDK 2.4 // TODO break; case audioMasterGetNextPlug: // Deprecated in VST SDK 2.4 // TODO break; case audioMasterWillReplaceOrAccumulate: // Deprecated in VST SDK 2.4 ret = 1; // replace break; #endif case audioMasterGetCurrentProcessLevel: if (kData->engine->isOffline()) ret = kVstProcessLevelOffline; else if (fIsProcessing) ret = kVstProcessLevelRealtime; else ret = kVstProcessLevelUser; break; case audioMasterGetAutomationState: ret = kData->active ? kVstAutomationReadWrite : kVstAutomationOff; break; case audioMasterOfflineStart: case audioMasterOfflineRead: case audioMasterOfflineWrite: case audioMasterOfflineGetCurrentPass: case audioMasterOfflineGetCurrentMetaPass: // TODO break; #if ! VST_FORCE_DEPRECATED case audioMasterSetOutputSampleRate: // Deprecated in VST SDK 2.4 break; case audioMasterGetOutputSpeakerArrangement: // Deprecated in VST SDK 2.4 // TODO break; #endif case audioMasterVendorSpecific: // TODO - cockos extensions break; #if ! VST_FORCE_DEPRECATED case audioMasterSetIcon: // Deprecated in VST SDK 2.4 break; #endif #if ! VST_FORCE_DEPRECATED case audioMasterOpenWindow: case audioMasterCloseWindow: // Deprecated in VST SDK 2.4 // TODO break; #endif case audioMasterGetDirectory: // TODO break; case audioMasterUpdateDisplay: // Idle UI if visible if (fGui.isVisible) dispatcher(effEditIdle, 0, 0, nullptr, 0.0f); // Update current program if (kData->prog.count > 0) { const int32_t current = dispatcher(effGetProgram, 0, 0, nullptr, 0.0f); if (current >= 0 && current < static_cast(kData->prog.count)) { char strBuf[STR_MAX+1] = { '\0' }; dispatcher(effGetProgramName, 0, 0, strBuf, 0.0f); if (kData->prog.names[current] != nullptr) delete[] kData->prog.names[current]; kData->prog.names[current] = carla_strdup(strBuf); if (kData->prog.current != current) { kData->prog.current = current; kData->engine->callback(CALLBACK_PROGRAM_CHANGED, fId, current, 0, 0.0f, nullptr); } } } kData->engine->callback(CALLBACK_UPDATE, fId, 0, 0, 0.0f, nullptr); ret = 1; break; case audioMasterBeginEdit: case audioMasterEndEdit: // TODO break; case audioMasterOpenFileSelector: case audioMasterCloseFileSelector: // TODO break; #if ! VST_FORCE_DEPRECATED case audioMasterEditFile: // Deprecated in VST SDK 2.4 // TODO break; case audioMasterGetChunkFile: // Deprecated in VST SDK 2.4 // TODO break; case audioMasterGetInputSpeakerArrangement: // Deprecated in VST SDK 2.4 // TODO break; #endif default: carla_debug("VstPlugin::handleAudioMasterCallback(%02i:%s, %i, " P_INTPTR ", %p, %f)", opcode, vstMasterOpcode2str(opcode), index, value, ptr, opt); break; } return ret; } // ------------------------------------------------------------------- public: bool init(const char* const filename, const char* const name) { CARLA_ASSERT(kData->engine != nullptr); CARLA_ASSERT(kData->client == nullptr); CARLA_ASSERT(filename != nullptr); // --------------------------------------------------------------- // first checks if (kData->engine == nullptr) { return false; } if (kData->client != nullptr) { kData->engine->setLastError("Plugin client is already registered"); return false; } if (filename == nullptr) { kData->engine->setLastError("null filename"); return false; } // --------------------------------------------------------------- // open DLL if (! kData->libOpen(filename)) { kData->engine->setLastError(kData->libError(filename)); return false; } // --------------------------------------------------------------- // get DLL main entry VST_Function vstFn = (VST_Function)kData->libSymbol("VSTPluginMain"); if (vstFn == nullptr) { vstFn = (VST_Function)kData->libSymbol("main"); if (vstFn == nullptr) { kData->engine->setLastError("Could not find the VST main entry in the plugin library"); return false; } } // --------------------------------------------------------------- // initialize plugin (part 1) sLastVstPlugin = this; fEffect = vstFn(carla_vst_audioMasterCallback); sLastVstPlugin = nullptr; if (fEffect == nullptr) { kData->engine->setLastError("Plugin failed to initialize"); return false; } if (fEffect->magic != kEffectMagic) { kData->engine->setLastError("Plugin is not valid (wrong vst effect magic code)"); return false; } #ifdef VESTIGE_HEADER fEffect->ptr1 = this; #else fEffect->resvd1 = ToVstPtr(this); #endif dispatcher(effOpen, 0, 0, nullptr, 0.0f); // --------------------------------------------------------------- // get info if (name != nullptr) { fName = kData->engine->getUniquePluginName(name); } else { char strBuf[STR_MAX+1] = { '\0' }; dispatcher(effGetEffectName, 0, 0, strBuf, 0.0f); if (strBuf[0] != '\0') { fName = kData->engine->getUniquePluginName(strBuf); } else { const char* const label = std::strrchr(filename, OS_SEP)+1; fName = kData->engine->getUniquePluginName(label); } } fFilename = filename; // --------------------------------------------------------------- // register client kData->client = kData->engine->addClient(this); if (kData->client == nullptr || ! kData->client->isOk()) { kData->engine->setLastError("Failed to register plugin client"); return false; } // --------------------------------------------------------------- // initialize plugin (part 2) #if ! VST_FORCE_DEPRECATED dispatcher(effSetBlockSizeAndSampleRate, 0, kData->engine->getBufferSize(), nullptr, kData->engine->getSampleRate()); #endif dispatcher(effSetSampleRate, 0, 0, nullptr, kData->engine->getSampleRate()); dispatcher(effSetBlockSize, 0, kData->engine->getBufferSize(), nullptr, 0.0f); dispatcher(effSetProcessPrecision, 0, kVstProcessPrecision32, nullptr, 0.0f); if (dispatcher(effGetVstVersion, 0, 0, nullptr, 0.0f) < kVstVersion) fHints |= PLUGIN_USES_OLD_VSTSDK; if (static_cast(dispatcher(effCanDo, 0, 0, (void*)"hasCockosExtensions", 0.0f)) == 0xbeef0000) fHints |= PLUGIN_HAS_COCKOS_EXTENSIONS; // --------------------------------------------------------------- // gui stuff if (fEffect->flags & effFlagsHasEditor) { const EngineOptions& engineOptions(kData->engine->getOptions()); #if defined(Q_WS_X11) CarlaString uiBridgeBinary(engineOptions.bridge_vstX11); #elif defined(CARLA_OS_MAC) CarlaString uiBridgeBinary(engineOptions.bridge_vstCocoa); #elif defined(CARLA_OS_WIN) CarlaString uiBridgeBinary(engineOptions.bridge_vstHWND); #else CarlaString uiBridgeBinary; #endif if (engineOptions.preferUiBridges && uiBridgeBinary.isNotEmpty() && (fEffect->flags & effFlagsProgramChunks) == 0) { kData->osc.thread.setOscData(uiBridgeBinary, nullptr); fGui.isOsc = true; } } // --------------------------------------------------------------- // load plugin settings { // set default options fOptions = 0x0; fOptions |= PLUGIN_OPTION_MAP_PROGRAM_CHANGES; if (midiInCount() > 0) fOptions |= PLUGIN_OPTION_FIXED_BUFFER; if (fEffect->flags & effFlagsProgramChunks) fOptions |= PLUGIN_OPTION_USE_CHUNKS; if (vstPluginCanDo(fEffect, "receiveVstEvents") || vstPluginCanDo(fEffect, "receiveVstMidiEvent") || (fEffect->flags & effFlagsIsSynth) > 0 || (fHints & PLUGIN_WANTS_MIDI_INPUT)) { fOptions |= PLUGIN_OPTION_SEND_CHANNEL_PRESSURE; fOptions |= PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH; fOptions |= PLUGIN_OPTION_SEND_PITCHBEND; fOptions |= PLUGIN_OPTION_SEND_ALL_SOUND_OFF; } // load settings kData->idStr = "VST/"; kData->idStr += std::strrchr(filename, OS_SEP)+1; // FIXME! kData->idStr += "/"; kData->idStr += CarlaString(uniqueId()); fOptions = kData->loadSettings(fOptions, availableOptions()); // ignore settings, we need this anyway if (midiInCount() > 0) fOptions |= PLUGIN_OPTION_FIXED_BUFFER; } return true; } private: int fUnique1; AEffect* fEffect; void* fLastChunk; uint32_t fMidiEventCount; VstMidiEvent fMidiEvents[MAX_MIDI_EVENTS*2]; VstTimeInfo_R fTimeInfo; struct FixedVstEvents { int32_t numEvents; intptr_t reserved; VstEvent* data[MAX_MIDI_EVENTS*2]; FixedVstEvents() : numEvents(0), reserved(0), data{nullptr} {} } fEvents; struct GuiInfo { bool isOsc; bool isVisible; int lastWidth; int lastHeight; GuiInfo() : isOsc(false), isVisible(false), lastWidth(0), lastHeight(0) {} } fGui; bool fIsProcessing; bool fNeedIdle; int fUnique2; static VstPlugin* sLastVstPlugin; // ------------------------------------------------------------------- static intptr_t carla_vst_hostCanDo(const char* const feature) { carla_debug("carla_vst_hostCanDo(\"%s\")", feature); if (std::strcmp(feature, "supplyIdle") == 0) return 1; if (std::strcmp(feature, "sendVstEvents") == 0) return 1; if (std::strcmp(feature, "sendVstMidiEvent") == 0) return 1; if (std::strcmp(feature, "sendVstMidiEventFlagIsRealtime") == 0) return 1; if (std::strcmp(feature, "sendVstTimeInfo") == 0) return 1; if (std::strcmp(feature, "receiveVstEvents") == 0) return 1; if (std::strcmp(feature, "receiveVstMidiEvent") == 0) return 1; if (std::strcmp(feature, "receiveVstTimeInfo") == 0) return -1; if (std::strcmp(feature, "reportConnectionChanges") == 0) return -1; if (std::strcmp(feature, "acceptIOChanges") == 0) return 1; if (std::strcmp(feature, "sizeWindow") == 0) return 1; if (std::strcmp(feature, "offline") == 0) return -1; if (std::strcmp(feature, "openFileSelector") == 0) return -1; if (std::strcmp(feature, "closeFileSelector") == 0) return -1; if (std::strcmp(feature, "startStopProcess") == 0) return 1; if (std::strcmp(feature, "supportShell") == 0) return -1; if (std::strcmp(feature, "shellCategory") == 0) return -1; // unimplemented carla_stderr("carla_vst_hostCanDo(\"%s\") - unknown feature", feature); return 0; } static intptr_t VSTCALLBACK carla_vst_audioMasterCallback(AEffect* effect, int32_t opcode, int32_t index, intptr_t value, void* ptr, float opt) { #if defined(DEBUG) && ! defined(CARLA_OS_WIN) if (opcode != audioMasterGetTime && opcode != audioMasterProcessEvents && opcode != audioMasterGetCurrentProcessLevel && opcode != audioMasterGetOutputLatency) carla_debug("carla_vst_audioMasterCallback(%p, %02i:%s, %i, " P_INTPTR ", %p, %f)", effect, opcode, vstMasterOpcode2str(opcode), index, value, ptr, opt); #endif switch (opcode) { case audioMasterVersion: return kVstVersion; case audioMasterGetVendorString: CARLA_ASSERT(ptr != nullptr); if (ptr != nullptr) { std::strcpy((char*)ptr, "falkTX"); return 1; } else { carla_stderr("carla_vst_audioMasterCallback() - audioMasterGetVendorString called with invalid pointer"); return 0; } case audioMasterGetProductString: CARLA_ASSERT(ptr != nullptr); if (ptr != nullptr) { std::strcpy((char*)ptr, "Carla"); return 1; } else { carla_stderr("carla_vst_audioMasterCallback() - audioMasterGetProductString called with invalid pointer"); return 0; } case audioMasterGetVendorVersion: return 0x1000; // 1.0.0 case audioMasterCanDo: CARLA_ASSERT(ptr != nullptr); if (ptr != nullptr) { return carla_vst_hostCanDo((const char*)ptr); } else { carla_stderr("carla_vst_audioMasterCallback() - audioMasterCanDo called with invalid pointer"); return 0; } case audioMasterGetLanguage: return kVstLangEnglish; } // Check if 'resvd1' points to us, otherwise register ourselfs if possible VstPlugin* self = nullptr; if (effect != nullptr) { #ifdef VESTIGE_HEADER if (effect->ptr1 != nullptr) { self = (VstPlugin*)effect->ptr1; #else if (effect->resvd1 != 0) { self = FromVstPtr(effect->resvd1); #endif if (self->fUnique1 != self->fUnique2) self = nullptr; } if (self != nullptr) { if (self->fEffect == nullptr) self->fEffect = effect; if (self->fEffect != effect) { carla_stderr2("carla_vst_audioMasterCallback() - host pointer mismatch: %p != %p", self->fEffect, effect); self = nullptr; } } else if (sLastVstPlugin != nullptr) { #ifdef VESTIGE_HEADER effect->ptr1 = sLastVstPlugin; #else effect->resvd1 = ToVstPtr(sLastVstPlugin); #endif self = sLastVstPlugin; } } return (self != nullptr) ? self->handleAudioMasterCallback(opcode, index, value, ptr, opt) : 0; } CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(VstPlugin) }; VstPlugin* VstPlugin::sLastVstPlugin = nullptr; CARLA_BACKEND_END_NAMESPACE #else // WANT_VST # warning Building without VST support #endif CARLA_BACKEND_START_NAMESPACE CarlaPlugin* CarlaPlugin::newVST(const Initializer& init) { carla_debug("CarlaPlugin::newVST({%p, \"%s\", \"%s\"})", init.engine, init.filename, init.name); #ifdef WANT_VST VstPlugin* const plugin(new VstPlugin(init.engine, init.id)); if (! plugin->init(init.filename, init.name)) { delete plugin; return nullptr; } plugin->reload(); if (init.engine->getProccessMode() == PROCESS_MODE_CONTINUOUS_RACK && ! CarlaPluginProtectedData::canRunInRack(plugin)) { init.engine->setLastError("Carla's rack mode can only work with Stereo VST plugins, sorry!"); delete plugin; return nullptr; } return plugin; #else init.engine->setLastError("VST support not available"); return nullptr; #endif } CARLA_BACKEND_END_NAMESPACE