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.

675 lines
16KB

  1. /*
  2. * Carla Bridge UI
  3. * Copyright (C) 2011-2014 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 "CarlaBridgeUI.hpp"
  18. #include "CarlaMIDI.h"
  19. #include "CarlaBase64Utils.hpp"
  20. #ifdef BRIDGE_LV2
  21. # undef NULL
  22. # define NULL nullptr
  23. # include "lv2/atom-util.h"
  24. #endif
  25. CARLA_BRIDGE_START_NAMESPACE
  26. // ---------------------------------------------------------------------
  27. CarlaBridgeUI::CarlaBridgeUI() noexcept
  28. : CarlaPipeClient(),
  29. fQuitReceived(false),
  30. #ifdef BRIDGE_LV2
  31. fUridMapComplete(false),
  32. #endif
  33. fToolkit(nullptr),
  34. fLib(nullptr),
  35. fLibFilename(),
  36. leakDetector_CarlaBridgeUI()
  37. {
  38. carla_debug("CarlaBridgeUI::CarlaBridgeUI()");
  39. try {
  40. fToolkit = CarlaBridgeToolkit::createNew(this);
  41. } CARLA_SAFE_EXCEPTION_RETURN("CarlaBridgeToolkit::createNew",);
  42. }
  43. CarlaBridgeUI::~CarlaBridgeUI() noexcept
  44. {
  45. carla_debug("CarlaBridgeUI::~CarlaBridgeUI()");
  46. if (fLib != nullptr)
  47. {
  48. lib_close(fLib);
  49. fLib = nullptr;
  50. }
  51. if (isPipeRunning() && ! fQuitReceived)
  52. {
  53. const CarlaMutexLocker cml(getPipeLock());
  54. writeMessage("exiting\n", 8);
  55. flushMessages();
  56. }
  57. if (fToolkit != nullptr)
  58. {
  59. fToolkit->quit();
  60. delete fToolkit;
  61. fToolkit = nullptr;
  62. }
  63. closePipeClient();
  64. }
  65. // ---------------------------------------------------------------------
  66. // Host DSP State
  67. void CarlaBridgeUI::sendControl(const uint32_t index, const float value) const noexcept
  68. {
  69. char tmpBuf[0xff+1];
  70. tmpBuf[0xff] = '\0';
  71. const CarlaMutexLocker cml(getPipeLock());
  72. const ScopedLocale csl;
  73. writeMessage("control\n", 8);
  74. {
  75. std::snprintf(tmpBuf, 0xff, "%i\n", index);
  76. writeMessage(tmpBuf);
  77. std::snprintf(tmpBuf, 0xff, "%f\n", value);
  78. writeMessage(tmpBuf);
  79. }
  80. flushMessages();
  81. }
  82. void CarlaBridgeUI::sendProgram(const uint32_t index) const noexcept
  83. {
  84. char tmpBuf[0xff+1];
  85. tmpBuf[0xff] = '\0';
  86. const CarlaMutexLocker cml(getPipeLock());
  87. writeMessage("program\n", 8);
  88. {
  89. std::snprintf(tmpBuf, 0xff, "%i\n", index);
  90. writeMessage(tmpBuf);
  91. }
  92. flushMessages();
  93. }
  94. void CarlaBridgeUI::sendConfigure(const char* const key, const char* const value) const noexcept
  95. {
  96. CARLA_SAFE_ASSERT_RETURN(key != nullptr && key[0] != '\0',);
  97. CARLA_SAFE_ASSERT_RETURN(value != nullptr,);
  98. const CarlaMutexLocker cml(getPipeLock());
  99. writeMessage("configure\n", 10);
  100. {
  101. writeAndFixMessage(key);
  102. writeAndFixMessage(value);
  103. }
  104. flushMessages();
  105. }
  106. void CarlaBridgeUI::sendNote(const bool onOff, const uint8_t channel, const uint8_t note, const uint8_t velocity) const noexcept
  107. {
  108. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  109. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  110. CARLA_SAFE_ASSERT_RETURN(velocity < MAX_MIDI_VALUE,);
  111. char tmpBuf[0xff+1];
  112. tmpBuf[0xff] = '\0';
  113. const CarlaMutexLocker cml(getPipeLock());
  114. writeMessage("note\n", 5);
  115. {
  116. std::snprintf(tmpBuf, 0xff, "%s\n", bool2str(onOff));
  117. writeMessage(tmpBuf);
  118. std::snprintf(tmpBuf, 0xff, "%i\n", channel);
  119. writeMessage(tmpBuf);
  120. std::snprintf(tmpBuf, 0xff, "%i\n", note);
  121. writeMessage(tmpBuf);
  122. std::snprintf(tmpBuf, 0xff, "%i\n", velocity);
  123. writeMessage(tmpBuf);
  124. }
  125. flushMessages();
  126. }
  127. #ifdef BRIDGE_LV2
  128. void CarlaBridgeUI::sendAtom(const uint32_t index, const LV2_Atom* const atom) const noexcept
  129. {
  130. CARLA_SAFE_ASSERT_RETURN(atom != nullptr,);
  131. char tmpBuf[0xff+1];
  132. tmpBuf[0xff] = '\0';
  133. CarlaString base64atom(CarlaString::asBase64(atom, lv2_atom_total_size(atom)));
  134. const CarlaMutexLocker cml(getPipeLock());
  135. writeMessage("atom\n", 5);
  136. {
  137. std::snprintf(tmpBuf, 0xff, "%i\n", index);
  138. writeMessage(tmpBuf);
  139. std::snprintf(tmpBuf, 0xff, "%i\n", atom->size);
  140. writeMessage(tmpBuf);
  141. writeAndFixMessage(base64atom.buffer());
  142. }
  143. flushMessages();
  144. }
  145. void CarlaBridgeUI::sendURID(const LV2_URID urid, const char* const uri) const noexcept
  146. {
  147. CARLA_SAFE_ASSERT_RETURN(urid != 0,);
  148. CARLA_SAFE_ASSERT_RETURN(uri != nullptr && uri[0] != '\0',);
  149. char tmpBuf[0xff+1];
  150. tmpBuf[0xff] = '\0';
  151. const CarlaMutexLocker cml(getPipeLock());
  152. writeMessage("urid\n", 5);
  153. {
  154. std::snprintf(tmpBuf, 0xff, "%i\n", urid);
  155. writeMessage(tmpBuf);
  156. writeAndFixMessage(uri);
  157. }
  158. flushMessages();
  159. }
  160. #endif
  161. bool CarlaBridgeUI::libOpen(const char* const filename) noexcept
  162. {
  163. CARLA_SAFE_ASSERT_RETURN(fLib == nullptr, false);
  164. fLib = lib_open(filename);
  165. if (fLib != nullptr)
  166. {
  167. fLibFilename = filename;
  168. return true;
  169. }
  170. return false;
  171. }
  172. void* CarlaBridgeUI::libSymbol(const char* const symbol) const noexcept
  173. {
  174. CARLA_SAFE_ASSERT_RETURN(fLib != nullptr, nullptr);
  175. return lib_symbol<void*>(fLib, symbol);
  176. }
  177. const char* CarlaBridgeUI::libError() const noexcept
  178. {
  179. CARLA_SAFE_ASSERT_RETURN(fLibFilename.isNotEmpty(), nullptr);
  180. return lib_error(fLibFilename);
  181. }
  182. // ---------------------------------------------------------------------
  183. bool CarlaBridgeUI::msgReceived(const char* const msg) noexcept
  184. {
  185. #ifdef BRIDGE_LV2
  186. if (! fUridMapComplete) {
  187. CARLA_SAFE_ASSERT_RETURN(std::strcmp(msg, "urid") == 0, true);
  188. }
  189. #endif
  190. if (std::strcmp(msg, "control") == 0)
  191. {
  192. uint32_t index;
  193. float value;
  194. CARLA_SAFE_ASSERT_RETURN(readNextLineAsUInt(index), true);
  195. CARLA_SAFE_ASSERT_RETURN(readNextLineAsFloat(value), true);
  196. dspParameterChanged(index, value);
  197. return true;
  198. }
  199. if (std::strcmp(msg, "program") == 0)
  200. {
  201. uint32_t index;
  202. CARLA_SAFE_ASSERT_RETURN(readNextLineAsUInt(index), true);
  203. dspProgramChanged(index);
  204. return true;
  205. }
  206. if (std::strcmp(msg, "mprogram") == 0)
  207. {
  208. uint32_t bank, program;
  209. CARLA_SAFE_ASSERT_RETURN(readNextLineAsUInt(bank), true);
  210. CARLA_SAFE_ASSERT_RETURN(readNextLineAsUInt(program), true);
  211. dspMidiProgramChanged(bank, program);
  212. return true;
  213. }
  214. if (std::strcmp(msg, "configure") == 0)
  215. {
  216. const char* key;
  217. const char* value;
  218. CARLA_SAFE_ASSERT_RETURN(readNextLineAsString(key), true);
  219. CARLA_SAFE_ASSERT_RETURN(readNextLineAsString(value), true);
  220. dspStateChanged(key, value);
  221. delete[] key;
  222. delete[] value;
  223. return true;
  224. }
  225. if (std::strcmp(msg, "note") == 0)
  226. {
  227. bool onOff;
  228. uint8_t channel, note, velocity;
  229. CARLA_SAFE_ASSERT_RETURN(readNextLineAsBool(onOff), true);
  230. CARLA_SAFE_ASSERT_RETURN(readNextLineAsByte(channel), true);
  231. CARLA_SAFE_ASSERT_RETURN(readNextLineAsByte(note), true);
  232. CARLA_SAFE_ASSERT_RETURN(readNextLineAsByte(velocity), true);
  233. dspNoteReceived(onOff, channel, note, velocity);
  234. }
  235. #ifdef BRIDGE_LV2
  236. if (std::strcmp(msg, "atom") == 0)
  237. {
  238. uint32_t index, size;
  239. const char* base64atom;
  240. CARLA_SAFE_ASSERT_RETURN(readNextLineAsUInt(index), true);
  241. CARLA_SAFE_ASSERT_RETURN(readNextLineAsUInt(size), true);
  242. CARLA_SAFE_ASSERT_RETURN(readNextLineAsString(base64atom), true);
  243. std::vector<uint8_t> chunk(carla_getChunkFromBase64String(base64atom));
  244. delete[] base64atom;
  245. CARLA_SAFE_ASSERT_RETURN(chunk.size() >= sizeof(LV2_Atom), true);
  246. const LV2_Atom* const atom((const LV2_Atom*)chunk.data());
  247. CARLA_SAFE_ASSERT_RETURN(atom->size == chunk.size(), true);
  248. dspAtomReceived(index, atom);
  249. return true;
  250. }
  251. if (std::strcmp(msg, "urid") == 0)
  252. {
  253. uint32_t urid;
  254. const char* uri;
  255. CARLA_SAFE_ASSERT_RETURN(readNextLineAsUInt(urid), true);
  256. CARLA_SAFE_ASSERT_RETURN(readNextLineAsString(uri), true);
  257. if (urid == 0)
  258. {
  259. CARLA_SAFE_ASSERT_RETURN(std::strcmp(uri, "Complete") == 0, true);
  260. fUridMapComplete = true;
  261. }
  262. else
  263. {
  264. dspURIDReceived(urid, uri);
  265. }
  266. delete[] uri;
  267. return true;
  268. }
  269. #endif
  270. CARLA_SAFE_ASSERT_RETURN(fToolkit != nullptr, true);
  271. if (std::strcmp(msg, "show") == 0)
  272. {
  273. fToolkit->show();
  274. return true;
  275. }
  276. if (std::strcmp(msg, "focus") == 0)
  277. {
  278. fToolkit->focus();
  279. return true;
  280. }
  281. if (std::strcmp(msg, "hide") == 0)
  282. {
  283. fToolkit->hide();
  284. return true;
  285. }
  286. if (std::strcmp(msg, "quit") == 0)
  287. {
  288. fQuitReceived = true;
  289. fToolkit->quit();
  290. return true;
  291. }
  292. if (std::strcmp(msg, "uiTitle") == 0)
  293. {
  294. const char* title;
  295. CARLA_SAFE_ASSERT_RETURN(readNextLineAsString(title), true);
  296. fToolkit->setTitle(title);
  297. delete[] title;
  298. return true;
  299. }
  300. carla_stderr("CarlaBridgeUI::msgReceived : %s", msg);
  301. return false;
  302. }
  303. // ---------------------------------------------------------------------
  304. bool CarlaBridgeUI::init(const int argc, const char* argv[])
  305. {
  306. CARLA_SAFE_ASSERT_RETURN(fToolkit != nullptr, false);
  307. if (! fToolkit->init(argc, argv))
  308. return false;
  309. if (argc == 7)
  310. {
  311. if (! initPipeClient(argv))
  312. {
  313. fToolkit->quit();
  314. delete fToolkit;
  315. fToolkit = nullptr;
  316. return false;
  317. }
  318. #ifdef BRIDGE_LV2
  319. // wait for URID map to complete
  320. for (int i=0; i<20 && ! fUridMapComplete; ++i)
  321. {
  322. idlePipe();
  323. carla_msleep(100);
  324. }
  325. if (! fUridMapComplete)
  326. {
  327. fToolkit->quit();
  328. delete fToolkit;
  329. fToolkit = nullptr;
  330. closePipeClient();
  331. }
  332. #endif
  333. }
  334. return true;
  335. }
  336. void CarlaBridgeUI::exec(const bool showUI)
  337. {
  338. CARLA_SAFE_ASSERT_RETURN(fToolkit != nullptr,);
  339. fToolkit->exec(showUI);
  340. }
  341. // ---------------------------------------------------------------------
  342. CARLA_BRIDGE_END_NAMESPACE
  343. #include "CarlaPipeUtils.cpp"
  344. // ---------------------------------------------------------------------
  345. #if 0
  346. // ---------------------------------------------------------------------
  347. // ui initialization
  348. bool CarlaBridgeUI::uiInit(const char*, const char* const, const char* const)
  349. {
  350. carla_debug("CarlaBridgeUI::uiInit()");
  351. fUI.init();
  352. return true;
  353. }
  354. void CarlaBridgeUI::uiClose()
  355. {
  356. carla_debug("CarlaBridgeUI::uiClose()");
  357. if (isOscControlRegistered() && ! fUI.quit)
  358. sendOscExiting();
  359. fUI.close();
  360. }
  361. // ---------------------------------------------------------------------
  362. // ui toolkit
  363. void CarlaBridgeUI::toolkitShow()
  364. {
  365. CARLA_SAFE_ASSERT_RETURN(fUI.toolkit != nullptr,);
  366. carla_debug("CarlaBridgeUI::toolkitShow()");
  367. fUI.toolkit->show();
  368. }
  369. void CarlaBridgeUI::toolkitHide()
  370. {
  371. CARLA_SAFE_ASSERT_RETURN(fUI.toolkit != nullptr,);
  372. carla_debug("CarlaBridgeUI::toolkitHide()");
  373. fUI.toolkit->hide();
  374. }
  375. void CarlaBridgeUI::toolkitResize(const int width, const int height)
  376. {
  377. CARLA_SAFE_ASSERT_RETURN(fUI.toolkit != nullptr,);
  378. carla_debug("CarlaBridgeUI::toolkitResize(%i, %i)", width, height);
  379. fUI.toolkit->resize(width, height);
  380. }
  381. void CarlaBridgeUI::toolkitExec(const bool showGui)
  382. {
  383. CARLA_SAFE_ASSERT_RETURN(fUI.toolkit != nullptr,);
  384. carla_debug("CarlaBridgeUI::toolkitExec(%s)", bool2str(showGui));
  385. fUI.toolkit->exec(showGui);
  386. }
  387. void CarlaBridgeUI::toolkitQuit()
  388. {
  389. carla_debug("CarlaBridgeUI::toolkitQuit()");
  390. fUI.quit = true;
  391. }
  392. // ---------------------------------------------------------------------
  393. // osc stuff
  394. void CarlaBridgeUI::oscInit(const char* const url)
  395. {
  396. carla_debug("CarlaBridgeUI::oscInit(\"%s\")", url);
  397. fOsc.init(url);
  398. }
  399. bool CarlaBridgeUI::oscIdle(const bool onlyOnce) const
  400. {
  401. if (onlyOnce)
  402. fOsc.idleOnce();
  403. else
  404. fOsc.idle();
  405. return ! fUI.quit;
  406. }
  407. void CarlaBridgeUI::oscClose()
  408. {
  409. carla_debug("CarlaBridgeUI::oscClose()");
  410. fOsc.close();
  411. }
  412. bool CarlaBridgeUI::isOscControlRegistered() const noexcept
  413. {
  414. return fOsc.isControlRegistered();
  415. }
  416. void CarlaBridgeUI::sendOscUpdate() const
  417. {
  418. carla_debug("CarlaBridgeUI::sendOscUpdate()");
  419. if (fOscData.target != nullptr)
  420. osc_send_update(fOscData, fOsc.getServerPath());
  421. }
  422. // ---------------------------------------------------------------------
  423. void CarlaBridgeUI::sendOscConfigure(const char* const key, const char* const value) const
  424. {
  425. carla_debug("CarlaBridgeUI::sendOscConfigure(\"%s\", \"%s\")", key, value);
  426. if (fOscData.target != nullptr)
  427. osc_send_configure(fOscData, key, value);
  428. }
  429. void CarlaBridgeUI::sendOscControl(const int32_t index, const float value) const
  430. {
  431. carla_debug("CarlaBridgeUI::sendOscControl(%i, %f)", index, value);
  432. if (fOscData.target != nullptr)
  433. osc_send_control(fOscData, index, value);
  434. }
  435. void CarlaBridgeUI::sendOscProgram(const uint32_t index) const
  436. {
  437. carla_debug("CarlaBridgeUI::sendOscProgram(%i)", index);
  438. if (fOscData.target != nullptr)
  439. osc_send_program(fOscData, index);
  440. }
  441. void CarlaBridgeUI::sendOscMidiProgram(const uint32_t index) const
  442. {
  443. carla_debug("CarlaBridgeUI::sendOscMidiProgram(%i)", index);
  444. if (fOscData.target != nullptr)
  445. osc_send_midi_program(fOscData, index);
  446. }
  447. void CarlaBridgeUI::sendOscMidi(const uint8_t midiBuf[4]) const
  448. {
  449. carla_debug("CarlaBridgeUI::sendOscMidi(%p)", midiBuf);
  450. if (fOscData.target != nullptr)
  451. osc_send_midi(fOscData, midiBuf);
  452. }
  453. void CarlaBridgeUI::sendOscExiting() const
  454. {
  455. carla_debug("CarlaBridgeUI::sendOscExiting()");
  456. if (fOscData.target != nullptr)
  457. osc_send_exiting(fOscData);
  458. }
  459. #ifdef BRIDGE_LV2
  460. void CarlaBridgeUI::sendOscLv2AtomTransfer(const uint32_t portIndex, const char* const atomBuf) const
  461. {
  462. carla_debug("CarlaBridgeUI::sendOscLv2TransferAtom(%i, \"%s\")", portIndex, atomBuf);
  463. if (fOscData.target != nullptr)
  464. osc_send_lv2_atom_transfer(fOscData, portIndex, atomBuf);
  465. }
  466. void CarlaBridgeUI::sendOscLv2UridMap(const uint32_t urid, const char* const uri) const
  467. {
  468. carla_debug("CarlaBridgeUI::sendOscLv2UridMap(%i, \"%s\")", urid, uri);
  469. if (fOscData.target != nullptr)
  470. osc_send_lv2_urid_map(fOscData, urid, uri);
  471. }
  472. #endif
  473. // ---------------------------------------------------------------------
  474. void* CarlaBridgeUI::getContainerId()
  475. {
  476. carla_debug("CarlaBridgeUI::getContainerId()");
  477. return fUI.toolkit->getContainerId();
  478. }
  479. void* CarlaBridgeUI::getContainerId2()
  480. {
  481. carla_debug("CarlaBridgeUI::getContainerId2()");
  482. return fUI.toolkit->getContainerId2();
  483. }
  484. bool CarlaBridgeUI::uiLibOpen(const char* const filename)
  485. {
  486. CARLA_ASSERT(fUI.lib == nullptr);
  487. CARLA_ASSERT(filename != nullptr);
  488. carla_debug("CarlaBridgeUI::uiLibOpen(\"%s\")", filename);
  489. fUI.lib = lib_open(filename);
  490. fUI.filename = filename;
  491. return (fUI.lib != nullptr);
  492. }
  493. bool CarlaBridgeUI::uiLibClose()
  494. {
  495. CARLA_SAFE_ASSERT_RETURN(fUI.lib != nullptr, false);
  496. carla_debug("CarlaBridgeUI::uiLibClose()");
  497. const bool closed = lib_close(fUI.lib);
  498. fUI.lib = nullptr;
  499. return closed;
  500. }
  501. const char* CarlaBridgeUI::uiLibError()
  502. {
  503. carla_debug("CarlaBridgeUI::uiLibError()");
  504. return lib_error(fUI.filename);
  505. }
  506. #endif