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.

1580 lines
59KB

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