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.

1462 lines
59KB

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