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.

2464 lines
79KB

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