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.

2756 lines
91KB

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