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.

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