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.

3200 lines
115KB

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