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.

2715 lines
92KB

  1. /*
  2. * Carla Plugin Bridge
  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. #if defined(BUILD_BRIDGE) && defined(BRIDGE_PLUGIN)
  18. # error This file should be used under bridge mode
  19. #endif
  20. #include "CarlaPluginInternal.hpp"
  21. #include "CarlaBackendUtils.hpp"
  22. #include "CarlaBase64Utils.hpp"
  23. #include "CarlaBridgeUtils.hpp"
  24. #include "CarlaEngineUtils.hpp"
  25. #include "CarlaMathUtils.hpp"
  26. #include "CarlaShmUtils.hpp"
  27. #include "CarlaThread.hpp"
  28. #include "jackbridge/JackBridge.hpp"
  29. #include <ctime>
  30. // -------------------------------------------------------------------------------------------------------------------
  31. using juce::ChildProcess;
  32. using juce::File;
  33. using juce::ScopedPointer;
  34. using juce::String;
  35. using juce::StringArray;
  36. using juce::Time;
  37. CARLA_BACKEND_START_NAMESPACE
  38. // -------------------------------------------------------------------------------------------------------------------
  39. struct BridgeAudioPool {
  40. CarlaString filename;
  41. std::size_t size;
  42. float* data;
  43. carla_shm_t shm;
  44. BridgeAudioPool() noexcept
  45. : filename(),
  46. size(0),
  47. data(nullptr)
  48. #ifdef CARLA_PROPER_CPP11_SUPPORT
  49. , shm(carla_shm_t_INIT) {}
  50. #else
  51. {
  52. carla_shm_init(shm);
  53. }
  54. #endif
  55. ~BridgeAudioPool() noexcept
  56. {
  57. // should be cleared by now
  58. CARLA_SAFE_ASSERT(data == nullptr);
  59. clear();
  60. }
  61. bool initialize() noexcept
  62. {
  63. char tmpFileBase[64];
  64. std::sprintf(tmpFileBase, PLUGIN_BRIDGE_NAMEPREFIX_AUDIO_POOL "XXXXXX");
  65. shm = carla_shm_create_temp(tmpFileBase);
  66. CARLA_SAFE_ASSERT_RETURN(carla_is_shm_valid(shm), false);
  67. filename = tmpFileBase;
  68. return true;
  69. }
  70. void clear() noexcept
  71. {
  72. filename.clear();
  73. if (! carla_is_shm_valid(shm))
  74. {
  75. CARLA_SAFE_ASSERT(data == nullptr);
  76. return;
  77. }
  78. if (data != nullptr)
  79. {
  80. carla_shm_unmap(shm, data);
  81. data = nullptr;
  82. }
  83. size = 0;
  84. carla_shm_close(shm);
  85. carla_shm_init(shm);
  86. }
  87. void resize(const uint32_t bufferSize, const uint32_t audioPortCount, const uint32_t cvPortCount) noexcept
  88. {
  89. CARLA_SAFE_ASSERT_RETURN(carla_is_shm_valid(shm),);
  90. if (data != nullptr)
  91. carla_shm_unmap(shm, data);
  92. size = (audioPortCount+cvPortCount)*bufferSize*sizeof(float);
  93. if (size == 0)
  94. size = sizeof(float);
  95. data = (float*)carla_shm_map(shm, size);
  96. std::memset(data, 0, size);
  97. }
  98. CARLA_DECLARE_NON_COPY_STRUCT(BridgeAudioPool)
  99. };
  100. // -------------------------------------------------------------------------------------------------------------------
  101. struct BridgeRtClientControl : public CarlaRingBufferControl<SmallStackBuffer> {
  102. BridgeRtClientData* data;
  103. CarlaString filename;
  104. bool needsSemDestroy;
  105. carla_shm_t shm;
  106. BridgeRtClientControl()
  107. : data(nullptr),
  108. filename(),
  109. needsSemDestroy(false)
  110. #ifdef CARLA_PROPER_CPP11_SUPPORT
  111. , shm(carla_shm_t_INIT) {}
  112. #else
  113. {
  114. carla_shm_init(shm);
  115. }
  116. #endif
  117. ~BridgeRtClientControl() noexcept override
  118. {
  119. // should be cleared by now
  120. CARLA_SAFE_ASSERT(data == nullptr);
  121. clear();
  122. }
  123. bool initialize() noexcept
  124. {
  125. char tmpFileBase[64];
  126. std::sprintf(tmpFileBase, PLUGIN_BRIDGE_NAMEPREFIX_RT_CLIENT "XXXXXX");
  127. shm = carla_shm_create_temp(tmpFileBase);
  128. CARLA_SAFE_ASSERT_RETURN(carla_is_shm_valid(shm), false);
  129. if (! mapData())
  130. {
  131. carla_shm_close(shm);
  132. carla_shm_init(shm);
  133. return false;
  134. }
  135. CARLA_SAFE_ASSERT(data != nullptr);
  136. if (! jackbridge_sem_init(&data->sem.server))
  137. {
  138. unmapData();
  139. carla_shm_close(shm);
  140. carla_shm_init(shm);
  141. return false;
  142. }
  143. if (! jackbridge_sem_init(&data->sem.client))
  144. {
  145. jackbridge_sem_destroy(&data->sem.server);
  146. unmapData();
  147. carla_shm_close(shm);
  148. carla_shm_init(shm);
  149. return false;
  150. }
  151. filename = tmpFileBase;
  152. needsSemDestroy = true;
  153. return true;
  154. }
  155. void clear() noexcept
  156. {
  157. filename.clear();
  158. if (needsSemDestroy)
  159. {
  160. jackbridge_sem_destroy(&data->sem.client);
  161. jackbridge_sem_destroy(&data->sem.server);
  162. needsSemDestroy = false;
  163. }
  164. if (data != nullptr)
  165. unmapData();
  166. if (! carla_is_shm_valid(shm))
  167. return;
  168. carla_shm_close(shm);
  169. carla_shm_init(shm);
  170. }
  171. bool mapData() noexcept
  172. {
  173. CARLA_SAFE_ASSERT(data == nullptr);
  174. if (carla_shm_map<BridgeRtClientData>(shm, data))
  175. {
  176. std::memset(data, 0, sizeof(BridgeRtClientData));
  177. setRingBuffer(&data->ringBuffer, true);
  178. return true;
  179. }
  180. return false;
  181. }
  182. void unmapData() noexcept
  183. {
  184. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  185. carla_shm_unmap(shm, data);
  186. data = nullptr;
  187. setRingBuffer(nullptr, false);
  188. }
  189. bool waitForClient(const uint msecs) noexcept
  190. {
  191. CARLA_SAFE_ASSERT_RETURN(data != nullptr, false);
  192. jackbridge_sem_post(&data->sem.server);
  193. return jackbridge_sem_timedwait(&data->sem.client, msecs);
  194. }
  195. void writeOpcode(const PluginBridgeRtClientOpcode opcode) noexcept
  196. {
  197. writeUInt(static_cast<uint32_t>(opcode));
  198. }
  199. CARLA_DECLARE_NON_COPY_STRUCT(BridgeRtClientControl)
  200. };
  201. // -------------------------------------------------------------------------------------------------------------------
  202. struct BridgeNonRtClientControl : public CarlaRingBufferControl<BigStackBuffer> {
  203. BridgeNonRtClientData* data;
  204. CarlaString filename;
  205. CarlaMutex mutex;
  206. carla_shm_t shm;
  207. BridgeNonRtClientControl() noexcept
  208. : data(nullptr),
  209. filename(),
  210. mutex()
  211. #ifdef CARLA_PROPER_CPP11_SUPPORT
  212. , shm(carla_shm_t_INIT) {}
  213. #else
  214. {
  215. carla_shm_init(shm);
  216. }
  217. #endif
  218. ~BridgeNonRtClientControl() noexcept override
  219. {
  220. // should be cleared by now
  221. CARLA_SAFE_ASSERT(data == nullptr);
  222. clear();
  223. }
  224. bool initialize() noexcept
  225. {
  226. char tmpFileBase[64];
  227. std::sprintf(tmpFileBase, PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_CLIENT "XXXXXX");
  228. shm = carla_shm_create_temp(tmpFileBase);
  229. CARLA_SAFE_ASSERT_RETURN(carla_is_shm_valid(shm), false);
  230. if (! mapData())
  231. {
  232. carla_shm_close(shm);
  233. carla_shm_init(shm);
  234. return false;
  235. }
  236. CARLA_SAFE_ASSERT(data != nullptr);
  237. filename = tmpFileBase;
  238. return true;
  239. }
  240. void clear() noexcept
  241. {
  242. filename.clear();
  243. if (data != nullptr)
  244. unmapData();
  245. if (! carla_is_shm_valid(shm))
  246. return;
  247. carla_shm_close(shm);
  248. carla_shm_init(shm);
  249. }
  250. bool mapData() noexcept
  251. {
  252. CARLA_SAFE_ASSERT(data == nullptr);
  253. if (carla_shm_map<BridgeNonRtClientData>(shm, data))
  254. {
  255. setRingBuffer(&data->ringBuffer, true);
  256. return true;
  257. }
  258. return false;
  259. }
  260. void unmapData() noexcept
  261. {
  262. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  263. carla_shm_unmap(shm, data);
  264. data = nullptr;
  265. setRingBuffer(nullptr, false);
  266. }
  267. void writeOpcode(const PluginBridgeNonRtClientOpcode opcode) noexcept
  268. {
  269. writeUInt(static_cast<uint32_t>(opcode));
  270. }
  271. void waitIfDataIsReachingLimit() noexcept
  272. {
  273. if (getAvailableDataSize() < BigStackBuffer::size/4)
  274. return;
  275. for (int i=50; --i >= 0;)
  276. {
  277. if (getAvailableDataSize() >= BigStackBuffer::size*3/4)
  278. {
  279. //carla_stdout("Server waitIfDataIsReachingLimit() reached and waited successfully");
  280. writeOpcode(kPluginBridgeNonRtClientPing);
  281. commitWrite();
  282. return;
  283. }
  284. carla_msleep(20);
  285. }
  286. carla_stderr("Server waitIfDataIsReachingLimit() reached and failed");
  287. }
  288. CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtClientControl)
  289. };
  290. // -------------------------------------------------------------------------------------------------------------------
  291. struct BridgeNonRtServerControl : public CarlaRingBufferControl<HugeStackBuffer> {
  292. BridgeNonRtServerData* data;
  293. CarlaString filename;
  294. carla_shm_t shm;
  295. BridgeNonRtServerControl() noexcept
  296. : data(nullptr),
  297. filename()
  298. #ifdef CARLA_PROPER_CPP11_SUPPORT
  299. , shm(carla_shm_t_INIT) {}
  300. #else
  301. {
  302. carla_shm_init(shm);
  303. }
  304. #endif
  305. ~BridgeNonRtServerControl() noexcept override
  306. {
  307. // should be cleared by now
  308. CARLA_SAFE_ASSERT(data == nullptr);
  309. clear();
  310. }
  311. bool initialize() noexcept
  312. {
  313. char tmpFileBase[64];
  314. std::sprintf(tmpFileBase, PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_SERVER "XXXXXX");
  315. shm = carla_shm_create_temp(tmpFileBase);
  316. if (! carla_is_shm_valid(shm))
  317. return false;
  318. if (! mapData())
  319. {
  320. carla_shm_close(shm);
  321. carla_shm_init(shm);
  322. return false;
  323. }
  324. CARLA_SAFE_ASSERT(data != nullptr);
  325. filename = tmpFileBase;
  326. return true;
  327. }
  328. void clear() noexcept
  329. {
  330. filename.clear();
  331. if (data != nullptr)
  332. unmapData();
  333. if (! carla_is_shm_valid(shm))
  334. return;
  335. carla_shm_close(shm);
  336. carla_shm_init(shm);
  337. }
  338. bool mapData() noexcept
  339. {
  340. CARLA_SAFE_ASSERT(data == nullptr);
  341. if (carla_shm_map<BridgeNonRtServerData>(shm, data))
  342. {
  343. setRingBuffer(&data->ringBuffer, true);
  344. return true;
  345. }
  346. return false;
  347. }
  348. void unmapData() noexcept
  349. {
  350. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  351. carla_shm_unmap(shm, data);
  352. data = nullptr;
  353. setRingBuffer(nullptr, false);
  354. }
  355. PluginBridgeNonRtServerOpcode readOpcode() noexcept
  356. {
  357. return static_cast<PluginBridgeNonRtServerOpcode>(readUInt());
  358. }
  359. CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtServerControl)
  360. };
  361. // -------------------------------------------------------------------------------------------------------------------
  362. struct BridgeParamInfo {
  363. float value;
  364. CarlaString name;
  365. CarlaString symbol;
  366. CarlaString unit;
  367. BridgeParamInfo() noexcept
  368. : value(0.0f),
  369. name(),
  370. symbol(),
  371. unit() {}
  372. CARLA_DECLARE_NON_COPY_STRUCT(BridgeParamInfo)
  373. };
  374. // -------------------------------------------------------------------------------------------------------------------
  375. class CarlaPluginBridgeThread : public CarlaThread
  376. {
  377. public:
  378. CarlaPluginBridgeThread(CarlaEngine* const engine, CarlaPlugin* const plugin) noexcept
  379. : CarlaThread("CarlaPluginBridgeThread"),
  380. kEngine(engine),
  381. kPlugin(plugin),
  382. fBinary(),
  383. fLabel(),
  384. fShmIds(),
  385. fProcess() {}
  386. void setData(const char* const binary, const char* const label, const char* const shmIds) noexcept
  387. {
  388. CARLA_SAFE_ASSERT_RETURN(binary != nullptr && binary[0] != '\0',);
  389. CARLA_SAFE_ASSERT_RETURN(shmIds != nullptr && shmIds[0] != '\0',);
  390. CARLA_SAFE_ASSERT(! isThreadRunning());
  391. fBinary = binary;
  392. fShmIds = shmIds;
  393. if (label != nullptr)
  394. fLabel = label;
  395. if (fLabel.isEmpty())
  396. fLabel = "\"\"";
  397. }
  398. uintptr_t getProcessPID() const noexcept
  399. {
  400. CARLA_SAFE_ASSERT_RETURN(fProcess != nullptr, 0);
  401. return (uintptr_t)fProcess->getPID();
  402. }
  403. protected:
  404. void run()
  405. {
  406. if (fProcess == nullptr)
  407. {
  408. fProcess = new ChildProcess();
  409. }
  410. else if (fProcess->isRunning())
  411. {
  412. carla_stderr("CarlaPluginBridgeThread::run() - already running, giving up...");
  413. }
  414. String name(kPlugin->getName());
  415. String filename(kPlugin->getFilename());
  416. if (name.isEmpty())
  417. name = "(none)";
  418. if (filename.isEmpty())
  419. filename = "\"\"";
  420. StringArray arguments;
  421. #ifndef CARLA_OS_WIN
  422. // start with "wine" if needed
  423. if (fBinary.endsWithIgnoreCase(".exe"))
  424. arguments.add("wine");
  425. #endif
  426. // binary
  427. arguments.add(fBinary);
  428. // plugin type
  429. arguments.add(getPluginTypeAsString(kPlugin->getType()));
  430. // filename
  431. arguments.add(filename);
  432. // label
  433. arguments.add(fLabel);
  434. // uniqueId
  435. arguments.add(String(static_cast<juce::int64>(kPlugin->getUniqueId())));
  436. bool started;
  437. {
  438. char strBuf[STR_MAX+1];
  439. strBuf[STR_MAX] = '\0';
  440. const EngineOptions& options(kEngine->getOptions());
  441. const ScopedEngineEnvironmentLocker _seel(kEngine);
  442. #ifdef CARLA_OS_LINUX
  443. const char* const oldPreload(std::getenv("LD_PRELOAD"));
  444. if (oldPreload != nullptr)
  445. ::unsetenv("LD_PRELOAD");
  446. #endif
  447. carla_setenv("ENGINE_OPTION_FORCE_STEREO", bool2str(options.forceStereo));
  448. carla_setenv("ENGINE_OPTION_PREFER_PLUGIN_BRIDGES", bool2str(options.preferPluginBridges));
  449. carla_setenv("ENGINE_OPTION_PREFER_UI_BRIDGES", bool2str(options.preferUiBridges));
  450. carla_setenv("ENGINE_OPTION_UIS_ALWAYS_ON_TOP", bool2str(options.uisAlwaysOnTop));
  451. std::snprintf(strBuf, STR_MAX, "%u", options.maxParameters);
  452. carla_setenv("ENGINE_OPTION_MAX_PARAMETERS", strBuf);
  453. std::snprintf(strBuf, STR_MAX, "%u", options.uiBridgesTimeout);
  454. carla_setenv("ENGINE_OPTION_UI_BRIDGES_TIMEOUT",strBuf);
  455. if (options.pathLADSPA != nullptr)
  456. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LADSPA", options.pathLADSPA);
  457. else
  458. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LADSPA", "");
  459. if (options.pathDSSI != nullptr)
  460. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_DSSI", options.pathDSSI);
  461. else
  462. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_DSSI", "");
  463. if (options.pathLV2 != nullptr)
  464. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LV2", options.pathLV2);
  465. else
  466. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LV2", "");
  467. if (options.pathVST2 != nullptr)
  468. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST2", options.pathVST2);
  469. else
  470. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST2", "");
  471. if (options.pathVST3 != nullptr)
  472. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST3", options.pathVST3);
  473. else
  474. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST3", "");
  475. if (options.pathGIG != nullptr)
  476. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_GIG", options.pathGIG);
  477. else
  478. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_GIG", "");
  479. if (options.pathSF2 != nullptr)
  480. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SF2", options.pathSF2);
  481. else
  482. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SF2", "");
  483. if (options.pathSFZ != nullptr)
  484. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SFZ", options.pathSFZ);
  485. else
  486. carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SFZ", "");
  487. if (options.binaryDir != nullptr)
  488. carla_setenv("ENGINE_OPTION_PATH_BINARIES", options.binaryDir);
  489. else
  490. carla_setenv("ENGINE_OPTION_PATH_BINARIES", "");
  491. if (options.resourceDir != nullptr)
  492. carla_setenv("ENGINE_OPTION_PATH_RESOURCES", options.resourceDir);
  493. else
  494. carla_setenv("ENGINE_OPTION_PATH_RESOURCES", "");
  495. carla_setenv("ENGINE_OPTION_PREVENT_BAD_BEHAVIOUR", bool2str(options.preventBadBehaviour));
  496. std::snprintf(strBuf, STR_MAX, P_UINTPTR, options.frontendWinId);
  497. carla_setenv("ENGINE_OPTION_FRONTEND_WIN_ID", strBuf);
  498. carla_setenv("ENGINE_BRIDGE_SHM_IDS", fShmIds.toRawUTF8());
  499. carla_setenv("WINEDEBUG", "-all");
  500. carla_stdout("starting plugin bridge, command is:\n%s \"%s\" \"%s\" \"%s\" " P_INT64,
  501. fBinary.toRawUTF8(), getPluginTypeAsString(kPlugin->getType()), filename.toRawUTF8(), fLabel.toRawUTF8(), kPlugin->getUniqueId());
  502. started = fProcess->start(arguments);
  503. #ifdef CARLA_OS_LINUX
  504. if (oldPreload != nullptr)
  505. ::setenv("LD_PRELOAD", oldPreload, 1);
  506. #endif
  507. }
  508. if (! started)
  509. {
  510. carla_stdout("failed!");
  511. fProcess = nullptr;
  512. return;
  513. }
  514. for (; fProcess->isRunning() && ! shouldThreadExit();)
  515. carla_sleep(1);
  516. // we only get here if bridge crashed or thread asked to exit
  517. if (fProcess->isRunning() && shouldThreadExit())
  518. {
  519. fProcess->waitForProcessToFinish(2000);
  520. if (fProcess->isRunning())
  521. {
  522. carla_stdout("CarlaPluginBridgeThread::run() - bridge refused to close, force kill now");
  523. fProcess->kill();
  524. }
  525. else
  526. {
  527. carla_stdout("CarlaPluginBridgeThread::run() - bridge auto-closed successfully");
  528. }
  529. }
  530. else
  531. {
  532. // forced quit, may have crashed
  533. if (fProcess->getExitCode() != 0 /*|| fProcess->exitStatus() == QProcess::CrashExit*/)
  534. {
  535. carla_stderr("CarlaPluginBridgeThread::run() - bridge crashed");
  536. CarlaString errorString("Plugin '" + CarlaString(kPlugin->getName()) + "' has crashed!\n"
  537. "Saving now will lose its current settings.\n"
  538. "Please remove this plugin, and not rely on it from this point.");
  539. kEngine->callback(CarlaBackend::ENGINE_CALLBACK_ERROR, kPlugin->getId(), 0, 0, 0.0f, errorString);
  540. }
  541. else
  542. carla_stderr("CarlaPluginBridgeThread::run() - bridge closed cleanly");
  543. }
  544. carla_stdout("plugin bridge finished");
  545. fProcess = nullptr;
  546. }
  547. private:
  548. CarlaEngine* const kEngine;
  549. CarlaPlugin* const kPlugin;
  550. String fBinary;
  551. String fLabel;
  552. String fShmIds;
  553. ScopedPointer<ChildProcess> fProcess;
  554. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaPluginBridgeThread)
  555. };
  556. // -------------------------------------------------------------------------------------------------------------------
  557. class CarlaPluginBridge : public CarlaPlugin
  558. {
  559. public:
  560. CarlaPluginBridge(CarlaEngine* const engine, const uint id, const BinaryType btype, const PluginType ptype)
  561. : CarlaPlugin(engine, id),
  562. fBinaryType(btype),
  563. fPluginType(ptype),
  564. fInitiated(false),
  565. fInitError(false),
  566. fSaved(true),
  567. fTimedOut(false),
  568. fTimedError(false),
  569. fProcWaitTime(0),
  570. fLastPongTime(-1),
  571. fBridgeBinary(),
  572. fBridgeThread(engine, this),
  573. fShmAudioPool(),
  574. fShmRtClientControl(),
  575. fShmNonRtClientControl(),
  576. fShmNonRtServerControl(),
  577. fInfo(),
  578. fUniqueId(0),
  579. fParams(nullptr)
  580. {
  581. carla_debug("CarlaPluginBridge::CarlaPluginBridge(%p, %i, %s, %s)", engine, id, BinaryType2Str(btype), PluginType2Str(ptype));
  582. pData->hints |= PLUGIN_IS_BRIDGE;
  583. }
  584. ~CarlaPluginBridge() override
  585. {
  586. carla_debug("CarlaPluginBridge::~CarlaPluginBridge()");
  587. // close UI
  588. if (pData->hints & PLUGIN_HAS_CUSTOM_UI)
  589. pData->transientTryCounter = 0;
  590. pData->singleMutex.lock();
  591. pData->masterMutex.lock();
  592. if (pData->client != nullptr && pData->client->isActive())
  593. pData->client->deactivate();
  594. if (pData->active)
  595. {
  596. deactivate();
  597. pData->active = false;
  598. }
  599. if (fBridgeThread.isThreadRunning())
  600. {
  601. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientQuit);
  602. fShmNonRtClientControl.commitWrite();
  603. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientQuit);
  604. fShmRtClientControl.commitWrite();
  605. if (! fTimedOut)
  606. waitForClient("stopping", 3000);
  607. }
  608. fBridgeThread.stopThread(3000);
  609. fShmNonRtServerControl.clear();
  610. fShmNonRtClientControl.clear();
  611. fShmRtClientControl.clear();
  612. fShmAudioPool.clear();
  613. clearBuffers();
  614. fInfo.chunk.clear();
  615. }
  616. // -------------------------------------------------------------------
  617. // Information (base)
  618. BinaryType getBinaryType() const noexcept override
  619. {
  620. return fBinaryType;
  621. }
  622. PluginType getType() const noexcept override
  623. {
  624. return fPluginType;
  625. }
  626. PluginCategory getCategory() const noexcept override
  627. {
  628. return fInfo.category;
  629. }
  630. int64_t getUniqueId() const noexcept override
  631. {
  632. return fUniqueId;
  633. }
  634. // -------------------------------------------------------------------
  635. // Information (count)
  636. uint32_t getMidiInCount() const noexcept override
  637. {
  638. return fInfo.mIns;
  639. }
  640. uint32_t getMidiOutCount() const noexcept override
  641. {
  642. return fInfo.mOuts;
  643. }
  644. // -------------------------------------------------------------------
  645. // Information (current data)
  646. // TODO - missing getCustomData
  647. std::size_t getChunkData(void** const dataPtr) noexcept override
  648. {
  649. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS, 0);
  650. CARLA_SAFE_ASSERT_RETURN(dataPtr != nullptr, 0);
  651. waitForSaved();
  652. CARLA_SAFE_ASSERT_RETURN(fInfo.chunk.size() > 0, 0);
  653. *dataPtr = fInfo.chunk.data();
  654. return fInfo.chunk.size();
  655. }
  656. // -------------------------------------------------------------------
  657. // Information (per-plugin data)
  658. uint getOptionsAvailable() const noexcept override
  659. {
  660. return fInfo.optionsAvailable;
  661. }
  662. float getParameterValue(const uint32_t parameterId) const noexcept override
  663. {
  664. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, 0.0f);
  665. return fParams[parameterId].value;
  666. }
  667. void getLabel(char* const strBuf) const noexcept override
  668. {
  669. std::strncpy(strBuf, fInfo.label, STR_MAX);
  670. }
  671. void getMaker(char* const strBuf) const noexcept override
  672. {
  673. std::strncpy(strBuf, fInfo.maker, STR_MAX);
  674. }
  675. void getCopyright(char* const strBuf) const noexcept override
  676. {
  677. std::strncpy(strBuf, fInfo.copyright, STR_MAX);
  678. }
  679. void getRealName(char* const strBuf) const noexcept override
  680. {
  681. std::strncpy(strBuf, fInfo.name, STR_MAX);
  682. }
  683. void getParameterName(const uint32_t parameterId, char* const strBuf) const noexcept override
  684. {
  685. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, nullStrBuf(strBuf));
  686. std::strncpy(strBuf, fParams[parameterId].name.buffer(), STR_MAX);
  687. }
  688. void getParameterSymbol(const uint32_t parameterId, char* const strBuf) const noexcept override
  689. {
  690. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, nullStrBuf(strBuf));
  691. std::strncpy(strBuf, fParams[parameterId].symbol.buffer(), STR_MAX);
  692. }
  693. void getParameterUnit(const uint32_t parameterId, char* const strBuf) const noexcept override
  694. {
  695. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, nullStrBuf(strBuf));
  696. std::strncpy(strBuf, fParams[parameterId].unit.buffer(), STR_MAX);
  697. }
  698. // -------------------------------------------------------------------
  699. // Set data (state)
  700. void prepareForSave() noexcept override
  701. {
  702. fSaved = false;
  703. {
  704. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  705. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPrepareForSave);
  706. fShmNonRtClientControl.commitWrite();
  707. }
  708. }
  709. void waitForSaved()
  710. {
  711. if (fSaved)
  712. return;
  713. // TODO: only wait 1 minute for NI plugins
  714. const uint32_t timeoutEnd(Time::getMillisecondCounter() + 60*1000); // 60 secs, 1 minute
  715. const bool needsEngineIdle(pData->engine->getType() != kEngineTypePlugin);
  716. carla_stdout("CarlaPluginBridge::waitForSaved() - now waiting...");
  717. for (; Time::getMillisecondCounter() < timeoutEnd && fBridgeThread.isThreadRunning();)
  718. {
  719. pData->engine->callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  720. if (needsEngineIdle)
  721. pData->engine->idle();
  722. if (fSaved)
  723. break;
  724. carla_msleep(20);
  725. }
  726. if (! fSaved)
  727. carla_stderr("CarlaPluginBridge::waitForSaved() - Timeout while requesting save state");
  728. else
  729. carla_stdout("CarlaPluginBridge::waitForSaved() - success!");
  730. }
  731. // -------------------------------------------------------------------
  732. // Set data (internal stuff)
  733. void setOption(const uint option, const bool yesNo, const bool sendCallback) override
  734. {
  735. {
  736. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  737. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetOption);
  738. fShmNonRtClientControl.writeUInt(option);
  739. fShmNonRtClientControl.writeBool(yesNo);
  740. fShmNonRtClientControl.commitWrite();
  741. }
  742. CarlaPlugin::setOption(option, yesNo, sendCallback);
  743. }
  744. void setCtrlChannel(const int8_t channel, const bool sendOsc, const bool sendCallback) noexcept override
  745. {
  746. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  747. {
  748. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  749. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetCtrlChannel);
  750. fShmNonRtClientControl.writeShort(channel);
  751. fShmNonRtClientControl.commitWrite();
  752. }
  753. CarlaPlugin::setCtrlChannel(channel, sendOsc, sendCallback);
  754. }
  755. // -------------------------------------------------------------------
  756. // Set data (plugin-specific stuff)
  757. void setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  758. {
  759. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback,); // never call this from RT
  760. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  761. const float fixedValue(pData->param.getFixedValue(parameterId, value));
  762. fParams[parameterId].value = fixedValue;
  763. {
  764. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  765. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterValue);
  766. fShmNonRtClientControl.writeUInt(parameterId);
  767. fShmNonRtClientControl.writeFloat(value);
  768. fShmNonRtClientControl.commitWrite();
  769. fShmNonRtClientControl.waitIfDataIsReachingLimit();
  770. }
  771. CarlaPlugin::setParameterValue(parameterId, fixedValue, sendGui, sendOsc, sendCallback);
  772. }
  773. void setParameterMidiChannel(const uint32_t parameterId, const uint8_t channel, const bool sendOsc, const bool sendCallback) noexcept override
  774. {
  775. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  776. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  777. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  778. {
  779. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  780. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterMidiChannel);
  781. fShmNonRtClientControl.writeUInt(parameterId);
  782. fShmNonRtClientControl.writeByte(channel);
  783. fShmNonRtClientControl.commitWrite();
  784. }
  785. CarlaPlugin::setParameterMidiChannel(parameterId, channel, sendOsc, sendCallback);
  786. }
  787. void setParameterMidiCC(const uint32_t parameterId, const int16_t cc, const bool sendOsc, const bool sendCallback) noexcept override
  788. {
  789. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  790. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  791. CARLA_SAFE_ASSERT_RETURN(cc >= -1 && cc < MAX_MIDI_CONTROL,);
  792. {
  793. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  794. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetParameterMidiCC);
  795. fShmNonRtClientControl.writeUInt(parameterId);
  796. fShmNonRtClientControl.writeShort(cc);
  797. fShmNonRtClientControl.commitWrite();
  798. }
  799. CarlaPlugin::setParameterMidiCC(parameterId, cc, sendOsc, sendCallback);
  800. }
  801. void setProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  802. {
  803. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback,); // never call this from RT
  804. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->prog.count),);
  805. {
  806. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  807. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetProgram);
  808. fShmNonRtClientControl.writeInt(index);
  809. fShmNonRtClientControl.commitWrite();
  810. }
  811. CarlaPlugin::setProgram(index, sendGui, sendOsc, sendCallback);
  812. }
  813. void setMidiProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  814. {
  815. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback,); // never call this from RT
  816. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->midiprog.count),);
  817. {
  818. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  819. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetMidiProgram);
  820. fShmNonRtClientControl.writeInt(index);
  821. fShmNonRtClientControl.commitWrite();
  822. }
  823. CarlaPlugin::setMidiProgram(index, sendGui, sendOsc, sendCallback);
  824. }
  825. void setCustomData(const char* const type, const char* const key, const char* const value, const bool sendGui) override
  826. {
  827. CARLA_SAFE_ASSERT_RETURN(type != nullptr && type[0] != '\0',);
  828. CARLA_SAFE_ASSERT_RETURN(key != nullptr && key[0] != '\0',);
  829. CARLA_SAFE_ASSERT_RETURN(value != nullptr,);
  830. if (std::strcmp(type, CUSTOM_DATA_TYPE_PROPERTY) == 0)
  831. return CarlaPlugin::setCustomData(type, key, value, sendGui);
  832. if (std::strcmp(type, CUSTOM_DATA_TYPE_STRING) == 0 && std::strcmp(key, "__CarlaPingOnOff__") == 0)
  833. {
  834. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  835. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPingOnOff);
  836. fShmNonRtClientControl.writeBool(std::strcmp(value, "true") == 0);
  837. fShmNonRtClientControl.commitWrite();
  838. carla_stdout("Carla bridge server side, OnOff ping checks => %s", value);
  839. return;
  840. }
  841. const uint32_t typeLen(static_cast<uint32_t>(std::strlen(type)));
  842. const uint32_t keyLen(static_cast<uint32_t>(std::strlen(key)));
  843. const uint32_t valueLen(static_cast<uint32_t>(std::strlen(value)));
  844. {
  845. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  846. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetCustomData);
  847. fShmNonRtClientControl.writeUInt(typeLen);
  848. fShmNonRtClientControl.writeCustomData(type, typeLen);
  849. fShmNonRtClientControl.writeUInt(keyLen);
  850. fShmNonRtClientControl.writeCustomData(key, keyLen);
  851. fShmNonRtClientControl.writeUInt(valueLen);
  852. fShmNonRtClientControl.writeCustomData(value, valueLen);
  853. fShmNonRtClientControl.commitWrite();
  854. }
  855. CarlaPlugin::setCustomData(type, key, value, sendGui);
  856. }
  857. void setChunkData(const void* const data, const std::size_t dataSize) override
  858. {
  859. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS,);
  860. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  861. CARLA_SAFE_ASSERT_RETURN(dataSize > 0,);
  862. carla_stdout("Carla bridge server side, setChunkData 001");
  863. CarlaString dataBase64(CarlaString::asBase64(data, dataSize));
  864. CARLA_SAFE_ASSERT_RETURN(dataBase64.length() > 0,);
  865. String filePath(File::getSpecialLocation(File::tempDirectory).getFullPathName());
  866. filePath += CARLA_OS_SEP_STR ".CarlaChunk_";
  867. filePath += fShmAudioPool.filename.buffer() + 18;
  868. if (File(filePath).replaceWithText(dataBase64.buffer()))
  869. {
  870. carla_stdout("Carla bridge server side, setChunkData 002");
  871. const uint32_t ulength(static_cast<uint32_t>(filePath.length()));
  872. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  873. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetChunkDataFile);
  874. fShmNonRtClientControl.writeUInt(ulength);
  875. fShmNonRtClientControl.writeCustomData(filePath.toRawUTF8(), ulength);
  876. fShmNonRtClientControl.commitWrite();
  877. carla_stdout("Carla bridge server side, setChunkData sent");
  878. }
  879. // save data internally as well
  880. fInfo.chunk.resize(dataSize);
  881. std::memcpy(fInfo.chunk.data(), data, dataSize);
  882. carla_stdout("Carla bridge server side, setChunkData saved locally too");
  883. }
  884. // -------------------------------------------------------------------
  885. // Set ui stuff
  886. void showCustomUI(const bool yesNo) override
  887. {
  888. {
  889. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  890. fShmNonRtClientControl.writeOpcode(yesNo ? kPluginBridgeNonRtClientShowUI : kPluginBridgeNonRtClientHideUI);
  891. fShmNonRtClientControl.commitWrite();
  892. }
  893. #ifndef BUILD_BRIDGE
  894. if (yesNo)
  895. {
  896. pData->tryTransient();
  897. }
  898. else
  899. {
  900. pData->transientTryCounter = 0;
  901. }
  902. #endif
  903. }
  904. void idle() override
  905. {
  906. if (fBridgeThread.isThreadRunning())
  907. {
  908. if (fInitiated && fTimedOut && pData->active)
  909. setActive(false, true, true);
  910. {
  911. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  912. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientPing);
  913. fShmNonRtClientControl.commitWrite();
  914. }
  915. try {
  916. handleNonRtData();
  917. } CARLA_SAFE_EXCEPTION("handleNonRtData");
  918. }
  919. else if (fInitiated)
  920. {
  921. fTimedOut = true;
  922. fTimedError = true;
  923. fInitiated = false;
  924. pData->engine->callback(ENGINE_CALLBACK_PLUGIN_UNAVAILABLE, pData->id, 0, 0, 0.0f, "plugin bridge has been stopped or crashed");
  925. }
  926. CarlaPlugin::idle();
  927. }
  928. // -------------------------------------------------------------------
  929. // Plugin state
  930. void reload() override
  931. {
  932. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr,);
  933. carla_debug("CarlaPluginBridge::reload() - start");
  934. const EngineProcessMode processMode(pData->engine->getProccessMode());
  935. // Safely disable plugin for reload
  936. const ScopedDisabler sd(this);
  937. // cleanup of previous data
  938. pData->audioIn.clear();
  939. pData->audioOut.clear();
  940. pData->cvIn.clear();
  941. pData->cvOut.clear();
  942. pData->event.clear();
  943. bool needsCtrlIn, needsCtrlOut;
  944. needsCtrlIn = needsCtrlOut = false;
  945. if (fInfo.aIns > 0)
  946. {
  947. pData->audioIn.createNew(fInfo.aIns);
  948. }
  949. if (fInfo.aOuts > 0)
  950. {
  951. pData->audioOut.createNew(fInfo.aOuts);
  952. needsCtrlIn = true;
  953. }
  954. if (fInfo.cvIns > 0)
  955. {
  956. pData->cvIn.createNew(fInfo.cvIns);
  957. }
  958. if (fInfo.cvOuts > 0)
  959. {
  960. pData->cvOut.createNew(fInfo.cvOuts);
  961. }
  962. if (fInfo.mIns > 0)
  963. needsCtrlIn = true;
  964. if (fInfo.mOuts > 0)
  965. needsCtrlOut = true;
  966. const uint portNameSize(pData->engine->getMaxPortNameSize());
  967. CarlaString portName;
  968. // Audio Ins
  969. for (uint32_t j=0; j < fInfo.aIns; ++j)
  970. {
  971. portName.clear();
  972. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  973. {
  974. portName = pData->name;
  975. portName += ":";
  976. }
  977. if (fInfo.aIns > 1)
  978. {
  979. portName += "input_";
  980. portName += CarlaString(j+1);
  981. }
  982. else
  983. portName += "input";
  984. portName.truncate(portNameSize);
  985. pData->audioIn.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, true, j);
  986. pData->audioIn.ports[j].rindex = j;
  987. }
  988. // Audio Outs
  989. for (uint32_t j=0; j < fInfo.aOuts; ++j)
  990. {
  991. portName.clear();
  992. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  993. {
  994. portName = pData->name;
  995. portName += ":";
  996. }
  997. if (fInfo.aOuts > 1)
  998. {
  999. portName += "output_";
  1000. portName += CarlaString(j+1);
  1001. }
  1002. else
  1003. portName += "output";
  1004. portName.truncate(portNameSize);
  1005. pData->audioOut.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, false, j);
  1006. pData->audioOut.ports[j].rindex = j;
  1007. }
  1008. // TODO - CV
  1009. if (needsCtrlIn)
  1010. {
  1011. portName.clear();
  1012. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  1013. {
  1014. portName = pData->name;
  1015. portName += ":";
  1016. }
  1017. portName += "event-in";
  1018. portName.truncate(portNameSize);
  1019. pData->event.portIn = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, true, 0);
  1020. }
  1021. if (needsCtrlOut)
  1022. {
  1023. portName.clear();
  1024. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  1025. {
  1026. portName = pData->name;
  1027. portName += ":";
  1028. }
  1029. portName += "event-out";
  1030. portName.truncate(portNameSize);
  1031. pData->event.portOut = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, false, 0);
  1032. }
  1033. // extra plugin hints
  1034. pData->extraHints = 0x0;
  1035. if (fInfo.mIns > 0)
  1036. pData->extraHints |= PLUGIN_EXTRA_HINT_HAS_MIDI_IN;
  1037. if (fInfo.mOuts > 0)
  1038. pData->extraHints |= PLUGIN_EXTRA_HINT_HAS_MIDI_OUT;
  1039. if (fInfo.aIns <= 2 && fInfo.aOuts <= 2 && (fInfo.aIns == fInfo.aOuts || fInfo.aIns == 0 || fInfo.aOuts == 0))
  1040. pData->extraHints |= PLUGIN_EXTRA_HINT_CAN_RUN_RACK;
  1041. bufferSizeChanged(pData->engine->getBufferSize());
  1042. reloadPrograms(true);
  1043. carla_debug("CarlaPluginBridge::reload() - end");
  1044. }
  1045. // -------------------------------------------------------------------
  1046. // Plugin processing
  1047. void activate() noexcept override
  1048. {
  1049. CARLA_SAFE_ASSERT_RETURN(! fTimedError,);
  1050. {
  1051. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1052. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientActivate);
  1053. fShmNonRtClientControl.commitWrite();
  1054. }
  1055. fTimedOut = false;
  1056. try {
  1057. waitForClient("activate", 2000);
  1058. } CARLA_SAFE_EXCEPTION("activate - waitForClient");
  1059. }
  1060. void deactivate() noexcept override
  1061. {
  1062. CARLA_SAFE_ASSERT_RETURN(! fTimedError,);
  1063. {
  1064. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1065. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientDeactivate);
  1066. fShmNonRtClientControl.commitWrite();
  1067. }
  1068. fTimedOut = false;
  1069. try {
  1070. waitForClient("deactivate", 2000);
  1071. } CARLA_SAFE_EXCEPTION("deactivate - waitForClient");
  1072. }
  1073. void process(const float** const audioIn, float** const audioOut, const float** const cvIn, float** const cvOut, const uint32_t frames) override
  1074. {
  1075. // --------------------------------------------------------------------------------------------------------
  1076. // Check if active
  1077. if (fTimedOut || fTimedError || ! pData->active)
  1078. {
  1079. // disable any output sound
  1080. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  1081. FloatVectorOperations::clear(audioOut[i], static_cast<int>(frames));
  1082. for (uint32_t i=0; i < pData->cvOut.count; ++i)
  1083. FloatVectorOperations::clear(cvOut[i], static_cast<int>(frames));
  1084. return;
  1085. }
  1086. // --------------------------------------------------------------------------------------------------------
  1087. // Check if needs reset
  1088. if (pData->needsReset)
  1089. {
  1090. // TODO
  1091. pData->needsReset = false;
  1092. }
  1093. // --------------------------------------------------------------------------------------------------------
  1094. // Event Input
  1095. if (pData->event.portIn != nullptr)
  1096. {
  1097. // ----------------------------------------------------------------------------------------------------
  1098. // MIDI Input (External)
  1099. if (pData->extNotes.mutex.tryLock())
  1100. {
  1101. for (RtLinkedList<ExternalMidiNote>::Itenerator it = pData->extNotes.data.begin2(); it.valid(); it.next())
  1102. {
  1103. const ExternalMidiNote& note(it.getValue());
  1104. CARLA_SAFE_ASSERT_CONTINUE(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS);
  1105. uint8_t data1, data2, data3;
  1106. data1 = uint8_t((note.velo > 0 ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF) | (note.channel & MIDI_CHANNEL_BIT));
  1107. data2 = note.note;
  1108. data3 = note.velo;
  1109. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientMidiEvent);
  1110. fShmRtClientControl.writeUInt(0); // time
  1111. fShmRtClientControl.writeByte(0); // port
  1112. fShmRtClientControl.writeByte(3); // size
  1113. fShmRtClientControl.writeByte(data1);
  1114. fShmRtClientControl.writeByte(data2);
  1115. fShmRtClientControl.writeByte(data3);
  1116. fShmRtClientControl.commitWrite();
  1117. }
  1118. pData->extNotes.data.clear();
  1119. pData->extNotes.mutex.unlock();
  1120. } // End of MIDI Input (External)
  1121. // ----------------------------------------------------------------------------------------------------
  1122. // Event Input (System)
  1123. #ifndef BUILD_BRIDGE
  1124. bool allNotesOffSent = false;
  1125. #endif
  1126. for (uint32_t i=0, numEvents=pData->event.portIn->getEventCount(); i < numEvents; ++i)
  1127. {
  1128. const EngineEvent& event(pData->event.portIn->getEvent(i));
  1129. // Control change
  1130. switch (event.type)
  1131. {
  1132. case kEngineEventTypeNull:
  1133. break;
  1134. case kEngineEventTypeControl: {
  1135. const EngineControlEvent& ctrlEvent = event.ctrl;
  1136. switch (ctrlEvent.type)
  1137. {
  1138. case kEngineControlEventTypeNull:
  1139. break;
  1140. case kEngineControlEventTypeParameter:
  1141. #ifndef BUILD_BRIDGE
  1142. // Control backend stuff
  1143. if (event.channel == pData->ctrlChannel)
  1144. {
  1145. float value;
  1146. if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_DRYWET) != 0)
  1147. {
  1148. value = ctrlEvent.value;
  1149. setDryWet(value, false, false);
  1150. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_DRYWET, 0, value);
  1151. break;
  1152. }
  1153. if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_VOLUME) != 0)
  1154. {
  1155. value = ctrlEvent.value*127.0f/100.0f;
  1156. setVolume(value, false, false);
  1157. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_VOLUME, 0, value);
  1158. break;
  1159. }
  1160. if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_BALANCE) != 0)
  1161. {
  1162. float left, right;
  1163. value = ctrlEvent.value/0.5f - 1.0f;
  1164. if (value < 0.0f)
  1165. {
  1166. left = -1.0f;
  1167. right = (value*2.0f)+1.0f;
  1168. }
  1169. else if (value > 0.0f)
  1170. {
  1171. left = (value*2.0f)-1.0f;
  1172. right = 1.0f;
  1173. }
  1174. else
  1175. {
  1176. left = -1.0f;
  1177. right = 1.0f;
  1178. }
  1179. setBalanceLeft(left, false, false);
  1180. setBalanceRight(right, false, false);
  1181. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_LEFT, 0, left);
  1182. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_RIGHT, 0, right);
  1183. break;
  1184. }
  1185. }
  1186. #endif
  1187. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventParameter);
  1188. fShmRtClientControl.writeUInt(event.time);
  1189. fShmRtClientControl.writeByte(event.channel);
  1190. fShmRtClientControl.writeUShort(event.ctrl.param);
  1191. fShmRtClientControl.writeFloat(event.ctrl.value);
  1192. fShmRtClientControl.commitWrite();
  1193. break;
  1194. case kEngineControlEventTypeMidiBank:
  1195. if (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES)
  1196. {
  1197. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventMidiBank);
  1198. fShmRtClientControl.writeUInt(event.time);
  1199. fShmRtClientControl.writeByte(event.channel);
  1200. fShmRtClientControl.writeUShort(event.ctrl.param);
  1201. fShmRtClientControl.commitWrite();
  1202. }
  1203. break;
  1204. case kEngineControlEventTypeMidiProgram:
  1205. if (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES)
  1206. {
  1207. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventMidiProgram);
  1208. fShmRtClientControl.writeUInt(event.time);
  1209. fShmRtClientControl.writeByte(event.channel);
  1210. fShmRtClientControl.writeUShort(event.ctrl.param);
  1211. fShmRtClientControl.commitWrite();
  1212. }
  1213. break;
  1214. case kEngineControlEventTypeAllSoundOff:
  1215. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  1216. {
  1217. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventAllSoundOff);
  1218. fShmRtClientControl.writeUInt(event.time);
  1219. fShmRtClientControl.writeByte(event.channel);
  1220. fShmRtClientControl.commitWrite();
  1221. }
  1222. break;
  1223. case kEngineControlEventTypeAllNotesOff:
  1224. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  1225. {
  1226. #ifndef BUILD_BRIDGE
  1227. if (event.channel == pData->ctrlChannel && ! allNotesOffSent)
  1228. {
  1229. allNotesOffSent = true;
  1230. sendMidiAllNotesOffToCallback();
  1231. }
  1232. #endif
  1233. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientControlEventAllNotesOff);
  1234. fShmRtClientControl.writeUInt(event.time);
  1235. fShmRtClientControl.writeByte(event.channel);
  1236. fShmRtClientControl.commitWrite();
  1237. }
  1238. break;
  1239. } // switch (ctrlEvent.type)
  1240. break;
  1241. } // case kEngineEventTypeControl
  1242. case kEngineEventTypeMidi: {
  1243. const EngineMidiEvent& midiEvent(event.midi);
  1244. if (midiEvent.size == 0 || midiEvent.size >= MAX_MIDI_VALUE)
  1245. continue;
  1246. const uint8_t* const midiData(midiEvent.size > EngineMidiEvent::kDataSize ? midiEvent.dataExt : midiEvent.data);
  1247. uint8_t status = uint8_t(MIDI_GET_STATUS_FROM_DATA(midiData));
  1248. if (status == MIDI_STATUS_CHANNEL_PRESSURE && (pData->options & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0)
  1249. continue;
  1250. if (status == MIDI_STATUS_CONTROL_CHANGE && (pData->options & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0)
  1251. continue;
  1252. if (status == MIDI_STATUS_POLYPHONIC_AFTERTOUCH && (pData->options & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0)
  1253. continue;
  1254. if (status == MIDI_STATUS_PITCH_WHEEL_CONTROL && (pData->options & PLUGIN_OPTION_SEND_PITCHBEND) == 0)
  1255. continue;
  1256. // Fix bad note-off
  1257. if (status == MIDI_STATUS_NOTE_ON && midiData[2] == 0)
  1258. status = MIDI_STATUS_NOTE_OFF;
  1259. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientMidiEvent);
  1260. fShmRtClientControl.writeUInt(event.time);
  1261. fShmRtClientControl.writeByte(midiEvent.port);
  1262. fShmRtClientControl.writeByte(midiEvent.size);
  1263. fShmRtClientControl.writeByte(uint8_t(midiData[0] | (event.channel & MIDI_CHANNEL_BIT)));
  1264. for (uint8_t j=1; j < midiEvent.size; ++j)
  1265. fShmRtClientControl.writeByte(midiData[j]);
  1266. fShmRtClientControl.commitWrite();
  1267. if (status == MIDI_STATUS_NOTE_ON)
  1268. pData->postponeRtEvent(kPluginPostRtEventNoteOn, event.channel, midiData[1], midiData[2]);
  1269. else if (status == MIDI_STATUS_NOTE_OFF)
  1270. pData->postponeRtEvent(kPluginPostRtEventNoteOff, event.channel, midiData[1], 0.0f);
  1271. } break;
  1272. }
  1273. }
  1274. pData->postRtEvents.trySplice();
  1275. } // End of Event Input
  1276. if (! processSingle(audioIn, audioOut, cvIn, cvOut, frames))
  1277. return;
  1278. // --------------------------------------------------------------------------------------------------------
  1279. // Control and MIDI Output
  1280. if (pData->event.portOut != nullptr)
  1281. {
  1282. float value;
  1283. for (uint32_t k=0; k < pData->param.count; ++k)
  1284. {
  1285. if (pData->param.data[k].type != PARAMETER_OUTPUT)
  1286. continue;
  1287. if (pData->param.data[k].midiCC > 0)
  1288. {
  1289. value = pData->param.ranges[k].getNormalizedValue(fParams[k].value);
  1290. pData->event.portOut->writeControlEvent(0, pData->param.data[k].midiChannel, kEngineControlEventTypeParameter, static_cast<uint16_t>(pData->param.data[k].midiCC), value);
  1291. }
  1292. }
  1293. uint8_t size;
  1294. uint32_t time;
  1295. const uint8_t* midiData(fShmRtClientControl.data->midiOut);
  1296. for (std::size_t read=0; read<kBridgeRtClientDataMidiOutSize;)
  1297. {
  1298. size = *midiData;
  1299. if (size == 0)
  1300. break;
  1301. // advance 8 bits (1 byte)
  1302. midiData = midiData + 1;
  1303. // get time as 32bit
  1304. time = *(const uint32_t*)midiData;
  1305. // advance 32 bits (4 bytes)
  1306. midiData = midiData + 4;
  1307. // store midi data advancing as needed
  1308. uint8_t data[size];
  1309. for (uint8_t j=0; j<size; ++j)
  1310. data[j] = *midiData++;
  1311. pData->event.portOut->writeMidiEvent(time, size, data);
  1312. read += 1U /* size*/ + 4U /* time */ + size;
  1313. }
  1314. } // End of Control and MIDI Output
  1315. }
  1316. bool processSingle(const float** const audioIn, float** const audioOut, const float** const cvIn, float** const cvOut, const uint32_t frames)
  1317. {
  1318. CARLA_SAFE_ASSERT_RETURN(! fTimedError, false);
  1319. CARLA_SAFE_ASSERT_RETURN(frames > 0, false);
  1320. if (pData->audioIn.count > 0)
  1321. {
  1322. CARLA_SAFE_ASSERT_RETURN(audioIn != nullptr, false);
  1323. }
  1324. if (pData->audioOut.count > 0)
  1325. {
  1326. CARLA_SAFE_ASSERT_RETURN(audioOut != nullptr, false);
  1327. }
  1328. if (pData->cvIn.count > 0)
  1329. {
  1330. CARLA_SAFE_ASSERT_RETURN(cvIn != nullptr, false);
  1331. }
  1332. if (pData->cvOut.count > 0)
  1333. {
  1334. CARLA_SAFE_ASSERT_RETURN(cvOut != nullptr, false);
  1335. }
  1336. // --------------------------------------------------------------------------------------------------------
  1337. // Try lock, silence otherwise
  1338. if (pData->engine->isOffline())
  1339. {
  1340. pData->singleMutex.lock();
  1341. }
  1342. else if (! pData->singleMutex.tryLock())
  1343. {
  1344. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  1345. FloatVectorOperations::clear(audioOut[i], static_cast<int>(frames));
  1346. for (uint32_t i=0; i < pData->cvOut.count; ++i)
  1347. FloatVectorOperations::clear(cvOut[i], static_cast<int>(frames));
  1348. return false;
  1349. }
  1350. // --------------------------------------------------------------------------------------------------------
  1351. // Reset audio buffers
  1352. for (uint32_t i=0; i < fInfo.aIns; ++i)
  1353. FloatVectorOperations::copy(fShmAudioPool.data + (i * frames), audioIn[i], static_cast<int>(frames));
  1354. // --------------------------------------------------------------------------------------------------------
  1355. // TimeInfo
  1356. const EngineTimeInfo& timeInfo(pData->engine->getTimeInfo());
  1357. BridgeTimeInfo& bridgeTimeInfo(fShmRtClientControl.data->timeInfo);
  1358. bridgeTimeInfo.playing = timeInfo.playing;
  1359. bridgeTimeInfo.frame = timeInfo.frame;
  1360. bridgeTimeInfo.usecs = timeInfo.usecs;
  1361. bridgeTimeInfo.valid = timeInfo.valid;
  1362. if (timeInfo.valid & EngineTimeInfo::kValidBBT)
  1363. {
  1364. bridgeTimeInfo.bar = timeInfo.bbt.bar;
  1365. bridgeTimeInfo.beat = timeInfo.bbt.beat;
  1366. bridgeTimeInfo.tick = timeInfo.bbt.tick;
  1367. bridgeTimeInfo.beatsPerBar = timeInfo.bbt.beatsPerBar;
  1368. bridgeTimeInfo.beatType = timeInfo.bbt.beatType;
  1369. bridgeTimeInfo.ticksPerBeat = timeInfo.bbt.ticksPerBeat;
  1370. bridgeTimeInfo.beatsPerMinute = timeInfo.bbt.beatsPerMinute;
  1371. bridgeTimeInfo.barStartTick = timeInfo.bbt.barStartTick;
  1372. }
  1373. // --------------------------------------------------------------------------------------------------------
  1374. // Run plugin
  1375. {
  1376. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientProcess);
  1377. fShmRtClientControl.commitWrite();
  1378. }
  1379. waitForClient("process", fProcWaitTime);
  1380. if (fTimedOut)
  1381. {
  1382. pData->singleMutex.unlock();
  1383. return false;
  1384. }
  1385. for (uint32_t i=0; i < fInfo.aOuts; ++i)
  1386. FloatVectorOperations::copy(audioOut[i], fShmAudioPool.data + ((i + fInfo.aIns) * frames), static_cast<int>(frames));
  1387. #ifndef BUILD_BRIDGE
  1388. // --------------------------------------------------------------------------------------------------------
  1389. // Post-processing (dry/wet, volume and balance)
  1390. {
  1391. const bool doVolume = (pData->hints & PLUGIN_CAN_VOLUME) != 0 && carla_isNotEqual(pData->postProc.volume, 1.0f);
  1392. const bool doDryWet = (pData->hints & PLUGIN_CAN_DRYWET) != 0 && carla_isNotEqual(pData->postProc.dryWet, 1.0f);
  1393. const bool doBalance = (pData->hints & PLUGIN_CAN_BALANCE) != 0 && ! (carla_isEqual(pData->postProc.balanceLeft, -1.0f) && carla_isEqual(pData->postProc.balanceRight, 1.0f));
  1394. bool isPair;
  1395. float bufValue, oldBufLeft[doBalance ? frames : 1];
  1396. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  1397. {
  1398. // Dry/Wet
  1399. if (doDryWet)
  1400. {
  1401. for (uint32_t k=0; k < frames; ++k)
  1402. {
  1403. bufValue = audioIn[(pData->audioIn.count == 1) ? 0 : i][k];
  1404. audioOut[i][k] = (audioOut[i][k] * pData->postProc.dryWet) + (bufValue * (1.0f - pData->postProc.dryWet));
  1405. }
  1406. }
  1407. // Balance
  1408. if (doBalance)
  1409. {
  1410. isPair = (i % 2 == 0);
  1411. if (isPair)
  1412. {
  1413. CARLA_ASSERT(i+1 < pData->audioOut.count);
  1414. FloatVectorOperations::copy(oldBufLeft, audioOut[i], static_cast<int>(frames));
  1415. }
  1416. float balRangeL = (pData->postProc.balanceLeft + 1.0f)/2.0f;
  1417. float balRangeR = (pData->postProc.balanceRight + 1.0f)/2.0f;
  1418. for (uint32_t k=0; k < frames; ++k)
  1419. {
  1420. if (isPair)
  1421. {
  1422. // left
  1423. audioOut[i][k] = oldBufLeft[k] * (1.0f - balRangeL);
  1424. audioOut[i][k] += audioOut[i+1][k] * (1.0f - balRangeR);
  1425. }
  1426. else
  1427. {
  1428. // right
  1429. audioOut[i][k] = audioOut[i][k] * balRangeR;
  1430. audioOut[i][k] += oldBufLeft[k] * balRangeL;
  1431. }
  1432. }
  1433. }
  1434. // Volume (and buffer copy)
  1435. if (doVolume)
  1436. {
  1437. for (uint32_t k=0; k < frames; ++k)
  1438. audioOut[i][k] *= pData->postProc.volume;
  1439. }
  1440. }
  1441. } // End of Post-processing
  1442. #endif // BUILD_BRIDGE
  1443. // --------------------------------------------------------------------------------------------------------
  1444. pData->singleMutex.unlock();
  1445. return true;
  1446. }
  1447. void bufferSizeChanged(const uint32_t newBufferSize) override
  1448. {
  1449. resizeAudioPool(newBufferSize);
  1450. {
  1451. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1452. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetBufferSize);
  1453. fShmNonRtClientControl.writeUInt(newBufferSize);
  1454. fShmNonRtClientControl.commitWrite();
  1455. }
  1456. //fProcWaitTime = newBufferSize*1000/pData->engine->getSampleRate();
  1457. fProcWaitTime = 1000;
  1458. waitForClient("buffersize", 1000);
  1459. }
  1460. void sampleRateChanged(const double newSampleRate) override
  1461. {
  1462. {
  1463. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1464. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetSampleRate);
  1465. fShmNonRtClientControl.writeDouble(newSampleRate);
  1466. fShmNonRtClientControl.commitWrite();
  1467. }
  1468. //fProcWaitTime = pData->engine->getBufferSize()*1000/newSampleRate;
  1469. fProcWaitTime = 1000;
  1470. waitForClient("samplerate", 1000);
  1471. }
  1472. void offlineModeChanged(const bool isOffline) override
  1473. {
  1474. {
  1475. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1476. fShmNonRtClientControl.writeOpcode(isOffline ? kPluginBridgeNonRtClientSetOffline : kPluginBridgeNonRtClientSetOnline);
  1477. fShmNonRtClientControl.commitWrite();
  1478. }
  1479. waitForClient("offline", 1000);
  1480. }
  1481. // -------------------------------------------------------------------
  1482. // Plugin buffers
  1483. void clearBuffers() noexcept override
  1484. {
  1485. if (fParams != nullptr)
  1486. {
  1487. delete[] fParams;
  1488. fParams = nullptr;
  1489. }
  1490. CarlaPlugin::clearBuffers();
  1491. }
  1492. // -------------------------------------------------------------------
  1493. // Post-poned UI Stuff
  1494. void uiParameterChange(const uint32_t index, const float value) noexcept override
  1495. {
  1496. CARLA_SAFE_ASSERT_RETURN(index < pData->param.count,);
  1497. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1498. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiParameterChange);
  1499. fShmNonRtClientControl.writeUInt(index);
  1500. fShmNonRtClientControl.writeFloat(value);
  1501. fShmNonRtClientControl.commitWrite();
  1502. }
  1503. void uiProgramChange(const uint32_t index) noexcept override
  1504. {
  1505. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count,);
  1506. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1507. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiProgramChange);
  1508. fShmNonRtClientControl.writeUInt(index);
  1509. fShmNonRtClientControl.commitWrite();
  1510. }
  1511. void uiMidiProgramChange(const uint32_t index) noexcept override
  1512. {
  1513. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count,);
  1514. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1515. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiMidiProgramChange);
  1516. fShmNonRtClientControl.writeUInt(index);
  1517. fShmNonRtClientControl.commitWrite();
  1518. }
  1519. void uiNoteOn(const uint8_t channel, const uint8_t note, const uint8_t velo) noexcept override
  1520. {
  1521. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1522. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1523. CARLA_SAFE_ASSERT_RETURN(velo > 0 && velo < MAX_MIDI_VALUE,);
  1524. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1525. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiNoteOn);
  1526. fShmNonRtClientControl.writeByte(channel);
  1527. fShmNonRtClientControl.writeByte(note);
  1528. fShmNonRtClientControl.writeByte(velo);
  1529. fShmNonRtClientControl.commitWrite();
  1530. }
  1531. void uiNoteOff(const uint8_t channel, const uint8_t note) noexcept override
  1532. {
  1533. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1534. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1535. const CarlaMutexLocker _cml(fShmNonRtClientControl.mutex);
  1536. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientUiNoteOff);
  1537. fShmNonRtClientControl.writeByte(channel);
  1538. fShmNonRtClientControl.writeByte(note);
  1539. fShmNonRtClientControl.commitWrite();
  1540. }
  1541. // -------------------------------------------------------------------
  1542. void handleNonRtData()
  1543. {
  1544. for (; fShmNonRtServerControl.isDataAvailableForReading();)
  1545. {
  1546. const PluginBridgeNonRtServerOpcode opcode(fShmNonRtServerControl.readOpcode());
  1547. #ifdef DEBUG
  1548. if (opcode != kPluginBridgeNonRtServerPong) {
  1549. carla_debug("CarlaPluginBridge::handleNonRtData() - got opcode: %s", PluginBridgeNonRtServerOpcode2str(opcode));
  1550. }
  1551. #endif
  1552. if (opcode != kPluginBridgeNonRtServerNull && fLastPongTime > 0)
  1553. fLastPongTime = Time::currentTimeMillis();
  1554. switch (opcode)
  1555. {
  1556. case kPluginBridgeNonRtServerNull:
  1557. case kPluginBridgeNonRtServerPong:
  1558. break;
  1559. case kPluginBridgeNonRtServerPluginInfo1: {
  1560. // uint/category, uint/hints, uint/optionsAvailable, uint/optionsEnabled, long/uniqueId
  1561. const uint32_t category = fShmNonRtServerControl.readUInt();
  1562. const uint32_t hints = fShmNonRtServerControl.readUInt();
  1563. const uint32_t optionAv = fShmNonRtServerControl.readUInt();
  1564. const uint32_t optionEn = fShmNonRtServerControl.readUInt();
  1565. const int64_t uniqueId = fShmNonRtServerControl.readLong();
  1566. CARLA_SAFE_ASSERT_INT2(fUniqueId == uniqueId, fUniqueId, uniqueId);
  1567. pData->hints = hints | PLUGIN_IS_BRIDGE;
  1568. pData->options = optionEn;
  1569. fInfo.category = static_cast<PluginCategory>(category);
  1570. fInfo.optionsAvailable = optionAv;
  1571. } break;
  1572. case kPluginBridgeNonRtServerPluginInfo2: {
  1573. // uint/size, str[] (realName), uint/size, str[] (label), uint/size, str[] (maker), uint/size, str[] (copyright)
  1574. // realName
  1575. const uint32_t realNameSize(fShmNonRtServerControl.readUInt());
  1576. char realName[realNameSize+1];
  1577. carla_zeroChars(realName, realNameSize+1);
  1578. fShmNonRtServerControl.readCustomData(realName, realNameSize);
  1579. // label
  1580. const uint32_t labelSize(fShmNonRtServerControl.readUInt());
  1581. char label[labelSize+1];
  1582. carla_zeroChars(label, labelSize+1);
  1583. fShmNonRtServerControl.readCustomData(label, labelSize);
  1584. // maker
  1585. const uint32_t makerSize(fShmNonRtServerControl.readUInt());
  1586. char maker[makerSize+1];
  1587. carla_zeroChars(maker, makerSize+1);
  1588. fShmNonRtServerControl.readCustomData(maker, makerSize);
  1589. // copyright
  1590. const uint32_t copyrightSize(fShmNonRtServerControl.readUInt());
  1591. char copyright[copyrightSize+1];
  1592. carla_zeroChars(copyright, copyrightSize+1);
  1593. fShmNonRtServerControl.readCustomData(copyright, copyrightSize);
  1594. fInfo.name = realName;
  1595. fInfo.label = label;
  1596. fInfo.maker = maker;
  1597. fInfo.copyright = copyright;
  1598. if (pData->name == nullptr)
  1599. pData->name = pData->engine->getUniquePluginName(realName);
  1600. } break;
  1601. case kPluginBridgeNonRtServerAudioCount: {
  1602. // uint/ins, uint/outs
  1603. fInfo.aIns = fShmNonRtServerControl.readUInt();
  1604. fInfo.aOuts = fShmNonRtServerControl.readUInt();
  1605. } break;
  1606. case kPluginBridgeNonRtServerMidiCount: {
  1607. // uint/ins, uint/outs
  1608. fInfo.mIns = fShmNonRtServerControl.readUInt();
  1609. fInfo.mOuts = fShmNonRtServerControl.readUInt();
  1610. } break;
  1611. case kPluginBridgeNonRtServerParameterCount: {
  1612. // uint/count
  1613. const uint32_t count = fShmNonRtServerControl.readUInt();
  1614. // delete old data
  1615. pData->param.clear();
  1616. if (fParams != nullptr)
  1617. {
  1618. delete[] fParams;
  1619. fParams = nullptr;
  1620. }
  1621. if (count > 0)
  1622. {
  1623. pData->param.createNew(count, false);
  1624. fParams = new BridgeParamInfo[count];
  1625. // we might not receive all parameter data, so ensure range max is not 0
  1626. for (uint32_t i=0; i<count; ++i)
  1627. {
  1628. pData->param.ranges[i].def = 0.0f;
  1629. pData->param.ranges[i].min = 0.0f;
  1630. pData->param.ranges[i].max = 1.0f;
  1631. pData->param.ranges[i].step = 0.001f;
  1632. pData->param.ranges[i].stepSmall = 0.0001f;
  1633. pData->param.ranges[i].stepLarge = 0.1f;
  1634. }
  1635. }
  1636. } break;
  1637. case kPluginBridgeNonRtServerProgramCount: {
  1638. // uint/count
  1639. pData->prog.clear();
  1640. if (const uint32_t count = fShmNonRtServerControl.readUInt())
  1641. pData->prog.createNew(static_cast<uint32_t>(count));
  1642. } break;
  1643. case kPluginBridgeNonRtServerMidiProgramCount: {
  1644. // uint/count
  1645. pData->midiprog.clear();
  1646. if (const uint32_t count = fShmNonRtServerControl.readUInt())
  1647. pData->midiprog.createNew(static_cast<uint32_t>(count));
  1648. } break;
  1649. case kPluginBridgeNonRtServerParameterData1: {
  1650. // uint/index, int/rindex, uint/type, uint/hints, int/cc
  1651. const uint32_t index = fShmNonRtServerControl.readUInt();
  1652. const int32_t rindex = fShmNonRtServerControl.readInt();
  1653. const uint32_t type = fShmNonRtServerControl.readUInt();
  1654. const uint32_t hints = fShmNonRtServerControl.readUInt();
  1655. const int16_t midiCC = fShmNonRtServerControl.readShort();
  1656. CARLA_SAFE_ASSERT_BREAK(midiCC >= -1 && midiCC < MAX_MIDI_CONTROL);
  1657. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1658. if (index < pData->param.count)
  1659. {
  1660. pData->param.data[index].type = static_cast<ParameterType>(type);
  1661. pData->param.data[index].index = static_cast<int32_t>(index);
  1662. pData->param.data[index].rindex = rindex;
  1663. pData->param.data[index].hints = hints;
  1664. pData->param.data[index].midiCC = midiCC;
  1665. }
  1666. } break;
  1667. case kPluginBridgeNonRtServerParameterData2: {
  1668. // uint/index, uint/size, str[] (name), uint/size, str[] (unit)
  1669. const uint32_t index = fShmNonRtServerControl.readUInt();
  1670. // name
  1671. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1672. char name[nameSize+1];
  1673. carla_zeroChars(name, nameSize+1);
  1674. fShmNonRtServerControl.readCustomData(name, nameSize);
  1675. // symbol
  1676. const uint32_t symbolSize(fShmNonRtServerControl.readUInt());
  1677. char symbol[symbolSize+1];
  1678. carla_zeroChars(symbol, symbolSize+1);
  1679. fShmNonRtServerControl.readCustomData(symbol, symbolSize);
  1680. // unit
  1681. const uint32_t unitSize(fShmNonRtServerControl.readUInt());
  1682. char unit[unitSize+1];
  1683. carla_zeroChars(unit, unitSize+1);
  1684. fShmNonRtServerControl.readCustomData(unit, unitSize);
  1685. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1686. if (index < pData->param.count)
  1687. {
  1688. fParams[index].name = name;
  1689. fParams[index].symbol = symbol;
  1690. fParams[index].unit = unit;
  1691. }
  1692. } break;
  1693. case kPluginBridgeNonRtServerParameterRanges: {
  1694. // uint/index, float/def, float/min, float/max, float/step, float/stepSmall, float/stepLarge
  1695. const uint32_t index = fShmNonRtServerControl.readUInt();
  1696. const float def = fShmNonRtServerControl.readFloat();
  1697. const float min = fShmNonRtServerControl.readFloat();
  1698. const float max = fShmNonRtServerControl.readFloat();
  1699. const float step = fShmNonRtServerControl.readFloat();
  1700. const float stepSmall = fShmNonRtServerControl.readFloat();
  1701. const float stepLarge = fShmNonRtServerControl.readFloat();
  1702. CARLA_SAFE_ASSERT_BREAK(min < max);
  1703. CARLA_SAFE_ASSERT_BREAK(def >= min);
  1704. CARLA_SAFE_ASSERT_BREAK(def <= max);
  1705. CARLA_SAFE_ASSERT_INT2(index < pData->param.count, index, pData->param.count);
  1706. if (index < pData->param.count)
  1707. {
  1708. pData->param.ranges[index].def = def;
  1709. pData->param.ranges[index].min = min;
  1710. pData->param.ranges[index].max = max;
  1711. pData->param.ranges[index].step = step;
  1712. pData->param.ranges[index].stepSmall = stepSmall;
  1713. pData->param.ranges[index].stepLarge = stepLarge;
  1714. }
  1715. } break;
  1716. case kPluginBridgeNonRtServerParameterValue: {
  1717. // uint/index, float/value
  1718. const uint32_t index = fShmNonRtServerControl.readUInt();
  1719. const float value = fShmNonRtServerControl.readFloat();
  1720. if (index < pData->param.count)
  1721. {
  1722. const float fixedValue(pData->param.getFixedValue(index, value));
  1723. fParams[index].value = fixedValue;
  1724. CarlaPlugin::setParameterValue(index, fixedValue, false, true, true);
  1725. }
  1726. } break;
  1727. case kPluginBridgeNonRtServerParameterValue2: {
  1728. // uint/index, float/value
  1729. const uint32_t index = fShmNonRtServerControl.readUInt();
  1730. const float value = fShmNonRtServerControl.readFloat();
  1731. if (index < pData->param.count)
  1732. {
  1733. const float fixedValue(pData->param.getFixedValue(index, value));
  1734. fParams[index].value = fixedValue;
  1735. }
  1736. } break;
  1737. case kPluginBridgeNonRtServerDefaultValue: {
  1738. // uint/index, float/value
  1739. const uint32_t index = fShmNonRtServerControl.readUInt();
  1740. const float value = fShmNonRtServerControl.readFloat();
  1741. if (index < pData->param.count)
  1742. pData->param.ranges[index].def = value;
  1743. } break;
  1744. case kPluginBridgeNonRtServerCurrentProgram: {
  1745. // int/index
  1746. const int32_t index = fShmNonRtServerControl.readInt();
  1747. CARLA_SAFE_ASSERT_BREAK(index >= -1);
  1748. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->prog.count), index, pData->prog.count);
  1749. CarlaPlugin::setProgram(index, false, true, true);
  1750. } break;
  1751. case kPluginBridgeNonRtServerCurrentMidiProgram: {
  1752. // int/index
  1753. const int32_t index = fShmNonRtServerControl.readInt();
  1754. CARLA_SAFE_ASSERT_BREAK(index >= -1);
  1755. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->midiprog.count), index, pData->midiprog.count);
  1756. CarlaPlugin::setMidiProgram(index, false, true, true);
  1757. } break;
  1758. case kPluginBridgeNonRtServerProgramName: {
  1759. // uint/index, uint/size, str[] (name)
  1760. const uint32_t index = fShmNonRtServerControl.readUInt();
  1761. // name
  1762. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1763. char name[nameSize+1];
  1764. carla_zeroChars(name, nameSize+1);
  1765. fShmNonRtServerControl.readCustomData(name, nameSize);
  1766. CARLA_SAFE_ASSERT_INT2(index < pData->prog.count, index, pData->prog.count);
  1767. if (index < pData->prog.count)
  1768. {
  1769. if (pData->prog.names[index] != nullptr)
  1770. delete[] pData->prog.names[index];
  1771. pData->prog.names[index] = carla_strdup(name);
  1772. }
  1773. } break;
  1774. case kPluginBridgeNonRtServerMidiProgramData: {
  1775. // uint/index, uint/bank, uint/program, uint/size, str[] (name)
  1776. const uint32_t index = fShmNonRtServerControl.readUInt();
  1777. const uint32_t bank = fShmNonRtServerControl.readUInt();
  1778. const uint32_t program = fShmNonRtServerControl.readUInt();
  1779. // name
  1780. const uint32_t nameSize(fShmNonRtServerControl.readUInt());
  1781. char name[nameSize+1];
  1782. carla_zeroChars(name, nameSize+1);
  1783. fShmNonRtServerControl.readCustomData(name, nameSize);
  1784. CARLA_SAFE_ASSERT_INT2(index < pData->midiprog.count, index, pData->midiprog.count);
  1785. if (index < pData->midiprog.count)
  1786. {
  1787. if (pData->midiprog.data[index].name != nullptr)
  1788. delete[] pData->midiprog.data[index].name;
  1789. pData->midiprog.data[index].bank = bank;
  1790. pData->midiprog.data[index].program = program;
  1791. pData->midiprog.data[index].name = carla_strdup(name);
  1792. }
  1793. } break;
  1794. case kPluginBridgeNonRtServerSetCustomData: {
  1795. // uint/size, str[], uint/size, str[], uint/size, str[]
  1796. // type
  1797. const uint32_t typeSize(fShmNonRtServerControl.readUInt());
  1798. char type[typeSize+1];
  1799. carla_zeroChars(type, typeSize+1);
  1800. fShmNonRtServerControl.readCustomData(type, typeSize);
  1801. // key
  1802. const uint32_t keySize(fShmNonRtServerControl.readUInt());
  1803. char key[keySize+1];
  1804. carla_zeroChars(key, keySize+1);
  1805. fShmNonRtServerControl.readCustomData(key, keySize);
  1806. // value
  1807. const uint32_t valueSize(fShmNonRtServerControl.readUInt());
  1808. char value[valueSize+1];
  1809. carla_zeroChars(value, valueSize+1);
  1810. fShmNonRtServerControl.readCustomData(value, valueSize);
  1811. CarlaPlugin::setCustomData(type, key, value, false);
  1812. } break;
  1813. case kPluginBridgeNonRtServerSetChunkDataFile: {
  1814. // uint/size, str[] (filename)
  1815. // chunkFilePath
  1816. const uint32_t chunkFilePathSize(fShmNonRtServerControl.readUInt());
  1817. char chunkFilePath[chunkFilePathSize+1];
  1818. carla_zeroChars(chunkFilePath, chunkFilePathSize+1);
  1819. fShmNonRtServerControl.readCustomData(chunkFilePath, chunkFilePathSize);
  1820. String realChunkFilePath(chunkFilePath);
  1821. carla_stdout("chunk save path BEFORE => %s", realChunkFilePath.toRawUTF8());
  1822. #ifndef CARLA_OS_WIN
  1823. // Using Wine, fix temp dir
  1824. if (fBinaryType == BINARY_WIN32 || fBinaryType == BINARY_WIN64)
  1825. {
  1826. // Get WINEPREFIX
  1827. String wineDir;
  1828. if (const char* const WINEPREFIX = getenv("WINEPREFIX"))
  1829. wineDir = String(WINEPREFIX);
  1830. else
  1831. wineDir = File::getSpecialLocation(File::userHomeDirectory).getFullPathName() + "/.wine";
  1832. const StringArray driveLetterSplit(StringArray::fromTokens(realChunkFilePath, ":/", ""));
  1833. realChunkFilePath = wineDir;
  1834. realChunkFilePath += "/drive_";
  1835. realChunkFilePath += driveLetterSplit[0].toLowerCase();
  1836. realChunkFilePath += "/";
  1837. realChunkFilePath += driveLetterSplit[1];
  1838. realChunkFilePath = realChunkFilePath.replace("\\", "/");
  1839. carla_stdout("chunk save path AFTER => %s", realChunkFilePath.toRawUTF8());
  1840. }
  1841. #endif
  1842. File chunkFile(realChunkFilePath);
  1843. if (chunkFile.existsAsFile())
  1844. {
  1845. fInfo.chunk = carla_getChunkFromBase64String(chunkFile.loadFileAsString().toRawUTF8());
  1846. chunkFile.deleteFile();
  1847. carla_stderr("chunk data final");
  1848. }
  1849. } break;
  1850. case kPluginBridgeNonRtServerSetLatency: {
  1851. // uint
  1852. } break;
  1853. case kPluginBridgeNonRtServerReady:
  1854. fInitiated = true;
  1855. break;
  1856. case kPluginBridgeNonRtServerSaved:
  1857. fSaved = true;
  1858. break;
  1859. case kPluginBridgeNonRtServerUiClosed:
  1860. pData->transientTryCounter = 0;
  1861. pData->engine->callback(ENGINE_CALLBACK_UI_STATE_CHANGED, pData->id, 0, 0, 0.0f, nullptr);
  1862. break;
  1863. case kPluginBridgeNonRtServerError: {
  1864. // error
  1865. const uint32_t errorSize(fShmNonRtServerControl.readUInt());
  1866. char error[errorSize+1];
  1867. carla_zeroChars(error, errorSize+1);
  1868. fShmNonRtServerControl.readCustomData(error, errorSize);
  1869. if (fInitiated)
  1870. {
  1871. pData->engine->callback(ENGINE_CALLBACK_ERROR, pData->id, 0, 0, 0.0f, error);
  1872. // just in case
  1873. pData->engine->setLastError(error);
  1874. fInitError = true;
  1875. }
  1876. else
  1877. {
  1878. pData->engine->setLastError(error);
  1879. fInitError = true;
  1880. fInitiated = true;
  1881. }
  1882. } break;
  1883. }
  1884. }
  1885. }
  1886. // -------------------------------------------------------------------
  1887. uintptr_t getUiBridgeProcessId() const noexcept override
  1888. {
  1889. return fBridgeThread.getProcessPID();
  1890. }
  1891. const void* getExtraStuff() const noexcept override
  1892. {
  1893. return fBridgeBinary.isNotEmpty() ? fBridgeBinary.buffer() : nullptr;
  1894. }
  1895. // -------------------------------------------------------------------
  1896. bool init(const char* const filename, const char* const name, const char* const label, const int64_t uniqueId, const char* const bridgeBinary)
  1897. {
  1898. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr, false);
  1899. // ---------------------------------------------------------------
  1900. // first checks
  1901. if (pData->client != nullptr)
  1902. {
  1903. pData->engine->setLastError("Plugin client is already registered");
  1904. return false;
  1905. }
  1906. if (bridgeBinary == nullptr || bridgeBinary[0] == '\0')
  1907. {
  1908. pData->engine->setLastError("null bridge binary");
  1909. return false;
  1910. }
  1911. // ---------------------------------------------------------------
  1912. // set info
  1913. if (name != nullptr && name[0] != '\0')
  1914. pData->name = pData->engine->getUniquePluginName(name);
  1915. if (filename != nullptr && filename[0] != '\0')
  1916. pData->filename = carla_strdup(filename);
  1917. else
  1918. pData->filename = carla_strdup("");
  1919. fUniqueId = uniqueId;
  1920. fBridgeBinary = bridgeBinary;
  1921. std::srand(static_cast<uint>(std::time(nullptr)));
  1922. // ---------------------------------------------------------------
  1923. // init sem/shm
  1924. if (! fShmAudioPool.initialize())
  1925. {
  1926. carla_stdout("Failed to initialize shared memory audio pool");
  1927. return false;
  1928. }
  1929. if (! fShmRtClientControl.initialize())
  1930. {
  1931. carla_stdout("Failed to initialize RT client control");
  1932. fShmAudioPool.clear();
  1933. return false;
  1934. }
  1935. if (! fShmNonRtClientControl.initialize())
  1936. {
  1937. carla_stdout("Failed to initialize Non-RT client control");
  1938. fShmRtClientControl.clear();
  1939. fShmAudioPool.clear();
  1940. return false;
  1941. }
  1942. if (! fShmNonRtServerControl.initialize())
  1943. {
  1944. carla_stdout("Failed to initialize Non-RT server control");
  1945. fShmNonRtClientControl.clear();
  1946. fShmRtClientControl.clear();
  1947. fShmAudioPool.clear();
  1948. return false;
  1949. }
  1950. // ---------------------------------------------------------------
  1951. carla_stdout("Carla Server Info:");
  1952. carla_stdout(" sizeof(BridgeRtClientData): " P_SIZE, sizeof(BridgeRtClientData));
  1953. carla_stdout(" sizeof(BridgeNonRtClientData): " P_SIZE, sizeof(BridgeNonRtClientData));
  1954. carla_stdout(" sizeof(BridgeNonRtServerData): " P_SIZE, sizeof(BridgeNonRtServerData));
  1955. // initial values
  1956. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientNull);
  1957. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeRtClientData)));
  1958. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeNonRtClientData)));
  1959. fShmNonRtClientControl.writeUInt(static_cast<uint32_t>(sizeof(BridgeNonRtServerData)));
  1960. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetBufferSize);
  1961. fShmNonRtClientControl.writeUInt(pData->engine->getBufferSize());
  1962. fShmNonRtClientControl.writeOpcode(kPluginBridgeNonRtClientSetSampleRate);
  1963. fShmNonRtClientControl.writeDouble(pData->engine->getSampleRate());
  1964. fShmNonRtClientControl.commitWrite();
  1965. // testing dummy message
  1966. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientNull);
  1967. fShmRtClientControl.commitWrite();
  1968. // init bridge thread
  1969. {
  1970. char shmIdsStr[6*4+1];
  1971. carla_zeroChars(shmIdsStr, 6*4+1);
  1972. std::strncpy(shmIdsStr+6*0, &fShmAudioPool.filename[fShmAudioPool.filename.length()-6], 6);
  1973. std::strncpy(shmIdsStr+6*1, &fShmRtClientControl.filename[fShmRtClientControl.filename.length()-6], 6);
  1974. std::strncpy(shmIdsStr+6*2, &fShmNonRtClientControl.filename[fShmNonRtClientControl.filename.length()-6], 6);
  1975. std::strncpy(shmIdsStr+6*3, &fShmNonRtServerControl.filename[fShmNonRtServerControl.filename.length()-6], 6);
  1976. fBridgeThread.setData(bridgeBinary, label, shmIdsStr);
  1977. fBridgeThread.startThread();
  1978. }
  1979. fInitiated = false;
  1980. fLastPongTime = Time::currentTimeMillis();
  1981. CARLA_SAFE_ASSERT(fLastPongTime > 0);
  1982. static bool sFirstInit = true;
  1983. int64_t timeoutEnd = 5000;
  1984. if (sFirstInit)
  1985. timeoutEnd *= 2;
  1986. #ifndef CARLA_OS_WIN
  1987. if (fBinaryType == BINARY_WIN32 || fBinaryType == BINARY_WIN64)
  1988. timeoutEnd *= 2;
  1989. #endif
  1990. sFirstInit = false;
  1991. const bool needsEngineIdle = pData->engine->getType() != kEngineTypePlugin;
  1992. for (; Time::currentTimeMillis() < fLastPongTime + timeoutEnd && fBridgeThread.isThreadRunning();)
  1993. {
  1994. pData->engine->callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  1995. if (needsEngineIdle)
  1996. pData->engine->idle();
  1997. idle();
  1998. if (fInitiated)
  1999. break;
  2000. carla_msleep(20);
  2001. }
  2002. fLastPongTime = -1;
  2003. if (fInitError || ! fInitiated)
  2004. {
  2005. fBridgeThread.stopThread(6000);
  2006. if (! fInitError)
  2007. pData->engine->setLastError("Timeout while waiting for a response from plugin-bridge\n(or the plugin crashed on initialization?)");
  2008. return false;
  2009. }
  2010. // ---------------------------------------------------------------
  2011. // register client
  2012. if (pData->name == nullptr)
  2013. {
  2014. if (label != nullptr && label[0] != '\0')
  2015. pData->name = pData->engine->getUniquePluginName(label);
  2016. else
  2017. pData->name = pData->engine->getUniquePluginName("unknown");
  2018. }
  2019. pData->client = pData->engine->addClient(this);
  2020. if (pData->client == nullptr || ! pData->client->isOk())
  2021. {
  2022. pData->engine->setLastError("Failed to register plugin client");
  2023. return false;
  2024. }
  2025. return true;
  2026. }
  2027. private:
  2028. const BinaryType fBinaryType;
  2029. const PluginType fPluginType;
  2030. bool fInitiated;
  2031. bool fInitError;
  2032. bool fSaved;
  2033. bool fTimedOut;
  2034. bool fTimedError;
  2035. uint fProcWaitTime;
  2036. int64_t fLastPongTime;
  2037. CarlaString fBridgeBinary;
  2038. CarlaPluginBridgeThread fBridgeThread;
  2039. BridgeAudioPool fShmAudioPool;
  2040. BridgeRtClientControl fShmRtClientControl;
  2041. BridgeNonRtClientControl fShmNonRtClientControl;
  2042. BridgeNonRtServerControl fShmNonRtServerControl;
  2043. struct Info {
  2044. uint32_t aIns, aOuts;
  2045. uint32_t cvIns, cvOuts;
  2046. uint32_t mIns, mOuts;
  2047. PluginCategory category;
  2048. uint optionsAvailable;
  2049. CarlaString name;
  2050. CarlaString label;
  2051. CarlaString maker;
  2052. CarlaString copyright;
  2053. std::vector<uint8_t> chunk;
  2054. Info()
  2055. : aIns(0),
  2056. aOuts(0),
  2057. cvIns(0),
  2058. cvOuts(0),
  2059. mIns(0),
  2060. mOuts(0),
  2061. category(PLUGIN_CATEGORY_NONE),
  2062. optionsAvailable(0),
  2063. name(),
  2064. label(),
  2065. maker(),
  2066. copyright(),
  2067. chunk() {}
  2068. } fInfo;
  2069. int64_t fUniqueId;
  2070. BridgeParamInfo* fParams;
  2071. void resizeAudioPool(const uint32_t bufferSize)
  2072. {
  2073. fShmAudioPool.resize(bufferSize, fInfo.aIns+fInfo.aOuts, fInfo.cvIns+fInfo.cvOuts);
  2074. fShmRtClientControl.writeOpcode(kPluginBridgeRtClientSetAudioPool);
  2075. fShmRtClientControl.writeULong(static_cast<uint64_t>(fShmAudioPool.size));
  2076. fShmRtClientControl.commitWrite();
  2077. waitForClient("resize-pool", 5000);
  2078. }
  2079. void waitForClient(const char* const action, const uint msecs)
  2080. {
  2081. CARLA_SAFE_ASSERT_RETURN(! fTimedOut,);
  2082. CARLA_SAFE_ASSERT_RETURN(! fTimedError,);
  2083. if (fShmRtClientControl.waitForClient(msecs))
  2084. return;
  2085. fTimedOut = true;
  2086. carla_stderr("waitForClient(%s) timed out", action);
  2087. }
  2088. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaPluginBridge)
  2089. };
  2090. CARLA_BACKEND_END_NAMESPACE
  2091. // -------------------------------------------------------------------------------------------------------------------
  2092. CARLA_BACKEND_START_NAMESPACE
  2093. CarlaPlugin* CarlaPlugin::newBridge(const Initializer& init, BinaryType btype, PluginType ptype, const char* const bridgeBinary)
  2094. {
  2095. carla_debug("CarlaPlugin::newBridge({%p, \"%s\", \"%s\", \"%s\"}, %s, %s, \"%s\")", init.engine, init.filename, init.name, init.label, BinaryType2Str(btype), PluginType2Str(ptype), bridgeBinary);
  2096. if (bridgeBinary == nullptr || bridgeBinary[0] == '\0')
  2097. {
  2098. init.engine->setLastError("Bridge not possible, bridge-binary not found");
  2099. return nullptr;
  2100. }
  2101. CarlaPluginBridge* const plugin(new CarlaPluginBridge(init.engine, init.id, btype, ptype));
  2102. if (! plugin->init(init.filename, init.name, init.label, init.uniqueId, bridgeBinary))
  2103. {
  2104. delete plugin;
  2105. return nullptr;
  2106. }
  2107. return plugin;
  2108. }
  2109. CARLA_BACKEND_END_NAMESPACE
  2110. // -------------------------------------------------------------------------------------------------------------------