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.

2181 lines
76KB

  1. /*
  2. * Carla Plugin Host
  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 "CarlaEngineInternal.hpp"
  18. #include "CarlaPlugin.hpp"
  19. #include "CarlaBackendUtils.hpp"
  20. #include "CarlaEngineUtils.hpp"
  21. #include "CarlaMathUtils.hpp"
  22. #include "CarlaMIDI.h"
  23. #include "CarlaPatchbayUtils.hpp"
  24. #include "CarlaStringList.hpp"
  25. #include "jackbridge/JackBridge.hpp"
  26. #include "jackey.h"
  27. #include "juce_audio_basics.h"
  28. #ifdef __SSE2_MATH__
  29. # include <xmmintrin.h>
  30. #endif
  31. #define URI_CANVAS_ICON "http://kxstudio.sf.net/ns/canvas/icon"
  32. using juce::FloatVectorOperations;
  33. using juce::String;
  34. using juce::StringArray;
  35. CARLA_BACKEND_START_NAMESPACE
  36. class CarlaEngineJack;
  37. class CarlaEngineJackClient;
  38. // -----------------------------------------------------------------------
  39. // Fallback data
  40. static const EngineEvent kFallbackJackEngineEvent = { kEngineEventTypeNull, 0, 0, {{ kEngineControlEventTypeNull, 0, 0.0f }} };
  41. // -----------------------------------------------------------------------
  42. // Carla Engine Port removal helper
  43. class CarlaEngineJackAudioPort;
  44. class CarlaEngineJackCVPort;
  45. class CarlaEngineJackEventPort;
  46. struct JackPortDeletionCallback {
  47. virtual ~JackPortDeletionCallback() noexcept {}
  48. virtual void jackAudioPortDeleted(CarlaEngineJackAudioPort* const) noexcept = 0;
  49. virtual void jackCVPortDeleted(CarlaEngineJackCVPort* const) noexcept = 0;
  50. virtual void jackEventPortDeleted(CarlaEngineJackEventPort* const) noexcept = 0;
  51. };
  52. // -----------------------------------------------------------------------
  53. // Carla Engine JACK-Audio port
  54. class CarlaEngineJackAudioPort : public CarlaEngineAudioPort
  55. {
  56. public:
  57. CarlaEngineJackAudioPort(const CarlaEngineClient& client, const bool isInputPort, jack_client_t* const jackClient, jack_port_t* const jackPort, JackPortDeletionCallback* const delCallback) noexcept
  58. : CarlaEngineAudioPort(client, isInputPort),
  59. fJackClient(jackClient),
  60. fJackPort(jackPort),
  61. kDeletionCallback(delCallback),
  62. leakDetector_CarlaEngineJackAudioPort()
  63. {
  64. carla_debug("CarlaEngineJackAudioPort::CarlaEngineJackAudioPort(%s, %p, %p)", bool2str(isInputPort), jackClient, jackPort);
  65. switch (kClient.getEngine().getProccessMode())
  66. {
  67. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  68. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  69. CARLA_SAFE_ASSERT_RETURN(jackClient != nullptr && jackPort != nullptr,);
  70. #ifndef BUILD_BRIDGE
  71. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  72. jackbridge_set_property(jackClient, uuid, JACKEY_SIGNAL_TYPE, "AUDIO", "text/plain");
  73. #endif
  74. break;
  75. default:
  76. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  77. break;
  78. }
  79. }
  80. ~CarlaEngineJackAudioPort() noexcept override
  81. {
  82. carla_debug("CarlaEngineJackAudioPort::~CarlaEngineJackAudioPort()");
  83. if (fJackClient != nullptr && fJackPort != nullptr)
  84. {
  85. #ifndef BUILD_BRIDGE
  86. try {
  87. if (const jack_uuid_t uuid = jackbridge_port_uuid(fJackPort))
  88. jackbridge_remove_property(fJackClient, uuid, JACKEY_SIGNAL_TYPE);
  89. } CARLA_SAFE_EXCEPTION("Audio port remove meta type");
  90. #endif
  91. try {
  92. jackbridge_port_unregister(fJackClient, fJackPort);
  93. } CARLA_SAFE_EXCEPTION("Audio port unregister");
  94. fJackClient = nullptr;
  95. fJackPort = nullptr;
  96. }
  97. if (kDeletionCallback != nullptr)
  98. kDeletionCallback->jackAudioPortDeleted(this);
  99. }
  100. void initBuffer() noexcept override
  101. {
  102. if (fJackPort == nullptr)
  103. return CarlaEngineAudioPort::initBuffer();
  104. const uint32_t bufferSize(kClient.getEngine().getBufferSize());
  105. try {
  106. fBuffer = (float*)jackbridge_port_get_buffer(fJackPort, bufferSize);
  107. }
  108. catch(...) {
  109. fBuffer = nullptr;
  110. return;
  111. }
  112. if (! kIsInput)
  113. FloatVectorOperations::clear(fBuffer, static_cast<int>(bufferSize));
  114. }
  115. void invalidate() noexcept
  116. {
  117. fJackClient = nullptr;
  118. fJackPort = nullptr;
  119. }
  120. private:
  121. jack_client_t* fJackClient;
  122. jack_port_t* fJackPort;
  123. JackPortDeletionCallback* const kDeletionCallback;
  124. friend class CarlaEngineJackClient;
  125. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackAudioPort)
  126. };
  127. // -----------------------------------------------------------------------
  128. // Carla Engine JACK-CV port
  129. class CarlaEngineJackCVPort : public CarlaEngineCVPort
  130. {
  131. public:
  132. CarlaEngineJackCVPort(const CarlaEngineClient& client, const bool isInputPort, jack_client_t* const jackClient, jack_port_t* const jackPort, JackPortDeletionCallback* const delCallback) noexcept
  133. : CarlaEngineCVPort(client, isInputPort),
  134. fJackClient(jackClient),
  135. fJackPort(jackPort),
  136. kDeletionCallback(delCallback),
  137. leakDetector_CarlaEngineJackCVPort()
  138. {
  139. carla_debug("CarlaEngineJackCVPort::CarlaEngineJackCVPort(%s, %p, %p)", bool2str(isInputPort), jackClient, jackPort);
  140. switch (kClient.getEngine().getProccessMode())
  141. {
  142. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  143. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  144. CARLA_SAFE_ASSERT_RETURN(jackClient != nullptr && jackPort != nullptr,);
  145. #ifndef BUILD_BRIDGE
  146. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  147. jackbridge_set_property(jackClient, uuid, JACKEY_SIGNAL_TYPE, "CV", "text/plain");
  148. #endif
  149. break;
  150. default:
  151. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  152. break;
  153. }
  154. }
  155. ~CarlaEngineJackCVPort() noexcept override
  156. {
  157. carla_debug("CarlaEngineJackCVPort::~CarlaEngineJackCVPort()");
  158. if (fJackClient != nullptr && fJackPort != nullptr)
  159. {
  160. #ifndef BUILD_BRIDGE
  161. try {
  162. if (const jack_uuid_t uuid = jackbridge_port_uuid(fJackPort))
  163. jackbridge_remove_property(fJackClient, uuid, JACKEY_SIGNAL_TYPE);
  164. } CARLA_SAFE_EXCEPTION("CV port remove meta type");
  165. #endif
  166. try {
  167. jackbridge_port_unregister(fJackClient, fJackPort);
  168. } CARLA_SAFE_EXCEPTION("CV port unregister");
  169. fJackClient = nullptr;
  170. fJackPort = nullptr;
  171. }
  172. if (kDeletionCallback != nullptr)
  173. kDeletionCallback->jackCVPortDeleted(this);
  174. }
  175. void initBuffer() noexcept override
  176. {
  177. if (fJackPort == nullptr)
  178. return CarlaEngineCVPort::initBuffer();
  179. const uint32_t bufferSize(kClient.getEngine().getBufferSize());
  180. try {
  181. fBuffer = (float*)jackbridge_port_get_buffer(fJackPort, bufferSize);
  182. }
  183. catch(...) {
  184. fBuffer = nullptr;
  185. return;
  186. }
  187. if (! kIsInput)
  188. FloatVectorOperations::clear(fBuffer, static_cast<int>(bufferSize));
  189. }
  190. void invalidate() noexcept
  191. {
  192. fJackClient = nullptr;
  193. fJackPort = nullptr;
  194. }
  195. private:
  196. jack_client_t* fJackClient;
  197. jack_port_t* fJackPort;
  198. JackPortDeletionCallback* const kDeletionCallback;
  199. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackCVPort)
  200. };
  201. // -----------------------------------------------------------------------
  202. // Carla Engine JACK-Event port
  203. class CarlaEngineJackEventPort : public CarlaEngineEventPort
  204. {
  205. public:
  206. CarlaEngineJackEventPort(const CarlaEngineClient& client, const bool isInputPort, jack_client_t* const jackClient, jack_port_t* const jackPort, JackPortDeletionCallback* const delCallback) noexcept
  207. : CarlaEngineEventPort(client, isInputPort),
  208. fJackClient(jackClient),
  209. fJackPort(jackPort),
  210. fJackBuffer(nullptr),
  211. fRetEvent(kFallbackJackEngineEvent),
  212. kDeletionCallback(delCallback),
  213. leakDetector_CarlaEngineJackEventPort()
  214. {
  215. carla_debug("CarlaEngineJackEventPort::CarlaEngineJackEventPort(%s, %p, %p)", bool2str(isInputPort), jackClient, jackPort);
  216. switch (kClient.getEngine().getProccessMode())
  217. {
  218. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  219. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  220. CARLA_SAFE_ASSERT_RETURN(jackClient != nullptr && jackPort != nullptr,);
  221. break;
  222. default:
  223. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  224. break;
  225. }
  226. }
  227. ~CarlaEngineJackEventPort() noexcept override
  228. {
  229. carla_debug("CarlaEngineJackEventPort::~CarlaEngineJackEventPort()");
  230. if (fJackClient != nullptr && fJackPort != nullptr)
  231. {
  232. try {
  233. jackbridge_port_unregister(fJackClient, fJackPort);
  234. } CARLA_SAFE_EXCEPTION("Event port unregister");
  235. fJackClient = nullptr;
  236. fJackPort = nullptr;
  237. }
  238. if (kDeletionCallback != nullptr)
  239. kDeletionCallback->jackEventPortDeleted(this);
  240. }
  241. void initBuffer() noexcept override
  242. {
  243. if (fJackPort == nullptr)
  244. return CarlaEngineEventPort::initBuffer();
  245. try {
  246. fJackBuffer = jackbridge_port_get_buffer(fJackPort, kClient.getEngine().getBufferSize());
  247. }
  248. catch(...) {
  249. fJackBuffer = nullptr;
  250. return;
  251. }
  252. if (! kIsInput)
  253. jackbridge_midi_clear_buffer(fJackBuffer);
  254. }
  255. uint32_t getEventCount() const noexcept override
  256. {
  257. if (fJackPort == nullptr)
  258. return CarlaEngineEventPort::getEventCount();
  259. CARLA_SAFE_ASSERT_RETURN(kIsInput, 0);
  260. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, 0);
  261. try {
  262. return jackbridge_midi_get_event_count(fJackBuffer);
  263. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_get_event_count", 0);
  264. }
  265. const EngineEvent& getEvent(const uint32_t index) const noexcept override
  266. {
  267. if (fJackPort == nullptr)
  268. return CarlaEngineEventPort::getEvent(index);
  269. CARLA_SAFE_ASSERT_RETURN(kIsInput, kFallbackJackEngineEvent);
  270. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, kFallbackJackEngineEvent);
  271. return getEventUnchecked(index);
  272. }
  273. const EngineEvent& getEventUnchecked(const uint32_t index) const noexcept override
  274. {
  275. jack_midi_event_t jackEvent;
  276. bool test = false;
  277. try {
  278. test = jackbridge_midi_event_get(&jackEvent, fJackBuffer, index);
  279. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_get", kFallbackJackEngineEvent);
  280. if (! test)
  281. return kFallbackJackEngineEvent;
  282. CARLA_SAFE_ASSERT_RETURN(jackEvent.size < UINT8_MAX, kFallbackJackEngineEvent);
  283. fRetEvent.time = jackEvent.time;
  284. fRetEvent.fillFromMidiData(static_cast<uint8_t>(jackEvent.size), jackEvent.buffer);
  285. return fRetEvent;
  286. }
  287. bool writeControlEvent(const uint32_t time, const uint8_t channel, const EngineControlEventType type, const uint16_t param, const float value) noexcept override
  288. {
  289. if (fJackPort == nullptr)
  290. return CarlaEngineEventPort::writeControlEvent(time, channel, type, param, value);
  291. CARLA_SAFE_ASSERT_RETURN(! kIsInput, false);
  292. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, false);
  293. CARLA_SAFE_ASSERT_RETURN(type != kEngineControlEventTypeNull, false);
  294. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS, false);
  295. CARLA_SAFE_ASSERT_RETURN(param < MAX_MIDI_CONTROL, false);
  296. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.0f);
  297. if (type == kEngineControlEventTypeParameter) {
  298. CARLA_SAFE_ASSERT(! MIDI_IS_CONTROL_BANK_SELECT(param));
  299. }
  300. uint8_t size = 0;
  301. uint8_t data[3] = { 0, 0, 0 };
  302. EngineControlEvent ctrlEvent = { type, param, value };
  303. ctrlEvent.convertToMidiData(channel, size, data);
  304. if (size == 0)
  305. return false;
  306. try {
  307. return jackbridge_midi_event_write(fJackBuffer, time, data, size);
  308. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_write", false);
  309. }
  310. bool writeMidiEvent(const uint32_t time, const uint8_t channel, const uint8_t port, const uint8_t size, const uint8_t* const data) noexcept override
  311. {
  312. if (fJackPort == nullptr)
  313. return CarlaEngineEventPort::writeMidiEvent(time, channel, port, size, data);
  314. CARLA_SAFE_ASSERT_RETURN(! kIsInput, false);
  315. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, false);
  316. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS, false);
  317. CARLA_SAFE_ASSERT_RETURN(size > 0, false);
  318. CARLA_SAFE_ASSERT_RETURN(data != nullptr, false);
  319. jack_midi_data_t jdata[size];
  320. jdata[0] = static_cast<jack_midi_data_t>(MIDI_GET_STATUS_FROM_DATA(data) + channel);
  321. for (uint8_t i=1; i < size; ++i)
  322. jdata[i] = data[i];
  323. try {
  324. return jackbridge_midi_event_write(fJackBuffer, time, jdata, size);
  325. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_write", false);
  326. }
  327. void invalidate() noexcept
  328. {
  329. fJackClient = nullptr;
  330. fJackPort = nullptr;
  331. }
  332. private:
  333. jack_client_t* fJackClient;
  334. jack_port_t* fJackPort;
  335. void* fJackBuffer;
  336. mutable EngineEvent fRetEvent;
  337. JackPortDeletionCallback* const kDeletionCallback;
  338. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackEventPort)
  339. };
  340. // -----------------------------------------------------------------------
  341. // Jack Engine client
  342. class CarlaEngineJackClient : public CarlaEngineClient,
  343. JackPortDeletionCallback
  344. {
  345. public:
  346. CarlaEngineJackClient(const CarlaEngine& engine, jack_client_t* const jackClient)
  347. : CarlaEngineClient(engine),
  348. fJackClient(jackClient),
  349. fUseClient(engine.getProccessMode() == ENGINE_PROCESS_MODE_SINGLE_CLIENT || engine.getProccessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS),
  350. fAudioPorts(),
  351. fCVPorts(),
  352. fEventPorts(),
  353. leakDetector_CarlaEngineJackClient()
  354. {
  355. carla_debug("CarlaEngineJackClient::CarlaEngineJackClient(%p)", jackClient);
  356. if (fUseClient)
  357. {
  358. CARLA_SAFE_ASSERT(jackClient != nullptr);
  359. }
  360. else
  361. {
  362. CARLA_SAFE_ASSERT(jackClient == nullptr);
  363. }
  364. }
  365. ~CarlaEngineJackClient() noexcept override
  366. {
  367. carla_debug("CarlaEngineJackClient::~CarlaEngineJackClient()");
  368. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS && fJackClient != nullptr) // FIXME
  369. jackbridge_client_close(fJackClient);
  370. // ports must have been deleted by now!
  371. //fAudioPorts.clear();
  372. //fCVPorts.clear();
  373. //fEventPorts.clear();
  374. }
  375. void activate() noexcept override
  376. {
  377. carla_debug("CarlaEngineJackClient::activate()");
  378. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  379. {
  380. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr && ! isActive(),);
  381. try {
  382. jackbridge_activate(fJackClient);
  383. } catch(...) {}
  384. }
  385. CarlaEngineClient::activate();
  386. }
  387. void deactivate() noexcept override
  388. {
  389. carla_debug("CarlaEngineJackClient::deactivate()");
  390. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  391. {
  392. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr && isActive(),);
  393. try {
  394. jackbridge_deactivate(fJackClient);
  395. } catch(...) {}
  396. }
  397. CarlaEngineClient::deactivate();
  398. }
  399. bool isOk() const noexcept override
  400. {
  401. if (fUseClient)
  402. return (fJackClient != nullptr);
  403. return CarlaEngineClient::isOk();
  404. }
  405. CarlaEnginePort* addPort(const EnginePortType portType, const char* const name, const bool isInput) override
  406. {
  407. carla_debug("CarlaEngineJackClient::addPort(%i:%s, \"%s\", %s)", portType, EnginePortType2Str(portType), name, bool2str(isInput));
  408. jack_port_t* jackPort = nullptr;
  409. const char* realName = name;
  410. // Create JACK port first, if needed
  411. if (fUseClient && fJackClient != nullptr)
  412. {
  413. realName = _getUniquePortName(name);
  414. switch (portType)
  415. {
  416. case kEnginePortTypeNull:
  417. break;
  418. case kEnginePortTypeAudio:
  419. jackPort = jackbridge_port_register(fJackClient, realName, JACK_DEFAULT_AUDIO_TYPE, isInput ? JackPortIsInput : JackPortIsOutput, 0);
  420. break;
  421. case kEnginePortTypeCV:
  422. jackPort = jackbridge_port_register(fJackClient, realName, JACK_DEFAULT_AUDIO_TYPE, isInput ? JackPortIsInput : JackPortIsOutput, 0);
  423. break;
  424. case kEnginePortTypeEvent:
  425. jackPort = jackbridge_port_register(fJackClient, realName, JACK_DEFAULT_MIDI_TYPE, isInput ? JackPortIsInput : JackPortIsOutput, 0);
  426. break;
  427. }
  428. CARLA_SAFE_ASSERT_RETURN(jackPort != nullptr, nullptr);
  429. }
  430. // Create Engine port
  431. switch (portType)
  432. {
  433. case kEnginePortTypeNull:
  434. break;
  435. case kEnginePortTypeAudio: {
  436. _addAudioPortName(isInput, realName);
  437. if (realName != name) delete[] realName;
  438. CarlaEngineJackAudioPort* const enginePort(new CarlaEngineJackAudioPort(*this, isInput, fJackClient, jackPort, this));
  439. fAudioPorts.append(enginePort);
  440. return enginePort;
  441. }
  442. case kEnginePortTypeCV: {
  443. _addCVPortName(isInput, realName);
  444. if (realName != name) delete[] realName;
  445. CarlaEngineJackCVPort* const enginePort(new CarlaEngineJackCVPort(*this, isInput, fJackClient, jackPort, this));
  446. fCVPorts.append(enginePort);
  447. return enginePort;
  448. }
  449. case kEnginePortTypeEvent: {
  450. _addEventPortName(isInput, realName);
  451. if (realName != name) delete[] realName;
  452. CarlaEngineJackEventPort* const enginePort(new CarlaEngineJackEventPort(*this, isInput, fJackClient, jackPort, this));
  453. fEventPorts.append(enginePort);
  454. return enginePort;
  455. }
  456. }
  457. carla_stderr("CarlaEngineJackClient::addPort(%i, \"%s\", %s) - invalid type", portType, name, bool2str(isInput));
  458. return nullptr;
  459. }
  460. void invalidate() noexcept
  461. {
  462. for (LinkedList<CarlaEngineJackAudioPort*>::Itenerator it = fAudioPorts.begin(); it.valid(); it.next())
  463. {
  464. CarlaEngineJackAudioPort* const port(it.getValue(nullptr));
  465. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  466. port->invalidate();
  467. }
  468. for (LinkedList<CarlaEngineJackCVPort*>::Itenerator it = fCVPorts.begin(); it.valid(); it.next())
  469. {
  470. CarlaEngineJackCVPort* const port(it.getValue(nullptr));
  471. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  472. port->invalidate();
  473. }
  474. for (LinkedList<CarlaEngineJackEventPort*>::Itenerator it = fEventPorts.begin(); it.valid(); it.next())
  475. {
  476. CarlaEngineJackEventPort* const port(it.getValue(nullptr));
  477. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  478. port->invalidate();
  479. }
  480. fJackClient = nullptr;
  481. CarlaEngineClient::deactivate();
  482. }
  483. const char* getJackClientName() const noexcept
  484. {
  485. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr, nullptr);
  486. try {
  487. return jackbridge_get_client_name(fJackClient);
  488. } CARLA_SAFE_EXCEPTION_RETURN("jack_get_client_name", nullptr);
  489. }
  490. void jackAudioPortDeleted(CarlaEngineJackAudioPort* const port) noexcept override
  491. {
  492. fAudioPorts.removeAll(port);
  493. }
  494. void jackCVPortDeleted(CarlaEngineJackCVPort* const port) noexcept override
  495. {
  496. fCVPorts.removeAll(port);
  497. }
  498. void jackEventPortDeleted(CarlaEngineJackEventPort* const port) noexcept override
  499. {
  500. fEventPorts.removeAll(port);
  501. }
  502. private:
  503. jack_client_t* fJackClient;
  504. const bool fUseClient;
  505. LinkedList<CarlaEngineJackAudioPort*> fAudioPorts;
  506. LinkedList<CarlaEngineJackCVPort*> fCVPorts;
  507. LinkedList<CarlaEngineJackEventPort*> fEventPorts;
  508. friend class CarlaEngineJack;
  509. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackClient)
  510. };
  511. // -----------------------------------------------------------------------
  512. // Jack Engine
  513. class CarlaEngineJack : public CarlaEngine
  514. {
  515. public:
  516. CarlaEngineJack()
  517. : CarlaEngine(),
  518. fClient(nullptr),
  519. fTransportPos(),
  520. fTransportState(JackTransportStopped),
  521. fExternalPatchbay(true),
  522. fFreewheel(false),
  523. #ifdef BUILD_BRIDGE
  524. fIsRunning(false),
  525. #else
  526. fUsedGroups(),
  527. fUsedPorts(),
  528. fUsedConnections(),
  529. fNewGroups(),
  530. fRetConns(),
  531. #endif
  532. leakDetector_CarlaEngineJack()
  533. {
  534. carla_debug("CarlaEngineJack::CarlaEngineJack()");
  535. #ifdef BUILD_BRIDGE
  536. pData->options.processMode = ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS;
  537. #else
  538. carla_fill<jack_port_t*>(fRackPorts, nullptr, kRackPortCount);
  539. #endif
  540. // FIXME: Always enable JACK transport for now
  541. pData->options.transportMode = ENGINE_TRANSPORT_MODE_JACK;
  542. carla_zeroStruct<jack_position_t>(fTransportPos);
  543. }
  544. ~CarlaEngineJack() noexcept override
  545. {
  546. carla_debug("CarlaEngineJack::~CarlaEngineJack()");
  547. CARLA_SAFE_ASSERT(fClient == nullptr);
  548. #ifndef BUILD_BRIDGE
  549. fUsedGroups.clear();
  550. fUsedPorts.clear();
  551. fUsedConnections.clear();
  552. fNewGroups.clear();
  553. #endif
  554. }
  555. // -------------------------------------------------------------------
  556. // Maximum values
  557. uint getMaxClientNameSize() const noexcept override
  558. {
  559. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT || pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  560. {
  561. try {
  562. return static_cast<uint>(jackbridge_client_name_size());
  563. } CARLA_SAFE_EXCEPTION_RETURN("jack_client_name_size", 0);
  564. }
  565. return CarlaEngine::getMaxClientNameSize();
  566. }
  567. uint getMaxPortNameSize() const noexcept override
  568. {
  569. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT || pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  570. {
  571. try {
  572. return static_cast<uint>(jackbridge_port_name_size());
  573. } CARLA_SAFE_EXCEPTION_RETURN("jack_port_name_size", 0);
  574. }
  575. return CarlaEngine::getMaxPortNameSize();
  576. }
  577. // -------------------------------------------------------------------
  578. // Virtual, per-engine type calls
  579. bool init(const char* const clientName) override
  580. {
  581. CARLA_SAFE_ASSERT_RETURN(fClient == nullptr, false);
  582. CARLA_SAFE_ASSERT_RETURN(clientName != nullptr && clientName[0] != '\0', false);
  583. CARLA_SAFE_ASSERT_RETURN(jackbridge_is_ok(), false);
  584. carla_debug("CarlaEngineJack::init(\"%s\")", clientName);
  585. fFreewheel = false;
  586. fTransportState = JackTransportStopped;
  587. fExternalPatchbay = true;
  588. carla_zeroStruct<jack_position_t>(fTransportPos);
  589. #ifdef BUILD_BRIDGE
  590. fIsRunning = true;
  591. if (! pData->init(clientName))
  592. {
  593. close();
  594. setLastError("Failed to init internal data");
  595. return false;
  596. }
  597. if (pData->bufferSize == 0 || carla_compareFloats(pData->sampleRate, 0.0))
  598. {
  599. // open temp client to get initial buffer-size and sample-rate values
  600. if (jack_client_t* const tmpClient = jackbridge_client_open(clientName, JackNoStartServer, nullptr))
  601. {
  602. pData->bufferSize = jackbridge_get_buffer_size(tmpClient);
  603. pData->sampleRate = jackbridge_get_sample_rate(tmpClient);
  604. jackbridge_client_close(tmpClient);
  605. }
  606. else
  607. {
  608. close();
  609. setLastError("Failed to init temporary jack client");
  610. return false;
  611. }
  612. }
  613. return true;
  614. #else
  615. fClient = jackbridge_client_open(clientName, JackNullOption, nullptr);
  616. if (fClient == nullptr)
  617. {
  618. setLastError("Failed to create new JACK client");
  619. return false;
  620. }
  621. const char* const jackClientName(jackbridge_get_client_name(fClient));
  622. if (! pData->init(jackClientName))
  623. {
  624. jackbridge_client_close(fClient);
  625. fClient = nullptr;
  626. setLastError("Failed to init internal data");
  627. return false;
  628. }
  629. pData->bufferSize = jackbridge_get_buffer_size(fClient);
  630. pData->sampleRate = jackbridge_get_sample_rate(fClient);
  631. jackbridge_set_thread_init_callback(fClient, carla_jack_thread_init_callback, nullptr);
  632. jackbridge_set_buffer_size_callback(fClient, carla_jack_bufsize_callback, this);
  633. jackbridge_set_sample_rate_callback(fClient, carla_jack_srate_callback, this);
  634. jackbridge_set_freewheel_callback(fClient, carla_jack_freewheel_callback, this);
  635. jackbridge_set_latency_callback(fClient, carla_jack_latency_callback, this);
  636. jackbridge_set_process_callback(fClient, carla_jack_process_callback, this);
  637. jackbridge_on_shutdown(fClient, carla_jack_shutdown_callback, this);
  638. if (pData->options.processMode != ENGINE_PROCESS_MODE_PATCHBAY)
  639. initJackPatchbay(jackClientName);
  640. jackbridge_set_client_registration_callback(fClient, carla_jack_client_registration_callback, this);
  641. jackbridge_set_port_registration_callback(fClient, carla_jack_port_registration_callback, this);
  642. jackbridge_set_port_connect_callback(fClient, carla_jack_port_connect_callback, this);
  643. jackbridge_set_port_rename_callback(fClient, carla_jack_port_rename_callback, this);
  644. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  645. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  646. {
  647. fRackPorts[kRackPortAudioIn1] = jackbridge_port_register(fClient, "audio-in1", JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
  648. fRackPorts[kRackPortAudioIn2] = jackbridge_port_register(fClient, "audio-in2", JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
  649. fRackPorts[kRackPortAudioOut1] = jackbridge_port_register(fClient, "audio-out1", JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
  650. fRackPorts[kRackPortAudioOut2] = jackbridge_port_register(fClient, "audio-out2", JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
  651. fRackPorts[kRackPortEventIn] = jackbridge_port_register(fClient, "events-in", JACK_DEFAULT_MIDI_TYPE, JackPortIsInput, 0);
  652. fRackPorts[kRackPortEventOut] = jackbridge_port_register(fClient, "events-out", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
  653. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  654. {
  655. pData->graph.create(true, pData->sampleRate, pData->bufferSize, 0, 0);
  656. }
  657. else
  658. {
  659. pData->graph.create(false, pData->sampleRate, pData->bufferSize, 2, 2);
  660. patchbayRefresh(false);
  661. }
  662. }
  663. if (jackbridge_activate(fClient))
  664. {
  665. callback(ENGINE_CALLBACK_ENGINE_STARTED, 0, pData->options.processMode, pData->options.transportMode, 0.0f, getCurrentDriverName());
  666. return true;
  667. }
  668. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  669. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  670. {
  671. pData->graph.destroy();
  672. }
  673. pData->close();
  674. jackbridge_client_close(fClient);
  675. fClient = nullptr;
  676. setLastError("Failed to activate the JACK client");
  677. return false;
  678. #endif
  679. }
  680. bool close() override
  681. {
  682. carla_debug("CarlaEngineJack::close()");
  683. #ifdef BUILD_BRIDGE
  684. fClient = nullptr;
  685. fIsRunning = false;
  686. CarlaEngine::close();
  687. return true;
  688. #else
  689. CARLA_SAFE_ASSERT_RETURN_ERR(fClient != nullptr, "JACK Client is null");
  690. // deactivate first
  691. const bool deactivated(jackbridge_deactivate(fClient));
  692. // clear engine data
  693. CarlaEngine::close();
  694. fUsedGroups.clear();
  695. fUsedPorts.clear();
  696. fUsedConnections.clear();
  697. fNewGroups.clear();
  698. // clear rack/patchbay stuff
  699. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  700. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  701. {
  702. if (deactivated)
  703. {
  704. jackbridge_port_unregister(fClient, fRackPorts[kRackPortAudioIn1]);
  705. jackbridge_port_unregister(fClient, fRackPorts[kRackPortAudioIn2]);
  706. jackbridge_port_unregister(fClient, fRackPorts[kRackPortAudioOut1]);
  707. jackbridge_port_unregister(fClient, fRackPorts[kRackPortAudioOut2]);
  708. jackbridge_port_unregister(fClient, fRackPorts[kRackPortEventIn]);
  709. jackbridge_port_unregister(fClient, fRackPorts[kRackPortEventOut]);
  710. }
  711. carla_fill<jack_port_t*>(fRackPorts, nullptr, kRackPortCount);
  712. pData->graph.destroy();
  713. }
  714. // close client
  715. if (deactivated)
  716. jackbridge_client_close(fClient);
  717. fClient = nullptr;
  718. return true;
  719. #endif
  720. }
  721. #ifndef BUILD_BRIDGE
  722. void idle() noexcept override
  723. {
  724. CarlaEngine::idle();
  725. if (fNewGroups.count() == 0)
  726. return;
  727. LinkedList<uint> newPlugins;
  728. fNewGroups.moveTo(newPlugins);
  729. for (LinkedList<uint>::Itenerator it = newPlugins.begin(); it.valid(); it.next())
  730. {
  731. const uint groupId(it.getValue(0));
  732. CARLA_SAFE_ASSERT_CONTINUE(groupId > 0);
  733. const char* const groupName(fUsedGroups.getGroupName(groupId));
  734. CARLA_SAFE_ASSERT_CONTINUE(groupName != nullptr && groupName[0] != '\0');
  735. int pluginId = -1;
  736. PatchbayIcon icon = PATCHBAY_ICON_PLUGIN;
  737. if (findPluginIdAndIcon(groupName, pluginId, icon))
  738. callback(ENGINE_CALLBACK_PATCHBAY_CLIENT_DATA_CHANGED, groupId, icon, pluginId, 0.0f, nullptr);
  739. }
  740. newPlugins.clear();
  741. }
  742. #endif
  743. bool isRunning() const noexcept override
  744. {
  745. #ifdef BUILD_BRIDGE
  746. return (fClient != nullptr || fIsRunning);
  747. #else
  748. return (fClient != nullptr);
  749. #endif
  750. }
  751. bool isOffline() const noexcept override
  752. {
  753. return fFreewheel;
  754. }
  755. EngineType getType() const noexcept override
  756. {
  757. return kEngineTypeJack;
  758. }
  759. const char* getCurrentDriverName() const noexcept override
  760. {
  761. return "JACK";
  762. }
  763. CarlaEngineClient* addClient(CarlaPlugin* const plugin) override
  764. {
  765. jack_client_t* client = nullptr;
  766. #ifndef BUILD_BRIDGE
  767. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  768. {
  769. client = fClient;
  770. }
  771. else if (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  772. #endif
  773. {
  774. client = jackbridge_client_open(plugin->getName(), JackNullOption, nullptr);
  775. CARLA_SAFE_ASSERT_RETURN(client != nullptr, nullptr);
  776. jackbridge_set_thread_init_callback(client, carla_jack_thread_init_callback, nullptr);
  777. #ifndef BUILD_BRIDGE
  778. jackbridge_set_latency_callback(client, carla_jack_latency_callback_plugin, plugin);
  779. jackbridge_set_process_callback(client, carla_jack_process_callback_plugin, plugin);
  780. jackbridge_on_shutdown(client, carla_jack_shutdown_callback_plugin, plugin);
  781. #else
  782. fClient = client;
  783. pData->bufferSize = jackbridge_get_buffer_size(client);
  784. pData->sampleRate = jackbridge_get_sample_rate(client);
  785. jackbridge_set_buffer_size_callback(client, carla_jack_bufsize_callback, this);
  786. jackbridge_set_sample_rate_callback(client, carla_jack_srate_callback, this);
  787. jackbridge_set_freewheel_callback(client, carla_jack_freewheel_callback, this);
  788. jackbridge_set_latency_callback(client, carla_jack_latency_callback, this);
  789. jackbridge_set_process_callback(client, carla_jack_process_callback, this);
  790. jackbridge_on_shutdown(client, carla_jack_shutdown_callback, this);
  791. #endif
  792. }
  793. return new CarlaEngineJackClient(*this, client);
  794. }
  795. #ifndef BUILD_BRIDGE
  796. const char* renamePlugin(const uint id, const char* const newName) override
  797. {
  798. CARLA_SAFE_ASSERT_RETURN(pData->curPluginCount > 0, nullptr);
  799. CARLA_SAFE_ASSERT_RETURN(id < pData->curPluginCount, nullptr);
  800. CARLA_SAFE_ASSERT_RETURN(pData->plugins != nullptr, nullptr);
  801. CARLA_SAFE_ASSERT_RETURN(newName != nullptr && newName[0] != '\0', nullptr);
  802. CarlaPlugin* const plugin(pData->plugins[id].plugin);
  803. if (plugin == nullptr)
  804. {
  805. carla_stderr("CarlaEngine::clonePlugin(%i) - could not find plugin", id);
  806. return nullptr;
  807. }
  808. CARLA_SAFE_ASSERT(plugin->getId() == id);
  809. CarlaString uniqueName;
  810. try {
  811. const char* const tmpName = getUniquePluginName(newName);
  812. uniqueName = tmpName;
  813. delete[] tmpName;
  814. } CARLA_SAFE_EXCEPTION("JACK renamePlugin");
  815. if (uniqueName.isEmpty())
  816. {
  817. setLastError("Failed to request new unique plugin name");
  818. return nullptr;
  819. }
  820. // single client always re-inits
  821. bool needsReinit = (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT);
  822. // rename in multiple client mode
  823. if (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  824. {
  825. CarlaEngineJackClient* const client((CarlaEngineJackClient*)plugin->getEngineClient());
  826. #if 0
  827. if (bridge.client_rename_ptr != nullptr)
  828. {
  829. newName = jackbridge_client_rename(client->fClient, newName);
  830. }
  831. else
  832. #endif
  833. {
  834. // we should not be able to do this, jack really needs to allow client rename
  835. if (jack_client_t* const jackClient = jackbridge_client_open(uniqueName, JackNullOption, nullptr))
  836. {
  837. // close old client
  838. plugin->setEnabled(false);
  839. if (client->isActive())
  840. client->deactivate();
  841. plugin->clearBuffers();
  842. jackbridge_client_close(client->fJackClient);
  843. // set new client data
  844. uniqueName = jackbridge_get_client_name(jackClient);
  845. jackbridge_set_thread_init_callback(jackClient, carla_jack_thread_init_callback, nullptr);
  846. jackbridge_set_process_callback(jackClient, carla_jack_process_callback_plugin, plugin);
  847. jackbridge_set_latency_callback(jackClient, carla_jack_latency_callback_plugin, plugin);
  848. jackbridge_on_shutdown(jackClient, carla_jack_shutdown_callback_plugin, plugin);
  849. client->fJackClient = jackClient;
  850. needsReinit = true;
  851. }
  852. else
  853. {
  854. setLastError("Failed to create new JACK client");
  855. return nullptr;
  856. }
  857. }
  858. }
  859. // Rename
  860. plugin->setName(uniqueName);
  861. if (needsReinit)
  862. {
  863. // reload plugin to recreate its ports
  864. const CarlaStateSave& saveState(plugin->getStateSave());
  865. plugin->reload();
  866. plugin->loadStateSave(saveState);
  867. }
  868. return plugin->getName();
  869. }
  870. // -------------------------------------------------------------------
  871. // Patchbay
  872. bool patchbayConnect(const uint groupA, const uint portA, const uint groupB, const uint portB) override
  873. {
  874. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  875. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! fExternalPatchbay)
  876. return CarlaEngine::patchbayConnect(groupA, portA, groupB, portB);
  877. const char* const fullPortNameA = fUsedPorts.getFullPortName(groupA, portA);
  878. CARLA_SAFE_ASSERT_RETURN(fullPortNameA != nullptr && fullPortNameA[0] != '\0', false);
  879. const char* const fullPortNameB = fUsedPorts.getFullPortName(groupB, portB);
  880. CARLA_SAFE_ASSERT_RETURN(fullPortNameB != nullptr && fullPortNameB[0] != '\0', false);
  881. carla_stdout("patchbayConnect(%u, %u, %u, %u => %s, %s)", groupA, portA, groupB, portB, fullPortNameA, fullPortNameB);
  882. if (! jackbridge_connect(fClient, fullPortNameA, fullPortNameB))
  883. {
  884. setLastError("JACK operation failed");
  885. return false;
  886. }
  887. return true;
  888. }
  889. bool patchbayDisconnect(const uint connectionId) override
  890. {
  891. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  892. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! fExternalPatchbay)
  893. return CarlaEngine::patchbayDisconnect(connectionId);
  894. for (LinkedList<ConnectionToId>::Itenerator it = fUsedConnections.list.begin(); it.valid(); it.next())
  895. {
  896. static const ConnectionToId fallback = { 0, 0, 0, 0, 0 };
  897. const ConnectionToId& connectionToId(it.getValue(fallback));
  898. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  899. if (connectionToId.id == connectionId)
  900. {
  901. const char* const fullPortNameA = fUsedPorts.getFullPortName(connectionToId.groupA, connectionToId.portA);
  902. CARLA_SAFE_ASSERT_RETURN(fullPortNameA != nullptr && fullPortNameA[0] != '\0', false);
  903. const char* const fullPortNameB = fUsedPorts.getFullPortName(connectionToId.groupB, connectionToId.portB);
  904. CARLA_SAFE_ASSERT_RETURN(fullPortNameB != nullptr && fullPortNameB[0] != '\0', false);
  905. if (! jackbridge_disconnect(fClient, fullPortNameA, fullPortNameB))
  906. {
  907. setLastError("JACK operation failed");
  908. return false;
  909. }
  910. return true;
  911. }
  912. }
  913. setLastError("Failed to find the requested connection");
  914. return false;
  915. }
  916. bool patchbayRefresh(const bool external) override
  917. {
  918. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  919. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  920. {
  921. fExternalPatchbay = external;
  922. pData->graph.setIgnorePatchbay(external);
  923. if (! external)
  924. return CarlaEngine::patchbayRefresh(false);
  925. }
  926. fUsedGroups.clear();
  927. fUsedPorts.clear();
  928. fUsedConnections.clear();
  929. fNewGroups.clear();
  930. initJackPatchbay(jackbridge_get_client_name(fClient));
  931. return true;
  932. }
  933. // -------------------------------------------------------------------
  934. // Transport
  935. void transportPlay() noexcept override
  936. {
  937. if (pData->options.transportMode == ENGINE_TRANSPORT_MODE_INTERNAL)
  938. return CarlaEngine::transportPlay();
  939. if (fClient != nullptr)
  940. {
  941. try {
  942. jackbridge_transport_start(fClient);
  943. } catch(...) {}
  944. }
  945. }
  946. void transportPause() noexcept override
  947. {
  948. if (pData->options.transportMode == ENGINE_TRANSPORT_MODE_INTERNAL)
  949. return CarlaEngine::transportPause();
  950. if (fClient != nullptr)
  951. {
  952. try {
  953. jackbridge_transport_stop(fClient);
  954. } catch(...) {}
  955. }
  956. }
  957. void transportRelocate(const uint64_t frame) noexcept override
  958. {
  959. if (pData->options.transportMode == ENGINE_TRANSPORT_MODE_INTERNAL)
  960. return CarlaEngine::transportRelocate(frame);
  961. if (fClient != nullptr)
  962. {
  963. try {
  964. jackbridge_transport_locate(fClient, static_cast<jack_nframes_t>(frame));
  965. } catch(...) {}
  966. }
  967. }
  968. // -------------------------------------------------------------------
  969. // Patchbay stuff
  970. const char* const* getPatchbayConnections() const override
  971. {
  972. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, nullptr);
  973. carla_debug("CarlaEngineJack::getPatchbayConnections()");
  974. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  975. return CarlaEngine::getPatchbayConnections();
  976. CarlaStringList connList;
  977. if (const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, JackPortIsOutput))
  978. {
  979. for (int i=0; ports[i] != nullptr; ++i)
  980. {
  981. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, ports[i]));
  982. const char* const fullPortName(ports[i]);
  983. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  984. if (const char** const connections = jackbridge_port_get_all_connections(fClient, jackPort))
  985. {
  986. for (int j=0; connections[j] != nullptr; ++j)
  987. {
  988. connList.append(fullPortName);
  989. connList.append(connections[j]);
  990. }
  991. jackbridge_free(connections);
  992. }
  993. }
  994. jackbridge_free(ports);
  995. }
  996. if (connList.count() == 0)
  997. return nullptr;
  998. fRetConns = connList.toCharStringListPtr();
  999. return fRetConns;
  1000. }
  1001. void restorePatchbayConnection(const char* const connSource, const char* const connTarget) override
  1002. {
  1003. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr,);
  1004. CARLA_SAFE_ASSERT_RETURN(connSource != nullptr && connSource[0] != '\0',);
  1005. CARLA_SAFE_ASSERT_RETURN(connTarget != nullptr && connTarget[0] != '\0',);
  1006. carla_debug("CarlaEngineJack::restorePatchbayConnection(\"%s\", \"%s\")", connSource, connTarget);
  1007. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1008. return CarlaEngine::restorePatchbayConnection(connSource, connTarget);
  1009. if (const jack_port_t* const port = jackbridge_port_by_name(fClient, connSource))
  1010. {
  1011. if (jackbridge_port_by_name(fClient, connTarget) == nullptr)
  1012. return;
  1013. if (! jackbridge_port_connected_to(port, connTarget))
  1014. jackbridge_connect(fClient, connSource, connTarget);
  1015. }
  1016. }
  1017. #endif
  1018. // -------------------------------------------------------------------
  1019. protected:
  1020. void handleJackBufferSizeCallback(const uint32_t newBufferSize)
  1021. {
  1022. if (pData->bufferSize == newBufferSize)
  1023. return;
  1024. pData->bufferSize = newBufferSize;
  1025. bufferSizeChanged(newBufferSize);
  1026. }
  1027. void handleJackSampleRateCallback(const double newSampleRate)
  1028. {
  1029. if (carla_compareFloats(pData->sampleRate, newSampleRate))
  1030. return;
  1031. pData->sampleRate = newSampleRate;
  1032. sampleRateChanged(newSampleRate);
  1033. }
  1034. void handleJackFreewheelCallback(const bool isFreewheel)
  1035. {
  1036. if (fFreewheel == isFreewheel)
  1037. return;
  1038. fFreewheel = isFreewheel;
  1039. offlineModeChanged(isFreewheel);
  1040. }
  1041. void saveTransportInfo()
  1042. {
  1043. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  1044. return;
  1045. fTransportPos.unique_1 = fTransportPos.unique_2 + 1; // invalidate
  1046. fTransportState = jackbridge_transport_query(fClient, &fTransportPos);
  1047. pData->timeInfo.playing = (fTransportState == JackTransportRolling);
  1048. if (fTransportPos.unique_1 == fTransportPos.unique_2)
  1049. {
  1050. pData->timeInfo.frame = fTransportPos.frame;
  1051. pData->timeInfo.usecs = fTransportPos.usecs;
  1052. if (fTransportPos.valid & JackPositionBBT)
  1053. {
  1054. pData->timeInfo.valid = EngineTimeInfo::kValidBBT;
  1055. pData->timeInfo.bbt.bar = fTransportPos.bar;
  1056. pData->timeInfo.bbt.beat = fTransportPos.beat;
  1057. pData->timeInfo.bbt.tick = fTransportPos.tick;
  1058. pData->timeInfo.bbt.barStartTick = fTransportPos.bar_start_tick;
  1059. pData->timeInfo.bbt.beatsPerBar = fTransportPos.beats_per_bar;
  1060. pData->timeInfo.bbt.beatType = fTransportPos.beat_type;
  1061. pData->timeInfo.bbt.ticksPerBeat = fTransportPos.ticks_per_beat;
  1062. pData->timeInfo.bbt.beatsPerMinute = fTransportPos.beats_per_minute;
  1063. }
  1064. else
  1065. pData->timeInfo.valid = 0x0;
  1066. }
  1067. else
  1068. {
  1069. pData->timeInfo.frame = 0;
  1070. pData->timeInfo.valid = 0x0;
  1071. }
  1072. }
  1073. void handleJackProcessCallback(const uint32_t nframes)
  1074. {
  1075. const PendingRtEventsRunner prt(this);
  1076. saveTransportInfo();
  1077. #ifdef BUILD_BRIDGE
  1078. CarlaPlugin* const plugin(pData->plugins[0].plugin);
  1079. if (plugin != nullptr && plugin->isEnabled() && plugin->tryLock(fFreewheel))
  1080. {
  1081. plugin->initBuffers();
  1082. processPlugin(plugin, nframes);
  1083. plugin->unlock();
  1084. }
  1085. #else
  1086. if (pData->curPluginCount == 0 && pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  1087. {
  1088. // pass-through
  1089. // TODO MIDI as well
  1090. float* const audioIn1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn1], nframes);
  1091. float* const audioIn2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn2], nframes);
  1092. float* const audioOut1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut1], nframes);
  1093. float* const audioOut2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut2], nframes);
  1094. void* const eventOut = jackbridge_port_get_buffer(fRackPorts[kRackPortEventOut], nframes);
  1095. FloatVectorOperations::copy(audioOut1, audioIn1, static_cast<int>(nframes));
  1096. FloatVectorOperations::copy(audioOut2, audioIn2, static_cast<int>(nframes));
  1097. jackbridge_midi_clear_buffer(eventOut);
  1098. return;
  1099. }
  1100. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  1101. {
  1102. for (uint i=0; i < pData->curPluginCount; ++i)
  1103. {
  1104. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1105. if (plugin != nullptr && plugin->isEnabled() && plugin->tryLock(fFreewheel))
  1106. {
  1107. plugin->initBuffers();
  1108. processPlugin(plugin, nframes);
  1109. plugin->unlock();
  1110. }
  1111. }
  1112. }
  1113. else if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1114. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1115. {
  1116. CARLA_SAFE_ASSERT_RETURN(pData->events.in != nullptr,);
  1117. CARLA_SAFE_ASSERT_RETURN(pData->events.out != nullptr,);
  1118. // get buffers from jack
  1119. float* const audioIn1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn1], nframes);
  1120. float* const audioIn2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn2], nframes);
  1121. float* const audioOut1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut1], nframes);
  1122. float* const audioOut2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut2], nframes);
  1123. void* const eventIn = jackbridge_port_get_buffer(fRackPorts[kRackPortEventIn], nframes);
  1124. void* const eventOut = jackbridge_port_get_buffer(fRackPorts[kRackPortEventOut], nframes);
  1125. #if 1
  1126. // assert buffers
  1127. CARLA_SAFE_ASSERT(audioIn1 != nullptr);
  1128. CARLA_SAFE_ASSERT(audioIn2 != nullptr);
  1129. CARLA_SAFE_ASSERT(audioOut1 != nullptr);
  1130. CARLA_SAFE_ASSERT(audioOut2 != nullptr);
  1131. CARLA_SAFE_ASSERT(eventIn != nullptr);
  1132. CARLA_SAFE_ASSERT(eventOut != nullptr);
  1133. #endif
  1134. // create audio buffers
  1135. const float* inBuf[2] = { audioIn1, audioIn2 };
  1136. /**/ float* outBuf[2] = { audioOut1, audioOut2 };
  1137. // initialize events
  1138. carla_zeroStruct<EngineEvent>(pData->events.in, kMaxEngineEventInternalCount);
  1139. carla_zeroStruct<EngineEvent>(pData->events.out, kMaxEngineEventInternalCount);
  1140. {
  1141. ushort engineEventIndex = 0;
  1142. jack_midi_event_t jackEvent;
  1143. const uint32_t jackEventCount(jackbridge_midi_get_event_count(eventIn));
  1144. for (uint32_t jackEventIndex=0; jackEventIndex < jackEventCount; ++jackEventIndex)
  1145. {
  1146. if (! jackbridge_midi_event_get(&jackEvent, eventIn, jackEventIndex))
  1147. continue;
  1148. CARLA_SAFE_ASSERT_CONTINUE(jackEvent.size <= 0xFF /* uint8_t max */);
  1149. EngineEvent& engineEvent(pData->events.in[engineEventIndex++]);
  1150. engineEvent.time = jackEvent.time;
  1151. engineEvent.fillFromMidiData(static_cast<uint8_t>(jackEvent.size), jackEvent.buffer);
  1152. if (engineEventIndex >= kMaxEngineEventInternalCount)
  1153. break;
  1154. }
  1155. }
  1156. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  1157. pData->graph.processRack(pData, inBuf, outBuf, nframes);
  1158. else
  1159. pData->graph.process(pData, inBuf, outBuf, nframes);
  1160. // output control
  1161. {
  1162. jackbridge_midi_clear_buffer(eventOut);
  1163. uint8_t size = 0;
  1164. uint8_t data[3] = { 0, 0, 0 };
  1165. const uint8_t* dataPtr = data;
  1166. for (ushort i=0; i < kMaxEngineEventInternalCount; ++i)
  1167. {
  1168. const EngineEvent& engineEvent(pData->events.out[i]);
  1169. if (engineEvent.type == kEngineEventTypeNull)
  1170. break;
  1171. else if (engineEvent.type == kEngineEventTypeControl)
  1172. {
  1173. const EngineControlEvent& ctrlEvent(engineEvent.ctrl);
  1174. ctrlEvent.convertToMidiData(engineEvent.channel, size, data);
  1175. dataPtr = data;
  1176. }
  1177. else if (engineEvent.type == kEngineEventTypeMidi)
  1178. {
  1179. const EngineMidiEvent& midiEvent(engineEvent.midi);
  1180. size = midiEvent.size;
  1181. if (size > EngineMidiEvent::kDataSize && midiEvent.dataExt != nullptr)
  1182. dataPtr = midiEvent.dataExt;
  1183. else
  1184. dataPtr = midiEvent.data;
  1185. }
  1186. else
  1187. {
  1188. continue;
  1189. }
  1190. if (size > 0)
  1191. jackbridge_midi_event_write(eventOut, engineEvent.time, dataPtr, size);
  1192. }
  1193. }
  1194. }
  1195. #endif // ! BUILD_BRIDGE
  1196. }
  1197. void handleJackLatencyCallback(const jack_latency_callback_mode_t /*mode*/)
  1198. {
  1199. // TODO
  1200. }
  1201. #ifndef BUILD_BRIDGE
  1202. void handleJackClientRegistrationCallback(const char* const name, const bool reg)
  1203. {
  1204. CARLA_SAFE_ASSERT_RETURN(name != nullptr && name[0] != '\0',);
  1205. // ignore this if on internal patchbay mode
  1206. if (! fExternalPatchbay) return;
  1207. // do nothing on client registration, wait for first port
  1208. if (reg) return;
  1209. const uint groupId(fUsedGroups.getGroupId(name));
  1210. // clients might have been registered without ports
  1211. if (groupId == 0) return;
  1212. GroupNameToId groupNameToId;
  1213. groupNameToId.setData(groupId, name);
  1214. callback(ENGINE_CALLBACK_PATCHBAY_CLIENT_REMOVED, groupNameToId.group, 0, 0, 0.0f, nullptr);
  1215. fUsedGroups.list.removeOne(groupNameToId);
  1216. }
  1217. void handleJackPortRegistrationCallback(const jack_port_id_t port, const bool reg)
  1218. {
  1219. // ignore this if on internal patchbay mode
  1220. if (! fExternalPatchbay) return;
  1221. const jack_port_t* const jackPort(jackbridge_port_by_id(fClient, port));
  1222. CARLA_SAFE_ASSERT_RETURN(jackPort != nullptr,);
  1223. const char* const fullPortName(jackbridge_port_name(jackPort));
  1224. CARLA_SAFE_ASSERT_RETURN(fullPortName != nullptr && fullPortName[0] != '\0',);
  1225. if (reg)
  1226. {
  1227. const char* const shortPortName(jackbridge_port_short_name(jackPort));
  1228. CARLA_SAFE_ASSERT_RETURN(shortPortName != nullptr && shortPortName[0] != '\0',);
  1229. bool found;
  1230. CarlaString groupName(fullPortName);
  1231. groupName.truncate(groupName.rfind(shortPortName, &found)-1);
  1232. CARLA_SAFE_ASSERT_RETURN(found,);
  1233. const int jackPortFlags(jackbridge_port_flags(jackPort));
  1234. uint groupId(fUsedGroups.getGroupId(groupName));
  1235. if (groupId == 0)
  1236. {
  1237. groupId = ++fUsedGroups.lastId;
  1238. PatchbayIcon icon = (jackPortFlags & JackPortIsPhysical) ? PATCHBAY_ICON_HARDWARE : PATCHBAY_ICON_APPLICATION;
  1239. GroupNameToId groupNameToId;
  1240. groupNameToId.setData(groupId, groupName);
  1241. callback(ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED, groupNameToId.group, icon, -1, 0.0f, groupNameToId.name);
  1242. fNewGroups.append(groupId);
  1243. fUsedGroups.list.append(groupNameToId);
  1244. }
  1245. addPatchbayJackPort(groupId, jackPort, shortPortName, fullPortName, jackPortFlags);
  1246. }
  1247. else
  1248. {
  1249. const PortNameToId& portNameToId(fUsedPorts.getPortNameToId(fullPortName));
  1250. CARLA_SAFE_ASSERT_RETURN(portNameToId.group > 0 && portNameToId.port > 0,);
  1251. callback(ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED, portNameToId.group, static_cast<int>(portNameToId.port), 0, 0.0f, nullptr);
  1252. fUsedPorts.list.removeOne(portNameToId);
  1253. }
  1254. }
  1255. void handleJackPortConnectCallback(const jack_port_id_t a, const jack_port_id_t b, const bool connect)
  1256. {
  1257. // ignore this if on internal patchbay mode
  1258. if (! fExternalPatchbay) return;
  1259. const jack_port_t* const jackPortA(jackbridge_port_by_id(fClient, a));
  1260. CARLA_SAFE_ASSERT_RETURN(jackPortA != nullptr,);
  1261. const jack_port_t* const jackPortB(jackbridge_port_by_id(fClient, b));
  1262. CARLA_SAFE_ASSERT_RETURN(jackPortB != nullptr,);
  1263. const char* const fullPortNameA(jackbridge_port_name(jackPortA));
  1264. CARLA_SAFE_ASSERT_RETURN(fullPortNameA != nullptr && fullPortNameA[0] != '\0',);
  1265. const char* const fullPortNameB(jackbridge_port_name(jackPortB));
  1266. CARLA_SAFE_ASSERT_RETURN(fullPortNameB != nullptr && fullPortNameB[0] != '\0',);
  1267. const PortNameToId& portNameToIdA(fUsedPorts.getPortNameToId(fullPortNameA));
  1268. CARLA_SAFE_ASSERT_RETURN(portNameToIdA.group > 0 && portNameToIdA.port > 0,);
  1269. const PortNameToId& portNameToIdB(fUsedPorts.getPortNameToId(fullPortNameB));
  1270. CARLA_SAFE_ASSERT_RETURN(portNameToIdB.group > 0 && portNameToIdB.port > 0,);
  1271. if (connect)
  1272. {
  1273. char strBuf[STR_MAX+1];
  1274. std::snprintf(strBuf, STR_MAX, "%i:%i:%i:%i", portNameToIdA.group, portNameToIdA.port, portNameToIdB.group, portNameToIdB.port);
  1275. strBuf[STR_MAX] = '\0';
  1276. ConnectionToId connectionToId;
  1277. connectionToId.setData(++fUsedConnections.lastId, portNameToIdA.group, portNameToIdA.port, portNameToIdB.group, portNameToIdB.port);
  1278. callback(ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED, connectionToId.id, 0, 0, 0.0f, strBuf);
  1279. fUsedConnections.list.append(connectionToId);
  1280. }
  1281. else
  1282. {
  1283. for (LinkedList<ConnectionToId>::Itenerator it = fUsedConnections.list.begin(); it.valid(); it.next())
  1284. {
  1285. static const ConnectionToId fallback = { 0, 0, 0, 0, 0 };
  1286. const ConnectionToId& connectionToId(it.getValue(fallback));
  1287. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  1288. if (connectionToId.groupA == portNameToIdA.group && connectionToId.portA == portNameToIdA.port &&
  1289. connectionToId.groupB == portNameToIdB.group && connectionToId.portB == portNameToIdB.port)
  1290. {
  1291. callback(ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED, connectionToId.id, 0, 0, 0.0f, nullptr);
  1292. fUsedConnections.list.remove(it);
  1293. break;
  1294. }
  1295. }
  1296. }
  1297. }
  1298. void handleJackClientRenameCallback(const char* const oldName, const char* const newName)
  1299. {
  1300. CARLA_SAFE_ASSERT_RETURN(oldName != nullptr && oldName[0] != '\0',);
  1301. CARLA_SAFE_ASSERT_RETURN(newName != nullptr && newName[0] != '\0',);
  1302. // ignore this if on internal patchbay mode
  1303. if (! fExternalPatchbay) return;
  1304. for (LinkedList<GroupNameToId>::Itenerator it = fUsedGroups.list.begin(); it.valid(); it.next())
  1305. {
  1306. static GroupNameToId groupNameFallback = { 0, { '\0' } };
  1307. GroupNameToId& groupNameToId(it.getValue(groupNameFallback));
  1308. CARLA_SAFE_ASSERT_CONTINUE(groupNameToId.group != 0);
  1309. if (std::strncmp(groupNameToId.name, oldName, STR_MAX) == 0)
  1310. {
  1311. groupNameToId.rename(newName);
  1312. callback(ENGINE_CALLBACK_PATCHBAY_CLIENT_RENAMED, groupNameToId.group, 0, 0, 0.0f, groupNameToId.name);
  1313. break;
  1314. }
  1315. }
  1316. }
  1317. void handleJackPortRenameCallback(const jack_port_id_t port, const char* const oldFullName, const char* const newFullName)
  1318. {
  1319. CARLA_SAFE_ASSERT_RETURN(oldFullName != nullptr && oldFullName[0] != '\0',);
  1320. CARLA_SAFE_ASSERT_RETURN(newFullName != nullptr && newFullName[0] != '\0',);
  1321. // ignore this if on internal patchbay mode
  1322. if (! fExternalPatchbay) return;
  1323. const jack_port_t* const jackPort(jackbridge_port_by_id(fClient, port));
  1324. CARLA_SAFE_ASSERT_RETURN(jackPort != nullptr,);
  1325. const char* const shortPortName(jackbridge_port_short_name(jackPort));
  1326. CARLA_SAFE_ASSERT_RETURN(shortPortName != nullptr && shortPortName[0] != '\0',);
  1327. bool found;
  1328. CarlaString groupName(newFullName);
  1329. groupName.truncate(groupName.rfind(shortPortName, &found)-1);
  1330. CARLA_SAFE_ASSERT_RETURN(found,);
  1331. const uint groupId(fUsedGroups.getGroupId(groupName));
  1332. CARLA_SAFE_ASSERT_RETURN(groupId > 0,);
  1333. for (LinkedList<PortNameToId>::Itenerator it = fUsedPorts.list.begin(); it.valid(); it.next())
  1334. {
  1335. static PortNameToId portNameFallback = { 0, 0, { '\0' }, { '\0' } };
  1336. PortNameToId& portNameToId(it.getValue(portNameFallback));
  1337. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group != 0);
  1338. if (std::strncmp(portNameToId.fullName, oldFullName, STR_MAX) == 0)
  1339. {
  1340. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group == groupId);
  1341. portNameToId.rename(shortPortName, newFullName);
  1342. callback(ENGINE_CALLBACK_PATCHBAY_PORT_RENAMED, portNameToId.group, static_cast<int>(portNameToId.port), 0, 0.0f, portNameToId.name);
  1343. break;
  1344. }
  1345. }
  1346. }
  1347. #endif
  1348. void handleJackShutdownCallback()
  1349. {
  1350. for (uint i=0; i < pData->curPluginCount; ++i)
  1351. {
  1352. if (CarlaPlugin* const plugin = pData->plugins[i].plugin)
  1353. {
  1354. plugin->tryLock(true);
  1355. if (CarlaEngineJackClient* const client = (CarlaEngineJackClient*)plugin->getEngineClient())
  1356. client->invalidate();
  1357. plugin->unlock();
  1358. }
  1359. }
  1360. fClient = nullptr;
  1361. #ifndef BUILD_BRIDGE
  1362. carla_fill<jack_port_t*>(fRackPorts, nullptr, kRackPortCount);
  1363. #endif
  1364. runPendingRtEvents();
  1365. callback(ENGINE_CALLBACK_QUIT, 0, 0, 0, 0.0f, nullptr);
  1366. }
  1367. // -------------------------------------------------------------------
  1368. void handlePluginJackShutdownCallback(CarlaPlugin* const plugin)
  1369. {
  1370. CarlaEngineJackClient* const engineClient((CarlaEngineJackClient*)plugin->getEngineClient());
  1371. CARLA_SAFE_ASSERT_RETURN(engineClient != nullptr,);
  1372. plugin->tryLock(true);
  1373. engineClient->invalidate();
  1374. plugin->unlock();
  1375. //if (pData->nextAction.pluginId == plugin->getId())
  1376. // pData->nextAction.clearAndReset();
  1377. callback(ENGINE_CALLBACK_PLUGIN_UNAVAILABLE, plugin->getId(), 0, 0, 0.0f, "Killed by JACK");
  1378. }
  1379. // -------------------------------------------------------------------
  1380. private:
  1381. jack_client_t* fClient;
  1382. jack_position_t fTransportPos;
  1383. jack_transport_state_t fTransportState;
  1384. bool fExternalPatchbay;
  1385. bool fFreewheel;
  1386. // -------------------------------------------------------------------
  1387. #ifdef BUILD_BRIDGE
  1388. bool fIsRunning;
  1389. #else
  1390. enum RackPorts {
  1391. kRackPortAudioIn1 = 0,
  1392. kRackPortAudioIn2 = 1,
  1393. kRackPortAudioOut1 = 2,
  1394. kRackPortAudioOut2 = 3,
  1395. kRackPortEventIn = 4,
  1396. kRackPortEventOut = 5,
  1397. kRackPortCount = 6
  1398. };
  1399. jack_port_t* fRackPorts[kRackPortCount];
  1400. PatchbayGroupList fUsedGroups;
  1401. PatchbayPortList fUsedPorts;
  1402. PatchbayConnectionList fUsedConnections;
  1403. LinkedList<uint> fNewGroups;
  1404. mutable CharStringListPtr fRetConns;
  1405. bool findPluginIdAndIcon(const char* const clientName, int& pluginId, PatchbayIcon& icon) noexcept
  1406. {
  1407. carla_debug("CarlaEngineJack::findPluginIdAndIcon(\"%s\", ...)", clientName);
  1408. // TODO - this currently only works in multi-client mode
  1409. if (pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1410. return false;
  1411. for (uint i=0; i < pData->curPluginCount; ++i)
  1412. {
  1413. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1414. if (plugin == nullptr || ! plugin->isEnabled())
  1415. continue;
  1416. const CarlaEngineJackClient* const engineClient((const CarlaEngineJackClient*)plugin->getEngineClient());
  1417. CARLA_SAFE_ASSERT_CONTINUE(engineClient != nullptr);
  1418. const char* const engineClientName(engineClient->getJackClientName());
  1419. CARLA_SAFE_ASSERT_CONTINUE(engineClientName != nullptr && engineClientName[0] != '\0');
  1420. if (std::strcmp(clientName, engineClientName) != 0)
  1421. continue;
  1422. pluginId = static_cast<int>(i);
  1423. icon = PATCHBAY_ICON_PLUGIN;
  1424. if (const char* const pluginIcon = plugin->getIconName())
  1425. {
  1426. if (pluginIcon[0] == '\0')
  1427. pass();
  1428. else if (std::strcmp(pluginIcon, "app") == 0 || std::strcmp(pluginIcon, "application") == 0)
  1429. icon = PATCHBAY_ICON_APPLICATION;
  1430. else if (std::strcmp(pluginIcon, "plugin") == 0)
  1431. icon = PATCHBAY_ICON_PLUGIN;
  1432. else if (std::strcmp(pluginIcon, "hardware") == 0)
  1433. icon = PATCHBAY_ICON_HARDWARE;
  1434. else if (std::strcmp(pluginIcon, "carla") == 0)
  1435. icon = PATCHBAY_ICON_CARLA;
  1436. else if (std::strcmp(pluginIcon, "distrho") == 0)
  1437. icon = PATCHBAY_ICON_DISTRHO;
  1438. else if (std::strcmp(pluginIcon, "file") == 0)
  1439. icon = PATCHBAY_ICON_FILE;
  1440. }
  1441. return true;
  1442. }
  1443. return false;
  1444. }
  1445. void initJackPatchbay(const char* const ourName)
  1446. {
  1447. CARLA_SAFE_ASSERT_RETURN(pData->options.processMode != ENGINE_PROCESS_MODE_PATCHBAY || fExternalPatchbay,);
  1448. CARLA_SAFE_ASSERT_RETURN(ourName != nullptr && ourName[0] != '\0',);
  1449. StringArray parsedGroups;
  1450. // add our client first
  1451. {
  1452. parsedGroups.add(String(ourName));
  1453. GroupNameToId groupNameToId;
  1454. groupNameToId.setData(++fUsedGroups.lastId, ourName);
  1455. callback(ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED, groupNameToId.group, PATCHBAY_ICON_CARLA, -1, 0.0f, groupNameToId.name);
  1456. fUsedGroups.list.append(groupNameToId);
  1457. }
  1458. // query all jack ports
  1459. if (const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, 0))
  1460. {
  1461. for (int i=0; ports[i] != nullptr; ++i)
  1462. {
  1463. const char* const fullPortName(ports[i]);
  1464. CARLA_SAFE_ASSERT_CONTINUE(fullPortName != nullptr && fullPortName[0] != '\0');
  1465. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, fullPortName));
  1466. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  1467. const char* const shortPortName(jackbridge_port_short_name(jackPort));
  1468. CARLA_SAFE_ASSERT_CONTINUE(shortPortName != nullptr && shortPortName[0] != '\0');
  1469. const int jackPortFlags(jackbridge_port_flags(jackPort));
  1470. uint groupId = 0;
  1471. bool found;
  1472. CarlaString groupName(fullPortName);
  1473. groupName.truncate(groupName.rfind(shortPortName, &found)-1);
  1474. CARLA_SAFE_ASSERT_CONTINUE(found);
  1475. String jGroupName(groupName.buffer());
  1476. if (parsedGroups.contains(jGroupName))
  1477. {
  1478. groupId = fUsedGroups.getGroupId(groupName);
  1479. CARLA_SAFE_ASSERT_CONTINUE(groupId > 0);
  1480. }
  1481. else
  1482. {
  1483. groupId = ++fUsedGroups.lastId;
  1484. parsedGroups.add(jGroupName);
  1485. int pluginId = -1;
  1486. PatchbayIcon icon = (jackPortFlags & JackPortIsPhysical) ? PATCHBAY_ICON_HARDWARE : PATCHBAY_ICON_APPLICATION;
  1487. findPluginIdAndIcon(groupName, pluginId, icon);
  1488. GroupNameToId groupNameToId;
  1489. groupNameToId.setData(groupId, groupName);
  1490. callback(ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED, groupNameToId.group, icon, pluginId, 0.0f, groupNameToId.name);
  1491. fUsedGroups.list.append(groupNameToId);
  1492. }
  1493. addPatchbayJackPort(groupId, jackPort, shortPortName, fullPortName, jackPortFlags);
  1494. }
  1495. jackbridge_free(ports);
  1496. }
  1497. // query connections, after all ports are in place
  1498. if (const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, JackPortIsOutput))
  1499. {
  1500. char strBuf[STR_MAX+1];
  1501. for (int i=0; ports[i] != nullptr; ++i)
  1502. {
  1503. const char* const fullPortName(ports[i]);
  1504. CARLA_SAFE_ASSERT_CONTINUE(fullPortName != nullptr && fullPortName[0] != '\0');
  1505. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, fullPortName));
  1506. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  1507. const PortNameToId& thisPort(fUsedPorts.getPortNameToId(fullPortName));
  1508. CARLA_SAFE_ASSERT_CONTINUE(thisPort.group > 0);
  1509. CARLA_SAFE_ASSERT_CONTINUE(thisPort.port > 0);
  1510. if (const char** const connections = jackbridge_port_get_all_connections(fClient, jackPort))
  1511. {
  1512. for (int j=0; connections[j] != nullptr; ++j)
  1513. {
  1514. const char* const connection(connections[j]);
  1515. CARLA_SAFE_ASSERT_CONTINUE(connection != nullptr && connection[0] != '\0');
  1516. const PortNameToId& targetPort(fUsedPorts.getPortNameToId(connection));
  1517. CARLA_SAFE_ASSERT_CONTINUE(targetPort.group > 0);
  1518. CARLA_SAFE_ASSERT_CONTINUE(targetPort.port > 0);
  1519. std::snprintf(strBuf, STR_MAX, "%i:%i:%i:%i", thisPort.group, thisPort.port, targetPort.group, targetPort.port);
  1520. strBuf[STR_MAX] = '\0';
  1521. ConnectionToId connectionToId;
  1522. connectionToId.setData(++fUsedConnections.lastId, thisPort.group, thisPort.port, targetPort.group, targetPort.port);
  1523. callback(ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED, connectionToId.id, 0, 0, 0.0f, strBuf);
  1524. fUsedConnections.list.append(connectionToId);
  1525. }
  1526. jackbridge_free(connections);
  1527. }
  1528. }
  1529. jackbridge_free(ports);
  1530. }
  1531. }
  1532. void addPatchbayJackPort(const uint groupId, const jack_port_t* const jackPort, const char* const shortPortName, const char* const fullPortName, const int jackPortFlags)
  1533. {
  1534. bool portIsInput = (jackPortFlags & JackPortIsInput);
  1535. bool portIsAudio = (std::strcmp(jackbridge_port_type(jackPort), JACK_DEFAULT_AUDIO_TYPE) == 0);
  1536. bool portIsMIDI = (std::strcmp(jackbridge_port_type(jackPort), JACK_DEFAULT_MIDI_TYPE) == 0);
  1537. bool portIsCV = false;
  1538. bool portIsOSC = false;
  1539. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  1540. {
  1541. char* value = nullptr;
  1542. char* type = nullptr;
  1543. if (jackbridge_get_property(uuid, JACKEY_SIGNAL_TYPE, &value, &type) && value != nullptr && type != nullptr && std::strcmp(type, "text/plain") == 0)
  1544. {
  1545. portIsCV = (std::strcmp(value, "CV") == 0);
  1546. portIsOSC = (std::strcmp(value, "OSC") == 0);
  1547. }
  1548. }
  1549. uint canvasPortFlags = 0x0;
  1550. canvasPortFlags |= portIsInput ? PATCHBAY_PORT_IS_INPUT : 0x0;
  1551. if (portIsCV)
  1552. canvasPortFlags |= PATCHBAY_PORT_TYPE_CV;
  1553. else if (portIsAudio)
  1554. canvasPortFlags |= PATCHBAY_PORT_TYPE_AUDIO;
  1555. else if (portIsMIDI)
  1556. canvasPortFlags |= PATCHBAY_PORT_TYPE_MIDI;
  1557. PortNameToId portNameToId;
  1558. portNameToId.setData(groupId, ++fUsedPorts.lastId, shortPortName, fullPortName);
  1559. callback(ENGINE_CALLBACK_PATCHBAY_PORT_ADDED, portNameToId.group, static_cast<int>(portNameToId.port), static_cast<int>(canvasPortFlags), 0.0f, portNameToId.name);
  1560. fUsedPorts.list.append(portNameToId);
  1561. return; // unused
  1562. (void)portIsOSC;
  1563. }
  1564. #endif
  1565. // -------------------------------------------------------------------
  1566. void processPlugin(CarlaPlugin* const plugin, const uint32_t nframes)
  1567. {
  1568. const uint32_t audioInCount(plugin->getAudioInCount());
  1569. const uint32_t audioOutCount(plugin->getAudioOutCount());
  1570. const uint32_t cvInCount(plugin->getCVInCount());
  1571. const uint32_t cvOutCount(plugin->getCVOutCount());
  1572. const float* audioIn[audioInCount];
  1573. /* */ float* audioOut[audioOutCount];
  1574. const float* cvIn[cvInCount];
  1575. /* */ float* cvOut[cvOutCount];
  1576. for (uint32_t i=0; i < audioInCount; ++i)
  1577. {
  1578. CarlaEngineAudioPort* const port(plugin->getAudioInPort(i));
  1579. audioIn[i] = port->getBuffer();
  1580. }
  1581. for (uint32_t i=0; i < audioOutCount; ++i)
  1582. {
  1583. CarlaEngineAudioPort* const port(plugin->getAudioOutPort(i));
  1584. audioOut[i] = port->getBuffer();
  1585. }
  1586. for (uint32_t i=0; i < cvInCount; ++i)
  1587. {
  1588. CarlaEngineCVPort* const port(plugin->getCVInPort(i));
  1589. cvIn[i] = port->getBuffer();
  1590. }
  1591. for (uint32_t i=0; i < cvOutCount; ++i)
  1592. {
  1593. CarlaEngineCVPort* const port(plugin->getCVOutPort(i));
  1594. cvOut[i] = port->getBuffer();
  1595. }
  1596. float inPeaks[2] = { 0.0f };
  1597. float outPeaks[2] = { 0.0f };
  1598. for (uint32_t i=0; i < audioInCount && i < 2; ++i)
  1599. {
  1600. for (uint32_t j=0; j < nframes; ++j)
  1601. {
  1602. const float absV(std::abs(audioIn[i][j]));
  1603. if (absV > inPeaks[i])
  1604. inPeaks[i] = absV;
  1605. }
  1606. }
  1607. plugin->process(audioIn, audioOut, cvIn, cvOut, nframes);
  1608. for (uint32_t i=0; i < audioOutCount && i < 2; ++i)
  1609. {
  1610. for (uint32_t j=0; j < nframes; ++j)
  1611. {
  1612. const float absV(std::abs(audioOut[i][j]));
  1613. if (absV > outPeaks[i])
  1614. outPeaks[i] = absV;
  1615. }
  1616. }
  1617. setPluginPeaks(plugin->getId(), inPeaks, outPeaks);
  1618. }
  1619. // -------------------------------------------------------------------
  1620. #define handlePtr ((CarlaEngineJack*)arg)
  1621. static void carla_jack_thread_init_callback(void*)
  1622. {
  1623. #ifdef __SSE2_MATH__
  1624. // Set FTZ and DAZ flags
  1625. _mm_setcsr(_mm_getcsr() | 0x8040);
  1626. #endif
  1627. }
  1628. static int carla_jack_bufsize_callback(jack_nframes_t newBufferSize, void* arg)
  1629. {
  1630. handlePtr->handleJackBufferSizeCallback(newBufferSize);
  1631. return 0;
  1632. }
  1633. static int carla_jack_srate_callback(jack_nframes_t newSampleRate, void* arg)
  1634. {
  1635. handlePtr->handleJackSampleRateCallback(newSampleRate);
  1636. return 0;
  1637. }
  1638. static void carla_jack_freewheel_callback(int starting, void* arg)
  1639. {
  1640. handlePtr->handleJackFreewheelCallback(bool(starting));
  1641. }
  1642. static int carla_jack_process_callback(jack_nframes_t nframes, void* arg)
  1643. {
  1644. handlePtr->handleJackProcessCallback(nframes);
  1645. return 0;
  1646. }
  1647. static void carla_jack_latency_callback(jack_latency_callback_mode_t mode, void* arg)
  1648. {
  1649. handlePtr->handleJackLatencyCallback(mode);
  1650. }
  1651. #ifndef BUILD_BRIDGE
  1652. static void carla_jack_client_registration_callback(const char* name, int reg, void* arg)
  1653. {
  1654. handlePtr->handleJackClientRegistrationCallback(name, (reg != 0));
  1655. }
  1656. static void carla_jack_port_registration_callback(jack_port_id_t port, int reg, void* arg)
  1657. {
  1658. handlePtr->handleJackPortRegistrationCallback(port, (reg != 0));
  1659. }
  1660. static void carla_jack_port_connect_callback(jack_port_id_t a, jack_port_id_t b, int connect, void* arg)
  1661. {
  1662. handlePtr->handleJackPortConnectCallback(a, b, (connect != 0));
  1663. }
  1664. static int carla_jack_client_rename_callback(const char* oldName, const char* newName, void* arg)
  1665. {
  1666. handlePtr->handleJackClientRenameCallback(oldName, newName);
  1667. return 0;
  1668. }
  1669. // NOTE: JACK1 returns void, JACK2 returns int
  1670. static int carla_jack_port_rename_callback(jack_port_id_t port, const char* oldName, const char* newName, void* arg)
  1671. {
  1672. handlePtr->handleJackPortRenameCallback(port, oldName, newName);
  1673. return 0;
  1674. }
  1675. #endif
  1676. static void carla_jack_shutdown_callback(void* arg)
  1677. {
  1678. handlePtr->handleJackShutdownCallback();
  1679. }
  1680. #undef handlePtr
  1681. // -------------------------------------------------------------------
  1682. #ifndef BUILD_BRIDGE
  1683. static int carla_jack_process_callback_plugin(jack_nframes_t nframes, void* arg)
  1684. {
  1685. CarlaPlugin* const plugin((CarlaPlugin*)arg);
  1686. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr && plugin->isEnabled(), 0);
  1687. CarlaEngineJack* const engine((CarlaEngineJack*)plugin->getEngine());
  1688. CARLA_SAFE_ASSERT_RETURN(engine != nullptr, 0);
  1689. if (plugin->tryLock(engine->fFreewheel))
  1690. {
  1691. plugin->initBuffers();
  1692. engine->saveTransportInfo();
  1693. engine->processPlugin(plugin, nframes);
  1694. plugin->unlock();
  1695. }
  1696. return 0;
  1697. }
  1698. static void carla_jack_latency_callback_plugin(jack_latency_callback_mode_t /*mode*/, void* /*arg*/)
  1699. {
  1700. // TODO
  1701. }
  1702. static void carla_jack_shutdown_callback_plugin(void* arg)
  1703. {
  1704. CarlaPlugin* const plugin((CarlaPlugin*)arg);
  1705. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr,);
  1706. CarlaEngineJack* const engine((CarlaEngineJack*)plugin->getEngine());
  1707. CARLA_SAFE_ASSERT_RETURN(engine != nullptr,);
  1708. engine->handlePluginJackShutdownCallback(plugin);
  1709. }
  1710. #endif
  1711. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJack)
  1712. };
  1713. // -----------------------------------------------------------------------
  1714. CarlaEngine* CarlaEngine::newJack()
  1715. {
  1716. carla_debug("CarlaEngine::newJack()");
  1717. return new CarlaEngineJack();
  1718. }
  1719. // -----------------------------------------------------------------------
  1720. CARLA_BACKEND_END_NAMESPACE