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.

1073 lines
40KB

  1. /*
  2. * Carla JSFX Plugin
  3. * Copyright (C) 2021 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. // TODO(jsfx) graphics section
  18. #include "CarlaPluginInternal.hpp"
  19. #include "CarlaEngine.hpp"
  20. #include "CarlaJsfxUtils.hpp"
  21. #include "CarlaBackendUtils.hpp"
  22. #include "CarlaUtils.hpp"
  23. #include "water/files/File.h"
  24. #include "water/text/StringArray.h"
  25. #include <algorithm>
  26. #include <cstdio>
  27. #include <cstring>
  28. using water::CharPointer_UTF8;
  29. using water::File;
  30. using water::String;
  31. using water::StringArray;
  32. CARLA_BACKEND_START_NAMESPACE
  33. // -------------------------------------------------------------------------------------------------------------------
  34. // Fallback data
  35. static const ExternalMidiNote kExternalMidiNoteFallback = { -1, 0, 0 };
  36. // -------------------------------------------------------------------------------------------------------------------
  37. class CarlaPluginJSFX : public CarlaPlugin
  38. {
  39. public:
  40. CarlaPluginJSFX(CarlaEngine* const engine, const uint id) noexcept
  41. : CarlaPlugin(engine, id),
  42. fMapOfSliderToParameter(ysfx_max_sliders, -1)
  43. {
  44. carla_debug("CarlaPluginJSFX::CarlaPluginJSFX(%p, %i)", engine, id);
  45. }
  46. ~CarlaPluginJSFX()
  47. {
  48. carla_debug("CarlaPluginJSFX::~CarlaPluginJSFX()");
  49. pData->singleMutex.lock();
  50. pData->masterMutex.lock();
  51. if (pData->client != nullptr && pData->client->isActive())
  52. pData->client->deactivate(true);
  53. if (pData->active)
  54. {
  55. deactivate();
  56. pData->active = false;
  57. }
  58. clearBuffers();
  59. }
  60. // -------------------------------------------------------------------
  61. // Information (base)
  62. PluginType getType() const noexcept override
  63. {
  64. return PLUGIN_JSFX;
  65. }
  66. PluginCategory getCategory() const noexcept override
  67. {
  68. CARLA_SAFE_ASSERT_RETURN(fEffect != nullptr, CarlaPlugin::getCategory());
  69. return CarlaJsfxCategories::getFromEffect(fEffect.get());
  70. }
  71. uint32_t getLatencyInFrames() const noexcept override
  72. {
  73. CARLA_SAFE_ASSERT_RETURN(fEffect != nullptr, 0);
  74. ysfx_real sampleRate = ysfx_get_sample_rate(fEffect.get());
  75. ysfx_real latencyInSeconds = ysfx_get_pdc_delay(fEffect.get());
  76. //NOTE: `pdc_bot_ch` and `pdc_top_ch` channel range ignored
  77. int32_t latencyInFrames = water::roundToInt(latencyInSeconds * sampleRate);
  78. wassert(latencyInFrames >= 0);
  79. return (uint32_t)latencyInFrames;
  80. }
  81. // -------------------------------------------------------------------
  82. // Information (count)
  83. uint32_t getMidiInCount() const noexcept override
  84. {
  85. return 1;
  86. }
  87. uint32_t getMidiOutCount() const noexcept override
  88. {
  89. return 1;
  90. }
  91. uint32_t getParameterScalePointCount(const uint32_t parameterId) const noexcept override
  92. {
  93. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, 0);
  94. int32_t rindex = pData->param.data[parameterId].rindex;
  95. return ysfx_slider_get_enum_names(fEffect.get(), (uint32_t)rindex, nullptr, 0);;
  96. }
  97. // -------------------------------------------------------------------
  98. // Information (current data)
  99. std::size_t getChunkData(void** dataPtr) noexcept override
  100. {
  101. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS, 0);
  102. CARLA_SAFE_ASSERT_RETURN(dataPtr != nullptr, 0);
  103. ysfx_state_u state(ysfx_save_state(fEffect.get()));
  104. CARLA_SAFE_ASSERT_RETURN(state, 0);
  105. fChunkText = CarlaJsfxState::convertToString(*state);
  106. *dataPtr = (void*)fChunkText.toRawUTF8();
  107. return (std::size_t)fChunkText.getNumBytesAsUTF8();
  108. }
  109. // -------------------------------------------------------------------
  110. // Information (per-plugin data)
  111. uint getOptionsAvailable() const noexcept override
  112. {
  113. uint options = 0x0;
  114. options |= PLUGIN_OPTION_USE_CHUNKS;
  115. options |= PLUGIN_OPTION_SEND_CONTROL_CHANGES;
  116. options |= PLUGIN_OPTION_SEND_CHANNEL_PRESSURE;
  117. options |= PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH;
  118. options |= PLUGIN_OPTION_SEND_PITCHBEND;
  119. options |= PLUGIN_OPTION_SEND_ALL_SOUND_OFF;
  120. options |= PLUGIN_OPTION_SEND_PROGRAM_CHANGES;
  121. options |= PLUGIN_OPTION_SKIP_SENDING_NOTES;
  122. return options;
  123. }
  124. float getParameterValue(const uint32_t parameterId) const noexcept override
  125. {
  126. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, 0.0f);
  127. int32_t rindex = pData->param.data[parameterId].rindex;
  128. return ysfx_slider_get_value(fEffect.get(), (uint32_t)rindex);
  129. }
  130. bool getParameterName(const uint32_t parameterId, char* const strBuf) const noexcept override
  131. {
  132. CARLA_SAFE_ASSERT_RETURN(fEffect != nullptr, false);
  133. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, false);
  134. int32_t rindex = pData->param.data[parameterId].rindex;
  135. const char *name = ysfx_slider_get_name(fEffect.get(), (uint32_t)rindex);
  136. std::snprintf(strBuf, STR_MAX, "%s", name);
  137. return true;
  138. }
  139. bool getParameterText(const uint32_t parameterId, char* const strBuf) noexcept override
  140. {
  141. CARLA_SAFE_ASSERT_RETURN(fEffect != nullptr, false);
  142. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, false);
  143. int32_t rindex = pData->param.data[parameterId].rindex;
  144. float value = ysfx_slider_get_value(fEffect.get(), (uint32_t)rindex);
  145. int32_t enumIndex = -1;
  146. if (ysfx_slider_is_enum(fEffect.get(), (uint32_t)rindex))
  147. {
  148. uint32_t enumCount = ysfx_slider_get_enum_names(fEffect.get(), (uint32_t)rindex, nullptr, 0);
  149. if ((int32_t)value >= 0 && (uint32_t)value < enumCount)
  150. enumIndex = (int32_t)value;
  151. }
  152. if (enumIndex != -1)
  153. std::snprintf(strBuf, STR_MAX, "%s", ysfx_slider_get_name(fEffect.get(), (uint32_t)enumIndex));
  154. else
  155. std::snprintf(strBuf, STR_MAX, "%.12g", value);
  156. return true;
  157. }
  158. float getParameterScalePointValue(const uint32_t parameterId, const uint32_t scalePointId) const noexcept override
  159. {
  160. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), 0.0f);
  161. CARLA_SAFE_ASSERT_RETURN(scalePointId < getParameterScalePointCount(parameterId), 0.0f);
  162. return (float)scalePointId;
  163. }
  164. bool getParameterScalePointLabel(const uint32_t parameterId, const uint32_t scalePointId, char* const strBuf) const noexcept override
  165. {
  166. CARLA_SAFE_ASSERT_RETURN(parameterId < getParameterCount(), false);
  167. int32_t rindex = pData->param.data[parameterId].rindex;
  168. uint32_t enumCount = ysfx_slider_get_enum_names(fEffect.get(), (uint32_t)rindex, nullptr, 0);
  169. CARLA_SAFE_ASSERT_RETURN(scalePointId < enumCount, false);
  170. std::snprintf(strBuf, STR_MAX, "%s", ysfx_slider_get_enum_name(fEffect.get(), (uint32_t)rindex, scalePointId));
  171. return true;
  172. }
  173. bool getLabel(char* const strBuf) const noexcept override
  174. {
  175. std::strncpy(strBuf, fUnit.getFileId().toRawUTF8(), STR_MAX);
  176. return true;
  177. }
  178. // -------------------------------------------------------------------
  179. // Set data (plugin-specific stuff)
  180. void setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  181. {
  182. CARLA_SAFE_ASSERT_RETURN(fEffect != nullptr,);
  183. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  184. int32_t rindex = pData->param.data[parameterId].rindex;
  185. ysfx_slider_set_value(fEffect.get(), rindex, value);
  186. CarlaPlugin::setParameterValue(parameterId, value, sendGui, sendOsc, sendCallback);
  187. }
  188. void setParameterValueRT(const uint32_t parameterId, const float value, const bool sendCallbackLater) noexcept override
  189. {
  190. CARLA_SAFE_ASSERT_RETURN(fEffect != nullptr,);
  191. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  192. int32_t rindex = pData->param.data[parameterId].rindex;
  193. ysfx_slider_set_value(fEffect.get(), rindex, value);
  194. CarlaPlugin::setParameterValueRT(parameterId, value, sendCallbackLater);
  195. }
  196. void setChunkData(const void* data, std::size_t dataSize) override
  197. {
  198. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS,);
  199. water::String dataText(water::CharPointer_UTF8((const char*)data), dataSize);
  200. ysfx_state_u state(CarlaJsfxState::convertFromString(dataText));
  201. CARLA_SAFE_ASSERT_RETURN(state,);
  202. CARLA_SAFE_ASSERT_RETURN(ysfx_load_state(fEffect.get(), state.get()),);
  203. }
  204. // -------------------------------------------------------------------
  205. // Plugin state
  206. void reload() override
  207. {
  208. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr,);
  209. CARLA_SAFE_ASSERT_RETURN(fEffect != nullptr,);
  210. carla_debug("CarlaPluginJSFX::reload()");
  211. const EngineProcessMode processMode(pData->engine->getProccessMode());
  212. // Safely disable plugin for reload
  213. const ScopedDisabler sd(this);
  214. if (pData->active)
  215. deactivate();
  216. clearBuffers();
  217. // ---------------------------------------------------------------
  218. // initialize the block size and sample rate
  219. // loading the chunk can invoke @slider which makes computations based on these
  220. ysfx_set_sample_rate(fEffect.get(), pData->engine->getSampleRate());
  221. ysfx_set_block_size(fEffect.get(), (uint32_t)pData->engine->getBufferSize());
  222. ysfx_init(fEffect.get());
  223. const uint32_t aIns = ysfx_get_num_inputs(fEffect.get());
  224. const uint32_t aOuts = ysfx_get_num_outputs(fEffect.get());
  225. // perhaps we obtained a latency value from @init
  226. pData->client->setLatency(getLatencyInFrames());
  227. if (aIns > 0)
  228. {
  229. pData->audioIn.createNew(aIns);
  230. }
  231. if (aOuts > 0)
  232. {
  233. pData->audioOut.createNew(aOuts);
  234. }
  235. // count the sliders and establish the mappings between parameter and slider
  236. uint32_t params = 0;
  237. uint32_t mapOfParameterToSlider[ysfx_max_sliders];
  238. for (uint32_t rindex = 0; rindex < ysfx_max_sliders; ++rindex)
  239. {
  240. if (ysfx_slider_exists(fEffect.get(), rindex))
  241. {
  242. mapOfParameterToSlider[params] = rindex;
  243. fMapOfSliderToParameter[rindex] = (int32_t)params;
  244. ++params;
  245. }
  246. else
  247. {
  248. fMapOfSliderToParameter[rindex] = -1;
  249. }
  250. }
  251. if (params > 0)
  252. {
  253. pData->param.createNew(params, false);
  254. }
  255. const uint portNameSize(pData->engine->getMaxPortNameSize());
  256. CarlaString portName;
  257. // Audio Ins
  258. for (uint32_t j = 0; j < aIns; ++j)
  259. {
  260. portName.clear();
  261. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  262. {
  263. portName = pData->name;
  264. portName += ":";
  265. }
  266. const char* const inputName = ysfx_get_input_name(fEffect.get(), j);
  267. if (inputName && inputName[0])
  268. {
  269. portName += inputName;
  270. }
  271. else if (aIns > 1)
  272. {
  273. portName += "input_";
  274. portName += CarlaString(j+1);
  275. }
  276. else
  277. portName += "input";
  278. portName.truncate(portNameSize);
  279. pData->audioIn.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, true, j);
  280. pData->audioIn.ports[j].rindex = j;
  281. }
  282. // Audio Outs
  283. for (uint32_t j = 0; j < aOuts; ++j)
  284. {
  285. portName.clear();
  286. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  287. {
  288. portName = pData->name;
  289. portName += ":";
  290. }
  291. const char* const outputName = ysfx_get_input_name(fEffect.get(), j);
  292. if (outputName && outputName[0])
  293. {
  294. portName += outputName;
  295. }
  296. else if (aOuts > 1)
  297. {
  298. portName += "output_";
  299. portName += CarlaString(j+1);
  300. }
  301. else
  302. portName += "output";
  303. portName.truncate(portNameSize);
  304. pData->audioOut.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, false, j);
  305. pData->audioOut.ports[j].rindex = j;
  306. }
  307. // Parameters
  308. for (uint32_t j = 0; j < params; ++j)
  309. {
  310. const uint32_t rindex = mapOfParameterToSlider[j];
  311. pData->param.data[j].type = PARAMETER_INPUT;
  312. pData->param.data[j].index = (int32_t)j;
  313. pData->param.data[j].rindex = (int32_t)rindex;
  314. ysfx_slider_range_t range = {};
  315. ysfx_slider_get_range(fEffect.get(), rindex, &range);
  316. float min = (float)range.min;
  317. float max = (float)range.max;
  318. float def = (float)range.def;
  319. float step = (float)range.inc;
  320. // only use values as integer if we have a proper range
  321. bool isEnum = ysfx_slider_is_enum(fEffect.get(), rindex) &&
  322. min == 0.0f && max >= 0.0f &&
  323. max + 1.0f == (float)ysfx_slider_get_enum_names(fEffect.get(), rindex, nullptr, 0);
  324. // NOTE: in case of incomplete slider specification without <min,max,step>;
  325. // these are usually output-only sliders.
  326. if (min == max)
  327. {
  328. // replace with a dummy range
  329. min = 0.0f;
  330. max = 1.0f;
  331. }
  332. if (min > max)
  333. std::swap(min, max);
  334. if (def < min)
  335. def = min;
  336. else if (def > max)
  337. def = max;
  338. float stepSmall;
  339. float stepLarge;
  340. if (isEnum)
  341. {
  342. step = 1.0f;
  343. stepSmall = 1.0f;
  344. stepLarge = 10.0f;
  345. }
  346. else
  347. {
  348. stepSmall = step/10.0f;
  349. stepLarge = step*10.0f;
  350. }
  351. pData->param.data[j].hints |= PARAMETER_IS_ENABLED;
  352. if (isEnum)
  353. {
  354. pData->param.data[j].hints |= PARAMETER_IS_INTEGER;
  355. pData->param.data[j].hints |= PARAMETER_USES_SCALEPOINTS;
  356. pData->param.data[j].hints |= PARAMETER_USES_CUSTOM_TEXT;
  357. }
  358. else
  359. {
  360. pData->param.data[j].hints |= PARAMETER_CAN_BE_CV_CONTROLLED;
  361. }
  362. pData->param.ranges[j].min = min;
  363. pData->param.ranges[j].max = max;
  364. pData->param.ranges[j].def = def;
  365. pData->param.ranges[j].step = step;
  366. pData->param.ranges[j].stepSmall = stepSmall;
  367. pData->param.ranges[j].stepLarge = stepLarge;
  368. }
  369. //if (needsCtrlIn)
  370. {
  371. portName.clear();
  372. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  373. {
  374. portName = pData->name;
  375. portName += ":";
  376. }
  377. portName += "events-in";
  378. portName.truncate(portNameSize);
  379. pData->event.portIn = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, true, 0);
  380. }
  381. //if (needsCtrlOut)
  382. {
  383. portName.clear();
  384. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  385. {
  386. portName = pData->name;
  387. portName += ":";
  388. }
  389. portName += "events-out";
  390. portName.truncate(portNameSize);
  391. pData->event.portOut = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, false, 0);
  392. }
  393. }
  394. // -------------------------------------------------------------------
  395. // Plugin processing
  396. void activate() noexcept override
  397. {
  398. CARLA_SAFE_ASSERT_RETURN(fEffect,);
  399. ysfx_set_sample_rate(fEffect.get(), pData->engine->getSampleRate());
  400. ysfx_set_block_size(fEffect.get(), (uint32_t)pData->engine->getBufferSize());
  401. ysfx_init(fEffect.get());
  402. fTransportValues.tempo = 120;
  403. fTransportValues.playback_state = ysfx_playback_paused;
  404. fTransportValues.time_position = 0;
  405. fTransportValues.beat_position = 0;
  406. fTransportValues.time_signature[0] = 4;
  407. fTransportValues.time_signature[1] = 4;
  408. }
  409. void process(const float* const* const audioIn, float** const audioOut,
  410. const float* const* const, float**,
  411. const uint32_t frames) override
  412. {
  413. CARLA_SAFE_ASSERT_RETURN(fEffect,);
  414. // --------------------------------------------------------------------------------------------------------
  415. // Set TimeInfo
  416. const EngineTimeInfo timeInfo = pData->engine->getTimeInfo();
  417. const EngineTimeInfoBBT& bbt = timeInfo.bbt;
  418. fTransportValues.playback_state = timeInfo.playing ?
  419. ysfx_playback_playing : ysfx_playback_paused;
  420. fTransportValues.time_position = 1e-6*double(timeInfo.usecs);
  421. if (bbt.valid)
  422. {
  423. const double samplePos = double(timeInfo.frame);
  424. const double sampleRate = pData->engine->getSampleRate();
  425. fTransportValues.tempo = bbt.beatsPerMinute;
  426. fTransportValues.beat_position = samplePos / (sampleRate * 60 / bbt.beatsPerMinute);
  427. fTransportValues.time_signature[0] = (uint32_t)bbt.beatsPerBar;
  428. fTransportValues.time_signature[1] = (uint32_t)bbt.beatType;
  429. }
  430. ysfx_set_time_info(fEffect.get(), &fTransportValues);
  431. // --------------------------------------------------------------------------------------------------------
  432. // Event Input and Processing
  433. if (pData->event.portIn != nullptr)
  434. {
  435. // ----------------------------------------------------------------------------------------------------
  436. // MIDI Input (External)
  437. if (pData->extNotes.mutex.tryLock())
  438. {
  439. for (RtLinkedList<ExternalMidiNote>::Itenerator it = pData->extNotes.data.begin2(); it.valid(); it.next())
  440. {
  441. const ExternalMidiNote& note(it.getValue(kExternalMidiNoteFallback));
  442. CARLA_SAFE_ASSERT_CONTINUE(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS);
  443. uint8_t midiData[3];
  444. midiData[0] = uint8_t((note.velo > 0 ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF) | (note.channel & MIDI_CHANNEL_BIT));
  445. midiData[1] = note.note;
  446. midiData[2] = note.velo;
  447. ysfx_midi_event_t event;
  448. event.bus = 0;
  449. event.offset = 0;
  450. event.size = 3;
  451. event.data = midiData;
  452. ysfx_send_midi(fEffect.get(), &event);
  453. }
  454. pData->extNotes.data.clear();
  455. pData->extNotes.mutex.unlock();
  456. } // End of MIDI Input (External)
  457. // ----------------------------------------------------------------------------------------------------
  458. // Event Input (System)
  459. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  460. bool allNotesOffSent = false;
  461. #endif
  462. for (uint32_t i=0, numEvents=pData->event.portIn->getEventCount(); i < numEvents; ++i)
  463. {
  464. EngineEvent& event(pData->event.portIn->getEvent(i));
  465. if (event.time >= frames)
  466. continue;
  467. auto addInputEvent = [this]
  468. (uint32_t offset, const uint8_t *data, uint32_t size)
  469. {
  470. ysfx_midi_event_t event;
  471. event.bus = 0;
  472. event.offset = offset;
  473. event.size = size;
  474. event.data = data;
  475. ysfx_send_midi(fEffect.get(), &event);
  476. };
  477. switch (event.type)
  478. {
  479. case kEngineEventTypeNull:
  480. break;
  481. case kEngineEventTypeControl: {
  482. EngineControlEvent& ctrlEvent(event.ctrl);
  483. switch (ctrlEvent.type)
  484. {
  485. case kEngineControlEventTypeNull:
  486. break;
  487. case kEngineControlEventTypeParameter: {
  488. float value;
  489. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  490. // non-midi
  491. if (event.channel == kEngineEventNonMidiChannel)
  492. {
  493. const uint32_t k = ctrlEvent.param;
  494. CARLA_SAFE_ASSERT_CONTINUE(k < pData->param.count);
  495. ctrlEvent.handled = true;
  496. value = pData->param.getFinalUnnormalizedValue(k, ctrlEvent.normalizedValue);
  497. setParameterValueRT(k, value, true);
  498. continue;
  499. }
  500. // Control backend stuff
  501. if (event.channel == pData->ctrlChannel)
  502. {
  503. if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_DRYWET) != 0)
  504. {
  505. ctrlEvent.handled = true;
  506. value = ctrlEvent.normalizedValue;
  507. setDryWetRT(value, true);
  508. }
  509. else if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_VOLUME) != 0)
  510. {
  511. ctrlEvent.handled = true;
  512. value = ctrlEvent.normalizedValue*127.0f/100.0f;
  513. setVolumeRT(value, true);
  514. }
  515. else if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_BALANCE) != 0)
  516. {
  517. float left, right;
  518. value = ctrlEvent.normalizedValue/0.5f - 1.0f;
  519. if (value < 0.0f)
  520. {
  521. left = -1.0f;
  522. right = (value*2.0f)+1.0f;
  523. }
  524. else if (value > 0.0f)
  525. {
  526. left = (value*2.0f)-1.0f;
  527. right = 1.0f;
  528. }
  529. else
  530. {
  531. left = -1.0f;
  532. right = 1.0f;
  533. }
  534. ctrlEvent.handled = true;
  535. setBalanceLeftRT(left, true);
  536. setBalanceRightRT(right, true);
  537. }
  538. }
  539. #endif
  540. // Control plugin parameters
  541. uint32_t k;
  542. for (k=0; k < pData->param.count; ++k)
  543. {
  544. if (pData->param.data[k].midiChannel != event.channel)
  545. continue;
  546. if (pData->param.data[k].mappedControlIndex != ctrlEvent.param)
  547. continue;
  548. if (pData->param.data[k].type != PARAMETER_INPUT)
  549. continue;
  550. if ((pData->param.data[k].hints & PARAMETER_IS_AUTOMABLE) == 0)
  551. continue;
  552. ctrlEvent.handled = true;
  553. value = pData->param.getFinalUnnormalizedValue(k, ctrlEvent.normalizedValue);
  554. setParameterValueRT(k, value, true);
  555. }
  556. if ((pData->options & PLUGIN_OPTION_SEND_CONTROL_CHANGES) != 0 && ctrlEvent.param < MAX_MIDI_VALUE)
  557. {
  558. uint8_t midiData[3];
  559. midiData[0] = uint8_t(MIDI_STATUS_CONTROL_CHANGE | (event.channel & MIDI_CHANNEL_BIT));
  560. midiData[1] = uint8_t(ctrlEvent.param);
  561. midiData[2] = uint8_t(ctrlEvent.normalizedValue*127.0f);
  562. addInputEvent(event.time, midiData, 3);
  563. }
  564. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  565. if (! ctrlEvent.handled)
  566. checkForMidiLearn(event);
  567. #endif
  568. break;
  569. } // case kEngineControlEventTypeParameter
  570. case kEngineControlEventTypeMidiBank:
  571. if ((pData->options & PLUGIN_OPTION_SEND_PROGRAM_CHANGES) != 0)
  572. {
  573. uint8_t midiData[3];
  574. midiData[0] = uint8_t(MIDI_STATUS_CONTROL_CHANGE | (event.channel & MIDI_CHANNEL_BIT));
  575. midiData[1] = MIDI_CONTROL_BANK_SELECT;
  576. midiData[2] = 0;
  577. addInputEvent(event.time, midiData, 3);
  578. midiData[1] = MIDI_CONTROL_BANK_SELECT__LSB;
  579. midiData[2] = uint8_t(ctrlEvent.normalizedValue*127.0f);
  580. addInputEvent(event.time, midiData, 3);
  581. }
  582. break;
  583. case kEngineControlEventTypeMidiProgram:
  584. if (event.channel == pData->ctrlChannel && (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES) != 0)
  585. {
  586. if (ctrlEvent.param < pData->prog.count)
  587. {
  588. setProgramRT(ctrlEvent.param, true);
  589. }
  590. }
  591. else if ((pData->options & PLUGIN_OPTION_SEND_PROGRAM_CHANGES) != 0)
  592. {
  593. uint8_t midiData[3];
  594. midiData[0] = uint8_t(MIDI_STATUS_PROGRAM_CHANGE | (event.channel & MIDI_CHANNEL_BIT));
  595. midiData[1] = uint8_t(ctrlEvent.normalizedValue*127.0f);
  596. addInputEvent(event.time, midiData, 2);
  597. }
  598. break;
  599. case kEngineControlEventTypeAllSoundOff:
  600. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  601. {
  602. uint8_t midiData[3];
  603. midiData[0] = uint8_t(MIDI_STATUS_CONTROL_CHANGE | (event.channel & MIDI_CHANNEL_BIT));
  604. midiData[1] = MIDI_CONTROL_ALL_SOUND_OFF;
  605. midiData[2] = 0;
  606. addInputEvent(event.time, midiData, 3);
  607. }
  608. break;
  609. case kEngineControlEventTypeAllNotesOff:
  610. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  611. {
  612. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  613. if (event.channel == pData->ctrlChannel && ! allNotesOffSent)
  614. {
  615. allNotesOffSent = true;
  616. postponeRtAllNotesOff();
  617. }
  618. #endif
  619. uint8_t midiData[3];
  620. midiData[0] = uint8_t(MIDI_STATUS_CONTROL_CHANGE | (event.channel & MIDI_CHANNEL_BIT));
  621. midiData[1] = MIDI_CONTROL_ALL_NOTES_OFF;
  622. midiData[2] = 0;
  623. addInputEvent(event.time, midiData, 3);
  624. }
  625. break;
  626. } // switch (ctrlEvent.type)
  627. break;
  628. } // case kEngineEventTypeControl
  629. case kEngineEventTypeMidi: {
  630. const EngineMidiEvent& midiEvent(event.midi);
  631. const uint8_t* const midiData(midiEvent.size > EngineMidiEvent::kDataSize ? midiEvent.dataExt : midiEvent.data);
  632. uint8_t status = uint8_t(MIDI_GET_STATUS_FROM_DATA(midiData));
  633. if ((status == MIDI_STATUS_NOTE_OFF || status == MIDI_STATUS_NOTE_ON) && (pData->options & PLUGIN_OPTION_SKIP_SENDING_NOTES))
  634. continue;
  635. if (status == MIDI_STATUS_CHANNEL_PRESSURE && (pData->options & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0)
  636. continue;
  637. if (status == MIDI_STATUS_CONTROL_CHANGE && (pData->options & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0)
  638. continue;
  639. if (status == MIDI_STATUS_POLYPHONIC_AFTERTOUCH && (pData->options & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0)
  640. continue;
  641. if (status == MIDI_STATUS_PITCH_WHEEL_CONTROL && (pData->options & PLUGIN_OPTION_SEND_PITCHBEND) == 0)
  642. continue;
  643. // Fix bad note-off
  644. if (status == MIDI_STATUS_NOTE_ON && midiData[2] == 0)
  645. status = MIDI_STATUS_NOTE_OFF;
  646. // put back channel in data
  647. uint8_t midiData2[midiEvent.size];
  648. midiData2[0] = uint8_t(status | (event.channel & MIDI_CHANNEL_BIT));
  649. std::memcpy(midiData2+1, midiData+1, static_cast<std::size_t>(midiEvent.size-1));
  650. addInputEvent(event.time, midiData2, midiEvent.size);
  651. if (status == MIDI_STATUS_NOTE_ON)
  652. {
  653. pData->postponeNoteOnRtEvent(true, event.channel, midiData[1], midiData[2]);
  654. }
  655. else if (status == MIDI_STATUS_NOTE_OFF)
  656. {
  657. pData->postponeNoteOffRtEvent(true, event.channel, midiData[1]);
  658. }
  659. } break;
  660. } // switch (event.type)
  661. }
  662. pData->postRtEvents.trySplice();
  663. } // End of Event Input and Processing
  664. // --------------------------------------------------------------------------------------------------------
  665. // Plugin processing
  666. const uint32_t numInputs = ysfx_get_num_inputs(fEffect.get());
  667. const uint32_t numOutputs = ysfx_get_num_outputs(fEffect.get());
  668. ysfx_process_float(fEffect.get(), audioIn, audioOut, numInputs, numOutputs, frames);
  669. // End of Plugin processing (no events)
  670. // --------------------------------------------------------------------------------------------------------
  671. // MIDI Output
  672. if (pData->event.portOut != nullptr)
  673. {
  674. ysfx_midi_event_t event;
  675. while (ysfx_receive_midi(fEffect.get(), &event))
  676. {
  677. CARLA_SAFE_ASSERT_BREAK(event.offset < frames);
  678. CARLA_SAFE_ASSERT_BREAK(event.size > 0);
  679. CARLA_SAFE_ASSERT_CONTINUE(event.size <= 0xff);
  680. if (! pData->event.portOut->writeMidiEvent(event.offset,
  681. static_cast<uint8_t>(event.size),
  682. event.data))
  683. break;
  684. }
  685. } // End of MIDI Output
  686. // --------------------------------------------------------------------------------------------------------
  687. // Control Output
  688. {
  689. uint64_t changes = ysfx_fetch_slider_changes(fEffect.get());
  690. uint64_t automations = ysfx_fetch_slider_automations(fEffect.get());
  691. if ((changes|automations) != 0)
  692. {
  693. for (uint32_t rindex = 0; rindex < ysfx_max_sliders; ++rindex)
  694. {
  695. uint64_t mask = (uint64_t)1 << rindex;
  696. //TODO: automations and changes are handled identically
  697. // refer to `sliderchange` vs `slider_automate`
  698. if (((changes|automations) & mask) != 0)
  699. {
  700. int32_t parameterIndex = fMapOfSliderToParameter[rindex];
  701. CARLA_SAFE_ASSERT_CONTINUE(parameterIndex != -1);
  702. float newValue = ysfx_slider_get_value(fEffect.get(), (uint32_t)parameterIndex);
  703. setParameterValueRT(parameterIndex, newValue, true);
  704. }
  705. }
  706. }
  707. //TODO: slider visibility changes, if this feature can be supported
  708. }
  709. }
  710. // -------------------------------------------------------------------
  711. bool initJSFX(const CarlaPluginPtr plugin,
  712. const char* const filename, const char* name, const char* const label, const uint options)
  713. {
  714. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr, false);
  715. // ---------------------------------------------------------------
  716. // first checks
  717. if (pData->client != nullptr)
  718. {
  719. pData->engine->setLastError("Plugin client is already registered");
  720. return false;
  721. }
  722. if ((filename == nullptr || filename[0] == '\0') &&
  723. (label == nullptr || label[0] == '\0'))
  724. {
  725. pData->engine->setLastError("null filename and label");
  726. return false;
  727. }
  728. // ---------------------------------------------------------------
  729. fUnit = CarlaJsfxUnit();
  730. {
  731. StringArray splitPaths;
  732. if (const char* paths = pData->engine->getOptions().pathJSFX)
  733. splitPaths = StringArray::fromTokens(CharPointer_UTF8(paths), CARLA_OS_SPLIT_STR, "");
  734. File file;
  735. if (filename && filename[0] != '\0')
  736. file = File(CharPointer_UTF8(filename));
  737. if (file.isNotNull() && file.existsAsFile())
  738. {
  739. // find which engine search path we're in, and use this as the root
  740. for (int i = 0; i < splitPaths.size() && !fUnit; ++i)
  741. {
  742. const File currentPath(splitPaths[i]);
  743. if (file.isAChildOf(currentPath))
  744. fUnit = CarlaJsfxUnit(currentPath, file);
  745. }
  746. // if not found in engine search paths, use parent directory as the root
  747. if (! fUnit)
  748. fUnit = CarlaJsfxUnit(file.getParentDirectory(), file);
  749. }
  750. else if (label && label[0] != '\0')
  751. {
  752. // search a matching file in plugin paths
  753. for (int i = 0; i < splitPaths.size() && !fUnit; ++i)
  754. {
  755. const File currentPath(splitPaths[i]);
  756. const File currentFile = currentPath.getChildFile(CharPointer_UTF8(label));
  757. const CarlaJsfxUnit currentUnit(currentPath, currentFile);
  758. if (currentUnit.getFilePath().existsAsFile())
  759. fUnit = currentUnit;
  760. }
  761. }
  762. }
  763. if (! fUnit)
  764. {
  765. pData->engine->setLastError("Cannot locate the JSFX plugin");
  766. return false;
  767. }
  768. // ---------------------------------------------------------------
  769. ysfx_config_u config(ysfx_config_new());
  770. CARLA_SAFE_ASSERT_RETURN(config != nullptr, false);
  771. const water::String rootPath = fUnit.getRootPath().getFullPathName();
  772. const water::String filePath = fUnit.getFilePath().getFullPathName();
  773. ysfx_register_builtin_audio_formats(config.get());
  774. ysfx_set_import_root(config.get(), rootPath.toRawUTF8());
  775. ysfx_guess_file_roots(config.get(), filePath.toRawUTF8());
  776. ysfx_set_log_reporter(config.get(), &CarlaJsfxLogging::logAll);
  777. ysfx_set_user_data(config.get(), (intptr_t)this);
  778. fEffect.reset(ysfx_new(config.get()));
  779. CARLA_SAFE_ASSERT_RETURN(fEffect != nullptr, false);
  780. // ---------------------------------------------------------------
  781. // get info
  782. {
  783. if (! ysfx_load_file(fEffect.get(), filePath.toRawUTF8(), 0))
  784. {
  785. pData->engine->setLastError("Failed to load JSFX");
  786. return false;
  787. }
  788. // TODO(jsfx) adapt when implementing these features
  789. const int compileFlags = 0
  790. //| ysfx_compile_no_serialize
  791. | ysfx_compile_no_gfx
  792. ;
  793. if (! ysfx_compile(fEffect.get(), compileFlags))
  794. {
  795. pData->engine->setLastError("Failed to compile JSFX");
  796. return false;
  797. }
  798. }
  799. if (name != nullptr && name[0] != '\0')
  800. {
  801. pData->name = pData->engine->getUniquePluginName(name);
  802. }
  803. else
  804. {
  805. pData->name = carla_strdup(ysfx_get_name(fEffect.get()));
  806. }
  807. pData->filename = carla_strdup(filePath.toRawUTF8());
  808. // ---------------------------------------------------------------
  809. // register client
  810. pData->client = pData->engine->addClient(plugin);
  811. if (pData->client == nullptr || ! pData->client->isOk())
  812. {
  813. pData->engine->setLastError("Failed to register plugin client");
  814. return false;
  815. }
  816. // ---------------------------------------------------------------
  817. // set options
  818. pData->options = 0x0;
  819. if (isPluginOptionEnabled(options, PLUGIN_OPTION_USE_CHUNKS))
  820. pData->options |= PLUGIN_OPTION_USE_CHUNKS;
  821. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_CONTROL_CHANGES))
  822. pData->options |= PLUGIN_OPTION_SEND_CONTROL_CHANGES;
  823. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_CHANNEL_PRESSURE))
  824. pData->options |= PLUGIN_OPTION_SEND_CHANNEL_PRESSURE;
  825. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_PITCHBEND))
  826. pData->options |= PLUGIN_OPTION_SEND_PITCHBEND;
  827. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_ALL_SOUND_OFF))
  828. pData->options |= PLUGIN_OPTION_SEND_ALL_SOUND_OFF;
  829. if (isPluginOptionEnabled(options, PLUGIN_OPTION_MAP_PROGRAM_CHANGES))
  830. pData->options |= PLUGIN_OPTION_MAP_PROGRAM_CHANGES;
  831. if (isPluginOptionInverseEnabled(options, PLUGIN_OPTION_SKIP_SENDING_NOTES))
  832. pData->options |= PLUGIN_OPTION_SKIP_SENDING_NOTES;
  833. if (isPluginOptionEnabled(options, PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH))
  834. pData->options |= PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH;
  835. return true;
  836. }
  837. private:
  838. ysfx_u fEffect = nullptr;
  839. CarlaJsfxUnit fUnit;
  840. water::String fChunkText;
  841. ysfx_time_info_t fTransportValues = {};
  842. std::vector<int32_t> fMapOfSliderToParameter;
  843. };
  844. // -------------------------------------------------------------------------------------------------------------------
  845. CarlaPluginPtr CarlaPlugin::newJSFX(const Initializer& init)
  846. {
  847. carla_debug("CarlaPlugin::newJSFX({%p, \"%s\", \"%s\", \"%s\", " P_INT64 "})",
  848. init.engine, init.filename, init.name, init.label, init.uniqueId);
  849. std::shared_ptr<CarlaPluginJSFX> plugin(new CarlaPluginJSFX(init.engine, init.id));
  850. if (! plugin->initJSFX(plugin, init.filename, init.name, init.label, init.options))
  851. return nullptr;
  852. return plugin;
  853. }
  854. // -------------------------------------------------------------------------------------------------------------------
  855. CARLA_BACKEND_END_NAMESPACE