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.

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