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.

3053 lines
108KB

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