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.

1446 lines
58KB

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