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.

1134 lines
36KB

  1. /*
  2. * Carla Native Plugins
  3. * Copyright (C) 2013-2019 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License as
  7. * published by the Free Software Foundation; either version 2 of
  8. * the License, or any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16. */
  17. #define CARLA_NATIVE_PLUGIN_LV2
  18. #include "carla-base.cpp"
  19. #include "CarlaLv2Utils.hpp"
  20. #include "CarlaMathUtils.hpp"
  21. #include "CarlaPipeUtils.hpp"
  22. #include "CarlaString.hpp"
  23. #ifdef USING_JUCE
  24. # if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
  25. # pragma GCC diagnostic push
  26. # pragma GCC diagnostic ignored "-Wconversion"
  27. # pragma GCC diagnostic ignored "-Weffc++"
  28. # pragma GCC diagnostic ignored "-Wsign-conversion"
  29. # pragma GCC diagnostic ignored "-Wundef"
  30. # pragma GCC diagnostic ignored "-Wzero-as-null-pointer-constant"
  31. # endif
  32. # include "AppConfig.h"
  33. # include "juce_events/juce_events.h"
  34. # if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
  35. # pragma GCC diagnostic pop
  36. # endif
  37. #endif
  38. #include "water/files/File.h"
  39. template<>
  40. void Lv2PluginBaseClass<NativeTimeInfo>::clearTimeData() noexcept
  41. {
  42. fLastPositionData.clear();
  43. carla_zeroStruct(fTimeInfo);
  44. }
  45. // --------------------------------------------------------------------------------------------------------------------
  46. // Carla Internal Plugin API exposed as LV2 plugin
  47. class NativePlugin : public Lv2PluginBaseClass<NativeTimeInfo>
  48. {
  49. public:
  50. static const uint32_t kMaxMidiEvents = 512;
  51. NativePlugin(const NativePluginDescriptor* const desc,
  52. const double sampleRate,
  53. const char* const bundlePath,
  54. const LV2_Feature* const* const features)
  55. : Lv2PluginBaseClass<NativeTimeInfo>(sampleRate, features),
  56. fHandle(nullptr),
  57. fHost(),
  58. fDescriptor(desc),
  59. #ifdef CARLA_PROPER_CPP11_SUPPORT
  60. fProgramDesc({0, 0, nullptr}),
  61. #endif
  62. fMidiEventCount(0),
  63. #ifdef USING_JUCE
  64. fJuceInitialiser(),
  65. #endif
  66. fWorkerUISignal(0)
  67. {
  68. carla_zeroStruct(fHost);
  69. if (! loadedInProperHost())
  70. return;
  71. using water::File;
  72. using water::String;
  73. String resourceDir(water::File(bundlePath).getChildFile("resources").getFullPathName());
  74. fHost.handle = this;
  75. fHost.resourceDir = carla_strdup(resourceDir.toRawUTF8());
  76. fHost.uiName = nullptr;
  77. fHost.uiParentId = 0;
  78. fHost.get_buffer_size = host_get_buffer_size;
  79. fHost.get_sample_rate = host_get_sample_rate;
  80. fHost.is_offline = host_is_offline;
  81. fHost.get_time_info = host_get_time_info;
  82. fHost.write_midi_event = host_write_midi_event;
  83. fHost.ui_parameter_changed = host_ui_parameter_changed;
  84. fHost.ui_custom_data_changed = host_ui_custom_data_changed;
  85. fHost.ui_closed = host_ui_closed;
  86. fHost.ui_open_file = host_ui_open_file;
  87. fHost.ui_save_file = host_ui_save_file;
  88. fHost.dispatcher = host_dispatcher;
  89. }
  90. ~NativePlugin()
  91. {
  92. CARLA_SAFE_ASSERT(fHandle == nullptr);
  93. if (fHost.resourceDir != nullptr)
  94. {
  95. delete[] fHost.resourceDir;
  96. fHost.resourceDir = nullptr;
  97. }
  98. if (fHost.uiName != nullptr)
  99. {
  100. delete[] fHost.uiName;
  101. fHost.uiName = nullptr;
  102. }
  103. }
  104. // ----------------------------------------------------------------------------------------------------------------
  105. bool init()
  106. {
  107. if (fHost.resourceDir == nullptr)
  108. return false;
  109. if (fDescriptor->instantiate == nullptr || fDescriptor->process == nullptr)
  110. {
  111. carla_stderr("Plugin is missing something...");
  112. return false;
  113. }
  114. carla_zeroStructs(fMidiEvents, kMaxMidiEvents);
  115. fHandle = fDescriptor->instantiate(&fHost);
  116. CARLA_SAFE_ASSERT_RETURN(fHandle != nullptr, false);
  117. fPorts.hasUI = fDescriptor->hints & NATIVE_PLUGIN_HAS_UI;
  118. fPorts.usesTime = fDescriptor->hints & NATIVE_PLUGIN_USES_TIME;
  119. fPorts.numAudioIns = fDescriptor->audioIns;
  120. fPorts.numAudioOuts = fDescriptor->audioOuts;
  121. fPorts.numMidiIns = fDescriptor->midiIns;
  122. fPorts.numMidiOuts = fDescriptor->midiOuts;
  123. if (fDescriptor->get_parameter_count != nullptr &&
  124. fDescriptor->get_parameter_info != nullptr &&
  125. fDescriptor->get_parameter_value != nullptr &&
  126. fDescriptor->set_parameter_value != nullptr)
  127. {
  128. fPorts.numParams = fDescriptor->get_parameter_count(fHandle);
  129. }
  130. fPorts.init();
  131. if (fPorts.numParams > 0)
  132. {
  133. for (uint32_t i=0; i < fPorts.numParams; ++i)
  134. {
  135. fPorts.paramsLast[i] = fDescriptor->get_parameter_value(fHandle, i);
  136. fPorts.paramsOut [i] = fDescriptor->get_parameter_info(fHandle, i)->hints & NATIVE_PARAMETER_IS_OUTPUT;
  137. }
  138. }
  139. return true;
  140. }
  141. // ----------------------------------------------------------------------------------------------------------------
  142. // LV2 functions
  143. void lv2_activate()
  144. {
  145. CARLA_SAFE_ASSERT_RETURN(! fIsActive,);
  146. resetTimeInfo();
  147. if (fDescriptor->activate != nullptr)
  148. fDescriptor->activate(fHandle);
  149. fIsActive = true;
  150. }
  151. void lv2_deactivate()
  152. {
  153. CARLA_SAFE_ASSERT_RETURN(fIsActive,);
  154. fIsActive = false;
  155. if (fDescriptor->deactivate != nullptr)
  156. fDescriptor->deactivate(fHandle);
  157. }
  158. void lv2_cleanup()
  159. {
  160. if (fIsActive)
  161. {
  162. carla_stderr("Warning: Host forgot to call deactivate!");
  163. fIsActive = false;
  164. if (fDescriptor->deactivate != nullptr)
  165. fDescriptor->deactivate(fHandle);
  166. }
  167. if (fDescriptor->cleanup != nullptr)
  168. fDescriptor->cleanup(fHandle);
  169. fHandle = nullptr;
  170. }
  171. // ----------------------------------------------------------------------------------------------------------------
  172. void lv2_run(const uint32_t frames)
  173. {
  174. if (! lv2_pre_run(frames))
  175. {
  176. updateParameterOutputs();
  177. return;
  178. }
  179. if (fPorts.numMidiIns > 0 || fPorts.hasUI)
  180. {
  181. uint32_t numEventsIn;
  182. if (fPorts.numMidiIns > 0)
  183. {
  184. numEventsIn = fPorts.numMidiIns;
  185. fMidiEventCount = 0;
  186. carla_zeroStructs(fMidiEvents, kMaxMidiEvents);
  187. }
  188. else
  189. {
  190. numEventsIn = 1;
  191. }
  192. for (uint32_t i=0; i < numEventsIn; ++i)
  193. {
  194. const LV2_Atom_Sequence* const eventsIn(fPorts.eventsIn[i]);
  195. CARLA_SAFE_ASSERT_CONTINUE(eventsIn != nullptr);
  196. LV2_ATOM_SEQUENCE_FOREACH(eventsIn, event)
  197. {
  198. if (event == nullptr)
  199. continue;
  200. if (event->body.type == fURIs.uiEvents && fWorkerUISignal != -1)
  201. {
  202. if (fWorker != nullptr)
  203. {
  204. // worker is supported by the host, we can continue
  205. fWorkerUISignal = 1;
  206. const char* const msg((const char*)(event + 1));
  207. const size_t msgSize = std::strlen(msg);
  208. fWorker->schedule_work(fWorker->handle, static_cast<uint32_t>(msgSize + 1U), msg);
  209. }
  210. else
  211. {
  212. // worker is not supported, cancel
  213. fWorkerUISignal = -1;
  214. }
  215. continue;
  216. }
  217. if (event->body.type != fURIs.midiEvent)
  218. continue;
  219. if (event->body.size > 4)
  220. continue;
  221. if (event->time.frames >= frames)
  222. break;
  223. const uint8_t* const data((const uint8_t*)(event + 1));
  224. NativeMidiEvent& nativeEvent(fMidiEvents[fMidiEventCount++]);
  225. nativeEvent.port = (uint8_t)i;
  226. nativeEvent.size = (uint8_t)event->body.size;
  227. nativeEvent.time = (uint32_t)event->time.frames;
  228. uint32_t j=0;
  229. for (uint32_t size=event->body.size; j<size; ++j)
  230. nativeEvent.data[j] = data[j];
  231. for (; j<4; ++j)
  232. nativeEvent.data[j] = 0;
  233. if (fMidiEventCount >= kMaxMidiEvents)
  234. break;
  235. }
  236. }
  237. }
  238. fDescriptor->process(fHandle, fPorts.audioIns, fPorts.audioOuts, frames, fMidiEvents, fMidiEventCount);
  239. if (fWorkerUISignal == -1 && fPorts.hasUI)
  240. {
  241. const char* const msg = "quit";
  242. const size_t msgSize = 5;
  243. LV2_Atom_Sequence* const seq(fPorts.eventsOut[0]);
  244. Ports::EventsOutData& mData(fPorts.eventsOutData[0]);
  245. if (sizeof(LV2_Atom_Event) + msgSize <= mData.capacity - mData.offset)
  246. {
  247. LV2_Atom_Event* const aev = (LV2_Atom_Event*)(LV2_ATOM_CONTENTS(LV2_Atom_Sequence, seq) + mData.offset);
  248. aev->time.frames = 0;
  249. aev->body.size = msgSize;
  250. aev->body.type = fURIs.uiEvents;
  251. std::memcpy(LV2_ATOM_BODY(&aev->body), msg, msgSize);
  252. const uint32_t size = lv2_atom_pad_size(static_cast<uint32_t>(sizeof(LV2_Atom_Event) + msgSize));
  253. mData.offset += size;
  254. seq->atom.size += size;
  255. fWorkerUISignal = 0;
  256. }
  257. }
  258. lv2_post_run(frames);
  259. updateParameterOutputs();
  260. }
  261. // ----------------------------------------------------------------------------------------------------------------
  262. const LV2_Program_Descriptor* lv2_get_program(const uint32_t index)
  263. {
  264. if (fDescriptor->category == NATIVE_PLUGIN_CATEGORY_SYNTH)
  265. return nullptr;
  266. if (fDescriptor->get_midi_program_count == nullptr)
  267. return nullptr;
  268. if (fDescriptor->get_midi_program_info == nullptr)
  269. return nullptr;
  270. if (index >= fDescriptor->get_midi_program_count(fHandle))
  271. return nullptr;
  272. const NativeMidiProgram* const midiProg(fDescriptor->get_midi_program_info(fHandle, index));
  273. if (midiProg == nullptr)
  274. return nullptr;
  275. fProgramDesc.bank = midiProg->bank;
  276. fProgramDesc.program = midiProg->program;
  277. fProgramDesc.name = midiProg->name;
  278. return &fProgramDesc;
  279. }
  280. void lv2_select_program(uint32_t bank, uint32_t program)
  281. {
  282. if (fDescriptor->category == NATIVE_PLUGIN_CATEGORY_SYNTH)
  283. return;
  284. if (fDescriptor->set_midi_program == nullptr)
  285. return;
  286. fDescriptor->set_midi_program(fHandle, 0, bank, program);
  287. for (uint32_t i=0; i < fPorts.numParams; ++i)
  288. {
  289. fPorts.paramsLast[i] = fDescriptor->get_parameter_value(fHandle, i);
  290. if (fPorts.paramsPtr[i] != nullptr)
  291. *fPorts.paramsPtr[i] = fPorts.paramsLast[i];
  292. }
  293. }
  294. // ----------------------------------------------------------------------------------------------------------------
  295. LV2_State_Status lv2_save(const LV2_State_Store_Function store, const LV2_State_Handle handle,
  296. const uint32_t /*flags*/, const LV2_Feature* const* const /*features*/) const
  297. {
  298. if ((fDescriptor->hints & NATIVE_PLUGIN_USES_STATE) == 0 || fDescriptor->get_state == nullptr)
  299. return LV2_STATE_ERR_NO_FEATURE;
  300. if (char* const state = fDescriptor->get_state(fHandle))
  301. {
  302. store(handle, fUridMap->map(fUridMap->handle, "http://kxstudio.sf.net/ns/carla/chunk"), state, std::strlen(state)+1, fURIs.atomString, LV2_STATE_IS_POD|LV2_STATE_IS_PORTABLE);
  303. std::free(state);
  304. return LV2_STATE_SUCCESS;
  305. }
  306. return LV2_STATE_ERR_UNKNOWN;
  307. }
  308. LV2_State_Status lv2_restore(const LV2_State_Retrieve_Function retrieve, const LV2_State_Handle handle,
  309. uint32_t flags, const LV2_Feature* const* const /*features*/) const
  310. {
  311. if ((fDescriptor->hints & NATIVE_PLUGIN_USES_STATE) == 0 || fDescriptor->set_state == nullptr)
  312. return LV2_STATE_ERR_NO_FEATURE;
  313. size_t size = 0;
  314. uint32_t type = 0;
  315. const void* const data = retrieve(handle, fUridMap->map(fUridMap->handle, "http://kxstudio.sf.net/ns/carla/chunk"), &size, &type, &flags);
  316. if (size == 0)
  317. return LV2_STATE_ERR_UNKNOWN;
  318. if (type == 0)
  319. return LV2_STATE_ERR_UNKNOWN;
  320. if (data == nullptr)
  321. return LV2_STATE_ERR_UNKNOWN;
  322. if (type != fURIs.atomString)
  323. return LV2_STATE_ERR_BAD_TYPE;
  324. fDescriptor->set_state(fHandle, (const char*)data);
  325. return LV2_STATE_SUCCESS;
  326. }
  327. // ----------------------------------------------------------------------------------------------------------------
  328. LV2_Worker_Status lv2_work(LV2_Worker_Respond_Function, LV2_Worker_Respond_Handle, uint32_t, const void* data)
  329. {
  330. const char* const msg = (const char*)data;
  331. /**/ if (std::strncmp(msg, "control ", 8) == 0)
  332. {
  333. if (fDescriptor->ui_set_parameter_value == nullptr)
  334. return LV2_WORKER_SUCCESS;
  335. if (const char* const msgSplit = std::strstr(msg+8, " "))
  336. {
  337. const char* const msgIndex = msg+8;
  338. CARLA_SAFE_ASSERT_RETURN(msgSplit - msgIndex < 8, LV2_WORKER_ERR_UNKNOWN);
  339. CARLA_SAFE_ASSERT_RETURN(msgSplit[0] != '\0', LV2_WORKER_ERR_UNKNOWN);
  340. char strBufIndex[8];
  341. carla_zeroChars(strBufIndex, 8);
  342. std::strncpy(strBufIndex, msgIndex, static_cast<size_t>(msgSplit - msgIndex));
  343. const int index = std::atoi(msgIndex) - static_cast<int>(fPorts.indexOffset);
  344. CARLA_SAFE_ASSERT_RETURN(index >= 0, LV2_WORKER_ERR_UNKNOWN);
  345. float value;
  346. {
  347. const CarlaScopedLocale csl;
  348. value = static_cast<float>(std::atof(msgSplit+1));
  349. }
  350. fDescriptor->ui_set_parameter_value(fHandle, static_cast<uint32_t>(index), value);
  351. }
  352. }
  353. else if (std::strcmp(msg, "show") == 0)
  354. {
  355. handleUiShow();
  356. }
  357. else if (std::strcmp(msg, "hide") == 0)
  358. {
  359. handleUiHide();
  360. }
  361. else if (std::strcmp(msg, "idle") == 0)
  362. {
  363. handleUiRun();
  364. }
  365. else if (std::strcmp(msg, "quit") == 0)
  366. {
  367. handleUiClosed();
  368. }
  369. else
  370. {
  371. carla_stdout("lv2_work unknown msg '%s'", msg);
  372. return LV2_WORKER_ERR_UNKNOWN;
  373. }
  374. return LV2_WORKER_SUCCESS;
  375. }
  376. LV2_Worker_Status lv2_work_resp(uint32_t /*size*/, const void* /*body*/)
  377. {
  378. return LV2_WORKER_SUCCESS;
  379. }
  380. // ----------------------------------------------------------------------------------------------------------------
  381. void lv2ui_instantiate(LV2UI_Write_Function writeFunction, LV2UI_Controller controller,
  382. LV2UI_Widget* widget, const LV2_Feature* const* features)
  383. {
  384. fUI.writeFunction = writeFunction;
  385. fUI.controller = controller;
  386. if (fHost.uiName != nullptr)
  387. {
  388. delete[] fHost.uiName;
  389. fHost.uiName = nullptr;
  390. }
  391. // ---------------------------------------------------------------
  392. // see if the host supports external-ui
  393. for (int i=0; features[i] != nullptr; ++i)
  394. {
  395. if (std::strcmp(features[i]->URI, LV2_EXTERNAL_UI__Host) == 0 ||
  396. std::strcmp(features[i]->URI, LV2_EXTERNAL_UI_DEPRECATED_URI) == 0)
  397. {
  398. fUI.host = (const LV2_External_UI_Host*)features[i]->data;
  399. break;
  400. }
  401. }
  402. if (fUI.host != nullptr)
  403. {
  404. fHost.uiName = carla_strdup(fUI.host->plugin_human_id);
  405. *widget = (LV2_External_UI_Widget_Compat*)this;
  406. return;
  407. }
  408. // ---------------------------------------------------------------
  409. // no external-ui support, use showInterface
  410. for (int i=0; features[i] != nullptr; ++i)
  411. {
  412. if (std::strcmp(features[i]->URI, LV2_OPTIONS__options) != 0)
  413. continue;
  414. const LV2_Options_Option* const options((const LV2_Options_Option*)features[i]->data);
  415. CARLA_SAFE_ASSERT_BREAK(options != nullptr);
  416. for (int j=0; options[j].key != 0; ++j)
  417. {
  418. if (options[j].key != fUridMap->map(fUridMap->handle, LV2_UI__windowTitle))
  419. continue;
  420. const char* const title((const char*)options[j].value);
  421. CARLA_SAFE_ASSERT_BREAK(title != nullptr && title[0] != '\0');
  422. fHost.uiName = carla_strdup(title);
  423. break;
  424. }
  425. break;
  426. }
  427. if (fHost.uiName == nullptr)
  428. fHost.uiName = carla_strdup(fDescriptor->name);
  429. *widget = nullptr;
  430. return;
  431. }
  432. void lv2ui_port_event(uint32_t portIndex, uint32_t bufferSize, uint32_t format, const void* buffer) const
  433. {
  434. if (format != 0 || bufferSize != sizeof(float) || buffer == nullptr)
  435. return;
  436. if (portIndex < fPorts.indexOffset || ! fUI.isVisible)
  437. return;
  438. if (fDescriptor->ui_set_parameter_value == nullptr)
  439. return;
  440. const float value(*(const float*)buffer);
  441. fDescriptor->ui_set_parameter_value(fHandle, portIndex-fPorts.indexOffset, value);
  442. }
  443. // ----------------------------------------------------------------------------------------------------------------
  444. void lv2ui_select_program(uint32_t bank, uint32_t program) const
  445. {
  446. if (fDescriptor->category == NATIVE_PLUGIN_CATEGORY_SYNTH)
  447. return;
  448. if (fDescriptor->ui_set_midi_program == nullptr)
  449. return;
  450. fDescriptor->ui_set_midi_program(fHandle, 0, bank, program);
  451. }
  452. // ----------------------------------------------------------------------------------------------------------------
  453. protected:
  454. void handleUiRun() const override
  455. {
  456. if (fDescriptor->ui_idle != nullptr)
  457. fDescriptor->ui_idle(fHandle);
  458. }
  459. void handleUiShow() override
  460. {
  461. if (fDescriptor->ui_show != nullptr)
  462. fDescriptor->ui_show(fHandle, true);
  463. fUI.isVisible = true;
  464. }
  465. void handleUiHide() override
  466. {
  467. if (fDescriptor->ui_show != nullptr)
  468. fDescriptor->ui_show(fHandle, false);
  469. fUI.isVisible = false;
  470. }
  471. // ----------------------------------------------------------------------------------------------------------------
  472. void handleParameterValueChanged(const uint32_t index, const float value) override
  473. {
  474. fDescriptor->set_parameter_value(fHandle, index, value);
  475. }
  476. void handleBufferSizeChanged(const uint32_t bufferSize) override
  477. {
  478. if (fDescriptor->dispatcher == nullptr)
  479. return;
  480. fDescriptor->dispatcher(fHandle, NATIVE_PLUGIN_OPCODE_BUFFER_SIZE_CHANGED, 0, bufferSize, nullptr, 0.0f);
  481. }
  482. void handleSampleRateChanged(const double sampleRate) override
  483. {
  484. if (fDescriptor->dispatcher == nullptr)
  485. return;
  486. fDescriptor->dispatcher(fHandle, NATIVE_PLUGIN_OPCODE_SAMPLE_RATE_CHANGED, 0, 0, nullptr, (float)sampleRate);
  487. }
  488. // ----------------------------------------------------------------------------------------------------------------
  489. bool handleWriteMidiEvent(const NativeMidiEvent* const event)
  490. {
  491. CARLA_SAFE_ASSERT_RETURN(fPorts.numMidiOuts > 0, false);
  492. CARLA_SAFE_ASSERT_RETURN(event != nullptr, false);
  493. CARLA_SAFE_ASSERT_RETURN(event->size > 0, false);
  494. const uint8_t port(event->port);
  495. CARLA_SAFE_ASSERT_RETURN(port < fPorts.numMidiOuts, false);
  496. LV2_Atom_Sequence* const seq(fPorts.eventsOut[port]);
  497. CARLA_SAFE_ASSERT_RETURN(seq != nullptr, false);
  498. Ports::EventsOutData& mData(fPorts.eventsOutData[port]);
  499. if (sizeof(LV2_Atom_Event) + event->size > mData.capacity - mData.offset)
  500. return false;
  501. LV2_Atom_Event* const aev = (LV2_Atom_Event*)(LV2_ATOM_CONTENTS(LV2_Atom_Sequence, seq) + mData.offset);
  502. aev->time.frames = event->time;
  503. aev->body.size = event->size;
  504. aev->body.type = fURIs.midiEvent;
  505. std::memcpy(LV2_ATOM_BODY(&aev->body), event->data, event->size);
  506. const uint32_t size = lv2_atom_pad_size(static_cast<uint32_t>(sizeof(LV2_Atom_Event) + event->size));
  507. mData.offset += size;
  508. seq->atom.size += size;
  509. return true;
  510. }
  511. void handleUiParameterChanged(const uint32_t index, const float value) const
  512. {
  513. if (fWorkerUISignal)
  514. return;
  515. if (fUI.writeFunction != nullptr && fUI.controller != nullptr)
  516. fUI.writeFunction(fUI.controller, index+fPorts.indexOffset, sizeof(float), 0, &value);
  517. }
  518. void handleUiCustomDataChanged(const char* const key, const char* const value) const
  519. {
  520. carla_stdout("TODO: handleUiCustomDataChanged %s %s", key, value);
  521. //storeCustomData(key, value);
  522. if (fUI.writeFunction == nullptr || fUI.controller == nullptr)
  523. return;
  524. }
  525. void handleUiClosed()
  526. {
  527. fUI.isVisible = false;
  528. if (fWorkerUISignal)
  529. fWorkerUISignal = -1;
  530. if (fUI.host != nullptr && fUI.host->ui_closed != nullptr && fUI.controller != nullptr)
  531. fUI.host->ui_closed(fUI.controller);
  532. fUI.host = nullptr;
  533. fUI.writeFunction = nullptr;
  534. fUI.controller = nullptr;
  535. }
  536. const char* handleUiOpenFile(const bool /*isDir*/, const char* const /*title*/, const char* const /*filter*/) const
  537. {
  538. // TODO
  539. return nullptr;
  540. }
  541. const char* handleUiSaveFile(const bool /*isDir*/, const char* const /*title*/, const char* const /*filter*/) const
  542. {
  543. // TODO
  544. return nullptr;
  545. }
  546. intptr_t handleDispatcher(const NativeHostDispatcherOpcode opcode, const int32_t index, const intptr_t value, void* const ptr, const float opt)
  547. {
  548. carla_debug("NativePlugin::handleDispatcher(%i, %i, " P_INTPTR ", %p, %f)", opcode, index, value, ptr, opt);
  549. intptr_t ret = 0;
  550. switch (opcode)
  551. {
  552. case NATIVE_HOST_OPCODE_NULL:
  553. case NATIVE_HOST_OPCODE_UPDATE_PARAMETER:
  554. case NATIVE_HOST_OPCODE_UPDATE_MIDI_PROGRAM:
  555. case NATIVE_HOST_OPCODE_RELOAD_PARAMETERS:
  556. case NATIVE_HOST_OPCODE_RELOAD_MIDI_PROGRAMS:
  557. case NATIVE_HOST_OPCODE_RELOAD_ALL:
  558. case NATIVE_HOST_OPCODE_HOST_IDLE:
  559. case NATIVE_HOST_OPCODE_INTERNAL_PLUGIN:
  560. // nothing
  561. break;
  562. case NATIVE_HOST_OPCODE_UI_UNAVAILABLE:
  563. handleUiClosed();
  564. break;
  565. }
  566. return ret;
  567. // unused for now
  568. (void)index;
  569. (void)value;
  570. (void)ptr;
  571. (void)opt;
  572. }
  573. void updateParameterOutputs()
  574. {
  575. float value;
  576. for (uint32_t i=0; i < fPorts.numParams; ++i)
  577. {
  578. if (! fPorts.paramsOut[i])
  579. continue;
  580. fPorts.paramsLast[i] = value = fDescriptor->get_parameter_value(fHandle, i);
  581. if (fPorts.paramsPtr[i] != nullptr)
  582. *fPorts.paramsPtr[i] = value;
  583. }
  584. }
  585. // -------------------------------------------------------------------
  586. private:
  587. // Native data
  588. NativePluginHandle fHandle;
  589. NativeHostDescriptor fHost;
  590. const NativePluginDescriptor* const fDescriptor;
  591. LV2_Program_Descriptor fProgramDesc;
  592. uint32_t fMidiEventCount;
  593. NativeMidiEvent fMidiEvents[kMaxMidiEvents];
  594. #ifdef USING_JUCE
  595. juce::SharedResourcePointer<juce::ScopedJuceInitialiser_GUI> fJuceInitialiser;
  596. #endif
  597. int fWorkerUISignal;
  598. // -------------------------------------------------------------------
  599. #define handlePtr ((NativePlugin*)handle)
  600. static uint32_t host_get_buffer_size(NativeHostHandle handle)
  601. {
  602. return handlePtr->fBufferSize;
  603. }
  604. static double host_get_sample_rate(NativeHostHandle handle)
  605. {
  606. return handlePtr->fSampleRate;
  607. }
  608. static bool host_is_offline(NativeHostHandle handle)
  609. {
  610. return handlePtr->fIsOffline;
  611. }
  612. static const NativeTimeInfo* host_get_time_info(NativeHostHandle handle)
  613. {
  614. return &(handlePtr->fTimeInfo);
  615. }
  616. static bool host_write_midi_event(NativeHostHandle handle, const NativeMidiEvent* event)
  617. {
  618. return handlePtr->handleWriteMidiEvent(event);
  619. }
  620. static void host_ui_parameter_changed(NativeHostHandle handle, uint32_t index, float value)
  621. {
  622. handlePtr->handleUiParameterChanged(index, value);
  623. }
  624. static void host_ui_custom_data_changed(NativeHostHandle handle, const char* key, const char* value)
  625. {
  626. handlePtr->handleUiCustomDataChanged(key, value);
  627. }
  628. static void host_ui_closed(NativeHostHandle handle)
  629. {
  630. handlePtr->handleUiClosed();
  631. }
  632. static const char* host_ui_open_file(NativeHostHandle handle, bool isDir, const char* title, const char* filter)
  633. {
  634. return handlePtr->handleUiOpenFile(isDir, title, filter);
  635. }
  636. static const char* host_ui_save_file(NativeHostHandle handle, bool isDir, const char* title, const char* filter)
  637. {
  638. return handlePtr->handleUiSaveFile(isDir, title, filter);
  639. }
  640. static intptr_t host_dispatcher(NativeHostHandle handle, NativeHostDispatcherOpcode opcode, int32_t index, intptr_t value, void* ptr, float opt)
  641. {
  642. return handlePtr->handleDispatcher(opcode, index, value, ptr, opt);
  643. }
  644. #undef handlePtr
  645. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(NativePlugin)
  646. };
  647. // -----------------------------------------------------------------------
  648. // LV2 plugin descriptor functions
  649. static LV2_Handle lv2_instantiate(const LV2_Descriptor* lv2Descriptor, double sampleRate, const char* bundlePath, const LV2_Feature* const* features)
  650. {
  651. carla_debug("lv2_instantiate(%p, %g, %s, %p)", lv2Descriptor, sampleRate, bundlePath, features);
  652. const NativePluginDescriptor* pluginDesc = nullptr;
  653. const char* pluginLabel = nullptr;
  654. if (std::strncmp(lv2Descriptor->URI, "http://kxstudio.sf.net/carla/plugins/", 37) == 0)
  655. pluginLabel = lv2Descriptor->URI+37;
  656. if (pluginLabel == nullptr)
  657. {
  658. carla_stderr("Failed to find carla native plugin with URI \"%s\"", lv2Descriptor->URI);
  659. return nullptr;
  660. }
  661. carla_debug("lv2_instantiate() - looking up label \"%s\"", pluginLabel);
  662. PluginListManager& plm(PluginListManager::getInstance());
  663. for (LinkedList<const NativePluginDescriptor*>::Itenerator it = plm.descs.begin2(); it.valid(); it.next())
  664. {
  665. const NativePluginDescriptor* const& tmpDesc(it.getValue(nullptr));
  666. CARLA_SAFE_ASSERT_CONTINUE(tmpDesc != nullptr);
  667. if (std::strcmp(tmpDesc->label, pluginLabel) == 0)
  668. {
  669. pluginDesc = tmpDesc;
  670. break;
  671. }
  672. }
  673. if (pluginDesc == nullptr)
  674. {
  675. carla_stderr("Failed to find carla native plugin with label \"%s\"", pluginLabel);
  676. return nullptr;
  677. }
  678. NativePlugin* const plugin(new NativePlugin(pluginDesc, sampleRate, bundlePath, features));
  679. if (! plugin->init())
  680. {
  681. carla_stderr("Failed to init plugin");
  682. delete plugin;
  683. return nullptr;
  684. }
  685. return (LV2_Handle)plugin;
  686. }
  687. #define instancePtr ((NativePlugin*)instance)
  688. static void lv2_connect_port(LV2_Handle instance, uint32_t port, void* dataLocation)
  689. {
  690. instancePtr->lv2_connect_port(port, dataLocation);
  691. }
  692. static void lv2_activate(LV2_Handle instance)
  693. {
  694. carla_debug("lv2_activate(%p)", instance);
  695. instancePtr->lv2_activate();
  696. }
  697. static void lv2_run(LV2_Handle instance, uint32_t sampleCount)
  698. {
  699. instancePtr->lv2_run(sampleCount);
  700. }
  701. static void lv2_deactivate(LV2_Handle instance)
  702. {
  703. carla_debug("lv2_deactivate(%p)", instance);
  704. instancePtr->lv2_deactivate();
  705. }
  706. static void lv2_cleanup(LV2_Handle instance)
  707. {
  708. carla_debug("lv2_cleanup(%p)", instance);
  709. instancePtr->lv2_cleanup();
  710. delete instancePtr;
  711. }
  712. static uint32_t lv2_get_options(LV2_Handle instance, LV2_Options_Option* options)
  713. {
  714. carla_debug("lv2_get_options(%p, %p)", instance, options);
  715. return instancePtr->lv2_get_options(options);
  716. }
  717. static uint32_t lv2_set_options(LV2_Handle instance, const LV2_Options_Option* options)
  718. {
  719. carla_debug("lv2_set_options(%p, %p)", instance, options);
  720. return instancePtr->lv2_set_options(options);
  721. }
  722. static const LV2_Program_Descriptor* lv2_get_program(LV2_Handle instance, uint32_t index)
  723. {
  724. carla_debug("lv2_get_program(%p, %i)", instance, index);
  725. return instancePtr->lv2_get_program(index);
  726. }
  727. static void lv2_select_program(LV2_Handle instance, uint32_t bank, uint32_t program)
  728. {
  729. carla_debug("lv2_select_program(%p, %i, %i)", instance, bank, program);
  730. return instancePtr->lv2_select_program(bank, program);
  731. }
  732. static LV2_State_Status lv2_save(LV2_Handle instance, LV2_State_Store_Function store, LV2_State_Handle handle, uint32_t flags, const LV2_Feature* const* features)
  733. {
  734. carla_debug("lv2_save(%p, %p, %p, %i, %p)", instance, store, handle, flags, features);
  735. return instancePtr->lv2_save(store, handle, flags, features);
  736. }
  737. static LV2_State_Status lv2_restore(LV2_Handle instance, LV2_State_Retrieve_Function retrieve, LV2_State_Handle handle, uint32_t flags, const LV2_Feature* const* features)
  738. {
  739. carla_debug("lv2_restore(%p, %p, %p, %i, %p)", instance, retrieve, handle, flags, features);
  740. return instancePtr->lv2_restore(retrieve, handle, flags, features);
  741. }
  742. static LV2_Worker_Status lv2_work(LV2_Handle instance, LV2_Worker_Respond_Function respond, LV2_Worker_Respond_Handle handle, uint32_t size, const void* data)
  743. {
  744. carla_debug("work(%p, %p, %p, %u, %p)", instance, respond, handle, size, data);
  745. return instancePtr->lv2_work(respond, handle, size, data);
  746. }
  747. static LV2_Worker_Status lv2_work_resp(LV2_Handle instance, uint32_t size, const void* body)
  748. {
  749. carla_debug("work_resp(%p, %u, %p)", instance, size, body);
  750. return instancePtr->lv2_work_resp(size, body);
  751. }
  752. static const void* lv2_extension_data(const char* uri)
  753. {
  754. carla_debug("lv2_extension_data(\"%s\")", uri);
  755. static const LV2_Options_Interface options = { lv2_get_options, lv2_set_options };
  756. static const LV2_Programs_Interface programs = { lv2_get_program, lv2_select_program };
  757. static const LV2_State_Interface state = { lv2_save, lv2_restore };
  758. static const LV2_Worker_Interface worker = { lv2_work, lv2_work_resp, nullptr };
  759. if (std::strcmp(uri, LV2_OPTIONS__interface) == 0)
  760. return &options;
  761. if (std::strcmp(uri, LV2_PROGRAMS__Interface) == 0)
  762. return &programs;
  763. if (std::strcmp(uri, LV2_STATE__interface) == 0)
  764. return &state;
  765. if (std::strcmp(uri, LV2_WORKER__interface) == 0)
  766. return &worker;
  767. return nullptr;
  768. }
  769. #undef instancePtr
  770. #ifdef HAVE_PYQT
  771. // -----------------------------------------------------------------------
  772. // LV2 UI descriptor functions
  773. static LV2UI_Handle lv2ui_instantiate(const LV2UI_Descriptor*, const char*, const char*,
  774. LV2UI_Write_Function writeFunction, LV2UI_Controller controller,
  775. LV2UI_Widget* widget, const LV2_Feature* const* features)
  776. {
  777. carla_debug("lv2ui_instantiate(..., %p, %p, %p)", writeFunction, controller, widget, features);
  778. NativePlugin* plugin = nullptr;
  779. for (int i=0; features[i] != nullptr; ++i)
  780. {
  781. if (std::strcmp(features[i]->URI, LV2_INSTANCE_ACCESS_URI) == 0)
  782. {
  783. plugin = (NativePlugin*)features[i]->data;
  784. break;
  785. }
  786. }
  787. if (plugin == nullptr)
  788. {
  789. carla_stderr("Host doesn't support instance-access, cannot show UI");
  790. return nullptr;
  791. }
  792. plugin->lv2ui_instantiate(writeFunction, controller, widget, features);
  793. return (LV2UI_Handle)plugin;
  794. }
  795. #define uiPtr ((NativePlugin*)ui)
  796. static void lv2ui_port_event(LV2UI_Handle ui, uint32_t portIndex, uint32_t bufferSize, uint32_t format, const void* buffer)
  797. {
  798. carla_debug("lv2ui_port_eventxx(%p, %i, %i, %i, %p)", ui, portIndex, bufferSize, format, buffer);
  799. uiPtr->lv2ui_port_event(portIndex, bufferSize, format, buffer);
  800. }
  801. static void lv2ui_cleanup(LV2UI_Handle ui)
  802. {
  803. carla_debug("lv2ui_cleanup(%p)", ui);
  804. uiPtr->lv2ui_cleanup();
  805. }
  806. static void lv2ui_select_program(LV2UI_Handle ui, uint32_t bank, uint32_t program)
  807. {
  808. carla_debug("lv2ui_select_program(%p, %i, %i)", ui, bank, program);
  809. uiPtr->lv2ui_select_program(bank, program);
  810. }
  811. static int lv2ui_idle(LV2UI_Handle ui)
  812. {
  813. return uiPtr->lv2ui_idle();
  814. }
  815. static int lv2ui_show(LV2UI_Handle ui)
  816. {
  817. carla_debug("lv2ui_show(%p)", ui);
  818. return uiPtr->lv2ui_show();
  819. }
  820. static int lv2ui_hide(LV2UI_Handle ui)
  821. {
  822. carla_debug("lv2ui_hide(%p)", ui);
  823. return uiPtr->lv2ui_hide();
  824. }
  825. static const void* lv2ui_extension_data(const char* uri)
  826. {
  827. carla_stdout("lv2ui_extension_data(\"%s\")", uri);
  828. static const LV2UI_Idle_Interface uiidle = { lv2ui_idle };
  829. static const LV2UI_Show_Interface uishow = { lv2ui_show, lv2ui_hide };
  830. static const LV2_Programs_UI_Interface uiprograms = { lv2ui_select_program };
  831. if (std::strcmp(uri, LV2_UI__idleInterface) == 0)
  832. return &uiidle;
  833. if (std::strcmp(uri, LV2_UI__showInterface) == 0)
  834. return &uishow;
  835. if (std::strcmp(uri, LV2_PROGRAMS__UIInterface) == 0)
  836. return &uiprograms;
  837. return nullptr;
  838. }
  839. #endif
  840. #undef uiPtr
  841. // -----------------------------------------------------------------------
  842. // Startup code
  843. CARLA_EXPORT
  844. const LV2_Descriptor* lv2_descriptor(uint32_t index)
  845. {
  846. carla_debug("lv2_descriptor(%i)", index);
  847. PluginListManager& plm(PluginListManager::getInstance());
  848. if (index >= plm.descs.count())
  849. {
  850. carla_debug("lv2_descriptor(%i) - out of bounds", index);
  851. return nullptr;
  852. }
  853. if (index < plm.lv2Descs.count())
  854. {
  855. carla_debug("lv2_descriptor(%i) - found previously allocated", index);
  856. return plm.lv2Descs.getAt(index, nullptr);
  857. }
  858. const NativePluginDescriptor* const pluginDesc(plm.descs.getAt(index, nullptr));
  859. CARLA_SAFE_ASSERT_RETURN(pluginDesc != nullptr, nullptr);
  860. CarlaString tmpURI;
  861. tmpURI = "http://kxstudio.sf.net/carla/plugins/";
  862. tmpURI += pluginDesc->label;
  863. carla_debug("lv2_descriptor(%i) - not found, allocating new with uri \"%s\"", index, (const char*)tmpURI);
  864. const LV2_Descriptor lv2DescTmp = {
  865. /* URI */ carla_strdup(tmpURI),
  866. /* instantiate */ lv2_instantiate,
  867. /* connect_port */ lv2_connect_port,
  868. /* activate */ lv2_activate,
  869. /* run */ lv2_run,
  870. /* deactivate */ lv2_deactivate,
  871. /* cleanup */ lv2_cleanup,
  872. /* extension_data */ lv2_extension_data
  873. };
  874. LV2_Descriptor* lv2Desc;
  875. try {
  876. lv2Desc = new LV2_Descriptor;
  877. } CARLA_SAFE_EXCEPTION_RETURN("new LV2_Descriptor", nullptr);
  878. std::memcpy(lv2Desc, &lv2DescTmp, sizeof(LV2_Descriptor));
  879. plm.lv2Descs.append(lv2Desc);
  880. return lv2Desc;
  881. }
  882. #ifdef HAVE_PYQT
  883. CARLA_EXPORT
  884. const LV2UI_Descriptor* lv2ui_descriptor(uint32_t index)
  885. {
  886. carla_debug("lv2ui_descriptor(%i)", index);
  887. static const LV2UI_Descriptor lv2UiExtDesc = {
  888. /* URI */ "http://kxstudio.sf.net/carla/ui-ext",
  889. /* instantiate */ lv2ui_instantiate,
  890. /* cleanup */ lv2ui_cleanup,
  891. /* port_event */ lv2ui_port_event,
  892. /* extension_data */ lv2ui_extension_data
  893. };
  894. return (index == 0) ? &lv2UiExtDesc : nullptr;
  895. }
  896. #endif
  897. // -----------------------------------------------------------------------