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.

2740 lines
90KB

  1. // SPDX-FileCopyrightText: 2011-2024 Filipe Coelho <falktx@falktx.com>
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  3. #include "CarlaPluginInternal.hpp"
  4. #include "CarlaEngine.hpp"
  5. #include "CarlaBackendUtils.hpp"
  6. #include "CarlaBase64Utils.hpp"
  7. #include "CarlaMathUtils.hpp"
  8. #include "CarlaMIDI.h"
  9. #include "CarlaPluginUI.hpp"
  10. #include "CarlaScopeUtils.hpp"
  11. #include "CarlaStringList.hpp"
  12. #include <ctime>
  13. #include "water/files/File.h"
  14. #include "water/streams/MemoryOutputStream.h"
  15. #include "water/xml/XmlDocument.h"
  16. #include "water/xml/XmlElement.h"
  17. using water::CharPointer_UTF8;
  18. using water::File;
  19. using water::MemoryOutputStream;
  20. using water::Result;
  21. using water::String;
  22. using water::XmlDocument;
  23. using water::XmlElement;
  24. CARLA_BACKEND_START_NAMESPACE
  25. // -------------------------------------------------------------------------------------------------------------------
  26. // Fallback data
  27. static const ParameterData kParameterDataNull = { PARAMETER_UNKNOWN, 0x0, PARAMETER_NULL, -1, 0, CONTROL_INDEX_NONE, 0.0f, 1.0f, 0x0 };
  28. static const ParameterRanges kParameterRangesNull = { 0.0f, 0.0f, 1.0f, 0.01f, 0.0001f, 0.1f };
  29. static const MidiProgramData kMidiProgramDataNull = { 0, 0, nullptr };
  30. static const CustomData kCustomDataFallback = { nullptr, nullptr, nullptr };
  31. static /* */ CustomData kCustomDataFallbackNC = { nullptr, nullptr, nullptr };
  32. static const PluginPostRtEvent kPluginPostRtEventFallback = { kPluginPostRtEventNull, false, {} };
  33. // -------------------------------------------------------------------------------------------------------------------
  34. // ParamSymbol struct, needed for CarlaPlugin::loadStateSave()
  35. struct ParamSymbol {
  36. int32_t index;
  37. const char* symbol;
  38. ParamSymbol(const uint32_t i, const char* const s)
  39. : index(static_cast<int32_t>(i)),
  40. symbol(carla_strdup(s)) {}
  41. ~ParamSymbol() noexcept
  42. {
  43. CARLA_SAFE_ASSERT_RETURN(symbol != nullptr,)
  44. delete[] symbol;
  45. symbol = nullptr;
  46. }
  47. #ifdef CARLA_PROPER_CPP11_SUPPORT
  48. ParamSymbol() = delete;
  49. CARLA_DECLARE_NON_COPYABLE(ParamSymbol)
  50. #endif
  51. };
  52. // -------------------------------------------------------------------------------------------------------------------
  53. // Constructor and destructor
  54. CarlaPlugin::CarlaPlugin(CarlaEngine* const engine, const uint id)
  55. : pData(new ProtectedData(engine, id))
  56. {
  57. CARLA_SAFE_ASSERT_RETURN(engine != nullptr,);
  58. CARLA_SAFE_ASSERT(id < engine->getMaxPluginNumber());
  59. carla_debug("CarlaPlugin::CarlaPlugin(%p, %i)", engine, id);
  60. switch (engine->getProccessMode())
  61. {
  62. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  63. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  64. CARLA_SAFE_ASSERT(id < MAX_DEFAULT_PLUGINS);
  65. break;
  66. case ENGINE_PROCESS_MODE_CONTINUOUS_RACK:
  67. CARLA_SAFE_ASSERT(id < MAX_RACK_PLUGINS);
  68. break;
  69. case ENGINE_PROCESS_MODE_PATCHBAY:
  70. CARLA_SAFE_ASSERT(id < MAX_PATCHBAY_PLUGINS);
  71. break;
  72. case ENGINE_PROCESS_MODE_BRIDGE:
  73. CARLA_SAFE_ASSERT(id == 0);
  74. break;
  75. }
  76. }
  77. CarlaPlugin::~CarlaPlugin()
  78. {
  79. carla_debug("CarlaPlugin::~CarlaPlugin()");
  80. delete pData;
  81. }
  82. // -------------------------------------------------------------------
  83. // Information (base)
  84. uint CarlaPlugin::getId() const noexcept
  85. {
  86. return pData->id;
  87. }
  88. uint CarlaPlugin::getHints() const noexcept
  89. {
  90. return pData->hints;
  91. }
  92. uint CarlaPlugin::getOptionsEnabled() const noexcept
  93. {
  94. return pData->options;
  95. }
  96. bool CarlaPlugin::isEnabled() const noexcept
  97. {
  98. return pData->enabled;
  99. }
  100. const char* CarlaPlugin::getName() const noexcept
  101. {
  102. return pData->name;
  103. }
  104. const char* CarlaPlugin::getFilename() const noexcept
  105. {
  106. return pData->filename;
  107. }
  108. const char* CarlaPlugin::getIconName() const noexcept
  109. {
  110. return pData->iconName;
  111. }
  112. PluginCategory CarlaPlugin::getCategory() const noexcept
  113. {
  114. return getPluginCategoryFromName(pData->name);
  115. }
  116. int64_t CarlaPlugin::getUniqueId() const noexcept
  117. {
  118. return 0;
  119. }
  120. uint32_t CarlaPlugin::getLatencyInFrames() const noexcept
  121. {
  122. return 0;
  123. }
  124. // -------------------------------------------------------------------
  125. // Information (count)
  126. uint32_t CarlaPlugin::getAudioInCount() const noexcept
  127. {
  128. return pData->audioIn.count;
  129. }
  130. uint32_t CarlaPlugin::getAudioOutCount() const noexcept
  131. {
  132. return pData->audioOut.count;
  133. }
  134. uint32_t CarlaPlugin::getCVInCount() const noexcept
  135. {
  136. return pData->cvIn.count;
  137. }
  138. uint32_t CarlaPlugin::getCVOutCount() const noexcept
  139. {
  140. return pData->cvOut.count;
  141. }
  142. uint32_t CarlaPlugin::getMidiInCount() const noexcept
  143. {
  144. return (pData->extraHints & PLUGIN_EXTRA_HINT_HAS_MIDI_IN) ? 1 : 0;
  145. }
  146. uint32_t CarlaPlugin::getMidiOutCount() const noexcept
  147. {
  148. return (pData->extraHints & PLUGIN_EXTRA_HINT_HAS_MIDI_OUT) ? 1 : 0;
  149. }
  150. uint32_t CarlaPlugin::getParameterCount() const noexcept
  151. {
  152. return pData->param.count;
  153. }
  154. uint32_t CarlaPlugin::getParameterScalePointCount(const uint32_t parameterId) const noexcept
  155. {
  156. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, 0);
  157. return 0;
  158. }
  159. uint32_t CarlaPlugin::getProgramCount() const noexcept
  160. {
  161. return pData->prog.count;
  162. }
  163. uint32_t CarlaPlugin::getMidiProgramCount() const noexcept
  164. {
  165. return pData->midiprog.count;
  166. }
  167. uint32_t CarlaPlugin::getCustomDataCount() const noexcept
  168. {
  169. return static_cast<uint32_t>(pData->custom.count());
  170. }
  171. // -------------------------------------------------------------------
  172. // Information (current data)
  173. int32_t CarlaPlugin::getCurrentProgram() const noexcept
  174. {
  175. return pData->prog.current;
  176. }
  177. int32_t CarlaPlugin::getCurrentMidiProgram() const noexcept
  178. {
  179. return pData->midiprog.current;
  180. }
  181. uint CarlaPlugin::getAudioPortHints(bool, uint32_t) const noexcept
  182. {
  183. return 0x0;
  184. }
  185. const ParameterData& CarlaPlugin::getParameterData(const uint32_t parameterId) const noexcept
  186. {
  187. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, kParameterDataNull);
  188. return pData->param.data[parameterId];
  189. }
  190. const ParameterRanges& CarlaPlugin::getParameterRanges(const uint32_t parameterId) const noexcept
  191. {
  192. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, kParameterRangesNull);
  193. return pData->param.ranges[parameterId];
  194. }
  195. bool CarlaPlugin::isParameterOutput(const uint32_t parameterId) const noexcept
  196. {
  197. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, false);
  198. return (pData->param.data[parameterId].type == PARAMETER_OUTPUT);
  199. }
  200. const MidiProgramData& CarlaPlugin::getMidiProgramData(const uint32_t index) const noexcept
  201. {
  202. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count, kMidiProgramDataNull);
  203. return pData->midiprog.data[index];
  204. }
  205. const CustomData& CarlaPlugin::getCustomData(const uint32_t index) const noexcept
  206. {
  207. return pData->custom.getAt(index, kCustomDataFallback);
  208. }
  209. std::size_t CarlaPlugin::getChunkData(void** const dataPtr) noexcept
  210. {
  211. CARLA_SAFE_ASSERT_RETURN(dataPtr != nullptr, 0);
  212. CARLA_SAFE_ASSERT(false); // this should never happen
  213. return 0;
  214. }
  215. // -------------------------------------------------------------------
  216. // Information (per-plugin data)
  217. uint CarlaPlugin::getOptionsAvailable() const noexcept
  218. {
  219. CARLA_SAFE_ASSERT(false); // this should never happen
  220. return 0x0;
  221. }
  222. float CarlaPlugin::getParameterValue(const uint32_t parameterId) const noexcept
  223. {
  224. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), 0.0f);
  225. CARLA_SAFE_ASSERT(false); // this should never happen
  226. return 0.0f;
  227. }
  228. float CarlaPlugin::getParameterScalePointValue(const uint32_t parameterId, const uint32_t scalePointId) const noexcept
  229. {
  230. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), 0.0f);
  231. CARLA_SAFE_ASSERT_RETURN(scalePointId < getParameterScalePointCount(parameterId), 0.0f);
  232. CARLA_SAFE_ASSERT(false); // this should never happen
  233. return 0.0f;
  234. }
  235. bool CarlaPlugin::getLabel(char* const strBuf) const noexcept
  236. {
  237. strBuf[0] = '\0';
  238. return false;
  239. }
  240. bool CarlaPlugin::getMaker(char* const strBuf) const noexcept
  241. {
  242. strBuf[0] = '\0';
  243. return false;
  244. }
  245. bool CarlaPlugin::getCopyright(char* const strBuf) const noexcept
  246. {
  247. strBuf[0] = '\0';
  248. return false;
  249. }
  250. bool CarlaPlugin::getRealName(char* const strBuf) const noexcept
  251. {
  252. strBuf[0] = '\0';
  253. return false;
  254. }
  255. bool CarlaPlugin::getParameterName(const uint32_t parameterId, char* const strBuf) const noexcept
  256. {
  257. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), false);
  258. CARLA_SAFE_ASSERT(false); // this should never happen
  259. strBuf[0] = '\0';
  260. return false;
  261. }
  262. bool CarlaPlugin::getParameterSymbol(const uint32_t parameterId, char* const strBuf) const noexcept
  263. {
  264. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), false);
  265. strBuf[0] = '\0';
  266. return false;
  267. }
  268. bool CarlaPlugin::getParameterText(const uint32_t parameterId, char* const strBuf) noexcept
  269. {
  270. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), false);
  271. CARLA_SAFE_ASSERT(false); // this should never happen
  272. strBuf[0] = '\0';
  273. return false;
  274. }
  275. bool CarlaPlugin::getParameterUnit(const uint32_t parameterId, char* const strBuf) const noexcept
  276. {
  277. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), false);
  278. strBuf[0] = '\0';
  279. return false;
  280. }
  281. bool CarlaPlugin::getParameterComment(const uint32_t parameterId, char* const strBuf) const noexcept
  282. {
  283. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), false);
  284. strBuf[0] = '\0';
  285. return false;
  286. }
  287. bool CarlaPlugin::getParameterGroupName(const uint32_t parameterId, char* const strBuf) const noexcept
  288. {
  289. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), false);
  290. strBuf[0] = '\0';
  291. return false;
  292. }
  293. bool CarlaPlugin::getParameterScalePointLabel(const uint32_t parameterId, const uint32_t scalePointId, char* const strBuf) const noexcept
  294. {
  295. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), false);
  296. CARLA_SAFE_ASSERT_RETURN(scalePointId < getParameterScalePointCount(parameterId), false);
  297. CARLA_SAFE_ASSERT(false); // this should never happen
  298. strBuf[0] = '\0';
  299. return false;
  300. }
  301. float CarlaPlugin::getInternalParameterValue(const int32_t parameterId) const noexcept
  302. {
  303. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  304. CARLA_SAFE_ASSERT_RETURN(parameterId != PARAMETER_NULL && parameterId > PARAMETER_MAX, 0.0f);
  305. switch (parameterId)
  306. {
  307. case PARAMETER_ACTIVE:
  308. return pData->active;
  309. case PARAMETER_CTRL_CHANNEL:
  310. return pData->ctrlChannel;
  311. case PARAMETER_DRYWET:
  312. return pData->postProc.dryWet;
  313. case PARAMETER_VOLUME:
  314. return pData->postProc.volume;
  315. case PARAMETER_BALANCE_LEFT:
  316. return pData->postProc.balanceLeft;
  317. case PARAMETER_BALANCE_RIGHT:
  318. return pData->postProc.balanceRight;
  319. case PARAMETER_PANNING:
  320. return pData->postProc.panning;
  321. };
  322. #endif
  323. CARLA_SAFE_ASSERT_RETURN(parameterId >= 0, 0.0f);
  324. return getParameterValue(static_cast<uint32_t>(parameterId));
  325. }
  326. bool CarlaPlugin::getProgramName(const uint32_t index, char* const strBuf) const noexcept
  327. {
  328. CARLA_SAFE_ASSERT_RETURN(index < pData->prog.count, false);
  329. CARLA_SAFE_ASSERT_RETURN(pData->prog.names[index] != nullptr, false);
  330. std::strncpy(strBuf, pData->prog.names[index], STR_MAX);
  331. return true;
  332. }
  333. bool CarlaPlugin::getMidiProgramName(const uint32_t index, char* const strBuf) const noexcept
  334. {
  335. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count, false);
  336. CARLA_SAFE_ASSERT_RETURN(pData->midiprog.data[index].name != nullptr, false);
  337. std::strncpy(strBuf, pData->midiprog.data[index].name, STR_MAX);
  338. return true;
  339. }
  340. void CarlaPlugin::getParameterCountInfo(uint32_t& ins, uint32_t& outs) const noexcept
  341. {
  342. ins = 0;
  343. outs = 0;
  344. for (uint32_t i=0; i < pData->param.count; ++i)
  345. {
  346. if (pData->param.data[i].type == PARAMETER_INPUT)
  347. ++ins;
  348. else if (pData->param.data[i].type == PARAMETER_OUTPUT)
  349. ++outs;
  350. }
  351. }
  352. // -------------------------------------------------------------------
  353. // Set data (state)
  354. void CarlaPlugin::prepareForSave(bool)
  355. {
  356. }
  357. void CarlaPlugin::resetParameters() noexcept
  358. {
  359. for (uint i=0; i < pData->param.count; ++i)
  360. {
  361. const ParameterData& paramData(pData->param.data[i]);
  362. const ParameterRanges& paramRanges(pData->param.ranges[i]);
  363. if (paramData.type != PARAMETER_INPUT)
  364. continue;
  365. if ((paramData.hints & PARAMETER_IS_ENABLED) == 0)
  366. continue;
  367. setParameterValue(i, paramRanges.def, true, true, true);
  368. }
  369. }
  370. void CarlaPlugin::randomizeParameters() noexcept
  371. {
  372. float value, random;
  373. char strBuf[STR_MAX+1];
  374. strBuf[STR_MAX] = '\0';
  375. std::srand(static_cast<uint>(std::time(nullptr)));
  376. for (uint i=0; i < pData->param.count; ++i)
  377. {
  378. const ParameterData& paramData(pData->param.data[i]);
  379. if (paramData.type != PARAMETER_INPUT)
  380. continue;
  381. if ((paramData.hints & PARAMETER_IS_ENABLED) == 0)
  382. continue;
  383. if (! getParameterName(i, strBuf))
  384. strBuf[0] = '\0';
  385. if (std::strstr(strBuf, "olume") != nullptr)
  386. continue;
  387. if (std::strstr(strBuf, "Master") != nullptr)
  388. continue;
  389. const ParameterRanges& paramRanges(pData->param.ranges[i]);
  390. if (paramData.hints & PARAMETER_IS_BOOLEAN)
  391. {
  392. random = static_cast<float>(std::rand()) / static_cast<float>(RAND_MAX);
  393. value = random > 0.5f ? paramRanges.max : paramRanges.min;
  394. }
  395. else
  396. {
  397. random = static_cast<float>(std::rand()) / static_cast<float>(RAND_MAX);
  398. value = random * (paramRanges.max - paramRanges.min) + paramRanges.min;
  399. if (paramData.hints & PARAMETER_IS_INTEGER)
  400. value = std::rint(value);
  401. }
  402. setParameterValue(i, value, true, true, true);
  403. }
  404. }
  405. const CarlaStateSave& CarlaPlugin::getStateSave(const bool callPrepareForSave)
  406. {
  407. pData->stateSave.clear();
  408. if (callPrepareForSave)
  409. {
  410. pData->stateSave.temporary = true;
  411. prepareForSave(true);
  412. }
  413. const PluginType pluginType = getType();
  414. char strBuf[STR_MAX+1];
  415. carla_zeroChars(strBuf, STR_MAX+1);
  416. // ---------------------------------------------------------------
  417. // Basic info
  418. if (! getLabel(strBuf))
  419. strBuf[0] = '\0';
  420. pData->stateSave.type = carla_strdup(getPluginTypeAsString(pluginType));
  421. pData->stateSave.name = carla_strdup(pData->name);
  422. pData->stateSave.label = carla_strdup(strBuf);
  423. pData->stateSave.uniqueId = getUniqueId();
  424. // #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  425. pData->stateSave.options = pData->options;
  426. // #endif
  427. if (pData->filename != nullptr)
  428. pData->stateSave.binary = carla_strdup(pData->filename);
  429. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  430. // ---------------------------------------------------------------
  431. // Internals
  432. pData->stateSave.active = pData->active;
  433. pData->stateSave.dryWet = pData->postProc.dryWet;
  434. pData->stateSave.volume = pData->postProc.volume;
  435. pData->stateSave.balanceLeft = pData->postProc.balanceLeft;
  436. pData->stateSave.balanceRight = pData->postProc.balanceRight;
  437. pData->stateSave.panning = pData->postProc.panning;
  438. pData->stateSave.ctrlChannel = pData->ctrlChannel;
  439. #endif
  440. if (pData->hints & PLUGIN_IS_BRIDGE)
  441. waitForBridgeSaveSignal();
  442. // ---------------------------------------------------------------
  443. // Chunk
  444. bool usingChunk = false;
  445. if (pData->options & PLUGIN_OPTION_USE_CHUNKS)
  446. {
  447. void* data = nullptr;
  448. const std::size_t dataSize = getChunkData(&data);
  449. if (data != nullptr && dataSize > 0)
  450. {
  451. pData->stateSave.chunk = CarlaString::asBase64(data, dataSize).dup();
  452. if (pluginType != PLUGIN_INTERNAL && pluginType != PLUGIN_JSFX)
  453. usingChunk = true;
  454. }
  455. }
  456. // ---------------------------------------------------------------
  457. // Current Program
  458. if (pData->prog.current >= 0 && pluginType != PLUGIN_LV2)
  459. {
  460. pData->stateSave.currentProgramIndex = pData->prog.current;
  461. pData->stateSave.currentProgramName = carla_strdup(pData->prog.names[pData->prog.current]);
  462. }
  463. // ---------------------------------------------------------------
  464. // Current MIDI Program
  465. if (pData->midiprog.current >= 0 && pluginType != PLUGIN_LV2 && pluginType != PLUGIN_SF2)
  466. {
  467. const MidiProgramData& mpData(pData->midiprog.getCurrent());
  468. pData->stateSave.currentMidiBank = static_cast<int32_t>(mpData.bank);
  469. pData->stateSave.currentMidiProgram = static_cast<int32_t>(mpData.program);
  470. }
  471. // ---------------------------------------------------------------
  472. // Parameters
  473. const float sampleRate = static_cast<float>(pData->engine->getSampleRate());
  474. for (uint32_t i=0; i < pData->param.count; ++i)
  475. {
  476. const ParameterData& paramData(pData->param.data[i]);
  477. if ((paramData.hints & PARAMETER_IS_ENABLED) == 0)
  478. continue;
  479. if (paramData.hints & PARAMETER_IS_NOT_SAVED)
  480. continue;
  481. const bool dummy = paramData.type != PARAMETER_INPUT || usingChunk;
  482. if (dummy && paramData.mappedControlIndex <= CONTROL_INDEX_NONE)
  483. continue;
  484. CarlaStateSave::Parameter* const stateParameter(new CarlaStateSave::Parameter());
  485. stateParameter->dummy = dummy;
  486. stateParameter->index = paramData.index;
  487. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  488. if (paramData.mappedControlIndex != CONTROL_INDEX_MIDI_LEARN)
  489. {
  490. stateParameter->mappedControlIndex = paramData.mappedControlIndex;
  491. stateParameter->midiChannel = paramData.midiChannel;
  492. if (paramData.hints & PARAMETER_MAPPED_RANGES_SET)
  493. {
  494. stateParameter->mappedMinimum = paramData.mappedMinimum;
  495. stateParameter->mappedMaximum = paramData.mappedMaximum;
  496. stateParameter->mappedRangeValid = true;
  497. if (paramData.hints & PARAMETER_USES_SAMPLERATE)
  498. {
  499. stateParameter->mappedMinimum /= sampleRate;
  500. stateParameter->mappedMaximum /= sampleRate;
  501. }
  502. }
  503. }
  504. #endif
  505. if (! getParameterName(i, strBuf))
  506. strBuf[0] = '\0';
  507. stateParameter->name = carla_strdup(strBuf);
  508. if (! getParameterSymbol(i, strBuf))
  509. strBuf[0] = '\0';
  510. stateParameter->symbol = carla_strdup(strBuf);;
  511. if (! dummy)
  512. {
  513. stateParameter->value = getParameterValue(i);
  514. if (paramData.hints & PARAMETER_USES_SAMPLERATE)
  515. stateParameter->value /= sampleRate;
  516. }
  517. pData->stateSave.parameters.append(stateParameter);
  518. }
  519. // ---------------------------------------------------------------
  520. // Custom Data
  521. for (LinkedList<CustomData>::Itenerator it = pData->custom.begin2(); it.valid(); it.next())
  522. {
  523. const CustomData& cData(it.getValue(kCustomDataFallback));
  524. CARLA_SAFE_ASSERT_CONTINUE(cData.isValid());
  525. CarlaStateSave::CustomData* stateCustomData(new CarlaStateSave::CustomData());
  526. stateCustomData->type = carla_strdup(cData.type);
  527. stateCustomData->key = carla_strdup(cData.key);
  528. stateCustomData->value = carla_strdup(cData.value);
  529. pData->stateSave.customData.append(stateCustomData);
  530. }
  531. return pData->stateSave;
  532. }
  533. void CarlaPlugin::loadStateSave(const CarlaStateSave& stateSave)
  534. {
  535. const bool usesMultiProgs = pData->hints & PLUGIN_USES_MULTI_PROGS;
  536. const PluginType pluginType = getType();
  537. char strBuf[STR_MAX+1];
  538. carla_zeroChars(strBuf, STR_MAX+1);
  539. // ---------------------------------------------------------------
  540. // Part 1 - PRE-set custom data (only those which reload programs)
  541. for (CarlaStateSave::CustomDataItenerator it = stateSave.customData.begin2(); it.valid(); it.next())
  542. {
  543. const CarlaStateSave::CustomData* const stateCustomData(it.getValue(nullptr));
  544. CARLA_SAFE_ASSERT_CONTINUE(stateCustomData != nullptr);
  545. CARLA_SAFE_ASSERT_CONTINUE(stateCustomData->isValid());
  546. const char* const key(stateCustomData->key);
  547. /**/ if (pluginType == PLUGIN_DSSI && (std::strcmp (key, "reloadprograms") == 0 ||
  548. std::strcmp (key, "load" ) == 0 ||
  549. std::strncmp(key, "patches", 7) == 0 ))
  550. pass();
  551. else if (usesMultiProgs && std::strcmp(key, "midiPrograms") == 0)
  552. pass();
  553. else
  554. continue;
  555. setCustomData(stateCustomData->type, key, stateCustomData->value, true);
  556. }
  557. // ---------------------------------------------------------------
  558. // Part 2 - set program
  559. if (stateSave.currentProgramIndex >= 0 && stateSave.currentProgramName != nullptr)
  560. {
  561. int32_t programId = -1;
  562. // index < count
  563. if (stateSave.currentProgramIndex < static_cast<int32_t>(pData->prog.count))
  564. {
  565. programId = stateSave.currentProgramIndex;
  566. }
  567. // index not valid, try to find by name
  568. else
  569. {
  570. for (uint32_t i=0; i < pData->prog.count; ++i)
  571. {
  572. if (getProgramName(i, strBuf) && std::strcmp(stateSave.currentProgramName, strBuf) == 0)
  573. {
  574. programId = static_cast<int32_t>(i);
  575. break;
  576. }
  577. }
  578. }
  579. // set program now, if valid
  580. if (programId >= 0)
  581. setProgram(programId, true, true, true);
  582. }
  583. // ---------------------------------------------------------------
  584. // Part 3 - set midi program
  585. if (stateSave.currentMidiBank >= 0 && stateSave.currentMidiProgram >= 0 && ! usesMultiProgs)
  586. setMidiProgramById(static_cast<uint32_t>(stateSave.currentMidiBank), static_cast<uint32_t>(stateSave.currentMidiProgram), true, true, true);
  587. // ---------------------------------------------------------------
  588. // Part 4a - get plugin parameter symbols
  589. LinkedList<ParamSymbol*> paramSymbols;
  590. if (pluginType == PLUGIN_LADSPA || pluginType == PLUGIN_LV2 || pluginType == PLUGIN_CLAP)
  591. {
  592. for (uint32_t i=0; i < pData->param.count; ++i)
  593. {
  594. if (pData->param.data[i].hints & PARAMETER_IS_NOT_SAVED)
  595. continue;
  596. if (getParameterSymbol(i, strBuf))
  597. {
  598. ParamSymbol* const paramSymbol(new ParamSymbol(i, strBuf));
  599. paramSymbols.append(paramSymbol);
  600. }
  601. }
  602. }
  603. // ---------------------------------------------------------------
  604. // Part 4b - set parameter values (carefully)
  605. const float sampleRate = static_cast<float>(pData->engine->getSampleRate());
  606. for (CarlaStateSave::ParameterItenerator it = stateSave.parameters.begin2(); it.valid(); it.next())
  607. {
  608. CarlaStateSave::Parameter* const stateParameter(it.getValue(nullptr));
  609. CARLA_SAFE_ASSERT_CONTINUE(stateParameter != nullptr);
  610. int32_t index = -1;
  611. if (pluginType == PLUGIN_LADSPA)
  612. {
  613. // Try to set by symbol, otherwise use index
  614. if (stateParameter->symbol != nullptr && stateParameter->symbol[0] != '\0')
  615. {
  616. for (LinkedList<ParamSymbol*>::Itenerator it2 = paramSymbols.begin2(); it2.valid(); it2.next())
  617. {
  618. ParamSymbol* const paramSymbol(it2.getValue(nullptr));
  619. CARLA_SAFE_ASSERT_CONTINUE(paramSymbol != nullptr);
  620. CARLA_SAFE_ASSERT_CONTINUE(paramSymbol->symbol != nullptr);
  621. if (std::strcmp(stateParameter->symbol, paramSymbol->symbol) == 0)
  622. {
  623. index = paramSymbol->index;
  624. break;
  625. }
  626. }
  627. if (index == -1)
  628. index = stateParameter->index;
  629. }
  630. else
  631. {
  632. index = stateParameter->index;
  633. }
  634. }
  635. else if (pluginType == PLUGIN_LV2 || pluginType == PLUGIN_CLAP)
  636. {
  637. // Symbol only
  638. if (stateParameter->symbol != nullptr && stateParameter->symbol[0] != '\0')
  639. {
  640. for (LinkedList<ParamSymbol*>::Itenerator it2 = paramSymbols.begin2(); it2.valid(); it2.next())
  641. {
  642. ParamSymbol* const paramSymbol(it2.getValue(nullptr));
  643. CARLA_SAFE_ASSERT_CONTINUE(paramSymbol != nullptr);
  644. CARLA_SAFE_ASSERT_CONTINUE(paramSymbol->symbol != nullptr);
  645. if (std::strcmp(stateParameter->symbol, paramSymbol->symbol) == 0)
  646. {
  647. index = paramSymbol->index;
  648. break;
  649. }
  650. }
  651. if (index == -1)
  652. {
  653. if (pluginType == PLUGIN_LV2)
  654. carla_stderr("Failed to find LV2 parameter symbol '%s' for '%s'",
  655. stateParameter->symbol, pData->name);
  656. else
  657. carla_stderr("Failed to find CLAP parameter id '%s' for '%s'",
  658. stateParameter->symbol, pData->name);
  659. }
  660. }
  661. else
  662. {
  663. if (pluginType == PLUGIN_LV2)
  664. carla_stderr("LV2 Plugin parameter '%s' has no symbol", stateParameter->name);
  665. else
  666. carla_stderr("CLAP Plugin parameter '%s' has no id", stateParameter->name);
  667. }
  668. }
  669. else
  670. {
  671. // Index only
  672. index = stateParameter->index;
  673. }
  674. // Now set parameter
  675. if (index >= 0 && index < static_cast<int32_t>(pData->param.count))
  676. {
  677. //CARLA_SAFE_ASSERT(stateParameter->isInput == (pData
  678. if (! stateParameter->dummy)
  679. {
  680. if (pData->param.data[index].hints & PARAMETER_USES_SAMPLERATE)
  681. stateParameter->value *= sampleRate;
  682. setParameterValue(static_cast<uint32_t>(index), stateParameter->value, true, true, true);
  683. }
  684. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  685. if (stateParameter->mappedRangeValid)
  686. {
  687. if (pData->param.data[index].hints & PARAMETER_USES_SAMPLERATE)
  688. {
  689. stateParameter->mappedMinimum *= sampleRate;
  690. stateParameter->mappedMaximum *= sampleRate;
  691. }
  692. setParameterMappedRange(static_cast<uint32_t>(index),
  693. stateParameter->mappedMinimum,
  694. stateParameter->mappedMaximum, true, true);
  695. }
  696. setParameterMappedControlIndex(static_cast<uint32_t>(index),
  697. stateParameter->mappedControlIndex, true, true, false);
  698. setParameterMidiChannel(static_cast<uint32_t>(index), stateParameter->midiChannel, true, true);
  699. #endif
  700. }
  701. else
  702. carla_stderr("Could not set parameter '%s' value for '%s'",
  703. stateParameter->name, pData->name);
  704. }
  705. // ---------------------------------------------------------------
  706. // Part 4c - clear
  707. for (LinkedList<ParamSymbol*>::Itenerator it = paramSymbols.begin2(); it.valid(); it.next())
  708. {
  709. ParamSymbol* const paramSymbol(it.getValue(nullptr));
  710. delete paramSymbol;
  711. }
  712. paramSymbols.clear();
  713. // ---------------------------------------------------------------
  714. // Part 5 - set custom data
  715. for (CarlaStateSave::CustomDataItenerator it = stateSave.customData.begin2(); it.valid(); it.next())
  716. {
  717. const CarlaStateSave::CustomData* const stateCustomData(it.getValue(nullptr));
  718. CARLA_SAFE_ASSERT_CONTINUE(stateCustomData != nullptr);
  719. CARLA_SAFE_ASSERT_CONTINUE(stateCustomData->isValid());
  720. const char* const key(stateCustomData->key);
  721. if (pluginType == PLUGIN_DSSI && (std::strcmp (key, "reloadprograms") == 0 ||
  722. std::strcmp (key, "load" ) == 0 ||
  723. std::strncmp(key, "patches", 7) == 0 ))
  724. continue;
  725. if (usesMultiProgs && std::strcmp(key, "midiPrograms") == 0)
  726. continue;
  727. setCustomData(stateCustomData->type, key, stateCustomData->value, true);
  728. }
  729. // ---------------------------------------------------------------
  730. // Part 5x - set lv2 state
  731. if (pluginType == PLUGIN_LV2)
  732. {
  733. for (LinkedList<CustomData>::Itenerator it = pData->custom.begin2(); it.valid(); it.next())
  734. {
  735. const CustomData& customData(it.getValue(kCustomDataFallback));
  736. CARLA_SAFE_ASSERT_CONTINUE(customData.isValid());
  737. if (std::strcmp(customData.type, CUSTOM_DATA_TYPE_PROPERTY) == 0)
  738. continue;
  739. restoreLV2State(stateSave.temporary);
  740. break;
  741. }
  742. }
  743. // ---------------------------------------------------------------
  744. // Part 6 - set chunk
  745. if (stateSave.chunk != nullptr && (pData->options & PLUGIN_OPTION_USE_CHUNKS) != 0)
  746. {
  747. std::vector<uint8_t> chunk(carla_getChunkFromBase64String(stateSave.chunk));
  748. #ifdef CARLA_PROPER_CPP11_SUPPORT
  749. setChunkData(chunk.data(), chunk.size());
  750. #else
  751. setChunkData(&chunk.front(), chunk.size());
  752. #endif
  753. }
  754. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  755. // ---------------------------------------------------------------
  756. // Part 6 - set internal stuff
  757. const uint availOptions = getOptionsAvailable();
  758. for (uint i=0; i<10; ++i) // FIXME - get this value somehow...
  759. {
  760. const uint option(1u << i);
  761. if (availOptions & option)
  762. setOption(option, (stateSave.options & option) != 0, true);
  763. }
  764. setDryWet(stateSave.dryWet, true, true);
  765. setVolume(stateSave.volume, true, true);
  766. setBalanceLeft(stateSave.balanceLeft, true, true);
  767. setBalanceRight(stateSave.balanceRight, true, true);
  768. setPanning(stateSave.panning, true, true);
  769. setCtrlChannel(stateSave.ctrlChannel, true, true);
  770. setActive(stateSave.active, true, true);
  771. if (! pData->engine->isLoadingProject())
  772. pData->engine->callback(true, true, ENGINE_CALLBACK_UPDATE, pData->id, 0, 0, 0, 0.0f, nullptr);
  773. #endif
  774. }
  775. bool CarlaPlugin::saveStateToFile(const char* const filename)
  776. {
  777. CARLA_SAFE_ASSERT_RETURN(filename != nullptr && filename[0] != '\0', false);
  778. carla_debug("CarlaPlugin::saveStateToFile(\"%s\")", filename);
  779. MemoryOutputStream out, streamState;
  780. getStateSave().dumpToMemoryStream(streamState);
  781. out << "<?xml version='1.0' encoding='UTF-8'?>\n";
  782. out << "<!DOCTYPE CARLA-PRESET>\n";
  783. out << "<CARLA-PRESET VERSION='2.0'>\n";
  784. out << streamState;
  785. out << "</CARLA-PRESET>\n";
  786. File file(filename);
  787. if (file.replaceWithData(out.getData(), out.getDataSize()))
  788. return true;
  789. pData->engine->setLastError("Failed to write file");
  790. return false;
  791. }
  792. bool CarlaPlugin::loadStateFromFile(const char* const filename)
  793. {
  794. // TODO set errors
  795. CARLA_SAFE_ASSERT_RETURN(filename != nullptr && filename[0] != '\0', false);
  796. carla_debug("CarlaPlugin::loadStateFromFile(\"%s\")", filename);
  797. File file(filename);
  798. CARLA_SAFE_ASSERT_RETURN(file.existsAsFile(), false);
  799. XmlDocument xml(file);
  800. CarlaScopedPointer<XmlElement> xmlElement(xml.getDocumentElement(true));
  801. CARLA_SAFE_ASSERT_RETURN(xmlElement != nullptr, false);
  802. CARLA_SAFE_ASSERT_RETURN(xmlElement->getTagName().equalsIgnoreCase("carla-preset"), false);
  803. // completely load file
  804. xmlElement = xml.getDocumentElement(false);
  805. CARLA_SAFE_ASSERT_RETURN(xmlElement != nullptr, false);
  806. if (pData->stateSave.fillFromXmlElement(xmlElement))
  807. {
  808. loadStateSave(pData->stateSave);
  809. return true;
  810. }
  811. return false;
  812. }
  813. #ifndef CARLA_PLUGIN_ONLY_BRIDGE
  814. bool CarlaPlugin::exportAsLV2(const char* const lv2path)
  815. {
  816. CARLA_SAFE_ASSERT_RETURN(lv2path != nullptr && lv2path[0] != '\0', false);
  817. carla_debug("CarlaPlugin::exportAsLV2(\"%s\")", lv2path);
  818. CarlaString bundlepath(lv2path);
  819. if (! bundlepath.endsWith(".lv2"))
  820. bundlepath += ".lv2";
  821. const File bundlefolder(bundlepath.buffer());
  822. if (bundlefolder.existsAsFile())
  823. {
  824. pData->engine->setLastError("Requested filename already exists as file, use a folder instead");
  825. return false;
  826. }
  827. if (! bundlefolder.exists())
  828. {
  829. const Result res(bundlefolder.createDirectory());
  830. if (res.failed())
  831. {
  832. pData->engine->setLastError(res.getErrorMessage().c_str());
  833. return false;
  834. }
  835. }
  836. CarlaString symbol(pData->name);
  837. symbol.toBasic();
  838. {
  839. const CarlaString pluginFilename(bundlepath + CARLA_OS_SEP_STR + symbol + ".xml");
  840. if (! saveStateToFile(pluginFilename))
  841. return false;
  842. }
  843. {
  844. MemoryOutputStream manifestStream;
  845. manifestStream << "@prefix lv2: <http://lv2plug.in/ns/lv2core#> .\n";
  846. manifestStream << "@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .\n";
  847. manifestStream << "@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .\n";
  848. manifestStream << "\n";
  849. manifestStream << "<" << symbol.buffer() << ".ttl>\n";
  850. manifestStream << " a lv2:Plugin ;\n";
  851. manifestStream << " lv2:binary <" << symbol.buffer() << CARLA_LIB_EXT "> ;\n";
  852. manifestStream << " rdfs:seeAlso <" << symbol.buffer() << ".ttl> .\n";
  853. manifestStream << "\n";
  854. manifestStream << "<ext-ui>\n";
  855. manifestStream << " a <http://kxstudio.sf.net/ns/lv2ext/external-ui#Widget> ;\n";
  856. manifestStream << " ui:binary <" << symbol.buffer() << CARLA_LIB_EXT "> ;\n";
  857. manifestStream << " lv2:extensionData <http://lv2plug.in/ns/extensions/ui#idleInterface> ,\n";
  858. manifestStream << " <http://lv2plug.in/ns/extensions/ui#showInterface> ;\n";
  859. manifestStream << " lv2:requiredFeature <http://lv2plug.in/ns/ext/instance-access> .\n";
  860. manifestStream << "\n";
  861. const CarlaString manifestFilename(bundlepath + CARLA_OS_SEP_STR "manifest.ttl");
  862. const File manifestFile(manifestFilename.buffer());
  863. if (! manifestFile.replaceWithData(manifestStream.getData(), manifestStream.getDataSize()))
  864. {
  865. pData->engine->setLastError("Failed to write manifest.ttl file");
  866. return false;
  867. }
  868. }
  869. {
  870. MemoryOutputStream mainStream;
  871. mainStream << "@prefix atom: <http://lv2plug.in/ns/ext/atom#> .\n";
  872. mainStream << "@prefix doap: <http://usefulinc.com/ns/doap#> .\n";
  873. mainStream << "@prefix foaf: <http://xmlns.com/foaf/0.1/> .\n";
  874. mainStream << "@prefix lv2: <http://lv2plug.in/ns/lv2core#> .\n";
  875. mainStream << "@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .\n";
  876. mainStream << "@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .\n";
  877. mainStream << "\n";
  878. mainStream << "<>\n";
  879. mainStream << " a lv2:Plugin ;\n";
  880. mainStream << "\n";
  881. mainStream << " lv2:requiredFeature <http://lv2plug.in/ns/ext/buf-size#boundedBlockLength> ,\n";
  882. mainStream << " <http://lv2plug.in/ns/ext/options#options> ,\n";
  883. mainStream << " <http://lv2plug.in/ns/ext/urid#map> ;\n";
  884. mainStream << "\n";
  885. if (pData->hints & PLUGIN_HAS_CUSTOM_UI)
  886. {
  887. mainStream << " ui:ui <ext-ui> ;\n";
  888. mainStream << "\n";
  889. }
  890. const uint32_t midiIns = getMidiInCount();
  891. const uint32_t midiOuts = getMidiOutCount();
  892. int portIndex = 0;
  893. if (midiIns > 0)
  894. {
  895. mainStream << " lv2:port [\n";
  896. mainStream << " a lv2:InputPort, atom:AtomPort ;\n";
  897. mainStream << " lv2:index 0 ;\n";
  898. mainStream << " lv2:symbol \"clv2_events_in\" ;\n";
  899. mainStream << " lv2:name \"Events Input\" ;\n";
  900. mainStream << " atom:bufferType atom:Sequence ;\n";
  901. mainStream << " atom:supports <http://lv2plug.in/ns/ext/midi#MidiEvent> ,\n";
  902. mainStream << " <http://lv2plug.in/ns/ext/time#Position> ;\n";
  903. mainStream << " ] ;\n";
  904. ++portIndex;
  905. for (uint32_t i=1; i<midiIns; ++i)
  906. {
  907. const String portIndexNum(portIndex++);
  908. const String portIndexLabel(portIndex);
  909. mainStream << " lv2:port [\n";
  910. mainStream << " a lv2:InputPort, atom:AtomPort ;\n";
  911. mainStream << " lv2:index " << portIndexNum << " ;\n";
  912. mainStream << " lv2:symbol \"clv2_midi_in_" << portIndexLabel << "\" ;\n";
  913. mainStream << " lv2:name \"MIDI Input " << portIndexLabel << "\" ;\n";
  914. mainStream << " ] ;\n";
  915. }
  916. }
  917. else
  918. {
  919. mainStream << " lv2:port [\n";
  920. mainStream << " a lv2:InputPort, atom:AtomPort ;\n";
  921. mainStream << " lv2:index 0 ;\n";
  922. mainStream << " lv2:symbol \"clv2_time_info\" ;\n";
  923. mainStream << " lv2:name \"Time Info\" ;\n";
  924. mainStream << " atom:bufferType atom:Sequence ;\n";
  925. mainStream << " atom:supports <http://lv2plug.in/ns/ext/time#Position> ;\n";
  926. mainStream << " ] ;\n";
  927. ++portIndex;
  928. }
  929. for (uint32_t i=0; i<midiOuts; ++i)
  930. {
  931. const String portIndexNum(portIndex++);
  932. const String portIndexLabel(portIndex);
  933. mainStream << " lv2:port [\n";
  934. mainStream << " a lv2:InputPort, atom:AtomPort ;\n";
  935. mainStream << " lv2:index " << portIndexNum << " ;\n";
  936. mainStream << " lv2:symbol \"clv2_midi_out_" << portIndexLabel << "\" ;\n";
  937. mainStream << " lv2:name \"MIDI Output " << portIndexLabel << "\" ;\n";
  938. mainStream << " atom:bufferType atom:Sequence ;\n";
  939. mainStream << " atom:supports <http://lv2plug.in/ns/ext/midi#MidiEvent> ;\n";
  940. mainStream << " ] ;\n";
  941. }
  942. mainStream << " lv2:port [\n";
  943. mainStream << " a lv2:InputPort, lv2:ControlPort ;\n";
  944. mainStream << " lv2:index " << String(portIndex++) << " ;\n";
  945. mainStream << " lv2:name \"freewheel\" ;\n";
  946. mainStream << " lv2:symbol \"clv2_freewheel\" ;\n";
  947. mainStream << " lv2:default 0 ;\n";
  948. mainStream << " lv2:minimum 0 ;\n";
  949. mainStream << " lv2:maximum 1 ;\n";
  950. mainStream << " lv2:designation lv2:freeWheeling ;\n";
  951. mainStream << " lv2:portProperty lv2:toggled , lv2:integer ;\n";
  952. mainStream << " lv2:portProperty <http://lv2plug.in/ns/ext/port-props#notOnGUI> ;\n";
  953. mainStream << " ] ;\n";
  954. for (uint32_t i=0; i<pData->audioIn.count; ++i)
  955. {
  956. const String portIndexNum(portIndex++);
  957. const String portIndexLabel(i+1);
  958. mainStream << " lv2:port [\n";
  959. mainStream << " a lv2:InputPort, lv2:AudioPort ;\n";
  960. mainStream << " lv2:index " << portIndexNum << " ;\n";
  961. mainStream << " lv2:symbol \"clv2_audio_in_" << portIndexLabel << "\" ;\n";
  962. mainStream << " lv2:name \"Audio Input " << portIndexLabel << "\" ;\n";
  963. mainStream << " ] ;\n";
  964. }
  965. for (uint32_t i=0; i<pData->audioOut.count; ++i)
  966. {
  967. const String portIndexNum(portIndex++);
  968. const String portIndexLabel(i+1);
  969. mainStream << " lv2:port [\n";
  970. mainStream << " a lv2:OutputPort, lv2:AudioPort ;\n";
  971. mainStream << " lv2:index " << portIndexNum << " ;\n";
  972. mainStream << " lv2:symbol \"clv2_audio_out_" << portIndexLabel << "\" ;\n";
  973. mainStream << " lv2:name \"Audio Output " << portIndexLabel << "\" ;\n";
  974. mainStream << " ] ;\n";
  975. }
  976. CarlaStringList uniqueSymbolNames;
  977. char strBufName[STR_MAX+1];
  978. char strBufSymbol[STR_MAX+1];
  979. carla_zeroChars(strBufName, STR_MAX+1);
  980. carla_zeroChars(strBufSymbol, STR_MAX+1);
  981. for (uint32_t i=0; i<pData->param.count; ++i)
  982. {
  983. const ParameterData& paramData(pData->param.data[i]);
  984. const ParameterRanges& paramRanges(pData->param.ranges[i]);
  985. const String portIndexNum(portIndex++);
  986. mainStream << " lv2:port [\n";
  987. if (paramData.type == PARAMETER_INPUT)
  988. mainStream << " a lv2:InputPort, lv2:ControlPort ;\n";
  989. else
  990. mainStream << " a lv2:OutputPort, lv2:ControlPort ;\n";
  991. if (paramData.hints & PARAMETER_IS_BOOLEAN)
  992. mainStream << " lv2:portProperty lv2:toggled ;\n";
  993. if (paramData.hints & PARAMETER_IS_INTEGER)
  994. mainStream << " lv2:portProperty lv2:integer ;\n";
  995. // TODO logarithmic, enabled (not on gui), automatable, samplerate, scalepoints
  996. if (! getParameterName(i, strBufName))
  997. strBufName[0] = '\0';
  998. if (! getParameterSymbol(i, strBufSymbol))
  999. strBufSymbol[0] = '\0';
  1000. if (strBufSymbol[0] == '\0')
  1001. {
  1002. CarlaString s(strBufName);
  1003. s.toBasic();
  1004. std::memcpy(strBufSymbol, s.buffer(), s.length()+1);
  1005. if (strBufSymbol[0] >= '0' && strBufSymbol[0] <= '9')
  1006. {
  1007. const size_t len(std::strlen(strBufSymbol));
  1008. std::memmove(strBufSymbol+1, strBufSymbol, len);
  1009. strBufSymbol[0] = '_';
  1010. strBufSymbol[len+1] = '\0';
  1011. }
  1012. }
  1013. if (uniqueSymbolNames.contains(strBufSymbol))
  1014. std::snprintf(strBufSymbol, STR_MAX, "clv2_param_%d", i+1);
  1015. mainStream << " lv2:index " << portIndexNum << " ;\n";
  1016. mainStream << " lv2:symbol \"" << strBufSymbol << "\" ;\n";
  1017. mainStream << " lv2:name \"\"\"" << strBufName << "\"\"\" ;\n";
  1018. mainStream << " lv2:default " << String(paramRanges.def) << " ;\n";
  1019. mainStream << " lv2:minimum " << String(paramRanges.min) << " ;\n";
  1020. mainStream << " lv2:maximum " << String(paramRanges.max) << " ;\n";
  1021. // TODO midiCC, midiChannel
  1022. mainStream << " ] ;\n";
  1023. }
  1024. char strBuf[STR_MAX+1];
  1025. carla_zeroChars(strBuf, STR_MAX+1);
  1026. if (! getMaker(strBuf))
  1027. strBuf[0] = '\0';
  1028. mainStream << " rdfs:comment \"Plugin generated using Carla LV2 export.\" ;\n";
  1029. mainStream << " doap:name \"\"\"" << getName() << "\"\"\" ;\n";
  1030. mainStream << " doap:maintainer [ foaf:name \"\"\"" << strBuf << "\"\"\" ] .\n";
  1031. mainStream << "\n";
  1032. const CarlaString mainFilename(bundlepath + CARLA_OS_SEP_STR + symbol + ".ttl");
  1033. const File mainFile(mainFilename.buffer());
  1034. if (! mainFile.replaceWithData(mainStream.getData(), mainStream.getDataSize()))
  1035. {
  1036. pData->engine->setLastError("Failed to write main plugin ttl file");
  1037. return false;
  1038. }
  1039. }
  1040. const CarlaString binaryFilename(bundlepath + CARLA_OS_SEP_STR + symbol + CARLA_LIB_EXT);
  1041. const File binaryFileSource(File::getSpecialLocation(File::currentExecutableFile).getSiblingFile("carla-bridge-lv2" CARLA_LIB_EXT));
  1042. const File binaryFileTarget(binaryFilename.buffer());
  1043. const EngineOptions& opts(pData->engine->getOptions());
  1044. const CarlaString binFolderTarget(bundlepath + CARLA_OS_SEP_STR + "bin");
  1045. const CarlaString resFolderTarget(bundlepath + CARLA_OS_SEP_STR + "res");
  1046. if (! binaryFileSource.copyFileTo(binaryFileTarget))
  1047. {
  1048. pData->engine->setLastError("Failed to copy plugin binary");
  1049. return false;
  1050. }
  1051. #ifdef CARLA_OS_WIN
  1052. File(opts.resourceDir).copyDirectoryTo(File(resFolderTarget.buffer()));
  1053. // Copying all the binaries is pointless, just go through the expected needed bits
  1054. const File binFolder1(opts.binaryDir);
  1055. const File binFolder2(binFolderTarget.buffer());
  1056. binFolder2.createDirectory();
  1057. static const char* files[] = {
  1058. "carla-bridge-native.exe",
  1059. "carla-bridge-win32.exe",
  1060. "carla-discovery-win32.exe",
  1061. "carla-discovery-win64.exe",
  1062. "libcarla_utils.dll"
  1063. };
  1064. for (int i=0; i<5; ++i)
  1065. binFolder1.getChildFile(files[i]).copyFileTo(binFolder2.getChildFile(files[i]));;
  1066. #else
  1067. File(opts.binaryDir).createSymbolicLink(File(binFolderTarget.buffer()), true);
  1068. File(opts.resourceDir).createSymbolicLink(File(resFolderTarget.buffer()), true);
  1069. #endif
  1070. return true;
  1071. }
  1072. #endif
  1073. // -------------------------------------------------------------------
  1074. // Set data (internal stuff)
  1075. void CarlaPlugin::setId(const uint newId) noexcept
  1076. {
  1077. pData->id = newId;
  1078. }
  1079. void CarlaPlugin::setName(const char* const newName)
  1080. {
  1081. CARLA_SAFE_ASSERT_RETURN(newName != nullptr && newName[0] != '\0',);
  1082. if (pData->name != nullptr)
  1083. delete[] pData->name;
  1084. pData->name = carla_strdup(newName);
  1085. }
  1086. void CarlaPlugin::setOption(const uint option, const bool yesNo, const bool sendCallback)
  1087. {
  1088. CARLA_SAFE_ASSERT_UINT2_RETURN(getOptionsAvailable() & option, getOptionsAvailable(), option,);
  1089. if (yesNo)
  1090. pData->options |= option;
  1091. else
  1092. pData->options &= ~option;
  1093. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1094. if (sendCallback)
  1095. pData->engine->callback(true, true,
  1096. ENGINE_CALLBACK_OPTION_CHANGED,
  1097. pData->id,
  1098. static_cast<int>(option),
  1099. yesNo ? 1 : 0,
  1100. 0, 0.0f, nullptr);
  1101. #else
  1102. // unused
  1103. return; (void)sendCallback;
  1104. #endif
  1105. }
  1106. void CarlaPlugin::setEnabled(const bool yesNo) noexcept
  1107. {
  1108. if (pData->enabled == yesNo)
  1109. return;
  1110. pData->masterMutex.lock();
  1111. pData->enabled = yesNo;
  1112. if (yesNo && ! pData->client->isActive())
  1113. pData->client->activate();
  1114. pData->masterMutex.unlock();
  1115. }
  1116. void CarlaPlugin::setActive(const bool active, const bool sendOsc, const bool sendCallback) noexcept
  1117. {
  1118. if (pData->engineBridged) {
  1119. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1120. } else if (pData->enginePlugin) {
  1121. // nothing here
  1122. } else {
  1123. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1124. }
  1125. if (pData->active == active)
  1126. return;
  1127. {
  1128. const ScopedSingleProcessLocker spl(this, true);
  1129. if (active)
  1130. activate();
  1131. else
  1132. deactivate();
  1133. }
  1134. pData->active = active;
  1135. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1136. const float value = active ? 1.0f : 0.0f;
  1137. pData->engine->callback(sendCallback, sendOsc,
  1138. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1139. pData->id,
  1140. PARAMETER_ACTIVE,
  1141. 0, 0,
  1142. value,
  1143. nullptr);
  1144. #endif
  1145. }
  1146. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1147. void CarlaPlugin::setDryWet(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1148. {
  1149. if (pData->engineBridged) {
  1150. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1151. } else {
  1152. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1153. }
  1154. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.0f);
  1155. const float fixedValue(carla_fixedValue<float>(0.0f, 1.0f, value));
  1156. if (carla_isEqual(pData->postProc.dryWet, fixedValue))
  1157. return;
  1158. pData->postProc.dryWet = fixedValue;
  1159. pData->engine->callback(sendCallback, sendOsc,
  1160. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1161. pData->id,
  1162. PARAMETER_DRYWET,
  1163. 0, 0,
  1164. fixedValue,
  1165. nullptr);
  1166. }
  1167. void CarlaPlugin::setVolume(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1168. {
  1169. if (pData->engineBridged) {
  1170. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1171. } else {
  1172. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1173. }
  1174. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.27f);
  1175. const float fixedValue(carla_fixedValue<float>(0.0f, 1.27f, value));
  1176. if (carla_isEqual(pData->postProc.volume, fixedValue))
  1177. return;
  1178. pData->postProc.volume = fixedValue;
  1179. pData->engine->callback(sendCallback, sendOsc,
  1180. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1181. pData->id,
  1182. PARAMETER_VOLUME,
  1183. 0, 0,
  1184. fixedValue,
  1185. nullptr);
  1186. }
  1187. void CarlaPlugin::setBalanceLeft(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1188. {
  1189. if (pData->engineBridged) {
  1190. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1191. } else {
  1192. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1193. }
  1194. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1195. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1196. if (carla_isEqual(pData->postProc.balanceLeft, fixedValue))
  1197. return;
  1198. pData->postProc.balanceLeft = fixedValue;
  1199. pData->engine->callback(sendCallback, sendOsc,
  1200. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1201. pData->id,
  1202. PARAMETER_BALANCE_LEFT,
  1203. 0, 0,
  1204. fixedValue,
  1205. nullptr);
  1206. }
  1207. void CarlaPlugin::setBalanceRight(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1208. {
  1209. if (pData->engineBridged) {
  1210. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1211. } else {
  1212. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1213. }
  1214. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1215. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1216. if (carla_isEqual(pData->postProc.balanceRight, fixedValue))
  1217. return;
  1218. pData->postProc.balanceRight = fixedValue;
  1219. pData->engine->callback(sendCallback, sendOsc,
  1220. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1221. pData->id,
  1222. PARAMETER_BALANCE_RIGHT,
  1223. 0, 0,
  1224. fixedValue,
  1225. nullptr);
  1226. }
  1227. void CarlaPlugin::setPanning(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1228. {
  1229. if (pData->engineBridged) {
  1230. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1231. } else {
  1232. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1233. }
  1234. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1235. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1236. if (carla_isEqual(pData->postProc.panning, fixedValue))
  1237. return;
  1238. pData->postProc.panning = fixedValue;
  1239. pData->engine->callback(sendCallback, sendOsc,
  1240. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1241. pData->id,
  1242. PARAMETER_PANNING,
  1243. 0, 0,
  1244. fixedValue,
  1245. nullptr);
  1246. }
  1247. void CarlaPlugin::setDryWetRT(const float value, const bool sendCallbackLater) noexcept
  1248. {
  1249. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.0f);
  1250. const float fixedValue(carla_fixedValue<float>(0.0f, 1.0f, value));
  1251. if (carla_isEqual(pData->postProc.dryWet, fixedValue))
  1252. return;
  1253. pData->postProc.dryWet = fixedValue;
  1254. pData->postponeParameterChangeRtEvent(sendCallbackLater, PARAMETER_DRYWET, fixedValue);
  1255. }
  1256. void CarlaPlugin::setVolumeRT(const float value, const bool sendCallbackLater) noexcept
  1257. {
  1258. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.27f);
  1259. const float fixedValue(carla_fixedValue<float>(0.0f, 1.27f, value));
  1260. if (carla_isEqual(pData->postProc.volume, fixedValue))
  1261. return;
  1262. pData->postProc.volume = fixedValue;
  1263. pData->postponeParameterChangeRtEvent(sendCallbackLater, PARAMETER_VOLUME, fixedValue);
  1264. }
  1265. void CarlaPlugin::setBalanceLeftRT(const float value, const bool sendCallbackLater) noexcept
  1266. {
  1267. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1268. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1269. if (carla_isEqual(pData->postProc.balanceLeft, fixedValue))
  1270. return;
  1271. pData->postProc.balanceLeft = fixedValue;
  1272. pData->postponeParameterChangeRtEvent(sendCallbackLater, PARAMETER_BALANCE_LEFT, fixedValue);
  1273. }
  1274. void CarlaPlugin::setBalanceRightRT(const float value, const bool sendCallbackLater) noexcept
  1275. {
  1276. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1277. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1278. if (carla_isEqual(pData->postProc.balanceRight, fixedValue))
  1279. return;
  1280. pData->postProc.balanceRight = fixedValue;
  1281. pData->postponeParameterChangeRtEvent(sendCallbackLater, PARAMETER_BALANCE_RIGHT, fixedValue);
  1282. }
  1283. void CarlaPlugin::setPanningRT(const float value, const bool sendCallbackLater) noexcept
  1284. {
  1285. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1286. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1287. if (carla_isEqual(pData->postProc.panning, fixedValue))
  1288. return;
  1289. pData->postProc.panning = fixedValue;
  1290. pData->postponeParameterChangeRtEvent(sendCallbackLater, PARAMETER_PANNING, fixedValue);
  1291. }
  1292. #endif // ! BUILD_BRIDGE_ALTERNATIVE_ARCH
  1293. void CarlaPlugin::setCtrlChannel(const int8_t channel, const bool sendOsc, const bool sendCallback) noexcept
  1294. {
  1295. if (pData->engineBridged) {
  1296. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1297. } else {
  1298. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1299. }
  1300. CARLA_SAFE_ASSERT_RETURN(channel >= -1 && channel < MAX_MIDI_CHANNELS,);
  1301. if (pData->ctrlChannel == channel)
  1302. return;
  1303. pData->ctrlChannel = channel;
  1304. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1305. const float channelf = static_cast<float>(channel);
  1306. pData->engine->callback(sendCallback, sendOsc,
  1307. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1308. pData->id,
  1309. PARAMETER_CTRL_CHANNEL,
  1310. 0, 0,
  1311. channelf, nullptr);
  1312. #endif
  1313. }
  1314. // -------------------------------------------------------------------
  1315. // Set data (plugin-specific stuff)
  1316. void CarlaPlugin::setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept
  1317. {
  1318. if (pData->engineBridged) {
  1319. // NOTE: some LV2 plugins feedback messages to UI on purpose
  1320. CARLA_SAFE_ASSERT_RETURN(getType() == PLUGIN_LV2 || !sendGui,);
  1321. } else if (pData->enginePlugin) {
  1322. // nothing here
  1323. } else {
  1324. CARLA_SAFE_ASSERT_RETURN(sendGui || sendOsc || sendCallback,); // never call this from RT
  1325. }
  1326. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  1327. if (sendGui && (pData->hints & PLUGIN_HAS_CUSTOM_UI) != 0)
  1328. uiParameterChange(parameterId, value);
  1329. pData->engine->callback(sendCallback, sendOsc,
  1330. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1331. pData->id,
  1332. static_cast<int>(parameterId),
  1333. 0, 0,
  1334. value,
  1335. nullptr);
  1336. }
  1337. void CarlaPlugin::setParameterValueRT(const uint32_t parameterId, const float value, uint32_t, const bool sendCallbackLater) noexcept
  1338. {
  1339. pData->postponeParameterChangeRtEvent(sendCallbackLater, static_cast<int32_t>(parameterId), value);
  1340. }
  1341. void CarlaPlugin::setParameterValueByRealIndex(const int32_t rindex, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept
  1342. {
  1343. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1344. CARLA_SAFE_ASSERT_RETURN(rindex > PARAMETER_MAX && rindex != PARAMETER_NULL,);
  1345. switch (rindex)
  1346. {
  1347. case PARAMETER_ACTIVE:
  1348. return setActive((value > 0.0f), sendOsc, sendCallback);
  1349. case PARAMETER_CTRL_CHANNEL:
  1350. return setCtrlChannel(int8_t(value), sendOsc, sendCallback);
  1351. case PARAMETER_DRYWET:
  1352. return setDryWet(value, sendOsc, sendCallback);
  1353. case PARAMETER_VOLUME:
  1354. return setVolume(value, sendOsc, sendCallback);
  1355. case PARAMETER_BALANCE_LEFT:
  1356. return setBalanceLeft(value, sendOsc, sendCallback);
  1357. case PARAMETER_BALANCE_RIGHT:
  1358. return setBalanceRight(value, sendOsc, sendCallback);
  1359. case PARAMETER_PANNING:
  1360. return setPanning(value, sendOsc, sendCallback);
  1361. }
  1362. #endif
  1363. CARLA_SAFE_ASSERT_RETURN(rindex >= 0,);
  1364. for (uint32_t i=0; i < pData->param.count; ++i)
  1365. {
  1366. if (pData->param.data[i].rindex == rindex)
  1367. {
  1368. //if (carla_isNotEqual(getParameterValue(i), value))
  1369. setParameterValue(i, value, sendGui, sendOsc, sendCallback);
  1370. break;
  1371. }
  1372. }
  1373. }
  1374. void CarlaPlugin::setParameterMidiChannel(const uint32_t parameterId, const uint8_t channel, const bool sendOsc, const bool sendCallback) noexcept
  1375. {
  1376. if (pData->engineBridged) {
  1377. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1378. } else {
  1379. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1380. }
  1381. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  1382. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1383. if (pData->param.data[parameterId].midiChannel == channel)
  1384. return;
  1385. pData->param.data[parameterId].midiChannel = channel;
  1386. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1387. pData->engine->callback(sendCallback, sendOsc,
  1388. ENGINE_CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED,
  1389. pData->id,
  1390. static_cast<int>(parameterId),
  1391. channel,
  1392. 0, 0.0f, nullptr);
  1393. #endif
  1394. }
  1395. void CarlaPlugin::setParameterMappedControlIndex(const uint32_t parameterId, const int16_t index,
  1396. const bool sendOsc, const bool sendCallback,
  1397. const bool reconfigureNow) noexcept
  1398. {
  1399. if (pData->engineBridged) {
  1400. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1401. } else {
  1402. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1403. }
  1404. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  1405. CARLA_SAFE_ASSERT_RETURN(index >= CONTROL_INDEX_NONE && index <= CONTROL_INDEX_MAX_ALLOWED,);
  1406. ParameterData& paramData(pData->param.data[parameterId]);
  1407. if (paramData.mappedControlIndex == index)
  1408. return;
  1409. const ParameterRanges& paramRanges(pData->param.ranges[parameterId]);
  1410. if ((paramData.hints & PARAMETER_MAPPED_RANGES_SET) == 0x0)
  1411. setParameterMappedRange(parameterId, paramRanges.min, paramRanges.max, true, true);
  1412. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1413. char strBuf[STR_MAX+1];
  1414. carla_zeroChars(strBuf, STR_MAX+1);
  1415. if (! getParameterName(parameterId, strBuf))
  1416. std::snprintf(strBuf, STR_MAX, "Param %u", parameterId);
  1417. const uint portNameSize = pData->engine->getMaxPortNameSize();
  1418. if (portNameSize < STR_MAX)
  1419. strBuf[portNameSize] = '\0';
  1420. // was learning something else before, stop that first
  1421. if (pData->midiLearnParameterIndex >= 0 && pData->midiLearnParameterIndex != static_cast<int32_t>(parameterId))
  1422. {
  1423. const int32_t oldParameterId = pData->midiLearnParameterIndex;
  1424. pData->midiLearnParameterIndex = -1;
  1425. CARLA_SAFE_ASSERT_RETURN(oldParameterId < static_cast<int32_t>(pData->param.count),);
  1426. pData->param.data[oldParameterId].mappedControlIndex = CONTROL_INDEX_NONE;
  1427. pData->engine->callback(true, true,
  1428. ENGINE_CALLBACK_PARAMETER_MAPPED_CONTROL_INDEX_CHANGED,
  1429. pData->id,
  1430. oldParameterId,
  1431. CONTROL_INDEX_NONE,
  1432. 0, 0.0f, nullptr);
  1433. }
  1434. // mapping new parameter to CV
  1435. if (index == CONTROL_INDEX_CV)
  1436. {
  1437. CARLA_SAFE_ASSERT_RETURN(pData->event.cvSourcePorts != nullptr,);
  1438. CARLA_SAFE_ASSERT_RETURN(paramData.type == PARAMETER_INPUT,);
  1439. CARLA_SAFE_ASSERT_RETURN(paramData.hints & PARAMETER_CAN_BE_CV_CONTROLLED,);
  1440. CarlaEngineCVPort* const cvPort =
  1441. (CarlaEngineCVPort*)pData->client->addPort(kEnginePortTypeCV, strBuf, true, parameterId);
  1442. cvPort->setRange(paramData.mappedMinimum, paramData.mappedMaximum);
  1443. pData->event.cvSourcePorts->addCVSource(cvPort, parameterId, reconfigureNow);
  1444. }
  1445. // unmapping from CV
  1446. else if (paramData.mappedControlIndex == CONTROL_INDEX_CV)
  1447. {
  1448. CARLA_SAFE_ASSERT_RETURN(pData->event.cvSourcePorts != nullptr,);
  1449. CARLA_SAFE_ASSERT(pData->client->removePort(kEnginePortTypeCV, strBuf, true));
  1450. CARLA_SAFE_ASSERT(pData->event.cvSourcePorts->removeCVSource(parameterId));
  1451. }
  1452. // mapping to something new
  1453. else if (paramData.mappedControlIndex == CONTROL_INDEX_NONE)
  1454. {
  1455. // when doing MIDI CC mapping, ensure ranges are within bounds
  1456. if (paramData.mappedMinimum < paramRanges.min || paramData.mappedMaximum > paramRanges.max)
  1457. setParameterMappedRange(parameterId,
  1458. std::max(paramData.mappedMinimum, paramRanges.min),
  1459. std::min(paramData.mappedMaximum, paramRanges.max),
  1460. true, true);
  1461. }
  1462. #endif
  1463. paramData.mappedControlIndex = index;
  1464. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1465. if (index == CONTROL_INDEX_MIDI_LEARN)
  1466. pData->midiLearnParameterIndex = static_cast<int32_t>(parameterId);
  1467. else
  1468. pData->midiLearnParameterIndex = -1;
  1469. pData->engine->callback(sendCallback, sendOsc,
  1470. ENGINE_CALLBACK_PARAMETER_MAPPED_CONTROL_INDEX_CHANGED,
  1471. pData->id,
  1472. static_cast<int>(parameterId),
  1473. index,
  1474. 0, 0.0f, nullptr);
  1475. #else
  1476. return;
  1477. // unused
  1478. (void)reconfigureNow;
  1479. #endif
  1480. }
  1481. void CarlaPlugin::setParameterMappedRange(const uint32_t parameterId, const float minimum, const float maximum,
  1482. const bool sendOsc, const bool sendCallback) noexcept
  1483. {
  1484. if (pData->engineBridged) {
  1485. CARLA_SAFE_ASSERT_RETURN(!sendOsc && !sendCallback,);
  1486. } else {
  1487. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1488. }
  1489. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  1490. ParameterData& paramData(pData->param.data[parameterId]);
  1491. if (carla_isEqual(paramData.mappedMinimum, minimum) &&
  1492. carla_isEqual(paramData.mappedMaximum, maximum) &&
  1493. (paramData.hints & PARAMETER_MAPPED_RANGES_SET) != 0x0)
  1494. return;
  1495. if (paramData.mappedControlIndex != CONTROL_INDEX_NONE && paramData.mappedControlIndex != CONTROL_INDEX_CV)
  1496. {
  1497. const ParameterRanges& paramRanges(pData->param.ranges[parameterId]);
  1498. CARLA_SAFE_ASSERT_RETURN(minimum >= paramRanges.min,);
  1499. CARLA_SAFE_ASSERT_RETURN(maximum <= paramRanges.max,);
  1500. }
  1501. paramData.hints |= PARAMETER_MAPPED_RANGES_SET;
  1502. paramData.mappedMinimum = minimum;
  1503. paramData.mappedMaximum = maximum;
  1504. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1505. if (pData->event.cvSourcePorts != nullptr && paramData.mappedControlIndex == CONTROL_INDEX_CV)
  1506. pData->event.cvSourcePorts->setCVSourceRange(parameterId, minimum, maximum);
  1507. char strBuf[STR_MAX+1];
  1508. carla_zeroChars(strBuf, STR_MAX+1);
  1509. std::snprintf(strBuf, STR_MAX, "%.12g:%.12g", static_cast<double>(minimum), static_cast<double>(maximum));
  1510. pData->engine->callback(sendCallback, sendOsc,
  1511. ENGINE_CALLBACK_PARAMETER_MAPPED_RANGE_CHANGED,
  1512. pData->id,
  1513. static_cast<int>(parameterId),
  1514. 0, 0, 0.0f,
  1515. strBuf);
  1516. #endif
  1517. }
  1518. void CarlaPlugin::setCustomData(const char* const type, const char* const key, const char* const value, const bool)
  1519. {
  1520. CARLA_SAFE_ASSERT_RETURN(type != nullptr && type[0] != '\0',);
  1521. CARLA_SAFE_ASSERT_RETURN(key != nullptr && key[0] != '\0',);
  1522. CARLA_SAFE_ASSERT_RETURN(value != nullptr,);
  1523. // Ignore some keys
  1524. if (std::strcmp(type, CUSTOM_DATA_TYPE_STRING) == 0)
  1525. {
  1526. const PluginType ptype = getType();
  1527. if ((ptype == PLUGIN_INTERNAL && std::strncmp(key, "CarlaAlternateFile", 18) == 0) ||
  1528. (ptype == PLUGIN_DSSI && std::strcmp (key, "guiVisible") == 0) ||
  1529. (ptype == PLUGIN_LV2 && std::strncmp(key, "OSC:", 4) == 0))
  1530. return;
  1531. }
  1532. // Check if we already have this key
  1533. for (LinkedList<CustomData>::Itenerator it = pData->custom.begin2(); it.valid(); it.next())
  1534. {
  1535. CustomData& customData(it.getValue(kCustomDataFallbackNC));
  1536. CARLA_SAFE_ASSERT_CONTINUE(customData.isValid());
  1537. if (std::strcmp(customData.key, key) == 0)
  1538. {
  1539. if (customData.value != nullptr)
  1540. delete[] customData.value;
  1541. customData.value = carla_strdup(value);
  1542. return;
  1543. }
  1544. }
  1545. // Otherwise store it
  1546. CustomData customData;
  1547. customData.type = carla_strdup(type);
  1548. customData.key = carla_strdup(key);
  1549. customData.value = carla_strdup(value);
  1550. pData->custom.append(customData);
  1551. }
  1552. void CarlaPlugin::setChunkData(const void* const data, const std::size_t dataSize)
  1553. {
  1554. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  1555. CARLA_SAFE_ASSERT_RETURN(dataSize > 0,);
  1556. CARLA_SAFE_ASSERT(false); // this should never happen
  1557. }
  1558. void CarlaPlugin::setProgram(const int32_t index,
  1559. const bool sendGui, const bool sendOsc, const bool sendCallback, const bool) noexcept
  1560. {
  1561. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->prog.count),);
  1562. pData->prog.current = index;
  1563. pData->engine->callback(sendCallback, sendOsc,
  1564. ENGINE_CALLBACK_PROGRAM_CHANGED,
  1565. pData->id,
  1566. index,
  1567. 0, 0, 0.0f, nullptr);
  1568. // Change default parameter values
  1569. if (index >= 0)
  1570. {
  1571. if (sendGui && (pData->hints & PLUGIN_HAS_CUSTOM_UI) != 0)
  1572. uiProgramChange(static_cast<uint32_t>(index));
  1573. switch (getType())
  1574. {
  1575. case PLUGIN_SF2:
  1576. case PLUGIN_SFZ:
  1577. break;
  1578. default:
  1579. pData->updateParameterValues(this, sendCallback, sendOsc, true);
  1580. break;
  1581. }
  1582. }
  1583. }
  1584. void CarlaPlugin::setMidiProgram(const int32_t index,
  1585. const bool sendGui, const bool sendOsc, const bool sendCallback, const bool) noexcept
  1586. {
  1587. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->midiprog.count),);
  1588. pData->midiprog.current = index;
  1589. pData->engine->callback(sendCallback, sendOsc,
  1590. ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED,
  1591. pData->id,
  1592. index,
  1593. 0, 0, 0.0f, nullptr);
  1594. // Change default parameter values
  1595. if (index >= 0)
  1596. {
  1597. if (sendGui && (pData->hints & PLUGIN_HAS_CUSTOM_UI) != 0)
  1598. uiMidiProgramChange(static_cast<uint32_t>(index));
  1599. switch (getType())
  1600. {
  1601. case PLUGIN_SF2:
  1602. case PLUGIN_SFZ:
  1603. break;
  1604. default:
  1605. pData->updateParameterValues(this, sendCallback, sendOsc, true);
  1606. break;
  1607. }
  1608. }
  1609. }
  1610. void CarlaPlugin::setMidiProgramById(const uint32_t bank, const uint32_t program, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept
  1611. {
  1612. for (uint32_t i=0; i < pData->midiprog.count; ++i)
  1613. {
  1614. if (pData->midiprog.data[i].bank == bank && pData->midiprog.data[i].program == program)
  1615. return setMidiProgram(static_cast<int32_t>(i), sendGui, sendOsc, sendCallback);
  1616. }
  1617. }
  1618. void CarlaPlugin::setProgramRT(const uint32_t uindex, const bool sendCallbackLater) noexcept
  1619. {
  1620. CARLA_SAFE_ASSERT_RETURN(uindex < pData->prog.count,);
  1621. const int32_t index = static_cast<int32_t>(uindex);
  1622. pData->prog.current = index;
  1623. // Change default parameter values
  1624. switch (getType())
  1625. {
  1626. case PLUGIN_SF2:
  1627. case PLUGIN_SFZ:
  1628. break;
  1629. default:
  1630. pData->updateDefaultParameterValues(this);
  1631. break;
  1632. }
  1633. pData->postponeProgramChangeRtEvent(sendCallbackLater, uindex);
  1634. }
  1635. void CarlaPlugin::setMidiProgramRT(const uint32_t uindex, const bool sendCallbackLater) noexcept
  1636. {
  1637. CARLA_SAFE_ASSERT_RETURN(uindex < pData->midiprog.count,);
  1638. const int32_t index = static_cast<int32_t>(uindex);
  1639. pData->midiprog.current = index;
  1640. // Change default parameter values
  1641. switch (getType())
  1642. {
  1643. case PLUGIN_SF2:
  1644. case PLUGIN_SFZ:
  1645. break;
  1646. default:
  1647. pData->updateDefaultParameterValues(this);
  1648. break;
  1649. }
  1650. pData->postponeMidiProgramChangeRtEvent(sendCallbackLater, uindex);
  1651. }
  1652. // -------------------------------------------------------------------
  1653. // Plugin state
  1654. void CarlaPlugin::reloadPrograms(const bool)
  1655. {
  1656. }
  1657. // -------------------------------------------------------------------
  1658. // Plugin processing
  1659. void CarlaPlugin::activate() noexcept
  1660. {
  1661. CARLA_SAFE_ASSERT(! pData->active);
  1662. }
  1663. void CarlaPlugin::deactivate() noexcept
  1664. {
  1665. CARLA_SAFE_ASSERT(pData->active);
  1666. }
  1667. void CarlaPlugin::bufferSizeChanged(const uint32_t newBufferSize)
  1668. {
  1669. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1670. delete[] pData->postProc.extraBuffer;
  1671. pData->postProc.extraBuffer = new float[newBufferSize];
  1672. #else
  1673. // unused
  1674. (void)newBufferSize;
  1675. #endif
  1676. }
  1677. void CarlaPlugin::sampleRateChanged(const double)
  1678. {
  1679. }
  1680. void CarlaPlugin::offlineModeChanged(const bool)
  1681. {
  1682. }
  1683. // -------------------------------------------------------------------
  1684. // Misc
  1685. void CarlaPlugin::idle()
  1686. {
  1687. if (! pData->enabled)
  1688. return;
  1689. const bool hasUI = pData->hints & PLUGIN_HAS_CUSTOM_UI;
  1690. const bool needsUiMainThread = pData->hints & PLUGIN_NEEDS_UI_MAIN_THREAD;
  1691. const uint32_t latency = getLatencyInFrames();
  1692. if (pData->latency.frames != latency)
  1693. {
  1694. carla_stdout("latency changed to %i samples", latency);
  1695. const ScopedSingleProcessLocker sspl(this, true);
  1696. pData->client->setLatency(latency);
  1697. #ifndef BUILD_BRIDGE
  1698. pData->latency.recreateBuffers(pData->latency.channels, latency);
  1699. #else
  1700. pData->latency.frames = latency;
  1701. #endif
  1702. }
  1703. ProtectedData::PostRtEvents::Access rtEvents(pData->postRtEvents);
  1704. if (rtEvents.isEmpty())
  1705. return;
  1706. for (RtLinkedList<PluginPostRtEvent>::Itenerator it = rtEvents.getDataIterator(); it.valid(); it.next())
  1707. {
  1708. const PluginPostRtEvent& event(it.getValue(kPluginPostRtEventFallback));
  1709. CARLA_SAFE_ASSERT_CONTINUE(event.type != kPluginPostRtEventNull);
  1710. switch (event.type)
  1711. {
  1712. case kPluginPostRtEventNull: {
  1713. } break;
  1714. case kPluginPostRtEventParameterChange: {
  1715. // Update UI
  1716. if (event.parameter.index >= 0 && hasUI)
  1717. {
  1718. if (needsUiMainThread)
  1719. pData->postUiEvents.append(event);
  1720. else
  1721. uiParameterChange(static_cast<uint32_t>(event.parameter.index), event.parameter.value);
  1722. }
  1723. if (event.sendCallback)
  1724. {
  1725. // Update Host
  1726. pData->engine->callback(true, true,
  1727. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1728. pData->id,
  1729. event.parameter.index,
  1730. 0, 0,
  1731. event.parameter.value,
  1732. nullptr);
  1733. }
  1734. } break;
  1735. case kPluginPostRtEventProgramChange: {
  1736. // Update UI
  1737. if (hasUI)
  1738. {
  1739. if (needsUiMainThread)
  1740. pData->postUiEvents.append(event);
  1741. else
  1742. uiProgramChange(event.program.index);
  1743. }
  1744. // Update param values
  1745. for (uint32_t j=0; j < pData->param.count; ++j)
  1746. {
  1747. const float paramDefault(pData->param.ranges[j].def);
  1748. const float paramValue(getParameterValue(j));
  1749. pData->engine->callback(true, true,
  1750. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1751. pData->id,
  1752. static_cast<int>(j),
  1753. 0, 0,
  1754. paramValue,
  1755. nullptr);
  1756. pData->engine->callback(true, true,
  1757. ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED,
  1758. pData->id,
  1759. static_cast<int>(j),
  1760. 0, 0,
  1761. paramDefault,
  1762. nullptr);
  1763. }
  1764. if (event.sendCallback)
  1765. {
  1766. // Update Host
  1767. pData->engine->callback(true, true,
  1768. ENGINE_CALLBACK_PROGRAM_CHANGED,
  1769. pData->id,
  1770. static_cast<int>(event.program.index),
  1771. 0, 0, 0.0f, nullptr);
  1772. }
  1773. } break;
  1774. case kPluginPostRtEventMidiProgramChange: {
  1775. // Update UI
  1776. if (hasUI)
  1777. {
  1778. if (needsUiMainThread)
  1779. pData->postUiEvents.append(event);
  1780. else
  1781. uiMidiProgramChange(event.program.index);
  1782. }
  1783. // Update param values
  1784. for (uint32_t j=0; j < pData->param.count; ++j)
  1785. {
  1786. const float paramDefault(pData->param.ranges[j].def);
  1787. const float paramValue(getParameterValue(j));
  1788. pData->engine->callback(true, true,
  1789. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED,
  1790. pData->id,
  1791. static_cast<int>(j),
  1792. 0, 0,
  1793. paramValue,
  1794. nullptr);
  1795. pData->engine->callback(true, true,
  1796. ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED,
  1797. pData->id,
  1798. static_cast<int>(j),
  1799. 0, 0,
  1800. paramDefault,
  1801. nullptr);
  1802. }
  1803. if (event.sendCallback)
  1804. {
  1805. // Update Host
  1806. pData->engine->callback(true, true,
  1807. ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED,
  1808. pData->id,
  1809. static_cast<int>(event.program.index),
  1810. 0, 0, 0.0f, nullptr);
  1811. }
  1812. } break;
  1813. case kPluginPostRtEventNoteOn: {
  1814. CARLA_SAFE_ASSERT_BREAK(event.note.channel < MAX_MIDI_CHANNELS);
  1815. CARLA_SAFE_ASSERT_BREAK(event.note.note < MAX_MIDI_NOTE);
  1816. CARLA_SAFE_ASSERT_BREAK(event.note.velocity < MAX_MIDI_VALUE);
  1817. // Update UI
  1818. if (hasUI)
  1819. {
  1820. if (needsUiMainThread)
  1821. pData->postUiEvents.append(event);
  1822. else
  1823. uiNoteOn(event.note.channel, event.note.note, event.note.velocity);
  1824. }
  1825. if (event.sendCallback)
  1826. {
  1827. // Update Host
  1828. pData->engine->callback(true, true,
  1829. ENGINE_CALLBACK_NOTE_ON,
  1830. pData->id,
  1831. static_cast<int>(event.note.channel),
  1832. static_cast<int>(event.note.note),
  1833. static_cast<int>(event.note.velocity),
  1834. 0.0f, nullptr);
  1835. }
  1836. } break;
  1837. case kPluginPostRtEventNoteOff: {
  1838. CARLA_SAFE_ASSERT_BREAK(event.note.channel < MAX_MIDI_CHANNELS);
  1839. CARLA_SAFE_ASSERT_BREAK(event.note.note < MAX_MIDI_NOTE);
  1840. // Update UI
  1841. if (hasUI)
  1842. {
  1843. if (needsUiMainThread)
  1844. pData->postUiEvents.append(event);
  1845. else
  1846. uiNoteOff(event.note.channel, event.note.note);
  1847. }
  1848. if (event.sendCallback)
  1849. {
  1850. // Update Host
  1851. pData->engine->callback(true, true,
  1852. ENGINE_CALLBACK_NOTE_OFF,
  1853. pData->id,
  1854. static_cast<int>(event.note.channel),
  1855. static_cast<int>(event.note.note),
  1856. 0, 0.0f, nullptr);
  1857. }
  1858. } break;
  1859. case kPluginPostRtEventMidiLearn: {
  1860. CARLA_SAFE_ASSERT_BREAK(event.midiLearn.cc < MAX_MIDI_VALUE);
  1861. CARLA_SAFE_ASSERT_BREAK(event.midiLearn.channel < MAX_MIDI_CHANNELS);
  1862. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1863. if (event.sendCallback)
  1864. {
  1865. pData->engine->callback(true, true,
  1866. ENGINE_CALLBACK_PARAMETER_MAPPED_CONTROL_INDEX_CHANGED,
  1867. pData->id,
  1868. static_cast<int>(event.midiLearn.parameter),
  1869. static_cast<int>(event.midiLearn.cc),
  1870. 0, 0.0f, nullptr);
  1871. pData->engine->callback(true, true,
  1872. ENGINE_CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED,
  1873. pData->id,
  1874. static_cast<int>(event.midiLearn.parameter),
  1875. static_cast<int>(event.midiLearn.channel),
  1876. 0, 0.0f, nullptr);
  1877. }
  1878. #endif
  1879. } break;
  1880. }
  1881. }
  1882. }
  1883. bool CarlaPlugin::tryLock(const bool forcedOffline) noexcept
  1884. {
  1885. if (forcedOffline)
  1886. {
  1887. #ifndef STOAT_TEST_BUILD
  1888. pData->masterMutex.lock();
  1889. return true;
  1890. #endif
  1891. }
  1892. return pData->masterMutex.tryLock();
  1893. }
  1894. void CarlaPlugin::unlock() noexcept
  1895. {
  1896. pData->masterMutex.unlock();
  1897. }
  1898. // -------------------------------------------------------------------
  1899. // Plugin buffers
  1900. void CarlaPlugin::initBuffers() const noexcept
  1901. {
  1902. pData->audioIn.initBuffers();
  1903. pData->audioOut.initBuffers();
  1904. pData->cvIn.initBuffers();
  1905. pData->cvOut.initBuffers();
  1906. pData->event.initBuffers();
  1907. }
  1908. void CarlaPlugin::clearBuffers() noexcept
  1909. {
  1910. pData->clearBuffers();
  1911. }
  1912. // -------------------------------------------------------------------
  1913. // OSC stuff
  1914. // FIXME
  1915. void CarlaPlugin::handleOscMessage(const char*, int, const void*, const char*, void*)
  1916. {
  1917. // do nothing
  1918. }
  1919. // -------------------------------------------------------------------
  1920. // MIDI events
  1921. void CarlaPlugin::sendMidiSingleNote(const uint8_t channel, const uint8_t note, const uint8_t velo, const bool sendGui, const bool sendOsc, const bool sendCallback)
  1922. {
  1923. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1924. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1925. CARLA_SAFE_ASSERT_RETURN(velo < MAX_MIDI_VALUE,);
  1926. if (! pData->active)
  1927. return;
  1928. ExternalMidiNote extNote;
  1929. extNote.channel = static_cast<int8_t>(channel);
  1930. extNote.note = note;
  1931. extNote.velo = velo;
  1932. pData->extNotes.appendNonRT(extNote);
  1933. if (sendGui && (pData->hints & PLUGIN_HAS_CUSTOM_UI) != 0)
  1934. {
  1935. if (velo > 0)
  1936. uiNoteOn(channel, note, velo);
  1937. else
  1938. uiNoteOff(channel, note);
  1939. }
  1940. pData->engine->callback(sendCallback, sendOsc,
  1941. (velo > 0) ? ENGINE_CALLBACK_NOTE_ON : ENGINE_CALLBACK_NOTE_OFF,
  1942. pData->id,
  1943. channel,
  1944. note,
  1945. velo,
  1946. 0.0f, nullptr);
  1947. }
  1948. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1949. void CarlaPlugin::postponeRtAllNotesOff()
  1950. {
  1951. if (pData->ctrlChannel < 0 || pData->ctrlChannel >= MAX_MIDI_CHANNELS)
  1952. return;
  1953. PluginPostRtEvent postEvent = { kPluginPostRtEventNoteOff, true, {} };
  1954. postEvent.note.channel = static_cast<uint8_t>(pData->ctrlChannel);
  1955. for (uint8_t i=0; i < MAX_MIDI_NOTE; ++i)
  1956. {
  1957. postEvent.note.note = i;
  1958. pData->postRtEvents.appendRT(postEvent);
  1959. }
  1960. }
  1961. #endif
  1962. // -------------------------------------------------------------------
  1963. // UI Stuff
  1964. void CarlaPlugin::setCustomUITitle(const char* const title) noexcept
  1965. {
  1966. pData->uiTitle = title;
  1967. }
  1968. void CarlaPlugin::showCustomUI(const bool yesNo)
  1969. {
  1970. if (yesNo) {
  1971. CARLA_SAFE_ASSERT(false);
  1972. }
  1973. }
  1974. void* CarlaPlugin::embedCustomUI(void*)
  1975. {
  1976. return nullptr;
  1977. }
  1978. void CarlaPlugin::uiIdle()
  1979. {
  1980. if (pData->hints & PLUGIN_NEEDS_UI_MAIN_THREAD)
  1981. {
  1982. // Update parameter outputs
  1983. for (uint32_t i=0; i < pData->param.count; ++i)
  1984. {
  1985. if (pData->param.data[i].type == PARAMETER_OUTPUT)
  1986. uiParameterChange(i, getParameterValue(i));
  1987. }
  1988. const CarlaMutexLocker sl(pData->postUiEvents.mutex);
  1989. for (LinkedList<PluginPostRtEvent>::Itenerator it = pData->postUiEvents.data.begin2(); it.valid(); it.next())
  1990. {
  1991. const PluginPostRtEvent& event(it.getValue(kPluginPostRtEventFallback));
  1992. CARLA_SAFE_ASSERT_CONTINUE(event.type != kPluginPostRtEventNull);
  1993. switch (event.type)
  1994. {
  1995. case kPluginPostRtEventNull:
  1996. case kPluginPostRtEventMidiLearn:
  1997. break;
  1998. case kPluginPostRtEventParameterChange:
  1999. uiParameterChange(static_cast<uint32_t>(event.parameter.index), event.parameter.value);
  2000. break;
  2001. case kPluginPostRtEventProgramChange:
  2002. uiProgramChange(event.program.index);
  2003. break;
  2004. case kPluginPostRtEventMidiProgramChange:
  2005. uiMidiProgramChange(event.program.index);
  2006. break;
  2007. case kPluginPostRtEventNoteOn:
  2008. uiNoteOn(event.note.channel, event.note.note, event.note.velocity);
  2009. break;
  2010. case kPluginPostRtEventNoteOff:
  2011. uiNoteOff(event.note.channel, event.note.note);
  2012. break;
  2013. }
  2014. }
  2015. pData->postUiEvents.data.clear();
  2016. }
  2017. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  2018. if (pData->transientTryCounter == 0)
  2019. return;
  2020. if (++pData->transientTryCounter % 10 != 0)
  2021. return;
  2022. if (pData->transientTryCounter >= 200)
  2023. return;
  2024. carla_stdout("Trying to get window...");
  2025. CarlaString uiTitle;
  2026. if (pData->uiTitle.isNotEmpty())
  2027. {
  2028. uiTitle = pData->uiTitle;
  2029. }
  2030. else
  2031. {
  2032. uiTitle = pData->name;
  2033. uiTitle += " (GUI)";
  2034. }
  2035. if (CarlaPluginUI::tryTransientWinIdMatch(getUiBridgeProcessId(), uiTitle,
  2036. pData->engine->getOptions().frontendWinId, pData->transientFirstTry))
  2037. {
  2038. pData->transientTryCounter = 0;
  2039. pData->transientFirstTry = false;
  2040. }
  2041. #endif
  2042. }
  2043. void CarlaPlugin::uiParameterChange(const uint32_t index, const float value) noexcept
  2044. {
  2045. CARLA_SAFE_ASSERT_RETURN(index < getParameterCount(),);
  2046. return;
  2047. // unused
  2048. (void)value;
  2049. }
  2050. void CarlaPlugin::uiProgramChange(const uint32_t index) noexcept
  2051. {
  2052. CARLA_SAFE_ASSERT_RETURN(index < getProgramCount(),);
  2053. }
  2054. void CarlaPlugin::uiMidiProgramChange(const uint32_t index) noexcept
  2055. {
  2056. CARLA_SAFE_ASSERT_RETURN(index < getMidiProgramCount(),);
  2057. }
  2058. void CarlaPlugin::uiNoteOn(const uint8_t channel, const uint8_t note, const uint8_t velo) noexcept
  2059. {
  2060. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  2061. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  2062. CARLA_SAFE_ASSERT_RETURN(velo > 0 && velo < MAX_MIDI_VALUE,);
  2063. }
  2064. void CarlaPlugin::uiNoteOff(const uint8_t channel, const uint8_t note) noexcept
  2065. {
  2066. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  2067. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  2068. }
  2069. CarlaEngine* CarlaPlugin::getEngine() const noexcept
  2070. {
  2071. return pData->engine;
  2072. }
  2073. CarlaEngineClient* CarlaPlugin::getEngineClient() const noexcept
  2074. {
  2075. return pData->client;
  2076. }
  2077. CarlaEngineAudioPort* CarlaPlugin::getAudioInPort(const uint32_t index) const noexcept
  2078. {
  2079. return pData->audioIn.ports[index].port;
  2080. }
  2081. CarlaEngineAudioPort* CarlaPlugin::getAudioOutPort(const uint32_t index) const noexcept
  2082. {
  2083. return pData->audioOut.ports[index].port;
  2084. }
  2085. CarlaEngineCVPort* CarlaPlugin::getCVInPort(const uint32_t index) const noexcept
  2086. {
  2087. return pData->cvIn.ports[index].port;
  2088. }
  2089. CarlaEngineCVPort* CarlaPlugin::getCVOutPort(const uint32_t index) const noexcept
  2090. {
  2091. return pData->cvOut.ports[index].port;
  2092. }
  2093. CarlaEngineEventPort* CarlaPlugin::getDefaultEventInPort() const noexcept
  2094. {
  2095. return pData->event.portIn;
  2096. }
  2097. CarlaEngineEventPort* CarlaPlugin::getDefaultEventOutPort() const noexcept
  2098. {
  2099. return pData->event.portOut;
  2100. }
  2101. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  2102. void CarlaPlugin::checkForMidiLearn(EngineEvent& event) noexcept
  2103. {
  2104. if (pData->midiLearnParameterIndex < 0)
  2105. return;
  2106. if (event.ctrl.param == MIDI_CONTROL_BANK_SELECT || event.ctrl.param == MIDI_CONTROL_BANK_SELECT__LSB)
  2107. return;
  2108. if (event.ctrl.param >= MAX_MIDI_CONTROL)
  2109. return;
  2110. const uint32_t parameterId = static_cast<uint32_t>(pData->midiLearnParameterIndex);
  2111. CARLA_SAFE_ASSERT_UINT2_RETURN(parameterId < pData->param.count, parameterId, pData->param.count,);
  2112. ParameterData& paramData(pData->param.data[parameterId]);
  2113. CARLA_SAFE_ASSERT_INT_RETURN(paramData.mappedControlIndex == CONTROL_INDEX_MIDI_LEARN,
  2114. paramData.mappedControlIndex,);
  2115. event.ctrl.handled = true;
  2116. paramData.mappedControlIndex = static_cast<int16_t>(event.ctrl.param);
  2117. paramData.midiChannel = event.channel;
  2118. pData->postponeMidiLearnRtEvent(true, parameterId, static_cast<uint8_t>(event.ctrl.param), event.channel);
  2119. pData->midiLearnParameterIndex = -1;
  2120. }
  2121. #endif
  2122. void* CarlaPlugin::getNativeHandle() const noexcept
  2123. {
  2124. return nullptr;
  2125. }
  2126. const void* CarlaPlugin::getNativeDescriptor() const noexcept
  2127. {
  2128. return nullptr;
  2129. }
  2130. uintptr_t CarlaPlugin::getUiBridgeProcessId() const noexcept
  2131. {
  2132. return 0;
  2133. }
  2134. // -------------------------------------------------------------------
  2135. uint32_t CarlaPlugin::getPatchbayNodeId() const noexcept
  2136. {
  2137. return pData->nodeId;
  2138. }
  2139. void CarlaPlugin::setPatchbayNodeId(const uint32_t nodeId) noexcept
  2140. {
  2141. pData->nodeId = nodeId;
  2142. }
  2143. // -------------------------------------------------------------------
  2144. void CarlaPlugin::cloneLV2Files(const CarlaPlugin&)
  2145. {
  2146. carla_stderr2("Warning: cloneLV2Files() called for non-implemented type");
  2147. }
  2148. void CarlaPlugin::restoreLV2State(const bool temporary) noexcept
  2149. {
  2150. carla_stderr2("Warning: restoreLV2State(%s) called for non-implemented type", bool2str(temporary));
  2151. }
  2152. void CarlaPlugin::prepareForDeletion() noexcept
  2153. {
  2154. carla_debug("CarlaPlugin::prepareForDeletion");
  2155. const CarlaMutexLocker cml(pData->masterMutex);
  2156. pData->client->deactivate(true);
  2157. }
  2158. void CarlaPlugin::waitForBridgeSaveSignal() noexcept
  2159. {
  2160. }
  2161. // -------------------------------------------------------------------
  2162. // Scoped Disabler
  2163. CarlaPlugin::ScopedDisabler::ScopedDisabler(CarlaPlugin* const plugin) noexcept
  2164. : fPlugin(plugin),
  2165. fWasEnabled(false)
  2166. {
  2167. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr,);
  2168. CARLA_SAFE_ASSERT_RETURN(plugin->pData != nullptr,);
  2169. CARLA_SAFE_ASSERT_RETURN(plugin->pData->client != nullptr,);
  2170. carla_debug("CarlaPlugin::ScopedDisabler(%p)", plugin);
  2171. plugin->pData->masterMutex.lock();
  2172. if (plugin->pData->enabled)
  2173. {
  2174. fWasEnabled = true;
  2175. plugin->pData->enabled = false;
  2176. if (plugin->pData->client->isActive())
  2177. plugin->pData->client->deactivate(false);
  2178. }
  2179. }
  2180. CarlaPlugin::ScopedDisabler::~ScopedDisabler() noexcept
  2181. {
  2182. CARLA_SAFE_ASSERT_RETURN(fPlugin != nullptr,);
  2183. CARLA_SAFE_ASSERT_RETURN(fPlugin->pData != nullptr,);
  2184. CARLA_SAFE_ASSERT_RETURN(fPlugin->pData->client != nullptr,);
  2185. carla_debug("CarlaPlugin::~ScopedDisabler()");
  2186. if (fWasEnabled)
  2187. {
  2188. fPlugin->pData->enabled = true;
  2189. fPlugin->pData->client->activate();
  2190. }
  2191. fPlugin->pData->masterMutex.unlock();
  2192. }
  2193. // -------------------------------------------------------------------
  2194. // Scoped Process Locker
  2195. CarlaPlugin::ScopedSingleProcessLocker::ScopedSingleProcessLocker(CarlaPlugin* const plugin, const bool block) noexcept
  2196. : fPlugin(plugin),
  2197. fBlock(block)
  2198. {
  2199. CARLA_SAFE_ASSERT_RETURN(fPlugin != nullptr,);
  2200. CARLA_SAFE_ASSERT_RETURN(fPlugin->pData != nullptr,);
  2201. carla_debug("CarlaPlugin::ScopedSingleProcessLocker(%p, %s)", plugin, bool2str(block));
  2202. if (! fBlock)
  2203. return;
  2204. plugin->pData->singleMutex.lock();
  2205. }
  2206. CarlaPlugin::ScopedSingleProcessLocker::~ScopedSingleProcessLocker() noexcept
  2207. {
  2208. CARLA_SAFE_ASSERT_RETURN(fPlugin != nullptr,);
  2209. CARLA_SAFE_ASSERT_RETURN(fPlugin->pData != nullptr,);
  2210. carla_debug("CarlaPlugin::~ScopedSingleProcessLocker()");
  2211. if (! fBlock)
  2212. return;
  2213. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  2214. if (fPlugin->pData->singleMutex.wasTryLockCalled())
  2215. fPlugin->pData->needsReset = true;
  2216. #endif
  2217. fPlugin->pData->singleMutex.unlock();
  2218. }
  2219. // -------------------------------------------------------------------
  2220. CARLA_BACKEND_END_NAMESPACE