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
37KB

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