/* * Carla Bridge 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 doc/GPL.txt file. */ #include "CarlaPluginInternal.hpp" #ifndef BUILD_BRIDGE #include "CarlaBridgeUtils.hpp" #include "CarlaShmUtils.hpp" #include "jackbridge/JackBridge.hpp" #include #include #include #define CARLA_BRIDGE_CHECK_OSC_TYPES(/* argc, types, */ argcToCompare, typesToCompare) \ /* check argument count */ \ if (argc != argcToCompare) \ { \ carla_stderr("BridgePlugin::%s() - argument count mismatch: %i != %i", __FUNCTION__, argc, argcToCompare); \ return 1; \ } \ if (argc > 0) \ { \ /* check for nullness */ \ if (! (types && typesToCompare)) \ { \ carla_stderr("BridgePlugin::%s() - argument types are null", __FUNCTION__); \ return 1; \ } \ /* check argument types */ \ if (std::strcmp(types, typesToCompare) != 0) \ { \ carla_stderr("BridgePlugin::%s() - argument types mismatch: '%s' != '%s'", __FUNCTION__, types, typesToCompare); \ return 1; \ } \ } CARLA_BACKEND_START_NAMESPACE // ------------------------------------------------------------------------------------------------------------------- shm_t shm_mkstemp(char* const fileBase) { static const char charSet[] = "abcdefghijklmnopqrstuvwxyz" "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "0123456789"; const size_t fileBaseLen((fileBase != nullptr) ? std::strlen(fileBase) : 0); shm_t fakeShm; carla_shm_init(fakeShm); if (fileBaseLen < 6) { errno = EINVAL; return fakeShm; } if (std::strcmp(fileBase + fileBaseLen - 6, "XXXXXX") != 0) { errno = EINVAL; return fakeShm; } for (;;) { for (size_t c = fileBaseLen - 6; c < fileBaseLen; ++c) { // Note the -1 to avoid the trailing '\0' in charSet. fileBase[c] = charSet[std::rand() % (sizeof(charSet) - 1)]; } shm_t shm = carla_shm_create(fileBase); if (carla_is_shm_valid(shm) || errno != EEXIST) return shm; } } // ------------------------------------------------------------------------------------------------------------------- struct BridgeAudioPool { CarlaString filename; float* data; size_t size; shm_t shm; BridgeAudioPool() : data(nullptr), size(0) { carla_shm_init(shm); } ~BridgeAudioPool() { // should be cleared by now CARLA_ASSERT(data == nullptr); clear(); } void clear() { filename.clear(); if (! carla_is_shm_valid(shm)) return; if (data != nullptr) { carla_shm_unmap(shm, data, size); data = nullptr; } size = 0; carla_shm_close(shm); } void resize(const uint32_t bufferSize, const uint32_t portCount) { if (data != nullptr) carla_shm_unmap(shm, data, size); size = portCount*bufferSize*sizeof(float); if (size == 0) size = sizeof(float); data = (float*)carla_shm_map(shm, size); } }; struct BridgeControl : public RingBufferControl { CarlaString filename; BridgeShmControl* data; shm_t shm; BridgeControl() : RingBufferControl(nullptr), data(nullptr) { carla_shm_init(shm); } ~BridgeControl() { // should be cleared by now CARLA_ASSERT(data == nullptr); clear(); } void clear() { filename.clear(); if (! carla_is_shm_valid(shm)) return; if (data != nullptr) { carla_shm_unmap(shm, data, sizeof(BridgeShmControl)); data = nullptr; } carla_shm_close(shm); } bool mapData() { CARLA_ASSERT(data == nullptr); if (carla_shm_map(shm, data)) { setRingBuffer(&data->ringBuffer, true); return true; } return false; } void unmapData() { CARLA_ASSERT(data != nullptr); if (data == nullptr) return; carla_shm_unmap(shm, data, sizeof(BridgeShmControl)); data = nullptr; setRingBuffer(nullptr, false); } bool waitForServer() { CARLA_ASSERT(data != nullptr); if (data == nullptr) return false; jackbridge_sem_post(&data->runServer); return jackbridge_sem_timedwait(&data->runClient, 5); } void writeOpcode(const PluginBridgeOpcode opcode) { writeInt(static_cast(opcode)); } }; struct BridgeParamInfo { float value; CarlaString name; CarlaString unit; BridgeParamInfo() : value(0.0f) {} CARLA_DECLARE_NON_COPY_STRUCT(BridgeParamInfo) }; // ------------------------------------------------------------------------------------------------------------------- class BridgePlugin : public CarlaPlugin { public: BridgePlugin(CarlaEngine* const engine, const unsigned int id, const BinaryType btype, const PluginType ptype) : CarlaPlugin(engine, id), fBinaryType(btype), fPluginType(ptype), fInitiated(false), fInitError(false), fSaved(false), fNeedsSemDestroy(false), fParams(nullptr) { carla_debug("BridgePlugin::BridgePlugin(%p, %i, %s, %s)", engine, id, BinaryType2Str(btype), PluginType2Str(ptype)); pData->osc.thread.setMode(CarlaPluginThread::PLUGIN_THREAD_BRIDGE); pData->hints |= PLUGIN_IS_BRIDGE; } ~BridgePlugin() override { carla_debug("BridgePlugin::~BridgePlugin()"); pData->singleMutex.lock(); pData->masterMutex.lock(); if (pData->client != nullptr && pData->client->isActive()) pData->client->deactivate(); if (pData->active) { deactivate(); pData->active = false; } if (pData->osc.thread.isRunning()) { fShmControl.writeOpcode(kPluginBridgeOpcodeQuit); fShmControl.commitWrite(); fShmControl.waitForServer(); } if (pData->osc.data.target != nullptr) { osc_send_hide(pData->osc.data); osc_send_quit(pData->osc.data); } pData->osc.data.free(); pData->osc.thread.stop(6000); if (fNeedsSemDestroy) { jackbridge_sem_destroy(&fShmControl.data->runServer); jackbridge_sem_destroy(&fShmControl.data->runClient); } fShmAudioPool.clear(); fShmControl.clear(); clearBuffers(); //info.chunk.clear(); } // ------------------------------------------------------------------- // Information (base) BinaryType getBinaryType() const noexcept { return fBinaryType; } PluginType getType() const noexcept override { return fPluginType; } PluginCategory getCategory() const override { return fInfo.category; } long getUniqueId() const noexcept override { return fInfo.uniqueId; } // ------------------------------------------------------------------- // Information (count) uint32_t getMidiInCount() const noexcept override { return fInfo.mIns; } uint32_t getMidiOutCount() const noexcept override { return fInfo.mOuts; } // ------------------------------------------------------------------- // Information (current data) int32_t getChunkData(void** const dataPtr) const override { CARLA_ASSERT(pData->options & PLUGIN_OPTION_USE_CHUNKS); CARLA_ASSERT(dataPtr != nullptr); #if 0 if (! info.chunk.isEmpty()) { *dataPtr = info.chunk.data(); return info.chunk.size(); } #endif return 0; } // ------------------------------------------------------------------- // Information (per-plugin data) unsigned int getOptionsAvailable() const override { unsigned int options = 0x0; options |= PLUGIN_OPTION_MAP_PROGRAM_CHANGES; options |= PLUGIN_OPTION_USE_CHUNKS; 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) const override { CARLA_ASSERT(parameterId < pData->param.count); return fParams[parameterId].value; } void getLabel(char* const strBuf) const override { std::strncpy(strBuf, (const char*)fInfo.label, STR_MAX); } void getMaker(char* const strBuf) const override { std::strncpy(strBuf, (const char*)fInfo.maker, STR_MAX); } void getCopyright(char* const strBuf) const override { std::strncpy(strBuf, (const char*)fInfo.copyright, STR_MAX); } void getRealName(char* const strBuf) const override { std::strncpy(strBuf, (const char*)fInfo.name, STR_MAX); } void getParameterName(const uint32_t parameterId, char* const strBuf) const override { CARLA_ASSERT(parameterId < pData->param.count); std::strncpy(strBuf, (const char*)fParams[parameterId].name, STR_MAX); } void getParameterUnit(const uint32_t parameterId, char* const strBuf) const override { CARLA_ASSERT(parameterId < pData->param.count); std::strncpy(strBuf, (const char*)fParams[parameterId].unit, STR_MAX); } // ------------------------------------------------------------------- // Set data (state) void prepareForSave() override { #if 0 m_saved = false; osc_send_configure(&osc.data, CARLA_BRIDGE_MSG_SAVE_NOW, ""); for (int i=0; i < 200; ++i) { if (m_saved) break; carla_msleep(50); } if (! m_saved) carla_stderr("BridgePlugin::prepareForSave() - Timeout while requesting save state"); else carla_debug("BridgePlugin::prepareForSave() - success!"); #endif } // ------------------------------------------------------------------- // Set data (internal stuff) // nothing // ------------------------------------------------------------------- // 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(parameterId < pData->param.count); const float fixedValue(pData->param.getFixedValue(parameterId, value)); fParams[parameterId].value = fixedValue; const bool doLock(sendGui || sendOsc || sendCallback); if (doLock) pData->singleMutex.lock(); fShmControl.writeOpcode(kPluginBridgeOpcodeSetParameter); fShmControl.writeInt(parameterId); fShmControl.writeFloat(value); if (doLock) { fShmControl.commitWrite(); pData->singleMutex.unlock(); } CarlaPlugin::setParameterValue(parameterId, fixedValue, sendGui, sendOsc, sendCallback); } void setProgram(int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) override { CARLA_ASSERT(index >= -1 && index < static_cast(pData->prog.count)); if (index < -1) index = -1; else if (index > static_cast(pData->prog.count)) return; const bool doLock(sendGui || sendOsc || sendCallback); if (doLock) pData->singleMutex.lock(); fShmControl.writeOpcode(kPluginBridgeOpcodeSetProgram); fShmControl.writeInt(index); if (doLock) { fShmControl.commitWrite(); pData->singleMutex.unlock(); } CarlaPlugin::setProgram(index, sendGui, sendOsc, sendCallback); } void setMidiProgram(int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) override { CARLA_ASSERT(index >= -1 && index < static_cast(pData->midiprog.count)); if (index < -1) index = -1; else if (index > static_cast(pData->midiprog.count)) return; const bool doLock(sendGui || sendOsc || sendCallback); if (doLock) pData->singleMutex.lock(); fShmControl.writeOpcode(kPluginBridgeOpcodeSetMidiProgram); fShmControl.writeInt(index); if (doLock) { fShmControl.commitWrite(); pData->singleMutex.unlock(); } CarlaPlugin::setMidiProgram(index, sendGui, sendOsc, sendCallback); } #if 0 void setCustomData(const char* const type, const char* const key, const char* const value, const bool sendGui) override { CARLA_ASSERT(type); CARLA_ASSERT(key); CARLA_ASSERT(value); if (sendGui) { // TODO - if type is chunk|binary, store it in a file and send path instead QString cData; cData = type; cData += "·"; cData += key; cData += "·"; cData += value; osc_send_configure(&osc.data, CARLA_BRIDGE_MSG_SET_CUSTOM, cData.toUtf8().constData()); } CarlaPlugin::setCustomData(type, key, value, sendGui); } void setChunkData(const char* const stringData) override { CARLA_ASSERT(m_hints & PLUGIN_USES_CHUNKS); CARLA_ASSERT(stringData); QString filePath; filePath = QDir::tempPath(); filePath += "/.CarlaChunk_"; filePath += m_name; filePath = QDir::toNativeSeparators(filePath); QFile file(filePath); if (file.open(QIODevice::WriteOnly | QIODevice::Text)) { QTextStream out(&file); out << stringData; file.close(); osc_send_configure(&osc.data, CARLA_BRIDGE_MSG_SET_CHUNK, filePath.toUtf8().constData()); } } #endif // ------------------------------------------------------------------- // Set gui stuff void showCustomUI(const bool yesNo) override { if (yesNo) osc_send_show(pData->osc.data); else osc_send_hide(pData->osc.data); } void idle() override { if (! pData->osc.thread.isRunning()) carla_stderr2("TESTING: Bridge has closed!"); CarlaPlugin::idle(); } // ------------------------------------------------------------------- // Plugin state void reload() override { CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr,); carla_debug("BridgePlugin::reload() - start"); const EngineProcessMode processMode(pData->engine->getProccessMode()); // Safely disable plugin for reload const ScopedDisabler sd(this); bool needsCtrlIn, needsCtrlOut; needsCtrlIn = needsCtrlOut = false; if (fInfo.aIns > 0) { pData->audioIn.createNew(fInfo.aIns); } if (fInfo.aOuts > 0) { pData->audioOut.createNew(fInfo.aOuts); needsCtrlIn = true; } if (fInfo.mIns > 0) needsCtrlIn = true; if (fInfo.mOuts > 0) needsCtrlOut = true; const uint portNameSize(pData->engine->getMaxPortNameSize()); CarlaString portName; // Audio Ins for (uint32_t j=0; j < fInfo.aIns; ++j) { portName.clear(); if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT) { portName = pData->name; portName += ":"; } if (fInfo.aIns > 1) { portName += "input_"; portName += CarlaString(j+1); } else portName += "input"; portName.truncate(portNameSize); pData->audioIn.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, true); pData->audioIn.ports[j].rindex = j; } // Audio Outs for (uint32_t j=0; j < fInfo.aOuts; ++j) { portName.clear(); if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT) { portName = pData->name; portName += ":"; } if (fInfo.aOuts > 1) { portName += "output_"; portName += CarlaString(j+1); } else portName += "output"; portName.truncate(portNameSize); pData->audioOut.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, false); pData->audioOut.ports[j].rindex = j; } if (needsCtrlIn) { portName.clear(); if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT) { portName = pData->name; portName += ":"; } portName += "event-in"; portName.truncate(portNameSize); pData->event.portIn = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, true); } if (needsCtrlOut) { portName.clear(); if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT) { portName = pData->name; portName += ":"; } portName += "event-out"; portName.truncate(portNameSize); pData->event.portOut = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, false); } bufferSizeChanged(pData->engine->getBufferSize()); reloadPrograms(true); carla_debug("BridgePlugin::reload() - end"); } // ------------------------------------------------------------------- // Plugin processing void activate() override { // already locked before fShmControl.writeOpcode(kPluginBridgeOpcodeSetParameter); fShmControl.writeInt(PARAMETER_ACTIVE); fShmControl.writeFloat(1.0f); fShmControl.commitWrite(); waitForServer(); } void deactivate() override { // already locked before fShmControl.writeOpcode(kPluginBridgeOpcodeSetParameter); fShmControl.writeInt(PARAMETER_ACTIVE); fShmControl.writeFloat(0.0f); fShmControl.commitWrite(); waitForServer(); } void process(float** const inBuffer, float** const outBuffer, const uint32_t frames) override { uint32_t i, k; // -------------------------------------------------------------------------------------------------------- // Check if active if (! pData->active) { // disable any output sound for (i=0; i < pData->audioOut.count; ++i) { #ifdef HAVE_JUCE FloatVectorOperations::clear(outBuffer[i], frames); #else carla_zeroFloat(outBuffer[i], frames); #endif } return; } // -------------------------------------------------------------------------------------------------------- // Check if needs reset if (pData->needsReset) { // TODO pData->needsReset = false; } // -------------------------------------------------------------------------------------------------------- // Event Input if (pData->event.portIn != nullptr) { // ---------------------------------------------------------------------------------------------------- // MIDI Input (External) if (pData->extNotes.mutex.tryLock()) { while (! pData->extNotes.data.isEmpty()) { const ExternalMidiNote& note(pData->extNotes.data.getFirst(true)); CARLA_ASSERT(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS); char data1, data2, data3; data1 = static_cast(note.channel + (note.velo > 0) ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF); data2 = note.note; data3 = note.velo; fShmControl.writeOpcode(kPluginBridgeOpcodeMidiEvent); fShmControl.writeLong(0); fShmControl.writeInt(3); fShmControl.writeChar(data1); fShmControl.writeChar(data2); fShmControl.writeChar(data3); } pData->extNotes.mutex.unlock(); } // End of MIDI Input (External) // ---------------------------------------------------------------------------------------------------- // Event Input (System) bool allNotesOffSent = false; uint32_t nEvents = pData->event.portIn->getEventCount(); uint32_t nextBankId = 0; if (pData->midiprog.current >= 0 && pData->midiprog.count > 0) nextBankId = pData->midiprog.data[pData->midiprog.current].bank; for (i=0; i < nEvents; ++i) { const EngineEvent& event(pData->event.portIn->getEvent(i)); // Control change switch (event.type) { case kEngineEventTypeNull: break; case kEngineEventTypeControl: { const EngineControlEvent& ctrlEvent = event.ctrl; switch (ctrlEvent.type) { case kEngineControlEventTypeNull: break; case kEngineControlEventTypeParameter: { // Control backend stuff if (event.channel == pData->ctrlChannel) { float value; if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_DRYWET) > 0) { value = ctrlEvent.value; setDryWet(value, false, false); pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_DRYWET, 0, value); } if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_VOLUME) > 0) { value = ctrlEvent.value*127.0f/100.0f; setVolume(value, false, false); pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_VOLUME, 0, value); } if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (pData->hints & 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); pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_LEFT, 0, left); pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_RIGHT, 0, right); } } // Control plugin parameters for (k=0; k < pData->param.count; ++k) { if (pData->param.data[k].midiChannel != event.channel) continue; if (pData->param.data[k].midiCC != ctrlEvent.param) continue; if (pData->param.data[k].type != PARAMETER_INPUT) continue; if ((pData->param.data[k].hints & PARAMETER_IS_AUTOMABLE) == 0) continue; float value; if (pData->param.data[k].hints & PARAMETER_IS_BOOLEAN) { value = (ctrlEvent.value < 0.5f) ? pData->param.ranges[k].min : pData->param.ranges[k].max; } else { value = pData->param.ranges[k].getUnnormalizedValue(ctrlEvent.value); if (pData->param.data[k].hints & PARAMETER_IS_INTEGER) value = std::rint(value); } setParameterValue(k, value, false, false, false); pData->postponeRtEvent(kPluginPostRtEventParameterChange, static_cast(k), 0, value); } if ((pData->options & PLUGIN_OPTION_SEND_CONTROL_CHANGES) != 0 && ctrlEvent.param <= 0x5F) { fShmControl.writeOpcode(kPluginBridgeOpcodeMidiEvent); fShmControl.writeLong(event.time); fShmControl.writeInt(3); fShmControl.writeChar(static_cast(MIDI_STATUS_CONTROL_CHANGE + event.channel)); fShmControl.writeChar(static_cast(ctrlEvent.param)); fShmControl.writeChar(char(ctrlEvent.value*127.0f)); } break; } case kEngineControlEventTypeMidiBank: if (event.channel == pData->ctrlChannel && (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES) != 0) nextBankId = ctrlEvent.param; break; case kEngineControlEventTypeMidiProgram: if (event.channel == pData->ctrlChannel && (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES) != 0) { const uint32_t nextProgramId(ctrlEvent.param); if (pData->midiprog.count > 0) { for (k=0; k < pData->midiprog.count; ++k) { if (pData->midiprog.data[k].bank == nextBankId && pData->midiprog.data[k].program == nextProgramId) { setMidiProgram(k, false, false, false); pData->postponeRtEvent(kPluginPostRtEventMidiProgramChange, k, 0, 0.0f); break; } } } else { } } break; case kEngineControlEventTypeAllSoundOff: if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF) { // TODO } break; case kEngineControlEventTypeAllNotesOff: if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF) { if (event.channel == pData->ctrlChannel && ! allNotesOffSent) { allNotesOffSent = true; sendMidiAllNotesOffToCallback(); } // TODO } break; } break; } case kEngineEventTypeMidi: { const EngineMidiEvent& midiEvent(event.midi); uint8_t status = MIDI_GET_STATUS_FROM_DATA(midiEvent.data); uint8_t channel = event.channel; if (MIDI_IS_STATUS_CHANNEL_PRESSURE(status) && (pData->options & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0) continue; if (MIDI_IS_STATUS_CONTROL_CHANGE(status) && (pData->options & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0) continue; if (MIDI_IS_STATUS_POLYPHONIC_AFTERTOUCH(status) && (pData->options & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0) continue; if (MIDI_IS_STATUS_PITCH_WHEEL_CONTROL(status) && (pData->options & PLUGIN_OPTION_SEND_PITCHBEND) == 0) continue; // Fix bad note-off if (status == MIDI_STATUS_NOTE_ON && midiEvent.data[2] == 0) status = MIDI_STATUS_NOTE_OFF; char data[4]; data[0] = static_cast(status + channel); data[1] = midiEvent.data[1]; data[2] = midiEvent.data[2]; data[3] = midiEvent.data[3]; fShmControl.writeOpcode(kPluginBridgeOpcodeMidiEvent); fShmControl.writeLong(event.time); fShmControl.writeInt(midiEvent.size); for (uint8_t j=0; j < midiEvent.size && j < 4; ++j) fShmControl.writeChar(data[j]); if (status == MIDI_STATUS_NOTE_ON) pData->postponeRtEvent(kPluginPostRtEventNoteOn, channel, midiEvent.data[1], midiEvent.data[2]); else if (status == MIDI_STATUS_NOTE_OFF) pData->postponeRtEvent(kPluginPostRtEventNoteOff, channel, midiEvent.data[1], 0.0f); break; } } } pData->postRtEvents.trySplice(); } // End of Event Input processSingle(inBuffer, outBuffer, frames); } bool processSingle(float** const inBuffer, float** const outBuffer, const uint32_t frames) { CARLA_ASSERT(frames > 0); if (frames == 0) return false; if (pData->audioIn.count > 0) { CARLA_ASSERT(inBuffer != nullptr); if (inBuffer == nullptr) return false; } if (pData->audioOut.count > 0) { CARLA_ASSERT(outBuffer != nullptr); if (outBuffer == nullptr) return false; } uint32_t i, k; // -------------------------------------------------------------------------------------------------------- // Try lock, silence otherwise if (pData->engine->isOffline()) { pData->singleMutex.lock(); } else if (! pData->singleMutex.tryLock()) { for (i=0; i < pData->audioOut.count; ++i) { #ifdef HAVE_JUCE FloatVectorOperations::clear(outBuffer[i], frames); #else #endif } return false; } // -------------------------------------------------------------------------------------------------------- // Reset audio buffers for (i=0; i < fInfo.aIns; ++i) { #ifdef HAVE_JUCE FloatVectorOperations::copy(fShmAudioPool.data + (i * frames), inBuffer[i], frames); #else #endif } // -------------------------------------------------------------------------------------------------------- // Run plugin fShmControl.writeOpcode(kPluginBridgeOpcodeProcess); fShmControl.commitWrite(); if (! waitForServer()) { pData->singleMutex.unlock(); return true; } for (i=0; i < fInfo.aOuts; ++i) { #ifdef HAVE_JUCE FloatVectorOperations::copy(outBuffer[i], fShmAudioPool.data + ((i + fInfo.aIns) * frames), frames); #else #endif } // -------------------------------------------------------------------------------------------------------- // Post-processing (dry/wet, volume and balance) { const bool doVolume = (pData->hints & PLUGIN_CAN_VOLUME) != 0 && pData->postProc.volume != 1.0f; const bool doDryWet = (pData->hints & PLUGIN_CAN_DRYWET) != 0 && pData->postProc.dryWet != 1.0f; const bool doBalance = (pData->hints & PLUGIN_CAN_BALANCE) != 0 && (pData->postProc.balanceLeft != -1.0f || pData->postProc.balanceRight != 1.0f); bool isPair; float bufValue, oldBufLeft[doBalance ? frames : 1]; for (i=0; i < pData->audioOut.count; ++i) { // Dry/Wet if (doDryWet) { for (k=0; k < frames; ++k) { bufValue = inBuffer[(pData->audioIn.count == 1) ? 0 : i][k]; outBuffer[i][k] = (outBuffer[i][k] * pData->postProc.dryWet) + (bufValue * (1.0f - pData->postProc.dryWet)); } } // Balance if (doBalance) { isPair = (i % 2 == 0); if (isPair) { CARLA_ASSERT(i+1 < pData->audioOut.count); #ifdef HAVE_JUCE FloatVectorOperations::copy(oldBufLeft, outBuffer[i], frames); #else #endif } float balRangeL = (pData->postProc.balanceLeft + 1.0f)/2.0f; float balRangeR = (pData->postProc.balanceRight + 1.0f)/2.0f; for (k=0; k < frames; ++k) { if (isPair) { // left outBuffer[i][k] = oldBufLeft[k] * (1.0f - balRangeL); outBuffer[i][k] += outBuffer[i+1][k] * (1.0f - balRangeR); } else { // right outBuffer[i][k] = outBuffer[i][k] * balRangeR; outBuffer[i][k] += oldBufLeft[k] * balRangeL; } } } // Volume if (doVolume) { for (k=0; k < frames; ++k) outBuffer[i][k] *= pData->postProc.volume; } } } // End of Post-processing // -------------------------------------------------------------------------------------------------------- pData->singleMutex.unlock(); return true; } void bufferSizeChanged(const uint32_t newBufferSize) override { resizeAudioPool(newBufferSize); fShmControl.writeOpcode(kPluginBridgeOpcodeSetBufferSize); fShmControl.writeInt(newBufferSize); fShmControl.commitWrite(); } void sampleRateChanged(const double newSampleRate) override { fShmControl.writeOpcode(kPluginBridgeOpcodeSetSampleRate); fShmControl.writeFloat(float(newSampleRate)); fShmControl.commitWrite(); } // ------------------------------------------------------------------- // Plugin buffers void clearBuffers() override { if (fParams != nullptr) { delete[] fParams; fParams = nullptr; } CarlaPlugin::clearBuffers(); } // ------------------------------------------------------------------- // Post-poned UI Stuff // nothing // ------------------------------------------------------------------- int setOscPluginBridgeInfo(const PluginBridgeInfoType type, const int argc, const lo_arg* const* const argv, const char* const types) { carla_debug("setOscPluginBridgeInfo(%s, %i, %p, \"%s\")", PluginBridgeInfoType2str(type), argc, argv, types); switch (type) { case kPluginBridgeAudioCount: { CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iii"); const int32_t aIns = argv[0]->i; const int32_t aOuts = argv[1]->i; const int32_t aTotal = argv[2]->i; CARLA_ASSERT(aIns >= 0); CARLA_ASSERT(aOuts >= 0); CARLA_ASSERT(aIns + aOuts == aTotal); fInfo.aIns = aIns; fInfo.aOuts = aOuts; break; // unused (void)aTotal; } case kPluginBridgeMidiCount: { CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iii"); const int32_t mIns = argv[0]->i; const int32_t mOuts = argv[1]->i; const int32_t mTotal = argv[2]->i; CARLA_ASSERT(mIns >= 0); CARLA_ASSERT(mOuts >= 0); CARLA_ASSERT(mIns + mOuts == mTotal); fInfo.mIns = mIns; fInfo.mOuts = mOuts; break; // unused (void)mTotal; } case kPluginBridgeParameterCount: { CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iii"); const int32_t pIns = argv[0]->i; const int32_t pOuts = argv[1]->i; const int32_t pTotal = argv[2]->i; CARLA_ASSERT(pIns >= 0); CARLA_ASSERT(pOuts >= 0); CARLA_ASSERT(pIns + pOuts <= pTotal); // delete old data pData->param.clear(); if (fParams != nullptr) { delete[] fParams; fParams = nullptr; } CARLA_SAFE_ASSERT_INT2(pTotal < static_cast(pData->engine->getOptions().maxParameters), pTotal, pData->engine->getOptions().maxParameters); const int32_t count(carla_min(pTotal, pData->engine->getOptions().maxParameters, 0)); if (count > 0) { pData->param.createNew(count); fParams = new BridgeParamInfo[count]; } break; // unused (void)pIns; (void)pOuts; } case kPluginBridgeProgramCount: { CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i"); const int32_t count = argv[0]->i; CARLA_ASSERT(count >= 0); pData->prog.clear(); if (count > 0) pData->prog.createNew(count); break; } case kPluginBridgeMidiProgramCount: { CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i"); const int32_t count = argv[0]->i; CARLA_ASSERT(count >= 0); pData->midiprog.clear(); if (count > 0) pData->midiprog.createNew(count); break; } case kPluginBridgePluginInfo: { CARLA_BRIDGE_CHECK_OSC_TYPES(7, "iissssh"); const int32_t category = argv[0]->i; const int32_t hints = argv[1]->i; const char* const name = (const char*)&argv[2]->s; const char* const label = (const char*)&argv[3]->s; const char* const maker = (const char*)&argv[4]->s; const char* const copyright = (const char*)&argv[5]->s; const int64_t uniqueId = argv[6]->h; CARLA_ASSERT(category >= 0); CARLA_ASSERT(hints >= 0); CARLA_ASSERT(name != nullptr); CARLA_ASSERT(label != nullptr); CARLA_ASSERT(maker != nullptr); CARLA_ASSERT(copyright != nullptr); pData->hints = hints | PLUGIN_IS_BRIDGE; fInfo.category = static_cast(category); fInfo.uniqueId = static_cast(uniqueId); fInfo.name = name; fInfo.label = label; fInfo.maker = maker; fInfo.copyright = copyright; if (pData->name == nullptr) pData->name = carla_strdup(name); break; } case kPluginBridgeParameterInfo: { CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iss"); const int32_t index = argv[0]->i; const char* const name = (const char*)&argv[1]->s; const char* const unit = (const char*)&argv[2]->s; CARLA_ASSERT_INT2(index >= 0 && index < static_cast(pData->param.count), index, pData->param.count); CARLA_ASSERT(name != nullptr); CARLA_ASSERT(unit != nullptr); if (index >= 0 && static_cast(pData->param.count)) { fParams[index].name = name; fParams[index].unit = unit; } break; } case kPluginBridgeParameterData: { CARLA_BRIDGE_CHECK_OSC_TYPES(5, "iiiii"); const int32_t index = argv[0]->i; const int32_t rindex = argv[2]->i; const int32_t hints = argv[3]->i; const int32_t channel = argv[4]->i; const int32_t cc = argv[5]->i; CARLA_ASSERT_INT2(index >= 0 && index < static_cast(pData->param.count), index, pData->param.count); CARLA_ASSERT(rindex >= 0); CARLA_ASSERT(hints >= 0); CARLA_ASSERT(channel >= 0 && channel < MAX_MIDI_CHANNELS); CARLA_ASSERT(cc >= -1 && cc < 0x5F); if (index >= 0 && static_cast(pData->param.count)) { pData->param.data[index].index = index; pData->param.data[index].rindex = rindex; pData->param.data[index].hints = hints; pData->param.data[index].midiChannel = static_cast(channel); pData->param.data[index].midiCC = static_cast(cc); } break; } case kPluginBridgeParameterRanges: { CARLA_BRIDGE_CHECK_OSC_TYPES(7, "iffffff"); const int32_t index = argv[0]->i; const float def = argv[1]->f; const float min = argv[2]->f; const float max = argv[3]->f; const float step = argv[4]->f; const float stepSmall = argv[5]->f; const float stepLarge = argv[6]->f; CARLA_ASSERT_INT2(index >= 0 && index < static_cast(pData->param.count), index, pData->param.count); CARLA_ASSERT(min < max); CARLA_ASSERT(def >= min); CARLA_ASSERT(def <= max); if (index >= 0 && static_cast(pData->param.count)) { pData->param.ranges[index].def = def; pData->param.ranges[index].min = min; pData->param.ranges[index].max = max; pData->param.ranges[index].step = step; pData->param.ranges[index].stepSmall = stepSmall; pData->param.ranges[index].stepLarge = stepLarge; } break; } case kPluginBridgeProgramInfo: { CARLA_BRIDGE_CHECK_OSC_TYPES(2, "is"); const int32_t index = argv[0]->i; const char* const name = (const char*)&argv[1]->s; CARLA_ASSERT_INT2(index >= 0 && index < static_cast(pData->prog.count), index, pData->prog.count); CARLA_ASSERT(name != nullptr); if (index >= 0 && index < static_cast(pData->prog.count)) { if (pData->prog.names[index] != nullptr) delete[] pData->prog.names[index]; pData->prog.names[index] = carla_strdup(name); } break; } case kPluginBridgeMidiProgramInfo: { CARLA_BRIDGE_CHECK_OSC_TYPES(4, "iiis"); const int32_t index = argv[0]->i; const int32_t bank = argv[1]->i; const int32_t program = argv[2]->i; const char* const name = (const char*)&argv[3]->s; CARLA_ASSERT_INT2(index < static_cast(pData->midiprog.count), index, pData->midiprog.count); CARLA_ASSERT(bank >= 0); CARLA_ASSERT(program >= 0 && program < 128); CARLA_ASSERT(name != nullptr); if (index >= 0 && index < static_cast(pData->midiprog.count)) { if (pData->midiprog.data[index].name != nullptr) delete[] pData->midiprog.data[index].name; pData->midiprog.data[index].bank = bank; pData->midiprog.data[index].program = program; pData->midiprog.data[index].name = carla_strdup(name); } break; } case kPluginBridgeConfigure: { CARLA_BRIDGE_CHECK_OSC_TYPES(2, "ss"); const char* const key = (const char*)&argv[0]->s; const char* const value = (const char*)&argv[1]->s; CARLA_ASSERT(key != nullptr); CARLA_ASSERT(value != nullptr); if (key == nullptr || value == nullptr) break; if (std::strcmp(key, CARLA_BRIDGE_MSG_HIDE_GUI) == 0) pData->engine->callback(ENGINE_CALLBACK_UI_STATE_CHANGED, pData->id, 0, 0, 0.0f, nullptr); else if (std::strcmp(key, CARLA_BRIDGE_MSG_SAVED) == 0) fSaved = true; break; } case kPluginBridgeSetParameterValue: { CARLA_BRIDGE_CHECK_OSC_TYPES(2, "if"); const int32_t index = argv[0]->i; const float value = argv[1]->f; CARLA_ASSERT_INT2(index >= 0 && index < static_cast(pData->param.count), index, pData->param.count); if (index >= 0 && static_cast(pData->param.count)) { const float fixedValue(pData->param.getFixedValue(index, value)); fParams[index].value = fixedValue; CarlaPlugin::setParameterValue(index, fixedValue, false, true, true); } break; } case kPluginBridgeSetDefaultValue: { CARLA_BRIDGE_CHECK_OSC_TYPES(2, "if"); const int32_t index = argv[0]->i; const float value = argv[1]->f; CARLA_ASSERT_INT2(index >= 0 && index < static_cast(pData->param.count), index, pData->param.count); if (index >= 0 && static_cast(pData->param.count)) pData->param.ranges[index].def = value; break; } case kPluginBridgeSetProgram: { CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i"); const int32_t index = argv[0]->i; CARLA_ASSERT_INT2(index >= 0 && index < static_cast(pData->prog.count), index, pData->prog.count); setProgram(index, false, true, true); break; } case kPluginBridgeSetMidiProgram: { CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i"); const int32_t index = argv[0]->i; CARLA_ASSERT_INT2(index < static_cast(pData->midiprog.count), index, pData->midiprog.count); setMidiProgram(index, false, true, true); break; } case kPluginBridgeSetCustomData: { CARLA_BRIDGE_CHECK_OSC_TYPES(3, "sss"); const char* const type = (const char*)&argv[0]->s; const char* const key = (const char*)&argv[1]->s; const char* const value = (const char*)&argv[2]->s; CARLA_ASSERT(type != nullptr); CARLA_ASSERT(key != nullptr); CARLA_ASSERT(value != nullptr); setCustomData(type, key, value, false); break; } case kPluginBridgeSetChunkData: { CARLA_BRIDGE_CHECK_OSC_TYPES(1, "s"); #if 0 const char* const chunkFileChar = (const char*)&argv[0]->s; CARLA_ASSERT(chunkFileChar); QString chunkFileStr(chunkFileChar); #ifndef CARLA_OS_WIN // Using Wine, fix temp dir if (m_binary == BINARY_WIN32 || m_binary == BINARY_WIN64) { // Get WINEPREFIX QString wineDir; if (const char* const WINEPREFIX = getenv("WINEPREFIX")) wineDir = QString(WINEPREFIX); else wineDir = QDir::homePath() + "/.wine"; QStringList chunkFileStrSplit1 = chunkFileStr.split(":/"); QStringList chunkFileStrSplit2 = chunkFileStrSplit1.at(1).split("\\"); QString wineDrive = chunkFileStrSplit1.at(0).toLower(); QString wineTMP = chunkFileStrSplit2.at(0); QString baseName = chunkFileStrSplit2.at(1); chunkFileStr = wineDir; chunkFileStr += "/drive_"; chunkFileStr += wineDrive; chunkFileStr += "/"; chunkFileStr += wineTMP; chunkFileStr += "/"; chunkFileStr += baseName; chunkFileStr = QDir::toNativeSeparators(chunkFileStr); } #endif QFile chunkFile(chunkFileStr); if (chunkFile.open(QIODevice::ReadOnly)) { info.chunk = chunkFile.readAll(); chunkFile.close(); chunkFile.remove(); } #endif break; } case kPluginBridgeUpdateNow: { fInitiated = true; break; } case kPluginBridgeError: { CARLA_BRIDGE_CHECK_OSC_TYPES(1, "s"); const char* const error = (const char*)&argv[0]->s; CARLA_ASSERT(error != nullptr); pData->engine->setLastError(error); fInitError = true; fInitiated = true; break; } } return 0; } // ------------------------------------------------------------------- const void* getExtraStuff() const noexcept override { return fBridgeBinary.isNotEmpty() ? (const char*)fBridgeBinary : nullptr; } bool init(const char* const filename, const char* const name, const char* const label, const char* const bridgeBinary) { CARLA_ASSERT(pData->engine != nullptr); CARLA_ASSERT(pData->client == nullptr); // --------------------------------------------------------------- // first checks if (pData->engine == nullptr) { return false; } if (pData->client != nullptr) { pData->engine->setLastError("Plugin client is already registered"); return false; } // --------------------------------------------------------------- // set info if (name != nullptr) pData->name = pData->engine->getUniquePluginName(name); pData->filename = filename; fBridgeBinary = bridgeBinary; // --------------------------------------------------------------- // SHM Audio Pool { char tmpFileBase[60]; std::srand(static_cast(std::time(nullptr))); std::sprintf(tmpFileBase, "/carla-bridge_shm_XXXXXX"); fShmAudioPool.shm = shm_mkstemp(tmpFileBase); if (! carla_is_shm_valid(fShmAudioPool.shm)) { carla_stdout("Failed to open or create shared memory file #1"); return false; } fShmAudioPool.filename = tmpFileBase; } // --------------------------------------------------------------- // SHM Control { char tmpFileBase[60]; std::sprintf(tmpFileBase, "/carla-bridge_shc_XXXXXX"); fShmControl.shm = shm_mkstemp(tmpFileBase); if (! carla_is_shm_valid(fShmControl.shm)) { carla_stdout("Failed to open or create shared memory file #2"); // clear carla_shm_close(fShmAudioPool.shm); return false; } fShmControl.filename = tmpFileBase; if (! fShmControl.mapData()) { carla_stdout("Failed to mmap shared memory file"); // clear carla_shm_close(fShmControl.shm); carla_shm_close(fShmAudioPool.shm); return false; } CARLA_ASSERT(fShmControl.data != nullptr); if (! jackbridge_sem_init(&fShmControl.data->runServer)) { carla_stdout("Failed to initialize shared memory semaphore #1"); // clear fShmControl.unmapData(); carla_shm_close(fShmControl.shm); carla_shm_close(fShmAudioPool.shm); return false; } if (! jackbridge_sem_init(&fShmControl.data->runClient)) { carla_stdout("Failed to initialize shared memory semaphore #2"); // clear jackbridge_sem_destroy(&fShmControl.data->runServer); fShmControl.unmapData(); carla_shm_close(fShmControl.shm); carla_shm_close(fShmAudioPool.shm); return false; } fNeedsSemDestroy = true; } // initial values fShmControl.writeOpcode(kPluginBridgeOpcodeSetBufferSize); fShmControl.writeInt(pData->engine->getBufferSize()); fShmControl.writeOpcode(kPluginBridgeOpcodeSetSampleRate); fShmControl.writeFloat(float(pData->engine->getSampleRate())); fShmControl.commitWrite(); // register plugin now so we can receive OSC (and wait for it) pData->hints |= PLUGIN_IS_BRIDGE; pData->engine->registerEnginePlugin(pData->id, this); // init OSC { char shmIdStr[12+1] = { 0 }; std::strncpy(shmIdStr, &fShmAudioPool.filename[fShmAudioPool.filename.length()-6], 6); std::strncat(shmIdStr, &fShmControl.filename[fShmControl.filename.length()-6], 6); pData->osc.thread.setOscData(bridgeBinary, label, getPluginTypeAsString(fPluginType), shmIdStr); pData->osc.thread.start(); } for (int i=0; i < 200; ++i) { if (fInitiated || ! pData->osc.thread.isRunning()) break; carla_msleep(50); } if (fInitError || ! fInitiated) { // unregister so it gets handled properly pData->engine->registerEnginePlugin(pData->id, nullptr); pData->osc.thread.stop(6000); if (! fInitError) pData->engine->setLastError("Timeout while waiting for a response from plugin-bridge\n(or the plugin crashed on initialization?)"); return false; } // --------------------------------------------------------------- // register client if (pData->name == nullptr) { if (name != nullptr) pData->name = pData->engine->getUniquePluginName(name); else if (label != nullptr) pData->name = pData->engine->getUniquePluginName(label); else pData->name = pData->engine->getUniquePluginName("unknown"); } pData->client = pData->engine->addClient(this); if (pData->client == nullptr || ! pData->client->isOk()) { pData->engine->setLastError("Failed to register plugin client"); return false; } return true; } private: const BinaryType fBinaryType; const PluginType fPluginType; bool fInitiated; bool fInitError; bool fSaved; bool fNeedsSemDestroy; CarlaString fBridgeBinary; BridgeAudioPool fShmAudioPool; BridgeControl fShmControl; struct Info { uint32_t aIns, aOuts; uint32_t mIns, mOuts; PluginCategory category; long uniqueId; CarlaString name; CarlaString label; CarlaString maker; CarlaString copyright; //QByteArray chunk; Info() : aIns(0), aOuts(0), mIns(0), mOuts(0), category(PLUGIN_CATEGORY_NONE), uniqueId(0) {} } fInfo; BridgeParamInfo* fParams; void resizeAudioPool(const uint32_t bufferSize) { fShmAudioPool.resize(bufferSize, fInfo.aIns+fInfo.aOuts); fShmControl.writeOpcode(kPluginBridgeOpcodeSetAudioPool); fShmControl.writeLong(fShmAudioPool.size); fShmControl.commitWrite(); waitForServer(); } bool waitForServer() { if (! fShmControl.waitForServer()) { carla_stderr("waitForServer() timeout"); pData->active = false; // TODO return false; } return true; } CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(BridgePlugin) }; CARLA_BACKEND_END_NAMESPACE #endif // ! BUILD_BRIDGE CARLA_BACKEND_START_NAMESPACE CarlaPlugin* CarlaPlugin::newBridge(const Initializer& init, BinaryType btype, PluginType ptype, const char* const bridgeBinary) { carla_debug("CarlaPlugin::newBridge({%p, \"%s\", \"%s\", \"%s\"}, %s, %s, \"%s\")", init.engine, init.filename, init.name, init.label, BinaryType2Str(btype), PluginType2Str(ptype), bridgeBinary); #ifndef BUILD_BRIDGE if (bridgeBinary == nullptr) { init.engine->setLastError("Bridge not possible, bridge-binary not found"); return nullptr; } BridgePlugin* const plugin(new BridgePlugin(init.engine, init.id, btype, ptype)); if (! plugin->init(init.filename, init.name, init.label, bridgeBinary)) { delete plugin; return nullptr; } plugin->reload(); if (init.engine->getProccessMode() == ENGINE_PROCESS_MODE_CONTINUOUS_RACK && ! plugin->canRunInRack()) { init.engine->setLastError("Carla's rack mode can only work with Stereo Bridged plugins, sorry!"); delete plugin; return nullptr; } return plugin; #else init.engine->setLastError("Plugin bridge support not available"); return nullptr; // unused (void)bridgeBinary; #endif } #ifndef BUILD_BRIDGE // ------------------------------------------------------------------- // Bridge Helper #define bridgePlugin ((BridgePlugin*)plugin) int CarlaPluginSetOscBridgeInfo(CarlaPlugin* const plugin, const PluginBridgeInfoType type, const int argc, const lo_arg* const* const argv, const char* const types) { CARLA_ASSERT(plugin != nullptr && (plugin->getHints() & PLUGIN_IS_BRIDGE) != 0); return bridgePlugin->setOscPluginBridgeInfo(type, argc, argv, types); } #undef bridgePlugin #endif CARLA_BACKEND_END_NAMESPACE