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.

2786 lines
92KB

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