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.

2649 lines
89KB

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