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.

2717 lines
92KB

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