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.

1622 lines
60KB

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