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.

2214 lines
77KB

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