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.

2571 lines
82KB

  1. /*
  2. * Carla Plugin
  3. * Copyright (C) 2011-2018 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.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
  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.5 ? 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
  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
  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 && pluginType != PLUGIN_GIG)
  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
  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
  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
  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. #endif
  713. pData->engine->callback(ENGINE_CALLBACK_UPDATE, pData->id, 0, 0, 0.0f, nullptr);
  714. }
  715. bool CarlaPlugin::saveStateToFile(const char* const filename)
  716. {
  717. CARLA_SAFE_ASSERT_RETURN(filename != nullptr && filename[0] != '\0', false);
  718. carla_debug("CarlaPlugin::saveStateToFile(\"%s\")", filename);
  719. MemoryOutputStream out, streamState;
  720. getStateSave().dumpToMemoryStream(streamState);
  721. out << "<?xml version='1.0' encoding='UTF-8'?>\n";
  722. out << "<!DOCTYPE CARLA-PRESET>\n";
  723. out << "<CARLA-PRESET VERSION='2.0'>\n";
  724. out << streamState;
  725. out << "</CARLA-PRESET>\n";
  726. const String jfilename = String(CharPointer_UTF8(filename));
  727. File file(jfilename);
  728. if (file.replaceWithData(out.getData(), out.getDataSize()))
  729. return true;
  730. pData->engine->setLastError("Failed to write file");
  731. return false;
  732. }
  733. bool CarlaPlugin::loadStateFromFile(const char* const filename)
  734. {
  735. // TODO set errors
  736. CARLA_SAFE_ASSERT_RETURN(filename != nullptr && filename[0] != '\0', false);
  737. carla_debug("CarlaPlugin::loadStateFromFile(\"%s\")", filename);
  738. const String jfilename = String(CharPointer_UTF8(filename));
  739. File file(jfilename);
  740. CARLA_SAFE_ASSERT_RETURN(file.existsAsFile(), false);
  741. XmlDocument xml(file);
  742. ScopedPointer<XmlElement> xmlElement(xml.getDocumentElement(true));
  743. CARLA_SAFE_ASSERT_RETURN(xmlElement != nullptr, false);
  744. CARLA_SAFE_ASSERT_RETURN(xmlElement->getTagName().equalsIgnoreCase("carla-preset"), false);
  745. // completely load file
  746. xmlElement = xml.getDocumentElement(false);
  747. CARLA_SAFE_ASSERT_RETURN(xmlElement != nullptr, false);
  748. if (pData->stateSave.fillFromXmlElement(xmlElement))
  749. {
  750. loadStateSave(pData->stateSave);
  751. return true;
  752. }
  753. return false;
  754. }
  755. bool CarlaPlugin::exportAsLV2(const char* const lv2path)
  756. {
  757. CARLA_SAFE_ASSERT_RETURN(lv2path != nullptr && lv2path[0] != '\0', false);
  758. carla_debug("CarlaPlugin::exportAsLV2(\"%s\")", lv2path);
  759. CarlaString bundlepath(lv2path);
  760. if (! bundlepath.endsWith(".lv2"))
  761. bundlepath += ".lv2";
  762. const File bundlefolder(bundlepath.buffer());
  763. if (bundlefolder.existsAsFile())
  764. {
  765. pData->engine->setLastError("Requested filename already exists as file, use a folder instead");
  766. return false;
  767. }
  768. if (! bundlefolder.exists())
  769. {
  770. const Result res(bundlefolder.createDirectory());
  771. if (res.failed())
  772. {
  773. pData->engine->setLastError(res.getErrorMessage().toRawUTF8());
  774. return false;
  775. }
  776. }
  777. CarlaString symbol(pData->name);
  778. symbol.toBasic();
  779. {
  780. const CarlaString pluginFilename(bundlepath + CARLA_OS_SEP_STR + symbol + ".xml");
  781. if (! saveStateToFile(pluginFilename))
  782. return false;
  783. }
  784. {
  785. MemoryOutputStream manifestStream;
  786. manifestStream << "@prefix lv2: <http://lv2plug.in/ns/lv2core#> .\n";
  787. manifestStream << "@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .\n";
  788. manifestStream << "@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .\n";
  789. manifestStream << "\n";
  790. manifestStream << "<" << symbol.buffer() << ".ttl>\n";
  791. manifestStream << " a lv2:Plugin ;\n";
  792. manifestStream << " lv2:binary <" << symbol.buffer() << CARLA_LIB_EXT "> ;\n";
  793. manifestStream << " rdfs:seeAlso <" << symbol.buffer() << ".ttl> .\n";
  794. manifestStream << "\n";
  795. manifestStream << "<ext-ui>\n";
  796. manifestStream << " a <http://kxstudio.sf.net/ns/lv2ext/external-ui#Widget> ;\n";
  797. manifestStream << " ui:binary <" << symbol.buffer() << CARLA_LIB_EXT "> ;\n";
  798. manifestStream << " lv2:extensionData <http://lv2plug.in/ns/extensions/ui#idleInterface> ,\n";
  799. manifestStream << " <http://lv2plug.in/ns/extensions/ui#showInterface> ;\n";
  800. manifestStream << " lv2:requiredFeature <http://lv2plug.in/ns/ext/instance-access> .\n";
  801. manifestStream << "\n";
  802. const CarlaString manifestFilename(bundlepath + CARLA_OS_SEP_STR "manifest.ttl");
  803. const File manifestFile(manifestFilename.buffer());
  804. if (! manifestFile.replaceWithData(manifestStream.getData(), manifestStream.getDataSize()))
  805. {
  806. pData->engine->setLastError("Failed to write manifest.ttl file");
  807. return false;
  808. }
  809. }
  810. {
  811. MemoryOutputStream mainStream;
  812. mainStream << "@prefix atom: <http://lv2plug.in/ns/ext/atom#> .\n";
  813. mainStream << "@prefix doap: <http://usefulinc.com/ns/doap#> .\n";
  814. mainStream << "@prefix lv2: <http://lv2plug.in/ns/lv2core#> .\n";
  815. mainStream << "@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .\n";
  816. mainStream << "@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .\n";
  817. mainStream << "\n";
  818. mainStream << "<>\n";
  819. mainStream << " a lv2:Plugin ;\n";
  820. mainStream << "\n";
  821. mainStream << " lv2:requiredFeature <http://lv2plug.in/ns/ext/buf-size#boundedBlockLength> ,\n";
  822. mainStream << " <http://lv2plug.in/ns/ext/options#options> ,\n";
  823. mainStream << " <http://lv2plug.in/ns/ext/urid#map> ;\n";
  824. mainStream << "\n";
  825. if (pData->hints & PLUGIN_HAS_CUSTOM_UI)
  826. {
  827. mainStream << " ui:ui <ext-ui> ;\n";
  828. mainStream << "\n";
  829. }
  830. const uint32_t midiIns = getMidiInCount();
  831. const uint32_t midiOuts = getMidiOutCount();
  832. int portIndex = 0;
  833. if (midiIns > 0)
  834. {
  835. mainStream << " lv2:port [\n";
  836. mainStream << " a lv2:InputPort, atom:AtomPort ;\n";
  837. mainStream << " lv2:index 0 ;\n";
  838. mainStream << " lv2:symbol \"clv2_events_in\" ;\n";
  839. mainStream << " lv2:name \"Events Input\" ;\n";
  840. mainStream << " atom:bufferType atom:Sequence ;\n";
  841. mainStream << " atom:supports <http://lv2plug.in/ns/ext/midi#MidiEvent> ,\n";
  842. mainStream << " <http://lv2plug.in/ns/ext/time#Position> ;\n";
  843. mainStream << " ] ;\n";
  844. ++portIndex;
  845. for (uint32_t i=1; i<midiIns; ++i)
  846. {
  847. const String portIndexNum(portIndex++);
  848. const String portIndexLabel(portIndex);
  849. mainStream << " lv2:port [\n";
  850. mainStream << " a lv2:InputPort, atom:AtomPort ;\n";
  851. mainStream << " lv2:index " << portIndexNum << " ;\n";
  852. mainStream << " lv2:symbol \"clv2_midi_in_" << portIndexLabel << "\" ;\n";
  853. mainStream << " lv2:name \"MIDI Input " << portIndexLabel << "\" ;\n";
  854. mainStream << " ] ;\n";
  855. }
  856. }
  857. else
  858. {
  859. mainStream << " lv2:port [\n";
  860. mainStream << " a lv2:InputPort, atom:AtomPort ;\n";
  861. mainStream << " lv2:index 0 ;\n";
  862. mainStream << " lv2:symbol \"clv2_time_info\" ;\n";
  863. mainStream << " lv2:name \"Time Info\" ;\n";
  864. mainStream << " atom:bufferType atom:Sequence ;\n";
  865. mainStream << " atom:supports <http://lv2plug.in/ns/ext/time#Position> ;\n";
  866. mainStream << " ] ;\n";
  867. ++portIndex;
  868. }
  869. for (uint32_t i=0; i<midiOuts; ++i)
  870. {
  871. const String portIndexNum(portIndex++);
  872. const String portIndexLabel(portIndex);
  873. mainStream << " lv2:port [\n";
  874. mainStream << " a lv2:InputPort, atom:AtomPort ;\n";
  875. mainStream << " lv2:index " << portIndexNum << " ;\n";
  876. mainStream << " lv2:symbol \"clv2_midi_out_" << portIndexLabel << "\" ;\n";
  877. mainStream << " lv2:name \"MIDI Output " << portIndexLabel << "\" ;\n";
  878. mainStream << " atom:bufferType atom:Sequence ;\n";
  879. mainStream << " atom:supports <http://lv2plug.in/ns/ext/midi#MidiEvent> ;\n";
  880. mainStream << " ] ;\n";
  881. }
  882. mainStream << " lv2:port [\n";
  883. mainStream << " a lv2:InputPort, lv2:ControlPort ;\n";
  884. mainStream << " lv2:index " << String(portIndex++) << " ;\n";
  885. mainStream << " lv2:name \"freewheel\" ;\n";
  886. mainStream << " lv2:symbol \"clv2_freewheel\" ;\n";
  887. mainStream << " lv2:default 0 ;\n";
  888. mainStream << " lv2:minimum 0 ;\n";
  889. mainStream << " lv2:maximum 1 ;\n";
  890. mainStream << " lv2:designation lv2:freeWheeling ;\n";
  891. mainStream << " lv2:portProperty lv2:toggled , lv2:integer ;\n";
  892. mainStream << " lv2:portProperty <http://lv2plug.in/ns/ext/port-props#notOnGUI> ;\n";
  893. mainStream << " ] ;\n";
  894. for (uint32_t i=0; i<pData->audioIn.count; ++i)
  895. {
  896. const String portIndexNum(portIndex++);
  897. const String portIndexLabel(i+1);
  898. mainStream << " lv2:port [\n";
  899. mainStream << " a lv2:InputPort, lv2:AudioPort ;\n";
  900. mainStream << " lv2:index " << portIndexNum << " ;\n";
  901. mainStream << " lv2:symbol \"clv2_audio_in_" << portIndexLabel << "\" ;\n";
  902. mainStream << " lv2:name \"Audio Input " << portIndexLabel << "\" ;\n";
  903. mainStream << " ] ;\n";
  904. }
  905. for (uint32_t i=0; i<pData->audioOut.count; ++i)
  906. {
  907. const String portIndexNum(portIndex++);
  908. const String portIndexLabel(i+1);
  909. mainStream << " lv2:port [\n";
  910. mainStream << " a lv2:OutputPort, lv2:AudioPort ;\n";
  911. mainStream << " lv2:index " << portIndexNum << " ;\n";
  912. mainStream << " lv2:symbol \"clv2_audio_out_" << portIndexLabel << "\" ;\n";
  913. mainStream << " lv2:name \"Audio Output " << portIndexLabel << "\" ;\n";
  914. mainStream << " ] ;\n";
  915. }
  916. CarlaStringList uniqueSymbolNames;
  917. char strBufName[STR_MAX+1];
  918. char strBufSymbol[STR_MAX+1];
  919. strBufName[STR_MAX] = strBufSymbol[STR_MAX] = '\0';
  920. for (uint32_t i=0; i<pData->param.count; ++i)
  921. {
  922. const ParameterData& paramData(pData->param.data[i]);
  923. const ParameterRanges& paramRanges(pData->param.ranges[i]);
  924. const String portIndexNum(portIndex++);
  925. mainStream << " lv2:port [\n";
  926. if (paramData.type == PARAMETER_INPUT)
  927. mainStream << " a lv2:InputPort, lv2:ControlPort ;\n";
  928. else
  929. mainStream << " a lv2:OutputPort, lv2:ControlPort ;\n";
  930. if (paramData.hints & PARAMETER_IS_BOOLEAN)
  931. mainStream << " lv2:portProperty lv2:toggled ;\n";
  932. if (paramData.hints & PARAMETER_IS_INTEGER)
  933. mainStream << " lv2:portProperty lv2:integer ;\n";
  934. // TODO logarithmic, enabled (not on gui), automable, samplerate, scalepoints
  935. strBufName[0] = strBufSymbol[0] = '\0';
  936. getParameterName(i, strBufName);
  937. getParameterSymbol(i, strBufSymbol);
  938. if (strBufSymbol[0] == '\0')
  939. {
  940. CarlaString s(strBufName);
  941. s.toBasic();
  942. std::memcpy(strBufSymbol, s.buffer(), s.length()+1);
  943. if (strBufSymbol[0] >= '0' && strBufSymbol[0] <= '9')
  944. {
  945. const size_t len(std::strlen(strBufSymbol));
  946. std::memmove(strBufSymbol+1, strBufSymbol, len);
  947. strBufSymbol[0] = '_';
  948. strBufSymbol[len+1] = '\0';
  949. }
  950. }
  951. if (uniqueSymbolNames.contains(strBufSymbol))
  952. {
  953. std::snprintf(strBufSymbol, STR_MAX, "clv2_param_%d", i+1);
  954. strBufSymbol[STR_MAX] = '\0';
  955. }
  956. mainStream << " lv2:index " << portIndexNum << " ;\n";
  957. mainStream << " lv2:symbol \"" << strBufSymbol << "\" ;\n";
  958. mainStream << " lv2:name \"\"\"" << strBufName << "\"\"\" ;\n";
  959. mainStream << " lv2:default " << String(paramRanges.def) << " ;\n";
  960. mainStream << " lv2:minimum " << String(paramRanges.min) << " ;\n";
  961. mainStream << " lv2:maximum " << String(paramRanges.max) << " ;\n";
  962. // TODO midiCC, midiChannel
  963. mainStream << " ] ;\n";
  964. }
  965. mainStream << " rdfs:comment \"Plugin generated using Carla LV2 export.\" ;\n";
  966. mainStream << " doap:name \"\"\"" << getName() << "\"\"\" .\n";
  967. mainStream << "\n";
  968. const CarlaString mainFilename(bundlepath + CARLA_OS_SEP_STR + symbol + ".ttl");
  969. const File mainFile(mainFilename.buffer());
  970. if (! mainFile.replaceWithData(mainStream.getData(), mainStream.getDataSize()))
  971. {
  972. pData->engine->setLastError("Failed to write main plugin ttl file");
  973. return false;
  974. }
  975. }
  976. const CarlaString binaryFilename(bundlepath + CARLA_OS_SEP_STR + symbol + CARLA_LIB_EXT);
  977. const File binaryFileSource(File::getSpecialLocation(File::currentExecutableFile).getSiblingFile("carla-bridge-lv2" CARLA_LIB_EXT));
  978. const File binaryFileTarget(binaryFilename.buffer());
  979. if (! binaryFileSource.createSymbolicLink(binaryFileTarget, true))
  980. {
  981. pData->engine->setLastError("Failed to create symbolik link of plugin binary");
  982. return false;
  983. }
  984. const EngineOptions& opts(pData->engine->getOptions());
  985. const CarlaString binFolderTarget(bundlepath + CARLA_OS_SEP_STR + "bin");
  986. const CarlaString resFolderTarget(bundlepath + CARLA_OS_SEP_STR + "res");
  987. File(opts.binaryDir).createSymbolicLink(File(binFolderTarget.buffer()), true);
  988. File(opts.resourceDir).createSymbolicLink(File(resFolderTarget.buffer()), true);
  989. return true;
  990. }
  991. // -------------------------------------------------------------------
  992. // Set data (internal stuff)
  993. void CarlaPlugin::setId(const uint newId) noexcept
  994. {
  995. pData->id = newId;
  996. }
  997. void CarlaPlugin::setName(const char* const newName)
  998. {
  999. CARLA_SAFE_ASSERT_RETURN(newName != nullptr && newName[0] != '\0',);
  1000. if (pData->name != nullptr)
  1001. delete[] pData->name;
  1002. pData->name = carla_strdup(newName);
  1003. }
  1004. void CarlaPlugin::setOption(const uint option, const bool yesNo, const bool sendCallback)
  1005. {
  1006. CARLA_SAFE_ASSERT_RETURN(getOptionsAvailable() & option,);
  1007. if (yesNo)
  1008. pData->options |= option;
  1009. else
  1010. pData->options &= ~option;
  1011. #ifndef BUILD_BRIDGE
  1012. if (sendCallback)
  1013. pData->engine->callback(ENGINE_CALLBACK_OPTION_CHANGED, pData->id, static_cast<int>(option), yesNo ? 1 : 0, 0.0f, nullptr);
  1014. #else
  1015. // unused
  1016. return; (void)sendCallback;
  1017. #endif
  1018. }
  1019. void CarlaPlugin::setEnabled(const bool yesNo) noexcept
  1020. {
  1021. if (pData->enabled == yesNo)
  1022. return;
  1023. pData->masterMutex.lock();
  1024. pData->enabled = yesNo;
  1025. if (yesNo && ! pData->client->isActive())
  1026. pData->client->activate();
  1027. pData->masterMutex.unlock();
  1028. }
  1029. void CarlaPlugin::setActive(const bool active, const bool sendOsc, const bool sendCallback) noexcept
  1030. {
  1031. #ifndef BUILD_BRIDGE
  1032. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1033. #endif
  1034. if (pData->active == active)
  1035. return;
  1036. {
  1037. const ScopedSingleProcessLocker spl(this, true);
  1038. if (active)
  1039. activate();
  1040. else
  1041. deactivate();
  1042. }
  1043. pData->active = active;
  1044. #ifndef BUILD_BRIDGE
  1045. const float value(active ? 1.0f : 0.0f);
  1046. # ifdef HAVE_LIBLO
  1047. if (sendOsc && pData->engine->isOscControlRegistered())
  1048. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_ACTIVE, value);
  1049. # endif
  1050. if (sendCallback)
  1051. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, PARAMETER_ACTIVE, 0, value, nullptr);
  1052. #endif
  1053. // may be unused
  1054. return; (void)sendOsc; (void)sendCallback;
  1055. }
  1056. #ifndef BUILD_BRIDGE
  1057. void CarlaPlugin::setDryWet(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1058. {
  1059. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.0f);
  1060. const float fixedValue(carla_fixedValue<float>(0.0f, 1.0f, value));
  1061. if (carla_isEqual(pData->postProc.dryWet, fixedValue))
  1062. return;
  1063. pData->postProc.dryWet = fixedValue;
  1064. #ifdef HAVE_LIBLO
  1065. if (sendOsc && pData->engine->isOscControlRegistered())
  1066. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_DRYWET, fixedValue);
  1067. #endif
  1068. if (sendCallback)
  1069. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, PARAMETER_DRYWET, 0, fixedValue, nullptr);
  1070. // may be unused
  1071. return; (void)sendOsc;
  1072. }
  1073. void CarlaPlugin::setVolume(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1074. {
  1075. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.27f);
  1076. const float fixedValue(carla_fixedValue<float>(0.0f, 1.27f, value));
  1077. if (carla_isEqual(pData->postProc.volume, fixedValue))
  1078. return;
  1079. pData->postProc.volume = fixedValue;
  1080. #ifdef HAVE_LIBLO
  1081. if (sendOsc && pData->engine->isOscControlRegistered())
  1082. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_VOLUME, fixedValue);
  1083. #endif
  1084. if (sendCallback)
  1085. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, PARAMETER_VOLUME, 0, fixedValue, nullptr);
  1086. // may be unused
  1087. return; (void)sendOsc;
  1088. }
  1089. void CarlaPlugin::setBalanceLeft(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1090. {
  1091. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1092. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1093. if (carla_isEqual(pData->postProc.balanceLeft, fixedValue))
  1094. return;
  1095. pData->postProc.balanceLeft = fixedValue;
  1096. #ifdef HAVE_LIBLO
  1097. if (sendOsc && pData->engine->isOscControlRegistered())
  1098. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_BALANCE_LEFT, fixedValue);
  1099. #endif
  1100. if (sendCallback)
  1101. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, PARAMETER_BALANCE_LEFT, 0, fixedValue, nullptr);
  1102. // may be unused
  1103. return; (void)sendOsc;
  1104. }
  1105. void CarlaPlugin::setBalanceRight(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1106. {
  1107. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1108. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1109. if (carla_isEqual(pData->postProc.balanceRight, fixedValue))
  1110. return;
  1111. pData->postProc.balanceRight = fixedValue;
  1112. #ifdef HAVE_LIBLO
  1113. if (sendOsc && pData->engine->isOscControlRegistered())
  1114. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_BALANCE_RIGHT, fixedValue);
  1115. #endif
  1116. if (sendCallback)
  1117. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, PARAMETER_BALANCE_RIGHT, 0, fixedValue, nullptr);
  1118. // may be unused
  1119. return; (void)sendOsc;
  1120. }
  1121. void CarlaPlugin::setPanning(const float value, const bool sendOsc, const bool sendCallback) noexcept
  1122. {
  1123. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1124. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1125. if (carla_isEqual(pData->postProc.panning, fixedValue))
  1126. return;
  1127. pData->postProc.panning = fixedValue;
  1128. #ifdef HAVE_LIBLO
  1129. if (sendOsc && pData->engine->isOscControlRegistered())
  1130. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_PANNING, fixedValue);
  1131. #endif
  1132. if (sendCallback)
  1133. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, PARAMETER_PANNING, 0, fixedValue, nullptr);
  1134. // may be unused
  1135. return; (void)sendOsc;
  1136. }
  1137. void CarlaPlugin::setDryWetRT(const float value) noexcept
  1138. {
  1139. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.0f);
  1140. const float fixedValue(carla_fixedValue<float>(0.0f, 1.0f, value));
  1141. if (carla_isEqual(pData->postProc.dryWet, fixedValue))
  1142. return;
  1143. pData->postProc.dryWet = fixedValue;
  1144. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_DRYWET, 0, fixedValue);
  1145. }
  1146. void CarlaPlugin::setVolumeRT(const float value) noexcept
  1147. {
  1148. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.27f);
  1149. const float fixedValue(carla_fixedValue<float>(0.0f, 1.27f, value));
  1150. if (carla_isEqual(pData->postProc.volume, fixedValue))
  1151. return;
  1152. pData->postProc.volume = fixedValue;
  1153. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_VOLUME, 0, fixedValue);
  1154. }
  1155. void CarlaPlugin::setBalanceLeftRT(const float value) noexcept
  1156. {
  1157. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1158. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1159. if (carla_isEqual(pData->postProc.balanceLeft, fixedValue))
  1160. return;
  1161. pData->postProc.balanceLeft = fixedValue;
  1162. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_LEFT, 0, fixedValue);
  1163. }
  1164. void CarlaPlugin::setBalanceRightRT(const float value) noexcept
  1165. {
  1166. CARLA_SAFE_ASSERT(value >= -1.0f && value <= 1.0f);
  1167. const float fixedValue(carla_fixedValue<float>(-1.0f, 1.0f, value));
  1168. if (carla_isEqual(pData->postProc.balanceRight, fixedValue))
  1169. return;
  1170. pData->postProc.balanceRight = fixedValue;
  1171. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_RIGHT, 0, fixedValue);
  1172. }
  1173. void CarlaPlugin::setPanningRT(const float value) noexcept
  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. }
  1181. #endif // ! BUILD_BRIDGE
  1182. void CarlaPlugin::setCtrlChannel(const int8_t channel, const bool sendOsc, const bool sendCallback) noexcept
  1183. {
  1184. #ifndef BUILD_BRIDGE
  1185. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1186. #endif
  1187. CARLA_SAFE_ASSERT_RETURN(channel >= -1 && channel < MAX_MIDI_CHANNELS,);
  1188. if (pData->ctrlChannel == channel)
  1189. return;
  1190. pData->ctrlChannel = channel;
  1191. #ifndef BUILD_BRIDGE
  1192. const float channelf(channel);
  1193. # ifdef HAVE_LIBLO
  1194. if (sendOsc && pData->engine->isOscControlRegistered())
  1195. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_CTRL_CHANNEL, channelf);
  1196. # endif
  1197. if (sendCallback)
  1198. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, PARAMETER_CTRL_CHANNEL, 0, channelf, nullptr);
  1199. #endif
  1200. // may be unused
  1201. return; (void)sendOsc; (void)sendCallback;
  1202. }
  1203. // -------------------------------------------------------------------
  1204. // Set data (plugin-specific stuff)
  1205. void CarlaPlugin::setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept
  1206. {
  1207. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  1208. if (sendGui && (pData->hints & PLUGIN_HAS_CUSTOM_UI) != 0)
  1209. uiParameterChange(parameterId, value);
  1210. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1211. if (sendOsc && pData->engine->isOscControlRegistered())
  1212. pData->engine->oscSend_control_set_parameter_value(pData->id, static_cast<int32_t>(parameterId), value);
  1213. #endif
  1214. if (sendCallback)
  1215. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, static_cast<int>(parameterId), 0, value, nullptr);
  1216. // may be unused
  1217. return; (void)sendOsc;
  1218. }
  1219. void CarlaPlugin::setParameterValueRT(const uint32_t parameterId, const float value) noexcept
  1220. {
  1221. pData->postponeRtEvent(kPluginPostRtEventParameterChange, static_cast<int32_t>(parameterId), 0, value);
  1222. }
  1223. void CarlaPlugin::setParameterValueByRealIndex(const int32_t rindex, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept
  1224. {
  1225. #ifndef BUILD_BRIDGE
  1226. CARLA_SAFE_ASSERT_RETURN(rindex > PARAMETER_MAX && rindex != PARAMETER_NULL,);
  1227. switch (rindex)
  1228. {
  1229. case PARAMETER_ACTIVE:
  1230. return setActive((value > 0.0f), sendOsc, sendCallback);
  1231. case PARAMETER_CTRL_CHANNEL:
  1232. return setCtrlChannel(int8_t(value), sendOsc, sendCallback);
  1233. case PARAMETER_DRYWET:
  1234. return setDryWet(value, sendOsc, sendCallback);
  1235. case PARAMETER_VOLUME:
  1236. return setVolume(value, sendOsc, sendCallback);
  1237. case PARAMETER_BALANCE_LEFT:
  1238. return setBalanceLeft(value, sendOsc, sendCallback);
  1239. case PARAMETER_BALANCE_RIGHT:
  1240. return setBalanceRight(value, sendOsc, sendCallback);
  1241. case PARAMETER_PANNING:
  1242. return setPanning(value, sendOsc, sendCallback);
  1243. }
  1244. #endif
  1245. CARLA_SAFE_ASSERT_RETURN(rindex >= 0,);
  1246. for (uint32_t i=0; i < pData->param.count; ++i)
  1247. {
  1248. if (pData->param.data[i].rindex == rindex)
  1249. {
  1250. //if (carla_isNotEqual(getParameterValue(i), value))
  1251. setParameterValue(i, value, sendGui, sendOsc, sendCallback);
  1252. break;
  1253. }
  1254. }
  1255. }
  1256. void CarlaPlugin::setParameterMidiChannel(const uint32_t parameterId, const uint8_t channel, const bool sendOsc, const bool sendCallback) noexcept
  1257. {
  1258. #ifndef BUILD_BRIDGE
  1259. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1260. #endif
  1261. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  1262. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1263. pData->param.data[parameterId].midiChannel = channel;
  1264. #ifndef BUILD_BRIDGE
  1265. # ifdef HAVE_LIBLO
  1266. if (sendOsc && pData->engine->isOscControlRegistered())
  1267. pData->engine->oscSend_control_set_parameter_midi_channel(pData->id, parameterId, channel);
  1268. # endif
  1269. if (sendCallback)
  1270. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED, pData->id, static_cast<int>(parameterId), channel, 0.0f, nullptr);
  1271. #endif
  1272. // may be unused
  1273. return; (void)sendOsc; (void)sendCallback;
  1274. }
  1275. void CarlaPlugin::setParameterMidiCC(const uint32_t parameterId, const int16_t cc, const bool sendOsc, const bool sendCallback) noexcept
  1276. {
  1277. #ifndef BUILD_BRIDGE
  1278. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  1279. #endif
  1280. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  1281. CARLA_SAFE_ASSERT_RETURN(cc >= -1 && cc < MAX_MIDI_CONTROL,);
  1282. pData->param.data[parameterId].midiCC = cc;
  1283. #ifndef BUILD_BRIDGE
  1284. # ifdef HAVE_LIBLO
  1285. if (sendOsc && pData->engine->isOscControlRegistered())
  1286. pData->engine->oscSend_control_set_parameter_midi_cc(pData->id, parameterId, cc);
  1287. # endif
  1288. if (sendCallback)
  1289. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_MIDI_CC_CHANGED, pData->id, static_cast<int>(parameterId), cc, 0.0f, nullptr);
  1290. #endif
  1291. // may be unused
  1292. return; (void)sendOsc; (void)sendCallback;
  1293. }
  1294. void CarlaPlugin::setCustomData(const char* const type, const char* const key, const char* const value, const bool)
  1295. {
  1296. CARLA_SAFE_ASSERT_RETURN(type != nullptr && type[0] != '\0',);
  1297. CARLA_SAFE_ASSERT_RETURN(key != nullptr && key[0] != '\0',);
  1298. CARLA_SAFE_ASSERT_RETURN(value != nullptr,);
  1299. // Ignore some keys
  1300. if (std::strcmp(type, CUSTOM_DATA_TYPE_STRING) == 0)
  1301. {
  1302. const PluginType ptype = getType();
  1303. if ((ptype == PLUGIN_INTERNAL && std::strncmp(key, "CarlaAlternateFile", 18) == 0) ||
  1304. (ptype == PLUGIN_DSSI && std::strcmp (key, "guiVisible") == 0) ||
  1305. (ptype == PLUGIN_LV2 && std::strncmp(key, "OSC:", 4) == 0))
  1306. return;
  1307. }
  1308. // Check if we already have this key
  1309. for (LinkedList<CustomData>::Itenerator it = pData->custom.begin2(); it.valid(); it.next())
  1310. {
  1311. CustomData& customData(it.getValue(kCustomDataFallbackNC));
  1312. CARLA_SAFE_ASSERT_CONTINUE(customData.isValid());
  1313. if (std::strcmp(customData.key, key) == 0)
  1314. {
  1315. if (customData.value != nullptr)
  1316. delete[] customData.value;
  1317. customData.value = carla_strdup(value);
  1318. return;
  1319. }
  1320. }
  1321. // Otherwise store it
  1322. CustomData customData;
  1323. customData.type = carla_strdup(type);
  1324. customData.key = carla_strdup(key);
  1325. customData.value = carla_strdup(value);
  1326. pData->custom.append(customData);
  1327. }
  1328. void CarlaPlugin::setChunkData(const void* const data, const std::size_t dataSize)
  1329. {
  1330. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  1331. CARLA_SAFE_ASSERT_RETURN(dataSize > 0,);
  1332. CARLA_SAFE_ASSERT(false); // this should never happen
  1333. }
  1334. void CarlaPlugin::setProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback, const bool) noexcept
  1335. {
  1336. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->prog.count),);
  1337. pData->prog.current = index;
  1338. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1339. const bool reallySendOsc(sendOsc && pData->engine->isOscControlRegistered());
  1340. if (reallySendOsc && index < 50)
  1341. pData->engine->oscSend_control_set_current_program(pData->id, index);
  1342. #else
  1343. const bool reallySendOsc(false);
  1344. #endif
  1345. if (sendCallback)
  1346. pData->engine->callback(ENGINE_CALLBACK_PROGRAM_CHANGED, pData->id, index, 0, 0.0f, nullptr);
  1347. // Change default parameter values
  1348. if (index >= 0)
  1349. {
  1350. if (sendGui && (pData->hints & PLUGIN_HAS_CUSTOM_UI) != 0)
  1351. uiProgramChange(static_cast<uint32_t>(index));
  1352. switch (getType())
  1353. {
  1354. case PLUGIN_GIG:
  1355. case PLUGIN_SF2:
  1356. case PLUGIN_SFZ:
  1357. break;
  1358. default:
  1359. pData->updateParameterValues(this, reallySendOsc, sendCallback, true);
  1360. break;
  1361. }
  1362. }
  1363. // may be unused
  1364. return; (void)sendOsc;
  1365. }
  1366. void CarlaPlugin::setMidiProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback, const bool) noexcept
  1367. {
  1368. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->midiprog.count),);
  1369. pData->midiprog.current = index;
  1370. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1371. const bool reallySendOsc(sendOsc && pData->engine->isOscControlRegistered());
  1372. if (reallySendOsc && index < 50)
  1373. pData->engine->oscSend_control_set_current_midi_program(pData->id, index);
  1374. #else
  1375. const bool reallySendOsc(false);
  1376. #endif
  1377. if (sendCallback)
  1378. pData->engine->callback(ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED, pData->id, index, 0, 0.0f, nullptr);
  1379. // Change default parameter values
  1380. if (index >= 0)
  1381. {
  1382. if (sendGui && (pData->hints & PLUGIN_HAS_CUSTOM_UI) != 0)
  1383. uiMidiProgramChange(static_cast<uint32_t>(index));
  1384. switch (getType())
  1385. {
  1386. case PLUGIN_GIG:
  1387. case PLUGIN_SF2:
  1388. case PLUGIN_SFZ:
  1389. break;
  1390. default:
  1391. pData->updateParameterValues(this, reallySendOsc, sendCallback, true);
  1392. break;
  1393. }
  1394. }
  1395. // may be unused
  1396. return; (void)sendOsc;
  1397. }
  1398. void CarlaPlugin::setMidiProgramById(const uint32_t bank, const uint32_t program, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept
  1399. {
  1400. for (uint32_t i=0; i < pData->midiprog.count; ++i)
  1401. {
  1402. if (pData->midiprog.data[i].bank == bank && pData->midiprog.data[i].program == program)
  1403. return setMidiProgram(static_cast<int32_t>(i), sendGui, sendOsc, sendCallback);
  1404. }
  1405. }
  1406. void CarlaPlugin::setProgramRT(const uint32_t uindex) noexcept
  1407. {
  1408. CARLA_SAFE_ASSERT_RETURN(uindex < pData->prog.count,);
  1409. const int32_t index = static_cast<int32_t>(uindex);
  1410. pData->prog.current = index;
  1411. // Change default parameter values
  1412. switch (getType())
  1413. {
  1414. case PLUGIN_GIG:
  1415. case PLUGIN_SF2:
  1416. case PLUGIN_SFZ:
  1417. break;
  1418. default:
  1419. pData->updateDefaultParameterValues(this);
  1420. break;
  1421. }
  1422. pData->postponeRtEvent(kPluginPostRtEventProgramChange, index, 0, 0.0f);
  1423. }
  1424. void CarlaPlugin::setMidiProgramRT(const uint32_t uindex) noexcept
  1425. {
  1426. CARLA_SAFE_ASSERT_RETURN(uindex < pData->midiprog.count,);
  1427. const int32_t index = static_cast<int32_t>(uindex);
  1428. pData->midiprog.current = index;
  1429. // Change default parameter values
  1430. switch (getType())
  1431. {
  1432. case PLUGIN_GIG:
  1433. case PLUGIN_SF2:
  1434. case PLUGIN_SFZ:
  1435. break;
  1436. default:
  1437. pData->updateDefaultParameterValues(this);
  1438. break;
  1439. }
  1440. pData->postponeRtEvent(kPluginPostRtEventMidiProgramChange, index, 0, 0.0f);
  1441. }
  1442. // -------------------------------------------------------------------
  1443. // Plugin state
  1444. void CarlaPlugin::reloadPrograms(const bool)
  1445. {
  1446. }
  1447. // -------------------------------------------------------------------
  1448. // Plugin processing
  1449. void CarlaPlugin::activate() noexcept
  1450. {
  1451. CARLA_SAFE_ASSERT(! pData->active);
  1452. }
  1453. void CarlaPlugin::deactivate() noexcept
  1454. {
  1455. CARLA_SAFE_ASSERT(pData->active);
  1456. }
  1457. void CarlaPlugin::bufferSizeChanged(const uint32_t)
  1458. {
  1459. }
  1460. void CarlaPlugin::sampleRateChanged(const double)
  1461. {
  1462. }
  1463. void CarlaPlugin::offlineModeChanged(const bool)
  1464. {
  1465. }
  1466. // -------------------------------------------------------------------
  1467. // Misc
  1468. void CarlaPlugin::idle()
  1469. {
  1470. if (! pData->enabled)
  1471. return;
  1472. const bool hasUI(pData->hints & PLUGIN_HAS_CUSTOM_UI);
  1473. const bool needsUiMainThread(pData->hints & PLUGIN_NEEDS_UI_MAIN_THREAD);
  1474. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1475. const bool sendOsc(pData->engine->isOscControlRegistered());
  1476. #endif
  1477. const uint32_t latency(getLatencyInFrames());
  1478. if (pData->latency.frames != latency)
  1479. {
  1480. carla_stdout("latency changed to %i samples", latency);
  1481. const ScopedSingleProcessLocker sspl(this, true);
  1482. pData->client->setLatency(latency);
  1483. #ifndef BUILD_BRIDGE
  1484. pData->latency.recreateBuffers(pData->latency.channels, latency);
  1485. #else
  1486. pData->latency.frames = latency;
  1487. #endif
  1488. }
  1489. const CarlaMutexLocker sl(pData->postRtEvents.getDataMutex());
  1490. for (RtLinkedList<PluginPostRtEvent>::Itenerator it = pData->postRtEvents.getDataIterator(); it.valid(); it.next())
  1491. {
  1492. const PluginPostRtEvent& event(it.getValue(kPluginPostRtEventFallback));
  1493. CARLA_SAFE_ASSERT_CONTINUE(event.type != kPluginPostRtEventNull);
  1494. switch (event.type)
  1495. {
  1496. case kPluginPostRtEventNull: {
  1497. } break;
  1498. case kPluginPostRtEventDebug: {
  1499. pData->engine->callback(ENGINE_CALLBACK_DEBUG, pData->id, event.value1, event.value2, event.value3, nullptr);
  1500. } break;
  1501. case kPluginPostRtEventParameterChange: {
  1502. // Update UI
  1503. if (event.value1 >= 0 && hasUI)
  1504. {
  1505. if (needsUiMainThread)
  1506. pData->postUiEvents.append(event);
  1507. else
  1508. uiParameterChange(static_cast<uint32_t>(event.value1), event.value3);
  1509. }
  1510. if (event.value2 != 1)
  1511. {
  1512. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1513. // Update OSC control client
  1514. if (sendOsc)
  1515. pData->engine->oscSend_control_set_parameter_value(pData->id, event.value1, event.value3);
  1516. #endif
  1517. // Update Host
  1518. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, event.value1, 0, event.value3, nullptr);
  1519. }
  1520. } break;
  1521. case kPluginPostRtEventProgramChange: {
  1522. // Update UI
  1523. if (event.value1 >= 0 && hasUI)
  1524. {
  1525. if (needsUiMainThread)
  1526. pData->postUiEvents.append(event);
  1527. else
  1528. uiProgramChange(static_cast<uint32_t>(event.value1));
  1529. }
  1530. // Update param values
  1531. for (uint32_t j=0; j < pData->param.count; ++j)
  1532. {
  1533. const float paramDefault(pData->param.ranges[j].def);
  1534. const float paramValue(getParameterValue(j));
  1535. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1536. if (sendOsc && j < 50)
  1537. {
  1538. pData->engine->oscSend_control_set_parameter_value(pData->id, static_cast<int32_t>(j), paramValue);
  1539. pData->engine->oscSend_control_set_default_value(pData->id, j, paramDefault);
  1540. }
  1541. #endif
  1542. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, static_cast<int>(j), 0, paramValue, nullptr);
  1543. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED, pData->id, static_cast<int>(j), 0, paramDefault, nullptr);
  1544. }
  1545. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1546. // Update OSC control client
  1547. if (sendOsc)
  1548. pData->engine->oscSend_control_set_current_program(pData->id, event.value1);
  1549. #endif
  1550. // Update Host
  1551. pData->engine->callback(ENGINE_CALLBACK_PROGRAM_CHANGED, pData->id, event.value1, 0, 0.0f, nullptr);
  1552. } break;
  1553. case kPluginPostRtEventMidiProgramChange: {
  1554. // Update UI
  1555. if (event.value1 >= 0 && hasUI)
  1556. {
  1557. if (needsUiMainThread)
  1558. pData->postUiEvents.append(event);
  1559. else
  1560. uiMidiProgramChange(static_cast<uint32_t>(event.value1));
  1561. }
  1562. // Update param values
  1563. for (uint32_t j=0; j < pData->param.count; ++j)
  1564. {
  1565. const float paramDefault(pData->param.ranges[j].def);
  1566. const float paramValue(getParameterValue(j));
  1567. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1568. if (sendOsc && j < 50)
  1569. {
  1570. pData->engine->oscSend_control_set_parameter_value(pData->id, static_cast<int32_t>(j), paramValue);
  1571. pData->engine->oscSend_control_set_default_value(pData->id, j, paramDefault);
  1572. }
  1573. #endif
  1574. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED, pData->id, static_cast<int>(j), 0, paramValue, nullptr);
  1575. pData->engine->callback(ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED, pData->id, static_cast<int>(j), 0, paramDefault, nullptr);
  1576. }
  1577. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1578. // Update OSC control client
  1579. if (sendOsc)
  1580. pData->engine->oscSend_control_set_current_midi_program(pData->id, event.value1);
  1581. #endif
  1582. // Update Host
  1583. pData->engine->callback(ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED, pData->id, event.value1, 0, 0.0f, nullptr);
  1584. } break;
  1585. case kPluginPostRtEventNoteOn: {
  1586. CARLA_SAFE_ASSERT_BREAK(event.value1 >= 0 && event.value1 < MAX_MIDI_CHANNELS);
  1587. CARLA_SAFE_ASSERT_BREAK(event.value2 >= 0 && event.value2 < MAX_MIDI_NOTE);
  1588. CARLA_SAFE_ASSERT_BREAK(event.value3 >= 0 && event.value3 < MAX_MIDI_VALUE);
  1589. const uint8_t channel = static_cast<uint8_t>(event.value1);
  1590. const uint8_t note = static_cast<uint8_t>(event.value2);
  1591. const uint8_t velocity = uint8_t(event.value3);
  1592. // Update UI
  1593. if (hasUI)
  1594. {
  1595. if (needsUiMainThread)
  1596. pData->postUiEvents.append(event);
  1597. else
  1598. uiNoteOn(channel, note, velocity);
  1599. }
  1600. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1601. // Update OSC control client
  1602. if (sendOsc)
  1603. pData->engine->oscSend_control_note_on(pData->id, channel, note, velocity);
  1604. #endif
  1605. // Update Host
  1606. pData->engine->callback(ENGINE_CALLBACK_NOTE_ON, pData->id, event.value1, event.value2, event.value3, nullptr);
  1607. } break;
  1608. case kPluginPostRtEventNoteOff: {
  1609. CARLA_SAFE_ASSERT_BREAK(event.value1 >= 0 && event.value1 < MAX_MIDI_CHANNELS);
  1610. CARLA_SAFE_ASSERT_BREAK(event.value2 >= 0 && event.value2 < MAX_MIDI_NOTE);
  1611. const uint8_t channel = static_cast<uint8_t>(event.value1);
  1612. const uint8_t note = static_cast<uint8_t>(event.value2);
  1613. // Update UI
  1614. if (hasUI)
  1615. {
  1616. if (needsUiMainThread)
  1617. pData->postUiEvents.append(event);
  1618. else
  1619. uiNoteOff(channel, note);
  1620. }
  1621. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1622. // Update OSC control client
  1623. if (sendOsc)
  1624. pData->engine->oscSend_control_note_off(pData->id, channel, note);
  1625. #endif
  1626. // Update Host
  1627. pData->engine->callback(ENGINE_CALLBACK_NOTE_OFF, pData->id, event.value1, event.value2, 0.0f, nullptr);
  1628. } break;
  1629. }
  1630. }
  1631. pData->postRtEvents.clearData();
  1632. }
  1633. bool CarlaPlugin::tryLock(const bool forcedOffline) noexcept
  1634. {
  1635. if (forcedOffline)
  1636. {
  1637. #ifndef STOAT_TEST_BUILD
  1638. pData->masterMutex.lock();
  1639. return true;
  1640. #endif
  1641. }
  1642. return pData->masterMutex.tryLock();
  1643. }
  1644. void CarlaPlugin::unlock() noexcept
  1645. {
  1646. pData->masterMutex.unlock();
  1647. }
  1648. // -------------------------------------------------------------------
  1649. // Plugin buffers
  1650. void CarlaPlugin::initBuffers() const noexcept
  1651. {
  1652. pData->audioIn.initBuffers();
  1653. pData->audioOut.initBuffers();
  1654. pData->cvIn.initBuffers();
  1655. pData->cvOut.initBuffers();
  1656. pData->event.initBuffers();
  1657. }
  1658. void CarlaPlugin::clearBuffers() noexcept
  1659. {
  1660. pData->clearBuffers();
  1661. }
  1662. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1663. // -------------------------------------------------------------------
  1664. // OSC stuff
  1665. void CarlaPlugin::registerToOscClient() noexcept
  1666. {
  1667. if (! pData->engine->isOscControlRegistered())
  1668. return;
  1669. pData->engine->oscSend_control_add_plugin_start(pData->id, pData->name);
  1670. // Base data
  1671. {
  1672. char bufName[STR_MAX+1], bufLabel[STR_MAX+1], bufMaker[STR_MAX+1], bufCopyright[STR_MAX+1];
  1673. carla_zeroChars(bufName, STR_MAX);
  1674. carla_zeroChars(bufLabel, STR_MAX);
  1675. carla_zeroChars(bufMaker, STR_MAX);
  1676. carla_zeroChars(bufCopyright, STR_MAX);
  1677. getRealName(bufName);
  1678. getLabel(bufLabel);
  1679. getMaker(bufMaker);
  1680. getCopyright(bufCopyright);
  1681. pData->engine->oscSend_control_set_plugin_info1(pData->id, getType(), getCategory(), pData->hints, getUniqueId());
  1682. pData->engine->oscSend_control_set_plugin_info2(pData->id, bufName, bufLabel, bufMaker, bufCopyright);
  1683. }
  1684. // Base count
  1685. uint32_t paramIns, paramOuts;
  1686. {
  1687. getParameterCountInfo(paramIns, paramOuts);
  1688. if (paramIns > 49)
  1689. paramIns = 49;
  1690. if (paramOuts > 49)
  1691. paramOuts = 49;
  1692. pData->engine->oscSend_control_set_audio_count(pData->id, getAudioInCount(), getAudioOutCount());
  1693. pData->engine->oscSend_control_set_midi_count(pData->id, getMidiInCount(), getMidiOutCount());
  1694. pData->engine->oscSend_control_set_parameter_count(pData->id, paramIns, paramOuts);
  1695. }
  1696. // Plugin Parameters
  1697. if (const uint32_t count = std::min<uint32_t>(pData->param.count, 98U))
  1698. {
  1699. char bufName[STR_MAX+1], bufUnit[STR_MAX+1];
  1700. for (uint32_t i=0; i<count; ++i)
  1701. {
  1702. const ParameterData& paramData(pData->param.data[i]);
  1703. if (paramData.type == PARAMETER_INPUT)
  1704. {
  1705. if (--paramIns == 0)
  1706. break;
  1707. }
  1708. else if (paramData.type == PARAMETER_INPUT)
  1709. {
  1710. if (--paramOuts == 0)
  1711. break;
  1712. }
  1713. else
  1714. {
  1715. continue;
  1716. }
  1717. const ParameterRanges& paramRanges(pData->param.ranges[i]);
  1718. carla_zeroChars(bufName, STR_MAX);
  1719. carla_zeroChars(bufUnit, STR_MAX);
  1720. getParameterName(i, bufName);
  1721. getParameterUnit(i, bufUnit);
  1722. pData->engine->oscSend_control_set_parameter_data(pData->id, i, paramData.type, paramData.hints, bufName, bufUnit);
  1723. pData->engine->oscSend_control_set_parameter_ranges1(pData->id, i, paramRanges.def, paramRanges.min, paramRanges.max);
  1724. pData->engine->oscSend_control_set_parameter_ranges2(pData->id, i, paramRanges.step, paramRanges.stepSmall, paramRanges.stepLarge);
  1725. pData->engine->oscSend_control_set_parameter_value(pData->id, static_cast<int32_t>(i), getParameterValue(i));
  1726. if (paramData.midiCC >= 0)
  1727. pData->engine->oscSend_control_set_parameter_midi_cc(pData->id, i, paramData.midiCC);
  1728. if (paramData.midiChannel != 0)
  1729. pData->engine->oscSend_control_set_parameter_midi_channel(pData->id, i, paramData.midiChannel);
  1730. }
  1731. }
  1732. // Programs
  1733. if (const uint32_t count = std::min<uint32_t>(pData->prog.count, 50U))
  1734. {
  1735. pData->engine->oscSend_control_set_program_count(pData->id, count);
  1736. for (uint32_t i=0; i < count; ++i)
  1737. pData->engine->oscSend_control_set_program_name(pData->id, i, pData->prog.names[i]);
  1738. pData->engine->oscSend_control_set_current_program(pData->id, pData->prog.current);
  1739. }
  1740. // MIDI Programs
  1741. if (const uint32_t count = std::min<uint32_t>(pData->midiprog.count, 50U))
  1742. {
  1743. pData->engine->oscSend_control_set_midi_program_count(pData->id, count);
  1744. for (uint32_t i=0; i < count; ++i)
  1745. {
  1746. const MidiProgramData& mpData(pData->midiprog.data[i]);
  1747. pData->engine->oscSend_control_set_midi_program_data(pData->id, i, mpData.bank, mpData.program, mpData.name);
  1748. }
  1749. pData->engine->oscSend_control_set_current_midi_program(pData->id, pData->midiprog.current);
  1750. }
  1751. pData->engine->oscSend_control_add_plugin_end(pData->id);
  1752. // Internal Parameters
  1753. {
  1754. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_DRYWET, pData->postProc.dryWet);
  1755. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_VOLUME, pData->postProc.volume);
  1756. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_BALANCE_LEFT, pData->postProc.balanceLeft);
  1757. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_BALANCE_RIGHT, pData->postProc.balanceRight);
  1758. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_PANNING, pData->postProc.panning);
  1759. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_CTRL_CHANNEL, pData->ctrlChannel);
  1760. pData->engine->oscSend_control_set_parameter_value(pData->id, PARAMETER_ACTIVE, pData->active ? 1.0f : 0.0f);
  1761. }
  1762. }
  1763. #endif
  1764. // FIXME
  1765. void CarlaPlugin::handleOscMessage(const char* const, const int, const void* const, const char* const, const lo_message)
  1766. {
  1767. // do nothing
  1768. }
  1769. //#endif // HAVE_LIBLO && ! BUILD_BRIDGE
  1770. // -------------------------------------------------------------------
  1771. // MIDI events
  1772. void CarlaPlugin::sendMidiSingleNote(const uint8_t channel, const uint8_t note, const uint8_t velo, const bool sendGui, const bool sendOsc, const bool sendCallback)
  1773. {
  1774. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1775. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1776. CARLA_SAFE_ASSERT_RETURN(velo < MAX_MIDI_VALUE,);
  1777. if (! pData->active)
  1778. return;
  1779. ExternalMidiNote extNote;
  1780. extNote.channel = static_cast<int8_t>(channel);
  1781. extNote.note = note;
  1782. extNote.velo = velo;
  1783. pData->extNotes.appendNonRT(extNote);
  1784. if (sendGui && (pData->hints & PLUGIN_HAS_CUSTOM_UI) != 0)
  1785. {
  1786. if (velo > 0)
  1787. uiNoteOn(channel, note, velo);
  1788. else
  1789. uiNoteOff(channel, note);
  1790. }
  1791. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  1792. if (sendOsc && pData->engine->isOscControlRegistered())
  1793. {
  1794. if (velo > 0)
  1795. pData->engine->oscSend_control_note_on(pData->id, channel, note, velo);
  1796. else
  1797. pData->engine->oscSend_control_note_off(pData->id, channel, note);
  1798. }
  1799. #endif
  1800. if (sendCallback)
  1801. pData->engine->callback((velo > 0) ? ENGINE_CALLBACK_NOTE_ON : ENGINE_CALLBACK_NOTE_OFF, pData->id, channel, note, velo, nullptr);
  1802. // may be unused
  1803. return; (void)sendOsc;
  1804. }
  1805. #ifndef BUILD_BRIDGE
  1806. void CarlaPlugin::sendMidiAllNotesOffToCallback()
  1807. {
  1808. if (pData->ctrlChannel < 0 || pData->ctrlChannel >= MAX_MIDI_CHANNELS)
  1809. return;
  1810. PluginPostRtEvent postEvent;
  1811. postEvent.type = kPluginPostRtEventNoteOff;
  1812. postEvent.value1 = pData->ctrlChannel;
  1813. postEvent.value2 = 0;
  1814. postEvent.value3 = 0.0f;
  1815. for (int32_t i=0; i < MAX_MIDI_NOTE; ++i)
  1816. {
  1817. postEvent.value2 = i;
  1818. pData->postRtEvents.appendRT(postEvent);
  1819. }
  1820. }
  1821. #endif
  1822. // -------------------------------------------------------------------
  1823. // UI Stuff
  1824. void CarlaPlugin::showCustomUI(const bool yesNo)
  1825. {
  1826. if (yesNo) {
  1827. CARLA_SAFE_ASSERT(false);
  1828. }
  1829. }
  1830. void CarlaPlugin::uiIdle()
  1831. {
  1832. if (pData->hints & PLUGIN_NEEDS_UI_MAIN_THREAD)
  1833. {
  1834. // Update parameter outputs
  1835. for (uint32_t i=0; i < pData->param.count; ++i)
  1836. {
  1837. if (pData->param.data[i].type == PARAMETER_OUTPUT)
  1838. uiParameterChange(i, getParameterValue(i));
  1839. }
  1840. const CarlaMutexLocker sl(pData->postUiEvents.mutex);
  1841. for (LinkedList<PluginPostRtEvent>::Itenerator it = pData->postUiEvents.data.begin2(); it.valid(); it.next())
  1842. {
  1843. const PluginPostRtEvent& event(it.getValue(kPluginPostRtEventFallback));
  1844. CARLA_SAFE_ASSERT_CONTINUE(event.type != kPluginPostRtEventNull);
  1845. switch (event.type)
  1846. {
  1847. case kPluginPostRtEventNull:
  1848. case kPluginPostRtEventDebug:
  1849. break;
  1850. case kPluginPostRtEventParameterChange:
  1851. uiParameterChange(static_cast<uint32_t>(event.value1), event.value3);
  1852. break;
  1853. case kPluginPostRtEventProgramChange:
  1854. uiProgramChange(static_cast<uint32_t>(event.value1));
  1855. break;
  1856. case kPluginPostRtEventMidiProgramChange:
  1857. uiMidiProgramChange(static_cast<uint32_t>(event.value1));
  1858. break;
  1859. case kPluginPostRtEventNoteOn:
  1860. uiNoteOn(static_cast<uint8_t>(event.value1), static_cast<uint8_t>(event.value2), uint8_t(event.value3));
  1861. break;
  1862. case kPluginPostRtEventNoteOff:
  1863. uiNoteOff(static_cast<uint8_t>(event.value1), static_cast<uint8_t>(event.value2));
  1864. break;
  1865. }
  1866. }
  1867. pData->postUiEvents.data.clear();
  1868. }
  1869. #ifndef BUILD_BRIDGE
  1870. if (pData->transientTryCounter == 0)
  1871. return;
  1872. if (++pData->transientTryCounter % 10 != 0)
  1873. return;
  1874. if (pData->transientTryCounter >= 200)
  1875. return;
  1876. carla_stdout("Trying to get window...");
  1877. CarlaString uiTitle(pData->name);
  1878. uiTitle += " (GUI)";
  1879. if (CarlaPluginUI::tryTransientWinIdMatch(getUiBridgeProcessId(), uiTitle,
  1880. pData->engine->getOptions().frontendWinId, pData->transientFirstTry))
  1881. {
  1882. pData->transientTryCounter = 0;
  1883. pData->transientFirstTry = false;
  1884. }
  1885. #endif
  1886. }
  1887. void CarlaPlugin::uiParameterChange(const uint32_t index, const float value) noexcept
  1888. {
  1889. CARLA_SAFE_ASSERT_RETURN(index < getParameterCount(),);
  1890. return;
  1891. // unused
  1892. (void)value;
  1893. }
  1894. void CarlaPlugin::uiProgramChange(const uint32_t index) noexcept
  1895. {
  1896. CARLA_SAFE_ASSERT_RETURN(index < getProgramCount(),);
  1897. }
  1898. void CarlaPlugin::uiMidiProgramChange(const uint32_t index) noexcept
  1899. {
  1900. CARLA_SAFE_ASSERT_RETURN(index < getMidiProgramCount(),);
  1901. }
  1902. void CarlaPlugin::uiNoteOn(const uint8_t channel, const uint8_t note, const uint8_t velo) noexcept
  1903. {
  1904. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1905. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1906. CARLA_SAFE_ASSERT_RETURN(velo > 0 && velo < MAX_MIDI_VALUE,);
  1907. }
  1908. void CarlaPlugin::uiNoteOff(const uint8_t channel, const uint8_t note) noexcept
  1909. {
  1910. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1911. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1912. }
  1913. bool CarlaPlugin::canRunInRack() const noexcept
  1914. {
  1915. return (pData->extraHints & PLUGIN_EXTRA_HINT_CAN_RUN_RACK) != 0;
  1916. }
  1917. CarlaEngine* CarlaPlugin::getEngine() const noexcept
  1918. {
  1919. return pData->engine;
  1920. }
  1921. CarlaEngineClient* CarlaPlugin::getEngineClient() const noexcept
  1922. {
  1923. return pData->client;
  1924. }
  1925. CarlaEngineAudioPort* CarlaPlugin::getAudioInPort(const uint32_t index) const noexcept
  1926. {
  1927. return pData->audioIn.ports[index].port;
  1928. }
  1929. CarlaEngineAudioPort* CarlaPlugin::getAudioOutPort(const uint32_t index) const noexcept
  1930. {
  1931. return pData->audioOut.ports[index].port;
  1932. }
  1933. CarlaEngineCVPort* CarlaPlugin::getCVInPort(const uint32_t index) const noexcept
  1934. {
  1935. return pData->cvIn.ports[index].port;
  1936. }
  1937. CarlaEngineCVPort* CarlaPlugin::getCVOutPort(const uint32_t index) const noexcept
  1938. {
  1939. return pData->cvOut.ports[index].port;
  1940. }
  1941. CarlaEngineEventPort* CarlaPlugin::getDefaultEventInPort() const noexcept
  1942. {
  1943. return pData->event.portIn;
  1944. }
  1945. CarlaEngineEventPort* CarlaPlugin::getDefaultEventOutPort() const noexcept
  1946. {
  1947. return pData->event.portOut;
  1948. }
  1949. void* CarlaPlugin::getNativeHandle() const noexcept
  1950. {
  1951. return nullptr;
  1952. }
  1953. const void* CarlaPlugin::getNativeDescriptor() const noexcept
  1954. {
  1955. return nullptr;
  1956. }
  1957. uintptr_t CarlaPlugin::getUiBridgeProcessId() const noexcept
  1958. {
  1959. return 0;
  1960. }
  1961. // -------------------------------------------------------------------
  1962. uint32_t CarlaPlugin::getPatchbayNodeId() const noexcept
  1963. {
  1964. return pData->nodeId;
  1965. }
  1966. void CarlaPlugin::setPatchbayNodeId(const uint32_t nodeId) noexcept
  1967. {
  1968. pData->nodeId = nodeId;
  1969. }
  1970. // -------------------------------------------------------------------
  1971. void CarlaPlugin::restoreLV2State() noexcept
  1972. {
  1973. }
  1974. void CarlaPlugin::waitForBridgeSaveSignal() noexcept
  1975. {
  1976. }
  1977. // -------------------------------------------------------------------
  1978. // Scoped Disabler
  1979. CarlaPlugin::ScopedDisabler::ScopedDisabler(CarlaPlugin* const plugin) noexcept
  1980. : fPlugin(plugin),
  1981. fWasEnabled(false)
  1982. {
  1983. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr,);
  1984. CARLA_SAFE_ASSERT_RETURN(plugin->pData != nullptr,);
  1985. CARLA_SAFE_ASSERT_RETURN(plugin->pData->client != nullptr,);
  1986. carla_debug("CarlaPlugin::ScopedDisabler(%p)", plugin);
  1987. plugin->pData->masterMutex.lock();
  1988. if (plugin->pData->enabled)
  1989. {
  1990. fWasEnabled = true;
  1991. plugin->pData->enabled = false;
  1992. if (plugin->pData->client->isActive())
  1993. plugin->pData->client->deactivate();
  1994. }
  1995. }
  1996. CarlaPlugin::ScopedDisabler::~ScopedDisabler() noexcept
  1997. {
  1998. CARLA_SAFE_ASSERT_RETURN(fPlugin != nullptr,);
  1999. CARLA_SAFE_ASSERT_RETURN(fPlugin->pData != nullptr,);
  2000. CARLA_SAFE_ASSERT_RETURN(fPlugin->pData->client != nullptr,);
  2001. carla_debug("CarlaPlugin::~ScopedDisabler()");
  2002. if (fWasEnabled)
  2003. {
  2004. fPlugin->pData->enabled = true;
  2005. fPlugin->pData->client->activate();
  2006. }
  2007. fPlugin->pData->masterMutex.unlock();
  2008. }
  2009. // -------------------------------------------------------------------
  2010. // Scoped Process Locker
  2011. CarlaPlugin::ScopedSingleProcessLocker::ScopedSingleProcessLocker(CarlaPlugin* const plugin, const bool block) noexcept
  2012. : fPlugin(plugin),
  2013. fBlock(block)
  2014. {
  2015. CARLA_SAFE_ASSERT_RETURN(fPlugin != nullptr,);
  2016. CARLA_SAFE_ASSERT_RETURN(fPlugin->pData != nullptr,);
  2017. carla_debug("CarlaPlugin::ScopedSingleProcessLocker(%p, %s)", plugin, bool2str(block));
  2018. if (! fBlock)
  2019. return;
  2020. plugin->pData->singleMutex.lock();
  2021. }
  2022. CarlaPlugin::ScopedSingleProcessLocker::~ScopedSingleProcessLocker() noexcept
  2023. {
  2024. CARLA_SAFE_ASSERT_RETURN(fPlugin != nullptr,);
  2025. CARLA_SAFE_ASSERT_RETURN(fPlugin->pData != nullptr,);
  2026. carla_debug("CarlaPlugin::~ScopedSingleProcessLocker()");
  2027. if (! fBlock)
  2028. return;
  2029. #ifndef BUILD_BRIDGE
  2030. if (fPlugin->pData->singleMutex.wasTryLockCalled())
  2031. fPlugin->pData->needsReset = true;
  2032. #endif
  2033. fPlugin->pData->singleMutex.unlock();
  2034. }
  2035. // -------------------------------------------------------------------
  2036. CARLA_BACKEND_END_NAMESPACE