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.

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