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.

1705 lines
67KB

  1. // SPDX-FileCopyrightText: 2011-2025 Filipe Coelho <falktx@falktx.com>
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  3. #ifndef BUILD_BRIDGE
  4. # error This file should not be compiled if not building bridge
  5. #endif
  6. // must be first so we can undef CARLA_SAFE_*_RETURN_ERR* macros
  7. #include "CarlaPluginInternal.hpp"
  8. #undef CARLA_SAFE_ASSERT_RETURN_ERR
  9. #undef CARLA_SAFE_ASSERT_RETURN_ERRN
  10. #undef CARLA_SAFE_EXCEPTION_RETURN_ERR
  11. #undef CARLA_SAFE_EXCEPTION_RETURN_ERRN
  12. #include "CarlaEngineClient.hpp"
  13. #include "CarlaEngineInit.hpp"
  14. #include "CarlaBackendUtils.hpp"
  15. #include "CarlaBridgeUtils.hpp"
  16. #include "CarlaMIDI.h"
  17. #ifdef __SSE2_MATH__
  18. # include <xmmintrin.h>
  19. #endif
  20. #include "extra/Base64.hpp"
  21. #include "extra/Time.hpp"
  22. #include "water/files/File.h"
  23. #include "water/misc/Time.h"
  24. // must be last
  25. #include "jackbridge/JackBridge.hpp"
  26. using water::File;
  27. using water::MemoryBlock;
  28. CARLA_BACKEND_START_NAMESPACE
  29. // -----------------------------------------------------------------------
  30. // Bridge Engine client
  31. struct LatencyChangedCallback {
  32. virtual ~LatencyChangedCallback() noexcept {}
  33. virtual void latencyChanged(const uint32_t samples) noexcept = 0;
  34. };
  35. class CarlaEngineBridgeClient : public CarlaEngineClientForSubclassing
  36. {
  37. public:
  38. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  39. CarlaEngineBridgeClient(const CarlaEngine& engine,
  40. EngineInternalGraph& egraph,
  41. const CarlaPluginPtr plugin,
  42. LatencyChangedCallback* const cb)
  43. : CarlaEngineClientForSubclassing(engine, egraph, plugin),
  44. fLatencyCallback(cb) {}
  45. #else
  46. CarlaEngineBridgeClient(const CarlaEngine& engine, LatencyChangedCallback* const cb)
  47. : CarlaEngineClientForSubclassing(engine),
  48. fLatencyCallback(cb) {}
  49. #endif
  50. protected:
  51. void setLatency(const uint32_t samples) noexcept override
  52. {
  53. if (getLatency() == samples)
  54. return;
  55. fLatencyCallback->latencyChanged(samples);
  56. CarlaEngineClient::setLatency(samples);
  57. }
  58. private:
  59. LatencyChangedCallback* const fLatencyCallback;
  60. CARLA_DECLARE_NON_COPYABLE(CarlaEngineBridgeClient)
  61. };
  62. // -------------------------------------------------------------------
  63. struct BridgeTextReader {
  64. char* text;
  65. BridgeTextReader(BridgeNonRtClientControl& nonRtClientCtrl)
  66. : text(nullptr)
  67. {
  68. const uint32_t size = nonRtClientCtrl.readUInt();
  69. CARLA_SAFE_ASSERT_RETURN(size != 0,);
  70. text = new char[size + 1];
  71. nonRtClientCtrl.readCustomData(text, size);
  72. text[size] = '\0';
  73. }
  74. BridgeTextReader(BridgeNonRtClientControl& nonRtClientCtrl, const uint32_t size)
  75. : text(nullptr)
  76. {
  77. text = new char[size + 1];
  78. if (size != 0)
  79. nonRtClientCtrl.readCustomData(text, size);
  80. text[size] = '\0';
  81. }
  82. ~BridgeTextReader() noexcept
  83. {
  84. delete[] text;
  85. }
  86. CARLA_DECLARE_NON_COPYABLE(BridgeTextReader)
  87. };
  88. // -------------------------------------------------------------------
  89. class CarlaEngineBridge : public CarlaEngine,
  90. private CarlaThread,
  91. private LatencyChangedCallback
  92. {
  93. public:
  94. CarlaEngineBridge(const char* const audioPoolBaseName, const char* const rtClientBaseName, const char* const nonRtClientBaseName, const char* const nonRtServerBaseName)
  95. : CarlaEngine(),
  96. CarlaThread("CarlaEngineBridge"),
  97. fShmAudioPool(),
  98. fShmRtClientControl(),
  99. fShmNonRtClientControl(),
  100. fShmNonRtServerControl(),
  101. fBaseNameAudioPool(audioPoolBaseName),
  102. fBaseNameRtClientControl(rtClientBaseName),
  103. fBaseNameNonRtClientControl(nonRtClientBaseName),
  104. fBaseNameNonRtServerControl(nonRtServerBaseName),
  105. fClosingDown(false),
  106. fIsOffline(false),
  107. fFirstIdle(true),
  108. fBridgeVersion(0),
  109. fLastPingTime(UINT32_MAX)
  110. {
  111. carla_debug("CarlaEngineBridge::CarlaEngineBridge(\"%s\", \"%s\", \"%s\", \"%s\")", audioPoolBaseName, rtClientBaseName, nonRtClientBaseName, nonRtServerBaseName);
  112. }
  113. ~CarlaEngineBridge() noexcept override
  114. {
  115. carla_debug("CarlaEngineBridge::~CarlaEngineBridge()");
  116. clear();
  117. }
  118. // -------------------------------------
  119. // CarlaEngine virtual calls
  120. bool init(const char* const clientName) override
  121. {
  122. carla_debug("CarlaEngineBridge::init(\"%s\")", clientName);
  123. if (! pData->init(clientName))
  124. {
  125. setLastError("Failed to init internal data");
  126. return false;
  127. }
  128. if (! fShmAudioPool.attachClient(fBaseNameAudioPool))
  129. {
  130. pData->close();
  131. setLastError("Failed to attach to audio pool shared memory");
  132. return false;
  133. }
  134. if (! fShmRtClientControl.attachClient(fBaseNameRtClientControl))
  135. {
  136. pData->close();
  137. clear();
  138. setLastError("Failed to attach to rt client control shared memory");
  139. return false;
  140. }
  141. if (! fShmRtClientControl.mapData())
  142. {
  143. pData->close();
  144. clear();
  145. setLastError("Failed to map rt client control shared memory");
  146. return false;
  147. }
  148. if (! fShmNonRtClientControl.attachClient(fBaseNameNonRtClientControl))
  149. {
  150. pData->close();
  151. clear();
  152. setLastError("Failed to attach to non-rt client control shared memory");
  153. return false;
  154. }
  155. if (! fShmNonRtClientControl.mapData())
  156. {
  157. pData->close();
  158. clear();
  159. setLastError("Failed to map non-rt control client shared memory");
  160. return false;
  161. }
  162. if (! fShmNonRtServerControl.attachClient(fBaseNameNonRtServerControl))
  163. {
  164. pData->close();
  165. clear();
  166. setLastError("Failed to attach to non-rt server control shared memory");
  167. return false;
  168. }
  169. if (! fShmNonRtServerControl.mapData())
  170. {
  171. pData->close();
  172. clear();
  173. setLastError("Failed to map non-rt control server shared memory");
  174. return false;
  175. }
  176. PluginBridgeNonRtClientOpcode opcode;
  177. opcode = fShmNonRtClientControl.readOpcode();
  178. CARLA_SAFE_ASSERT_RETURN(opcode == kPluginBridgeNonRtClientVersion, false);
  179. const uint32_t apiVersion = fShmNonRtClientControl.readUInt();
  180. CARLA_SAFE_ASSERT_RETURN(apiVersion >= CARLA_PLUGIN_BRIDGE_API_VERSION_MINIMUM, false);
  181. const uint32_t shmRtClientDataSize = fShmNonRtClientControl.readUInt();
  182. CARLA_SAFE_ASSERT_INT2(shmRtClientDataSize == sizeof(BridgeRtClientData), shmRtClientDataSize, sizeof(BridgeRtClientData));
  183. const uint32_t shmNonRtClientDataSize = fShmNonRtClientControl.readUInt();
  184. CARLA_SAFE_ASSERT_INT2(shmNonRtClientDataSize == sizeof(BridgeNonRtClientData), shmNonRtClientDataSize, sizeof(BridgeNonRtClientData));
  185. const uint32_t shmNonRtServerDataSize = fShmNonRtClientControl.readUInt();
  186. CARLA_SAFE_ASSERT_INT2(shmNonRtServerDataSize == sizeof(BridgeNonRtServerData), shmNonRtServerDataSize, sizeof(BridgeNonRtServerData));
  187. if (shmRtClientDataSize != sizeof(BridgeRtClientData) ||
  188. shmNonRtClientDataSize != sizeof(BridgeNonRtClientData) ||
  189. shmNonRtServerDataSize != sizeof(BridgeNonRtServerData))
  190. {
  191. pData->close();
  192. clear();
  193. setLastError("Shared memory data size mismatch");
  194. return false;
  195. }
  196. opcode = fShmNonRtClientControl.readOpcode();
  197. CARLA_SAFE_ASSERT_RETURN(opcode == kPluginBridgeNonRtClientInitialSetup, false);
  198. pData->bufferSize = fShmNonRtClientControl.readUInt();
  199. pData->sampleRate = fShmNonRtClientControl.readDouble();
  200. if (pData->bufferSize == 0 || carla_isZero(pData->sampleRate))
  201. {
  202. pData->close();
  203. clear();
  204. setLastError("Shared memory has invalid data");
  205. return false;
  206. }
  207. pData->initTime(nullptr);
  208. // tell backend we're live
  209. {
  210. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  211. // kPluginBridgeNonRtServerVersion was added in API 7
  212. if (apiVersion >= 7)
  213. {
  214. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerVersion);
  215. fShmNonRtServerControl.writeUInt(CARLA_PLUGIN_BRIDGE_API_VERSION_CURRENT);
  216. }
  217. else
  218. {
  219. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPong);
  220. }
  221. fShmNonRtServerControl.commitWrite();
  222. }
  223. startThread(true);
  224. return true;
  225. }
  226. bool close() override
  227. {
  228. carla_debug("CarlaEngineBridge::close()");
  229. fLastPingTime = UINT32_MAX;
  230. CarlaEngine::close();
  231. stopThread(5000);
  232. clear();
  233. return true;
  234. }
  235. bool hasIdleOnMainThread() const noexcept override
  236. {
  237. return true;
  238. }
  239. bool isRunning() const noexcept override
  240. {
  241. if (fClosingDown)
  242. return false;
  243. return isThreadRunning() || ! fFirstIdle;
  244. }
  245. bool isOffline() const noexcept override
  246. {
  247. return fIsOffline;
  248. }
  249. EngineType getType() const noexcept override
  250. {
  251. return kEngineTypeBridge;
  252. }
  253. const char* getCurrentDriverName() const noexcept override
  254. {
  255. return "Bridge";
  256. }
  257. void touchPluginParameter(const uint id, const uint32_t parameterId, const bool touch) noexcept override
  258. {
  259. CARLA_SAFE_ASSERT_RETURN(id == 0,);
  260. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  261. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterTouch);
  262. fShmNonRtServerControl.writeUInt(parameterId);
  263. fShmNonRtServerControl.writeBool(touch);
  264. fShmNonRtServerControl.commitWrite();
  265. }
  266. CarlaEngineClient* addClient(const CarlaPluginPtr plugin) override
  267. {
  268. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  269. return new CarlaEngineBridgeClient(*this, pData->graph, plugin, this);
  270. #else
  271. return new CarlaEngineBridgeClient(*this, this);
  272. // unused
  273. (void)plugin;
  274. #endif
  275. }
  276. void idle() noexcept override
  277. {
  278. const CarlaPluginPtr plugin = pData->plugins[0].plugin;
  279. if (plugin.get() == nullptr)
  280. {
  281. if (const uint32_t length = static_cast<uint32_t>(pData->lastError.length()))
  282. {
  283. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  284. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerError);
  285. fShmNonRtServerControl.writeUInt(length);
  286. fShmNonRtServerControl.writeCustomData(pData->lastError.buffer(), length);
  287. fShmNonRtServerControl.commitWrite();
  288. }
  289. signalThreadShouldExit();
  290. callback(true, true, ENGINE_CALLBACK_QUIT, 0, 0, 0, 0, 0.0f, nullptr);
  291. return;
  292. }
  293. const bool wasFirstIdle = fFirstIdle;
  294. if (wasFirstIdle)
  295. {
  296. fFirstIdle = false;
  297. fLastPingTime = d_gettime_ms();
  298. char bufStr[STR_MAX+1];
  299. carla_zeroChars(bufStr, STR_MAX+1);
  300. uint32_t bufStrSize;
  301. const CarlaEngineClient* const client(plugin->getEngineClient());
  302. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  303. // kPluginBridgeNonRtServerPluginInfo1
  304. {
  305. // uint/category, uint/hints, uint/optionsAvailable, uint/optionsEnabled, long/uniqueId
  306. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPluginInfo1);
  307. fShmNonRtServerControl.writeUInt(plugin->getCategory());
  308. fShmNonRtServerControl.writeUInt(plugin->getHints());
  309. fShmNonRtServerControl.writeUInt(plugin->getOptionsAvailable());
  310. fShmNonRtServerControl.writeUInt(plugin->getOptionsEnabled());
  311. fShmNonRtServerControl.writeLong(plugin->getUniqueId());
  312. fShmNonRtServerControl.commitWrite();
  313. }
  314. // kPluginBridgeNonRtServerPluginInfo2
  315. {
  316. // uint/size, str[] (realName), uint/size, str[] (label), uint/size, str[] (maker), uint/size, str[] (copyright)
  317. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPluginInfo2);
  318. if (! plugin->getRealName(bufStr))
  319. bufStr[0] = '\0';
  320. bufStrSize = carla_fixedValue(1U, 64U, static_cast<uint32_t>(std::strlen(bufStr)));
  321. fShmNonRtServerControl.writeUInt(bufStrSize);
  322. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  323. if (! plugin->getLabel(bufStr))
  324. bufStr[0] = '\0';
  325. bufStrSize = carla_fixedValue(1U, 256U, static_cast<uint32_t>(std::strlen(bufStr)));
  326. fShmNonRtServerControl.writeUInt(bufStrSize);
  327. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  328. if (! plugin->getMaker(bufStr))
  329. bufStr[0] = '\0';
  330. bufStrSize = carla_fixedValue(1U, 64U, static_cast<uint32_t>(std::strlen(bufStr)));
  331. fShmNonRtServerControl.writeUInt(bufStrSize);
  332. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  333. if (! plugin->getCopyright(bufStr))
  334. bufStr[0] = '\0';
  335. bufStrSize = carla_fixedValue(1U, 64U, static_cast<uint32_t>(std::strlen(bufStr)));
  336. fShmNonRtServerControl.writeUInt(bufStrSize);
  337. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  338. fShmNonRtServerControl.commitWrite();
  339. }
  340. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  341. // kPluginBridgeNonRtServerAudioCount
  342. {
  343. const uint32_t aIns = plugin->getAudioInCount();
  344. const uint32_t aOuts = plugin->getAudioOutCount();
  345. // uint/ins, uint/outs
  346. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerAudioCount);
  347. fShmNonRtServerControl.writeUInt(aIns);
  348. fShmNonRtServerControl.writeUInt(aOuts);
  349. fShmNonRtServerControl.commitWrite();
  350. // kPluginBridgeNonRtServerPortName
  351. for (uint32_t i=0; i<aIns; ++i)
  352. {
  353. const char* const portName(client->getAudioPortName(true, i));
  354. CARLA_SAFE_ASSERT_CONTINUE(portName != nullptr && portName[0] != '\0');
  355. // byte/type, uint/index, uint/size, str[] (name)
  356. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPortName);
  357. fShmNonRtServerControl.writeByte(kPluginBridgePortAudioInput);
  358. fShmNonRtServerControl.writeUInt(i);
  359. bufStrSize = static_cast<uint32_t>(std::strlen(portName));
  360. fShmNonRtServerControl.writeUInt(bufStrSize);
  361. fShmNonRtServerControl.writeCustomData(portName, bufStrSize);
  362. }
  363. // kPluginBridgeNonRtServerPortName
  364. for (uint32_t i=0; i<aOuts; ++i)
  365. {
  366. const char* const portName(client->getAudioPortName(false, i));
  367. CARLA_SAFE_ASSERT_CONTINUE(portName != nullptr && portName[0] != '\0');
  368. // byte/type, uint/index, uint/size, str[] (name)
  369. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPortName);
  370. fShmNonRtServerControl.writeByte(kPluginBridgePortAudioOutput);
  371. fShmNonRtServerControl.writeUInt(i);
  372. bufStrSize = static_cast<uint32_t>(std::strlen(portName));
  373. fShmNonRtServerControl.writeUInt(bufStrSize);
  374. fShmNonRtServerControl.writeCustomData(portName, bufStrSize);
  375. }
  376. }
  377. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  378. // kPluginBridgeNonRtServerMidiCount
  379. {
  380. // uint/ins, uint/outs
  381. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerMidiCount);
  382. fShmNonRtServerControl.writeUInt(plugin->getMidiInCount());
  383. fShmNonRtServerControl.writeUInt(plugin->getMidiOutCount());
  384. fShmNonRtServerControl.commitWrite();
  385. }
  386. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  387. // kPluginBridgeNonRtServerCvCount
  388. {
  389. // uint/ins, uint/outs
  390. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerCvCount);
  391. fShmNonRtServerControl.writeUInt(plugin->getCVInCount());
  392. fShmNonRtServerControl.writeUInt(plugin->getCVOutCount());
  393. fShmNonRtServerControl.commitWrite();
  394. }
  395. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  396. // kPluginBridgeNonRtServerParameter*
  397. if (const uint32_t count = plugin->getParameterCount())
  398. {
  399. // uint/count
  400. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterCount);
  401. fShmNonRtServerControl.writeUInt(count);
  402. fShmNonRtServerControl.commitWrite();
  403. for (uint32_t i=0; i<count; ++i)
  404. {
  405. const ParameterData& paramData(plugin->getParameterData(i));
  406. if (paramData.type != PARAMETER_INPUT && paramData.type != PARAMETER_OUTPUT)
  407. continue;
  408. if ((paramData.hints & PARAMETER_IS_ENABLED) == 0)
  409. continue;
  410. // kPluginBridgeNonRtServerParameterData1
  411. {
  412. // uint/index, int/rindex, uint/type, uint/hints, short/cc
  413. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterData1);
  414. fShmNonRtServerControl.writeUInt(i);
  415. fShmNonRtServerControl.writeInt(paramData.rindex);
  416. fShmNonRtServerControl.writeUInt(paramData.type);
  417. fShmNonRtServerControl.writeUInt(paramData.hints);
  418. fShmNonRtServerControl.writeShort(paramData.mappedControlIndex);
  419. fShmNonRtServerControl.commitWrite();
  420. }
  421. // kPluginBridgeNonRtServerParameterData2
  422. {
  423. // uint/index, uint/size, str[] (name), uint/size, str[] (symbol), uint/size, str[] (unit)
  424. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterData2);
  425. fShmNonRtServerControl.writeUInt(i);
  426. if (! plugin->getParameterName(i, bufStr))
  427. std::snprintf(bufStr, STR_MAX, "Param %u", i+1);
  428. bufStrSize = carla_fixedValue(1U, 32U, static_cast<uint32_t>(std::strlen(bufStr)));
  429. fShmNonRtServerControl.writeUInt(bufStrSize);
  430. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  431. if (! plugin->getParameterSymbol(i, bufStr))
  432. bufStr[0] = '\0';
  433. bufStrSize = carla_fixedValue(1U, 64U, static_cast<uint32_t>(std::strlen(bufStr)));
  434. fShmNonRtServerControl.writeUInt(bufStrSize);
  435. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  436. if (! plugin->getParameterUnit(i, bufStr))
  437. bufStr[0] = '\0';
  438. bufStrSize = carla_fixedValue(1U, 32U, static_cast<uint32_t>(std::strlen(bufStr)));
  439. fShmNonRtServerControl.writeUInt(bufStrSize);
  440. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  441. fShmNonRtServerControl.commitWrite();
  442. }
  443. // kPluginBridgeNonRtServerParameterRanges
  444. {
  445. const ParameterRanges& paramRanges(plugin->getParameterRanges(i));
  446. // uint/index, float/def, float/min, float/max, float/step, float/stepSmall, float/stepLarge
  447. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterRanges);
  448. fShmNonRtServerControl.writeUInt(i);
  449. fShmNonRtServerControl.writeFloat(paramRanges.def);
  450. fShmNonRtServerControl.writeFloat(paramRanges.min);
  451. fShmNonRtServerControl.writeFloat(paramRanges.max);
  452. fShmNonRtServerControl.writeFloat(paramRanges.step);
  453. fShmNonRtServerControl.writeFloat(paramRanges.stepSmall);
  454. fShmNonRtServerControl.writeFloat(paramRanges.stepLarge);
  455. fShmNonRtServerControl.commitWrite();
  456. }
  457. // kPluginBridgeNonRtServerParameterValue2
  458. {
  459. // uint/index float/value (used for init/output parameters only, don't resend values)
  460. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterValue2);
  461. fShmNonRtServerControl.writeUInt(i);
  462. fShmNonRtServerControl.writeFloat(plugin->getParameterValue(i));
  463. fShmNonRtServerControl.commitWrite();
  464. }
  465. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  466. }
  467. }
  468. // kPluginBridgeNonRtServerProgram*
  469. if (const uint32_t count = plugin->getProgramCount())
  470. {
  471. // uint/count
  472. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerProgramCount);
  473. fShmNonRtServerControl.writeUInt(count);
  474. fShmNonRtServerControl.commitWrite();
  475. for (uint32_t i=0; i < count; ++i)
  476. {
  477. // uint/index, uint/size, str[] (name)
  478. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerProgramName);
  479. fShmNonRtServerControl.writeUInt(i);
  480. if (! plugin->getProgramName(i, bufStr))
  481. bufStr[0] = '\0';
  482. bufStrSize = carla_fixedValue(1U, 32U, static_cast<uint32_t>(std::strlen(bufStr)));
  483. fShmNonRtServerControl.writeUInt(bufStrSize);
  484. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  485. fShmNonRtServerControl.commitWrite();
  486. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  487. }
  488. }
  489. // kPluginBridgeNonRtServerMidiProgram*
  490. if (const uint32_t count = plugin->getMidiProgramCount())
  491. {
  492. // uint/count
  493. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerMidiProgramCount);
  494. fShmNonRtServerControl.writeUInt(count);
  495. fShmNonRtServerControl.commitWrite();
  496. for (uint32_t i=0; i < count; ++i)
  497. {
  498. const MidiProgramData& mpData(plugin->getMidiProgramData(i));
  499. CARLA_SAFE_ASSERT_CONTINUE(mpData.name != nullptr);
  500. // uint/index, uint/bank, uint/program, uint/size, str[] (name)
  501. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerMidiProgramData);
  502. fShmNonRtServerControl.writeUInt(i);
  503. fShmNonRtServerControl.writeUInt(mpData.bank);
  504. fShmNonRtServerControl.writeUInt(mpData.program);
  505. bufStrSize = carla_fixedValue(1U, 32U, static_cast<uint32_t>(std::strlen(mpData.name)));
  506. fShmNonRtServerControl.writeUInt(bufStrSize);
  507. fShmNonRtServerControl.writeCustomData(mpData.name, bufStrSize);
  508. fShmNonRtServerControl.commitWrite();
  509. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  510. }
  511. }
  512. if (const uint32_t latency = plugin->getLatencyInFrames())
  513. {
  514. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSetLatency);
  515. fShmNonRtServerControl.writeUInt(latency);
  516. fShmNonRtServerControl.commitWrite();
  517. }
  518. // ready!
  519. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerReady);
  520. fShmNonRtServerControl.commitWrite();
  521. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  522. carla_stdout("Carla Bridge Ready!");
  523. fLastPingTime = d_gettime_ms();
  524. }
  525. // send parameter outputs
  526. if (const uint32_t count = plugin->getParameterCount())
  527. {
  528. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  529. for (uint32_t i=0; i < count; ++i)
  530. {
  531. if (! plugin->isParameterOutput(i))
  532. continue;
  533. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterValue2);
  534. fShmNonRtServerControl.writeUInt(i);
  535. fShmNonRtServerControl.writeFloat(plugin->getParameterValue(i));
  536. // parameter outputs are not that important, we can skip some
  537. if (! fShmNonRtServerControl.commitWrite())
  538. break;
  539. }
  540. }
  541. CarlaEngine::idle();
  542. try {
  543. handleNonRtData();
  544. } CARLA_SAFE_EXCEPTION("handleNonRtData");
  545. if (fLastPingTime != UINT32_MAX && d_gettime_ms() > fLastPingTime + 30000 && ! wasFirstIdle)
  546. {
  547. carla_stderr("Did not receive ping message from server for 30 secs, closing...");
  548. signalThreadShouldExit();
  549. callback(true, true, ENGINE_CALLBACK_QUIT, 0, 0, 0, 0, 0.0f, nullptr);
  550. }
  551. }
  552. void callback(const bool sendHost, const bool sendOsc,
  553. const EngineCallbackOpcode action, const uint pluginId,
  554. const int value1, const int value2, const int value3,
  555. const float valuef, const char* const valueStr) noexcept override
  556. {
  557. CarlaEngine::callback(sendHost, sendOsc, action, pluginId, value1, value2, value3, valuef, valueStr);
  558. if (fClosingDown || ! sendHost)
  559. return;
  560. switch (action)
  561. {
  562. // uint/index float/value
  563. case ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED: {
  564. CARLA_SAFE_ASSERT_BREAK(value1 >= 0);
  565. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  566. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterValue);
  567. fShmNonRtServerControl.writeUInt(static_cast<uint>(value1));
  568. fShmNonRtServerControl.writeFloat(valuef);
  569. fShmNonRtServerControl.commitWrite();
  570. } break;
  571. // uint/index float/value
  572. case ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED: {
  573. CARLA_SAFE_ASSERT_BREAK(value1 >= 0);
  574. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  575. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerDefaultValue);
  576. fShmNonRtServerControl.writeUInt(static_cast<uint>(value1));
  577. fShmNonRtServerControl.writeFloat(valuef);
  578. fShmNonRtServerControl.commitWrite();
  579. } break;
  580. // int/index
  581. case ENGINE_CALLBACK_PROGRAM_CHANGED: {
  582. CARLA_SAFE_ASSERT_BREAK(value1 >= -1);
  583. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  584. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerCurrentProgram);
  585. fShmNonRtServerControl.writeInt(value1);
  586. fShmNonRtServerControl.commitWrite();
  587. } break;
  588. // int/index
  589. case ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED: {
  590. CARLA_SAFE_ASSERT_BREAK(value1 >= -1);
  591. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  592. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerCurrentMidiProgram);
  593. fShmNonRtServerControl.writeInt(value1);
  594. fShmNonRtServerControl.commitWrite();
  595. } break;
  596. case ENGINE_CALLBACK_UI_STATE_CHANGED:
  597. if (value1 != 1)
  598. {
  599. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  600. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerUiClosed);
  601. fShmNonRtServerControl.commitWrite();
  602. }
  603. break;
  604. case ENGINE_CALLBACK_EMBED_UI_RESIZED: {
  605. CARLA_SAFE_ASSERT_BREAK(value1 > 1);
  606. CARLA_SAFE_ASSERT_BREAK(value2 > 1);
  607. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  608. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerResizeEmbedUI);
  609. fShmNonRtServerControl.writeUInt(static_cast<uint>(value1));
  610. fShmNonRtServerControl.writeUInt(static_cast<uint>(value2));
  611. fShmNonRtServerControl.commitWrite();
  612. } break;
  613. case ENGINE_CALLBACK_RELOAD_PARAMETERS:
  614. if (const CarlaPluginPtr plugin = pData->plugins[0].plugin)
  615. {
  616. if (const uint32_t count = plugin->getParameterCount())
  617. {
  618. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  619. for (uint32_t i=0; i<count; ++i)
  620. {
  621. const ParameterData& paramData(plugin->getParameterData(i));
  622. if (paramData.type != PARAMETER_INPUT && paramData.type != PARAMETER_OUTPUT)
  623. continue;
  624. if ((paramData.hints & PARAMETER_IS_ENABLED) == 0)
  625. continue;
  626. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterValue);
  627. fShmNonRtServerControl.writeUInt(i);
  628. fShmNonRtServerControl.writeFloat(plugin->getParameterValue(i));
  629. fShmNonRtServerControl.commitWrite();
  630. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  631. }
  632. }
  633. }
  634. break;
  635. default:
  636. break;
  637. }
  638. }
  639. // -------------------------------------------------------------------
  640. void clear() noexcept
  641. {
  642. fShmAudioPool.clear();
  643. fShmRtClientControl.clear();
  644. fShmNonRtClientControl.clear();
  645. fShmNonRtServerControl.clear();
  646. }
  647. void handleNonRtData()
  648. {
  649. const CarlaPluginPtr plugin = pData->plugins[0].plugin;
  650. CARLA_SAFE_ASSERT_RETURN(plugin.get() != nullptr,);
  651. for (; fShmNonRtClientControl.isDataAvailableForReading();)
  652. {
  653. const PluginBridgeNonRtClientOpcode opcode = fShmNonRtClientControl.readOpcode();
  654. #ifdef DEBUG
  655. if (opcode != kPluginBridgeNonRtClientPing) {
  656. carla_debug("CarlaEngineBridge::handleNonRtData() - got opcode: %i:%s",
  657. opcode, PluginBridgeNonRtClientOpcode2str(opcode));
  658. }
  659. #endif
  660. if (opcode != kPluginBridgeNonRtClientNull &&
  661. opcode != kPluginBridgeNonRtClientPingOnOff && fLastPingTime != UINT32_MAX)
  662. fLastPingTime = d_gettime_ms();
  663. switch (opcode)
  664. {
  665. case kPluginBridgeNonRtClientNull:
  666. break;
  667. case kPluginBridgeNonRtClientVersion: {
  668. fBridgeVersion = fShmNonRtServerControl.readUInt();
  669. CARLA_SAFE_ASSERT_UINT2(fBridgeVersion >= CARLA_PLUGIN_BRIDGE_API_VERSION_MINIMUM,
  670. fBridgeVersion, CARLA_PLUGIN_BRIDGE_API_VERSION_MINIMUM);
  671. } break;
  672. case kPluginBridgeNonRtClientPing: {
  673. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  674. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPong);
  675. fShmNonRtServerControl.commitWrite();
  676. } break;
  677. case kPluginBridgeNonRtClientPingOnOff:
  678. fLastPingTime = fShmNonRtClientControl.readBool() ? d_gettime_ms() : UINT32_MAX;
  679. break;
  680. case kPluginBridgeNonRtClientActivate:
  681. if (plugin->isEnabled())
  682. plugin->setActive(true, false, false);
  683. break;
  684. case kPluginBridgeNonRtClientDeactivate:
  685. if (plugin->isEnabled())
  686. plugin->setActive(false, false, false);
  687. break;
  688. case kPluginBridgeNonRtClientInitialSetup:
  689. // should never happen!!
  690. fShmNonRtServerControl.readUInt();
  691. fShmNonRtServerControl.readDouble();
  692. break;
  693. case kPluginBridgeNonRtClientSetParameterValue: {
  694. const uint32_t index(fShmNonRtClientControl.readUInt());
  695. const float value(fShmNonRtClientControl.readFloat());
  696. if (plugin->isEnabled())
  697. plugin->setParameterValue(index, value, false, false, false);
  698. break;
  699. }
  700. case kPluginBridgeNonRtClientSetParameterMidiChannel: {
  701. const uint32_t index(fShmNonRtClientControl.readUInt());
  702. const uint8_t channel(fShmNonRtClientControl.readByte());
  703. if (plugin->isEnabled())
  704. plugin->setParameterMidiChannel(index, channel, false, false);
  705. break;
  706. }
  707. case kPluginBridgeNonRtClientSetParameterMappedControlIndex: {
  708. const uint32_t index(fShmNonRtClientControl.readUInt());
  709. const int16_t ctrl(fShmNonRtClientControl.readShort());
  710. if (plugin->isEnabled())
  711. plugin->setParameterMappedControlIndex(index, ctrl, false, false, true);
  712. break;
  713. }
  714. case kPluginBridgeNonRtClientSetParameterMappedRange: {
  715. const uint32_t index = fShmNonRtClientControl.readUInt();
  716. const float minimum = fShmNonRtClientControl.readFloat();
  717. const float maximum = fShmNonRtClientControl.readFloat();
  718. if (plugin->isEnabled())
  719. plugin->setParameterMappedRange(index, minimum, maximum, false, false);
  720. break;
  721. }
  722. case kPluginBridgeNonRtClientSetProgram: {
  723. const int32_t index(fShmNonRtClientControl.readInt());
  724. if (plugin->isEnabled())
  725. plugin->setProgram(index, true, false, false);
  726. break;
  727. }
  728. case kPluginBridgeNonRtClientSetMidiProgram: {
  729. const int32_t index(fShmNonRtClientControl.readInt());
  730. if (plugin->isEnabled())
  731. plugin->setMidiProgram(index, true, false, false);
  732. break;
  733. }
  734. case kPluginBridgeNonRtClientSetCustomData: {
  735. const uint32_t maxLocalValueLen = fBridgeVersion >= 10 ? 4096 : 16384;
  736. // type
  737. const BridgeTextReader type(fShmNonRtClientControl);
  738. // key
  739. const BridgeTextReader key(fShmNonRtClientControl);
  740. // value
  741. const uint32_t valueSize = fShmNonRtClientControl.readUInt();
  742. if (valueSize > 0)
  743. {
  744. if (valueSize > maxLocalValueLen)
  745. {
  746. const BridgeTextReader bigValueFilePathTry(fShmNonRtClientControl);
  747. CARLA_SAFE_ASSERT_BREAK(bigValueFilePathTry.text[0] != '\0');
  748. if (! plugin->isEnabled()) break;
  749. water::String bigValueFilePath(bigValueFilePathTry.text);
  750. #ifdef CARLA_OS_WIN
  751. // check if running under Wine
  752. if (bigValueFilePath.startsWith("/"))
  753. bigValueFilePath = bigValueFilePath.replaceSection(0, 1, "Z:\\").replace("/", "\\");
  754. #endif
  755. File bigValueFile(bigValueFilePath.toRawUTF8());
  756. CARLA_SAFE_ASSERT_BREAK(bigValueFile.existsAsFile());
  757. plugin->setCustomData(type.text, key.text, bigValueFile.loadFileAsString().toRawUTF8(), true);
  758. bigValueFile.deleteFile();
  759. }
  760. else
  761. {
  762. const BridgeTextReader value(fShmNonRtClientControl, valueSize);
  763. if (plugin->isEnabled())
  764. plugin->setCustomData(type.text, key.text, value.text, true);
  765. }
  766. }
  767. else
  768. {
  769. if (plugin->isEnabled())
  770. plugin->setCustomData(type.text, key.text, "", true);
  771. }
  772. break;
  773. }
  774. case kPluginBridgeNonRtClientSetChunkDataFile: {
  775. const uint32_t size = fShmNonRtClientControl.readUInt();
  776. CARLA_SAFE_ASSERT_BREAK(size > 0);
  777. const BridgeTextReader chunkFilePathTry(fShmNonRtClientControl, size);
  778. CARLA_SAFE_ASSERT_BREAK(chunkFilePathTry.text[0] != '\0');
  779. if (! plugin->isEnabled()) break;
  780. water::String chunkFilePath(chunkFilePathTry.text);
  781. #ifdef CARLA_OS_WIN
  782. // check if running under Wine
  783. if (chunkFilePath.startsWith("/"))
  784. chunkFilePath = chunkFilePath.replaceSection(0, 1, "Z:\\").replace("/", "\\");
  785. #endif
  786. File chunkFile(chunkFilePath.toRawUTF8());
  787. CARLA_SAFE_ASSERT_BREAK(chunkFile.existsAsFile());
  788. water::String chunkDataBase64(chunkFile.loadFileAsString());
  789. chunkFile.deleteFile();
  790. CARLA_SAFE_ASSERT_BREAK(chunkDataBase64.isNotEmpty());
  791. std::vector<uint8_t> chunk;
  792. d_getChunkFromBase64String_impl(chunk, chunkDataBase64.toRawUTF8());
  793. #ifdef CARLA_PROPER_CPP11_SUPPORT
  794. plugin->setChunkData(chunk.data(), chunk.size());
  795. #else
  796. plugin->setChunkData(&chunk.front(), chunk.size());
  797. #endif
  798. break;
  799. }
  800. case kPluginBridgeNonRtClientSetCtrlChannel: {
  801. const int16_t channel(fShmNonRtClientControl.readShort());
  802. CARLA_SAFE_ASSERT_BREAK(channel >= -1 && channel < MAX_MIDI_CHANNELS);
  803. if (plugin->isEnabled())
  804. plugin->setCtrlChannel(static_cast<int8_t>(channel), false, false);
  805. break;
  806. }
  807. case kPluginBridgeNonRtClientSetOption: {
  808. const uint32_t option(fShmNonRtClientControl.readUInt());
  809. const bool yesNo(fShmNonRtClientControl.readBool());
  810. if (plugin->isEnabled())
  811. plugin->setOption(option, yesNo, false);
  812. break;
  813. }
  814. case kPluginBridgeNonRtClientSetOptions: {
  815. const uint32_t options(fShmNonRtClientControl.readUInt());
  816. plugin->pData->options = options;
  817. break;
  818. }
  819. case kPluginBridgeNonRtClientSetWindowTitle: {
  820. const BridgeTextReader title(fShmNonRtClientControl);
  821. plugin->setCustomUITitle(title.text);
  822. break;
  823. }
  824. case kPluginBridgeNonRtClientGetParameterText: {
  825. const int32_t index = fShmNonRtClientControl.readInt();
  826. if (index >= 0 && plugin->isEnabled())
  827. {
  828. char bufStr[STR_MAX+1];
  829. carla_zeroChars(bufStr, STR_MAX+1);
  830. if (! plugin->getParameterText(static_cast<uint32_t>(index), bufStr))
  831. bufStr[0] = '\0';
  832. const uint32_t bufStrLen = static_cast<uint32_t>(std::strlen(bufStr));
  833. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  834. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSetParameterText);
  835. fShmNonRtServerControl.writeInt(index);
  836. fShmNonRtServerControl.writeUInt(bufStrLen);
  837. fShmNonRtServerControl.writeCustomData(bufStr, bufStrLen);
  838. fShmNonRtServerControl.commitWrite();
  839. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  840. }
  841. else
  842. {
  843. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  844. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSetParameterText);
  845. fShmNonRtServerControl.writeInt(index);
  846. fShmNonRtServerControl.writeUInt(0);
  847. fShmNonRtServerControl.commitWrite();
  848. }
  849. break;
  850. }
  851. case kPluginBridgeNonRtClientPrepareForSave: {
  852. if (! plugin->isEnabled())
  853. {
  854. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  855. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSaved);
  856. fShmNonRtServerControl.commitWrite();
  857. return;
  858. }
  859. plugin->prepareForSave(false);
  860. const uint32_t maxLocalValueLen = fBridgeVersion >= 10 ? 4096 : 16384;
  861. for (uint32_t i=0, count=plugin->getCustomDataCount(); i<count; ++i)
  862. {
  863. const CustomData& cdata(plugin->getCustomData(i));
  864. if (std::strcmp(cdata.type, CUSTOM_DATA_TYPE_PROPERTY) == 0)
  865. continue;
  866. const uint32_t typeLen = static_cast<uint32_t>(std::strlen(cdata.type));
  867. const uint32_t keyLen = static_cast<uint32_t>(std::strlen(cdata.key));
  868. const uint32_t valueLen = static_cast<uint32_t>(std::strlen(cdata.value));
  869. {
  870. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  871. if (valueLen > maxLocalValueLen)
  872. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  873. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSetCustomData);
  874. fShmNonRtServerControl.writeUInt(typeLen);
  875. fShmNonRtServerControl.writeCustomData(cdata.type, typeLen);
  876. fShmNonRtServerControl.writeUInt(keyLen);
  877. fShmNonRtServerControl.writeCustomData(cdata.key, keyLen);
  878. fShmNonRtServerControl.writeUInt(valueLen);
  879. if (valueLen > 0)
  880. {
  881. if (valueLen > maxLocalValueLen)
  882. {
  883. water::String filePath(File::getSpecialLocation(File::tempDirectory).getFullPathName());
  884. filePath += CARLA_OS_SEP_STR ".CarlaCustomData_";
  885. filePath += fShmAudioPool.getFilenameSuffix();
  886. if (File(filePath.toRawUTF8()).replaceWithText(cdata.value))
  887. {
  888. const uint32_t ulength(static_cast<uint32_t>(filePath.length()));
  889. fShmNonRtServerControl.writeUInt(ulength);
  890. fShmNonRtServerControl.writeCustomData(filePath.toRawUTF8(), ulength);
  891. }
  892. else
  893. {
  894. fShmNonRtServerControl.writeUInt(0);
  895. }
  896. }
  897. else
  898. {
  899. fShmNonRtServerControl.writeCustomData(cdata.value, valueLen);
  900. }
  901. }
  902. fShmNonRtServerControl.commitWrite();
  903. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  904. }
  905. }
  906. if (plugin->getOptionsEnabled() & PLUGIN_OPTION_USE_CHUNKS)
  907. {
  908. void* data = nullptr;
  909. if (const std::size_t dataSize = plugin->getChunkData(&data))
  910. {
  911. CARLA_SAFE_ASSERT_BREAK(data != nullptr);
  912. String dataBase64 = String::asBase64(data, dataSize);
  913. CARLA_SAFE_ASSERT_BREAK(dataBase64.length() > 0);
  914. water::String filePath(File::getSpecialLocation(File::tempDirectory).getFullPathName());
  915. filePath += CARLA_OS_SEP_STR ".CarlaChunk_";
  916. filePath += fShmAudioPool.getFilenameSuffix();
  917. if (File(filePath.toRawUTF8()).replaceWithText(dataBase64.buffer()))
  918. {
  919. const uint32_t ulength(static_cast<uint32_t>(filePath.length()));
  920. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  921. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSetChunkDataFile);
  922. fShmNonRtServerControl.writeUInt(ulength);
  923. fShmNonRtServerControl.writeCustomData(filePath.toRawUTF8(), ulength);
  924. fShmNonRtServerControl.commitWrite();
  925. }
  926. }
  927. }
  928. {
  929. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  930. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSaved);
  931. fShmNonRtServerControl.commitWrite();
  932. }
  933. break;
  934. }
  935. case kPluginBridgeNonRtClientRestoreLV2State:
  936. if (plugin->isEnabled())
  937. plugin->restoreLV2State(false);
  938. break;
  939. case kPluginBridgeNonRtClientShowUI:
  940. if (plugin->isEnabled())
  941. plugin->showCustomUI(true);
  942. break;
  943. case kPluginBridgeNonRtClientHideUI:
  944. if (plugin->isEnabled())
  945. plugin->showCustomUI(false);
  946. break;
  947. case kPluginBridgeNonRtClientEmbedUI: {
  948. const uint64_t winId = fShmNonRtClientControl.readULong();
  949. uint64_t resp = 0;
  950. if (plugin->isEnabled())
  951. resp = reinterpret_cast<uint64_t>(plugin->embedCustomUI(reinterpret_cast<void*>(winId)));
  952. if (resp == 0)
  953. resp = 1;
  954. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  955. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerRespEmbedUI);
  956. fShmNonRtServerControl.writeULong(resp);
  957. fShmNonRtServerControl.commitWrite();
  958. break;
  959. }
  960. case kPluginBridgeNonRtClientUiParameterChange: {
  961. const uint32_t index = fShmNonRtClientControl.readUInt();
  962. const float value = fShmNonRtClientControl.readFloat();
  963. if (plugin->isEnabled())
  964. plugin->uiParameterChange(index, value);
  965. break;
  966. }
  967. case kPluginBridgeNonRtClientUiProgramChange: {
  968. const uint32_t index(fShmNonRtClientControl.readUInt());
  969. if (plugin->isEnabled())
  970. plugin->uiProgramChange(index);
  971. break;
  972. }
  973. case kPluginBridgeNonRtClientUiMidiProgramChange: {
  974. const uint32_t index(fShmNonRtClientControl.readUInt());
  975. if (plugin->isEnabled())
  976. plugin->uiMidiProgramChange(index);
  977. break;
  978. }
  979. case kPluginBridgeNonRtClientUiNoteOn: {
  980. const uint8_t chnl(fShmNonRtClientControl.readByte());
  981. const uint8_t note(fShmNonRtClientControl.readByte());
  982. const uint8_t velo(fShmNonRtClientControl.readByte());
  983. if (plugin->isEnabled())
  984. plugin->uiNoteOn(chnl, note, velo);
  985. break;
  986. }
  987. case kPluginBridgeNonRtClientUiNoteOff: {
  988. const uint8_t chnl(fShmNonRtClientControl.readByte());
  989. const uint8_t note(fShmNonRtClientControl.readByte());
  990. if (plugin->isEnabled())
  991. plugin->uiNoteOff(chnl, note);
  992. break;
  993. }
  994. case kPluginBridgeNonRtClientQuit:
  995. fClosingDown = true;
  996. signalThreadShouldExit();
  997. callback(true, true, ENGINE_CALLBACK_QUIT, 0, 0, 0, 0, 0.0f, nullptr);
  998. break;
  999. case kPluginBridgeNonRtClientReload:
  1000. fFirstIdle = true;
  1001. break;
  1002. }
  1003. }
  1004. }
  1005. // -------------------------------------------------------------------
  1006. protected:
  1007. void run() override
  1008. {
  1009. #ifdef __SSE2_MATH__
  1010. // Set FTZ and DAZ flags
  1011. _mm_setcsr(_mm_getcsr() | 0x8040);
  1012. #endif
  1013. bool quitReceived = false;
  1014. for (; ! shouldThreadExit();)
  1015. {
  1016. const BridgeRtClientControl::WaitHelper helper(fShmRtClientControl);
  1017. if (! helper.ok)
  1018. continue;
  1019. for (; fShmRtClientControl.isDataAvailableForReading();)
  1020. {
  1021. const PluginBridgeRtClientOpcode opcode(fShmRtClientControl.readOpcode());
  1022. const CarlaPluginPtr plugin = pData->plugins[0].plugin;
  1023. #ifdef DEBUG
  1024. if (opcode != kPluginBridgeRtClientProcess && opcode != kPluginBridgeRtClientMidiEvent) {
  1025. carla_debug("CarlaEngineBridgeRtThread::run() - got opcode: %s", PluginBridgeRtClientOpcode2str(opcode));
  1026. }
  1027. #endif
  1028. switch (opcode)
  1029. {
  1030. case kPluginBridgeRtClientNull:
  1031. break;
  1032. case kPluginBridgeRtClientSetAudioPool: {
  1033. if (fShmAudioPool.data != nullptr)
  1034. {
  1035. jackbridge_shm_unmap(fShmAudioPool.shm, fShmAudioPool.data);
  1036. fShmAudioPool.data = nullptr;
  1037. }
  1038. const uint64_t poolSize(fShmRtClientControl.readULong());
  1039. CARLA_SAFE_ASSERT_BREAK(poolSize > 0);
  1040. fShmAudioPool.data = (float*)jackbridge_shm_map(fShmAudioPool.shm, static_cast<size_t>(poolSize));
  1041. break;
  1042. }
  1043. case kPluginBridgeRtClientSetBufferSize: {
  1044. const uint32_t bufferSize(fShmRtClientControl.readUInt());
  1045. pData->bufferSize = bufferSize;
  1046. bufferSizeChanged(bufferSize);
  1047. break;
  1048. }
  1049. case kPluginBridgeRtClientSetSampleRate: {
  1050. const double sampleRate(fShmRtClientControl.readDouble());
  1051. pData->sampleRate = sampleRate;
  1052. sampleRateChanged(sampleRate);
  1053. break;
  1054. }
  1055. case kPluginBridgeRtClientSetOnline:
  1056. fIsOffline = fShmRtClientControl.readBool();
  1057. offlineModeChanged(fIsOffline);
  1058. break;
  1059. // NOTE this is never used
  1060. case kPluginBridgeRtClientControlEventParameter: {
  1061. const uint32_t time(fShmRtClientControl.readUInt());
  1062. const uint8_t channel(fShmRtClientControl.readByte());
  1063. const uint16_t param(fShmRtClientControl.readUShort());
  1064. const float value(fShmRtClientControl.readFloat());
  1065. if (EngineEvent* const event = getNextFreeInputEvent())
  1066. {
  1067. event->type = kEngineEventTypeControl;
  1068. event->time = time;
  1069. event->channel = channel;
  1070. event->ctrl.type = kEngineControlEventTypeParameter;
  1071. event->ctrl.param = param;
  1072. event->ctrl.midiValue = -1;
  1073. event->ctrl.normalizedValue = value;
  1074. event->ctrl.handled = true;
  1075. }
  1076. break;
  1077. }
  1078. case kPluginBridgeRtClientControlEventMidiBank: {
  1079. const uint32_t time(fShmRtClientControl.readUInt());
  1080. const uint8_t channel(fShmRtClientControl.readByte());
  1081. const uint16_t index(fShmRtClientControl.readUShort());
  1082. if (EngineEvent* const event = getNextFreeInputEvent())
  1083. {
  1084. event->type = kEngineEventTypeControl;
  1085. event->time = time;
  1086. event->channel = channel;
  1087. event->ctrl.type = kEngineControlEventTypeMidiBank;
  1088. event->ctrl.param = index;
  1089. event->ctrl.midiValue = -1;
  1090. event->ctrl.normalizedValue = 0.0f;
  1091. event->ctrl.handled = true;
  1092. }
  1093. break;
  1094. }
  1095. case kPluginBridgeRtClientControlEventMidiProgram: {
  1096. const uint32_t time(fShmRtClientControl.readUInt());
  1097. const uint8_t channel(fShmRtClientControl.readByte());
  1098. const uint16_t index(fShmRtClientControl.readUShort());
  1099. if (EngineEvent* const event = getNextFreeInputEvent())
  1100. {
  1101. event->type = kEngineEventTypeControl;
  1102. event->time = time;
  1103. event->channel = channel;
  1104. event->ctrl.type = kEngineControlEventTypeMidiProgram;
  1105. event->ctrl.param = index;
  1106. event->ctrl.midiValue = -1;
  1107. event->ctrl.normalizedValue = 0.0f;
  1108. event->ctrl.handled = true;
  1109. }
  1110. break;
  1111. }
  1112. case kPluginBridgeRtClientControlEventAllSoundOff: {
  1113. const uint32_t time(fShmRtClientControl.readUInt());
  1114. const uint8_t channel(fShmRtClientControl.readByte());
  1115. if (EngineEvent* const event = getNextFreeInputEvent())
  1116. {
  1117. event->type = kEngineEventTypeControl;
  1118. event->time = time;
  1119. event->channel = channel;
  1120. event->ctrl.type = kEngineControlEventTypeAllSoundOff;
  1121. event->ctrl.param = 0;
  1122. event->ctrl.midiValue = -1;
  1123. event->ctrl.normalizedValue = 0.0f;
  1124. event->ctrl.handled = true;
  1125. }
  1126. } break;
  1127. case kPluginBridgeRtClientControlEventAllNotesOff: {
  1128. const uint32_t time(fShmRtClientControl.readUInt());
  1129. const uint8_t channel(fShmRtClientControl.readByte());
  1130. if (EngineEvent* const event = getNextFreeInputEvent())
  1131. {
  1132. event->type = kEngineEventTypeControl;
  1133. event->time = time;
  1134. event->channel = channel;
  1135. event->ctrl.type = kEngineControlEventTypeAllNotesOff;
  1136. event->ctrl.param = 0;
  1137. event->ctrl.midiValue = -1;
  1138. event->ctrl.normalizedValue = 0.0f;
  1139. event->ctrl.handled = true;
  1140. }
  1141. } break;
  1142. case kPluginBridgeRtClientMidiEvent: {
  1143. const uint32_t time(fShmRtClientControl.readUInt());
  1144. const uint8_t port(fShmRtClientControl.readByte());
  1145. const uint8_t size(fShmRtClientControl.readByte());
  1146. CARLA_SAFE_ASSERT_BREAK(size > 0);
  1147. // FIXME variable-size stack
  1148. uint8_t data[4];
  1149. {
  1150. uint8_t i=0;
  1151. for (; i<size && i<4; ++i)
  1152. data[i] = fShmRtClientControl.readByte();
  1153. for (; i<size; ++i)
  1154. fShmRtClientControl.readByte();
  1155. }
  1156. if (size > 4)
  1157. continue;
  1158. if (EngineEvent* const event = getNextFreeInputEvent())
  1159. {
  1160. event->type = kEngineEventTypeMidi;
  1161. event->time = time;
  1162. event->channel = MIDI_GET_CHANNEL_FROM_DATA(data);
  1163. event->midi.port = port;
  1164. event->midi.size = size;
  1165. if (size > EngineMidiEvent::kDataSize)
  1166. {
  1167. event->midi.dataExt = data;
  1168. std::memset(event->midi.data, 0, sizeof(uint8_t)*EngineMidiEvent::kDataSize);
  1169. }
  1170. else
  1171. {
  1172. event->midi.data[0] = MIDI_GET_STATUS_FROM_DATA(data);
  1173. uint8_t i=1;
  1174. for (; i < size; ++i)
  1175. event->midi.data[i] = data[i];
  1176. for (; i < EngineMidiEvent::kDataSize; ++i)
  1177. event->midi.data[i] = 0;
  1178. event->midi.dataExt = nullptr;
  1179. }
  1180. }
  1181. break;
  1182. }
  1183. case kPluginBridgeRtClientProcess: {
  1184. const uint32_t frames(fShmRtClientControl.readUInt());
  1185. CARLA_SAFE_ASSERT_BREAK(fShmAudioPool.data != nullptr);
  1186. if (plugin.get() != nullptr && plugin->isEnabled() && plugin->tryLock(fIsOffline))
  1187. {
  1188. const BridgeTimeInfo& bridgeTimeInfo(fShmRtClientControl.data->timeInfo);
  1189. const uint32_t audioInCount = plugin->getAudioInCount();
  1190. const uint32_t audioOutCount = plugin->getAudioOutCount();
  1191. const uint32_t cvInCount = plugin->getCVInCount();
  1192. const uint32_t cvOutCount = plugin->getCVOutCount();
  1193. const float* audioIn[64];
  1194. /* */ float* audioOut[64];
  1195. const float* cvIn[32];
  1196. /* */ float* cvOut[32];
  1197. float* fdata = fShmAudioPool.data;
  1198. for (uint32_t i=0; i < audioInCount; ++i, fdata += pData->bufferSize)
  1199. audioIn[i] = fdata;
  1200. for (uint32_t i=0; i < audioOutCount; ++i, fdata += pData->bufferSize)
  1201. audioOut[i] = fdata;
  1202. for (uint32_t i=0; i < cvInCount; ++i, fdata += pData->bufferSize)
  1203. cvIn[i] = fdata;
  1204. for (uint32_t i=0; i < cvOutCount; ++i, fdata += pData->bufferSize)
  1205. cvOut[i] = fdata;
  1206. EngineTimeInfo& timeInfo(pData->timeInfo);
  1207. timeInfo.playing = bridgeTimeInfo.playing;
  1208. timeInfo.frame = bridgeTimeInfo.frame;
  1209. timeInfo.usecs = bridgeTimeInfo.usecs;
  1210. timeInfo.bbt.valid = (bridgeTimeInfo.validFlags & kPluginBridgeTimeInfoValidBBT) != 0;
  1211. if (timeInfo.bbt.valid)
  1212. {
  1213. timeInfo.bbt.bar = bridgeTimeInfo.bar;
  1214. timeInfo.bbt.beat = bridgeTimeInfo.beat;
  1215. timeInfo.bbt.tick = bridgeTimeInfo.tick;
  1216. timeInfo.bbt.beatsPerBar = bridgeTimeInfo.beatsPerBar;
  1217. timeInfo.bbt.beatType = bridgeTimeInfo.beatType;
  1218. timeInfo.bbt.ticksPerBeat = bridgeTimeInfo.ticksPerBeat;
  1219. timeInfo.bbt.beatsPerMinute = bridgeTimeInfo.beatsPerMinute;
  1220. timeInfo.bbt.barStartTick = bridgeTimeInfo.barStartTick;
  1221. }
  1222. plugin->initBuffers();
  1223. plugin->process(audioIn, audioOut, cvIn, cvOut, frames);
  1224. plugin->unlock();
  1225. }
  1226. uint8_t* midiData(fShmRtClientControl.data->midiOut);
  1227. carla_zeroBytes(midiData, kBridgeBaseMidiOutHeaderSize);
  1228. std::size_t curMidiDataPos = 0;
  1229. if (pData->events.in[0].type != kEngineEventTypeNull)
  1230. carla_zeroStructs(pData->events.in, kMaxEngineEventInternalCount);
  1231. if (pData->events.out[0].type != kEngineEventTypeNull)
  1232. {
  1233. for (ushort i=0; i < kMaxEngineEventInternalCount; ++i)
  1234. {
  1235. const EngineEvent& event(pData->events.out[i]);
  1236. if (event.type == kEngineEventTypeNull)
  1237. break;
  1238. if (event.type == kEngineEventTypeControl)
  1239. {
  1240. uint8_t data[3];
  1241. const uint8_t size = event.ctrl.convertToMidiData(event.channel, data);
  1242. CARLA_SAFE_ASSERT_CONTINUE(size > 0 && size <= 3);
  1243. if (curMidiDataPos + kBridgeBaseMidiOutHeaderSize + size >= kBridgeRtClientDataMidiOutSize)
  1244. break;
  1245. // set time
  1246. *(uint32_t*)midiData = event.time;
  1247. midiData = midiData + 4;
  1248. curMidiDataPos += 4;
  1249. // set port
  1250. *midiData++ = 0;
  1251. ++curMidiDataPos;
  1252. // set size
  1253. *midiData++ = size;
  1254. ++curMidiDataPos;
  1255. // set data
  1256. for (uint8_t j=0; j<size; ++j)
  1257. *midiData++ = data[j];
  1258. curMidiDataPos += size;
  1259. }
  1260. else if (event.type == kEngineEventTypeMidi)
  1261. {
  1262. const EngineMidiEvent& _midiEvent(event.midi);
  1263. if (curMidiDataPos + kBridgeBaseMidiOutHeaderSize + _midiEvent.size >= kBridgeRtClientDataMidiOutSize)
  1264. break;
  1265. const uint8_t* const _midiData(_midiEvent.dataExt != nullptr ? _midiEvent.dataExt : _midiEvent.data);
  1266. // set time
  1267. *(uint32_t*)midiData = event.time;
  1268. midiData += 4;
  1269. curMidiDataPos += 4;
  1270. // set port
  1271. *midiData++ = _midiEvent.port;
  1272. ++curMidiDataPos;
  1273. // set size
  1274. *midiData++ = _midiEvent.size;
  1275. ++curMidiDataPos;
  1276. // set data
  1277. *midiData++ = uint8_t(_midiData[0] | (event.channel & MIDI_CHANNEL_BIT));
  1278. for (uint8_t j=1; j<_midiEvent.size; ++j)
  1279. *midiData++ = _midiData[j];
  1280. curMidiDataPos += _midiEvent.size;
  1281. }
  1282. }
  1283. if (curMidiDataPos != 0 &&
  1284. curMidiDataPos + kBridgeBaseMidiOutHeaderSize < kBridgeRtClientDataMidiOutSize)
  1285. carla_zeroBytes(midiData, kBridgeBaseMidiOutHeaderSize);
  1286. carla_zeroStructs(pData->events.out, kMaxEngineEventInternalCount);
  1287. }
  1288. } break;
  1289. case kPluginBridgeRtClientQuit: {
  1290. quitReceived = true;
  1291. fClosingDown = true;
  1292. signalThreadShouldExit();
  1293. } break;
  1294. }
  1295. }
  1296. }
  1297. callback(true, true, ENGINE_CALLBACK_ENGINE_STOPPED, 0, 0, 0, 0, 0.0f, nullptr);
  1298. if (! quitReceived)
  1299. {
  1300. const char* const message("Plugin bridge error, process thread has stopped");
  1301. const std::size_t messageSize(std::strlen(message));
  1302. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  1303. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerError);
  1304. fShmNonRtServerControl.writeUInt(messageSize);
  1305. fShmNonRtServerControl.writeCustomData(message, messageSize);
  1306. fShmNonRtServerControl.commitWrite();
  1307. }
  1308. }
  1309. // called from process thread above
  1310. EngineEvent* getNextFreeInputEvent() const noexcept
  1311. {
  1312. for (ushort i=0; i < kMaxEngineEventInternalCount; ++i)
  1313. {
  1314. EngineEvent* const event(&pData->events.in[i]);
  1315. if (event->type == kEngineEventTypeNull)
  1316. return event;
  1317. }
  1318. return nullptr;
  1319. }
  1320. void latencyChanged(const uint32_t samples) noexcept override
  1321. {
  1322. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  1323. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSetLatency);
  1324. fShmNonRtServerControl.writeUInt(samples);
  1325. fShmNonRtServerControl.commitWrite();
  1326. }
  1327. // -------------------------------------------------------------------
  1328. private:
  1329. BridgeAudioPool fShmAudioPool;
  1330. BridgeRtClientControl fShmRtClientControl;
  1331. BridgeNonRtClientControl fShmNonRtClientControl;
  1332. BridgeNonRtServerControl fShmNonRtServerControl;
  1333. String fBaseNameAudioPool;
  1334. String fBaseNameRtClientControl;
  1335. String fBaseNameNonRtClientControl;
  1336. String fBaseNameNonRtServerControl;
  1337. bool fClosingDown;
  1338. bool fIsOffline;
  1339. bool fFirstIdle;
  1340. uint32_t fBridgeVersion;
  1341. uint32_t fLastPingTime;
  1342. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineBridge)
  1343. };
  1344. // -----------------------------------------------------------------------
  1345. namespace EngineInit {
  1346. CarlaEngine* newBridge(const char* const audioPoolBaseName,
  1347. const char* const rtClientBaseName,
  1348. const char* const nonRtClientBaseName,
  1349. const char* const nonRtServerBaseName)
  1350. {
  1351. return new CarlaEngineBridge(audioPoolBaseName, rtClientBaseName, nonRtClientBaseName, nonRtServerBaseName);
  1352. }
  1353. }
  1354. // -----------------------------------------------------------------------
  1355. CARLA_BACKEND_END_NAMESPACE
  1356. // -----------------------------------------------------------------------
  1357. #include "CarlaBridgeUtils.cpp"
  1358. // -----------------------------------------------------------------------