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.

2424 lines
87KB

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