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.

476 lines
14KB

  1. /*
  2. * Carla Native Plugins
  3. * Copyright (C) 2012-2017 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License as
  7. * published by the Free Software Foundation; either version 2 of
  8. * the License, or any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16. */
  17. #include "CarlaNativeExtUI.hpp"
  18. #include "CarlaJuceUtils.hpp"
  19. #include "distrho/extra/ScopedPointer.hpp"
  20. #include "zita-rev1/jclient.cc"
  21. #include "zita-rev1/pareq.cc"
  22. #include "zita-rev1/reverb.cc"
  23. using namespace REV1;
  24. // -----------------------------------------------------------------------
  25. // REV1 Plugin
  26. class REV1Plugin : public NativePluginAndUiClass
  27. {
  28. public:
  29. enum Parameters {
  30. kParameterDELAY,
  31. kParameterXOVER,
  32. kParameterRTLOW,
  33. kParameterRTMID,
  34. kParameterFDAMP,
  35. kParameterEQ1FR,
  36. kParameterEQ1GN,
  37. kParameterEQ2FR,
  38. kParameterEQ2GN,
  39. kParameterOPMIXorRGXYZ,
  40. kParameterNROTARY
  41. };
  42. REV1Plugin(const NativeHostDescriptor* const host, const bool isAmbisonic)
  43. : NativePluginAndUiClass(host, "rev1-ui"),
  44. kIsAmbisonic(isAmbisonic),
  45. kNumInputs(2),
  46. kNumOutputs(isAmbisonic ? 4 : 2),
  47. fJackClient(),
  48. jclient(nullptr)
  49. {
  50. CARLA_SAFE_ASSERT(host != nullptr);
  51. carla_zeroStruct(fJackClient);
  52. fJackClient.bufferSize = getBufferSize();
  53. fJackClient.sampleRate = getSampleRate();
  54. // set initial values
  55. fParameters[kParameterDELAY] = 0.04f;
  56. fParameters[kParameterXOVER] = 200.0f;
  57. fParameters[kParameterRTLOW] = 3.0f;
  58. fParameters[kParameterRTMID] = 2.0f;
  59. fParameters[kParameterFDAMP] = 6.0e3;
  60. fParameters[kParameterEQ1FR] = 160.0f;
  61. fParameters[kParameterEQ1GN] = 0.0f;
  62. fParameters[kParameterEQ2FR] = 2.5e3;
  63. fParameters[kParameterEQ2GN] = 0.0f;
  64. if (isAmbisonic)
  65. fParameters[kParameterOPMIXorRGXYZ] = 0.0f;
  66. else
  67. fParameters[kParameterOPMIXorRGXYZ] = 0.5f;
  68. _recreateZitaClient();
  69. }
  70. // -------------------------------------------------------------------
  71. // Plugin parameter calls
  72. uint32_t getParameterCount() const override
  73. {
  74. return kParameterNROTARY;
  75. }
  76. const NativeParameter* getParameterInfo(const uint32_t index) const override
  77. {
  78. CARLA_SAFE_ASSERT_RETURN(index < kParameterNROTARY, nullptr);
  79. static NativeParameter param;
  80. int hints = NATIVE_PARAMETER_IS_ENABLED|NATIVE_PARAMETER_IS_AUTOMABLE;
  81. // reset
  82. param.name = nullptr;
  83. param.unit = nullptr;
  84. param.ranges.def = 0.0f;
  85. param.ranges.min = 0.0f;
  86. param.ranges.max = 1.0f;
  87. param.ranges.step = 1.0f;
  88. param.ranges.stepSmall = 1.0f;
  89. param.ranges.stepLarge = 1.0f;
  90. param.scalePointCount = 0;
  91. param.scalePoints = nullptr;
  92. switch (index)
  93. {
  94. case kParameterDELAY:
  95. param.name = "Delay";
  96. param.ranges.def = 0.04f;
  97. param.ranges.min = 0.02f;
  98. param.ranges.max = 0.100f;
  99. break;
  100. case kParameterXOVER:
  101. hints |= NATIVE_PARAMETER_IS_LOGARITHMIC;
  102. param.name = "Crossover";
  103. param.ranges.def = 200.0f;
  104. param.ranges.min = 50.0f;
  105. param.ranges.max = 1000.0f;
  106. break;
  107. case kParameterRTLOW:
  108. hints |= NATIVE_PARAMETER_IS_LOGARITHMIC;
  109. param.name = "RT60 Low";
  110. param.ranges.def = 3.0f;
  111. param.ranges.min = 1.0f;
  112. param.ranges.max = 8.0f;
  113. break;
  114. case kParameterRTMID:
  115. hints |= NATIVE_PARAMETER_IS_LOGARITHMIC;
  116. param.name = "RT60 Mid";
  117. param.ranges.def = 2.0f;
  118. param.ranges.min = 1.0f;
  119. param.ranges.max = 8.0f;
  120. break;
  121. case kParameterFDAMP:
  122. hints |= NATIVE_PARAMETER_IS_LOGARITHMIC;
  123. param.name = "HF Damping";
  124. param.ranges.def = 6.0e3;
  125. param.ranges.min = 1.5e3;
  126. param.ranges.max = 24.0e3;
  127. break;
  128. case kParameterEQ1FR:
  129. hints |= NATIVE_PARAMETER_IS_LOGARITHMIC;
  130. param.name = "Eq1 Frequency";
  131. param.ranges.def = 160.0f;
  132. param.ranges.min = 40.0f;
  133. param.ranges.max = 2.5e3;
  134. break;
  135. case kParameterEQ1GN:
  136. param.name = "Eq1 Gain";
  137. param.ranges.def = 0.0f;
  138. param.ranges.min = -15.0;
  139. param.ranges.max = 15.0f;
  140. break;
  141. case kParameterEQ2FR:
  142. hints |= NATIVE_PARAMETER_IS_LOGARITHMIC;
  143. param.name = "Eq2 Frequency";
  144. param.ranges.def = 2.5e3;
  145. param.ranges.min = 160.0;
  146. param.ranges.max = 10e3;
  147. break;
  148. case kParameterEQ2GN:
  149. param.name = "Eq2 Gain";
  150. param.ranges.def = 0.0f;
  151. param.ranges.min = -15.0;
  152. param.ranges.max = 15.0f;
  153. break;
  154. case kParameterOPMIXorRGXYZ:
  155. if (kIsAmbisonic)
  156. {
  157. param.name = "XYZ gain";
  158. param.ranges.def = 0.0f;
  159. param.ranges.min = -9.0f;
  160. param.ranges.max = 9.0f;
  161. }
  162. else
  163. {
  164. param.name = "Dry/wet mix";
  165. param.ranges.def = 0.5f;
  166. param.ranges.min = 0.0f;
  167. param.ranges.max = 1.0f;
  168. }
  169. break;
  170. }
  171. param.hints = static_cast<NativeParameterHints>(hints);
  172. return &param;
  173. }
  174. float getParameterValue(const uint32_t index) const override
  175. {
  176. CARLA_SAFE_ASSERT_RETURN(index < kParameterNROTARY, 0.0f);
  177. return fParameters[index];
  178. }
  179. // -------------------------------------------------------------------
  180. // Plugin state calls
  181. void setParameterValue(const uint32_t index, const float value) override
  182. {
  183. CARLA_SAFE_ASSERT_RETURN(index < kParameterNROTARY,);
  184. Reverb* const reverb(jclient->reverb());
  185. fParameters[index] = value;
  186. switch (index)
  187. {
  188. case kParameterDELAY:
  189. reverb->set_delay(value);
  190. break;
  191. case kParameterXOVER:
  192. reverb->set_xover(value);
  193. break;
  194. case kParameterRTLOW:
  195. reverb->set_rtlow(value);
  196. break;
  197. case kParameterRTMID:
  198. reverb->set_rtmid(value);
  199. break;
  200. case kParameterFDAMP:
  201. reverb->set_fdamp(value);
  202. break;
  203. case kParameterEQ1FR:
  204. reverb->set_eq1(value, fParameters[kParameterEQ1GN]);
  205. break;
  206. case kParameterEQ1GN:
  207. reverb->set_eq1(fParameters[kParameterEQ1FR], value);
  208. break;
  209. case kParameterEQ2FR:
  210. reverb->set_eq2(value, fParameters[kParameterEQ2GN]);
  211. break;
  212. case kParameterEQ2GN:
  213. reverb->set_eq2(fParameters[kParameterEQ2FR], value);
  214. break;
  215. case kParameterOPMIXorRGXYZ:
  216. if (kIsAmbisonic)
  217. reverb->set_rgxyz(value);
  218. else
  219. reverb->set_opmix(value);
  220. break;
  221. }
  222. }
  223. // -------------------------------------------------------------------
  224. // Plugin process calls
  225. void process(float** const inBuffer, float** const outBuffer, const uint32_t frames, const NativeMidiEvent* const, const uint32_t) override
  226. {
  227. if (! fJackClient.active)
  228. {
  229. const int iframes(frames);
  230. for (uint32_t i=0; i<kNumInputs; ++i)
  231. carla_zeroFloats(outBuffer[i], iframes);
  232. return;
  233. }
  234. for (uint32_t i=0; i<kNumInputs; ++i)
  235. fJackClient.portsAudioIn[i].buffer.audio = inBuffer[i];
  236. for (uint32_t i=0; i<kNumOutputs; ++i)
  237. fJackClient.portsAudioOut[i].buffer.audio = outBuffer[i];
  238. fJackClient.processCallback(frames, fJackClient.processPtr);
  239. }
  240. // -------------------------------------------------------------------
  241. // Plugin dispatcher calls
  242. void bufferSizeChanged(const uint32_t bufferSize) override
  243. {
  244. fJackClient.bufferSize = bufferSize;
  245. // _recreateZitaClient(); // FIXME
  246. }
  247. void sampleRateChanged(const double sampleRate) override
  248. {
  249. fJackClient.sampleRate = sampleRate;
  250. // _recreateZitaClient(); // FIXME
  251. }
  252. // -------------------------------------------------------------------
  253. // Plugin UI calls
  254. void uiShow(const bool show) override
  255. {
  256. if (show)
  257. {
  258. if (isPipeRunning())
  259. {
  260. const CarlaMutexLocker cml(getPipeLock());
  261. writeMessage("focus\n", 6);
  262. flushMessages();
  263. return;
  264. }
  265. carla_stdout("Trying to start UI using \"%s\"", getExtUiPath());
  266. CarlaExternalUI::setData(getExtUiPath(), kIsAmbisonic ? "true" : "false", getUiName());
  267. if (! CarlaExternalUI::startPipeServer(true))
  268. {
  269. uiClosed();
  270. hostUiUnavailable();
  271. }
  272. }
  273. else
  274. {
  275. CarlaExternalUI::stopPipeServer(2000);
  276. }
  277. }
  278. // -------------------------------------------------------------------
  279. private:
  280. const bool kIsAmbisonic;
  281. const uint32_t kNumInputs;
  282. const uint32_t kNumOutputs;
  283. // Fake jack client
  284. jack_client_t fJackClient;
  285. // Zita stuff (core)
  286. ScopedPointer<Jclient> jclient;
  287. // Parameters
  288. float fParameters[kParameterNROTARY];
  289. void _recreateZitaClient()
  290. {
  291. jclient = new Jclient(&fJackClient, kIsAmbisonic);
  292. Reverb* const reverb(jclient->reverb());
  293. reverb->set_delay(fParameters[kParameterDELAY]);
  294. reverb->set_xover(fParameters[kParameterXOVER]);
  295. reverb->set_rtlow(fParameters[kParameterRTLOW]);
  296. reverb->set_rtmid(fParameters[kParameterRTMID]);
  297. reverb->set_fdamp(fParameters[kParameterFDAMP]);
  298. if (kIsAmbisonic)
  299. {
  300. reverb->set_opmix(0.5);
  301. reverb->set_rgxyz(fParameters[kParameterOPMIXorRGXYZ]);
  302. }
  303. else
  304. {
  305. reverb->set_opmix(fParameters[kParameterOPMIXorRGXYZ]);
  306. reverb->set_rgxyz(0.0);
  307. }
  308. reverb->set_eq1(fParameters[kParameterEQ1FR], fParameters[kParameterEQ1GN]);
  309. reverb->set_eq2(fParameters[kParameterEQ2FR], fParameters[kParameterEQ2GN]);
  310. }
  311. public:
  312. static NativePluginHandle _instantiateAmbisonic(const NativeHostDescriptor* host)
  313. {
  314. return (host != nullptr) ? new REV1Plugin(host, true) : nullptr;
  315. }
  316. static NativePluginHandle _instantiateStereo(const NativeHostDescriptor* host)
  317. {
  318. return (host != nullptr) ? new REV1Plugin(host, false) : nullptr;
  319. }
  320. static void _cleanup(NativePluginHandle handle)
  321. {
  322. delete (REV1Plugin*)handle;
  323. }
  324. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(REV1Plugin)
  325. };
  326. // -----------------------------------------------------------------------
  327. static const NativePluginDescriptor rev1AmbisonicDesc = {
  328. /* category */ NATIVE_PLUGIN_CATEGORY_DELAY,
  329. /* hints */ static_cast<NativePluginHints>(NATIVE_PLUGIN_IS_RTSAFE
  330. |NATIVE_PLUGIN_HAS_UI
  331. |NATIVE_PLUGIN_NEEDS_FIXED_BUFFERS),
  332. /* supports */ NATIVE_PLUGIN_SUPPORTS_NOTHING,
  333. /* audioIns */ 2,
  334. /* audioOuts */ 4,
  335. /* midiIns */ 0,
  336. /* midiOuts */ 0,
  337. /* paramIns */ REV1Plugin::kParameterNROTARY,
  338. /* paramOuts */ 0,
  339. /* name */ "REV1 (Ambisonic)",
  340. /* label */ "rev1-ambisonic",
  341. /* maker */ "falkTX, Fons Adriaensen",
  342. /* copyright */ "GPL v2+",
  343. REV1Plugin::_instantiateAmbisonic,
  344. REV1Plugin::_cleanup,
  345. REV1Plugin::_get_parameter_count,
  346. REV1Plugin::_get_parameter_info,
  347. REV1Plugin::_get_parameter_value,
  348. REV1Plugin::_get_midi_program_count,
  349. REV1Plugin::_get_midi_program_info,
  350. REV1Plugin::_set_parameter_value,
  351. REV1Plugin::_set_midi_program,
  352. REV1Plugin::_set_custom_data,
  353. REV1Plugin::_ui_show,
  354. REV1Plugin::_ui_idle,
  355. REV1Plugin::_ui_set_parameter_value,
  356. REV1Plugin::_ui_set_midi_program,
  357. REV1Plugin::_ui_set_custom_data,
  358. REV1Plugin::_activate,
  359. REV1Plugin::_deactivate,
  360. REV1Plugin::_process,
  361. REV1Plugin::_get_state,
  362. REV1Plugin::_set_state,
  363. REV1Plugin::_dispatcher
  364. };
  365. static const NativePluginDescriptor rev1StereoDesc = {
  366. /* category */ NATIVE_PLUGIN_CATEGORY_DELAY,
  367. /* hints */ static_cast<NativePluginHints>(NATIVE_PLUGIN_IS_RTSAFE
  368. |NATIVE_PLUGIN_HAS_UI
  369. |NATIVE_PLUGIN_NEEDS_FIXED_BUFFERS),
  370. /* supports */ NATIVE_PLUGIN_SUPPORTS_NOTHING,
  371. /* audioIns */ 2,
  372. /* audioOuts */ 2,
  373. /* midiIns */ 0,
  374. /* midiOuts */ 0,
  375. /* paramIns */ REV1Plugin::kParameterNROTARY,
  376. /* paramOuts */ 0,
  377. /* name */ "REV1 (Stereo)",
  378. /* label */ "rev1-stereo",
  379. /* maker */ "falkTX, Fons Adriaensen",
  380. /* copyright */ "GPL v2+",
  381. REV1Plugin::_instantiateStereo,
  382. REV1Plugin::_cleanup,
  383. REV1Plugin::_get_parameter_count,
  384. REV1Plugin::_get_parameter_info,
  385. REV1Plugin::_get_parameter_value,
  386. REV1Plugin::_get_midi_program_count,
  387. REV1Plugin::_get_midi_program_info,
  388. REV1Plugin::_set_parameter_value,
  389. REV1Plugin::_set_midi_program,
  390. REV1Plugin::_set_custom_data,
  391. REV1Plugin::_ui_show,
  392. REV1Plugin::_ui_idle,
  393. REV1Plugin::_ui_set_parameter_value,
  394. REV1Plugin::_ui_set_midi_program,
  395. REV1Plugin::_ui_set_custom_data,
  396. REV1Plugin::_activate,
  397. REV1Plugin::_deactivate,
  398. REV1Plugin::_process,
  399. REV1Plugin::_get_state,
  400. REV1Plugin::_set_state,
  401. REV1Plugin::_dispatcher
  402. };
  403. // -----------------------------------------------------------------------
  404. CARLA_EXPORT
  405. void carla_register_native_plugin_zita_rev1();
  406. CARLA_EXPORT
  407. void carla_register_native_plugin_zita_rev1()
  408. {
  409. carla_register_native_plugin(&rev1AmbisonicDesc);
  410. carla_register_native_plugin(&rev1StereoDesc);
  411. }
  412. // -----------------------------------------------------------------------