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.

3013 lines
106KB

  1. /*
  2. * Carla Plugin Bridge
  3. * Copyright (C) 2011-2019 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 "CarlaScopeUtils.hpp"
  25. #include "CarlaShmUtils.hpp"
  26. #include "CarlaThread.hpp"
  27. #include "jackbridge/JackBridge.hpp"
  28. #include <ctime>
  29. #include "water/files/File.h"
  30. #include "water/misc/Time.h"
  31. #include "water/threads/ChildProcess.h"
  32. // ---------------------------------------------------------------------------------------------------------------------
  33. using water::ChildProcess;
  34. using water::File;
  35. using water::String;
  36. using water::StringArray;
  37. using water::Time;
  38. CARLA_BACKEND_START_NAMESPACE
  39. // ---------------------------------------------------------------------------------------------------------------------
  40. // Fallback data
  41. static const ExternalMidiNote kExternalMidiNoteFallback = { -1, 0, 0 };
  42. // ---------------------------------------------------------------------------------------------------------------------
  43. static String findWinePrefix(const String filename, const int recursionLimit = 10)
  44. {
  45. if (recursionLimit == 0 || filename.length() < 5 || ! filename.contains("/"))
  46. return "";
  47. const String path(filename.upToLastOccurrenceOf("/", false, false));
  48. if (File(path + "/dosdevices").isDirectory())
  49. return path;
  50. return findWinePrefix(path, recursionLimit-1);
  51. }
  52. // ---------------------------------------------------------------------------------------------------------------------
  53. struct BridgeParamInfo {
  54. float value;
  55. CarlaString name;
  56. CarlaString symbol;
  57. CarlaString unit;
  58. BridgeParamInfo() noexcept
  59. : value(0.0f),
  60. name(),
  61. symbol(),
  62. unit() {}
  63. CARLA_DECLARE_NON_COPY_STRUCT(BridgeParamInfo)
  64. };
  65. // ---------------------------------------------------------------------------------------------------------------------
  66. class CarlaPluginBridgeThread : public CarlaThread
  67. {
  68. public:
  69. CarlaPluginBridgeThread(CarlaEngine* const engine, CarlaPlugin* const plugin) noexcept
  70. : CarlaThread("CarlaPluginBridgeThread"),
  71. kEngine(engine),
  72. kPlugin(plugin),
  73. fBinary(),
  74. fLabel(),
  75. fShmIds(),
  76. #ifndef CARLA_OS_WIN
  77. fWinePrefix(),
  78. #endif
  79. fProcess() {}
  80. void setData(
  81. #ifndef CARLA_OS_WIN
  82. const char* const winePrefix,
  83. #endif
  84. const char* const binary,
  85. const char* const label,
  86. const char* const shmIds) noexcept
  87. {
  88. CARLA_SAFE_ASSERT_RETURN(binary != nullptr && binary[0] != '\0',);
  89. CARLA_SAFE_ASSERT_RETURN(shmIds != nullptr && shmIds[0] != '\0',);
  90. CARLA_SAFE_ASSERT(! isThreadRunning());
  91. #ifndef CARLA_OS_WIN
  92. fWinePrefix = winePrefix;
  93. #endif
  94. fBinary = binary;
  95. fShmIds = shmIds;
  96. if (label != nullptr)
  97. fLabel = label;
  98. if (fLabel.isEmpty())
  99. fLabel = "\"\"";
  100. }
  101. uintptr_t getProcessPID() const noexcept
  102. {
  103. CARLA_SAFE_ASSERT_RETURN(fProcess != nullptr, 0);
  104. return (uintptr_t)fProcess->getPID();
  105. }
  106. protected:
  107. void run()
  108. {
  109. if (fProcess == nullptr)
  110. {
  111. fProcess = new ChildProcess();
  112. }
  113. else if (fProcess->isRunning())
  114. {
  115. carla_stderr("CarlaPluginBridgeThread::run() - already running");
  116. }
  117. char strBuf[STR_MAX+1];
  118. strBuf[STR_MAX] = '\0';
  119. const EngineOptions& options(kEngine->getOptions());
  120. String name(kPlugin->getName());
  121. String filename(kPlugin->getFilename());
  122. if (name.isEmpty())
  123. name = "(none)";
  124. if (filename.isEmpty())
  125. filename = "\"\"";
  126. StringArray arguments;
  127. #ifndef CARLA_OS_WIN
  128. // start with "wine" if needed
  129. if (fBinary.endsWithIgnoreCase(".exe"))
  130. {
  131. String wineCMD;
  132. if (options.wine.executable != nullptr && options.wine.executable[0] != '\0')
  133. {
  134. wineCMD = options.wine.executable;
  135. if (fBinary.endsWithIgnoreCase("64.exe")
  136. && options.wine.executable[0] == CARLA_OS_SEP
  137. && File(wineCMD + "64").existsAsFile())
  138. wineCMD += "64";
  139. }
  140. else
  141. {
  142. wineCMD = "wine";
  143. }
  144. arguments.add(wineCMD);
  145. }
  146. #endif
  147. // binary
  148. arguments.add(fBinary);
  149. // plugin type
  150. arguments.add(getPluginTypeAsString(kPlugin->getType()));
  151. // filename
  152. arguments.add(filename);
  153. // label
  154. arguments.add(fLabel);
  155. // uniqueId
  156. arguments.add(String(static_cast<water::int64>(kPlugin->getUniqueId())));
  157. bool started;
  158. {
  159. const ScopedEngineEnvironmentLocker _seel(kEngine);
  160. #ifdef CARLA_OS_LINUX
  161. const CarlaScopedEnvVar sev1("LD_LIBRARY_PATH", nullptr);
  162. const CarlaScopedEnvVar sev2("LD_PRELOAD", nullptr);
  163. #endif
  164. carla_setenv("ENGINE_OPTION_FORCE_STEREO", bool2str(options.forceStereo));
  165. carla_setenv("ENGINE_OPTION_PREFER_PLUGIN_BRIDGES", bool2str(options.preferPluginBridges));
  166. carla_setenv("ENGINE_OPTION_PREFER_UI_BRIDGES", bool2str(options.preferUiBridges));
  167. carla_setenv("ENGINE_OPTION_UIS_ALWAYS_ON_TOP", bool2str(options.uisAlwaysOnTop));
  168. std::snprintf(strBuf, STR_MAX, "%u", options.maxParameters);
  169. carla_setenv("ENGINE_OPTION_MAX_PARAMETERS", strBuf);
  170. std::snprintf(strBuf, STR_MAX, "%u", options.uiBridgesTimeout);
  171. carla_setenv("ENGINE_OPTION_UI_BRIDGES_TIMEOUT",strBuf);
  172. if (options.pathLADSPA != nullptr)
  173. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LADSPA", options.pathLADSPA);
  174. else
  175. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LADSPA", "");
  176. if (options.pathDSSI != nullptr)
  177. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_DSSI", options.pathDSSI);
  178. else
  179. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_DSSI", "");
  180. if (options.pathLV2 != nullptr)
  181. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LV2", options.pathLV2);
  182. else
  183. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LV2", "");
  184. if (options.pathVST2 != nullptr)
  185. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST2", options.pathVST2);
  186. else
  187. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST2", "");
  188. if (options.pathVST3 != nullptr)
  189. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST3", options.pathVST3);
  190. else
  191. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST3", "");
  192. if (options.pathSF2 != nullptr)
  193. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SF2", options.pathSF2);
  194. else
  195. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SF2", "");
  196. if (options.pathSFZ != nullptr)
  197. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SFZ", options.pathSFZ);
  198. else
  199. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SFZ", "");
  200. if (options.binaryDir != nullptr)
  201. carla_setenv("ENGINE_OPTION_PATH_BINARIES", options.binaryDir);
  202. else
  203. carla_setenv("ENGINE_OPTION_PATH_BINARIES", "");
  204. if (options.resourceDir != nullptr)
  205. carla_setenv("ENGINE_OPTION_PATH_RESOURCES", options.resourceDir);
  206. else
  207. carla_setenv("ENGINE_OPTION_PATH_RESOURCES", "");
  208. carla_setenv("ENGINE_OPTION_PREVENT_BAD_BEHAVIOUR", bool2str(options.preventBadBehaviour));
  209. std::snprintf(strBuf, STR_MAX, P_UINTPTR, options.frontendWinId);
  210. carla_setenv("ENGINE_OPTION_FRONTEND_WIN_ID", strBuf);
  211. carla_setenv("ENGINE_BRIDGE_SHM_IDS", fShmIds.toRawUTF8());
  212. #ifndef CARLA_OS_WIN
  213. if (fWinePrefix.isNotEmpty())
  214. {
  215. carla_setenv("WINEDEBUG", "-all");
  216. carla_setenv("WINEPREFIX", fWinePrefix.toRawUTF8());
  217. if (options.wine.rtPrio)
  218. {
  219. carla_setenv("STAGING_SHARED_MEMORY", "1");
  220. carla_setenv("WINE_RT_POLICY", "FF");
  221. std::snprintf(strBuf, STR_MAX, "%i", options.wine.baseRtPrio);
  222. carla_setenv("STAGING_RT_PRIORITY_BASE", strBuf);
  223. carla_setenv("WINE_RT", strBuf);
  224. carla_setenv("WINE_RT_PRIO", strBuf);
  225. std::snprintf(strBuf, STR_MAX, "%i", options.wine.serverRtPrio);
  226. carla_setenv("STAGING_RT_PRIORITY_SERVER", strBuf);
  227. carla_setenv("WINE_SVR_RT", strBuf);
  228. carla_stdout("Using WINEPREFIX '%s', with base RT prio %i and server RT prio %i",
  229. fWinePrefix.toRawUTF8(), options.wine.baseRtPrio, options.wine.serverRtPrio);
  230. }
  231. else
  232. {
  233. carla_unsetenv("STAGING_SHARED_MEMORY");
  234. carla_unsetenv("WINE_RT_POLICY");
  235. carla_unsetenv("STAGING_RT_PRIORITY_BASE");
  236. carla_unsetenv("STAGING_RT_PRIORITY_SERVER");
  237. carla_unsetenv("WINE_RT");
  238. carla_unsetenv("WINE_RT_PRIO");
  239. carla_unsetenv("WINE_SVR_RT");
  240. carla_stdout("Using WINEPREFIX '%s', without RT priorities", fWinePrefix.toRawUTF8());
  241. }
  242. }
  243. #endif
  244. carla_stdout("Starting plugin bridge, command is:\n%s \"%s\" \"%s\" \"%s\" " P_INT64,
  245. fBinary.toRawUTF8(), getPluginTypeAsString(kPlugin->getType()), filename.toRawUTF8(), fLabel.toRawUTF8(), kPlugin->getUniqueId());
  246. started = fProcess->start(arguments);
  247. }
  248. if (! started)
  249. {
  250. carla_stdout("failed!");
  251. fProcess = nullptr;
  252. return;
  253. }
  254. for (; fProcess->isRunning() && ! shouldThreadExit();)
  255. carla_sleep(1);
  256. // we only get here if bridge crashed or thread asked to exit
  257. if (fProcess->isRunning() && shouldThreadExit())
  258. {
  259. fProcess->waitForProcessToFinish(2000);
  260. if (fProcess->isRunning())
  261. {
  262. carla_stdout("CarlaPluginBridgeThread::run() - bridge refused to close, force kill now");
  263. fProcess->kill();
  264. }
  265. else
  266. {
  267. carla_stdout("CarlaPluginBridgeThread::run() - bridge auto-closed successfully");
  268. }
  269. }
  270. else
  271. {
  272. // forced quit, may have crashed
  273. if (fProcess->getExitCode() != 0 /*|| fProcess->exitStatus() == QProcess::CrashExit*/)
  274. {
  275. carla_stderr("CarlaPluginBridgeThread::run() - bridge crashed");
  276. CarlaString errorString("Plugin '" + CarlaString(kPlugin->getName()) + "' has crashed!\n"
  277. "Saving now will lose its current settings.\n"
  278. "Please remove this plugin, and not rely on it from this point.");
  279. kEngine->callback(true, true,
  280. CarlaBackend::ENGINE_CALLBACK_ERROR, kPlugin->getId(), 0, 0, 0, 0.0f, errorString);
  281. }
  282. }
  283. fProcess = nullptr;
  284. }
  285. private:
  286. CarlaEngine* const kEngine;
  287. CarlaPlugin* const kPlugin;
  288. String fBinary;
  289. String fLabel;
  290. String fShmIds;
  291. #ifndef CARLA_OS_WIN
  292. String fWinePrefix;
  293. #endif
  294. CarlaScopedPointer<ChildProcess> fProcess;
  295. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaPluginBridgeThread)
  296. };
  297. // ---------------------------------------------------------------------------------------------------------------------
  298. class CarlaPluginBridge : public CarlaPlugin
  299. {
  300. public:
  301. CarlaPluginBridge(CarlaEngine* const engine, const uint id, const BinaryType btype, const PluginType ptype)
  302. : CarlaPlugin(engine, id),
  303. fBinaryType(btype),
  304. fPluginType(ptype),
  305. fInitiated(false),
  306. fInitError(false),
  307. fSaved(true),
  308. fTimedOut(false),
  309. fTimedError(false),
  310. fBufferSize(engine->getBufferSize()),
  311. fProcWaitTime(0),
  312. fBridgeBinary(),
  313. fBridgeThread(engine, this),
  314. fShmAudioPool(),
  315. fShmRtClientControl(),
  316. fShmNonRtClientControl(),
  317. fShmNonRtServerControl(),
  318. #ifndef CARLA_OS_WIN
  319. fWinePrefix(),
  320. #endif
  321. fReceivingParamText(),
  322. fInfo(),
  323. fUniqueId(0),
  324. fLatency(0),
  325. fParams(nullptr)
  326. {
  327. carla_debug("CarlaPluginBridge::CarlaPluginBridge(%p, %i, %s, %s)", engine, id, BinaryType2Str(btype), PluginType2Str(ptype));
  328. pData->hints |= PLUGIN_IS_BRIDGE;
  329. }
  330. ~CarlaPluginBridge() override
  331. {
  332. carla_debug("CarlaPluginBridge::~CarlaPluginBridge()");
  333. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  334. // close UI
  335. if (pData->hints & PLUGIN_HAS_CUSTOM_UI)
  336. pData->transientTryCounter = 0;
  337. #endif
  338. pData->singleMutex.lock();
  339. pData->masterMutex.lock();
  340. if (pData->client != nullptr && pData->client->isActive())
  341. pData->client->deactivate();
  342. if (pData->active)
  343. {
  344. deactivate();
  345. pData->active = false;
  346. }
  347. if (fBridgeThread.isThreadRunning())
  348. {
  349. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientQuit);
  350. fShmNonRtClientControl.commitWrite();
  351. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientQuit);
  352. fShmRtClientControl.commitWrite();
  353. if (! fTimedOut)
  354. waitForClient("stopping", 3000);
  355. }
  356. fBridgeThread.stopThread(3000);
  357. fShmNonRtServerControl.clear();
  358. fShmNonRtClientControl.clear();
  359. fShmRtClientControl.clear();
  360. fShmAudioPool.clear();
  361. clearBuffers();
  362. fInfo.chunk.clear();
  363. }
  364. // -------------------------------------------------------------------
  365. // Information (base)
  366. BinaryType getBinaryType() const noexcept override
  367. {
  368. return fBinaryType;
  369. }
  370. PluginType getType() const noexcept override
  371. {
  372. return fPluginType;
  373. }
  374. PluginCategory getCategory() const noexcept override
  375. {
  376. return fInfo.category;
  377. }
  378. int64_t getUniqueId() const noexcept override
  379. {
  380. return fUniqueId;
  381. }
  382. uint32_t getLatencyInFrames() const noexcept override
  383. {
  384. return fLatency;
  385. }
  386. // -------------------------------------------------------------------
  387. // Information (count)
  388. uint32_t getMidiInCount() const noexcept override
  389. {
  390. return fInfo.mIns;
  391. }
  392. uint32_t getMidiOutCount() const noexcept override
  393. {
  394. return fInfo.mOuts;
  395. }
  396. // -------------------------------------------------------------------
  397. // Information (current data)
  398. std::size_t getChunkData(void** const dataPtr) noexcept override
  399. {
  400. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS, 0);
  401. CARLA_SAFE_ASSERT_RETURN(dataPtr != nullptr, 0);
  402. waitForSaved();
  403. CARLA_SAFE_ASSERT_RETURN(fInfo.chunk.size() > 0, 0);
  404. #ifdef CARLA_PROPER_CPP11_SUPPORT
  405. *dataPtr = fInfo.chunk.data();
  406. #else
  407. *dataPtr = &fInfo.chunk.front();
  408. #endif
  409. return fInfo.chunk.size();
  410. }
  411. // -------------------------------------------------------------------
  412. // Information (per-plugin data)
  413. uint getOptionsAvailable() const noexcept override
  414. {
  415. return fInfo.optionsAvailable;
  416. }
  417. float getParameterValue(const uint32_t parameterId) const noexcept override
  418. {
  419. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, 0.0f);
  420. return fParams[parameterId].value;
  421. }
  422. bool getLabel(char* const strBuf) const noexcept override
  423. {
  424. std::strncpy(strBuf, fInfo.label, STR_MAX);
  425. return true;
  426. }
  427. bool getMaker(char* const strBuf) const noexcept override
  428. {
  429. std::strncpy(strBuf, fInfo.maker, STR_MAX);
  430. return true;
  431. }
  432. bool getCopyright(char* const strBuf) const noexcept override
  433. {
  434. std::strncpy(strBuf, fInfo.copyright, STR_MAX);
  435. return true;
  436. }
  437. bool getRealName(char* const strBuf) const noexcept override
  438. {
  439. std::strncpy(strBuf, fInfo.name, STR_MAX);
  440. return true;
  441. }
  442. bool getParameterName(const uint32_t parameterId, char* const strBuf) const noexcept override
  443. {
  444. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, false);
  445. std::strncpy(strBuf, fParams[parameterId].name.buffer(), STR_MAX);
  446. return true;
  447. }
  448. bool getParameterText(const uint32_t parameterId, char* const strBuf) noexcept override
  449. {
  450. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, false);
  451. CARLA_SAFE_ASSERT_RETURN(! fReceivingParamText.isCurrentlyWaitingData(), false);
  452. const int32_t parameterIdi = static_cast<int32_t>(parameterId);
  453. fReceivingParamText.setTargetData(parameterIdi, strBuf);
  454. {
  455. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  456. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientGetParameterText);
  457. fShmNonRtClientControl.writeInt(parameterIdi);
  458. fShmNonRtClientControl.commitWrite();
  459. }
  460. if (waitForParameterText())
  461. return true;
  462. std::snprintf(strBuf, STR_MAX, "%f", static_cast<double>(fParams[parameterId].value));
  463. return false;
  464. }
  465. bool getParameterSymbol(const uint32_t parameterId, char* const strBuf) const noexcept override
  466. {
  467. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, false);
  468. std::strncpy(strBuf, fParams[parameterId].symbol.buffer(), STR_MAX);
  469. return true;
  470. }
  471. bool getParameterUnit(const uint32_t parameterId, char* const strBuf) const noexcept override
  472. {
  473. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, false);
  474. std::strncpy(strBuf, fParams[parameterId].unit.buffer(), STR_MAX);
  475. return true;
  476. }
  477. // -------------------------------------------------------------------
  478. // Set data (state)
  479. void prepareForSave() noexcept override
  480. {
  481. fSaved = false;
  482. {
  483. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  484. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPrepareForSave);
  485. fShmNonRtClientControl.commitWrite();
  486. }
  487. }
  488. bool waitForParameterText()
  489. {
  490. bool success;
  491. if (fReceivingParamText.wasDataReceived(&success))
  492. return success;
  493. const uint32_t timeoutEnd(Time::getMillisecondCounter() + 500); // 500 ms
  494. for (; Time::getMillisecondCounter() < timeoutEnd && fBridgeThread.isThreadRunning();)
  495. {
  496. if (fReceivingParamText.wasDataReceived(&success))
  497. return success;
  498. carla_msleep(5);
  499. }
  500. carla_stderr("CarlaPluginBridge::waitForParameterText() - Timeout while requesting text");
  501. #if 0
  502. // we waited and blocked for 5 secs, give host idle time now
  503. pData->engine->callback(true, true, ENGINE_CALLBACK_IDLE, 0, 0, 0, 0, 0.0f, nullptr);
  504. if (pData->engine->getType() != kEngineTypePlugin)
  505. pData->engine->idle();
  506. #endif
  507. return false;
  508. }
  509. void waitForSaved()
  510. {
  511. if (fSaved)
  512. return;
  513. // TODO: only wait 1 minute for NI plugins
  514. const uint32_t timeoutEnd(Time::getMillisecondCounter() + 60*1000); // 60 secs, 1 minute
  515. const bool needsEngineIdle(pData->engine->getType() != kEngineTypePlugin);
  516. for (; Time::getMillisecondCounter() < timeoutEnd && fBridgeThread.isThreadRunning();)
  517. {
  518. pData->engine->callback(true, true, ENGINE_CALLBACK_IDLE, 0, 0, 0, 0, 0.0f, nullptr);
  519. if (needsEngineIdle)
  520. pData->engine->idle();
  521. if (fSaved)
  522. break;
  523. carla_msleep(20);
  524. }
  525. if (! fBridgeThread.isThreadRunning())
  526. return carla_stderr("CarlaPluginBridge::waitForSaved() - Bridge is not running");
  527. if (! fSaved)
  528. return carla_stderr("CarlaPluginBridge::waitForSaved() - Timeout while requesting save state");
  529. }
  530. // -------------------------------------------------------------------
  531. // Set data (internal stuff)
  532. void setOption(const uint option, const bool yesNo, const bool sendCallback) override
  533. {
  534. {
  535. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  536. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetOption);
  537. fShmNonRtClientControl.writeUInt(option);
  538. fShmNonRtClientControl.writeBool(yesNo);
  539. fShmNonRtClientControl.commitWrite();
  540. }
  541. CarlaPlugin::setOption(option, yesNo, sendCallback);
  542. }
  543. void setCtrlChannel(const int8_t channel, const bool sendOsc, const bool sendCallback) noexcept override
  544. {
  545. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,);
  546. {
  547. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  548. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetCtrlChannel);
  549. fShmNonRtClientControl.writeShort(channel);
  550. fShmNonRtClientControl.commitWrite();
  551. }
  552. CarlaPlugin::setCtrlChannel(channel, sendOsc, sendCallback);
  553. }
  554. // -------------------------------------------------------------------
  555. // Set data (plugin-specific stuff)
  556. void setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  557. {
  558. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  559. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback,);
  560. const float fixedValue(pData->param.getFixedValue(parameterId, value));
  561. fParams[parameterId].value = fixedValue;
  562. {
  563. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  564. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterValue);
  565. fShmNonRtClientControl.writeUInt(parameterId);
  566. fShmNonRtClientControl.writeFloat(value);
  567. fShmNonRtClientControl.commitWrite();
  568. fShmNonRtClientControl.waitIfDataIsReachingLimit();
  569. }
  570. CarlaPlugin::setParameterValue(parameterId, fixedValue, sendGui, sendOsc, sendCallback);
  571. }
  572. void setParameterMidiChannel(const uint32_t parameterId, const uint8_t channel, const bool sendOsc, const bool sendCallback) noexcept override
  573. {
  574. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  575. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  576. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,);
  577. {
  578. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  579. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterMidiChannel);
  580. fShmNonRtClientControl.writeUInt(parameterId);
  581. fShmNonRtClientControl.writeByte(channel);
  582. fShmNonRtClientControl.commitWrite();
  583. }
  584. CarlaPlugin::setParameterMidiChannel(parameterId, channel, sendOsc, sendCallback);
  585. }
  586. void setParameterMidiCC(const uint32_t parameterId, const int16_t cc, const bool sendOsc, const bool sendCallback) noexcept override
  587. {
  588. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  589. CARLA_SAFE_ASSERT_RETURN(cc >= -1 && cc < MAX_MIDI_CONTROL,);
  590. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,);
  591. {
  592. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  593. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterMidiCC);
  594. fShmNonRtClientControl.writeUInt(parameterId);
  595. fShmNonRtClientControl.writeShort(cc);
  596. fShmNonRtClientControl.commitWrite();
  597. }
  598. CarlaPlugin::setParameterMidiCC(parameterId, cc, sendOsc, sendCallback);
  599. }
  600. void setProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback, const bool doingInit) noexcept override
  601. {
  602. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->prog.count),);
  603. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback || doingInit,);
  604. {
  605. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  606. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetProgram);
  607. fShmNonRtClientControl.writeInt(index);
  608. fShmNonRtClientControl.commitWrite();
  609. }
  610. CarlaPlugin::setProgram(index, sendGui, sendOsc, sendCallback, doingInit);
  611. }
  612. void setProgramRT(const uint32_t index, const bool sendCallbackLater) noexcept override
  613. {
  614. CARLA_SAFE_ASSERT_RETURN(index < pData->prog.count,);
  615. {
  616. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  617. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetProgram);
  618. fShmNonRtClientControl.writeInt(static_cast<int32_t>(index));
  619. fShmNonRtClientControl.commitWrite();
  620. }
  621. CarlaPlugin::setProgramRT(index, sendCallbackLater);
  622. }
  623. void setMidiProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback, const bool doingInit) noexcept override
  624. {
  625. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->midiprog.count),);
  626. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback || doingInit,);
  627. {
  628. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  629. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetMidiProgram);
  630. fShmNonRtClientControl.writeInt(index);
  631. fShmNonRtClientControl.commitWrite();
  632. }
  633. CarlaPlugin::setMidiProgram(index, sendGui, sendOsc, sendCallback, doingInit);
  634. }
  635. void setMidiProgramRT(const uint32_t uindex, const bool sendCallbackLater) noexcept override
  636. {
  637. CARLA_SAFE_ASSERT_RETURN(uindex < pData->midiprog.count,);
  638. {
  639. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  640. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetMidiProgram);
  641. fShmNonRtClientControl.writeInt(static_cast<int32_t>(uindex));
  642. fShmNonRtClientControl.commitWrite();
  643. }
  644. CarlaPlugin::setMidiProgramRT(uindex, sendCallbackLater);
  645. }
  646. void setCustomData(const char* const type, const char* const key, const char* const value, const bool sendGui) override
  647. {
  648. CARLA_SAFE_ASSERT_RETURN(type != nullptr && type[0] != '\0',);
  649. CARLA_SAFE_ASSERT_RETURN(key != nullptr && key[0] != '\0',);
  650. CARLA_SAFE_ASSERT_RETURN(value != nullptr,);
  651. if (std::strcmp(type, CUSTOM_DATA_TYPE_PROPERTY) == 0)
  652. return CarlaPlugin::setCustomData(type, key, value, sendGui);
  653. if (std::strcmp(type, CUSTOM_DATA_TYPE_STRING) == 0 && std::strcmp(key, "__CarlaPingOnOff__") == 0)
  654. {
  655. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  656. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPingOnOff);
  657. fShmNonRtClientControl.writeBool(std::strcmp(value, "true") == 0);
  658. fShmNonRtClientControl.commitWrite();
  659. return;
  660. }
  661. const uint32_t typeLen(static_cast<uint32_t>(std::strlen(type)));
  662. const uint32_t keyLen(static_cast<uint32_t>(std::strlen(key)));
  663. const uint32_t valueLen(static_cast<uint32_t>(std::strlen(value)));
  664. {
  665. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  666. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetCustomData);
  667. fShmNonRtClientControl.writeUInt(typeLen);
  668. fShmNonRtClientControl.writeCustomData(type, typeLen);
  669. fShmNonRtClientControl.writeUInt(keyLen);
  670. fShmNonRtClientControl.writeCustomData(key, keyLen);
  671. fShmNonRtClientControl.writeUInt(valueLen);
  672. if (valueLen > 0)
  673. fShmNonRtClientControl.writeCustomData(value, valueLen);
  674. fShmNonRtClientControl.commitWrite();
  675. }
  676. CarlaPlugin::setCustomData(type, key, value, sendGui);
  677. }
  678. void setChunkData(const void* const data, const std::size_t dataSize) override
  679. {
  680. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS,);
  681. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  682. CARLA_SAFE_ASSERT_RETURN(dataSize > 0,);
  683. CarlaString dataBase64(CarlaString::asBase64(data, dataSize));
  684. CARLA_SAFE_ASSERT_RETURN(dataBase64.length() > 0,);
  685. String filePath(File::getSpecialLocation(File::tempDirectory).getFullPathName());
  686. filePath += CARLA_OS_SEP_STR ".CarlaChunk_";
  687. filePath += fShmAudioPool.getFilenameSuffix();
  688. if (File(filePath).replaceWithText(dataBase64.buffer()))
  689. {
  690. const uint32_t ulength(static_cast<uint32_t>(filePath.length()));
  691. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  692. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetChunkDataFile);
  693. fShmNonRtClientControl.writeUInt(ulength);
  694. fShmNonRtClientControl.writeCustomData(filePath.toRawUTF8(), ulength);
  695. fShmNonRtClientControl.commitWrite();
  696. }
  697. // save data internally as well
  698. fInfo.chunk.resize(dataSize);
  699. #ifdef CARLA_PROPER_CPP11_SUPPORT
  700. std::memcpy(fInfo.chunk.data(), data, dataSize);
  701. #else
  702. std::memcpy(&fInfo.chunk.front(), data, dataSize);
  703. #endif
  704. }
  705. // -------------------------------------------------------------------
  706. // Set ui stuff
  707. void showCustomUI(const bool yesNo) override
  708. {
  709. {
  710. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  711. fShmNonRtClientControl.writeOpcode(yesNo ? kPluginBridgeNonRtClientShowUI : kPluginBridgeNonRtClientHideUI);
  712. fShmNonRtClientControl.commitWrite();
  713. }
  714. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  715. if (yesNo)
  716. {
  717. pData->tryTransient();
  718. }
  719. else
  720. {
  721. pData->transientTryCounter = 0;
  722. }
  723. #endif
  724. }
  725. void idle() override
  726. {
  727. if (fBridgeThread.isThreadRunning())
  728. {
  729. if (fInitiated && fTimedOut && pData->active)
  730. setActive(false, true, true);
  731. {
  732. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  733. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPing);
  734. fShmNonRtClientControl.commitWrite();
  735. }
  736. try {
  737. handleNonRtData();
  738. } CARLA_SAFE_EXCEPTION("handleNonRtData");
  739. }
  740. else if (fInitiated)
  741. {
  742. fTimedOut = true;
  743. fTimedError = true;
  744. fInitiated = false;
  745. handleProcessStopped();
  746. }
  747. CarlaPlugin::idle();
  748. }
  749. // -------------------------------------------------------------------
  750. // Plugin state
  751. void reload() override
  752. {
  753. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr,);
  754. carla_debug("CarlaPluginBridge::reload() - start");
  755. const EngineProcessMode processMode(pData->engine->getProccessMode());
  756. // Safely disable plugin for reload
  757. const ScopedDisabler sd(this);
  758. // cleanup of previous data
  759. pData->audioIn.clear();
  760. pData->audioOut.clear();
  761. pData->cvIn.clear();
  762. pData->cvOut.clear();
  763. pData->event.clear();
  764. bool needsCtrlIn, needsCtrlOut;
  765. needsCtrlIn = needsCtrlOut = false;
  766. if (fInfo.aIns > 0)
  767. {
  768. pData->audioIn.createNew(fInfo.aIns);
  769. }
  770. if (fInfo.aOuts > 0)
  771. {
  772. pData->audioOut.createNew(fInfo.aOuts);
  773. needsCtrlIn = true;
  774. }
  775. if (fInfo.cvIns > 0)
  776. {
  777. pData->cvIn.createNew(fInfo.cvIns);
  778. }
  779. if (fInfo.cvOuts > 0)
  780. {
  781. pData->cvOut.createNew(fInfo.cvOuts);
  782. }
  783. if (fInfo.mIns > 0)
  784. needsCtrlIn = true;
  785. if (fInfo.mOuts > 0)
  786. needsCtrlOut = true;
  787. const uint portNameSize(pData->engine->getMaxPortNameSize());
  788. CarlaString portName;
  789. // Audio Ins
  790. for (uint32_t j=0; j < fInfo.aIns; ++j)
  791. {
  792. portName.clear();
  793. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  794. {
  795. portName = pData->name;
  796. portName += ":";
  797. }
  798. if (fInfo.aInNames != nullptr && fInfo.aInNames[j] != nullptr)
  799. {
  800. portName += fInfo.aInNames[j];
  801. }
  802. else if (fInfo.aIns > 1)
  803. {
  804. portName += "input_";
  805. portName += CarlaString(j+1);
  806. }
  807. else
  808. portName += "input";
  809. portName.truncate(portNameSize);
  810. pData->audioIn.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, true, j);
  811. pData->audioIn.ports[j].rindex = j;
  812. }
  813. // Audio Outs
  814. for (uint32_t j=0; j < fInfo.aOuts; ++j)
  815. {
  816. portName.clear();
  817. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  818. {
  819. portName = pData->name;
  820. portName += ":";
  821. }
  822. if (fInfo.aOutNames != nullptr && fInfo.aOutNames[j] != nullptr)
  823. {
  824. portName += fInfo.aOutNames[j];
  825. }
  826. else if (fInfo.aOuts > 1)
  827. {
  828. portName += "output_";
  829. portName += CarlaString(j+1);
  830. }
  831. else
  832. portName += "output";
  833. portName.truncate(portNameSize);
  834. pData->audioOut.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, false, j);
  835. pData->audioOut.ports[j].rindex = j;
  836. }
  837. // TODO - MIDI
  838. // CV Ins
  839. for (uint32_t j=0; j < fInfo.cvIns; ++j)
  840. {
  841. portName.clear();
  842. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  843. {
  844. portName = pData->name;
  845. portName += ":";
  846. }
  847. if (fInfo.cvInNames != nullptr && fInfo.cvInNames[j] != nullptr)
  848. {
  849. portName += fInfo.cvInNames[j];
  850. }
  851. else if (fInfo.cvIns > 1)
  852. {
  853. portName += "cv_input_";
  854. portName += CarlaString(j+1);
  855. }
  856. else
  857. portName += "cv_input";
  858. portName.truncate(portNameSize);
  859. pData->cvIn.ports[j].port = (CarlaEngineCVPort*)pData->client->addPort(kEnginePortTypeCV, portName, true, j);
  860. pData->cvIn.ports[j].rindex = j;
  861. }
  862. // CV Outs
  863. for (uint32_t j=0; j < fInfo.cvOuts; ++j)
  864. {
  865. portName.clear();
  866. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  867. {
  868. portName = pData->name;
  869. portName += ":";
  870. }
  871. if (fInfo.cvOutNames != nullptr && fInfo.cvOutNames[j] != nullptr)
  872. {
  873. portName += fInfo.cvOutNames[j];
  874. }
  875. else if (fInfo.cvOuts > 1)
  876. {
  877. portName += "cv_output_";
  878. portName += CarlaString(j+1);
  879. }
  880. else
  881. portName += "cv_output";
  882. portName.truncate(portNameSize);
  883. pData->cvOut.ports[j].port = (CarlaEngineCVPort*)pData->client->addPort(kEnginePortTypeCV, portName, false, j);
  884. pData->cvOut.ports[j].rindex = j;
  885. }
  886. if (needsCtrlIn)
  887. {
  888. portName.clear();
  889. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  890. {
  891. portName = pData->name;
  892. portName += ":";
  893. }
  894. portName += "event-in";
  895. portName.truncate(portNameSize);
  896. pData->event.portIn = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, true, 0);
  897. }
  898. if (needsCtrlOut)
  899. {
  900. portName.clear();
  901. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  902. {
  903. portName = pData->name;
  904. portName += ":";
  905. }
  906. portName += "event-out";
  907. portName.truncate(portNameSize);
  908. pData->event.portOut = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, false, 0);
  909. }
  910. // extra plugin hints
  911. pData->extraHints = 0x0;
  912. if (fInfo.mIns > 0)
  913. pData->extraHints |= PLUGIN_EXTRA_HINT_HAS_MIDI_IN;
  914. if (fInfo.mOuts > 0)
  915. pData->extraHints |= PLUGIN_EXTRA_HINT_HAS_MIDI_OUT;
  916. bufferSizeChanged(pData->engine->getBufferSize());
  917. reloadPrograms(true);
  918. carla_debug("CarlaPluginBridge::reload() - end");
  919. }
  920. // -------------------------------------------------------------------
  921. // Plugin processing
  922. void activate() noexcept override
  923. {
  924. if (! fBridgeThread.isThreadRunning())
  925. {
  926. CARLA_SAFE_ASSERT_RETURN(restartBridgeThread(),);
  927. }
  928. {
  929. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  930. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientActivate);
  931. fShmNonRtClientControl.commitWrite();
  932. }
  933. fTimedOut = false;
  934. try {
  935. waitForClient("activate", 2000);
  936. } CARLA_SAFE_EXCEPTION("activate - waitForClient");
  937. }
  938. void deactivate() noexcept override
  939. {
  940. CARLA_SAFE_ASSERT_RETURN(! fTimedError,);
  941. {
  942. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  943. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientDeactivate);
  944. fShmNonRtClientControl.commitWrite();
  945. }
  946. fTimedOut = false;
  947. try {
  948. waitForClient("deactivate", 2000);
  949. } CARLA_SAFE_EXCEPTION("deactivate - waitForClient");
  950. }
  951. void process(const float** const audioIn,
  952. float** const audioOut,
  953. const float** const cvIn,
  954. float** const cvOut,
  955. const uint32_t frames) override
  956. {
  957. // --------------------------------------------------------------------------------------------------------
  958. // Check if active
  959. if (fTimedOut || fTimedError || ! pData->active)
  960. {
  961. // disable any output sound
  962. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  963. carla_zeroFloats(audioOut[i], frames);
  964. for (uint32_t i=0; i < pData->cvOut.count; ++i)
  965. carla_zeroFloats(cvOut[i], frames);
  966. return;
  967. }
  968. // --------------------------------------------------------------------------------------------------------
  969. // Check if needs reset
  970. if (pData->needsReset)
  971. {
  972. // TODO
  973. pData->needsReset = false;
  974. }
  975. // --------------------------------------------------------------------------------------------------------
  976. // Event Input
  977. if (pData->event.portIn != nullptr)
  978. {
  979. // ----------------------------------------------------------------------------------------------------
  980. // MIDI Input (External)
  981. if (pData->extNotes.mutex.tryLock())
  982. {
  983. for (RtLinkedList<ExternalMidiNote>::Itenerator it = pData->extNotes.data.begin2(); it.valid(); it.next())
  984. {
  985. const ExternalMidiNote& note(it.getValue(kExternalMidiNoteFallback));
  986. CARLA_SAFE_ASSERT_CONTINUE(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS);
  987. uint8_t data1, data2, data3;
  988. data1 = uint8_t((note.velo > 0 ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF) | (note.channel & MIDI_CHANNEL_BIT));
  989. data2 = note.note;
  990. data3 = note.velo;
  991. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientMidiEvent);
  992. fShmRtClientControl.writeUInt(0); // time
  993. fShmRtClientControl.writeByte(0); // port
  994. fShmRtClientControl.writeByte(3); // size
  995. fShmRtClientControl.writeByte(data1);
  996. fShmRtClientControl.writeByte(data2);
  997. fShmRtClientControl.writeByte(data3);
  998. fShmRtClientControl.commitWrite();
  999. }
  1000. pData->extNotes.data.clear();
  1001. pData->extNotes.mutex.unlock();
  1002. } // End of MIDI Input (External)
  1003. // ----------------------------------------------------------------------------------------------------
  1004. // Event Input (System)
  1005. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1006. bool allNotesOffSent = false;
  1007. #endif
  1008. for (uint32_t i=0, numEvents=pData->event.portIn->getEventCount(); i < numEvents; ++i)
  1009. {
  1010. const EngineEvent& event(pData->event.portIn->getEvent(i));
  1011. // Control change
  1012. switch (event.type)
  1013. {
  1014. case kEngineEventTypeNull:
  1015. break;
  1016. case kEngineEventTypeControl: {
  1017. const EngineControlEvent& ctrlEvent = event.ctrl;
  1018. switch (ctrlEvent.type)
  1019. {
  1020. case kEngineControlEventTypeNull:
  1021. break;
  1022. case kEngineControlEventTypeParameter:
  1023. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1024. // Control backend stuff
  1025. if (event.channel == pData->ctrlChannel)
  1026. {
  1027. float value;
  1028. if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_DRYWET) != 0)
  1029. {
  1030. value = ctrlEvent.value;
  1031. setDryWetRT(value, true);
  1032. }
  1033. if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_VOLUME) != 0)
  1034. {
  1035. value = ctrlEvent.value*127.0f/100.0f;
  1036. setVolumeRT(value, true);
  1037. }
  1038. if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_BALANCE) != 0)
  1039. {
  1040. float left, right;
  1041. value = ctrlEvent.value/0.5f - 1.0f;
  1042. if (value < 0.0f)
  1043. {
  1044. left = -1.0f;
  1045. right = (value*2.0f)+1.0f;
  1046. }
  1047. else if (value > 0.0f)
  1048. {
  1049. left = (value*2.0f)-1.0f;
  1050. right = 1.0f;
  1051. }
  1052. else
  1053. {
  1054. left = -1.0f;
  1055. right = 1.0f;
  1056. }
  1057. setBalanceLeftRT(left, true);
  1058. setBalanceRightRT(right, true);
  1059. }
  1060. }
  1061. #endif
  1062. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventParameter);
  1063. fShmRtClientControl.writeUInt(event.time);
  1064. fShmRtClientControl.writeByte(event.channel);
  1065. fShmRtClientControl.writeUShort(event.ctrl.param);
  1066. fShmRtClientControl.writeFloat(event.ctrl.value);
  1067. fShmRtClientControl.commitWrite();
  1068. break;
  1069. case kEngineControlEventTypeMidiBank:
  1070. if (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES)
  1071. {
  1072. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventMidiBank);
  1073. fShmRtClientControl.writeUInt(event.time);
  1074. fShmRtClientControl.writeByte(event.channel);
  1075. fShmRtClientControl.writeUShort(event.ctrl.param);
  1076. fShmRtClientControl.commitWrite();
  1077. }
  1078. else if ((pData->options & PLUGIN_OPTION_SEND_PROGRAM_CHANGES) != 0)
  1079. {
  1080. // VST2's that use banks usually require both a MSB bank message and a LSB bank message. The MSB bank message can just be 0
  1081. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientMidiEvent);
  1082. fShmRtClientControl.writeUInt(event.time);
  1083. fShmRtClientControl.writeByte(0); // port
  1084. fShmRtClientControl.writeByte(3); // size
  1085. fShmRtClientControl.writeByte(uint8_t(MIDI_STATUS_CONTROL_CHANGE | (event.channel & MIDI_CHANNEL_BIT)));
  1086. fShmRtClientControl.writeByte(MIDI_CONTROL_BANK_SELECT);
  1087. fShmRtClientControl.writeByte(0);
  1088. fShmRtClientControl.commitWrite();
  1089. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientMidiEvent);
  1090. fShmRtClientControl.writeUInt(event.time);
  1091. fShmRtClientControl.writeByte(0); // port
  1092. fShmRtClientControl.writeByte(3); // size
  1093. fShmRtClientControl.writeByte(uint8_t(MIDI_STATUS_CONTROL_CHANGE | (event.channel & MIDI_CHANNEL_BIT)));
  1094. fShmRtClientControl.writeByte(MIDI_CONTROL_BANK_SELECT__LSB);
  1095. fShmRtClientControl.writeByte(uint8_t(event.ctrl.param));
  1096. fShmRtClientControl.commitWrite();
  1097. }
  1098. break;
  1099. case kEngineControlEventTypeMidiProgram:
  1100. if (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES || pData->options & PLUGIN_OPTION_SEND_PROGRAM_CHANGES)
  1101. {
  1102. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventMidiProgram);
  1103. fShmRtClientControl.writeUInt(event.time);
  1104. fShmRtClientControl.writeByte(event.channel);
  1105. fShmRtClientControl.writeUShort(event.ctrl.param);
  1106. fShmRtClientControl.commitWrite();
  1107. }
  1108. break;
  1109. case kEngineControlEventTypeAllSoundOff:
  1110. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  1111. {
  1112. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventAllSoundOff);
  1113. fShmRtClientControl.writeUInt(event.time);
  1114. fShmRtClientControl.writeByte(event.channel);
  1115. fShmRtClientControl.commitWrite();
  1116. }
  1117. break;
  1118. case kEngineControlEventTypeAllNotesOff:
  1119. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  1120. {
  1121. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1122. if (event.channel == pData->ctrlChannel && ! allNotesOffSent)
  1123. {
  1124. allNotesOffSent = true;
  1125. postponeRtAllNotesOff();
  1126. }
  1127. #endif
  1128. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventAllNotesOff);
  1129. fShmRtClientControl.writeUInt(event.time);
  1130. fShmRtClientControl.writeByte(event.channel);
  1131. fShmRtClientControl.commitWrite();
  1132. }
  1133. break;
  1134. } // switch (ctrlEvent.type)
  1135. break;
  1136. } // case kEngineEventTypeControl
  1137. case kEngineEventTypeMidi: {
  1138. const EngineMidiEvent& midiEvent(event.midi);
  1139. if (midiEvent.size == 0 || midiEvent.size >= MAX_MIDI_VALUE)
  1140. continue;
  1141. const uint8_t* const midiData(midiEvent.size > EngineMidiEvent::kDataSize ? midiEvent.dataExt : midiEvent.data);
  1142. uint8_t status = uint8_t(MIDI_GET_STATUS_FROM_DATA(midiData));
  1143. if (status == MIDI_STATUS_CHANNEL_PRESSURE && (pData->options & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0)
  1144. continue;
  1145. if (status == MIDI_STATUS_CONTROL_CHANGE && (pData->options & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0)
  1146. continue;
  1147. if (status == MIDI_STATUS_POLYPHONIC_AFTERTOUCH && (pData->options & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0)
  1148. continue;
  1149. if (status == MIDI_STATUS_PITCH_WHEEL_CONTROL && (pData->options & PLUGIN_OPTION_SEND_PITCHBEND) == 0)
  1150. continue;
  1151. // Fix bad note-off
  1152. if (status == MIDI_STATUS_NOTE_ON && midiData[2] == 0)
  1153. status = MIDI_STATUS_NOTE_OFF;
  1154. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientMidiEvent);
  1155. fShmRtClientControl.writeUInt(event.time);
  1156. fShmRtClientControl.writeByte(midiEvent.port);
  1157. fShmRtClientControl.writeByte(midiEvent.size);
  1158. fShmRtClientControl.writeByte(uint8_t(midiData[0] | (event.channel & MIDI_CHANNEL_BIT)));
  1159. for (uint8_t j=1; j < midiEvent.size; ++j)
  1160. fShmRtClientControl.writeByte(midiData[j]);
  1161. fShmRtClientControl.commitWrite();
  1162. if (status == MIDI_STATUS_NOTE_ON)
  1163. {
  1164. pData->postponeRtEvent(kPluginPostRtEventNoteOn,
  1165. true,
  1166. event.channel,
  1167. midiData[1],
  1168. midiData[2],
  1169. 0.0f);
  1170. }
  1171. else if (status == MIDI_STATUS_NOTE_OFF)
  1172. {
  1173. pData->postponeRtEvent(kPluginPostRtEventNoteOff,
  1174. true,
  1175. event.channel,
  1176. midiData[1],
  1177. 0, 0.0f);
  1178. }
  1179. } break;
  1180. }
  1181. }
  1182. pData->postRtEvents.trySplice();
  1183. } // End of Event Input
  1184. if (! processSingle(audioIn, audioOut, cvIn, cvOut, frames))
  1185. return;
  1186. // --------------------------------------------------------------------------------------------------------
  1187. // Control and MIDI Output
  1188. if (pData->event.portOut != nullptr)
  1189. {
  1190. float value;
  1191. for (uint32_t k=0; k < pData->param.count; ++k)
  1192. {
  1193. if (pData->param.data[k].type != PARAMETER_OUTPUT)
  1194. continue;
  1195. if (pData->param.data[k].midiCC > 0)
  1196. {
  1197. value = pData->param.ranges[k].getNormalizedValue(fParams[k].value);
  1198. pData->event.portOut->writeControlEvent(0, pData->param.data[k].midiChannel, kEngineControlEventTypeParameter, static_cast<uint16_t>(pData->param.data[k].midiCC), value);
  1199. }
  1200. }
  1201. uint32_t time;
  1202. uint8_t port, size;
  1203. const uint8_t* midiData(fShmRtClientControl.data->midiOut);
  1204. for (std::size_t read=0; read<kBridgeRtClientDataMidiOutSize-kBridgeBaseMidiOutHeaderSize;)
  1205. {
  1206. // get time
  1207. time = *(const uint32_t*)midiData;
  1208. midiData += 4;
  1209. // get port and size
  1210. port = *midiData++;
  1211. size = *midiData++;
  1212. if (size == 0)
  1213. break;
  1214. // store midi data advancing as needed
  1215. uint8_t data[size];
  1216. for (uint8_t j=0; j<size; ++j)
  1217. data[j] = *midiData++;
  1218. pData->event.portOut->writeMidiEvent(time, size, data);
  1219. read += kBridgeBaseMidiOutHeaderSize + size;
  1220. }
  1221. // TODO
  1222. (void)port;
  1223. } // End of Control and MIDI Output
  1224. }
  1225. bool processSingle(const float** const audioIn, float** const audioOut,
  1226. const float** const cvIn, float** const cvOut, const uint32_t frames)
  1227. {
  1228. CARLA_SAFE_ASSERT_RETURN(! fTimedError, false);
  1229. CARLA_SAFE_ASSERT_RETURN(frames > 0, false);
  1230. CARLA_SAFE_ASSERT_RETURN(frames <= fBufferSize, false);
  1231. if (pData->audioIn.count > 0)
  1232. {
  1233. CARLA_SAFE_ASSERT_RETURN(audioIn != nullptr, false);
  1234. }
  1235. if (pData->audioOut.count > 0)
  1236. {
  1237. CARLA_SAFE_ASSERT_RETURN(audioOut != nullptr, false);
  1238. }
  1239. if (pData->cvIn.count > 0)
  1240. {
  1241. CARLA_SAFE_ASSERT_RETURN(cvIn != nullptr, false);
  1242. }
  1243. if (pData->cvOut.count > 0)
  1244. {
  1245. CARLA_SAFE_ASSERT_RETURN(cvOut != nullptr, false);
  1246. }
  1247. // --------------------------------------------------------------------------------------------------------
  1248. // Try lock, silence otherwise
  1249. #ifndef STOAT_TEST_BUILD
  1250. if (pData->engine->isOffline())
  1251. {
  1252. pData->singleMutex.lock();
  1253. }
  1254. else
  1255. #endif
  1256. if (! pData->singleMutex.tryLock())
  1257. {
  1258. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  1259. carla_zeroFloats(audioOut[i], frames);
  1260. for (uint32_t i=0; i < pData->cvOut.count; ++i)
  1261. carla_zeroFloats(cvOut[i], frames);
  1262. return false;
  1263. }
  1264. // --------------------------------------------------------------------------------------------------------
  1265. // Reset audio buffers
  1266. for (uint32_t i=0; i < pData->audioIn.count; ++i)
  1267. carla_copyFloats(fShmAudioPool.data + (i * fBufferSize), audioIn[i], frames);
  1268. for (uint32_t i=0; i < pData->cvIn.count; ++i)
  1269. carla_copyFloats(fShmAudioPool.data + ((pData->audioIn.count + pData->audioOut.count + i) * fBufferSize), cvIn[i], frames);
  1270. // --------------------------------------------------------------------------------------------------------
  1271. // TimeInfo
  1272. const EngineTimeInfo timeInfo(pData->engine->getTimeInfo());
  1273. BridgeTimeInfo& bridgeTimeInfo(fShmRtClientControl.data->timeInfo);
  1274. bridgeTimeInfo.playing = timeInfo.playing;
  1275. bridgeTimeInfo.frame = timeInfo.frame;
  1276. bridgeTimeInfo.usecs = timeInfo.usecs;
  1277. bridgeTimeInfo.validFlags = timeInfo.bbt.valid ? kPluginBridgeTimeInfoValidBBT : 0x0;
  1278. if (timeInfo.bbt.valid)
  1279. {
  1280. bridgeTimeInfo.bar = timeInfo.bbt.bar;
  1281. bridgeTimeInfo.beat = timeInfo.bbt.beat;
  1282. bridgeTimeInfo.tick = timeInfo.bbt.tick;
  1283. bridgeTimeInfo.beatsPerBar = timeInfo.bbt.beatsPerBar;
  1284. bridgeTimeInfo.beatType = timeInfo.bbt.beatType;
  1285. bridgeTimeInfo.ticksPerBeat = timeInfo.bbt.ticksPerBeat;
  1286. bridgeTimeInfo.beatsPerMinute = timeInfo.bbt.beatsPerMinute;
  1287. bridgeTimeInfo.barStartTick = timeInfo.bbt.barStartTick;
  1288. }
  1289. // --------------------------------------------------------------------------------------------------------
  1290. // Run plugin
  1291. {
  1292. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientProcess);
  1293. fShmRtClientControl.writeUInt(frames);
  1294. fShmRtClientControl.commitWrite();
  1295. }
  1296. waitForClient("process", fProcWaitTime);
  1297. if (fTimedOut)
  1298. {
  1299. pData->singleMutex.unlock();
  1300. return false;
  1301. }
  1302. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  1303. carla_copyFloats(audioOut[i], fShmAudioPool.data + ((pData->audioIn.count + i) * fBufferSize), frames);
  1304. for (uint32_t i=0; i < pData->cvOut.count; ++i)
  1305. carla_copyFloats(cvOut[i], fShmAudioPool.data + ((pData->audioIn.count + pData->audioOut.count + pData->cvIn.count + i) * fBufferSize), frames);
  1306. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1307. // --------------------------------------------------------------------------------------------------------
  1308. // Post-processing (dry/wet, volume and balance)
  1309. {
  1310. const bool doVolume = (pData->hints & PLUGIN_CAN_VOLUME) != 0 && carla_isNotEqual(pData->postProc.volume, 1.0f);
  1311. const bool doDryWet = (pData->hints & PLUGIN_CAN_DRYWET) != 0 && carla_isNotEqual(pData->postProc.dryWet, 1.0f);
  1312. const bool doBalance = (pData->hints & PLUGIN_CAN_BALANCE) != 0 && ! (carla_isEqual(pData->postProc.balanceLeft, -1.0f) && carla_isEqual(pData->postProc.balanceRight, 1.0f));
  1313. const bool isMono = (pData->audioIn.count == 1);
  1314. bool isPair;
  1315. float bufValue, oldBufLeft[doBalance ? frames : 1];
  1316. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  1317. {
  1318. // Dry/Wet
  1319. if (doDryWet)
  1320. {
  1321. const uint32_t c = isMono ? 0 : i;
  1322. for (uint32_t k=0; k < frames; ++k)
  1323. {
  1324. # ifndef BUILD_BRIDGE
  1325. if (k < pData->latency.frames && pData->latency.buffers != nullptr)
  1326. bufValue = pData->latency.buffers[c][k];
  1327. else if (pData->latency.frames < frames)
  1328. bufValue = audioIn[c][k-pData->latency.frames];
  1329. else
  1330. # endif
  1331. bufValue = audioIn[c][k];
  1332. audioOut[i][k] = (audioOut[i][k] * pData->postProc.dryWet) + (bufValue * (1.0f - pData->postProc.dryWet));
  1333. }
  1334. }
  1335. // Balance
  1336. if (doBalance)
  1337. {
  1338. isPair = (i % 2 == 0);
  1339. if (isPair)
  1340. {
  1341. CARLA_ASSERT(i+1 < pData->audioOut.count);
  1342. carla_copyFloats(oldBufLeft, audioOut[i], frames);
  1343. }
  1344. float balRangeL = (pData->postProc.balanceLeft + 1.0f)/2.0f;
  1345. float balRangeR = (pData->postProc.balanceRight + 1.0f)/2.0f;
  1346. for (uint32_t k=0; k < frames; ++k)
  1347. {
  1348. if (isPair)
  1349. {
  1350. // left
  1351. audioOut[i][k] = oldBufLeft[k] * (1.0f - balRangeL);
  1352. audioOut[i][k] += audioOut[i+1][k] * (1.0f - balRangeR);
  1353. }
  1354. else
  1355. {
  1356. // right
  1357. audioOut[i][k] = audioOut[i][k] * balRangeR;
  1358. audioOut[i][k] += oldBufLeft[k] * balRangeL;
  1359. }
  1360. }
  1361. }
  1362. // Volume (and buffer copy)
  1363. if (doVolume)
  1364. {
  1365. for (uint32_t k=0; k < frames; ++k)
  1366. audioOut[i][k] *= pData->postProc.volume;
  1367. }
  1368. }
  1369. } // End of Post-processing
  1370. # ifndef BUILD_BRIDGE
  1371. // --------------------------------------------------------------------------------------------------------
  1372. // Save latency values for next callback
  1373. if (pData->latency.frames != 0 && pData->latency.buffers != nullptr)
  1374. {
  1375. const uint32_t latframes = pData->latency.frames;
  1376. if (latframes <= frames)
  1377. {
  1378. for (uint32_t i=0; i < pData->audioIn.count; ++i)
  1379. carla_copyFloats(pData->latency.buffers[i], audioIn[i]+(frames-latframes), latframes);
  1380. }
  1381. else
  1382. {
  1383. const uint32_t diff = latframes - frames;
  1384. for (uint32_t i=0, k; i<pData->audioIn.count; ++i)
  1385. {
  1386. // push back buffer by 'frames'
  1387. for (k=0; k < diff; ++k)
  1388. pData->latency.buffers[i][k] = pData->latency.buffers[i][k+frames];
  1389. // put current input at the end
  1390. for (uint32_t j=0; k < latframes; ++j, ++k)
  1391. pData->latency.buffers[i][k] = audioIn[i][j];
  1392. }
  1393. }
  1394. }
  1395. # endif
  1396. #endif // BUILD_BRIDGE_ALTERNATIVE_ARCH
  1397. // --------------------------------------------------------------------------------------------------------
  1398. pData->singleMutex.unlock();
  1399. return true;
  1400. }
  1401. void bufferSizeChanged(const uint32_t newBufferSize) override
  1402. {
  1403. fBufferSize = newBufferSize;
  1404. resizeAudioPool(newBufferSize);
  1405. {
  1406. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetBufferSize);
  1407. fShmRtClientControl.writeUInt(newBufferSize);
  1408. fShmRtClientControl.commitWrite();
  1409. }
  1410. //fProcWaitTime = newBufferSize*1000/pData->engine->getSampleRate();
  1411. fProcWaitTime = 1000;
  1412. waitForClient("buffersize", 1000);
  1413. }
  1414. void sampleRateChanged(const double newSampleRate) override
  1415. {
  1416. {
  1417. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetSampleRate);
  1418. fShmRtClientControl.writeDouble(newSampleRate);
  1419. fShmRtClientControl.commitWrite();
  1420. }
  1421. //fProcWaitTime = pData->engine->getBufferSize()*1000/newSampleRate;
  1422. fProcWaitTime = 1000;
  1423. waitForClient("samplerate", 1000);
  1424. }
  1425. void offlineModeChanged(const bool isOffline) override
  1426. {
  1427. {
  1428. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetOnline);
  1429. fShmRtClientControl.writeBool(isOffline);
  1430. fShmRtClientControl.commitWrite();
  1431. }
  1432. waitForClient("offline", 1000);
  1433. }
  1434. // -------------------------------------------------------------------
  1435. // Plugin buffers
  1436. void clearBuffers() noexcept override
  1437. {
  1438. if (fParams != nullptr)
  1439. {
  1440. delete[] fParams;
  1441. fParams = nullptr;
  1442. }
  1443. CarlaPlugin::clearBuffers();
  1444. }
  1445. // -------------------------------------------------------------------
  1446. // Post-poned UI Stuff
  1447. void uiParameterChange(const uint32_t index, const float value) noexcept override
  1448. {
  1449. CARLA_SAFE_ASSERT_RETURN(index < pData->param.count,);
  1450. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1451. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiParameterChange);
  1452. fShmNonRtClientControl.writeUInt(index);
  1453. fShmNonRtClientControl.writeFloat(value);
  1454. fShmNonRtClientControl.commitWrite();
  1455. }
  1456. void uiProgramChange(const uint32_t index) noexcept override
  1457. {
  1458. CARLA_SAFE_ASSERT_RETURN(index < pData->prog.count,);
  1459. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1460. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiProgramChange);
  1461. fShmNonRtClientControl.writeUInt(index);
  1462. fShmNonRtClientControl.commitWrite();
  1463. }
  1464. void uiMidiProgramChange(const uint32_t index) noexcept override
  1465. {
  1466. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count,);
  1467. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1468. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiMidiProgramChange);
  1469. fShmNonRtClientControl.writeUInt(index);
  1470. fShmNonRtClientControl.commitWrite();
  1471. }
  1472. void uiNoteOn(const uint8_t channel, const uint8_t note, const uint8_t velo) noexcept override
  1473. {
  1474. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1475. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1476. CARLA_SAFE_ASSERT_RETURN(velo > 0 && velo < MAX_MIDI_VALUE,);
  1477. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1478. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiNoteOn);
  1479. fShmNonRtClientControl.writeByte(channel);
  1480. fShmNonRtClientControl.writeByte(note);
  1481. fShmNonRtClientControl.writeByte(velo);
  1482. fShmNonRtClientControl.commitWrite();
  1483. }
  1484. void uiNoteOff(const uint8_t channel, const uint8_t note) noexcept override
  1485. {
  1486. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1487. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1488. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1489. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiNoteOff);
  1490. fShmNonRtClientControl.writeByte(channel);
  1491. fShmNonRtClientControl.writeByte(note);
  1492. fShmNonRtClientControl.commitWrite();
  1493. }
  1494. // -------------------------------------------------------------------
  1495. // Internal helper functions
  1496. void restoreLV2State() noexcept override
  1497. {
  1498. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1499. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientRestoreLV2State);
  1500. fShmNonRtClientControl.commitWrite();
  1501. }
  1502. void waitForBridgeSaveSignal() noexcept override
  1503. {
  1504. // VSTs only save chunks, for which we already have a waitForSaved there
  1505. if (fPluginType != PLUGIN_VST2)
  1506. waitForSaved();
  1507. }
  1508. // -------------------------------------------------------------------
  1509. void handleNonRtData()
  1510. {
  1511. for (; fShmNonRtServerControl.isDataAvailableForReading();)
  1512. {
  1513. const PluginBridgeNonRtServerOpcode opcode(fShmNonRtServerControl.readOpcode());
  1514. #ifdef DEBUG
  1515. if (opcode != kPluginBridgeNonRtServerPong && opcode != kPluginBridgeNonRtServerParameterValue2) {
  1516. carla_debug("CarlaPluginBridge::handleNonRtData() - got opcode: %s", PluginBridgeNonRtServerOpcode2str(opcode));
  1517. }
  1518. #endif
  1519. switch (opcode)
  1520. {
  1521. case kPluginBridgeNonRtServerNull:
  1522. case kPluginBridgeNonRtServerPong:
  1523. break;
  1524. case kPluginBridgeNonRtServerPluginInfo1: {
  1525. // uint/category, uint/hints, uint/optionsAvailable, uint/optionsEnabled, long/uniqueId
  1526. const uint32_t category = fShmNonRtServerControl.readUInt();
  1527. const uint32_t hints = fShmNonRtServerControl.readUInt();
  1528. const uint32_t optionAv = fShmNonRtServerControl.readUInt();
  1529. const uint32_t optionEn = fShmNonRtServerControl.readUInt();
  1530. const int64_t uniqueId = fShmNonRtServerControl.readLong();
  1531. if (fUniqueId != 0) {
  1532. CARLA_SAFE_ASSERT_INT2(fUniqueId == uniqueId, fUniqueId, uniqueId);
  1533. }
  1534. pData->hints = hints | PLUGIN_IS_BRIDGE;
  1535. pData->options = optionEn;
  1536. fInfo.category = static_cast<PluginCategory>(category);
  1537. fInfo.optionsAvailable = optionAv;
  1538. } break;
  1539. case kPluginBridgeNonRtServerPluginInfo2: {
  1540. // uint/size, str[] (realName), uint/size, str[] (label), uint/size, str[] (maker), uint/size, str[] (copyright)
  1541. // realName
  1542. const uint32_t realNameSize(fShmNonRtServerControl.readUInt());
  1543. char realName[realNameSize+1];
  1544. carla_zeroChars(realName, realNameSize+1);
  1545. fShmNonRtServerControl.readCustomData(realName, realNameSize);
  1546. // label
  1547. const uint32_t labelSize(fShmNonRtServerControl.readUInt());
  1548. char label[labelSize+1];
  1549. carla_zeroChars(label, labelSize+1);
  1550. fShmNonRtServerControl.readCustomData(label, labelSize);
  1551. // maker
  1552. const uint32_t makerSize(fShmNonRtServerControl.readUInt());
  1553. char maker[makerSize+1];
  1554. carla_zeroChars(maker, makerSize+1);
  1555. fShmNonRtServerControl.readCustomData(maker, makerSize);
  1556. // copyright
  1557. const uint32_t copyrightSize(fShmNonRtServerControl.readUInt());
  1558. char copyright[copyrightSize+1];
  1559. carla_zeroChars(copyright, copyrightSize+1);
  1560. fShmNonRtServerControl.readCustomData(copyright, copyrightSize);
  1561. fInfo.name = realName;
  1562. fInfo.label = label;
  1563. fInfo.maker = maker;
  1564. fInfo.copyright = copyright;
  1565. if (pData->name == nullptr)
  1566. pData->name = pData->engine->getUniquePluginName(realName);
  1567. } break;
  1568. case kPluginBridgeNonRtServerAudioCount: {
  1569. // uint/ins, uint/outs
  1570. fInfo.clear();
  1571. fInfo.aIns = fShmNonRtServerControl.readUInt();
  1572. fInfo.aOuts = fShmNonRtServerControl.readUInt();
  1573. if (fInfo.aIns > 0)
  1574. {
  1575. fInfo.aInNames = new const char*[fInfo.aIns];
  1576. carla_zeroPointers(fInfo.aInNames, fInfo.aIns);
  1577. }
  1578. if (fInfo.aOuts > 0)
  1579. {
  1580. fInfo.aOutNames = new const char*[fInfo.aOuts];
  1581. carla_zeroPointers(fInfo.aOutNames, fInfo.aOuts);
  1582. }
  1583. } break;
  1584. case kPluginBridgeNonRtServerMidiCount: {
  1585. // uint/ins, uint/outs
  1586. fInfo.mIns = fShmNonRtServerControl.readUInt();
  1587. fInfo.mOuts = fShmNonRtServerControl.readUInt();
  1588. } break;
  1589. case kPluginBridgeNonRtServerCvCount: {
  1590. // uint/ins, uint/outs
  1591. fInfo.cvIns = fShmNonRtServerControl.readUInt();
  1592. fInfo.cvOuts = fShmNonRtServerControl.readUInt();
  1593. } break;
  1594. case kPluginBridgeNonRtServerParameterCount: {
  1595. // uint/count
  1596. const uint32_t count = fShmNonRtServerControl.readUInt();
  1597. // delete old data
  1598. pData->param.clear();
  1599. if (fParams != nullptr)
  1600. {
  1601. delete[] fParams;
  1602. fParams = nullptr;
  1603. }
  1604. if (count > 0)
  1605. {
  1606. pData->param.createNew(count, false);
  1607. fParams = new BridgeParamInfo[count];
  1608. // we might not receive all parameter data, so ensure range max is not 0
  1609. for (uint32_t i=0; i<count; ++i)
  1610. {
  1611. pData->param.ranges[i].def = 0.0f;
  1612. pData->param.ranges[i].min = 0.0f;
  1613. pData->param.ranges[i].max = 1.0f;
  1614. pData->param.ranges[i].step = 0.001f;
  1615. pData->param.ranges[i].stepSmall = 0.0001f;
  1616. pData->param.ranges[i].stepLarge = 0.1f;
  1617. }
  1618. }
  1619. } break;
  1620. case kPluginBridgeNonRtServerProgramCount: {
  1621. // uint/count
  1622. pData->prog.clear();
  1623. if (const uint32_t count = fShmNonRtServerControl.readUInt())
  1624. pData->prog.createNew(static_cast<uint32_t>(count));
  1625. } break;
  1626. case kPluginBridgeNonRtServerMidiProgramCount: {
  1627. // uint/count
  1628. pData->midiprog.clear();
  1629. if (const uint32_t count = fShmNonRtServerControl.readUInt())
  1630. pData->midiprog.createNew(static_cast<uint32_t>(count));
  1631. } break;
  1632. case kPluginBridgeNonRtServerPortName: {
  1633. // byte/type, uint/index, uint/size, str[] (name)
  1634. const uint8_t portType = fShmNonRtServerControl.readByte();
  1635. const uint32_t index = fShmNonRtServerControl.readUInt();
  1636. // name
  1637. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1638. char* const name = new char[nameSize+1];
  1639. carla_zeroChars(name, nameSize+1);
  1640. fShmNonRtServerControl.readCustomData(name, nameSize);
  1641. CARLA_SAFE_ASSERT_BREAK(portType > kPluginBridgePortNull && portType < kPluginBridgePortTypeCount);
  1642. switch (portType)
  1643. {
  1644. case kPluginBridgePortAudioInput:
  1645. CARLA_SAFE_ASSERT_BREAK(index < fInfo.aIns);
  1646. fInfo.aInNames[index] = name;
  1647. break;
  1648. case kPluginBridgePortAudioOutput:
  1649. CARLA_SAFE_ASSERT_BREAK(index < fInfo.aOuts);
  1650. fInfo.aOutNames[index] = name;
  1651. break;
  1652. }
  1653. } break;
  1654. case kPluginBridgeNonRtServerParameterData1: {
  1655. // uint/index, int/rindex, uint/type, uint/hints, int/cc
  1656. const uint32_t index = fShmNonRtServerControl.readUInt();
  1657. const int32_t rindex = fShmNonRtServerControl.readInt();
  1658. const uint32_t type = fShmNonRtServerControl.readUInt();
  1659. const uint32_t hints = fShmNonRtServerControl.readUInt();
  1660. const int16_t midiCC = fShmNonRtServerControl.readShort();
  1661. CARLA_SAFE_ASSERT_BREAK(midiCC >= -1 && midiCC < MAX_MIDI_CONTROL);
  1662. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1663. if (index < pData->param.count)
  1664. {
  1665. pData->param.data[index].type = static_cast<ParameterType>(type);
  1666. pData->param.data[index].index = static_cast<int32_t>(index);
  1667. pData->param.data[index].rindex = rindex;
  1668. pData->param.data[index].hints = hints;
  1669. pData->param.data[index].midiCC = midiCC;
  1670. }
  1671. } break;
  1672. case kPluginBridgeNonRtServerParameterData2: {
  1673. // uint/index, uint/size, str[] (name), uint/size, str[] (unit)
  1674. const uint32_t index = fShmNonRtServerControl.readUInt();
  1675. // name
  1676. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1677. char name[nameSize+1];
  1678. carla_zeroChars(name, nameSize+1);
  1679. fShmNonRtServerControl.readCustomData(name, nameSize);
  1680. // symbol
  1681. const uint32_t symbolSize(fShmNonRtServerControl.readUInt());
  1682. char symbol[symbolSize+1];
  1683. carla_zeroChars(symbol, symbolSize+1);
  1684. fShmNonRtServerControl.readCustomData(symbol, symbolSize);
  1685. // unit
  1686. const uint32_t unitSize(fShmNonRtServerControl.readUInt());
  1687. char unit[unitSize+1];
  1688. carla_zeroChars(unit, unitSize+1);
  1689. fShmNonRtServerControl.readCustomData(unit, unitSize);
  1690. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1691. if (index < pData->param.count)
  1692. {
  1693. fParams[index].name = name;
  1694. fParams[index].symbol = symbol;
  1695. fParams[index].unit = unit;
  1696. }
  1697. } break;
  1698. case kPluginBridgeNonRtServerParameterRanges: {
  1699. // uint/index, float/def, float/min, float/max, float/step, float/stepSmall, float/stepLarge
  1700. const uint32_t index = fShmNonRtServerControl.readUInt();
  1701. const float def = fShmNonRtServerControl.readFloat();
  1702. const float min = fShmNonRtServerControl.readFloat();
  1703. const float max = fShmNonRtServerControl.readFloat();
  1704. const float step = fShmNonRtServerControl.readFloat();
  1705. const float stepSmall = fShmNonRtServerControl.readFloat();
  1706. const float stepLarge = fShmNonRtServerControl.readFloat();
  1707. CARLA_SAFE_ASSERT_BREAK(min < max);
  1708. CARLA_SAFE_ASSERT_BREAK(def >= min);
  1709. CARLA_SAFE_ASSERT_BREAK(def <= max);
  1710. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1711. if (index < pData->param.count)
  1712. {
  1713. pData->param.ranges[index].def = def;
  1714. pData->param.ranges[index].min = min;
  1715. pData->param.ranges[index].max = max;
  1716. pData->param.ranges[index].step = step;
  1717. pData->param.ranges[index].stepSmall = stepSmall;
  1718. pData->param.ranges[index].stepLarge = stepLarge;
  1719. }
  1720. } break;
  1721. case kPluginBridgeNonRtServerParameterValue: {
  1722. // uint/index, float/value
  1723. const uint32_t index = fShmNonRtServerControl.readUInt();
  1724. const float value = fShmNonRtServerControl.readFloat();
  1725. if (index < pData->param.count)
  1726. {
  1727. const float fixedValue(pData->param.getFixedValue(index, value));
  1728. if (carla_isNotEqual(fParams[index].value, fixedValue))
  1729. {
  1730. fParams[index].value = fixedValue;
  1731. CarlaPlugin::setParameterValue(index, fixedValue, false, true, true);
  1732. }
  1733. }
  1734. } break;
  1735. case kPluginBridgeNonRtServerParameterValue2: {
  1736. // uint/index, float/value
  1737. const uint32_t index = fShmNonRtServerControl.readUInt();
  1738. const float value = fShmNonRtServerControl.readFloat();
  1739. if (index < pData->param.count)
  1740. {
  1741. const float fixedValue(pData->param.getFixedValue(index, value));
  1742. fParams[index].value = fixedValue;
  1743. }
  1744. } break;
  1745. case kPluginBridgeNonRtServerParameterTouch: {
  1746. // uint/index, bool/touch
  1747. const uint32_t index = fShmNonRtServerControl.readUInt();
  1748. const bool touch = fShmNonRtServerControl.readBool();
  1749. pData->engine->touchPluginParameter(pData->id, index, touch);
  1750. } break;
  1751. case kPluginBridgeNonRtServerDefaultValue: {
  1752. // uint/index, float/value
  1753. const uint32_t index = fShmNonRtServerControl.readUInt();
  1754. const float value = fShmNonRtServerControl.readFloat();
  1755. if (index < pData->param.count)
  1756. pData->param.ranges[index].def = value;
  1757. } break;
  1758. case kPluginBridgeNonRtServerCurrentProgram: {
  1759. // int/index
  1760. const int32_t index = fShmNonRtServerControl.readInt();
  1761. CARLA_SAFE_ASSERT_BREAK(index >= -1);
  1762. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->prog.count), index, pData->prog.count);
  1763. CarlaPlugin::setProgram(index, false, true, true);
  1764. } break;
  1765. case kPluginBridgeNonRtServerCurrentMidiProgram: {
  1766. // int/index
  1767. const int32_t index = fShmNonRtServerControl.readInt();
  1768. CARLA_SAFE_ASSERT_BREAK(index >= -1);
  1769. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->midiprog.count), index, pData->midiprog.count);
  1770. CarlaPlugin::setMidiProgram(index, false, true, true);
  1771. } break;
  1772. case kPluginBridgeNonRtServerProgramName: {
  1773. // uint/index, uint/size, str[] (name)
  1774. const uint32_t index = fShmNonRtServerControl.readUInt();
  1775. // name
  1776. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1777. char name[nameSize+1];
  1778. carla_zeroChars(name, nameSize+1);
  1779. fShmNonRtServerControl.readCustomData(name, nameSize);
  1780. CARLA_SAFE_ASSERT_INT2(index < pData->prog.count, index, pData->prog.count);
  1781. if (index < pData->prog.count)
  1782. {
  1783. if (pData->prog.names[index] != nullptr)
  1784. delete[] pData->prog.names[index];
  1785. pData->prog.names[index] = carla_strdup(name);
  1786. }
  1787. } break;
  1788. case kPluginBridgeNonRtServerMidiProgramData: {
  1789. // uint/index, uint/bank, uint/program, uint/size, str[] (name)
  1790. const uint32_t index = fShmNonRtServerControl.readUInt();
  1791. const uint32_t bank = fShmNonRtServerControl.readUInt();
  1792. const uint32_t program = fShmNonRtServerControl.readUInt();
  1793. // name
  1794. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1795. char name[nameSize+1];
  1796. carla_zeroChars(name, nameSize+1);
  1797. fShmNonRtServerControl.readCustomData(name, nameSize);
  1798. CARLA_SAFE_ASSERT_INT2(index < pData->midiprog.count, index, pData->midiprog.count);
  1799. if (index < pData->midiprog.count)
  1800. {
  1801. if (pData->midiprog.data[index].name != nullptr)
  1802. delete[] pData->midiprog.data[index].name;
  1803. pData->midiprog.data[index].bank = bank;
  1804. pData->midiprog.data[index].program = program;
  1805. pData->midiprog.data[index].name = carla_strdup(name);
  1806. }
  1807. } break;
  1808. case kPluginBridgeNonRtServerSetCustomData: {
  1809. // uint/size, str[], uint/size, str[], uint/size, str[]
  1810. // type
  1811. const uint32_t typeSize(fShmNonRtServerControl.readUInt());
  1812. char type[typeSize+1];
  1813. carla_zeroChars(type, typeSize+1);
  1814. fShmNonRtServerControl.readCustomData(type, typeSize);
  1815. // key
  1816. const uint32_t keySize(fShmNonRtServerControl.readUInt());
  1817. char key[keySize+1];
  1818. carla_zeroChars(key, keySize+1);
  1819. fShmNonRtServerControl.readCustomData(key, keySize);
  1820. // value
  1821. const uint32_t valueSize(fShmNonRtServerControl.readUInt());
  1822. char value[valueSize+1];
  1823. carla_zeroChars(value, valueSize+1);
  1824. if (valueSize > 0)
  1825. fShmNonRtServerControl.readCustomData(value, valueSize);
  1826. CarlaPlugin::setCustomData(type, key, value, false);
  1827. } break;
  1828. case kPluginBridgeNonRtServerSetChunkDataFile: {
  1829. // uint/size, str[] (filename)
  1830. // chunkFilePath
  1831. const uint32_t chunkFilePathSize(fShmNonRtServerControl.readUInt());
  1832. char chunkFilePath[chunkFilePathSize+1];
  1833. carla_zeroChars(chunkFilePath, chunkFilePathSize+1);
  1834. fShmNonRtServerControl.readCustomData(chunkFilePath, chunkFilePathSize);
  1835. String realChunkFilePath(chunkFilePath);
  1836. #ifndef CARLA_OS_WIN
  1837. // Using Wine, fix temp dir
  1838. if (fBinaryType == BINARY_WIN32 || fBinaryType == BINARY_WIN64)
  1839. {
  1840. const StringArray driveLetterSplit(StringArray::fromTokens(realChunkFilePath, ":/", ""));
  1841. carla_stdout("chunk save path BEFORE => %s", realChunkFilePath.toRawUTF8());
  1842. realChunkFilePath = fWinePrefix;
  1843. realChunkFilePath += "/drive_";
  1844. realChunkFilePath += driveLetterSplit[0].toLowerCase();
  1845. realChunkFilePath += driveLetterSplit[1];
  1846. realChunkFilePath = realChunkFilePath.replace("\\", "/");
  1847. carla_stdout("chunk save path AFTER => %s", realChunkFilePath.toRawUTF8());
  1848. }
  1849. #endif
  1850. File chunkFile(realChunkFilePath);
  1851. CARLA_SAFE_ASSERT_BREAK(chunkFile.existsAsFile());
  1852. fInfo.chunk = carla_getChunkFromBase64String(chunkFile.loadFileAsString().toRawUTF8());
  1853. chunkFile.deleteFile();
  1854. } break;
  1855. case kPluginBridgeNonRtServerSetLatency:
  1856. // uint
  1857. fLatency = fShmNonRtServerControl.readUInt();
  1858. #ifndef BUILD_BRIDGE
  1859. if (! fInitiated)
  1860. pData->latency.recreateBuffers(std::max(fInfo.aIns, fInfo.aOuts), fLatency);
  1861. #endif
  1862. break;
  1863. case kPluginBridgeNonRtServerSetParameterText: {
  1864. const int32_t index = fShmNonRtServerControl.readInt();
  1865. const uint32_t textSize(fShmNonRtServerControl.readUInt());
  1866. char text[textSize+1];
  1867. carla_zeroChars(text, textSize+1);
  1868. fShmNonRtServerControl.readCustomData(text, textSize);
  1869. fReceivingParamText.setReceivedData(index, text, textSize);
  1870. } break;
  1871. case kPluginBridgeNonRtServerReady:
  1872. fInitiated = true;
  1873. break;
  1874. case kPluginBridgeNonRtServerSaved:
  1875. fSaved = true;
  1876. break;
  1877. case kPluginBridgeNonRtServerUiClosed:
  1878. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1879. pData->transientTryCounter = 0;
  1880. #endif
  1881. pData->engine->callback(true, true, ENGINE_CALLBACK_UI_STATE_CHANGED, pData->id, 0, 0, 0, 0.0f, nullptr);
  1882. break;
  1883. case kPluginBridgeNonRtServerError: {
  1884. // error
  1885. const uint32_t errorSize(fShmNonRtServerControl.readUInt());
  1886. char error[errorSize+1];
  1887. carla_zeroChars(error, errorSize+1);
  1888. fShmNonRtServerControl.readCustomData(error, errorSize);
  1889. if (fInitiated)
  1890. {
  1891. pData->engine->callback(true, true, ENGINE_CALLBACK_ERROR, pData->id, 0, 0, 0, 0.0f, error);
  1892. // just in case
  1893. pData->engine->setLastError(error);
  1894. fInitError = true;
  1895. }
  1896. else
  1897. {
  1898. pData->engine->setLastError(error);
  1899. fInitError = true;
  1900. fInitiated = true;
  1901. }
  1902. } break;
  1903. }
  1904. }
  1905. }
  1906. // -------------------------------------------------------------------
  1907. uintptr_t getUiBridgeProcessId() const noexcept override
  1908. {
  1909. return fBridgeThread.getProcessPID();
  1910. }
  1911. const void* getExtraStuff() const noexcept override
  1912. {
  1913. return fBridgeBinary.isNotEmpty() ? fBridgeBinary.buffer() : nullptr;
  1914. }
  1915. // -------------------------------------------------------------------
  1916. bool init(const char* const filename,
  1917. const char* const name,
  1918. const char* const label,
  1919. const int64_t uniqueId,
  1920. const uint options,
  1921. const char* const bridgeBinary)
  1922. {
  1923. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr, false);
  1924. // ---------------------------------------------------------------
  1925. // first checks
  1926. if (pData->client != nullptr)
  1927. {
  1928. pData->engine->setLastError("Plugin client is already registered");
  1929. return false;
  1930. }
  1931. if (bridgeBinary == nullptr || bridgeBinary[0] == '\0')
  1932. {
  1933. pData->engine->setLastError("null bridge binary");
  1934. return false;
  1935. }
  1936. // ---------------------------------------------------------------
  1937. // set info
  1938. if (name != nullptr && name[0] != '\0')
  1939. pData->name = pData->engine->getUniquePluginName(name);
  1940. if (filename != nullptr && filename[0] != '\0')
  1941. pData->filename = carla_strdup(filename);
  1942. else
  1943. pData->filename = carla_strdup("");
  1944. fUniqueId = uniqueId;
  1945. fBridgeBinary = bridgeBinary;
  1946. std::srand(static_cast<uint>(std::time(nullptr)));
  1947. // ---------------------------------------------------------------
  1948. // init sem/shm
  1949. if (! fShmAudioPool.initializeServer())
  1950. {
  1951. carla_stderr("Failed to initialize shared memory audio pool");
  1952. return false;
  1953. }
  1954. if (! fShmRtClientControl.initializeServer())
  1955. {
  1956. carla_stderr("Failed to initialize RT client control");
  1957. fShmAudioPool.clear();
  1958. return false;
  1959. }
  1960. if (! fShmNonRtClientControl.initializeServer())
  1961. {
  1962. carla_stderr("Failed to initialize Non-RT client control");
  1963. fShmRtClientControl.clear();
  1964. fShmAudioPool.clear();
  1965. return false;
  1966. }
  1967. if (! fShmNonRtServerControl.initializeServer())
  1968. {
  1969. carla_stderr("Failed to initialize Non-RT server control");
  1970. fShmNonRtClientControl.clear();
  1971. fShmRtClientControl.clear();
  1972. fShmAudioPool.clear();
  1973. return false;
  1974. }
  1975. #ifndef CARLA_OS_WIN
  1976. // ---------------------------------------------------------------
  1977. // set wine prefix
  1978. if (fBridgeBinary.contains(".exe", true))
  1979. {
  1980. const EngineOptions& engineOptions(pData->engine->getOptions());
  1981. if (engineOptions.wine.autoPrefix)
  1982. fWinePrefix = findWinePrefix(pData->filename);
  1983. if (fWinePrefix.isEmpty())
  1984. {
  1985. const char* const envWinePrefix(std::getenv("WINEPREFIX"));
  1986. if (envWinePrefix != nullptr && envWinePrefix[0] != '\0')
  1987. fWinePrefix = envWinePrefix;
  1988. else if (engineOptions.wine.fallbackPrefix != nullptr && engineOptions.wine.fallbackPrefix[0] != '\0')
  1989. fWinePrefix = engineOptions.wine.fallbackPrefix;
  1990. else
  1991. fWinePrefix = File::getSpecialLocation(File::userHomeDirectory).getFullPathName() + "/.wine";
  1992. }
  1993. }
  1994. #endif
  1995. // ---------------------------------------------------------------
  1996. // init bridge thread
  1997. {
  1998. char shmIdsStr[6*4+1];
  1999. carla_zeroChars(shmIdsStr, 6*4+1);
  2000. std::strncpy(shmIdsStr+6*0, &fShmAudioPool.filename[fShmAudioPool.filename.length()-6], 6);
  2001. std::strncpy(shmIdsStr+6*1, &fShmRtClientControl.filename[fShmRtClientControl.filename.length()-6], 6);
  2002. std::strncpy(shmIdsStr+6*2, &fShmNonRtClientControl.filename[fShmNonRtClientControl.filename.length()-6], 6);
  2003. std::strncpy(shmIdsStr+6*3, &fShmNonRtServerControl.filename[fShmNonRtServerControl.filename.length()-6], 6);
  2004. fBridgeThread.setData(
  2005. #ifndef CARLA_OS_WIN
  2006. fWinePrefix.toRawUTF8(),
  2007. #endif
  2008. bridgeBinary, label, shmIdsStr);
  2009. }
  2010. if (! restartBridgeThread())
  2011. return false;
  2012. // ---------------------------------------------------------------
  2013. // register client
  2014. if (pData->name == nullptr)
  2015. {
  2016. if (label != nullptr && label[0] != '\0')
  2017. pData->name = pData->engine->getUniquePluginName(label);
  2018. else
  2019. pData->name = pData->engine->getUniquePluginName("unknown");
  2020. }
  2021. pData->client = pData->engine->addClient(this);
  2022. if (pData->client == nullptr || ! pData->client->isOk())
  2023. {
  2024. pData->engine->setLastError("Failed to register plugin client");
  2025. return false;
  2026. }
  2027. // ---------------------------------------------------------------
  2028. // set options
  2029. pData->options = 0x0;
  2030. if ((fInfo.optionsAvailable & PLUGIN_OPTION_FIXED_BUFFERS) == 0x0)
  2031. pData->options |= PLUGIN_OPTION_FIXED_BUFFERS;
  2032. else if (options & PLUGIN_OPTION_FIXED_BUFFERS)
  2033. pData->options |= PLUGIN_OPTION_FIXED_BUFFERS;
  2034. if (pData->engine->getOptions().forceStereo)
  2035. {
  2036. pData->options |= PLUGIN_OPTION_FORCE_STEREO;
  2037. }
  2038. else if (fInfo.optionsAvailable & PLUGIN_OPTION_FORCE_STEREO)
  2039. {
  2040. if (options & PLUGIN_OPTION_FORCE_STEREO)
  2041. pData->options |= PLUGIN_OPTION_FORCE_STEREO;
  2042. }
  2043. if (fInfo.optionsAvailable & PLUGIN_OPTION_SEND_CONTROL_CHANGES)
  2044. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_CONTROL_CHANGES))
  2045. pData->options |= PLUGIN_OPTION_SEND_CONTROL_CHANGES;
  2046. if (fInfo.optionsAvailable & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE)
  2047. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_CHANNEL_PRESSURE))
  2048. pData->options |= PLUGIN_OPTION_SEND_CHANNEL_PRESSURE;
  2049. if (fInfo.optionsAvailable & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH)
  2050. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH))
  2051. pData->options |= PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH;
  2052. if (fInfo.optionsAvailable & PLUGIN_OPTION_SEND_PITCHBEND)
  2053. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_PITCHBEND))
  2054. pData->options |= PLUGIN_OPTION_SEND_PITCHBEND;
  2055. if (fInfo.optionsAvailable & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  2056. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_ALL_SOUND_OFF))
  2057. pData->options |= PLUGIN_OPTION_SEND_ALL_SOUND_OFF;
  2058. if (fInfo.optionsAvailable & PLUGIN_OPTION_SEND_PROGRAM_CHANGES)
  2059. {
  2060. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_PROGRAM_CHANGES))
  2061. pData->options |= PLUGIN_OPTION_SEND_PROGRAM_CHANGES;
  2062. }
  2063. else if (fInfo.optionsAvailable & PLUGIN_OPTION_MAP_PROGRAM_CHANGES)
  2064. {
  2065. if (isPluginOptionEnabled(options, PLUGIN_OPTION_MAP_PROGRAM_CHANGES))
  2066. pData->options |= PLUGIN_OPTION_MAP_PROGRAM_CHANGES;
  2067. }
  2068. return true;
  2069. }
  2070. private:
  2071. const BinaryType fBinaryType;
  2072. const PluginType fPluginType;
  2073. bool fInitiated;
  2074. bool fInitError;
  2075. bool fSaved;
  2076. bool fTimedOut;
  2077. bool fTimedError;
  2078. uint fBufferSize;
  2079. uint fProcWaitTime;
  2080. CarlaString fBridgeBinary;
  2081. CarlaPluginBridgeThread fBridgeThread;
  2082. BridgeAudioPool fShmAudioPool;
  2083. BridgeRtClientControl fShmRtClientControl;
  2084. BridgeNonRtClientControl fShmNonRtClientControl;
  2085. BridgeNonRtServerControl fShmNonRtServerControl;
  2086. #ifndef CARLA_OS_WIN
  2087. String fWinePrefix;
  2088. #endif
  2089. class ReceivingParamText {
  2090. public:
  2091. ReceivingParamText() noexcept
  2092. : dataRecv(false),
  2093. dataOk(false),
  2094. index(-1),
  2095. strBuf(nullptr),
  2096. mutex() {}
  2097. bool isCurrentlyWaitingData() const noexcept
  2098. {
  2099. return index >= 0;
  2100. }
  2101. bool wasDataReceived(bool* const success) const noexcept
  2102. {
  2103. *success = dataOk;
  2104. return dataRecv;
  2105. }
  2106. void setTargetData(const int32_t i, char* const b) noexcept
  2107. {
  2108. const CarlaMutexLocker cml(mutex);
  2109. dataOk = false;
  2110. dataRecv = false;
  2111. index = i;
  2112. strBuf = b;
  2113. }
  2114. void setReceivedData(const int32_t i, const char* const b, const uint blen) noexcept
  2115. {
  2116. CarlaScopedValueSetter<bool> svs(dataRecv, false, true);
  2117. const CarlaMutexLocker cml(mutex);
  2118. // make backup and reset data
  2119. const int32_t indexCopy = index;
  2120. char* const strBufCopy = strBuf;
  2121. index = -1;
  2122. strBuf = nullptr;
  2123. CARLA_SAFE_ASSERT_RETURN(indexCopy == i,);
  2124. CARLA_SAFE_ASSERT_RETURN(strBufCopy != nullptr,);
  2125. std::strncpy(strBufCopy, b, std::min(blen, STR_MAX-1U));
  2126. dataOk = true;
  2127. }
  2128. private:
  2129. bool dataRecv;
  2130. bool dataOk;
  2131. int32_t index;
  2132. char* strBuf;
  2133. CarlaMutex mutex;
  2134. CARLA_DECLARE_NON_COPY_CLASS(ReceivingParamText)
  2135. } fReceivingParamText;
  2136. struct Info {
  2137. uint32_t aIns, aOuts;
  2138. uint32_t cvIns, cvOuts;
  2139. uint32_t mIns, mOuts;
  2140. PluginCategory category;
  2141. uint optionsAvailable;
  2142. CarlaString name;
  2143. CarlaString label;
  2144. CarlaString maker;
  2145. CarlaString copyright;
  2146. const char** aInNames;
  2147. const char** aOutNames;
  2148. const char** cvInNames;
  2149. const char** cvOutNames;
  2150. std::vector<uint8_t> chunk;
  2151. Info()
  2152. : aIns(0),
  2153. aOuts(0),
  2154. cvIns(0),
  2155. cvOuts(0),
  2156. mIns(0),
  2157. mOuts(0),
  2158. category(PLUGIN_CATEGORY_NONE),
  2159. optionsAvailable(0),
  2160. name(),
  2161. label(),
  2162. maker(),
  2163. copyright(),
  2164. aInNames(nullptr),
  2165. aOutNames(nullptr),
  2166. cvInNames(nullptr),
  2167. cvOutNames(nullptr),
  2168. chunk() {}
  2169. ~Info()
  2170. {
  2171. clear();
  2172. }
  2173. void clear()
  2174. {
  2175. if (aInNames != nullptr)
  2176. {
  2177. CARLA_SAFE_ASSERT_INT(aIns > 0, aIns);
  2178. for (uint32_t i=0; i<aIns; ++i)
  2179. delete[] aInNames[i];
  2180. delete[] aInNames;
  2181. aInNames = nullptr;
  2182. }
  2183. if (aOutNames != nullptr)
  2184. {
  2185. CARLA_SAFE_ASSERT_INT(aOuts > 0, aOuts);
  2186. for (uint32_t i=0; i<aOuts; ++i)
  2187. delete[] aOutNames[i];
  2188. delete[] aOutNames;
  2189. aOutNames = nullptr;
  2190. }
  2191. if (cvInNames != nullptr)
  2192. {
  2193. CARLA_SAFE_ASSERT_INT(cvIns > 0, cvIns);
  2194. for (uint32_t i=0; i<cvIns; ++i)
  2195. delete[] cvInNames[i];
  2196. delete[] cvInNames;
  2197. cvInNames = nullptr;
  2198. }
  2199. if (cvOutNames != nullptr)
  2200. {
  2201. CARLA_SAFE_ASSERT_INT(cvOuts > 0, cvOuts);
  2202. for (uint32_t i=0; i<cvOuts; ++i)
  2203. delete[] cvOutNames[i];
  2204. delete[] cvOutNames;
  2205. cvOutNames = nullptr;
  2206. }
  2207. aIns = aOuts = cvIns = cvOuts = 0;
  2208. }
  2209. CARLA_DECLARE_NON_COPY_STRUCT(Info)
  2210. } fInfo;
  2211. int64_t fUniqueId;
  2212. uint32_t fLatency;
  2213. BridgeParamInfo* fParams;
  2214. void handleProcessStopped() noexcept
  2215. {
  2216. const bool wasActive = pData->active;
  2217. pData->active = false;
  2218. if (wasActive)
  2219. {
  2220. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  2221. pData->engine->callback(true, true,
  2222. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  2223. pData->id,
  2224. PARAMETER_ACTIVE,
  2225. 0, 0,
  2226. 0.0f,
  2227. nullptr);
  2228. #endif
  2229. }
  2230. if (pData->hints & PLUGIN_HAS_CUSTOM_UI)
  2231. {
  2232. pData->engine->callback(true, true,
  2233. ENGINE_CALLBACK_UI_STATE_CHANGED,
  2234. pData->id,
  2235. 0,
  2236. 0, 0, 0.0f, nullptr);
  2237. }
  2238. }
  2239. void resizeAudioPool(const uint32_t bufferSize)
  2240. {
  2241. fShmAudioPool.resize(bufferSize, fInfo.aIns+fInfo.aOuts, fInfo.cvIns+fInfo.cvOuts);
  2242. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetAudioPool);
  2243. fShmRtClientControl.writeULong(static_cast<uint64_t>(fShmAudioPool.dataSize));
  2244. fShmRtClientControl.commitWrite();
  2245. waitForClient("resize-pool", 5000);
  2246. }
  2247. void waitForClient(const char* const action, const uint msecs)
  2248. {
  2249. CARLA_SAFE_ASSERT_RETURN(! fTimedOut,);
  2250. CARLA_SAFE_ASSERT_RETURN(! fTimedError,);
  2251. if (fShmRtClientControl.waitForClient(msecs))
  2252. return;
  2253. fTimedOut = true;
  2254. carla_stderr2("waitForClient(%s) timed out", action);
  2255. }
  2256. bool restartBridgeThread()
  2257. {
  2258. fInitiated = false;
  2259. fInitError = false;
  2260. fTimedError = false;
  2261. // reset memory
  2262. fShmRtClientControl.data->procFlags = 0;
  2263. carla_zeroStruct(fShmRtClientControl.data->timeInfo);
  2264. carla_zeroBytes(fShmRtClientControl.data->midiOut, kBridgeRtClientDataMidiOutSize);
  2265. fShmRtClientControl.clearData();
  2266. fShmNonRtClientControl.clearData();
  2267. fShmNonRtServerControl.clearData();
  2268. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientVersion);
  2269. fShmNonRtClientControl.writeUInt(CARLA_PLUGIN_BRIDGE_API_VERSION);
  2270. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeRtClientData)));
  2271. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeNonRtClientData)));
  2272. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeNonRtServerData)));
  2273. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientInitialSetup);
  2274. fShmNonRtClientControl.writeUInt(pData->engine->getBufferSize());
  2275. fShmNonRtClientControl.writeDouble(pData->engine->getSampleRate());
  2276. fShmNonRtClientControl.commitWrite();
  2277. if (fShmAudioPool.dataSize != 0)
  2278. {
  2279. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetAudioPool);
  2280. fShmRtClientControl.writeULong(static_cast<uint64_t>(fShmAudioPool.dataSize));
  2281. fShmRtClientControl.commitWrite();
  2282. }
  2283. else
  2284. {
  2285. // testing dummy message
  2286. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientNull);
  2287. fShmRtClientControl.commitWrite();
  2288. }
  2289. fBridgeThread.startThread();
  2290. const bool needsEngineIdle = pData->engine->getType() != kEngineTypePlugin;
  2291. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  2292. const bool needsCancelableAction = ! pData->engine->isLoadingProject();
  2293. if (needsCancelableAction)
  2294. {
  2295. pData->engine->setActionCanceled(false);
  2296. pData->engine->callback(true, true,
  2297. ENGINE_CALLBACK_CANCELABLE_ACTION,
  2298. pData->id,
  2299. 1,
  2300. 0, 0, 0.0f,
  2301. "Loading plugin bridge");
  2302. }
  2303. #endif
  2304. for (;fBridgeThread.isThreadRunning();)
  2305. {
  2306. pData->engine->callback(true, true, ENGINE_CALLBACK_IDLE, 0, 0, 0, 0, 0.0f, nullptr);
  2307. if (needsEngineIdle)
  2308. pData->engine->idle();
  2309. idle();
  2310. if (fInitiated)
  2311. break;
  2312. if (pData->engine->isAboutToClose() || pData->engine->wasActionCanceled())
  2313. break;
  2314. carla_msleep(5);
  2315. }
  2316. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  2317. if (needsCancelableAction)
  2318. {
  2319. pData->engine->callback(true, true,
  2320. ENGINE_CALLBACK_CANCELABLE_ACTION,
  2321. pData->id,
  2322. 0,
  2323. 0, 0, 0.0f,
  2324. "Loading JACK application");
  2325. }
  2326. #endif
  2327. if (fInitError || ! fInitiated)
  2328. {
  2329. fBridgeThread.stopThread(6000);
  2330. if (! fInitError)
  2331. pData->engine->setLastError("Timeout while waiting for a response from plugin-bridge\n"
  2332. "(or the plugin crashed on initialization?)");
  2333. return false;
  2334. }
  2335. if (const size_t dataSize = fInfo.chunk.size())
  2336. {
  2337. #ifdef CARLA_PROPER_CPP11_SUPPORT
  2338. void* data = fInfo.chunk.data();
  2339. #else
  2340. void* data = &fInfo.chunk.front();
  2341. #endif
  2342. CarlaString dataBase64(CarlaString::asBase64(data, dataSize));
  2343. CARLA_SAFE_ASSERT_RETURN(dataBase64.length() > 0, true);
  2344. String filePath(File::getSpecialLocation(File::tempDirectory).getFullPathName());
  2345. filePath += CARLA_OS_SEP_STR ".CarlaChunk_";
  2346. filePath += fShmAudioPool.getFilenameSuffix();
  2347. if (File(filePath).replaceWithText(dataBase64.buffer()))
  2348. {
  2349. const uint32_t ulength(static_cast<uint32_t>(filePath.length()));
  2350. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  2351. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetChunkDataFile);
  2352. fShmNonRtClientControl.writeUInt(ulength);
  2353. fShmNonRtClientControl.writeCustomData(filePath.toRawUTF8(), ulength);
  2354. fShmNonRtClientControl.commitWrite();
  2355. }
  2356. }
  2357. return true;
  2358. }
  2359. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaPluginBridge)
  2360. };
  2361. CARLA_BACKEND_END_NAMESPACE
  2362. // ---------------------------------------------------------------------------------------------------------------------
  2363. CARLA_BACKEND_START_NAMESPACE
  2364. CarlaPlugin* CarlaPlugin::newBridge(const Initializer& init, BinaryType btype, PluginType ptype, const char* bridgeBinary)
  2365. {
  2366. carla_debug("CarlaPlugin::newBridge({%p, \"%s\", \"%s\", \"%s\"}, %s, %s, \"%s\")", init.engine, init.filename, init.name, init.label, BinaryType2Str(btype), PluginType2Str(ptype), bridgeBinary);
  2367. if (bridgeBinary == nullptr || bridgeBinary[0] == '\0')
  2368. {
  2369. init.engine->setLastError("Bridge not possible, bridge-binary not found");
  2370. return nullptr;
  2371. }
  2372. #ifndef CARLA_OS_WIN
  2373. // FIXME: somewhere, somehow, we end up with double slashes, wine doesn't like that.
  2374. if (std::strncmp(bridgeBinary, "//", 2) == 0)
  2375. ++bridgeBinary;
  2376. #endif
  2377. CarlaPluginBridge* const plugin(new CarlaPluginBridge(init.engine, init.id, btype, ptype));
  2378. if (! plugin->init(init.filename, init.name, init.label, init.uniqueId, init.options, bridgeBinary))
  2379. {
  2380. delete plugin;
  2381. return nullptr;
  2382. }
  2383. return plugin;
  2384. }
  2385. CARLA_BACKEND_END_NAMESPACE
  2386. // ---------------------------------------------------------------------------------------------------------------------
  2387. #ifndef BUILD_BRIDGE
  2388. # include "CarlaBridgeUtils.cpp"
  2389. #endif
  2390. // ---------------------------------------------------------------------------------------------------------------------