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.

1573 lines
58KB

  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 CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  439. // kPluginBridgeNonRtServerPluginInfo1
  440. {
  441. // uint/category, uint/hints, uint/optionsAvailable, uint/optionsEnabled, long/uniqueId
  442. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPluginInfo1);
  443. fShmNonRtServerControl.writeUInt(plugin->getCategory());
  444. fShmNonRtServerControl.writeUInt(plugin->getHints());
  445. fShmNonRtServerControl.writeUInt(plugin->getOptionsAvailable());
  446. fShmNonRtServerControl.writeUInt(plugin->getOptionsEnabled());
  447. fShmNonRtServerControl.writeLong(plugin->getUniqueId());
  448. fShmNonRtServerControl.commitWrite();
  449. }
  450. // kPluginBridgeNonRtServerPluginInfo2
  451. {
  452. // uint/size, str[] (realName), uint/size, str[] (label), uint/size, str[] (maker), uint/size, str[] (copyright)
  453. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPluginInfo2);
  454. carla_zeroChars(bufStr, STR_MAX);
  455. plugin->getRealName(bufStr);
  456. bufStrSize = carla_fixedValue(1U, 64U, static_cast<uint32_t>(std::strlen(bufStr)));
  457. fShmNonRtServerControl.writeUInt(bufStrSize);
  458. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  459. carla_zeroChars(bufStr, STR_MAX);
  460. plugin->getLabel(bufStr);
  461. bufStrSize = carla_fixedValue(1U, 256U, static_cast<uint32_t>(std::strlen(bufStr)));
  462. fShmNonRtServerControl.writeUInt(bufStrSize);
  463. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  464. carla_zeroChars(bufStr, STR_MAX);
  465. plugin->getMaker(bufStr);
  466. bufStrSize = carla_fixedValue(1U, 64U, static_cast<uint32_t>(std::strlen(bufStr)));
  467. fShmNonRtServerControl.writeUInt(bufStrSize);
  468. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  469. carla_zeroChars(bufStr, STR_MAX);
  470. plugin->getCopyright(bufStr);
  471. bufStrSize = carla_fixedValue(1U, 64U, static_cast<uint32_t>(std::strlen(bufStr)));
  472. fShmNonRtServerControl.writeUInt(bufStrSize);
  473. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  474. fShmNonRtServerControl.commitWrite();
  475. }
  476. // kPluginBridgeNonRtServerAudioCount
  477. {
  478. // uint/ins, uint/outs
  479. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerAudioCount);
  480. fShmNonRtServerControl.writeUInt(plugin->getAudioInCount());
  481. fShmNonRtServerControl.writeUInt(plugin->getAudioOutCount());
  482. fShmNonRtServerControl.commitWrite();
  483. }
  484. // kPluginBridgeNonRtServerMidiCount
  485. {
  486. // uint/ins, uint/outs
  487. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerMidiCount);
  488. fShmNonRtServerControl.writeUInt(plugin->getMidiInCount());
  489. fShmNonRtServerControl.writeUInt(plugin->getMidiOutCount());
  490. fShmNonRtServerControl.commitWrite();
  491. }
  492. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  493. // kPluginBridgeNonRtServerParameter*
  494. if (const uint32_t count = plugin->getParameterCount())
  495. {
  496. // uint/count
  497. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterCount);
  498. fShmNonRtServerControl.writeUInt(count);
  499. fShmNonRtServerControl.commitWrite();
  500. for (uint32_t i=0; i<count; ++i)
  501. {
  502. const ParameterData& paramData(plugin->getParameterData(i));
  503. if (paramData.type != PARAMETER_INPUT && paramData.type != PARAMETER_OUTPUT)
  504. continue;
  505. if ((paramData.hints & PARAMETER_IS_ENABLED) == 0)
  506. continue;
  507. // kPluginBridgeNonRtServerParameterData1
  508. {
  509. // uint/index, int/rindex, uint/type, uint/hints, short/cc
  510. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterData1);
  511. fShmNonRtServerControl.writeUInt(i);
  512. fShmNonRtServerControl.writeInt(paramData.rindex);
  513. fShmNonRtServerControl.writeUInt(paramData.type);
  514. fShmNonRtServerControl.writeUInt(paramData.hints);
  515. fShmNonRtServerControl.writeShort(paramData.midiCC);
  516. fShmNonRtServerControl.commitWrite();
  517. }
  518. // kPluginBridgeNonRtServerParameterData2
  519. {
  520. // uint/index, uint/size, str[] (name), uint/size, str[] (symbol), uint/size, str[] (unit)
  521. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterData2);
  522. fShmNonRtServerControl.writeUInt(i);
  523. carla_zeroChars(bufStr, STR_MAX);
  524. plugin->getParameterName(i, bufStr);
  525. bufStrSize = carla_fixedValue(1U, 32U, static_cast<uint32_t>(std::strlen(bufStr)));
  526. fShmNonRtServerControl.writeUInt(bufStrSize);
  527. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  528. carla_zeroChars(bufStr, STR_MAX);
  529. plugin->getParameterSymbol(i, bufStr);
  530. bufStrSize = carla_fixedValue(1U, 64U, static_cast<uint32_t>(std::strlen(bufStr)));
  531. fShmNonRtServerControl.writeUInt(bufStrSize);
  532. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  533. carla_zeroChars(bufStr, STR_MAX);
  534. plugin->getParameterUnit(i, bufStr);
  535. bufStrSize = carla_fixedValue(1U, 32U, static_cast<uint32_t>(std::strlen(bufStr)));
  536. fShmNonRtServerControl.writeUInt(bufStrSize);
  537. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  538. fShmNonRtServerControl.commitWrite();
  539. }
  540. // kPluginBridgeNonRtServerParameterRanges
  541. {
  542. const ParameterRanges& paramRanges(plugin->getParameterRanges(i));
  543. // uint/index, float/def, float/min, float/max, float/step, float/stepSmall, float/stepLarge
  544. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterRanges);
  545. fShmNonRtServerControl.writeUInt(i);
  546. fShmNonRtServerControl.writeFloat(paramRanges.def);
  547. fShmNonRtServerControl.writeFloat(paramRanges.min);
  548. fShmNonRtServerControl.writeFloat(paramRanges.max);
  549. fShmNonRtServerControl.writeFloat(paramRanges.step);
  550. fShmNonRtServerControl.writeFloat(paramRanges.stepSmall);
  551. fShmNonRtServerControl.writeFloat(paramRanges.stepLarge);
  552. fShmNonRtServerControl.commitWrite();
  553. }
  554. // kPluginBridgeNonRtServerParameterValue2
  555. {
  556. // uint/index float/value (used for init/output parameters only, don't resend values)
  557. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterValue2);
  558. fShmNonRtServerControl.writeUInt(i);
  559. fShmNonRtServerControl.writeFloat(plugin->getParameterValue(i));
  560. fShmNonRtServerControl.commitWrite();
  561. }
  562. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  563. }
  564. }
  565. // kPluginBridgeNonRtServerProgram*
  566. if (const uint32_t count = plugin->getProgramCount())
  567. {
  568. // uint/count
  569. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerProgramCount);
  570. fShmNonRtServerControl.writeUInt(count);
  571. fShmNonRtServerControl.commitWrite();
  572. for (uint32_t i=0; i < count; ++i)
  573. {
  574. // uint/index, uint/size, str[] (name)
  575. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerProgramName);
  576. fShmNonRtServerControl.writeUInt(i);
  577. carla_zeroChars(bufStr, STR_MAX);
  578. plugin->getProgramName(i, bufStr);
  579. bufStrSize = carla_fixedValue(1U, 32U, static_cast<uint32_t>(std::strlen(bufStr)));
  580. fShmNonRtServerControl.writeUInt(bufStrSize);
  581. fShmNonRtServerControl.writeCustomData(bufStr, bufStrSize);
  582. fShmNonRtServerControl.commitWrite();
  583. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  584. }
  585. }
  586. // kPluginBridgeNonRtServerMidiProgram*
  587. if (const uint32_t count = plugin->getMidiProgramCount())
  588. {
  589. // uint/count
  590. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerMidiProgramCount);
  591. fShmNonRtServerControl.writeUInt(count);
  592. fShmNonRtServerControl.commitWrite();
  593. for (uint32_t i=0; i < count; ++i)
  594. {
  595. const MidiProgramData& mpData(plugin->getMidiProgramData(i));
  596. CARLA_SAFE_ASSERT_CONTINUE(mpData.name != nullptr);
  597. // uint/index, uint/bank, uint/program, uint/size, str[] (name)
  598. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerMidiProgramData);
  599. fShmNonRtServerControl.writeUInt(i);
  600. fShmNonRtServerControl.writeUInt(mpData.bank);
  601. fShmNonRtServerControl.writeUInt(mpData.program);
  602. bufStrSize = carla_fixedValue(1U, 32U, static_cast<uint32_t>(std::strlen(mpData.name)));
  603. fShmNonRtServerControl.writeUInt(bufStrSize);
  604. fShmNonRtServerControl.writeCustomData(mpData.name, bufStrSize);
  605. fShmNonRtServerControl.commitWrite();
  606. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  607. }
  608. }
  609. // ready!
  610. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerReady);
  611. fShmNonRtServerControl.commitWrite();
  612. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  613. carla_stdout("Carla Client Ready!");
  614. fLastPingTime = Time::currentTimeMillis();
  615. }
  616. // send parameter outputs
  617. if (const uint32_t count = plugin->getParameterCount())
  618. {
  619. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  620. for (uint32_t i=0; i < count; ++i)
  621. {
  622. if (! plugin->isParameterOutput(i))
  623. continue;
  624. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterValue2);
  625. fShmNonRtServerControl.writeUInt(i);
  626. fShmNonRtServerControl.writeFloat(plugin->getParameterValue(i));
  627. // parameter outputs are not that important, we can skip some
  628. if (! fShmNonRtServerControl.commitWrite())
  629. break;
  630. }
  631. }
  632. CarlaEngine::idle();
  633. try {
  634. handleNonRtData();
  635. } CARLA_SAFE_EXCEPTION("handleNonRtData");
  636. if (fLastPingTime > 0 && Time::currentTimeMillis() > fLastPingTime + 30000 && ! wasFirstIdle)
  637. {
  638. carla_stderr("Did not receive ping message from server for 30 secs, closing...");
  639. threadShouldExit();
  640. callback(ENGINE_CALLBACK_QUIT, 0, 0, 0, 0.0f, nullptr);
  641. }
  642. }
  643. void callback(const EngineCallbackOpcode action, const uint pluginId, const int value1, const int value2, const float value3, const char* const valueStr) noexcept override
  644. {
  645. CarlaEngine::callback(action, pluginId, value1, value2, value3, valueStr);
  646. if (fLastPingTime < 0)
  647. return;
  648. switch (action)
  649. {
  650. // uint/index float/value
  651. case ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED: {
  652. CARLA_SAFE_ASSERT_BREAK(value1 >= 0);
  653. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  654. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerParameterValue);
  655. fShmNonRtServerControl.writeUInt(static_cast<uint>(value1));
  656. fShmNonRtServerControl.writeFloat(value3);
  657. fShmNonRtServerControl.commitWrite();
  658. } break;
  659. // uint/index float/value
  660. case ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED: {
  661. CARLA_SAFE_ASSERT_BREAK(value1 >= 0);
  662. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  663. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerDefaultValue);
  664. fShmNonRtServerControl.writeUInt(static_cast<uint>(value1));
  665. fShmNonRtServerControl.writeFloat(value3);
  666. fShmNonRtServerControl.commitWrite();
  667. } break;
  668. // int/index
  669. case ENGINE_CALLBACK_PROGRAM_CHANGED: {
  670. CARLA_SAFE_ASSERT_BREAK(value1 >= -1);
  671. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  672. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerCurrentProgram);
  673. fShmNonRtServerControl.writeInt(value1);
  674. fShmNonRtServerControl.commitWrite();
  675. } break;
  676. // int/index
  677. case ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED: {
  678. CARLA_SAFE_ASSERT_BREAK(value1 >= -1);
  679. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  680. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerCurrentMidiProgram);
  681. fShmNonRtServerControl.writeInt(value1);
  682. fShmNonRtServerControl.commitWrite();
  683. } break;
  684. case ENGINE_CALLBACK_UI_STATE_CHANGED:
  685. if (value1 != 1)
  686. {
  687. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  688. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerUiClosed);
  689. fShmNonRtServerControl.commitWrite();
  690. }
  691. break;
  692. default:
  693. break;
  694. }
  695. }
  696. // -------------------------------------------------------------------
  697. void clear() noexcept
  698. {
  699. fShmAudioPool.clear();
  700. fShmRtClientControl.clear();
  701. fShmNonRtClientControl.clear();
  702. fShmNonRtServerControl.clear();
  703. }
  704. void handleNonRtData()
  705. {
  706. for (; fShmNonRtClientControl.isDataAvailableForReading();)
  707. {
  708. const PluginBridgeNonRtClientOpcode opcode(fShmNonRtClientControl.readOpcode());
  709. CarlaPlugin* const plugin(pData->plugins[0].plugin);
  710. #ifdef DEBUG
  711. if (opcode != kPluginBridgeNonRtClientPing) {
  712. carla_debug("CarlaEngineBridge::handleNonRtData() - got opcode: %s", PluginBridgeNonRtClientOpcode2str(opcode));
  713. }
  714. #endif
  715. if (opcode != kPluginBridgeNonRtClientNull && opcode != kPluginBridgeNonRtClientPingOnOff && fLastPingTime > 0)
  716. fLastPingTime = Time::currentTimeMillis();
  717. switch (opcode)
  718. {
  719. case kPluginBridgeNonRtClientNull:
  720. break;
  721. case kPluginBridgeNonRtClientPing: {
  722. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  723. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerPong);
  724. fShmNonRtServerControl.commitWrite();
  725. } break;
  726. case kPluginBridgeNonRtClientPingOnOff: {
  727. const uint32_t onOff(fShmNonRtClientControl.readBool());
  728. fLastPingTime = onOff ? Time::currentTimeMillis() : -1;
  729. } break;
  730. case kPluginBridgeNonRtClientActivate:
  731. if (plugin != nullptr && plugin->isEnabled())
  732. plugin->setActive(true, false, false);
  733. break;
  734. case kPluginBridgeNonRtClientDeactivate:
  735. if (plugin != nullptr && plugin->isEnabled())
  736. plugin->setActive(false, false, false);
  737. break;
  738. case kPluginBridgeNonRtClientSetBufferSize: {
  739. const uint32_t bufferSize(fShmNonRtClientControl.readUInt());
  740. pData->bufferSize = bufferSize;
  741. bufferSizeChanged(bufferSize);
  742. break;
  743. }
  744. case kPluginBridgeNonRtClientSetSampleRate: {
  745. const double sampleRate(fShmNonRtClientControl.readDouble());
  746. pData->sampleRate = sampleRate;
  747. sampleRateChanged(sampleRate);
  748. break;
  749. }
  750. case kPluginBridgeNonRtClientSetOffline:
  751. fIsOffline = true;
  752. offlineModeChanged(true);
  753. break;
  754. case kPluginBridgeNonRtClientSetOnline:
  755. fIsOffline = false;
  756. offlineModeChanged(false);
  757. break;
  758. case kPluginBridgeNonRtClientSetParameterValue: {
  759. const uint32_t index(fShmNonRtClientControl.readUInt());
  760. const float value(fShmNonRtClientControl.readFloat());
  761. if (plugin != nullptr && plugin->isEnabled())
  762. plugin->setParameterValue(index, value, false, false, false);
  763. break;
  764. }
  765. case kPluginBridgeNonRtClientSetParameterMidiChannel: {
  766. const uint32_t index(fShmNonRtClientControl.readUInt());
  767. const uint8_t channel(fShmNonRtClientControl.readByte());
  768. if (plugin != nullptr && plugin->isEnabled())
  769. plugin->setParameterMidiChannel(index, channel, false, false);
  770. break;
  771. }
  772. case kPluginBridgeNonRtClientSetParameterMidiCC: {
  773. const uint32_t index(fShmNonRtClientControl.readUInt());
  774. const int16_t cc(fShmNonRtClientControl.readShort());
  775. if (plugin != nullptr && plugin->isEnabled())
  776. plugin->setParameterMidiCC(index, cc, false, false);
  777. break;
  778. }
  779. case kPluginBridgeNonRtClientSetProgram: {
  780. const int32_t index(fShmNonRtClientControl.readInt());
  781. if (plugin != nullptr && plugin->isEnabled())
  782. plugin->setProgram(index, false, false, false);
  783. break;
  784. }
  785. case kPluginBridgeNonRtClientSetMidiProgram: {
  786. const int32_t index(fShmNonRtClientControl.readInt());
  787. if (plugin != nullptr && plugin->isEnabled())
  788. plugin->setMidiProgram(index, false, false, false);
  789. break;
  790. }
  791. case kPluginBridgeNonRtClientSetCustomData: {
  792. // type
  793. const uint32_t typeSize(fShmNonRtClientControl.readUInt());
  794. char typeStr[typeSize+1];
  795. carla_zeroChars(typeStr, typeSize+1);
  796. fShmNonRtClientControl.readCustomData(typeStr, typeSize);
  797. // key
  798. const uint32_t keySize(fShmNonRtClientControl.readUInt());
  799. char keyStr[keySize+1];
  800. carla_zeroChars(keyStr, keySize+1);
  801. fShmNonRtClientControl.readCustomData(keyStr, keySize);
  802. // value
  803. const uint32_t valueSize(fShmNonRtClientControl.readUInt());
  804. char valueStr[valueSize+1];
  805. carla_zeroChars(valueStr, valueSize+1);
  806. fShmNonRtClientControl.readCustomData(valueStr, valueSize);
  807. if (plugin != nullptr && plugin->isEnabled())
  808. plugin->setCustomData(typeStr, keyStr, valueStr, true);
  809. break;
  810. }
  811. case kPluginBridgeNonRtClientSetChunkDataFile: {
  812. const uint32_t size(fShmNonRtClientControl.readUInt());
  813. CARLA_SAFE_ASSERT_BREAK(size > 0);
  814. char chunkFilePathTry[size+1];
  815. carla_zeroChars(chunkFilePathTry, size+1);
  816. fShmNonRtClientControl.readCustomData(chunkFilePathTry, size);
  817. CARLA_SAFE_ASSERT_BREAK(chunkFilePathTry[0] != '\0');
  818. if (plugin == nullptr || ! plugin->isEnabled()) break;
  819. String chunkFilePath(chunkFilePathTry);
  820. #ifdef CARLA_OS_WIN
  821. // check if running under Wine
  822. if (chunkFilePath.startsWith("/"))
  823. chunkFilePath = chunkFilePath.replaceSection(0, 1, "Z:\\").replace("/", "\\");
  824. #endif
  825. File chunkFile(chunkFilePath);
  826. CARLA_SAFE_ASSERT_BREAK(chunkFile.existsAsFile());
  827. String chunkDataBase64(chunkFile.loadFileAsString());
  828. chunkFile.deleteFile();
  829. CARLA_SAFE_ASSERT_BREAK(chunkDataBase64.isNotEmpty());
  830. std::vector<uint8_t> chunk(carla_getChunkFromBase64String(chunkDataBase64.toRawUTF8()));
  831. plugin->setChunkData(chunk.data(), chunk.size());
  832. break;
  833. }
  834. case kPluginBridgeNonRtClientSetCtrlChannel: {
  835. const int16_t channel(fShmNonRtClientControl.readShort());
  836. CARLA_SAFE_ASSERT_BREAK(channel >= -1 && channel < MAX_MIDI_CHANNELS);
  837. if (plugin != nullptr && plugin->isEnabled())
  838. plugin->setCtrlChannel(static_cast<int8_t>(channel), false, false);
  839. break;
  840. }
  841. case kPluginBridgeNonRtClientSetOption: {
  842. const uint32_t option(fShmNonRtClientControl.readUInt());
  843. const bool yesNo(fShmNonRtClientControl.readBool());
  844. if (plugin != nullptr && plugin->isEnabled())
  845. plugin->setOption(option, yesNo, false);
  846. break;
  847. }
  848. case kPluginBridgeNonRtClientPrepareForSave: {
  849. if (plugin == nullptr || ! plugin->isEnabled()) break;
  850. plugin->prepareForSave();
  851. for (uint32_t i=0, count=plugin->getCustomDataCount(); i<count; ++i)
  852. {
  853. const CustomData& cdata(plugin->getCustomData(i));
  854. if (std::strcmp(cdata.type, CUSTOM_DATA_TYPE_STRING) == 0 && std::strcmp(cdata.key, "CarlaLoadLv2StateNow") == 0 && std::strcmp(cdata.value, "true") == 0)
  855. continue;
  856. const uint32_t typeLen(static_cast<uint32_t>(std::strlen(cdata.type)));
  857. const uint32_t keyLen(static_cast<uint32_t>(std::strlen(cdata.key)));
  858. const uint32_t valueLen(static_cast<uint32_t>(std::strlen(cdata.value)));
  859. {
  860. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  861. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSetCustomData);
  862. fShmNonRtServerControl.writeUInt(typeLen);
  863. fShmNonRtServerControl.writeCustomData(cdata.type, typeLen);
  864. fShmNonRtServerControl.writeUInt(keyLen);
  865. fShmNonRtServerControl.writeCustomData(cdata.key, keyLen);
  866. fShmNonRtServerControl.writeUInt(valueLen);
  867. fShmNonRtServerControl.writeCustomData(cdata.value, valueLen);
  868. fShmNonRtServerControl.commitWrite();
  869. fShmNonRtServerControl.waitIfDataIsReachingLimit();
  870. }
  871. }
  872. if (plugin->getOptionsEnabled() & PLUGIN_OPTION_USE_CHUNKS)
  873. {
  874. void* data = nullptr;
  875. if (const std::size_t dataSize = plugin->getChunkData(&data))
  876. {
  877. CARLA_SAFE_ASSERT_BREAK(data != nullptr);
  878. CarlaString dataBase64 = CarlaString::asBase64(data, dataSize);
  879. CARLA_SAFE_ASSERT_BREAK(dataBase64.length() > 0);
  880. String filePath(File::getSpecialLocation(File::tempDirectory).getFullPathName());
  881. filePath += CARLA_OS_SEP_STR;
  882. filePath += ".CarlaChunk_";
  883. filePath += fShmNonRtClientControl.filename.buffer() + 24;
  884. if (File(filePath).replaceWithText(dataBase64.buffer()))
  885. {
  886. const uint32_t ulength(static_cast<uint32_t>(filePath.length()));
  887. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  888. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSetChunkDataFile);
  889. fShmNonRtServerControl.writeUInt(ulength);
  890. fShmNonRtServerControl.writeCustomData(filePath.toRawUTF8(), ulength);
  891. fShmNonRtServerControl.commitWrite();
  892. }
  893. }
  894. }
  895. {
  896. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  897. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerSaved);
  898. fShmNonRtServerControl.commitWrite();
  899. }
  900. break;
  901. }
  902. case kPluginBridgeNonRtClientShowUI:
  903. if (plugin != nullptr && plugin->isEnabled())
  904. plugin->showCustomUI(true);
  905. break;
  906. case kPluginBridgeNonRtClientHideUI:
  907. if (plugin != nullptr && plugin->isEnabled())
  908. plugin->showCustomUI(false);
  909. break;
  910. case kPluginBridgeNonRtClientUiParameterChange: {
  911. const uint32_t index(fShmNonRtClientControl.readUInt());
  912. const float value(fShmNonRtClientControl.readFloat());
  913. if (plugin != nullptr && plugin->isEnabled())
  914. plugin->uiParameterChange(index, value);
  915. break;
  916. }
  917. case kPluginBridgeNonRtClientUiProgramChange: {
  918. const uint32_t index(fShmNonRtClientControl.readUInt());
  919. if (plugin != nullptr && plugin->isEnabled())
  920. plugin->uiProgramChange(index);
  921. break;
  922. }
  923. case kPluginBridgeNonRtClientUiMidiProgramChange: {
  924. const uint32_t index(fShmNonRtClientControl.readUInt());
  925. if (plugin != nullptr && plugin->isEnabled())
  926. plugin->uiMidiProgramChange(index);
  927. break;
  928. }
  929. case kPluginBridgeNonRtClientUiNoteOn: {
  930. const uint8_t chnl(fShmNonRtClientControl.readByte());
  931. const uint8_t note(fShmNonRtClientControl.readByte());
  932. const uint8_t velo(fShmNonRtClientControl.readByte());
  933. if (plugin != nullptr && plugin->isEnabled())
  934. plugin->uiNoteOn(chnl, note, velo);
  935. break;
  936. }
  937. case kPluginBridgeNonRtClientUiNoteOff: {
  938. const uint8_t chnl(fShmNonRtClientControl.readByte());
  939. const uint8_t note(fShmNonRtClientControl.readByte());
  940. if (plugin != nullptr && plugin->isEnabled())
  941. plugin->uiNoteOff(chnl, note);
  942. break;
  943. }
  944. case kPluginBridgeNonRtClientQuit:
  945. signalThreadShouldExit();
  946. callback(ENGINE_CALLBACK_QUIT, 0, 0, 0, 0.0f, nullptr);
  947. break;
  948. }
  949. }
  950. }
  951. // -------------------------------------------------------------------
  952. protected:
  953. void run() override
  954. {
  955. bool quitReceived = false;
  956. for (; ! threadShouldExit();)
  957. {
  958. const BridgeRtClientControl::WaitHelper helper(fShmRtClientControl);
  959. if (! helper.ok)
  960. continue;
  961. for (; fShmRtClientControl.isDataAvailableForReading();)
  962. {
  963. const PluginBridgeRtClientOpcode opcode(fShmRtClientControl.readOpcode());
  964. CarlaPlugin* const plugin(pData->plugins[0].plugin);
  965. #ifdef DEBUG
  966. if (opcode != kPluginBridgeRtClientProcess && opcode != kPluginBridgeRtClientMidiEvent) {
  967. carla_debug("CarlaEngineBridgeRtThread::run() - got opcode: %s", PluginBridgeRtClientOpcode2str(opcode));
  968. }
  969. #endif
  970. switch (opcode)
  971. {
  972. case kPluginBridgeRtClientNull:
  973. break;
  974. case kPluginBridgeRtClientSetAudioPool: {
  975. if (fShmAudioPool.data != nullptr)
  976. {
  977. jackbridge_shm_unmap(fShmAudioPool.shm, fShmAudioPool.data);
  978. fShmAudioPool.data = nullptr;
  979. }
  980. const uint64_t poolSize(fShmRtClientControl.readULong());
  981. CARLA_SAFE_ASSERT_BREAK(poolSize > 0);
  982. fShmAudioPool.data = (float*)jackbridge_shm_map(fShmAudioPool.shm, static_cast<size_t>(poolSize));
  983. break;
  984. }
  985. case kPluginBridgeRtClientControlEventParameter: {
  986. const uint32_t time(fShmRtClientControl.readUInt());
  987. const uint8_t channel(fShmRtClientControl.readByte());
  988. const uint16_t param(fShmRtClientControl.readUShort());
  989. const float value(fShmRtClientControl.readFloat());
  990. if (EngineEvent* const event = getNextFreeInputEvent())
  991. {
  992. event->type = kEngineEventTypeControl;
  993. event->time = time;
  994. event->channel = channel;
  995. event->ctrl.type = kEngineControlEventTypeParameter;
  996. event->ctrl.param = param;
  997. event->ctrl.value = value;
  998. }
  999. break;
  1000. }
  1001. case kPluginBridgeRtClientControlEventMidiBank: {
  1002. const uint32_t time(fShmRtClientControl.readUInt());
  1003. const uint8_t channel(fShmRtClientControl.readByte());
  1004. const uint16_t index(fShmRtClientControl.readUShort());
  1005. if (EngineEvent* const event = getNextFreeInputEvent())
  1006. {
  1007. event->type = kEngineEventTypeControl;
  1008. event->time = time;
  1009. event->channel = channel;
  1010. event->ctrl.type = kEngineControlEventTypeMidiBank;
  1011. event->ctrl.param = index;
  1012. event->ctrl.value = 0.0f;
  1013. }
  1014. break;
  1015. }
  1016. case kPluginBridgeRtClientControlEventMidiProgram: {
  1017. const uint32_t time(fShmRtClientControl.readUInt());
  1018. const uint8_t channel(fShmRtClientControl.readByte());
  1019. const uint16_t index(fShmRtClientControl.readUShort());
  1020. if (EngineEvent* const event = getNextFreeInputEvent())
  1021. {
  1022. event->type = kEngineEventTypeControl;
  1023. event->time = time;
  1024. event->channel = channel;
  1025. event->ctrl.type = kEngineControlEventTypeMidiProgram;
  1026. event->ctrl.param = index;
  1027. event->ctrl.value = 0.0f;
  1028. }
  1029. break;
  1030. }
  1031. case kPluginBridgeRtClientControlEventAllSoundOff: {
  1032. const uint32_t time(fShmRtClientControl.readUInt());
  1033. const uint8_t channel(fShmRtClientControl.readByte());
  1034. if (EngineEvent* const event = getNextFreeInputEvent())
  1035. {
  1036. event->type = kEngineEventTypeControl;
  1037. event->time = time;
  1038. event->channel = channel;
  1039. event->ctrl.type = kEngineControlEventTypeAllSoundOff;
  1040. event->ctrl.param = 0;
  1041. event->ctrl.value = 0.0f;
  1042. }
  1043. } break;
  1044. case kPluginBridgeRtClientControlEventAllNotesOff: {
  1045. const uint32_t time(fShmRtClientControl.readUInt());
  1046. const uint8_t channel(fShmRtClientControl.readByte());
  1047. if (EngineEvent* const event = getNextFreeInputEvent())
  1048. {
  1049. event->type = kEngineEventTypeControl;
  1050. event->time = time;
  1051. event->channel = channel;
  1052. event->ctrl.type = kEngineControlEventTypeAllNotesOff;
  1053. event->ctrl.param = 0;
  1054. event->ctrl.value = 0.0f;
  1055. }
  1056. } break;
  1057. case kPluginBridgeRtClientMidiEvent: {
  1058. const uint32_t time(fShmRtClientControl.readUInt());
  1059. const uint8_t port(fShmRtClientControl.readByte());
  1060. const uint8_t size(fShmRtClientControl.readByte());
  1061. CARLA_SAFE_ASSERT_BREAK(size > 0);
  1062. uint8_t data[size];
  1063. for (uint8_t i=0; i<size; ++i)
  1064. data[i] = fShmRtClientControl.readByte();
  1065. if (EngineEvent* const event = getNextFreeInputEvent())
  1066. {
  1067. event->type = kEngineEventTypeMidi;
  1068. event->time = time;
  1069. event->channel = MIDI_GET_CHANNEL_FROM_DATA(data);
  1070. event->midi.port = port;
  1071. event->midi.size = size;
  1072. if (size > EngineMidiEvent::kDataSize)
  1073. {
  1074. event->midi.dataExt = data;
  1075. std::memset(event->midi.data, 0, sizeof(uint8_t)*EngineMidiEvent::kDataSize);
  1076. }
  1077. else
  1078. {
  1079. event->midi.data[0] = MIDI_GET_STATUS_FROM_DATA(data);
  1080. uint8_t i=1;
  1081. for (; i < size; ++i)
  1082. event->midi.data[i] = data[i];
  1083. for (; i < EngineMidiEvent::kDataSize; ++i)
  1084. event->midi.data[i] = 0;
  1085. event->midi.dataExt = nullptr;
  1086. }
  1087. }
  1088. break;
  1089. }
  1090. case kPluginBridgeRtClientProcess: {
  1091. CARLA_SAFE_ASSERT_BREAK(fShmAudioPool.data != nullptr);
  1092. if (plugin != nullptr && plugin->isEnabled() && plugin->tryLock(false))
  1093. {
  1094. const BridgeTimeInfo& bridgeTimeInfo(fShmRtClientControl.data->timeInfo);
  1095. const uint32_t audioInCount(plugin->getAudioInCount());
  1096. const uint32_t audioOutCount(plugin->getAudioOutCount());
  1097. const uint32_t cvInCount(plugin->getCVInCount());
  1098. const uint32_t cvOutCount(plugin->getCVOutCount());
  1099. const float* audioIn[audioInCount];
  1100. /* */ float* audioOut[audioOutCount];
  1101. const float* cvIn[cvInCount];
  1102. /* */ float* cvOut[cvOutCount];
  1103. float* fdata = fShmAudioPool.data;
  1104. for (uint32_t i=0; i < audioInCount; ++i, fdata += pData->bufferSize)
  1105. audioIn[i] = fdata;
  1106. for (uint32_t i=0; i < audioOutCount; ++i, fdata += pData->bufferSize)
  1107. audioOut[i] = fdata;
  1108. for (uint32_t i=0; i < cvInCount; ++i, fdata += pData->bufferSize)
  1109. cvIn[i] = fdata;
  1110. for (uint32_t i=0; i < cvOutCount; ++i, fdata += pData->bufferSize)
  1111. cvOut[i] = fdata;
  1112. EngineTimeInfo& timeInfo(pData->timeInfo);
  1113. timeInfo.playing = bridgeTimeInfo.playing;
  1114. timeInfo.frame = bridgeTimeInfo.frame;
  1115. timeInfo.usecs = bridgeTimeInfo.usecs;
  1116. timeInfo.valid = bridgeTimeInfo.valid;
  1117. if (timeInfo.valid & EngineTimeInfo::kValidBBT)
  1118. {
  1119. timeInfo.bbt.bar = bridgeTimeInfo.bar;
  1120. timeInfo.bbt.beat = bridgeTimeInfo.beat;
  1121. timeInfo.bbt.tick = bridgeTimeInfo.tick;
  1122. timeInfo.bbt.beatsPerBar = bridgeTimeInfo.beatsPerBar;
  1123. timeInfo.bbt.beatType = bridgeTimeInfo.beatType;
  1124. timeInfo.bbt.ticksPerBeat = bridgeTimeInfo.ticksPerBeat;
  1125. timeInfo.bbt.beatsPerMinute = bridgeTimeInfo.beatsPerMinute;
  1126. timeInfo.bbt.barStartTick = bridgeTimeInfo.barStartTick;
  1127. }
  1128. plugin->initBuffers();
  1129. plugin->process(audioIn, audioOut, cvIn, cvOut, pData->bufferSize);
  1130. plugin->unlock();
  1131. }
  1132. uint8_t* midiData(fShmRtClientControl.data->midiOut);
  1133. carla_zeroBytes(midiData, kBridgeRtClientDataMidiOutSize);
  1134. std::size_t curMidiDataPos = 0;
  1135. if (pData->events.in[0].type != kEngineEventTypeNull)
  1136. carla_zeroStructs(pData->events.in, kMaxEngineEventInternalCount);
  1137. if (pData->events.out[0].type != kEngineEventTypeNull)
  1138. {
  1139. for (ushort i=0; i < kMaxEngineEventInternalCount; ++i)
  1140. {
  1141. const EngineEvent& event(pData->events.out[i]);
  1142. if (event.type == kEngineEventTypeNull)
  1143. break;
  1144. if (event.type == kEngineEventTypeControl)
  1145. {
  1146. uint8_t size;
  1147. uint8_t data[3];
  1148. event.ctrl.convertToMidiData(event.channel, size, data);
  1149. CARLA_SAFE_ASSERT_CONTINUE(size > 0 && size <= 3);
  1150. if (curMidiDataPos + 1U /* size*/ + 4U /* time */ + size >= kBridgeRtClientDataMidiOutSize)
  1151. break;
  1152. // set size
  1153. *midiData++ = size;
  1154. // set time
  1155. *(uint32_t*)midiData = event.time;
  1156. midiData = midiData + 4;
  1157. // set data
  1158. for (uint8_t j=0; j<size; ++j)
  1159. *midiData++ = data[j];
  1160. curMidiDataPos += 1U /* size*/ + 4U /* time */ + size;
  1161. }
  1162. else if (event.type == kEngineEventTypeMidi)
  1163. {
  1164. const EngineMidiEvent& _midiEvent(event.midi);
  1165. if (curMidiDataPos + 1 /* size*/ + 4 /* time */ + _midiEvent.size >= kBridgeRtClientDataMidiOutSize)
  1166. break;
  1167. const uint8_t* const _midiData(_midiEvent.dataExt != nullptr ? _midiEvent.dataExt : _midiEvent.data);
  1168. // set size
  1169. *midiData++ = _midiEvent.size;
  1170. // set time
  1171. *(uint32_t*)midiData = event.time;
  1172. midiData = midiData + 4;
  1173. // set data
  1174. *midiData++ = uint8_t(_midiData[0] | (event.channel & MIDI_CHANNEL_BIT));
  1175. for (uint8_t j=1; j<_midiEvent.size; ++j)
  1176. *midiData++ = _midiData[j];
  1177. curMidiDataPos += 1U /* size*/ + 4U /* time */ + _midiEvent.size;
  1178. }
  1179. }
  1180. carla_zeroStructs(pData->events.out, kMaxEngineEventInternalCount);
  1181. }
  1182. } break;
  1183. case kPluginBridgeRtClientQuit: {
  1184. quitReceived = true;
  1185. signalThreadShouldExit();
  1186. } break;
  1187. }
  1188. }
  1189. }
  1190. callback(ENGINE_CALLBACK_ENGINE_STOPPED, 0, 0, 0, 0.0f, nullptr);
  1191. if (! quitReceived)
  1192. {
  1193. const char* const message("Plugin bridge error, process thread has stopped");
  1194. const std::size_t messageSize(std::strlen(message));
  1195. const CarlaMutexLocker _cml(fShmNonRtServerControl.mutex);
  1196. fShmNonRtServerControl.writeOpcode(kPluginBridgeNonRtServerError);
  1197. fShmNonRtServerControl.writeUInt(messageSize);
  1198. fShmNonRtServerControl.writeCustomData(message, messageSize);
  1199. fShmNonRtServerControl.commitWrite();
  1200. }
  1201. }
  1202. // called from process thread above
  1203. EngineEvent* getNextFreeInputEvent() const noexcept
  1204. {
  1205. for (ushort i=0; i < kMaxEngineEventInternalCount; ++i)
  1206. {
  1207. EngineEvent* const event(&pData->events.in[i]);
  1208. if (event->type == kEngineEventTypeNull)
  1209. return event;
  1210. }
  1211. return nullptr;
  1212. }
  1213. // -------------------------------------------------------------------
  1214. private:
  1215. BridgeAudioPool fShmAudioPool;
  1216. BridgeRtClientControl fShmRtClientControl;
  1217. BridgeNonRtClientControl fShmNonRtClientControl;
  1218. BridgeNonRtServerControl fShmNonRtServerControl;
  1219. bool fIsOffline;
  1220. bool fFirstIdle;
  1221. int64_t fLastPingTime;
  1222. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineBridge)
  1223. };
  1224. // -----------------------------------------------------------------------
  1225. CarlaEngine* CarlaEngine::newBridge(const char* const audioPoolBaseName, const char* const rtClientBaseName, const char* const nonRtClientBaseName, const char* const nonRtServerBaseName)
  1226. {
  1227. return new CarlaEngineBridge(audioPoolBaseName, rtClientBaseName, nonRtClientBaseName, nonRtServerBaseName);
  1228. }
  1229. // -----------------------------------------------------------------------
  1230. #ifdef BRIDGE_PLUGIN
  1231. CarlaPlugin* CarlaPlugin::newNative(const CarlaPlugin::Initializer&) { return nullptr; }
  1232. CarlaPlugin* CarlaPlugin::newFileGIG(const CarlaPlugin::Initializer&, const bool) { return nullptr; }
  1233. CarlaPlugin* CarlaPlugin::newFileSF2(const CarlaPlugin::Initializer&, const bool) { return nullptr; }
  1234. CarlaPlugin* CarlaPlugin::newFileSFZ(const CarlaPlugin::Initializer&) { return nullptr; }
  1235. #endif
  1236. CARLA_BACKEND_END_NAMESPACE
  1237. // -----------------------------------------------------------------------
  1238. #if defined(CARLA_OS_WIN) && ! defined(__WINE__)
  1239. extern "C" __declspec (dllexport)
  1240. #else
  1241. extern "C" __attribute__ ((visibility("default")))
  1242. #endif
  1243. void carla_register_native_plugin_carla();
  1244. void carla_register_native_plugin_carla(){}
  1245. // -----------------------------------------------------------------------