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.

1527 lines
61KB

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