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.

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