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.

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