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.

2725 lines
92KB

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