Audio plugin host https://kx.studio/carla
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2383 lines
85KB

  1. /*
  2. * Carla Plugin Bridge
  3. * Copyright (C) 2011-2017 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License as
  7. * published by the Free Software Foundation; either version 2 of
  8. * the License, or any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16. */
  17. #include "CarlaPluginInternal.hpp"
  18. #include "CarlaBackendUtils.hpp"
  19. #include "CarlaBase64Utils.hpp"
  20. #include "CarlaBridgeUtils.hpp"
  21. #include "CarlaEngineUtils.hpp"
  22. #include "CarlaMathUtils.hpp"
  23. #include "CarlaPipeUtils.hpp"
  24. #include "CarlaShmUtils.hpp"
  25. #include "CarlaThread.hpp"
  26. #include "jackbridge/JackBridge.hpp"
  27. #include <ctime>
  28. // -------------------------------------------------------------------------------------------------------------------
  29. using juce::ChildProcess;
  30. using juce::File;
  31. using juce::ScopedPointer;
  32. using juce::String;
  33. using juce::StringArray;
  34. using juce::Time;
  35. CARLA_BACKEND_START_NAMESPACE
  36. // -------------------------------------------------------------------------------------------------------------------
  37. // Fallback data
  38. static const ExternalMidiNote kExternalMidiNoteFallback = { -1, 0, 0 };
  39. // -------------------------------------------------------------------------------------------------------------------
  40. struct BridgeParamInfo {
  41. float value;
  42. CarlaString name;
  43. CarlaString symbol;
  44. CarlaString unit;
  45. BridgeParamInfo() noexcept
  46. : value(0.0f),
  47. name(),
  48. symbol(),
  49. unit() {}
  50. CARLA_DECLARE_NON_COPY_STRUCT(BridgeParamInfo)
  51. };
  52. // -------------------------------------------------------------------------------------------------------------------
  53. class CarlaPluginBridgeThread : public CarlaThread
  54. {
  55. public:
  56. CarlaPluginBridgeThread(CarlaEngine* const engine, CarlaPlugin* const plugin) noexcept
  57. : CarlaThread("CarlaPluginBridgeThread"),
  58. kEngine(engine),
  59. kPlugin(plugin),
  60. fBinary(),
  61. fLabel(),
  62. fShmIds(),
  63. fProcess() {}
  64. void setData(const char* const binary, const char* const label, const char* const shmIds) noexcept
  65. {
  66. CARLA_SAFE_ASSERT_RETURN(binary != nullptr && binary[0] != '\0',);
  67. CARLA_SAFE_ASSERT_RETURN(shmIds != nullptr && shmIds[0] != '\0',);
  68. CARLA_SAFE_ASSERT(! isThreadRunning());
  69. fBinary = binary;
  70. fShmIds = shmIds;
  71. if (label != nullptr)
  72. fLabel = label;
  73. if (fLabel.isEmpty())
  74. fLabel = "\"\"";
  75. }
  76. uintptr_t getProcessPID() const noexcept
  77. {
  78. CARLA_SAFE_ASSERT_RETURN(fProcess != nullptr, 0);
  79. return (uintptr_t)fProcess->getPID();
  80. }
  81. protected:
  82. void run()
  83. {
  84. if (fProcess == nullptr)
  85. {
  86. fProcess = new ChildProcess();
  87. }
  88. else if (fProcess->isRunning())
  89. {
  90. carla_stderr("CarlaPluginBridgeThread::run() - already running");
  91. }
  92. String name(kPlugin->getName());
  93. String filename(kPlugin->getFilename());
  94. if (name.isEmpty())
  95. name = "(none)";
  96. if (filename.isEmpty())
  97. filename = "\"\"";
  98. StringArray arguments;
  99. #ifndef CARLA_OS_WIN
  100. // start with "wine" if needed
  101. if (fBinary.endsWithIgnoreCase(".exe"))
  102. arguments.add("wine");
  103. #endif
  104. // binary
  105. arguments.add(fBinary);
  106. // plugin type
  107. arguments.add(getPluginTypeAsString(kPlugin->getType()));
  108. // filename
  109. arguments.add(filename);
  110. // label
  111. arguments.add(fLabel);
  112. // uniqueId
  113. arguments.add(String(static_cast<juce::int64>(kPlugin->getUniqueId())));
  114. bool started;
  115. {
  116. char strBuf[STR_MAX+1];
  117. strBuf[STR_MAX] = '\0';
  118. const EngineOptions& options(kEngine->getOptions());
  119. const ScopedEngineEnvironmentLocker _seel(kEngine);
  120. #ifdef CARLA_OS_LINUX
  121. const ScopedEnvVar sev1("LD_LIBRARY_PATH", nullptr);
  122. const ScopedEnvVar sev2("LD_PRELOAD", nullptr);
  123. #endif
  124. carla_setenv("ENGINE_OPTION_FORCE_STEREO", bool2str(options.forceStereo));
  125. carla_setenv("ENGINE_OPTION_PREFER_PLUGIN_BRIDGES", bool2str(options.preferPluginBridges));
  126. carla_setenv("ENGINE_OPTION_PREFER_UI_BRIDGES", bool2str(options.preferUiBridges));
  127. carla_setenv("ENGINE_OPTION_UIS_ALWAYS_ON_TOP", bool2str(options.uisAlwaysOnTop));
  128. std::snprintf(strBuf, STR_MAX, "%u", options.maxParameters);
  129. carla_setenv("ENGINE_OPTION_MAX_PARAMETERS", strBuf);
  130. std::snprintf(strBuf, STR_MAX, "%u", options.uiBridgesTimeout);
  131. carla_setenv("ENGINE_OPTION_UI_BRIDGES_TIMEOUT",strBuf);
  132. if (options.pathLADSPA != nullptr)
  133. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LADSPA", options.pathLADSPA);
  134. else
  135. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LADSPA", "");
  136. if (options.pathDSSI != nullptr)
  137. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_DSSI", options.pathDSSI);
  138. else
  139. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_DSSI", "");
  140. if (options.pathLV2 != nullptr)
  141. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LV2", options.pathLV2);
  142. else
  143. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LV2", "");
  144. if (options.pathVST2 != nullptr)
  145. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST2", options.pathVST2);
  146. else
  147. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST2", "");
  148. if (options.pathVST3 != nullptr)
  149. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST3", options.pathVST3);
  150. else
  151. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST3", "");
  152. if (options.pathGIG != nullptr)
  153. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_GIG", options.pathGIG);
  154. else
  155. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_GIG", "");
  156. if (options.pathSF2 != nullptr)
  157. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SF2", options.pathSF2);
  158. else
  159. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SF2", "");
  160. if (options.pathSFZ != nullptr)
  161. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SFZ", options.pathSFZ);
  162. else
  163. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SFZ", "");
  164. if (options.binaryDir != nullptr)
  165. carla_setenv("ENGINE_OPTION_PATH_BINARIES", options.binaryDir);
  166. else
  167. carla_setenv("ENGINE_OPTION_PATH_BINARIES", "");
  168. if (options.resourceDir != nullptr)
  169. carla_setenv("ENGINE_OPTION_PATH_RESOURCES", options.resourceDir);
  170. else
  171. carla_setenv("ENGINE_OPTION_PATH_RESOURCES", "");
  172. carla_setenv("ENGINE_OPTION_PREVENT_BAD_BEHAVIOUR", bool2str(options.preventBadBehaviour));
  173. std::snprintf(strBuf, STR_MAX, P_UINTPTR, options.frontendWinId);
  174. carla_setenv("ENGINE_OPTION_FRONTEND_WIN_ID", strBuf);
  175. carla_setenv("ENGINE_BRIDGE_SHM_IDS", fShmIds.toRawUTF8());
  176. carla_setenv("WINEDEBUG", "-all");
  177. carla_stdout("starting plugin bridge, command is:\n%s \"%s\" \"%s\" \"%s\" " P_INT64,
  178. fBinary.toRawUTF8(), getPluginTypeAsString(kPlugin->getType()), filename.toRawUTF8(), fLabel.toRawUTF8(), kPlugin->getUniqueId());
  179. started = fProcess->start(arguments);
  180. }
  181. if (! started)
  182. {
  183. carla_stdout("failed!");
  184. fProcess = nullptr;
  185. return;
  186. }
  187. for (; fProcess->isRunning() && ! shouldThreadExit();)
  188. carla_sleep(1);
  189. // we only get here if bridge crashed or thread asked to exit
  190. if (fProcess->isRunning() && shouldThreadExit())
  191. {
  192. fProcess->waitForProcessToFinish(2000);
  193. if (fProcess->isRunning())
  194. {
  195. carla_stdout("CarlaPluginBridgeThread::run() - bridge refused to close, force kill now");
  196. fProcess->kill();
  197. }
  198. else
  199. {
  200. carla_stdout("CarlaPluginBridgeThread::run() - bridge auto-closed successfully");
  201. }
  202. }
  203. else
  204. {
  205. // forced quit, may have crashed
  206. if (fProcess->getExitCode() != 0 /*|| fProcess->exitStatus() == QProcess::CrashExit*/)
  207. {
  208. carla_stderr("CarlaPluginBridgeThread::run() - bridge crashed");
  209. CarlaString errorString("Plugin '" + CarlaString(kPlugin->getName()) + "' has crashed!\n"
  210. "Saving now will lose its current settings.\n"
  211. "Please remove this plugin, and not rely on it from this point.");
  212. kEngine->callback(CarlaBackend::ENGINE_CALLBACK_ERROR, kPlugin->getId(), 0, 0, 0.0f, errorString);
  213. }
  214. }
  215. fProcess = nullptr;
  216. }
  217. private:
  218. CarlaEngine* const kEngine;
  219. CarlaPlugin* const kPlugin;
  220. String fBinary;
  221. String fLabel;
  222. String fShmIds;
  223. ScopedPointer<ChildProcess> fProcess;
  224. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaPluginBridgeThread)
  225. };
  226. // -------------------------------------------------------------------------------------------------------------------
  227. class CarlaPluginBridge : public CarlaPlugin
  228. {
  229. public:
  230. CarlaPluginBridge(CarlaEngine* const engine, const uint id, const BinaryType btype, const PluginType ptype)
  231. : CarlaPlugin(engine, id),
  232. fBinaryType(btype),
  233. fPluginType(ptype),
  234. fInitiated(false),
  235. fInitError(false),
  236. fSaved(true),
  237. fTimedOut(false),
  238. fTimedError(false),
  239. fProcWaitTime(0),
  240. fLastPongTime(-1),
  241. fBridgeBinary(),
  242. fBridgeThread(engine, this),
  243. fShmAudioPool(),
  244. fShmRtClientControl(),
  245. fShmNonRtClientControl(),
  246. fShmNonRtServerControl(),
  247. fInfo(),
  248. fUniqueId(0),
  249. fLatency(0),
  250. fParams(nullptr)
  251. {
  252. carla_debug("CarlaPluginBridge::CarlaPluginBridge(%p, %i, %s, %s)", engine, id, BinaryType2Str(btype), PluginType2Str(ptype));
  253. pData->hints |= PLUGIN_IS_BRIDGE;
  254. }
  255. ~CarlaPluginBridge() override
  256. {
  257. carla_debug("CarlaPluginBridge::~CarlaPluginBridge()");
  258. // close UI
  259. if (pData->hints & PLUGIN_HAS_CUSTOM_UI)
  260. pData->transientTryCounter = 0;
  261. pData->singleMutex.lock();
  262. pData->masterMutex.lock();
  263. if (pData->client != nullptr && pData->client->isActive())
  264. pData->client->deactivate();
  265. if (pData->active)
  266. {
  267. deactivate();
  268. pData->active = false;
  269. }
  270. if (fBridgeThread.isThreadRunning())
  271. {
  272. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientQuit);
  273. fShmNonRtClientControl.commitWrite();
  274. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientQuit);
  275. fShmRtClientControl.commitWrite();
  276. if (! fTimedOut)
  277. waitForClient("stopping", 3000);
  278. }
  279. fBridgeThread.stopThread(3000);
  280. fShmNonRtServerControl.clear();
  281. fShmNonRtClientControl.clear();
  282. fShmRtClientControl.clear();
  283. fShmAudioPool.clear();
  284. clearBuffers();
  285. fInfo.chunk.clear();
  286. }
  287. // -------------------------------------------------------------------
  288. // Information (base)
  289. BinaryType getBinaryType() const noexcept override
  290. {
  291. return fBinaryType;
  292. }
  293. PluginType getType() const noexcept override
  294. {
  295. return fPluginType;
  296. }
  297. PluginCategory getCategory() const noexcept override
  298. {
  299. return fInfo.category;
  300. }
  301. int64_t getUniqueId() const noexcept override
  302. {
  303. return fUniqueId;
  304. }
  305. uint32_t getLatencyInFrames() const noexcept override
  306. {
  307. return fLatency;
  308. }
  309. // -------------------------------------------------------------------
  310. // Information (count)
  311. uint32_t getMidiInCount() const noexcept override
  312. {
  313. return fInfo.mIns;
  314. }
  315. uint32_t getMidiOutCount() const noexcept override
  316. {
  317. return fInfo.mOuts;
  318. }
  319. // -------------------------------------------------------------------
  320. // Information (current data)
  321. // TODO - missing getCustomData
  322. std::size_t getChunkData(void** const dataPtr) noexcept override
  323. {
  324. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS, 0);
  325. CARLA_SAFE_ASSERT_RETURN(dataPtr != nullptr, 0);
  326. waitForSaved();
  327. CARLA_SAFE_ASSERT_RETURN(fInfo.chunk.size() > 0, 0);
  328. *dataPtr = fInfo.chunk.data();
  329. return fInfo.chunk.size();
  330. }
  331. // -------------------------------------------------------------------
  332. // Information (per-plugin data)
  333. uint getOptionsAvailable() const noexcept override
  334. {
  335. return fInfo.optionsAvailable;
  336. }
  337. float getParameterValue(const uint32_t parameterId) const noexcept override
  338. {
  339. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, 0.0f);
  340. return fParams[parameterId].value;
  341. }
  342. void getLabel(char* const strBuf) const noexcept override
  343. {
  344. std::strncpy(strBuf, fInfo.label, STR_MAX);
  345. }
  346. void getMaker(char* const strBuf) const noexcept override
  347. {
  348. std::strncpy(strBuf, fInfo.maker, STR_MAX);
  349. }
  350. void getCopyright(char* const strBuf) const noexcept override
  351. {
  352. std::strncpy(strBuf, fInfo.copyright, STR_MAX);
  353. }
  354. void getRealName(char* const strBuf) const noexcept override
  355. {
  356. std::strncpy(strBuf, fInfo.name, STR_MAX);
  357. }
  358. void getParameterName(const uint32_t parameterId, char* const strBuf) const noexcept override
  359. {
  360. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, nullStrBuf(strBuf));
  361. std::strncpy(strBuf, fParams[parameterId].name.buffer(), STR_MAX);
  362. }
  363. void getParameterSymbol(const uint32_t parameterId, char* const strBuf) const noexcept override
  364. {
  365. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, nullStrBuf(strBuf));
  366. std::strncpy(strBuf, fParams[parameterId].symbol.buffer(), STR_MAX);
  367. }
  368. void getParameterUnit(const uint32_t parameterId, char* const strBuf) const noexcept override
  369. {
  370. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, nullStrBuf(strBuf));
  371. std::strncpy(strBuf, fParams[parameterId].unit.buffer(), STR_MAX);
  372. }
  373. // -------------------------------------------------------------------
  374. // Set data (state)
  375. void prepareForSave() noexcept override
  376. {
  377. fSaved = false;
  378. {
  379. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  380. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPrepareForSave);
  381. fShmNonRtClientControl.commitWrite();
  382. }
  383. }
  384. void waitForSaved()
  385. {
  386. if (fSaved)
  387. return;
  388. // TODO: only wait 1 minute for NI plugins
  389. const uint32_t timeoutEnd(Time::getMillisecondCounter() + 60*1000); // 60 secs, 1 minute
  390. const bool needsEngineIdle(pData->engine->getType() != kEngineTypePlugin);
  391. for (; Time::getMillisecondCounter() < timeoutEnd && fBridgeThread.isThreadRunning();)
  392. {
  393. pData->engine->callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  394. if (needsEngineIdle)
  395. pData->engine->idle();
  396. if (fSaved)
  397. break;
  398. carla_msleep(20);
  399. }
  400. if (! fSaved)
  401. carla_stderr("CarlaPluginBridge::waitForSaved() - Timeout while requesting save state");
  402. }
  403. // -------------------------------------------------------------------
  404. // Set data (internal stuff)
  405. void setOption(const uint option, const bool yesNo, const bool sendCallback) override
  406. {
  407. {
  408. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  409. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetOption);
  410. fShmNonRtClientControl.writeUInt(option);
  411. fShmNonRtClientControl.writeBool(yesNo);
  412. fShmNonRtClientControl.commitWrite();
  413. }
  414. CarlaPlugin::setOption(option, yesNo, sendCallback);
  415. }
  416. void setCtrlChannel(const int8_t channel, const bool sendOsc, const bool sendCallback) noexcept override
  417. {
  418. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  419. {
  420. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  421. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetCtrlChannel);
  422. fShmNonRtClientControl.writeShort(channel);
  423. fShmNonRtClientControl.commitWrite();
  424. }
  425. CarlaPlugin::setCtrlChannel(channel, sendOsc, sendCallback);
  426. }
  427. // -------------------------------------------------------------------
  428. // Set data (plugin-specific stuff)
  429. void setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  430. {
  431. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback,); // never call this from RT
  432. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  433. const float fixedValue(pData->param.getFixedValue(parameterId, value));
  434. fParams[parameterId].value = fixedValue;
  435. {
  436. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  437. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterValue);
  438. fShmNonRtClientControl.writeUInt(parameterId);
  439. fShmNonRtClientControl.writeFloat(value);
  440. fShmNonRtClientControl.commitWrite();
  441. fShmNonRtClientControl.waitIfDataIsReachingLimit();
  442. }
  443. CarlaPlugin::setParameterValue(parameterId, fixedValue, sendGui, sendOsc, sendCallback);
  444. }
  445. void setParameterMidiChannel(const uint32_t parameterId, const uint8_t channel, const bool sendOsc, const bool sendCallback) noexcept override
  446. {
  447. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  448. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  449. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  450. {
  451. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  452. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterMidiChannel);
  453. fShmNonRtClientControl.writeUInt(parameterId);
  454. fShmNonRtClientControl.writeByte(channel);
  455. fShmNonRtClientControl.commitWrite();
  456. }
  457. CarlaPlugin::setParameterMidiChannel(parameterId, channel, sendOsc, sendCallback);
  458. }
  459. void setParameterMidiCC(const uint32_t parameterId, const int16_t cc, const bool sendOsc, const bool sendCallback) noexcept override
  460. {
  461. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  462. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  463. CARLA_SAFE_ASSERT_RETURN(cc >= -1 && cc < MAX_MIDI_CONTROL,);
  464. {
  465. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  466. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterMidiCC);
  467. fShmNonRtClientControl.writeUInt(parameterId);
  468. fShmNonRtClientControl.writeShort(cc);
  469. fShmNonRtClientControl.commitWrite();
  470. }
  471. CarlaPlugin::setParameterMidiCC(parameterId, cc, sendOsc, sendCallback);
  472. }
  473. void setProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  474. {
  475. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback,); // never call this from RT
  476. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->prog.count),);
  477. {
  478. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  479. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetProgram);
  480. fShmNonRtClientControl.writeInt(index);
  481. fShmNonRtClientControl.commitWrite();
  482. }
  483. CarlaPlugin::setProgram(index, sendGui, sendOsc, sendCallback);
  484. }
  485. void setMidiProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  486. {
  487. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback,); // never call this from RT
  488. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->midiprog.count),);
  489. {
  490. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  491. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetMidiProgram);
  492. fShmNonRtClientControl.writeInt(index);
  493. fShmNonRtClientControl.commitWrite();
  494. }
  495. CarlaPlugin::setMidiProgram(index, sendGui, sendOsc, sendCallback);
  496. }
  497. void setCustomData(const char* const type, const char* const key, const char* const value, const bool sendGui) override
  498. {
  499. CARLA_SAFE_ASSERT_RETURN(type != nullptr && type[0] != '\0',);
  500. CARLA_SAFE_ASSERT_RETURN(key != nullptr && key[0] != '\0',);
  501. CARLA_SAFE_ASSERT_RETURN(value != nullptr,);
  502. if (std::strcmp(type, CUSTOM_DATA_TYPE_PROPERTY) == 0)
  503. return CarlaPlugin::setCustomData(type, key, value, sendGui);
  504. if (std::strcmp(type, CUSTOM_DATA_TYPE_STRING) == 0 && std::strcmp(key, "__CarlaPingOnOff__") == 0)
  505. {
  506. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  507. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPingOnOff);
  508. fShmNonRtClientControl.writeBool(std::strcmp(value, "true") == 0);
  509. fShmNonRtClientControl.commitWrite();
  510. return;
  511. }
  512. const uint32_t typeLen(static_cast<uint32_t>(std::strlen(type)));
  513. const uint32_t keyLen(static_cast<uint32_t>(std::strlen(key)));
  514. const uint32_t valueLen(static_cast<uint32_t>(std::strlen(value)));
  515. {
  516. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  517. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetCustomData);
  518. fShmNonRtClientControl.writeUInt(typeLen);
  519. fShmNonRtClientControl.writeCustomData(type, typeLen);
  520. fShmNonRtClientControl.writeUInt(keyLen);
  521. fShmNonRtClientControl.writeCustomData(key, keyLen);
  522. fShmNonRtClientControl.writeUInt(valueLen);
  523. fShmNonRtClientControl.writeCustomData(value, valueLen);
  524. fShmNonRtClientControl.commitWrite();
  525. }
  526. CarlaPlugin::setCustomData(type, key, value, sendGui);
  527. }
  528. void setChunkData(const void* const data, const std::size_t dataSize) override
  529. {
  530. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS,);
  531. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  532. CARLA_SAFE_ASSERT_RETURN(dataSize > 0,);
  533. CarlaString dataBase64(CarlaString::asBase64(data, dataSize));
  534. CARLA_SAFE_ASSERT_RETURN(dataBase64.length() > 0,);
  535. String filePath(File::getSpecialLocation(File::tempDirectory).getFullPathName());
  536. filePath += CARLA_OS_SEP_STR ".CarlaChunk_";
  537. filePath += fShmAudioPool.filename.buffer() + 18;
  538. if (File(filePath).replaceWithText(dataBase64.buffer()))
  539. {
  540. const uint32_t ulength(static_cast<uint32_t>(filePath.length()));
  541. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  542. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetChunkDataFile);
  543. fShmNonRtClientControl.writeUInt(ulength);
  544. fShmNonRtClientControl.writeCustomData(filePath.toRawUTF8(), ulength);
  545. fShmNonRtClientControl.commitWrite();
  546. }
  547. // save data internally as well
  548. fInfo.chunk.resize(dataSize);
  549. std::memcpy(fInfo.chunk.data(), data, dataSize);
  550. }
  551. // -------------------------------------------------------------------
  552. // Set ui stuff
  553. void showCustomUI(const bool yesNo) override
  554. {
  555. {
  556. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  557. fShmNonRtClientControl.writeOpcode(yesNo ? kPluginBridgeNonRtClientShowUI : kPluginBridgeNonRtClientHideUI);
  558. fShmNonRtClientControl.commitWrite();
  559. }
  560. #ifndef BUILD_BRIDGE
  561. if (yesNo)
  562. {
  563. pData->tryTransient();
  564. }
  565. else
  566. {
  567. pData->transientTryCounter = 0;
  568. }
  569. #endif
  570. }
  571. void idle() override
  572. {
  573. if (fBridgeThread.isThreadRunning())
  574. {
  575. if (fInitiated && fTimedOut && pData->active)
  576. setActive(false, true, true);
  577. {
  578. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  579. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPing);
  580. fShmNonRtClientControl.commitWrite();
  581. }
  582. try {
  583. handleNonRtData();
  584. } CARLA_SAFE_EXCEPTION("handleNonRtData");
  585. }
  586. else if (fInitiated)
  587. {
  588. fTimedOut = true;
  589. fTimedError = true;
  590. fInitiated = false;
  591. pData->engine->callback(ENGINE_CALLBACK_PLUGIN_UNAVAILABLE, pData->id, 0, 0, 0.0f,
  592. "Plugin bridge has been stopped or crashed");
  593. }
  594. CarlaPlugin::idle();
  595. }
  596. // -------------------------------------------------------------------
  597. // Plugin state
  598. void reload() override
  599. {
  600. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr,);
  601. carla_debug("CarlaPluginBridge::reload() - start");
  602. const EngineProcessMode processMode(pData->engine->getProccessMode());
  603. // Safely disable plugin for reload
  604. const ScopedDisabler sd(this);
  605. // cleanup of previous data
  606. pData->audioIn.clear();
  607. pData->audioOut.clear();
  608. pData->cvIn.clear();
  609. pData->cvOut.clear();
  610. pData->event.clear();
  611. bool needsCtrlIn, needsCtrlOut;
  612. needsCtrlIn = needsCtrlOut = false;
  613. if (fInfo.aIns > 0)
  614. {
  615. pData->audioIn.createNew(fInfo.aIns);
  616. }
  617. if (fInfo.aOuts > 0)
  618. {
  619. pData->audioOut.createNew(fInfo.aOuts);
  620. needsCtrlIn = true;
  621. }
  622. if (fInfo.cvIns > 0)
  623. {
  624. pData->cvIn.createNew(fInfo.cvIns);
  625. }
  626. if (fInfo.cvOuts > 0)
  627. {
  628. pData->cvOut.createNew(fInfo.cvOuts);
  629. }
  630. if (fInfo.mIns > 0)
  631. needsCtrlIn = true;
  632. if (fInfo.mOuts > 0)
  633. needsCtrlOut = true;
  634. const uint portNameSize(pData->engine->getMaxPortNameSize());
  635. CarlaString portName;
  636. // Audio Ins
  637. for (uint32_t j=0; j < fInfo.aIns; ++j)
  638. {
  639. portName.clear();
  640. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  641. {
  642. portName = pData->name;
  643. portName += ":";
  644. }
  645. if (fInfo.aInNames != nullptr && fInfo.aInNames[j] != nullptr)
  646. {
  647. portName += fInfo.aInNames[j];
  648. }
  649. else if (fInfo.aIns > 1)
  650. {
  651. portName += "input_";
  652. portName += CarlaString(j+1);
  653. }
  654. else
  655. portName += "input";
  656. portName.truncate(portNameSize);
  657. pData->audioIn.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, true, j);
  658. pData->audioIn.ports[j].rindex = j;
  659. }
  660. // Audio Outs
  661. for (uint32_t j=0; j < fInfo.aOuts; ++j)
  662. {
  663. portName.clear();
  664. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  665. {
  666. portName = pData->name;
  667. portName += ":";
  668. }
  669. if (fInfo.aOutNames != nullptr && fInfo.aOutNames[j] != nullptr)
  670. {
  671. portName += fInfo.aOutNames[j];
  672. }
  673. else if (fInfo.aOuts > 1)
  674. {
  675. portName += "output_";
  676. portName += CarlaString(j+1);
  677. }
  678. else
  679. portName += "output";
  680. portName.truncate(portNameSize);
  681. pData->audioOut.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, false, j);
  682. pData->audioOut.ports[j].rindex = j;
  683. }
  684. // TODO - MIDI
  685. // TODO - CV
  686. if (needsCtrlIn)
  687. {
  688. portName.clear();
  689. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  690. {
  691. portName = pData->name;
  692. portName += ":";
  693. }
  694. portName += "event-in";
  695. portName.truncate(portNameSize);
  696. pData->event.portIn = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, true, 0);
  697. }
  698. if (needsCtrlOut)
  699. {
  700. portName.clear();
  701. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  702. {
  703. portName = pData->name;
  704. portName += ":";
  705. }
  706. portName += "event-out";
  707. portName.truncate(portNameSize);
  708. pData->event.portOut = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, false, 0);
  709. }
  710. // extra plugin hints
  711. pData->extraHints = 0x0;
  712. if (fInfo.mIns > 0)
  713. pData->extraHints |= PLUGIN_EXTRA_HINT_HAS_MIDI_IN;
  714. if (fInfo.mOuts > 0)
  715. pData->extraHints |= PLUGIN_EXTRA_HINT_HAS_MIDI_OUT;
  716. if (fInfo.aIns <= 2 && fInfo.aOuts <= 2 && (fInfo.aIns == fInfo.aOuts || fInfo.aIns == 0 || fInfo.aOuts == 0))
  717. pData->extraHints |= PLUGIN_EXTRA_HINT_CAN_RUN_RACK;
  718. bufferSizeChanged(pData->engine->getBufferSize());
  719. reloadPrograms(true);
  720. carla_debug("CarlaPluginBridge::reload() - end");
  721. }
  722. // -------------------------------------------------------------------
  723. // Plugin processing
  724. void activate() noexcept override
  725. {
  726. CARLA_SAFE_ASSERT_RETURN(! fTimedError,);
  727. {
  728. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  729. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientActivate);
  730. fShmNonRtClientControl.commitWrite();
  731. }
  732. fTimedOut = false;
  733. try {
  734. waitForClient("activate", 2000);
  735. } CARLA_SAFE_EXCEPTION("activate - waitForClient");
  736. }
  737. void deactivate() noexcept override
  738. {
  739. CARLA_SAFE_ASSERT_RETURN(! fTimedError,);
  740. {
  741. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  742. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientDeactivate);
  743. fShmNonRtClientControl.commitWrite();
  744. }
  745. fTimedOut = false;
  746. try {
  747. waitForClient("deactivate", 2000);
  748. } CARLA_SAFE_EXCEPTION("deactivate - waitForClient");
  749. }
  750. void process(const float** const audioIn, float** const audioOut, const float** const cvIn, float** const cvOut, const uint32_t frames) override
  751. {
  752. // --------------------------------------------------------------------------------------------------------
  753. // Check if active
  754. if (fTimedOut || fTimedError || ! pData->active)
  755. {
  756. // disable any output sound
  757. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  758. FloatVectorOperations::clear(audioOut[i], static_cast<int>(frames));
  759. for (uint32_t i=0; i < pData->cvOut.count; ++i)
  760. FloatVectorOperations::clear(cvOut[i], static_cast<int>(frames));
  761. return;
  762. }
  763. // --------------------------------------------------------------------------------------------------------
  764. // Check if needs reset
  765. if (pData->needsReset)
  766. {
  767. // TODO
  768. pData->needsReset = false;
  769. }
  770. // --------------------------------------------------------------------------------------------------------
  771. // Event Input
  772. if (pData->event.portIn != nullptr)
  773. {
  774. // ----------------------------------------------------------------------------------------------------
  775. // MIDI Input (External)
  776. if (pData->extNotes.mutex.tryLock())
  777. {
  778. for (RtLinkedList<ExternalMidiNote>::Itenerator it = pData->extNotes.data.begin2(); it.valid(); it.next())
  779. {
  780. const ExternalMidiNote& note(it.getValue(kExternalMidiNoteFallback));
  781. CARLA_SAFE_ASSERT_CONTINUE(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS);
  782. uint8_t data1, data2, data3;
  783. data1 = uint8_t((note.velo > 0 ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF) | (note.channel & MIDI_CHANNEL_BIT));
  784. data2 = note.note;
  785. data3 = note.velo;
  786. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientMidiEvent);
  787. fShmRtClientControl.writeUInt(0); // time
  788. fShmRtClientControl.writeByte(0); // port
  789. fShmRtClientControl.writeByte(3); // size
  790. fShmRtClientControl.writeByte(data1);
  791. fShmRtClientControl.writeByte(data2);
  792. fShmRtClientControl.writeByte(data3);
  793. fShmRtClientControl.commitWrite();
  794. }
  795. pData->extNotes.data.clear();
  796. pData->extNotes.mutex.unlock();
  797. } // End of MIDI Input (External)
  798. // ----------------------------------------------------------------------------------------------------
  799. // Event Input (System)
  800. #ifndef BUILD_BRIDGE
  801. bool allNotesOffSent = false;
  802. #endif
  803. for (uint32_t i=0, numEvents=pData->event.portIn->getEventCount(); i < numEvents; ++i)
  804. {
  805. const EngineEvent& event(pData->event.portIn->getEvent(i));
  806. // Control change
  807. switch (event.type)
  808. {
  809. case kEngineEventTypeNull:
  810. break;
  811. case kEngineEventTypeControl: {
  812. const EngineControlEvent& ctrlEvent = event.ctrl;
  813. switch (ctrlEvent.type)
  814. {
  815. case kEngineControlEventTypeNull:
  816. break;
  817. case kEngineControlEventTypeParameter:
  818. #ifndef BUILD_BRIDGE
  819. // Control backend stuff
  820. if (event.channel == pData->ctrlChannel)
  821. {
  822. float value;
  823. if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_DRYWET) != 0)
  824. {
  825. value = ctrlEvent.value;
  826. setDryWet(value, false, false);
  827. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_DRYWET, 0, value);
  828. }
  829. if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_VOLUME) != 0)
  830. {
  831. value = ctrlEvent.value*127.0f/100.0f;
  832. setVolume(value, false, false);
  833. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_VOLUME, 0, value);
  834. }
  835. if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_BALANCE) != 0)
  836. {
  837. float left, right;
  838. value = ctrlEvent.value/0.5f - 1.0f;
  839. if (value < 0.0f)
  840. {
  841. left = -1.0f;
  842. right = (value*2.0f)+1.0f;
  843. }
  844. else if (value > 0.0f)
  845. {
  846. left = (value*2.0f)-1.0f;
  847. right = 1.0f;
  848. }
  849. else
  850. {
  851. left = -1.0f;
  852. right = 1.0f;
  853. }
  854. setBalanceLeft(left, false, false);
  855. setBalanceRight(right, false, false);
  856. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_LEFT, 0, left);
  857. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_RIGHT, 0, right);
  858. }
  859. }
  860. #endif
  861. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventParameter);
  862. fShmRtClientControl.writeUInt(event.time);
  863. fShmRtClientControl.writeByte(event.channel);
  864. fShmRtClientControl.writeUShort(event.ctrl.param);
  865. fShmRtClientControl.writeFloat(event.ctrl.value);
  866. fShmRtClientControl.commitWrite();
  867. break;
  868. case kEngineControlEventTypeMidiBank:
  869. if (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES)
  870. {
  871. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventMidiBank);
  872. fShmRtClientControl.writeUInt(event.time);
  873. fShmRtClientControl.writeByte(event.channel);
  874. fShmRtClientControl.writeUShort(event.ctrl.param);
  875. fShmRtClientControl.commitWrite();
  876. }
  877. break;
  878. case kEngineControlEventTypeMidiProgram:
  879. if (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES)
  880. {
  881. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventMidiProgram);
  882. fShmRtClientControl.writeUInt(event.time);
  883. fShmRtClientControl.writeByte(event.channel);
  884. fShmRtClientControl.writeUShort(event.ctrl.param);
  885. fShmRtClientControl.commitWrite();
  886. }
  887. break;
  888. case kEngineControlEventTypeAllSoundOff:
  889. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  890. {
  891. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventAllSoundOff);
  892. fShmRtClientControl.writeUInt(event.time);
  893. fShmRtClientControl.writeByte(event.channel);
  894. fShmRtClientControl.commitWrite();
  895. }
  896. break;
  897. case kEngineControlEventTypeAllNotesOff:
  898. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  899. {
  900. #ifndef BUILD_BRIDGE
  901. if (event.channel == pData->ctrlChannel && ! allNotesOffSent)
  902. {
  903. allNotesOffSent = true;
  904. sendMidiAllNotesOffToCallback();
  905. }
  906. #endif
  907. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventAllNotesOff);
  908. fShmRtClientControl.writeUInt(event.time);
  909. fShmRtClientControl.writeByte(event.channel);
  910. fShmRtClientControl.commitWrite();
  911. }
  912. break;
  913. } // switch (ctrlEvent.type)
  914. break;
  915. } // case kEngineEventTypeControl
  916. case kEngineEventTypeMidi: {
  917. const EngineMidiEvent& midiEvent(event.midi);
  918. if (midiEvent.size == 0 || midiEvent.size >= MAX_MIDI_VALUE)
  919. continue;
  920. const uint8_t* const midiData(midiEvent.size > EngineMidiEvent::kDataSize ? midiEvent.dataExt : midiEvent.data);
  921. uint8_t status = uint8_t(MIDI_GET_STATUS_FROM_DATA(midiData));
  922. if (status == MIDI_STATUS_CHANNEL_PRESSURE && (pData->options & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0)
  923. continue;
  924. if (status == MIDI_STATUS_CONTROL_CHANGE && (pData->options & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0)
  925. continue;
  926. if (status == MIDI_STATUS_POLYPHONIC_AFTERTOUCH && (pData->options & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0)
  927. continue;
  928. if (status == MIDI_STATUS_PITCH_WHEEL_CONTROL && (pData->options & PLUGIN_OPTION_SEND_PITCHBEND) == 0)
  929. continue;
  930. // Fix bad note-off
  931. if (status == MIDI_STATUS_NOTE_ON && midiData[2] == 0)
  932. status = MIDI_STATUS_NOTE_OFF;
  933. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientMidiEvent);
  934. fShmRtClientControl.writeUInt(event.time);
  935. fShmRtClientControl.writeByte(midiEvent.port);
  936. fShmRtClientControl.writeByte(midiEvent.size);
  937. fShmRtClientControl.writeByte(uint8_t(midiData[0] | (event.channel & MIDI_CHANNEL_BIT)));
  938. for (uint8_t j=1; j < midiEvent.size; ++j)
  939. fShmRtClientControl.writeByte(midiData[j]);
  940. fShmRtClientControl.commitWrite();
  941. if (status == MIDI_STATUS_NOTE_ON)
  942. pData->postponeRtEvent(kPluginPostRtEventNoteOn, event.channel, midiData[1], midiData[2]);
  943. else if (status == MIDI_STATUS_NOTE_OFF)
  944. pData->postponeRtEvent(kPluginPostRtEventNoteOff, event.channel, midiData[1], 0.0f);
  945. } break;
  946. }
  947. }
  948. pData->postRtEvents.trySplice();
  949. } // End of Event Input
  950. if (! processSingle(audioIn, audioOut, cvIn, cvOut, frames))
  951. return;
  952. // --------------------------------------------------------------------------------------------------------
  953. // Control and MIDI Output
  954. if (pData->event.portOut != nullptr)
  955. {
  956. float value;
  957. for (uint32_t k=0; k < pData->param.count; ++k)
  958. {
  959. if (pData->param.data[k].type != PARAMETER_OUTPUT)
  960. continue;
  961. if (pData->param.data[k].midiCC > 0)
  962. {
  963. value = pData->param.ranges[k].getNormalizedValue(fParams[k].value);
  964. pData->event.portOut->writeControlEvent(0, pData->param.data[k].midiChannel, kEngineControlEventTypeParameter, static_cast<uint16_t>(pData->param.data[k].midiCC), value);
  965. }
  966. }
  967. uint32_t time;
  968. uint8_t port, size;
  969. const uint8_t* midiData(fShmRtClientControl.data->midiOut);
  970. for (std::size_t read=0; read<kBridgeRtClientDataMidiOutSize;)
  971. {
  972. // get time
  973. time = *(const uint32_t*)midiData;
  974. midiData += 4;
  975. // get port and size
  976. port = *midiData++;
  977. size = *midiData++;
  978. if (size == 0)
  979. break;
  980. // store midi data advancing as needed
  981. uint8_t data[size];
  982. for (uint8_t j=0; j<size; ++j)
  983. data[j] = *midiData++;
  984. pData->event.portOut->writeMidiEvent(time, size, data);
  985. read += 6U /* time, port and size */ + size;
  986. }
  987. } // End of Control and MIDI Output
  988. }
  989. bool processSingle(const float** const audioIn, float** const audioOut,
  990. const float** const cvIn, float** const cvOut, const uint32_t frames)
  991. {
  992. CARLA_SAFE_ASSERT_RETURN(! fTimedError, false);
  993. CARLA_SAFE_ASSERT_RETURN(frames > 0, false);
  994. if (pData->audioIn.count > 0)
  995. {
  996. CARLA_SAFE_ASSERT_RETURN(audioIn != nullptr, false);
  997. }
  998. if (pData->audioOut.count > 0)
  999. {
  1000. CARLA_SAFE_ASSERT_RETURN(audioOut != nullptr, false);
  1001. }
  1002. if (pData->cvIn.count > 0)
  1003. {
  1004. CARLA_SAFE_ASSERT_RETURN(cvIn != nullptr, false);
  1005. }
  1006. if (pData->cvOut.count > 0)
  1007. {
  1008. CARLA_SAFE_ASSERT_RETURN(cvOut != nullptr, false);
  1009. }
  1010. const int iframes(static_cast<int>(frames));
  1011. // --------------------------------------------------------------------------------------------------------
  1012. // Try lock, silence otherwise
  1013. if (pData->engine->isOffline())
  1014. {
  1015. pData->singleMutex.lock();
  1016. }
  1017. else if (! pData->singleMutex.tryLock())
  1018. {
  1019. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  1020. FloatVectorOperations::clear(audioOut[i], iframes);
  1021. for (uint32_t i=0; i < pData->cvOut.count; ++i)
  1022. FloatVectorOperations::clear(cvOut[i], iframes);
  1023. return false;
  1024. }
  1025. // --------------------------------------------------------------------------------------------------------
  1026. // Reset audio buffers
  1027. for (uint32_t i=0; i < fInfo.aIns; ++i)
  1028. FloatVectorOperations::copy(fShmAudioPool.data + (i * frames), audioIn[i], iframes);
  1029. // --------------------------------------------------------------------------------------------------------
  1030. // TimeInfo
  1031. const EngineTimeInfo& timeInfo(pData->engine->getTimeInfo());
  1032. BridgeTimeInfo& bridgeTimeInfo(fShmRtClientControl.data->timeInfo);
  1033. bridgeTimeInfo.playing = timeInfo.playing;
  1034. bridgeTimeInfo.frame = timeInfo.frame;
  1035. bridgeTimeInfo.usecs = timeInfo.usecs;
  1036. bridgeTimeInfo.valid = timeInfo.valid;
  1037. if (timeInfo.valid & EngineTimeInfo::kValidBBT)
  1038. {
  1039. bridgeTimeInfo.bar = timeInfo.bbt.bar;
  1040. bridgeTimeInfo.beat = timeInfo.bbt.beat;
  1041. bridgeTimeInfo.tick = timeInfo.bbt.tick;
  1042. bridgeTimeInfo.beatsPerBar = timeInfo.bbt.beatsPerBar;
  1043. bridgeTimeInfo.beatType = timeInfo.bbt.beatType;
  1044. bridgeTimeInfo.ticksPerBeat = timeInfo.bbt.ticksPerBeat;
  1045. bridgeTimeInfo.beatsPerMinute = timeInfo.bbt.beatsPerMinute;
  1046. bridgeTimeInfo.barStartTick = timeInfo.bbt.barStartTick;
  1047. }
  1048. // --------------------------------------------------------------------------------------------------------
  1049. // Run plugin
  1050. {
  1051. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientProcess);
  1052. fShmRtClientControl.commitWrite();
  1053. }
  1054. waitForClient("process", fProcWaitTime);
  1055. if (fTimedOut)
  1056. {
  1057. pData->singleMutex.unlock();
  1058. return false;
  1059. }
  1060. for (uint32_t i=0; i < fInfo.aOuts; ++i)
  1061. FloatVectorOperations::copy(audioOut[i], fShmAudioPool.data + ((i + fInfo.aIns) * frames), iframes);
  1062. #ifndef BUILD_BRIDGE
  1063. // --------------------------------------------------------------------------------------------------------
  1064. // Post-processing (dry/wet, volume and balance)
  1065. {
  1066. const bool doVolume = (pData->hints & PLUGIN_CAN_VOLUME) != 0 && carla_isNotEqual(pData->postProc.volume, 1.0f);
  1067. const bool doDryWet = (pData->hints & PLUGIN_CAN_DRYWET) != 0 && carla_isNotEqual(pData->postProc.dryWet, 1.0f);
  1068. const bool doBalance = (pData->hints & PLUGIN_CAN_BALANCE) != 0 && ! (carla_isEqual(pData->postProc.balanceLeft, -1.0f) && carla_isEqual(pData->postProc.balanceRight, 1.0f));
  1069. const bool isMono = (pData->audioIn.count == 1);
  1070. bool isPair;
  1071. float bufValue, oldBufLeft[doBalance ? frames : 1];
  1072. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  1073. {
  1074. // Dry/Wet
  1075. if (doDryWet)
  1076. {
  1077. const uint32_t c = isMono ? 0 : i;
  1078. for (uint32_t k=0; k < frames; ++k)
  1079. {
  1080. if (k < pData->latency.frames)
  1081. bufValue = pData->latency.buffers[c][k];
  1082. else if (pData->latency.frames < frames)
  1083. bufValue = audioIn[c][k-pData->latency.frames];
  1084. else
  1085. bufValue = audioIn[c][k];
  1086. audioOut[i][k] = (audioOut[i][k] * pData->postProc.dryWet) + (bufValue * (1.0f - pData->postProc.dryWet));
  1087. }
  1088. }
  1089. // Balance
  1090. if (doBalance)
  1091. {
  1092. isPair = (i % 2 == 0);
  1093. if (isPair)
  1094. {
  1095. CARLA_ASSERT(i+1 < pData->audioOut.count);
  1096. FloatVectorOperations::copy(oldBufLeft, audioOut[i], iframes);
  1097. }
  1098. float balRangeL = (pData->postProc.balanceLeft + 1.0f)/2.0f;
  1099. float balRangeR = (pData->postProc.balanceRight + 1.0f)/2.0f;
  1100. for (uint32_t k=0; k < frames; ++k)
  1101. {
  1102. if (isPair)
  1103. {
  1104. // left
  1105. audioOut[i][k] = oldBufLeft[k] * (1.0f - balRangeL);
  1106. audioOut[i][k] += audioOut[i+1][k] * (1.0f - balRangeR);
  1107. }
  1108. else
  1109. {
  1110. // right
  1111. audioOut[i][k] = audioOut[i][k] * balRangeR;
  1112. audioOut[i][k] += oldBufLeft[k] * balRangeL;
  1113. }
  1114. }
  1115. }
  1116. // Volume (and buffer copy)
  1117. if (doVolume)
  1118. {
  1119. for (uint32_t k=0; k < frames; ++k)
  1120. audioOut[i][k] *= pData->postProc.volume;
  1121. }
  1122. }
  1123. } // End of Post-processing
  1124. // --------------------------------------------------------------------------------------------------------
  1125. // Save latency values for next callback
  1126. if (const uint32_t latframes = pData->latency.frames)
  1127. {
  1128. if (latframes <= frames)
  1129. {
  1130. for (uint32_t i=0; i < pData->audioIn.count; ++i)
  1131. FloatVectorOperations::copy(pData->latency.buffers[i], audioIn[i]+(frames-latframes), static_cast<int>(latframes));
  1132. }
  1133. else
  1134. {
  1135. const uint32_t diff = pData->latency.frames-frames;
  1136. for (uint32_t i=0, k; i<pData->audioIn.count; ++i)
  1137. {
  1138. // push back buffer by 'frames'
  1139. for (k=0; k < diff; ++k)
  1140. pData->latency.buffers[i][k] = pData->latency.buffers[i][k+frames];
  1141. // put current input at the end
  1142. for (uint32_t j=0; k < latframes; ++j, ++k)
  1143. pData->latency.buffers[i][k] = audioIn[i][j];
  1144. }
  1145. }
  1146. }
  1147. #endif // BUILD_BRIDGE
  1148. // --------------------------------------------------------------------------------------------------------
  1149. pData->singleMutex.unlock();
  1150. return true;
  1151. }
  1152. void bufferSizeChanged(const uint32_t newBufferSize) override
  1153. {
  1154. resizeAudioPool(newBufferSize);
  1155. {
  1156. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetBufferSize);
  1157. fShmRtClientControl.writeUInt(newBufferSize);
  1158. fShmRtClientControl.commitWrite();
  1159. }
  1160. //fProcWaitTime = newBufferSize*1000/pData->engine->getSampleRate();
  1161. fProcWaitTime = 1000;
  1162. waitForClient("buffersize", 1000);
  1163. }
  1164. void sampleRateChanged(const double newSampleRate) override
  1165. {
  1166. {
  1167. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetSampleRate);
  1168. fShmRtClientControl.writeDouble(newSampleRate);
  1169. fShmRtClientControl.commitWrite();
  1170. }
  1171. //fProcWaitTime = pData->engine->getBufferSize()*1000/newSampleRate;
  1172. fProcWaitTime = 1000;
  1173. waitForClient("samplerate", 1000);
  1174. }
  1175. void offlineModeChanged(const bool isOffline) override
  1176. {
  1177. {
  1178. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetOnline);
  1179. fShmRtClientControl.writeBool(isOffline);
  1180. fShmRtClientControl.commitWrite();
  1181. }
  1182. waitForClient("offline", 1000);
  1183. }
  1184. // -------------------------------------------------------------------
  1185. // Plugin buffers
  1186. void clearBuffers() noexcept override
  1187. {
  1188. if (fParams != nullptr)
  1189. {
  1190. delete[] fParams;
  1191. fParams = nullptr;
  1192. }
  1193. CarlaPlugin::clearBuffers();
  1194. }
  1195. // -------------------------------------------------------------------
  1196. // Post-poned UI Stuff
  1197. void uiParameterChange(const uint32_t index, const float value) noexcept override
  1198. {
  1199. CARLA_SAFE_ASSERT_RETURN(index < pData->param.count,);
  1200. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1201. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiParameterChange);
  1202. fShmNonRtClientControl.writeUInt(index);
  1203. fShmNonRtClientControl.writeFloat(value);
  1204. fShmNonRtClientControl.commitWrite();
  1205. }
  1206. void uiProgramChange(const uint32_t index) noexcept override
  1207. {
  1208. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count,);
  1209. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1210. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiProgramChange);
  1211. fShmNonRtClientControl.writeUInt(index);
  1212. fShmNonRtClientControl.commitWrite();
  1213. }
  1214. void uiMidiProgramChange(const uint32_t index) noexcept override
  1215. {
  1216. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count,);
  1217. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1218. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiMidiProgramChange);
  1219. fShmNonRtClientControl.writeUInt(index);
  1220. fShmNonRtClientControl.commitWrite();
  1221. }
  1222. void uiNoteOn(const uint8_t channel, const uint8_t note, const uint8_t velo) noexcept override
  1223. {
  1224. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1225. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1226. CARLA_SAFE_ASSERT_RETURN(velo > 0 && velo < MAX_MIDI_VALUE,);
  1227. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1228. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiNoteOn);
  1229. fShmNonRtClientControl.writeByte(channel);
  1230. fShmNonRtClientControl.writeByte(note);
  1231. fShmNonRtClientControl.writeByte(velo);
  1232. fShmNonRtClientControl.commitWrite();
  1233. }
  1234. void uiNoteOff(const uint8_t channel, const uint8_t note) noexcept override
  1235. {
  1236. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1237. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1238. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1239. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiNoteOff);
  1240. fShmNonRtClientControl.writeByte(channel);
  1241. fShmNonRtClientControl.writeByte(note);
  1242. fShmNonRtClientControl.commitWrite();
  1243. }
  1244. // -------------------------------------------------------------------
  1245. void handleNonRtData()
  1246. {
  1247. for (; fShmNonRtServerControl.isDataAvailableForReading();)
  1248. {
  1249. const PluginBridgeNonRtServerOpcode opcode(fShmNonRtServerControl.readOpcode());
  1250. #ifdef DEBUG
  1251. if (opcode != kPluginBridgeNonRtServerPong) {
  1252. carla_debug("CarlaPluginBridge::handleNonRtData() - got opcode: %s", PluginBridgeNonRtServerOpcode2str(opcode));
  1253. }
  1254. #endif
  1255. if (opcode != kPluginBridgeNonRtServerNull && fLastPongTime > 0)
  1256. fLastPongTime = Time::currentTimeMillis();
  1257. switch (opcode)
  1258. {
  1259. case kPluginBridgeNonRtServerNull:
  1260. case kPluginBridgeNonRtServerPong:
  1261. break;
  1262. case kPluginBridgeNonRtServerPluginInfo1: {
  1263. // uint/category, uint/hints, uint/optionsAvailable, uint/optionsEnabled, long/uniqueId
  1264. const uint32_t category = fShmNonRtServerControl.readUInt();
  1265. const uint32_t hints = fShmNonRtServerControl.readUInt();
  1266. const uint32_t optionAv = fShmNonRtServerControl.readUInt();
  1267. const uint32_t optionEn = fShmNonRtServerControl.readUInt();
  1268. const int64_t uniqueId = fShmNonRtServerControl.readLong();
  1269. CARLA_SAFE_ASSERT_INT2(fUniqueId == uniqueId, fUniqueId, uniqueId);
  1270. pData->hints = hints | PLUGIN_IS_BRIDGE;
  1271. pData->options = optionEn;
  1272. fInfo.category = static_cast<PluginCategory>(category);
  1273. fInfo.optionsAvailable = optionAv;
  1274. } break;
  1275. case kPluginBridgeNonRtServerPluginInfo2: {
  1276. // uint/size, str[] (realName), uint/size, str[] (label), uint/size, str[] (maker), uint/size, str[] (copyright)
  1277. // realName
  1278. const uint32_t realNameSize(fShmNonRtServerControl.readUInt());
  1279. char realName[realNameSize+1];
  1280. carla_zeroChars(realName, realNameSize+1);
  1281. fShmNonRtServerControl.readCustomData(realName, realNameSize);
  1282. // label
  1283. const uint32_t labelSize(fShmNonRtServerControl.readUInt());
  1284. char label[labelSize+1];
  1285. carla_zeroChars(label, labelSize+1);
  1286. fShmNonRtServerControl.readCustomData(label, labelSize);
  1287. // maker
  1288. const uint32_t makerSize(fShmNonRtServerControl.readUInt());
  1289. char maker[makerSize+1];
  1290. carla_zeroChars(maker, makerSize+1);
  1291. fShmNonRtServerControl.readCustomData(maker, makerSize);
  1292. // copyright
  1293. const uint32_t copyrightSize(fShmNonRtServerControl.readUInt());
  1294. char copyright[copyrightSize+1];
  1295. carla_zeroChars(copyright, copyrightSize+1);
  1296. fShmNonRtServerControl.readCustomData(copyright, copyrightSize);
  1297. fInfo.name = realName;
  1298. fInfo.label = label;
  1299. fInfo.maker = maker;
  1300. fInfo.copyright = copyright;
  1301. if (pData->name == nullptr)
  1302. pData->name = pData->engine->getUniquePluginName(realName);
  1303. } break;
  1304. case kPluginBridgeNonRtServerAudioCount: {
  1305. // uint/ins, uint/outs
  1306. fInfo.aIns = fShmNonRtServerControl.readUInt();
  1307. fInfo.aOuts = fShmNonRtServerControl.readUInt();
  1308. CARLA_SAFE_ASSERT(fInfo.aInNames == nullptr);
  1309. CARLA_SAFE_ASSERT(fInfo.aOutNames == nullptr);
  1310. if (fInfo.aIns > 0)
  1311. {
  1312. fInfo.aInNames = new const char*[fInfo.aIns];
  1313. carla_zeroPointers(fInfo.aInNames, fInfo.aIns);
  1314. }
  1315. if (fInfo.aOuts > 0)
  1316. {
  1317. fInfo.aOutNames = new const char*[fInfo.aOuts];
  1318. carla_zeroPointers(fInfo.aOutNames, fInfo.aOuts);
  1319. }
  1320. } break;
  1321. case kPluginBridgeNonRtServerMidiCount: {
  1322. // uint/ins, uint/outs
  1323. fInfo.mIns = fShmNonRtServerControl.readUInt();
  1324. fInfo.mOuts = fShmNonRtServerControl.readUInt();
  1325. } break;
  1326. case kPluginBridgeNonRtServerCvCount: {
  1327. // uint/ins, uint/outs
  1328. fInfo.cvIns = fShmNonRtServerControl.readUInt();
  1329. fInfo.cvOuts = fShmNonRtServerControl.readUInt();
  1330. } break;
  1331. case kPluginBridgeNonRtServerParameterCount: {
  1332. // uint/count
  1333. const uint32_t count = fShmNonRtServerControl.readUInt();
  1334. // delete old data
  1335. pData->param.clear();
  1336. if (fParams != nullptr)
  1337. {
  1338. delete[] fParams;
  1339. fParams = nullptr;
  1340. }
  1341. if (count > 0)
  1342. {
  1343. pData->param.createNew(count, false);
  1344. fParams = new BridgeParamInfo[count];
  1345. // we might not receive all parameter data, so ensure range max is not 0
  1346. for (uint32_t i=0; i<count; ++i)
  1347. {
  1348. pData->param.ranges[i].def = 0.0f;
  1349. pData->param.ranges[i].min = 0.0f;
  1350. pData->param.ranges[i].max = 1.0f;
  1351. pData->param.ranges[i].step = 0.001f;
  1352. pData->param.ranges[i].stepSmall = 0.0001f;
  1353. pData->param.ranges[i].stepLarge = 0.1f;
  1354. }
  1355. }
  1356. } break;
  1357. case kPluginBridgeNonRtServerProgramCount: {
  1358. // uint/count
  1359. pData->prog.clear();
  1360. if (const uint32_t count = fShmNonRtServerControl.readUInt())
  1361. pData->prog.createNew(static_cast<uint32_t>(count));
  1362. } break;
  1363. case kPluginBridgeNonRtServerMidiProgramCount: {
  1364. // uint/count
  1365. pData->midiprog.clear();
  1366. if (const uint32_t count = fShmNonRtServerControl.readUInt())
  1367. pData->midiprog.createNew(static_cast<uint32_t>(count));
  1368. } break;
  1369. case kPluginBridgeNonRtServerPortName: {
  1370. // byte/type, uint/index, uint/size, str[] (name)
  1371. const uint8_t portType = fShmNonRtServerControl.readByte();
  1372. const uint32_t index = fShmNonRtServerControl.readUInt();
  1373. // name
  1374. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1375. char* const name = new char[nameSize+1];
  1376. carla_zeroChars(name, nameSize+1);
  1377. fShmNonRtServerControl.readCustomData(name, nameSize);
  1378. CARLA_SAFE_ASSERT_BREAK(portType > kPluginBridgePortNull && portType < kPluginBridgePortTypeCount);
  1379. switch (portType)
  1380. {
  1381. case kPluginBridgePortAudioInput:
  1382. CARLA_SAFE_ASSERT_BREAK(index < fInfo.aIns);
  1383. fInfo.aInNames[index] = name;
  1384. break;
  1385. case kPluginBridgePortAudioOutput:
  1386. CARLA_SAFE_ASSERT_BREAK(index < fInfo.aOuts);
  1387. fInfo.aOutNames[index] = name;
  1388. break;
  1389. }
  1390. } break;
  1391. case kPluginBridgeNonRtServerParameterData1: {
  1392. // uint/index, int/rindex, uint/type, uint/hints, int/cc
  1393. const uint32_t index = fShmNonRtServerControl.readUInt();
  1394. const int32_t rindex = fShmNonRtServerControl.readInt();
  1395. const uint32_t type = fShmNonRtServerControl.readUInt();
  1396. const uint32_t hints = fShmNonRtServerControl.readUInt();
  1397. const int16_t midiCC = fShmNonRtServerControl.readShort();
  1398. CARLA_SAFE_ASSERT_BREAK(midiCC >= -1 && midiCC < MAX_MIDI_CONTROL);
  1399. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1400. if (index < pData->param.count)
  1401. {
  1402. pData->param.data[index].type = static_cast<ParameterType>(type);
  1403. pData->param.data[index].index = static_cast<int32_t>(index);
  1404. pData->param.data[index].rindex = rindex;
  1405. pData->param.data[index].hints = hints;
  1406. pData->param.data[index].midiCC = midiCC;
  1407. }
  1408. } break;
  1409. case kPluginBridgeNonRtServerParameterData2: {
  1410. // uint/index, uint/size, str[] (name), uint/size, str[] (unit)
  1411. const uint32_t index = fShmNonRtServerControl.readUInt();
  1412. // name
  1413. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1414. char name[nameSize+1];
  1415. carla_zeroChars(name, nameSize+1);
  1416. fShmNonRtServerControl.readCustomData(name, nameSize);
  1417. // symbol
  1418. const uint32_t symbolSize(fShmNonRtServerControl.readUInt());
  1419. char symbol[symbolSize+1];
  1420. carla_zeroChars(symbol, symbolSize+1);
  1421. fShmNonRtServerControl.readCustomData(symbol, symbolSize);
  1422. // unit
  1423. const uint32_t unitSize(fShmNonRtServerControl.readUInt());
  1424. char unit[unitSize+1];
  1425. carla_zeroChars(unit, unitSize+1);
  1426. fShmNonRtServerControl.readCustomData(unit, unitSize);
  1427. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1428. if (index < pData->param.count)
  1429. {
  1430. fParams[index].name = name;
  1431. fParams[index].symbol = symbol;
  1432. fParams[index].unit = unit;
  1433. }
  1434. } break;
  1435. case kPluginBridgeNonRtServerParameterRanges: {
  1436. // uint/index, float/def, float/min, float/max, float/step, float/stepSmall, float/stepLarge
  1437. const uint32_t index = fShmNonRtServerControl.readUInt();
  1438. const float def = fShmNonRtServerControl.readFloat();
  1439. const float min = fShmNonRtServerControl.readFloat();
  1440. const float max = fShmNonRtServerControl.readFloat();
  1441. const float step = fShmNonRtServerControl.readFloat();
  1442. const float stepSmall = fShmNonRtServerControl.readFloat();
  1443. const float stepLarge = fShmNonRtServerControl.readFloat();
  1444. CARLA_SAFE_ASSERT_BREAK(min < max);
  1445. CARLA_SAFE_ASSERT_BREAK(def >= min);
  1446. CARLA_SAFE_ASSERT_BREAK(def <= max);
  1447. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1448. if (index < pData->param.count)
  1449. {
  1450. pData->param.ranges[index].def = def;
  1451. pData->param.ranges[index].min = min;
  1452. pData->param.ranges[index].max = max;
  1453. pData->param.ranges[index].step = step;
  1454. pData->param.ranges[index].stepSmall = stepSmall;
  1455. pData->param.ranges[index].stepLarge = stepLarge;
  1456. }
  1457. } break;
  1458. case kPluginBridgeNonRtServerParameterValue: {
  1459. // uint/index, float/value
  1460. const uint32_t index = fShmNonRtServerControl.readUInt();
  1461. const float value = fShmNonRtServerControl.readFloat();
  1462. if (index < pData->param.count)
  1463. {
  1464. const float fixedValue(pData->param.getFixedValue(index, value));
  1465. fParams[index].value = fixedValue;
  1466. CarlaPlugin::setParameterValue(index, fixedValue, false, true, true);
  1467. }
  1468. } break;
  1469. case kPluginBridgeNonRtServerParameterValue2: {
  1470. // uint/index, float/value
  1471. const uint32_t index = fShmNonRtServerControl.readUInt();
  1472. const float value = fShmNonRtServerControl.readFloat();
  1473. if (index < pData->param.count)
  1474. {
  1475. const float fixedValue(pData->param.getFixedValue(index, value));
  1476. fParams[index].value = fixedValue;
  1477. }
  1478. } break;
  1479. case kPluginBridgeNonRtServerDefaultValue: {
  1480. // uint/index, float/value
  1481. const uint32_t index = fShmNonRtServerControl.readUInt();
  1482. const float value = fShmNonRtServerControl.readFloat();
  1483. if (index < pData->param.count)
  1484. pData->param.ranges[index].def = value;
  1485. } break;
  1486. case kPluginBridgeNonRtServerCurrentProgram: {
  1487. // int/index
  1488. const int32_t index = fShmNonRtServerControl.readInt();
  1489. CARLA_SAFE_ASSERT_BREAK(index >= -1);
  1490. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->prog.count), index, pData->prog.count);
  1491. CarlaPlugin::setProgram(index, false, true, true);
  1492. } break;
  1493. case kPluginBridgeNonRtServerCurrentMidiProgram: {
  1494. // int/index
  1495. const int32_t index = fShmNonRtServerControl.readInt();
  1496. CARLA_SAFE_ASSERT_BREAK(index >= -1);
  1497. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->midiprog.count), index, pData->midiprog.count);
  1498. CarlaPlugin::setMidiProgram(index, false, true, true);
  1499. } break;
  1500. case kPluginBridgeNonRtServerProgramName: {
  1501. // uint/index, uint/size, str[] (name)
  1502. const uint32_t index = fShmNonRtServerControl.readUInt();
  1503. // name
  1504. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1505. char name[nameSize+1];
  1506. carla_zeroChars(name, nameSize+1);
  1507. fShmNonRtServerControl.readCustomData(name, nameSize);
  1508. CARLA_SAFE_ASSERT_INT2(index < pData->prog.count, index, pData->prog.count);
  1509. if (index < pData->prog.count)
  1510. {
  1511. if (pData->prog.names[index] != nullptr)
  1512. delete[] pData->prog.names[index];
  1513. pData->prog.names[index] = carla_strdup(name);
  1514. }
  1515. } break;
  1516. case kPluginBridgeNonRtServerMidiProgramData: {
  1517. // uint/index, uint/bank, uint/program, uint/size, str[] (name)
  1518. const uint32_t index = fShmNonRtServerControl.readUInt();
  1519. const uint32_t bank = fShmNonRtServerControl.readUInt();
  1520. const uint32_t program = fShmNonRtServerControl.readUInt();
  1521. // name
  1522. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1523. char name[nameSize+1];
  1524. carla_zeroChars(name, nameSize+1);
  1525. fShmNonRtServerControl.readCustomData(name, nameSize);
  1526. CARLA_SAFE_ASSERT_INT2(index < pData->midiprog.count, index, pData->midiprog.count);
  1527. if (index < pData->midiprog.count)
  1528. {
  1529. if (pData->midiprog.data[index].name != nullptr)
  1530. delete[] pData->midiprog.data[index].name;
  1531. pData->midiprog.data[index].bank = bank;
  1532. pData->midiprog.data[index].program = program;
  1533. pData->midiprog.data[index].name = carla_strdup(name);
  1534. }
  1535. } break;
  1536. case kPluginBridgeNonRtServerSetCustomData: {
  1537. // uint/size, str[], uint/size, str[], uint/size, str[]
  1538. // type
  1539. const uint32_t typeSize(fShmNonRtServerControl.readUInt());
  1540. char type[typeSize+1];
  1541. carla_zeroChars(type, typeSize+1);
  1542. fShmNonRtServerControl.readCustomData(type, typeSize);
  1543. // key
  1544. const uint32_t keySize(fShmNonRtServerControl.readUInt());
  1545. char key[keySize+1];
  1546. carla_zeroChars(key, keySize+1);
  1547. fShmNonRtServerControl.readCustomData(key, keySize);
  1548. // value
  1549. const uint32_t valueSize(fShmNonRtServerControl.readUInt());
  1550. char value[valueSize+1];
  1551. carla_zeroChars(value, valueSize+1);
  1552. fShmNonRtServerControl.readCustomData(value, valueSize);
  1553. CarlaPlugin::setCustomData(type, key, value, false);
  1554. } break;
  1555. case kPluginBridgeNonRtServerSetChunkDataFile: {
  1556. // uint/size, str[] (filename)
  1557. // chunkFilePath
  1558. const uint32_t chunkFilePathSize(fShmNonRtServerControl.readUInt());
  1559. char chunkFilePath[chunkFilePathSize+1];
  1560. carla_zeroChars(chunkFilePath, chunkFilePathSize+1);
  1561. fShmNonRtServerControl.readCustomData(chunkFilePath, chunkFilePathSize);
  1562. String realChunkFilePath(chunkFilePath);
  1563. carla_stdout("chunk save path BEFORE => %s", realChunkFilePath.toRawUTF8());
  1564. #ifndef CARLA_OS_WIN
  1565. // Using Wine, fix temp dir
  1566. if (fBinaryType == BINARY_WIN32 || fBinaryType == BINARY_WIN64)
  1567. {
  1568. // Get WINEPREFIX
  1569. String wineDir;
  1570. if (const char* const WINEPREFIX = getenv("WINEPREFIX"))
  1571. wineDir = String(WINEPREFIX);
  1572. else
  1573. wineDir = File::getSpecialLocation(File::userHomeDirectory).getFullPathName() + "/.wine";
  1574. const StringArray driveLetterSplit(StringArray::fromTokens(realChunkFilePath, ":/", ""));
  1575. realChunkFilePath = wineDir;
  1576. realChunkFilePath += "/drive_";
  1577. realChunkFilePath += driveLetterSplit[0].toLowerCase();
  1578. realChunkFilePath += "/";
  1579. realChunkFilePath += driveLetterSplit[1];
  1580. realChunkFilePath = realChunkFilePath.replace("\\", "/");
  1581. carla_stdout("chunk save path AFTER => %s", realChunkFilePath.toRawUTF8());
  1582. }
  1583. #endif
  1584. File chunkFile(realChunkFilePath);
  1585. if (chunkFile.existsAsFile())
  1586. {
  1587. fInfo.chunk = carla_getChunkFromBase64String(chunkFile.loadFileAsString().toRawUTF8());
  1588. chunkFile.deleteFile();
  1589. }
  1590. } break;
  1591. case kPluginBridgeNonRtServerSetLatency:
  1592. // uint
  1593. fLatency = fShmNonRtServerControl.readUInt();
  1594. #ifndef BUILD_BRIDGE
  1595. if (! fInitiated)
  1596. pData->latency.recreateBuffers(std::max(fInfo.aIns, fInfo.aOuts), fLatency);
  1597. #endif
  1598. break;
  1599. case kPluginBridgeNonRtServerReady:
  1600. fInitiated = true;
  1601. break;
  1602. case kPluginBridgeNonRtServerSaved:
  1603. fSaved = true;
  1604. break;
  1605. case kPluginBridgeNonRtServerUiClosed:
  1606. pData->transientTryCounter = 0;
  1607. pData->engine->callback(ENGINE_CALLBACK_UI_STATE_CHANGED, pData->id, 0, 0, 0.0f, nullptr);
  1608. break;
  1609. case kPluginBridgeNonRtServerError: {
  1610. // error
  1611. const uint32_t errorSize(fShmNonRtServerControl.readUInt());
  1612. char error[errorSize+1];
  1613. carla_zeroChars(error, errorSize+1);
  1614. fShmNonRtServerControl.readCustomData(error, errorSize);
  1615. if (fInitiated)
  1616. {
  1617. pData->engine->callback(ENGINE_CALLBACK_ERROR, pData->id, 0, 0, 0.0f, error);
  1618. // just in case
  1619. pData->engine->setLastError(error);
  1620. fInitError = true;
  1621. }
  1622. else
  1623. {
  1624. pData->engine->setLastError(error);
  1625. fInitError = true;
  1626. fInitiated = true;
  1627. }
  1628. } break;
  1629. }
  1630. }
  1631. }
  1632. // -------------------------------------------------------------------
  1633. uintptr_t getUiBridgeProcessId() const noexcept override
  1634. {
  1635. return fBridgeThread.getProcessPID();
  1636. }
  1637. const void* getExtraStuff() const noexcept override
  1638. {
  1639. return fBridgeBinary.isNotEmpty() ? fBridgeBinary.buffer() : nullptr;
  1640. }
  1641. // -------------------------------------------------------------------
  1642. bool init(const char* const filename, const char* const name, const char* const label, const int64_t uniqueId, const char* const bridgeBinary)
  1643. {
  1644. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr, false);
  1645. // ---------------------------------------------------------------
  1646. // first checks
  1647. if (pData->client != nullptr)
  1648. {
  1649. pData->engine->setLastError("Plugin client is already registered");
  1650. return false;
  1651. }
  1652. if (bridgeBinary == nullptr || bridgeBinary[0] == '\0')
  1653. {
  1654. pData->engine->setLastError("null bridge binary");
  1655. return false;
  1656. }
  1657. // ---------------------------------------------------------------
  1658. // set info
  1659. if (name != nullptr && name[0] != '\0')
  1660. pData->name = pData->engine->getUniquePluginName(name);
  1661. if (filename != nullptr && filename[0] != '\0')
  1662. pData->filename = carla_strdup(filename);
  1663. else
  1664. pData->filename = carla_strdup("");
  1665. fUniqueId = uniqueId;
  1666. fBridgeBinary = bridgeBinary;
  1667. std::srand(static_cast<uint>(std::time(nullptr)));
  1668. // ---------------------------------------------------------------
  1669. // init sem/shm
  1670. if (! fShmAudioPool.initializeServer())
  1671. {
  1672. carla_stderr("Failed to initialize shared memory audio pool");
  1673. return false;
  1674. }
  1675. if (! fShmRtClientControl.initializeServer())
  1676. {
  1677. carla_stderr("Failed to initialize RT client control");
  1678. fShmAudioPool.clear();
  1679. return false;
  1680. }
  1681. if (! fShmNonRtClientControl.initializeServer())
  1682. {
  1683. carla_stderr("Failed to initialize Non-RT client control");
  1684. fShmRtClientControl.clear();
  1685. fShmAudioPool.clear();
  1686. return false;
  1687. }
  1688. if (! fShmNonRtServerControl.initializeServer())
  1689. {
  1690. carla_stderr("Failed to initialize Non-RT server control");
  1691. fShmNonRtClientControl.clear();
  1692. fShmRtClientControl.clear();
  1693. fShmAudioPool.clear();
  1694. return false;
  1695. }
  1696. // ---------------------------------------------------------------
  1697. // initial values
  1698. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientNull);
  1699. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeRtClientData)));
  1700. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeNonRtClientData)));
  1701. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeNonRtServerData)));
  1702. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientInitialSetup);
  1703. fShmNonRtClientControl.writeUInt(pData->engine->getBufferSize());
  1704. fShmNonRtClientControl.writeDouble(pData->engine->getSampleRate());
  1705. fShmNonRtClientControl.commitWrite();
  1706. // testing dummy message
  1707. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientNull);
  1708. fShmRtClientControl.commitWrite();
  1709. // init bridge thread
  1710. {
  1711. char shmIdsStr[6*4+1];
  1712. carla_zeroChars(shmIdsStr, 6*4+1);
  1713. std::strncpy(shmIdsStr+6*0, &fShmAudioPool.filename[fShmAudioPool.filename.length()-6], 6);
  1714. std::strncpy(shmIdsStr+6*1, &fShmRtClientControl.filename[fShmRtClientControl.filename.length()-6], 6);
  1715. std::strncpy(shmIdsStr+6*2, &fShmNonRtClientControl.filename[fShmNonRtClientControl.filename.length()-6], 6);
  1716. std::strncpy(shmIdsStr+6*3, &fShmNonRtServerControl.filename[fShmNonRtServerControl.filename.length()-6], 6);
  1717. fBridgeThread.setData(bridgeBinary, label, shmIdsStr);
  1718. fBridgeThread.startThread();
  1719. }
  1720. fInitiated = false;
  1721. fLastPongTime = Time::currentTimeMillis();
  1722. CARLA_SAFE_ASSERT(fLastPongTime > 0);
  1723. static bool sFirstInit = true;
  1724. int64_t timeoutEnd = 5000;
  1725. if (sFirstInit)
  1726. timeoutEnd *= 2;
  1727. #ifndef CARLA_OS_WIN
  1728. if (fBinaryType == BINARY_WIN32 || fBinaryType == BINARY_WIN64)
  1729. timeoutEnd *= 2;
  1730. #endif
  1731. sFirstInit = false;
  1732. const bool needsEngineIdle = pData->engine->getType() != kEngineTypePlugin;
  1733. for (; Time::currentTimeMillis() < fLastPongTime + timeoutEnd && fBridgeThread.isThreadRunning();)
  1734. {
  1735. pData->engine->callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  1736. if (needsEngineIdle)
  1737. pData->engine->idle();
  1738. idle();
  1739. if (fInitiated)
  1740. break;
  1741. if (pData->engine->isAboutToClose())
  1742. break;
  1743. carla_msleep(20);
  1744. }
  1745. fLastPongTime = -1;
  1746. if (fInitError || ! fInitiated)
  1747. {
  1748. fBridgeThread.stopThread(6000);
  1749. if (! fInitError)
  1750. pData->engine->setLastError("Timeout while waiting for a response from plugin-bridge\n(or the plugin crashed on initialization?)");
  1751. return false;
  1752. }
  1753. // ---------------------------------------------------------------
  1754. // register client
  1755. if (pData->name == nullptr)
  1756. {
  1757. if (label != nullptr && label[0] != '\0')
  1758. pData->name = pData->engine->getUniquePluginName(label);
  1759. else
  1760. pData->name = pData->engine->getUniquePluginName("unknown");
  1761. }
  1762. pData->client = pData->engine->addClient(this);
  1763. if (pData->client == nullptr || ! pData->client->isOk())
  1764. {
  1765. pData->engine->setLastError("Failed to register plugin client");
  1766. return false;
  1767. }
  1768. return true;
  1769. }
  1770. private:
  1771. const BinaryType fBinaryType;
  1772. const PluginType fPluginType;
  1773. bool fInitiated;
  1774. bool fInitError;
  1775. bool fSaved;
  1776. bool fTimedOut;
  1777. bool fTimedError;
  1778. uint fProcWaitTime;
  1779. int64_t fLastPongTime;
  1780. CarlaString fBridgeBinary;
  1781. CarlaPluginBridgeThread fBridgeThread;
  1782. BridgeAudioPool fShmAudioPool;
  1783. BridgeRtClientControl fShmRtClientControl;
  1784. BridgeNonRtClientControl fShmNonRtClientControl;
  1785. BridgeNonRtServerControl fShmNonRtServerControl;
  1786. struct Info {
  1787. uint32_t aIns, aOuts;
  1788. uint32_t cvIns, cvOuts;
  1789. uint32_t mIns, mOuts;
  1790. PluginCategory category;
  1791. uint optionsAvailable;
  1792. CarlaString name;
  1793. CarlaString label;
  1794. CarlaString maker;
  1795. CarlaString copyright;
  1796. const char** aInNames;
  1797. const char** aOutNames;
  1798. std::vector<uint8_t> chunk;
  1799. Info()
  1800. : aIns(0),
  1801. aOuts(0),
  1802. cvIns(0),
  1803. cvOuts(0),
  1804. mIns(0),
  1805. mOuts(0),
  1806. category(PLUGIN_CATEGORY_NONE),
  1807. optionsAvailable(0),
  1808. name(),
  1809. label(),
  1810. maker(),
  1811. copyright(),
  1812. aInNames(nullptr),
  1813. aOutNames(nullptr),
  1814. chunk() {}
  1815. CARLA_DECLARE_NON_COPY_STRUCT(Info)
  1816. } fInfo;
  1817. int64_t fUniqueId;
  1818. uint32_t fLatency;
  1819. BridgeParamInfo* fParams;
  1820. void resizeAudioPool(const uint32_t bufferSize)
  1821. {
  1822. fShmAudioPool.resize(bufferSize, fInfo.aIns+fInfo.aOuts, fInfo.cvIns+fInfo.cvOuts);
  1823. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetAudioPool);
  1824. fShmRtClientControl.writeULong(static_cast<uint64_t>(fShmAudioPool.dataSize));
  1825. fShmRtClientControl.commitWrite();
  1826. waitForClient("resize-pool", 5000);
  1827. }
  1828. void waitForClient(const char* const action, const uint msecs)
  1829. {
  1830. CARLA_SAFE_ASSERT_RETURN(! fTimedOut,);
  1831. CARLA_SAFE_ASSERT_RETURN(! fTimedError,);
  1832. if (fShmRtClientControl.waitForClient(msecs))
  1833. return;
  1834. fTimedOut = true;
  1835. carla_stderr("waitForClient(%s) timed out", action);
  1836. }
  1837. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaPluginBridge)
  1838. };
  1839. CARLA_BACKEND_END_NAMESPACE
  1840. // -------------------------------------------------------------------------------------------------------------------
  1841. CARLA_BACKEND_START_NAMESPACE
  1842. CarlaPlugin* CarlaPlugin::newBridge(const Initializer& init, BinaryType btype, PluginType ptype, const char* bridgeBinary)
  1843. {
  1844. carla_debug("CarlaPlugin::newBridge({%p, \"%s\", \"%s\", \"%s\"}, %s, %s, \"%s\")", init.engine, init.filename, init.name, init.label, BinaryType2Str(btype), PluginType2Str(ptype), bridgeBinary);
  1845. if (bridgeBinary == nullptr || bridgeBinary[0] == '\0')
  1846. {
  1847. init.engine->setLastError("Bridge not possible, bridge-binary not found");
  1848. return nullptr;
  1849. }
  1850. #ifndef CARLA_OS_WIN
  1851. // FIXME: somewhere, somehow, we end up with double slashes, wine doesn't like that.
  1852. if (std::strncmp(bridgeBinary, "//", 2) == 0)
  1853. ++bridgeBinary;
  1854. #endif
  1855. CarlaPluginBridge* const plugin(new CarlaPluginBridge(init.engine, init.id, btype, ptype));
  1856. if (! plugin->init(init.filename, init.name, init.label, init.uniqueId, bridgeBinary))
  1857. {
  1858. delete plugin;
  1859. return nullptr;
  1860. }
  1861. return plugin;
  1862. }
  1863. CARLA_BACKEND_END_NAMESPACE
  1864. // -------------------------------------------------------------------------------------------------------------------
  1865. #ifndef BUILD_BRIDGE
  1866. # include "CarlaBridgeUtils.cpp"
  1867. #endif
  1868. // -------------------------------------------------------------------------------------------------------------------