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.

4566 lines
161KB

  1. // SPDX-FileCopyrightText: 2011-2025 Filipe Coelho <falktx@falktx.com>
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  3. #include "CarlaEngineClient.hpp"
  4. #include "CarlaEngineInit.hpp"
  5. #include "CarlaEngineInternal.hpp"
  6. #include "CarlaPlugin.hpp"
  7. #include "CarlaBackendUtils.hpp"
  8. #include "CarlaEngineUtils.hpp"
  9. #include "CarlaMathUtils.hpp"
  10. #include "CarlaMIDI.h"
  11. #include "CarlaPatchbayUtils.hpp"
  12. #include "CarlaStringList.hpp"
  13. #include "extra/ScopedPointer.hpp"
  14. #include "jackey.h"
  15. #ifdef __SSE2_MATH__
  16. # include <xmmintrin.h>
  17. #endif
  18. // must be last
  19. #include "jackbridge/JackBridge.hpp"
  20. #ifdef JACKBRIDGE_DIRECT
  21. # define JackPortIsCV 0x20
  22. #endif
  23. #define URI_CANVAS_ICON "http://kxstudio.sf.net/ns/canvas/icon"
  24. #define URI_MAIN_CLIENT_NAME "https://kx.studio/ns/carla/main-client-name"
  25. #define URI_POSITION "https://kx.studio/ns/carla/position"
  26. #define URI_PLUGIN_ICON "https://kx.studio/ns/carla/plugin-icon"
  27. #define URI_PLUGIN_ID "https://kx.studio/ns/carla/plugin-id"
  28. #define URI_TYPE_INTEGER "http://www.w3.org/2001/XMLSchema#integer"
  29. #define URI_TYPE_STRING "text/plain"
  30. CARLA_BACKEND_START_NAMESPACE
  31. class CarlaEngineJack;
  32. class CarlaEngineJackClient;
  33. #ifndef BUILD_BRIDGE
  34. struct CarlaJackPortHints {
  35. bool isHardware : 1;
  36. bool isInput : 1;
  37. bool isAudio : 1;
  38. bool isMIDI : 1;
  39. bool isCV : 1;
  40. bool isOSC : 1;
  41. // NOTE: assumes fThreadSafeMetadataMutex lock done from caller
  42. static CarlaJackPortHints fromPort(const jack_port_t* const jackPort)
  43. {
  44. CarlaJackPortHints ph = { false, false, false, false, false, false };
  45. const int portFlags = jackbridge_port_flags(jackPort);
  46. const char* const portType = jackbridge_port_type(jackPort);
  47. ph.isHardware = portFlags & JackPortIsPhysical;
  48. ph.isInput = portFlags & JackPortIsInput;
  49. ph.isAudio = portType != nullptr && std::strcmp(portType, JACK_DEFAULT_AUDIO_TYPE) == 0;
  50. ph.isMIDI = portType != nullptr && std::strcmp(portType, JACK_DEFAULT_MIDI_TYPE) == 0;
  51. ph.isCV = false;
  52. ph.isOSC = false;
  53. if (ph.isAudio && portFlags & JackPortIsCV)
  54. {
  55. ph.isAudio = false;
  56. ph.isCV = true;
  57. }
  58. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  59. {
  60. char* value = nullptr;
  61. char* type = nullptr;
  62. if (jackbridge_get_property(uuid, JACKEY_SIGNAL_TYPE, &value, &type)
  63. && value != nullptr
  64. && type != nullptr
  65. && std::strcmp(type, URI_TYPE_STRING) == 0)
  66. {
  67. ph.isCV = (std::strcmp(value, "CV") == 0);
  68. ph.isOSC = (std::strcmp(value, "OSC") == 0);
  69. if (ph.isCV)
  70. ph.isAudio = false;
  71. if (ph.isOSC)
  72. ph.isMIDI = false;
  73. jackbridge_free(value);
  74. jackbridge_free(type);
  75. }
  76. }
  77. return ph;
  78. }
  79. };
  80. #endif
  81. // -----------------------------------------------------------------------
  82. // Fallback data
  83. #ifndef BUILD_BRIDGE
  84. static const GroupNameToId kGroupNameToIdFallback = { 0, { '\0' } };
  85. static /* */ PortNameToId kPortNameToIdFallbackNC = { 0, 0, { '\0' }, { '\0' }, { '\0' } };
  86. static const PortNameToId kPortNameToIdFallback = { 0, 0, { '\0' }, { '\0' }, { '\0' } };
  87. static const ConnectionToId kConnectionToIdFallback = { 0, 0, 0, 0, 0 };
  88. #endif
  89. static EngineEvent kFallbackJackEngineEvent = {
  90. kEngineEventTypeNull, 0, 0, {{ kEngineControlEventTypeNull, 0, -1, 0.0f, true }}
  91. };
  92. // -----------------------------------------------------------------------
  93. // Carla Engine Port removal helper
  94. class CarlaEngineJackAudioPort;
  95. class CarlaEngineJackCVPort;
  96. class CarlaEngineJackEventPort;
  97. struct JackPortDeletionCallback {
  98. virtual ~JackPortDeletionCallback() noexcept {}
  99. virtual void jackAudioPortDeleted(CarlaEngineJackAudioPort* const) noexcept = 0;
  100. virtual void jackCVPortDeleted(CarlaEngineJackCVPort* const) noexcept = 0;
  101. virtual void jackEventPortDeleted(CarlaEngineJackEventPort* const) noexcept = 0;
  102. };
  103. // -----------------------------------------------------------------------
  104. // Carla Engine JACK-Audio port
  105. class CarlaEngineJackAudioPort : public CarlaEngineAudioPort
  106. {
  107. public:
  108. CarlaEngineJackAudioPort(const CarlaEngineClient& client,
  109. const bool isInputPort,
  110. const uint32_t indexOffset,
  111. jack_client_t* const jackClient,
  112. jack_port_t* const jackPort,
  113. CarlaRecursiveMutex& rmutex,
  114. JackPortDeletionCallback* const delCallback) noexcept
  115. : CarlaEngineAudioPort(client, isInputPort, indexOffset),
  116. fJackClient(jackClient),
  117. fJackPort(jackPort),
  118. fThreadSafeMetadataMutex(rmutex),
  119. kDeletionCallback(delCallback)
  120. {
  121. carla_debug("CarlaEngineJackAudioPort::CarlaEngineJackAudioPort(%s, %p, %p)", bool2str(isInputPort), jackClient, jackPort);
  122. switch (kClient.getEngine().getProccessMode())
  123. {
  124. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  125. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  126. CARLA_SAFE_ASSERT_RETURN(jackClient != nullptr && jackPort != nullptr,);
  127. {
  128. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  129. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  130. jackbridge_set_property(jackClient, uuid, JACKEY_SIGNAL_TYPE, "AUDIO", URI_TYPE_STRING);
  131. }
  132. break;
  133. default:
  134. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  135. break;
  136. }
  137. }
  138. ~CarlaEngineJackAudioPort() noexcept override
  139. {
  140. carla_debug("CarlaEngineJackAudioPort::~CarlaEngineJackAudioPort()");
  141. if (fJackClient != nullptr && fJackPort != nullptr)
  142. {
  143. try {
  144. jackbridge_port_unregister(fJackClient, fJackPort);
  145. } CARLA_SAFE_EXCEPTION("Audio port unregister");
  146. fJackClient = nullptr;
  147. fJackPort = nullptr;
  148. }
  149. if (kDeletionCallback != nullptr)
  150. kDeletionCallback->jackAudioPortDeleted(this);
  151. }
  152. void initBuffer() noexcept override
  153. {
  154. if (fJackPort == nullptr)
  155. return CarlaEngineAudioPort::initBuffer();
  156. const uint32_t bufferSize(kClient.getEngine().getBufferSize());
  157. try {
  158. fBuffer = (float*)jackbridge_port_get_buffer(fJackPort, bufferSize);
  159. }
  160. catch(...) {
  161. fBuffer = nullptr;
  162. return;
  163. }
  164. if (! kIsInput)
  165. carla_zeroFloats(fBuffer, bufferSize);
  166. }
  167. void invalidate() noexcept
  168. {
  169. fJackClient = nullptr;
  170. fJackPort = nullptr;
  171. }
  172. void setMetaData(const char* const key, const char* const value, const char* const type) override
  173. {
  174. if (fJackPort == nullptr)
  175. return CarlaEngineAudioPort::setMetaData(key, value, type);
  176. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  177. try {
  178. if (const jack_uuid_t uuid = jackbridge_port_uuid(fJackPort))
  179. jackbridge_set_property(fJackClient, uuid, key, value, type);
  180. } CARLA_SAFE_EXCEPTION("Port setMetaData");
  181. }
  182. private:
  183. jack_client_t* fJackClient;
  184. jack_port_t* fJackPort;
  185. CarlaRecursiveMutex& fThreadSafeMetadataMutex;
  186. JackPortDeletionCallback* const kDeletionCallback;
  187. friend class CarlaEngineJackClient;
  188. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackAudioPort)
  189. };
  190. // -----------------------------------------------------------------------
  191. // Carla Engine JACK-CV port
  192. class CarlaEngineJackCVPort : public CarlaEngineCVPort
  193. {
  194. public:
  195. CarlaEngineJackCVPort(const CarlaEngineClient& client,
  196. const bool isInputPort,
  197. const uint32_t indexOffset,
  198. jack_client_t* const jackClient,
  199. jack_port_t* const jackPort,
  200. CarlaRecursiveMutex& rmutex,
  201. JackPortDeletionCallback* const delCallback) noexcept
  202. : CarlaEngineCVPort(client, isInputPort, indexOffset),
  203. fJackClient(jackClient),
  204. fJackPort(jackPort),
  205. fThreadSafeMetadataMutex(rmutex),
  206. kDeletionCallback(delCallback)
  207. {
  208. carla_debug("CarlaEngineJackCVPort::CarlaEngineJackCVPort(%s, %p, %p)", bool2str(isInputPort), jackClient, jackPort);
  209. switch (kClient.getEngine().getProccessMode())
  210. {
  211. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  212. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  213. CARLA_SAFE_ASSERT_RETURN(jackClient != nullptr && jackPort != nullptr,);
  214. {
  215. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  216. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  217. jackbridge_set_property(jackClient, uuid, JACKEY_SIGNAL_TYPE, "CV", URI_TYPE_STRING);
  218. }
  219. break;
  220. default:
  221. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  222. break;
  223. }
  224. }
  225. ~CarlaEngineJackCVPort() noexcept override
  226. {
  227. carla_debug("CarlaEngineJackCVPort::~CarlaEngineJackCVPort()");
  228. if (fJackClient != nullptr && fJackPort != nullptr)
  229. {
  230. try {
  231. jackbridge_port_unregister(fJackClient, fJackPort);
  232. } CARLA_SAFE_EXCEPTION("CV port unregister");
  233. fJackClient = nullptr;
  234. fJackPort = nullptr;
  235. }
  236. if (kDeletionCallback != nullptr)
  237. kDeletionCallback->jackCVPortDeleted(this);
  238. }
  239. void initBuffer() noexcept override
  240. {
  241. if (fJackPort == nullptr)
  242. return CarlaEngineCVPort::initBuffer();
  243. const uint32_t bufferSize(kClient.getEngine().getBufferSize());
  244. try {
  245. fBuffer = (float*)jackbridge_port_get_buffer(fJackPort, bufferSize);
  246. }
  247. catch(...) {
  248. fBuffer = nullptr;
  249. return;
  250. }
  251. if (! kIsInput)
  252. carla_zeroFloats(fBuffer, bufferSize);
  253. }
  254. void invalidate() noexcept
  255. {
  256. fJackClient = nullptr;
  257. fJackPort = nullptr;
  258. }
  259. void setMetaData(const char* const key, const char* const value, const char* const type) override
  260. {
  261. if (fJackPort == nullptr)
  262. return CarlaEngineCVPort::setMetaData(key, value, type);
  263. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  264. try {
  265. if (const jack_uuid_t uuid = jackbridge_port_uuid(fJackPort))
  266. jackbridge_set_property(fJackClient, uuid, key, value, type);
  267. } CARLA_SAFE_EXCEPTION("Port setMetaData");
  268. }
  269. private:
  270. jack_client_t* fJackClient;
  271. jack_port_t* fJackPort;
  272. CarlaRecursiveMutex& fThreadSafeMetadataMutex;
  273. JackPortDeletionCallback* const kDeletionCallback;
  274. friend class CarlaEngineJackClient;
  275. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackCVPort)
  276. };
  277. // -----------------------------------------------------------------------
  278. // Carla Engine JACK-Event port
  279. class CarlaEngineJackEventPort : public CarlaEngineEventPort
  280. {
  281. public:
  282. CarlaEngineJackEventPort(const CarlaEngineClient& client,
  283. const bool isInputPort,
  284. const uint32_t indexOffset,
  285. jack_client_t* const jackClient,
  286. jack_port_t* const jackPort,
  287. CarlaRecursiveMutex& rmutex,
  288. JackPortDeletionCallback* const delCallback) noexcept
  289. : CarlaEngineEventPort(client, isInputPort, indexOffset),
  290. fJackClient(jackClient),
  291. fJackPort(jackPort),
  292. fJackBuffer(nullptr),
  293. fRetEvent(kFallbackJackEngineEvent),
  294. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  295. fCvSourceEvents(nullptr),
  296. fCvSourceEventCount(0),
  297. #endif
  298. fThreadSafeMetadataMutex(rmutex),
  299. kDeletionCallback(delCallback)
  300. {
  301. carla_debug("CarlaEngineJackEventPort::CarlaEngineJackEventPort(%s, %p, %p)", bool2str(isInputPort), jackClient, jackPort);
  302. switch (kClient.getEngine().getProccessMode())
  303. {
  304. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  305. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  306. CARLA_SAFE_ASSERT_RETURN(jackClient != nullptr && jackPort != nullptr,);
  307. break;
  308. default:
  309. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  310. break;
  311. }
  312. }
  313. ~CarlaEngineJackEventPort() noexcept override
  314. {
  315. carla_debug("CarlaEngineJackEventPort::~CarlaEngineJackEventPort()");
  316. if (fJackClient != nullptr && fJackPort != nullptr)
  317. {
  318. try {
  319. jackbridge_port_unregister(fJackClient, fJackPort);
  320. } CARLA_SAFE_EXCEPTION("Event port unregister");
  321. fJackClient = nullptr;
  322. fJackPort = nullptr;
  323. }
  324. if (kDeletionCallback != nullptr)
  325. kDeletionCallback->jackEventPortDeleted(this);
  326. }
  327. void initBuffer() noexcept override
  328. {
  329. if (fJackPort == nullptr)
  330. return CarlaEngineEventPort::initBuffer();
  331. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  332. fCvSourceEvents = nullptr;
  333. fCvSourceEventCount = 0;
  334. #endif
  335. try {
  336. fJackBuffer = jackbridge_port_get_buffer(fJackPort, kClient.getEngine().getBufferSize());
  337. }
  338. catch(...) {
  339. fJackBuffer = nullptr;
  340. return;
  341. }
  342. if (! kIsInput)
  343. jackbridge_midi_clear_buffer(fJackBuffer);
  344. }
  345. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  346. void setCvSourceEvents(EngineEvent* const events, const uint32_t eventCount) noexcept
  347. {
  348. fCvSourceEvents = events;
  349. fCvSourceEventCount = eventCount;
  350. }
  351. #endif
  352. uint32_t getEventCount() const noexcept override
  353. {
  354. if (fJackPort == nullptr)
  355. return CarlaEngineEventPort::getEventCount();
  356. CARLA_SAFE_ASSERT_RETURN(kIsInput, 0);
  357. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, 0);
  358. try {
  359. return jackbridge_midi_get_event_count(fJackBuffer)
  360. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  361. + fCvSourceEventCount
  362. #endif
  363. ;
  364. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_get_event_count", 0);
  365. }
  366. EngineEvent& getEvent(const uint32_t index) const noexcept override
  367. {
  368. if (fJackPort == nullptr)
  369. return CarlaEngineEventPort::getEvent(index);
  370. CARLA_SAFE_ASSERT_RETURN(kIsInput, kFallbackJackEngineEvent);
  371. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, kFallbackJackEngineEvent);
  372. return getEventUnchecked(index);
  373. }
  374. EngineEvent& getEventUnchecked(uint32_t index) const noexcept override
  375. {
  376. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  377. if (index < fCvSourceEventCount)
  378. return fCvSourceEvents[index];
  379. index -= fCvSourceEventCount;
  380. #endif
  381. jack_midi_event_t jackEvent;
  382. bool test = false;
  383. try {
  384. test = jackbridge_midi_event_get(&jackEvent, fJackBuffer, index);
  385. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_get", kFallbackJackEngineEvent);
  386. if (! test)
  387. return kFallbackJackEngineEvent;
  388. CARLA_SAFE_ASSERT_RETURN(jackEvent.size < 0xFF /* uint8_t max */, kFallbackJackEngineEvent);
  389. uint8_t port;
  390. if (kIndexOffset < 0xFF /* uint8_t max */)
  391. {
  392. port = static_cast<uint8_t>(kIndexOffset);
  393. }
  394. else
  395. {
  396. port = 0;
  397. carla_safe_assert_uint("kIndexOffset < 0xFF", __FILE__, __LINE__, kIndexOffset);
  398. }
  399. fRetEvent.time = jackEvent.time;
  400. fRetEvent.fillFromMidiData(static_cast<uint8_t>(jackEvent.size), jackEvent.buffer, port);
  401. return fRetEvent;
  402. }
  403. bool writeControlEvent(const uint32_t time, const uint8_t channel,
  404. const EngineControlEventType type,
  405. const uint16_t param,
  406. const int8_t midiValue,
  407. const float value) noexcept override
  408. {
  409. if (fJackPort == nullptr)
  410. return CarlaEngineEventPort::writeControlEvent(time, channel, type, param, midiValue, value);
  411. CARLA_SAFE_ASSERT_RETURN(! kIsInput, false);
  412. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, false);
  413. CARLA_SAFE_ASSERT_RETURN(type != kEngineControlEventTypeNull, false);
  414. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS, false);
  415. CARLA_SAFE_ASSERT_RETURN(param < MAX_MIDI_VALUE, false);
  416. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.0f);
  417. if (type == kEngineControlEventTypeParameter) {
  418. CARLA_SAFE_ASSERT(! MIDI_IS_CONTROL_BANK_SELECT(param));
  419. }
  420. uint8_t data[3] = { 0, 0, 0 };
  421. EngineControlEvent ctrlEvent = { type, param, midiValue, value, false };
  422. const uint8_t size = ctrlEvent.convertToMidiData(channel, data);
  423. if (size == 0)
  424. return false;
  425. try {
  426. return jackbridge_midi_event_write(fJackBuffer, time, data, size);
  427. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_write", false);
  428. }
  429. bool writeMidiEvent(const uint32_t time, const uint8_t channel, const uint8_t size, const uint8_t* const data) noexcept override
  430. {
  431. if (fJackPort == nullptr)
  432. return CarlaEngineEventPort::writeMidiEvent(time, channel, size, data);
  433. CARLA_SAFE_ASSERT_RETURN(! kIsInput, false);
  434. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, false);
  435. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS, false);
  436. CARLA_SAFE_ASSERT_RETURN(size > 0, false);
  437. CARLA_SAFE_ASSERT_RETURN(data != nullptr, false);
  438. jack_midi_data_t jdata[size];
  439. jdata[0] = static_cast<jack_midi_data_t>(MIDI_GET_STATUS_FROM_DATA(data) + channel);
  440. for (uint8_t i=1; i < size; ++i)
  441. jdata[i] = data[i];
  442. try {
  443. return jackbridge_midi_event_write(fJackBuffer, time, jdata, size);
  444. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_write", false);
  445. }
  446. void invalidate() noexcept
  447. {
  448. fJackClient = nullptr;
  449. fJackPort = nullptr;
  450. }
  451. void setMetaData(const char* const key, const char* const value, const char* const type) override
  452. {
  453. if (fJackPort == nullptr)
  454. return CarlaEngineEventPort::setMetaData(key, value, type);
  455. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  456. try {
  457. if (const jack_uuid_t uuid = jackbridge_port_uuid(fJackPort))
  458. jackbridge_set_property(fJackClient, uuid, key, value, type);
  459. } CARLA_SAFE_EXCEPTION("Port setMetaData");
  460. }
  461. private:
  462. jack_client_t* fJackClient;
  463. jack_port_t* fJackPort;
  464. void* fJackBuffer;
  465. mutable EngineEvent fRetEvent;
  466. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  467. EngineEvent* fCvSourceEvents;
  468. uint32_t fCvSourceEventCount;
  469. #endif
  470. CarlaRecursiveMutex& fThreadSafeMetadataMutex;
  471. JackPortDeletionCallback* const kDeletionCallback;
  472. friend class CarlaEngineJackClient;
  473. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackEventPort)
  474. };
  475. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  476. // -----------------------------------------------------------------------
  477. // Jack Engine CV source ports
  478. class CarlaEngineJackCVSourcePorts : public CarlaEngineCVSourcePorts
  479. {
  480. public:
  481. CarlaEngineJackCVSourcePorts(const bool useClient)
  482. : CarlaEngineCVSourcePorts(),
  483. fUseClient(useClient),
  484. fBuffer(nullptr),
  485. fBufferToDeleteLater(nullptr)
  486. {}
  487. ~CarlaEngineJackCVSourcePorts() override
  488. {
  489. if (fBufferToDeleteLater != nullptr)
  490. {
  491. delete[] fBufferToDeleteLater;
  492. fBufferToDeleteLater = nullptr;
  493. }
  494. }
  495. bool addCVSource(CarlaEngineCVPort* const port, const uint32_t portIndexOffset, const bool reconfigureNow) override
  496. {
  497. if (! fUseClient)
  498. return CarlaEngineCVSourcePorts::addCVSource(port, portIndexOffset, reconfigureNow);
  499. const CarlaRecursiveMutexLocker crml(pData->rmutex);
  500. if (! CarlaEngineCVSourcePorts::addCVSource(port, portIndexOffset, reconfigureNow))
  501. return false;
  502. if (pData->cvs.size() == 1 && fBuffer == nullptr)
  503. {
  504. EngineEvent* const buffer = new EngineEvent[kMaxEngineEventInternalCount];
  505. carla_zeroStructs(buffer, kMaxEngineEventInternalCount);
  506. fBuffer = buffer;
  507. }
  508. return true;
  509. }
  510. bool removeCVSource(const uint32_t portIndexOffset) override
  511. {
  512. if (! fUseClient)
  513. return CarlaEngineCVSourcePorts::removeCVSource(portIndexOffset);
  514. const CarlaRecursiveMutexLocker crml(pData->rmutex);
  515. if (! CarlaEngineCVSourcePorts::removeCVSource(portIndexOffset))
  516. return false;
  517. if (pData->cvs.size() == 0 && fBuffer != nullptr)
  518. {
  519. if (fBufferToDeleteLater != nullptr)
  520. delete[] fBufferToDeleteLater;
  521. fBufferToDeleteLater = fBuffer;
  522. fBuffer = nullptr;
  523. }
  524. return true;
  525. }
  526. void initPortBuffers(const float* const* const buffers,
  527. const uint32_t frames,
  528. const bool sampleAccurate,
  529. CarlaEngineEventPort* const eventPort) override
  530. {
  531. if (! fUseClient)
  532. return CarlaEngineCVSourcePorts::initPortBuffers(buffers, frames, sampleAccurate, eventPort);
  533. CARLA_SAFE_ASSERT_RETURN(buffers != nullptr,);
  534. CARLA_SAFE_ASSERT_RETURN(eventPort != nullptr,);
  535. const CarlaRecursiveMutexTryLocker crmtl(pData->rmutex);
  536. if (! crmtl.wasLocked())
  537. return;
  538. const int numCVs = pData->cvs.size();
  539. if (numCVs == 0)
  540. return;
  541. EngineEvent* const buffer = fBuffer;
  542. CARLA_SAFE_ASSERT_RETURN(buffer != nullptr,);
  543. uint32_t eventCount = 0;
  544. float v, min, max;
  545. for (int i = 0; i < numCVs && eventCount < kMaxEngineEventInternalCount; ++i)
  546. {
  547. CarlaEngineEventCV& ecv(pData->cvs.getReference(i));
  548. CARLA_SAFE_ASSERT_CONTINUE(ecv.cvPort != nullptr);
  549. CARLA_SAFE_ASSERT_CONTINUE(buffers[i] != nullptr);
  550. float previousValue = ecv.previousValue;
  551. ecv.cvPort->getRange(min, max);
  552. v = buffers[i][0];
  553. if (carla_isNotEqual(v, previousValue))
  554. {
  555. previousValue = v;
  556. EngineEvent& event(buffer[eventCount++]);
  557. event.type = kEngineEventTypeControl;
  558. event.time = 0;
  559. event.channel = kEngineEventNonMidiChannel;
  560. event.ctrl.type = kEngineControlEventTypeParameter;
  561. event.ctrl.param = static_cast<uint16_t>(ecv.indexOffset);
  562. event.ctrl.midiValue = -1;
  563. event.ctrl.normalizedValue = carla_fixedValue(0.0f, 1.0f, (v - min) / (max - min));
  564. }
  565. ecv.previousValue = previousValue;
  566. }
  567. if (eventCount != 0)
  568. if (CarlaEngineJackEventPort* const jackEventPort = dynamic_cast<CarlaEngineJackEventPort*>(eventPort))
  569. jackEventPort->setCvSourceEvents(buffer, eventCount);
  570. }
  571. CarlaRecursiveMutex& getMutex() const noexcept
  572. {
  573. return pData->rmutex;
  574. }
  575. uint32_t getPortCount() const noexcept
  576. {
  577. return static_cast<uint32_t>(pData->cvs.size());
  578. }
  579. CarlaEngineCVPort* getPort(const uint32_t portIndexOffset) const
  580. {
  581. const int ioffset = static_cast<int>(portIndexOffset);
  582. return pData->cvs[ioffset].cvPort;
  583. }
  584. void resetGraphAndPlugin() noexcept
  585. {
  586. pData->graph = nullptr;
  587. pData->plugin.reset();
  588. }
  589. void setGraphAndPlugin(PatchbayGraph* const graph, const CarlaPluginPtr plugin) noexcept
  590. {
  591. pData->graph = graph;
  592. pData->plugin = plugin;
  593. }
  594. private:
  595. const bool fUseClient;
  596. EngineEvent* fBuffer;
  597. EngineEvent* fBufferToDeleteLater;
  598. CARLA_DECLARE_NON_COPYABLE(CarlaEngineJackCVSourcePorts)
  599. };
  600. #endif
  601. // -----------------------------------------------------------------------
  602. // Jack Engine client
  603. class CarlaEngineJackClient : public CarlaEngineClientForSubclassing,
  604. private JackPortDeletionCallback
  605. {
  606. public:
  607. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  608. CarlaEngineJackClient(const CarlaEngine& engine,
  609. EngineInternalGraph& egraph,
  610. CarlaRecursiveMutex& rmutex,
  611. const CarlaPluginPtr plugin,
  612. const String& mainClientName,
  613. jack_client_t* const jackClient)
  614. : CarlaEngineClientForSubclassing(engine, egraph, plugin),
  615. #else
  616. CarlaEngineJackClient(const CarlaEngine& engine,
  617. CarlaRecursiveMutex& rmutex,
  618. const String& mainClientName,
  619. jack_client_t* const jackClient)
  620. : CarlaEngineClientForSubclassing(engine),
  621. #endif
  622. fJackClient(jackClient),
  623. fUseClient(engine.getProccessMode() == ENGINE_PROCESS_MODE_SINGLE_CLIENT ||
  624. engine.getProccessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS),
  625. fAudioPorts(),
  626. fCVPorts(),
  627. fEventPorts(),
  628. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  629. fCVSourcePorts(fUseClient),
  630. fPreRenameMutex(),
  631. fPreRenameConnections(),
  632. fPreRenamePluginId(),
  633. fPreRenamePluginIcon(),
  634. fReservedPluginPtr(),
  635. #endif
  636. fThreadSafeMetadataMutex(rmutex),
  637. fMainClientName(mainClientName)
  638. {
  639. carla_debug("CarlaEngineJackClient::CarlaEngineJackClient(%p)", jackClient);
  640. if (fUseClient)
  641. {
  642. CARLA_SAFE_ASSERT(jackClient != nullptr);
  643. }
  644. else
  645. {
  646. CARLA_SAFE_ASSERT(jackClient == nullptr);
  647. }
  648. }
  649. ~CarlaEngineJackClient() noexcept override
  650. {
  651. carla_debug("CarlaEngineJackClient::~CarlaEngineJackClient()");
  652. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS && fJackClient != nullptr) // FIXME
  653. jackbridge_client_close(fJackClient);
  654. // ports must have been deleted by now!
  655. //fAudioPorts.clear();
  656. //fCVPorts.clear();
  657. //fEventPorts.clear();
  658. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  659. const CarlaMutexLocker cml(fPreRenameMutex);
  660. fPreRenameConnections.clear();
  661. fPreRenamePluginId.clear();
  662. fPreRenamePluginIcon.clear();
  663. #endif
  664. }
  665. void activate() noexcept override
  666. {
  667. carla_debug("CarlaEngineJackClient::activate()");
  668. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  669. {
  670. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr && ! isActive(),);
  671. try {
  672. jackbridge_activate(fJackClient);
  673. } catch(...) {}
  674. }
  675. CarlaEngineClient::activate();
  676. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  677. const CarlaMutexLocker cml(fPreRenameMutex);
  678. if (fJackClient != nullptr)
  679. {
  680. // restore pre-rename connections
  681. const char* portNameA = nullptr;
  682. const char* portNameB = nullptr;
  683. bool doConnection = false;
  684. for (CarlaStringList::Itenerator it = fPreRenameConnections.begin2(); it.valid(); it.next())
  685. {
  686. const bool connectNow = doConnection;
  687. doConnection = !doConnection;
  688. if (connectNow)
  689. portNameB = it.getValue(nullptr);
  690. else
  691. portNameA = it.getValue(nullptr);
  692. if (! connectNow)
  693. continue;
  694. CARLA_SAFE_ASSERT_CONTINUE(portNameA != nullptr && portNameA[0] != '\0');
  695. CARLA_SAFE_ASSERT_CONTINUE(portNameB != nullptr && portNameB[0] != '\0');
  696. jackbridge_connect(fJackClient, portNameA, portNameB);
  697. }
  698. if (fPreRenamePluginId.isNotEmpty())
  699. {
  700. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  701. if (char* const uuidstr = jackbridge_client_get_uuid(fJackClient))
  702. {
  703. jack_uuid_t uuid;
  704. if (jackbridge_uuid_parse(uuidstr, &uuid))
  705. {
  706. jackbridge_set_property(fJackClient, uuid,
  707. URI_MAIN_CLIENT_NAME,
  708. fMainClientName,
  709. URI_TYPE_STRING);
  710. jackbridge_set_property(fJackClient, uuid,
  711. URI_PLUGIN_ID,
  712. fPreRenamePluginId,
  713. URI_TYPE_INTEGER);
  714. if (fPreRenamePluginIcon.isNotEmpty())
  715. jackbridge_set_property(fJackClient, uuid,
  716. URI_PLUGIN_ICON,
  717. fPreRenamePluginIcon,
  718. URI_TYPE_STRING);
  719. }
  720. jackbridge_free(uuidstr);
  721. }
  722. }
  723. }
  724. fPreRenameConnections.clear();
  725. fPreRenamePluginId.clear();
  726. fPreRenamePluginIcon.clear();
  727. #endif
  728. }
  729. void deactivate(const bool willClose) noexcept override
  730. {
  731. carla_debug("CarlaEngineJackClient::deactivate(%s)", bool2str(willClose));
  732. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  733. {
  734. if (fJackClient != nullptr && isActive())
  735. {
  736. try {
  737. jackbridge_deactivate(fJackClient);
  738. } catch(...) {}
  739. }
  740. }
  741. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  742. if (willClose)
  743. {
  744. fCVSourcePorts.resetGraphAndPlugin();
  745. fReservedPluginPtr = nullptr;
  746. }
  747. #endif
  748. CarlaEngineClient::deactivate(willClose);
  749. }
  750. bool isOk() const noexcept override
  751. {
  752. if (fUseClient)
  753. return (fJackClient != nullptr);
  754. return CarlaEngineClient::isOk();
  755. }
  756. CarlaEnginePort* addPort(const EnginePortType portType, const char* const name, const bool isInput, const uint32_t indexOffset) override
  757. {
  758. carla_debug("CarlaEngineJackClient::addPort(%i:%s, \"%s\", %s)", portType, EnginePortType2Str(portType), name, bool2str(isInput));
  759. jack_port_t* jackPort = nullptr;
  760. const char* realName = name;
  761. // Create JACK port first, if needed
  762. if (fUseClient)
  763. {
  764. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr, nullptr);
  765. realName = pData->getUniquePortName(name);
  766. switch (portType)
  767. {
  768. case kEnginePortTypeNull:
  769. break;
  770. case kEnginePortTypeAudio:
  771. jackPort = jackbridge_port_register(fJackClient,
  772. realName,
  773. JACK_DEFAULT_AUDIO_TYPE,
  774. isInput ? JackPortIsInput : JackPortIsOutput,
  775. 0);
  776. break;
  777. case kEnginePortTypeCV:
  778. jackPort = jackbridge_port_register(fJackClient,
  779. realName,
  780. JACK_DEFAULT_AUDIO_TYPE,
  781. static_cast<uint64_t>(JackPortIsCV |
  782. (isInput ? JackPortIsInput
  783. : JackPortIsOutput)),
  784. 0);
  785. break;
  786. case kEnginePortTypeEvent:
  787. jackPort = jackbridge_port_register(fJackClient,
  788. realName,
  789. JACK_DEFAULT_MIDI_TYPE,
  790. isInput ? JackPortIsInput : JackPortIsOutput,
  791. 0);
  792. break;
  793. }
  794. CARLA_SAFE_ASSERT_RETURN(jackPort != nullptr, nullptr);
  795. }
  796. // Create Engine port
  797. switch (portType)
  798. {
  799. case kEnginePortTypeNull:
  800. break;
  801. case kEnginePortTypeAudio: {
  802. pData->addAudioPortName(isInput, realName);
  803. if (realName != name) delete[] realName;
  804. CarlaEngineJackAudioPort* const enginePort(new CarlaEngineJackAudioPort(*this,
  805. isInput,
  806. indexOffset,
  807. fJackClient,
  808. jackPort,
  809. fThreadSafeMetadataMutex,
  810. this));
  811. fAudioPorts.append(enginePort);
  812. return enginePort;
  813. }
  814. case kEnginePortTypeCV: {
  815. pData->addCVPortName(isInput, realName);
  816. if (realName != name) delete[] realName;
  817. CarlaEngineJackCVPort* const enginePort(new CarlaEngineJackCVPort(*this,
  818. isInput,
  819. indexOffset,
  820. fJackClient,
  821. jackPort,
  822. fThreadSafeMetadataMutex,
  823. this));
  824. fCVPorts.append(enginePort);
  825. return enginePort;
  826. }
  827. case kEnginePortTypeEvent: {
  828. pData->addEventPortName(isInput, realName);
  829. if (realName != name) delete[] realName;
  830. CarlaEngineJackEventPort* const enginePort(new CarlaEngineJackEventPort(*this,
  831. isInput,
  832. indexOffset,
  833. fJackClient,
  834. jackPort,
  835. fThreadSafeMetadataMutex,
  836. this));
  837. fEventPorts.append(enginePort);
  838. return enginePort;
  839. }
  840. }
  841. carla_stderr("CarlaEngineJackClient::addPort(%i, \"%s\", %s) - invalid type", portType, name, bool2str(isInput));
  842. return nullptr;
  843. }
  844. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  845. CarlaEngineCVSourcePorts* createCVSourcePorts() override
  846. {
  847. fCVSourcePorts.setGraphAndPlugin(getPatchbayGraphOrNull(), getPlugin());
  848. return &fCVSourcePorts;
  849. }
  850. CarlaEngineJackCVSourcePorts& getCVSourcePorts() noexcept
  851. {
  852. return fCVSourcePorts;
  853. }
  854. #endif
  855. void invalidate() noexcept
  856. {
  857. for (LinkedList<CarlaEngineJackAudioPort*>::Itenerator it = fAudioPorts.begin2(); it.valid(); it.next())
  858. {
  859. CarlaEngineJackAudioPort* const port(it.getValue(nullptr));
  860. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  861. port->invalidate();
  862. }
  863. for (LinkedList<CarlaEngineJackCVPort*>::Itenerator it = fCVPorts.begin2(); it.valid(); it.next())
  864. {
  865. CarlaEngineJackCVPort* const port(it.getValue(nullptr));
  866. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  867. port->invalidate();
  868. }
  869. for (LinkedList<CarlaEngineJackEventPort*>::Itenerator it = fEventPorts.begin2(); it.valid(); it.next())
  870. {
  871. CarlaEngineJackEventPort* const port(it.getValue(nullptr));
  872. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  873. port->invalidate();
  874. }
  875. fJackClient = nullptr;
  876. CarlaEngineClient::deactivate(true);
  877. }
  878. const char* getJackClientName() const noexcept
  879. {
  880. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr, nullptr);
  881. try {
  882. return jackbridge_get_client_name(fJackClient);
  883. } CARLA_SAFE_EXCEPTION_RETURN("jack_get_client_name", nullptr);
  884. }
  885. void jackAudioPortDeleted(CarlaEngineJackAudioPort* const port) noexcept override
  886. {
  887. fAudioPorts.removeAll(port);
  888. }
  889. void jackCVPortDeleted(CarlaEngineJackCVPort* const port) noexcept override
  890. {
  891. fCVPorts.removeAll(port);
  892. }
  893. void jackEventPortDeleted(CarlaEngineJackEventPort* const port) noexcept override
  894. {
  895. fEventPorts.removeAll(port);
  896. }
  897. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  898. bool renameInSingleClient(const String& newClientName)
  899. {
  900. const String clientNamePrefix(newClientName + ":");
  901. return _renamePorts(fAudioPorts, clientNamePrefix) &&
  902. _renamePorts(fCVPorts, clientNamePrefix) &&
  903. _renamePorts(fEventPorts, clientNamePrefix);
  904. }
  905. void closeForRename(jack_client_t* const newClient, const String& newClientName) noexcept
  906. {
  907. if (fJackClient != nullptr)
  908. {
  909. if (isActive())
  910. {
  911. {
  912. const String clientNamePrefix(newClientName + ":");
  913. // store current client connections
  914. const CarlaMutexLocker cml(fPreRenameMutex);
  915. fPreRenameConnections.clear();
  916. fPreRenamePluginId.clear();
  917. fPreRenamePluginIcon.clear();
  918. _savePortsConnections(fAudioPorts, clientNamePrefix);
  919. _savePortsConnections(fCVPorts, clientNamePrefix);
  920. _savePortsConnections(fEventPorts, clientNamePrefix);
  921. _saveProperties();
  922. }
  923. try {
  924. jackbridge_deactivate(fJackClient);
  925. } catch(...) {}
  926. }
  927. try {
  928. jackbridge_client_close(fJackClient);
  929. } catch(...) {}
  930. invalidate();
  931. }
  932. fAudioPorts.clear();
  933. fCVPorts.clear();
  934. fEventPorts.clear();
  935. pData->clearPorts();
  936. fJackClient = newClient;
  937. }
  938. void reservePluginPtr(CarlaPluginPtr* const pluginPtr)
  939. {
  940. fReservedPluginPtr = pluginPtr;
  941. }
  942. void setNewPluginId(const uint id) const
  943. {
  944. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr,);
  945. // NOTE: no fThreadSafeMetadataMutex lock here, assumed done from caller
  946. if (char* const uuidstr = jackbridge_client_get_uuid(fJackClient))
  947. {
  948. jack_uuid_t uuid;
  949. if (jackbridge_uuid_parse(uuidstr, &uuid))
  950. {
  951. char buf[32];
  952. std::snprintf(buf, 31, "%u", id);
  953. buf[31] = '\0';
  954. jackbridge_set_property(fJackClient, uuid,
  955. URI_PLUGIN_ID,
  956. buf,
  957. URI_TYPE_INTEGER);
  958. }
  959. jackbridge_free(uuidstr);
  960. }
  961. }
  962. #endif
  963. private:
  964. jack_client_t* fJackClient;
  965. const bool fUseClient;
  966. LinkedList<CarlaEngineJackAudioPort*> fAudioPorts;
  967. LinkedList<CarlaEngineJackCVPort*> fCVPorts;
  968. LinkedList<CarlaEngineJackEventPort*> fEventPorts;
  969. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  970. CarlaEngineJackCVSourcePorts fCVSourcePorts;
  971. CarlaMutex fPreRenameMutex;
  972. CarlaStringList fPreRenameConnections;
  973. String fPreRenamePluginId;
  974. String fPreRenamePluginIcon;
  975. ScopedPointer<CarlaPluginPtr> fReservedPluginPtr;
  976. template<typename T>
  977. bool _renamePorts(const LinkedList<T*>& t, const String& clientNamePrefix)
  978. {
  979. for (typename LinkedList<T*>::Itenerator it = t.begin2(); it.valid(); it.next())
  980. {
  981. T* const port(it.getValue(nullptr));
  982. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  983. CARLA_SAFE_ASSERT_CONTINUE(port->fJackPort != nullptr);
  984. const char* shortPortName(jackbridge_port_short_name(port->fJackPort));
  985. CARLA_SAFE_ASSERT_CONTINUE(shortPortName != nullptr && shortPortName[0] != '\0');
  986. const char* const oldClientNameSep(std::strstr(shortPortName, ":"));
  987. CARLA_SAFE_ASSERT_CONTINUE(oldClientNameSep != nullptr && oldClientNameSep[0] != '\0' && oldClientNameSep[1] != '\0');
  988. shortPortName += oldClientNameSep-shortPortName + 1;
  989. const String newPortName(clientNamePrefix + shortPortName);
  990. if (! jackbridge_port_rename(fJackClient, port->fJackPort, newPortName))
  991. return false;
  992. }
  993. return true;
  994. }
  995. template<typename T>
  996. void _savePortsConnections(const LinkedList<T*>& t, const String& clientNamePrefix)
  997. {
  998. for (typename LinkedList<T*>::Itenerator it = t.begin2(); it.valid(); it.next())
  999. {
  1000. T* const port(it.getValue(nullptr));
  1001. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  1002. CARLA_SAFE_ASSERT_CONTINUE(port->fJackPort != nullptr);
  1003. const char* const shortPortName(jackbridge_port_short_name(port->fJackPort));
  1004. CARLA_SAFE_ASSERT_CONTINUE(shortPortName != nullptr && shortPortName[0] != '\0');
  1005. const String portName(clientNamePrefix + shortPortName);
  1006. if (const char** const connections = jackbridge_port_get_all_connections(fJackClient, port->fJackPort))
  1007. {
  1008. for (int i=0; connections[i] != nullptr; ++i)
  1009. {
  1010. if (port->kIsInput)
  1011. {
  1012. fPreRenameConnections.append(connections[i]);
  1013. fPreRenameConnections.append(portName);
  1014. }
  1015. else
  1016. {
  1017. fPreRenameConnections.append(portName);
  1018. fPreRenameConnections.append(connections[i]);
  1019. }
  1020. }
  1021. jackbridge_free(connections);
  1022. }
  1023. }
  1024. }
  1025. void _saveProperties()
  1026. {
  1027. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  1028. if (char* const uuidstr = jackbridge_client_get_uuid(fJackClient))
  1029. {
  1030. jack_uuid_t uuid;
  1031. const bool parsed = jackbridge_uuid_parse(uuidstr, &uuid);
  1032. jackbridge_free(uuidstr);
  1033. CARLA_CUSTOM_SAFE_ASSERT_ONCE_RETURN("JACK meta-data support unavailable", parsed,);
  1034. char* value = nullptr;
  1035. char* type = nullptr;
  1036. CARLA_SAFE_ASSERT_RETURN(jackbridge_get_property(uuid,
  1037. URI_PLUGIN_ID,
  1038. &value,
  1039. &type),);
  1040. CARLA_SAFE_ASSERT_RETURN(type != nullptr,);
  1041. CARLA_SAFE_ASSERT_RETURN(std::strcmp(type, URI_TYPE_INTEGER) == 0,);
  1042. fPreRenamePluginId = value;
  1043. jackbridge_free(value);
  1044. jackbridge_free(type);
  1045. value = type = nullptr;
  1046. if (jackbridge_get_property(uuid, URI_PLUGIN_ICON, &value, &type))
  1047. {
  1048. CARLA_SAFE_ASSERT_RETURN(type != nullptr,);
  1049. CARLA_SAFE_ASSERT_RETURN(std::strcmp(type, URI_TYPE_STRING) == 0,);
  1050. fPreRenamePluginIcon = value;
  1051. jackbridge_free(value);
  1052. jackbridge_free(type);
  1053. }
  1054. }
  1055. }
  1056. #endif // BUILD_BRIDGE_ALTERNATIVE_ARCH
  1057. CarlaRecursiveMutex& fThreadSafeMetadataMutex;
  1058. const String& fMainClientName;
  1059. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackClient)
  1060. };
  1061. // -----------------------------------------------------------------------
  1062. // Jack Engine
  1063. class CarlaEngineJack : public CarlaEngine
  1064. #ifndef BUILD_BRIDGE
  1065. , private CarlaThread
  1066. #endif
  1067. {
  1068. public:
  1069. CarlaEngineJack()
  1070. : CarlaEngine(),
  1071. #ifndef BUILD_BRIDGE
  1072. CarlaThread("CarlaEngineJackCallbacks"),
  1073. #endif
  1074. fClient(nullptr),
  1075. fExternalPatchbayHost(true),
  1076. fExternalPatchbayOsc(true),
  1077. fFreewheel(false),
  1078. fClientName(),
  1079. fThreadSafeMetadataMutex(),
  1080. #ifdef BUILD_BRIDGE
  1081. fIsRunning(false)
  1082. #else
  1083. fClientNamePrefix(),
  1084. fTimebaseMaster(false),
  1085. fTimebaseRolling(false),
  1086. fTimebaseUsecs(0),
  1087. fUsedGroups(),
  1088. fUsedPorts(),
  1089. fUsedConnections(),
  1090. fPatchbayProcThreadProtectionMutex(),
  1091. fRetConns(),
  1092. fLastPatchbaySetGroupPos(),
  1093. fPostPonedEvents(),
  1094. fPostPonedEventsMutex(),
  1095. fIsInternalClient(false)
  1096. #endif
  1097. {
  1098. carla_debug("CarlaEngineJack::CarlaEngineJack()");
  1099. #ifdef BUILD_BRIDGE
  1100. pData->options.processMode = ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS;
  1101. #else
  1102. carla_zeroPointers(fRackPorts, kRackPortCount);
  1103. #endif
  1104. }
  1105. ~CarlaEngineJack() noexcept override
  1106. {
  1107. carla_debug("CarlaEngineJack::~CarlaEngineJack()");
  1108. CARLA_SAFE_ASSERT(fClient == nullptr);
  1109. #ifndef BUILD_BRIDGE
  1110. fUsedGroups.clear();
  1111. fUsedPorts.clear();
  1112. fUsedConnections.clear();
  1113. CARLA_SAFE_ASSERT(fPostPonedEvents.count() == 0);
  1114. #endif
  1115. }
  1116. // -------------------------------------------------------------------
  1117. // Maximum values
  1118. uint getMaxClientNameSize() const noexcept override
  1119. {
  1120. #ifndef BUILD_BRIDGE
  1121. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT ||
  1122. pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1123. #endif
  1124. {
  1125. try {
  1126. return static_cast<uint>(jackbridge_client_name_size()-1);
  1127. } CARLA_SAFE_EXCEPTION_RETURN("jack_client_name_size", 32);
  1128. }
  1129. return CarlaEngine::getMaxClientNameSize();
  1130. }
  1131. uint getMaxPortNameSize() const noexcept override
  1132. {
  1133. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT || pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1134. {
  1135. try {
  1136. return static_cast<uint>(jackbridge_port_name_size()-1);
  1137. } CARLA_SAFE_EXCEPTION_RETURN("jack_port_name_size", 255);
  1138. }
  1139. return CarlaEngine::getMaxPortNameSize();
  1140. }
  1141. // -------------------------------------------------------------------
  1142. // Virtual, per-engine type calls
  1143. bool init(const char* const clientName) override
  1144. {
  1145. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr || (clientName != nullptr && clientName[0] != '\0'), false);
  1146. carla_debug("CarlaEngineJack::init(\"%s\")", clientName);
  1147. if (!jackbridge_is_ok())
  1148. {
  1149. setLastError("JACK is not available or installed");
  1150. return false;
  1151. }
  1152. fFreewheel = false;
  1153. fExternalPatchbayHost = true;
  1154. fExternalPatchbayOsc = true;
  1155. String truncatedClientName;
  1156. if (fClient == nullptr && clientName != nullptr)
  1157. {
  1158. truncatedClientName = clientName;
  1159. truncatedClientName.truncate(getMaxClientNameSize());
  1160. }
  1161. #ifdef BUILD_BRIDGE
  1162. fIsRunning = true;
  1163. if (! pData->init(truncatedClientName))
  1164. {
  1165. close();
  1166. setLastError("Failed to init internal data");
  1167. return false;
  1168. }
  1169. if (pData->bufferSize == 0 || carla_isEqual(pData->sampleRate, 0.0))
  1170. {
  1171. // open temp client to get initial buffer-size and sample-rate values
  1172. if (jack_client_t* const tmpClient = jackbridge_client_open(truncatedClientName, JackNoStartServer, nullptr))
  1173. {
  1174. pData->bufferSize = jackbridge_get_buffer_size(tmpClient);
  1175. pData->sampleRate = jackbridge_get_sample_rate(tmpClient);
  1176. jackbridge_client_close(tmpClient);
  1177. }
  1178. else
  1179. {
  1180. close();
  1181. setLastError("Failed to init temporary jack client");
  1182. return false;
  1183. }
  1184. }
  1185. return true;
  1186. #else // BUILD_BRIDGE
  1187. if (fClient == nullptr && clientName != nullptr)
  1188. fClient = jackbridge_client_open(truncatedClientName, JackNoStartServer, nullptr);
  1189. if (fClient == nullptr)
  1190. {
  1191. setLastError("Failed to create new JACK client");
  1192. return false;
  1193. }
  1194. const char* const jackClientName = jackbridge_get_client_name(fClient);
  1195. if (! pData->init(jackClientName))
  1196. {
  1197. jackbridge_client_close(fClient);
  1198. fClient = nullptr;
  1199. setLastError("Failed to init internal data");
  1200. return false;
  1201. }
  1202. // if main jack client does not match our requested one, setup client name prefix as needed
  1203. if (truncatedClientName != jackClientName)
  1204. {
  1205. if (const char* const suffix = std::strrchr(jackClientName, '-'))
  1206. {
  1207. if (fClientNamePrefix.isNotEmpty())
  1208. {
  1209. fClientNamePrefix.truncate(fClientNamePrefix.rfind('.') + 1);
  1210. }
  1211. else
  1212. {
  1213. fClientNamePrefix = truncatedClientName;
  1214. fClientNamePrefix += ".";
  1215. }
  1216. fClientNamePrefix += suffix + 1;
  1217. fClientNamePrefix += "/";
  1218. }
  1219. }
  1220. fClientName = jackClientName;
  1221. const EngineOptions& opts(pData->options);
  1222. pData->bufferSize = jackbridge_get_buffer_size(fClient);
  1223. pData->sampleRate = jackbridge_get_sample_rate(fClient);
  1224. pData->initTime(opts.transportExtra);
  1225. jackbridge_set_thread_init_callback(fClient, carla_jack_thread_init_callback, nullptr);
  1226. jackbridge_set_buffer_size_callback(fClient, carla_jack_bufsize_callback, this);
  1227. jackbridge_set_sample_rate_callback(fClient, carla_jack_srate_callback, this);
  1228. jackbridge_set_freewheel_callback(fClient, carla_jack_freewheel_callback, this);
  1229. // jackbridge_set_latency_callback(fClient, carla_jack_latency_callback, this);
  1230. jackbridge_set_process_callback(fClient, carla_jack_process_callback, this);
  1231. jackbridge_on_shutdown(fClient, carla_jack_shutdown_callback, this);
  1232. fTimebaseRolling = false;
  1233. if (opts.transportMode == ENGINE_TRANSPORT_MODE_JACK)
  1234. fTimebaseMaster = jackbridge_set_timebase_callback(fClient, true, carla_jack_timebase_callback, this);
  1235. else
  1236. fTimebaseMaster = false;
  1237. initJackPatchbay(true, false, jackClientName, pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY);
  1238. jackbridge_set_client_registration_callback(fClient, carla_jack_client_registration_callback, this);
  1239. jackbridge_set_port_registration_callback(fClient, carla_jack_port_registration_callback, this);
  1240. jackbridge_set_port_connect_callback(fClient, carla_jack_port_connect_callback, this);
  1241. jackbridge_set_port_rename_callback(fClient, carla_jack_port_rename_callback, this);
  1242. jackbridge_set_property_change_callback(fClient, carla_jack_property_change_callback, this);
  1243. jackbridge_set_xrun_callback(fClient, carla_jack_xrun_callback, this);
  1244. if (opts.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK || opts.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1245. {
  1246. fRackPorts[kRackPortAudioIn1] = jackbridge_port_register(fClient, "audio-in1", JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
  1247. fRackPorts[kRackPortAudioIn2] = jackbridge_port_register(fClient, "audio-in2", JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
  1248. fRackPorts[kRackPortAudioOut1] = jackbridge_port_register(fClient, "audio-out1", JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
  1249. fRackPorts[kRackPortAudioOut2] = jackbridge_port_register(fClient, "audio-out2", JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
  1250. fRackPorts[kRackPortEventIn] = jackbridge_port_register(fClient, "events-in", JACK_DEFAULT_MIDI_TYPE, JackPortIsInput, 0);
  1251. fRackPorts[kRackPortEventOut] = jackbridge_port_register(fClient, "events-out", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
  1252. if (opts.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  1253. {
  1254. // FIXME?
  1255. pData->graph.create(0, 0, 0, 0);
  1256. }
  1257. else
  1258. {
  1259. pData->graph.create(2, 2, 0, 0);
  1260. // pData->graph.setUsingExternalHost(true);
  1261. // pData->graph.setUsingExternalOSC(true);
  1262. patchbayRefresh(true, false, false);
  1263. }
  1264. }
  1265. # ifdef HAVE_LIBLO
  1266. {
  1267. const String& tcp(pData->osc.getServerPathTCP());
  1268. const String& udp(pData->osc.getServerPathUDP());
  1269. if (tcp.isNotEmpty() || udp.isNotEmpty())
  1270. {
  1271. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  1272. if (char* const uuidstr = jackbridge_client_get_uuid(fClient))
  1273. {
  1274. jack_uuid_t uuid;
  1275. if (jackbridge_uuid_parse(uuidstr, &uuid))
  1276. {
  1277. if (tcp.isNotEmpty())
  1278. jackbridge_set_property(fClient, uuid,
  1279. "https://kx.studio/ns/carla/osc-tcp", tcp, URI_TYPE_STRING);
  1280. if (udp.isNotEmpty())
  1281. jackbridge_set_property(fClient, uuid,
  1282. "https://kx.studio/ns/carla/osc-udp", udp, URI_TYPE_STRING);
  1283. }
  1284. jackbridge_free(uuidstr);
  1285. }
  1286. }
  1287. }
  1288. # endif
  1289. if (jackbridge_activate(fClient))
  1290. {
  1291. if (opts.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1292. opts.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1293. {
  1294. if (pData->options.audioDevice != nullptr &&
  1295. std::strcmp(pData->options.audioDevice, "Auto-Connect ON") == 0 &&
  1296. std::getenv("LADISH_APP_NAME") == nullptr &&
  1297. std::getenv("NSM_URL") == nullptr)
  1298. {
  1299. char strBuf[STR_MAX];
  1300. if (jackbridge_port_by_name(fClient, "system:capture_1") != nullptr)
  1301. {
  1302. std::snprintf(strBuf, STR_MAX, "%s:audio-in1", jackClientName);
  1303. strBuf[STR_MAX-1] = '\0';
  1304. jackbridge_connect(fClient, "system:capture_1", strBuf);
  1305. std::snprintf(strBuf, STR_MAX, "%s:audio-in2", jackClientName);
  1306. strBuf[STR_MAX-1] = '\0';
  1307. if (jackbridge_port_by_name(fClient, "system:capture_2") != nullptr)
  1308. jackbridge_connect(fClient, "system:capture_2", strBuf);
  1309. else
  1310. jackbridge_connect(fClient, "system:capture_1", strBuf);
  1311. }
  1312. if (jackbridge_port_by_name(fClient, "system:playback_1") != nullptr)
  1313. {
  1314. std::snprintf(strBuf, STR_MAX, "%s:audio-out1", jackClientName);
  1315. strBuf[STR_MAX-1] = '\0';
  1316. jackbridge_connect(fClient, strBuf, "system:playback_1");
  1317. std::snprintf(strBuf, STR_MAX, "%s:audio-out2", jackClientName);
  1318. strBuf[STR_MAX-1] = '\0';
  1319. if (jackbridge_port_by_name(fClient, "system:playback_2") != nullptr)
  1320. jackbridge_connect(fClient, strBuf, "system:playback_2");
  1321. else
  1322. jackbridge_connect(fClient, strBuf, "system:playback_1");
  1323. }
  1324. }
  1325. }
  1326. if (fIsInternalClient)
  1327. startThread();
  1328. callback(true, true,
  1329. ENGINE_CALLBACK_ENGINE_STARTED, 0,
  1330. opts.processMode,
  1331. opts.transportMode,
  1332. static_cast<int>(pData->bufferSize),
  1333. static_cast<float>(pData->sampleRate),
  1334. getCurrentDriverName());
  1335. return true;
  1336. }
  1337. if (opts.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1338. opts.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1339. {
  1340. pData->graph.destroy();
  1341. }
  1342. pData->close();
  1343. jackbridge_client_close(fClient);
  1344. fClient = nullptr;
  1345. setLastError("Failed to activate the JACK client");
  1346. return false;
  1347. #endif // BUILD_BRIDGE
  1348. }
  1349. #ifndef BUILD_BRIDGE
  1350. bool initInternal(jack_client_t* const client)
  1351. {
  1352. fClient = client;
  1353. fIsInternalClient = true;
  1354. return init(nullptr);
  1355. }
  1356. #endif
  1357. bool close() override
  1358. {
  1359. carla_debug("CarlaEngineJack::close()");
  1360. #ifdef BUILD_BRIDGE
  1361. fClient = nullptr;
  1362. fIsRunning = false;
  1363. CarlaEngine::close();
  1364. return true;
  1365. #else
  1366. if (fIsInternalClient)
  1367. stopThread(-1);
  1368. // deactivate client ASAP
  1369. if (fClient != nullptr)
  1370. jackbridge_deactivate(fClient);
  1371. // clear engine data
  1372. CarlaEngine::close();
  1373. // now close client
  1374. if (fClient != nullptr)
  1375. {
  1376. jackbridge_client_close(fClient);
  1377. fClient = nullptr;
  1378. }
  1379. fClientName.clear();
  1380. fUsedGroups.clear();
  1381. fUsedPorts.clear();
  1382. fUsedConnections.clear();
  1383. fPostPonedEvents.clear();
  1384. // clear rack/patchbay stuff
  1385. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1386. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1387. {
  1388. carla_zeroPointers(fRackPorts, kRackPortCount);
  1389. pData->graph.destroy();
  1390. }
  1391. return true;
  1392. #endif
  1393. }
  1394. bool hasIdleOnMainThread() const noexcept override
  1395. {
  1396. #ifndef BUILD_BRIDGE
  1397. return !fIsInternalClient;
  1398. #else
  1399. return true;
  1400. #endif
  1401. }
  1402. bool isRunning() const noexcept override
  1403. {
  1404. #ifdef BUILD_BRIDGE
  1405. return (fClient != nullptr || fIsRunning);
  1406. #else
  1407. return (fClient != nullptr);
  1408. #endif
  1409. }
  1410. bool isOffline() const noexcept override
  1411. {
  1412. return fFreewheel;
  1413. }
  1414. EngineType getType() const noexcept override
  1415. {
  1416. return kEngineTypeJack;
  1417. }
  1418. const char* getCurrentDriverName() const noexcept override
  1419. {
  1420. return "JACK";
  1421. }
  1422. #ifndef BUILD_BRIDGE
  1423. float getDSPLoad() const noexcept override
  1424. {
  1425. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, 0.0f);
  1426. return jackbridge_cpu_load(fClient);
  1427. }
  1428. void callback(const bool sendHost, const bool sendOsc,
  1429. const EngineCallbackOpcode action, const uint pluginId,
  1430. const int value1, const int value2, const int value3,
  1431. const float valuef, const char* const valueStr) noexcept override
  1432. {
  1433. if (action == ENGINE_CALLBACK_PROJECT_LOAD_FINISHED)
  1434. {
  1435. if (fTimebaseMaster)
  1436. {
  1437. // project finished loading, need to set bpm here, so we force an update of timebase master
  1438. transportRelocate(pData->timeInfo.frame);
  1439. }
  1440. }
  1441. CarlaEngine::callback(sendHost, sendOsc, action, pluginId, value1, value2, value3, valuef, valueStr);
  1442. }
  1443. void idle() noexcept override
  1444. {
  1445. LinkedList<PostPonedJackEvent> events;
  1446. const PostPonedJackEvent nullEvent = {};
  1447. {
  1448. const CarlaMutexLocker cml(fPostPonedEventsMutex);
  1449. if (fPostPonedEvents.count() > 0)
  1450. fPostPonedEvents.moveTo(events);
  1451. }
  1452. for (LinkedList<PostPonedJackEvent>::Itenerator it = events.begin2(); it.valid(); it.next())
  1453. {
  1454. const PostPonedJackEvent& ev(it.getValue(nullEvent));
  1455. CARLA_SAFE_ASSERT_CONTINUE(ev.type != PostPonedJackEvent::kTypeNull);
  1456. switch (ev.type)
  1457. {
  1458. case PostPonedJackEvent::kTypeNull:
  1459. break;
  1460. case PostPonedJackEvent::kTypeClientUnregister:
  1461. handleJackClientUnregistrationCallback(ev.clientUnregister.name);
  1462. break;
  1463. case PostPonedJackEvent::kTypePortRegister:
  1464. handleJackPortRegistrationCallback(ev.portRegister.fullName,
  1465. ev.portRegister.shortName,
  1466. ev.portRegister.hints);
  1467. break;
  1468. case PostPonedJackEvent::kTypePortUnregister:
  1469. handleJackPortUnregistrationCallback(ev.portUnregister.fullName);
  1470. break;
  1471. case PostPonedJackEvent::kTypePortConnect:
  1472. handleJackPortConnectCallback(ev.portConnect.portNameA,
  1473. ev.portConnect.portNameB);
  1474. break;
  1475. case PostPonedJackEvent::kTypePortDisconnect:
  1476. handleJackPortDisconnectCallback(ev.portDisconnect.portNameA,
  1477. ev.portDisconnect.portNameB);
  1478. break;
  1479. case PostPonedJackEvent::kTypePortRename:
  1480. handleJackPortRenameCallback(ev.portRename.oldFullName,
  1481. ev.portRename.newFullName,
  1482. ev.portRename.newShortName);
  1483. break;
  1484. case PostPonedJackEvent::kTypeClientPositionChange:
  1485. handleJackClientPositionChangeCallback(ev.clientPositionChange.uuid);
  1486. break;
  1487. }
  1488. }
  1489. events.clear();
  1490. CarlaEngine::idle();
  1491. }
  1492. #endif
  1493. bool setBufferSizeAndSampleRate(const uint bufferSize, const double sampleRate) override
  1494. {
  1495. CARLA_SAFE_ASSERT_RETURN(carla_isEqual(pData->sampleRate, sampleRate), false);
  1496. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  1497. try {
  1498. return jackbridge_set_buffer_size(fClient, bufferSize);
  1499. } CARLA_SAFE_EXCEPTION_RETURN("setBufferSizeAndSampleRate", false);
  1500. }
  1501. EngineTimeInfo getTimeInfo() const noexcept override
  1502. {
  1503. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  1504. return CarlaEngine::getTimeInfo();
  1505. if (pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1506. return CarlaEngine::getTimeInfo();
  1507. jack_position_t jpos;
  1508. // invalidate
  1509. jpos.unique_1 = 1;
  1510. jpos.unique_2 = 2;
  1511. EngineTimeInfo timeInfo;
  1512. const bool playing = jackbridge_transport_query(fClient, &jpos) == JackTransportRolling;
  1513. if (jpos.unique_1 != jpos.unique_2)
  1514. {
  1515. timeInfo.playing = false;
  1516. timeInfo.frame = 0;
  1517. timeInfo.usecs = 0;
  1518. timeInfo.bbt.valid = false;
  1519. return timeInfo;
  1520. }
  1521. timeInfo.playing = playing;
  1522. timeInfo.frame = jpos.frame;
  1523. timeInfo.usecs = jpos.usecs;
  1524. if (jpos.valid & JackPositionBBT)
  1525. {
  1526. timeInfo.bbt.valid = true;
  1527. timeInfo.bbt.bar = jpos.bar;
  1528. timeInfo.bbt.beat = jpos.beat;
  1529. #ifdef JACK_TICK_DOUBLE
  1530. if (jpos.valid & JackTickDouble)
  1531. timeInfo.bbt.tick = jpos.tick_double;
  1532. else
  1533. #endif
  1534. timeInfo.bbt.tick = jpos.tick;
  1535. timeInfo.bbt.barStartTick = jpos.bar_start_tick;
  1536. timeInfo.bbt.beatsPerBar = jpos.beats_per_bar;
  1537. timeInfo.bbt.beatType = jpos.beat_type;
  1538. timeInfo.bbt.ticksPerBeat = jpos.ticks_per_beat;
  1539. timeInfo.bbt.beatsPerMinute = jpos.beats_per_minute;
  1540. }
  1541. else
  1542. {
  1543. timeInfo.bbt.valid = false;
  1544. }
  1545. return timeInfo;
  1546. }
  1547. #ifndef BUILD_BRIDGE
  1548. void setOption(const EngineOption option, const int value, const char* const valueStr) noexcept override
  1549. {
  1550. if (option == ENGINE_OPTION_TRANSPORT_MODE && fClient != nullptr)
  1551. {
  1552. CARLA_SAFE_ASSERT_INT_RETURN(value >= ENGINE_TRANSPORT_MODE_DISABLED &&
  1553. value <= ENGINE_TRANSPORT_MODE_JACK, value,);
  1554. if (value == ENGINE_TRANSPORT_MODE_JACK)
  1555. {
  1556. fTimebaseMaster = jackbridge_set_timebase_callback(fClient, true, carla_jack_timebase_callback, this);
  1557. }
  1558. else
  1559. {
  1560. // jack transport cannot be disabled in multi-client
  1561. callback(true, true,
  1562. ENGINE_CALLBACK_TRANSPORT_MODE_CHANGED, 0,
  1563. ENGINE_TRANSPORT_MODE_JACK,
  1564. 0, 0, 0.0f,
  1565. pData->options.transportExtra);
  1566. CARLA_SAFE_ASSERT_RETURN(pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS,);
  1567. jackbridge_release_timebase(fClient);
  1568. fTimebaseMaster = false;
  1569. }
  1570. }
  1571. else if (option == ENGINE_OPTION_CLIENT_NAME_PREFIX)
  1572. {
  1573. fClientNamePrefix = valueStr;
  1574. if (fClientNamePrefix.isNotEmpty())
  1575. {
  1576. if (! fClientNamePrefix.contains('.'))
  1577. fClientNamePrefix += ".0";
  1578. if (! fClientNamePrefix.endsWith('/'))
  1579. fClientNamePrefix += "/";
  1580. }
  1581. }
  1582. CarlaEngine::setOption(option, value, valueStr);
  1583. }
  1584. #endif
  1585. CarlaEngineClient* addClient(CarlaPluginPtr plugin) override
  1586. {
  1587. jack_client_t* client = nullptr;
  1588. #ifndef BUILD_BRIDGE
  1589. CARLA_CUSTOM_SAFE_ASSERT_RETURN("Not connected to JACK", fClient != nullptr, nullptr);
  1590. CarlaPluginPtr* pluginReserve = nullptr;
  1591. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  1592. {
  1593. client = fClient;
  1594. }
  1595. else if (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1596. #endif
  1597. {
  1598. #ifndef BUILD_BRIDGE
  1599. if (fClientNamePrefix.isNotEmpty())
  1600. {
  1601. client = jackbridge_client_open(fClientNamePrefix + plugin->getName(), JackNoStartServer, nullptr);
  1602. }
  1603. else
  1604. #endif
  1605. {
  1606. client = jackbridge_client_open(plugin->getName(), JackNoStartServer, nullptr);
  1607. }
  1608. CARLA_CUSTOM_SAFE_ASSERT_RETURN("Failure to open client", client != nullptr, nullptr);
  1609. jackbridge_set_thread_init_callback(client, carla_jack_thread_init_callback, nullptr);
  1610. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  1611. if (char* const uuidstr = jackbridge_client_get_uuid(client))
  1612. {
  1613. jack_uuid_t uuid;
  1614. if (jackbridge_uuid_parse(uuidstr, &uuid))
  1615. {
  1616. char strBufId[24];
  1617. std::snprintf(strBufId, 23, "%u", plugin->getId());
  1618. strBufId[23] = '\0';
  1619. #ifndef BUILD_BRIDGE
  1620. jackbridge_set_property(client, uuid,
  1621. URI_MAIN_CLIENT_NAME,
  1622. fClientName,
  1623. URI_TYPE_STRING);
  1624. jackbridge_set_property(client, uuid,
  1625. URI_PLUGIN_ID,
  1626. strBufId,
  1627. URI_TYPE_INTEGER);
  1628. #endif
  1629. if (const char* const pluginIcon = plugin->getIconName())
  1630. jackbridge_set_property(client, uuid,
  1631. URI_PLUGIN_ICON,
  1632. pluginIcon,
  1633. URI_TYPE_STRING);
  1634. }
  1635. jackbridge_free(uuidstr);
  1636. }
  1637. #ifndef BUILD_BRIDGE
  1638. pluginReserve = new CarlaPluginPtr(plugin);
  1639. /*
  1640. jackbridge_set_buffer_size_callback(fClient, carla_jack_bufsize_callback_plugin, pluginReserve);
  1641. jackbridge_set_sample_rate_callback(fClient, carla_jack_srate_callback_plugin, pluginReserve);
  1642. */
  1643. // jackbridge_set_latency_callback(client, carla_jack_latency_callback_plugin, pluginReserve);
  1644. jackbridge_set_process_callback(client, carla_jack_process_callback_plugin, pluginReserve);
  1645. jackbridge_on_shutdown(client, carla_jack_shutdown_callback_plugin, pluginReserve);
  1646. #else
  1647. fClient = client;
  1648. pData->bufferSize = jackbridge_get_buffer_size(client);
  1649. pData->sampleRate = jackbridge_get_sample_rate(client);
  1650. pData->initTime(nullptr);
  1651. jackbridge_set_buffer_size_callback(client, carla_jack_bufsize_callback, this);
  1652. jackbridge_set_sample_rate_callback(client, carla_jack_srate_callback, this);
  1653. jackbridge_set_freewheel_callback(client, carla_jack_freewheel_callback, this);
  1654. // jackbridge_set_latency_callback(client, carla_jack_latency_callback, this);
  1655. jackbridge_set_process_callback(client, carla_jack_process_callback, this);
  1656. jackbridge_on_shutdown(client, carla_jack_shutdown_callback, this);
  1657. fClientName = jackbridge_get_client_name(client);
  1658. #endif
  1659. }
  1660. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  1661. carla_debug("new CarlaEngineJackClient");
  1662. CarlaEngineJackClient* const jclient = new CarlaEngineJackClient(*this,
  1663. pData->graph,
  1664. fThreadSafeMetadataMutex,
  1665. plugin, fClientName, client);
  1666. # ifndef BUILD_BRIDGE
  1667. if (pluginReserve != nullptr)
  1668. jclient->reservePluginPtr(pluginReserve);
  1669. # endif
  1670. return jclient;
  1671. #else
  1672. return new CarlaEngineJackClient(*this, fThreadSafeMetadataMutex, fClientName, client);
  1673. #endif
  1674. }
  1675. #ifndef BUILD_BRIDGE
  1676. bool removePlugin(const uint id) override
  1677. {
  1678. if (! CarlaEngine::removePlugin(id))
  1679. return false;
  1680. if (pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1681. return true;
  1682. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  1683. for (uint i=id; i < pData->curPluginCount; ++i)
  1684. {
  1685. const CarlaPluginPtr plugin = pData->plugins[i].plugin;
  1686. CARLA_SAFE_ASSERT_BREAK(plugin.get() != nullptr);
  1687. CarlaEngineJackClient* const client = dynamic_cast<CarlaEngineJackClient*>(plugin->getEngineClient());
  1688. CARLA_SAFE_ASSERT_BREAK(client != nullptr);
  1689. client->setNewPluginId(i);
  1690. }
  1691. return true;
  1692. }
  1693. bool switchPlugins(const uint idA, const uint idB) noexcept override
  1694. {
  1695. if (! CarlaEngine::switchPlugins(idA, idB))
  1696. return false;
  1697. if (pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1698. return true;
  1699. CarlaPluginPtr newPluginA = pData->plugins[idA].plugin;
  1700. CARLA_SAFE_ASSERT_RETURN(newPluginA.get() != nullptr, true);
  1701. CarlaPluginPtr newPluginB = pData->plugins[idB].plugin;
  1702. CARLA_SAFE_ASSERT_RETURN(newPluginB.get() != nullptr, true);
  1703. CarlaEngineJackClient* const clientA = dynamic_cast<CarlaEngineJackClient*>(newPluginA->getEngineClient());
  1704. CARLA_SAFE_ASSERT_RETURN(clientA != nullptr, true);
  1705. CarlaEngineJackClient* const clientB = dynamic_cast<CarlaEngineJackClient*>(newPluginB->getEngineClient());
  1706. CARLA_SAFE_ASSERT_RETURN(clientB != nullptr, true);
  1707. {
  1708. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  1709. clientA->setNewPluginId(idA);
  1710. clientB->setNewPluginId(idB);
  1711. }
  1712. return true;
  1713. }
  1714. bool renamePlugin(const uint id, const char* const newName) override
  1715. {
  1716. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1717. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1718. {
  1719. return CarlaEngine::renamePlugin(id, newName);
  1720. }
  1721. CARLA_SAFE_ASSERT_RETURN(pData->plugins != nullptr, false);
  1722. CARLA_SAFE_ASSERT_RETURN(pData->curPluginCount != 0, false);
  1723. CARLA_SAFE_ASSERT_RETURN(id < pData->curPluginCount, false);
  1724. CARLA_SAFE_ASSERT_RETURN(newName != nullptr && newName[0] != '\0', false);
  1725. CarlaPluginPtr plugin = pData->plugins[id].plugin;
  1726. CARLA_SAFE_ASSERT_RETURN_ERR(plugin.get() != nullptr, "Could not find plugin to rename");
  1727. CARLA_SAFE_ASSERT_RETURN_ERR(plugin->getId() == id, "Invalid engine internal data");
  1728. // before we stop the engine thread we might need to get the plugin data
  1729. const bool needsReinit = (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS);
  1730. const CarlaStateSave* saveStatePtr = nullptr;
  1731. if (needsReinit)
  1732. {
  1733. const CarlaStateSave& saveState(plugin->getStateSave());
  1734. saveStatePtr = &saveState;
  1735. }
  1736. String uniqueName;
  1737. try {
  1738. const char* const tmpName = getUniquePluginName(newName);
  1739. uniqueName = tmpName;
  1740. delete[] tmpName;
  1741. } CARLA_SAFE_EXCEPTION("JACK renamePlugin getUniquePluginName");
  1742. if (uniqueName.isEmpty())
  1743. {
  1744. setLastError("Failed to request new unique plugin name");
  1745. return false;
  1746. }
  1747. const ScopedRunnerStopper srs(this);
  1748. // rename on client client mode, just rename the ports
  1749. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  1750. {
  1751. CarlaEngineJackClient* const client((CarlaEngineJackClient*)plugin->getEngineClient());
  1752. if (! client->renameInSingleClient(uniqueName))
  1753. {
  1754. setLastError("Failed to rename some JACK ports, does your JACK version support proper port renaming?");
  1755. return false;
  1756. }
  1757. }
  1758. // rename in multiple client mode
  1759. else if (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1760. {
  1761. CarlaEngineJackClient* const client((CarlaEngineJackClient*)plugin->getEngineClient());
  1762. // we should not be able to do this, jack really needs to allow client rename
  1763. if (jack_client_t* const jackClient = jackbridge_client_open(fClientNamePrefix + uniqueName,
  1764. JackNoStartServer, nullptr))
  1765. {
  1766. // get new client name
  1767. fClientName = jackbridge_get_client_name(jackClient);
  1768. if (fClientNamePrefix.isNotEmpty())
  1769. uniqueName = fClientName.buffer() + fClientNamePrefix.length();
  1770. else
  1771. uniqueName = fClientName;
  1772. // close client
  1773. client->closeForRename(jackClient, fClientName);
  1774. // disable plugin
  1775. plugin->setEnabled(false);
  1776. // set new client data
  1777. CarlaPluginPtr* const pluginReserve = new CarlaPluginPtr(plugin);
  1778. client->reservePluginPtr(pluginReserve);
  1779. // jackbridge_set_latency_callback(jackClient, carla_jack_latency_callback_plugin, pluginReserve);
  1780. jackbridge_set_process_callback(jackClient, carla_jack_process_callback_plugin, pluginReserve);
  1781. jackbridge_on_shutdown(jackClient, carla_jack_shutdown_callback_plugin, pluginReserve);
  1782. // NOTE: jack1 locks up here
  1783. if (jackbridge_get_version_string() != nullptr)
  1784. jackbridge_set_thread_init_callback(jackClient, carla_jack_thread_init_callback, nullptr);
  1785. /* The following code is because of a tricky situation.
  1786. We cannot lock or do jack operations during jack callbacks on jack1. jack2 events are asynchronous.
  1787. When we close the client jack will trigger unregister-port callbacks, which we handle on a separate thread ASAP.
  1788. But before that happens we already registered a new client with the same ports (the "renamed" one),
  1789. and at this point the port we receive during that callback is actually the new one from the new client..
  1790. JACK2 seems to be reusing ports to save space, which is understandable.
  1791. Anyway, this means we have to remove all our port-related data before the new client ports are created.
  1792. (we also stop the separate jack-events thread to avoid any race conditions while modying our port data) */
  1793. if (fIsInternalClient)
  1794. stopThread(-1);
  1795. LinkedList<PortNameToId> ports;
  1796. LinkedList<ConnectionToId> conns;
  1797. {
  1798. const CarlaMutexLocker cml1(fUsedGroups.mutex);
  1799. if (const uint groupId = fUsedGroups.getGroupId(plugin->getName()))
  1800. {
  1801. const CarlaMutexLocker cml2(fUsedPorts.mutex);
  1802. for (LinkedList<PortNameToId>::Itenerator it = fUsedPorts.list.begin2(); it.valid(); it.next())
  1803. {
  1804. const PortNameToId& portNameToId(it.getValue(kPortNameToIdFallback));
  1805. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group != 0);
  1806. if (portNameToId.group != groupId)
  1807. continue;
  1808. ports.append(portNameToId);
  1809. fUsedPorts.list.remove(it);
  1810. }
  1811. const CarlaMutexLocker cml3(fUsedConnections.mutex);
  1812. for (LinkedList<ConnectionToId>::Itenerator it = fUsedConnections.list.begin2(); it.valid(); it.next())
  1813. {
  1814. const ConnectionToId& connectionToId = it.getValue(kConnectionToIdFallback);
  1815. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  1816. if (connectionToId.groupA != groupId && connectionToId.groupB != groupId)
  1817. continue;
  1818. conns.append(connectionToId);
  1819. fUsedConnections.list.remove(it);
  1820. }
  1821. }
  1822. }
  1823. for (LinkedList<ConnectionToId>::Itenerator it = conns.begin2(); it.valid(); it.next())
  1824. {
  1825. const ConnectionToId& connectionToId = it.getValue(kConnectionToIdFallback);
  1826. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  1827. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1828. ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED,
  1829. connectionToId.id,
  1830. 0, 0, 0, 0.0f, nullptr);
  1831. }
  1832. for (LinkedList<PortNameToId>::Itenerator it = ports.begin2(); it.valid(); it.next())
  1833. {
  1834. const PortNameToId& portNameToId(it.getValue(kPortNameToIdFallback));
  1835. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group != 0);
  1836. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1837. ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED,
  1838. portNameToId.group,
  1839. static_cast<int>(portNameToId.port),
  1840. 0, 0, 0.0f, nullptr);
  1841. }
  1842. ports.clear();
  1843. conns.clear();
  1844. if (fIsInternalClient)
  1845. startThread();
  1846. }
  1847. else
  1848. {
  1849. setLastError("Failed to create new JACK client");
  1850. return false;
  1851. }
  1852. }
  1853. // Rename
  1854. plugin->setName(uniqueName);
  1855. if (needsReinit)
  1856. {
  1857. // reload plugin to recreate its ports
  1858. plugin->reload();
  1859. plugin->loadStateSave(*saveStatePtr);
  1860. plugin->setEnabled(true);
  1861. }
  1862. callback(true, true, ENGINE_CALLBACK_PLUGIN_RENAMED, id, 0, 0, 0, 0.0f, uniqueName);
  1863. return true;
  1864. }
  1865. // -------------------------------------------------------------------
  1866. // Patchbay
  1867. bool patchbayConnect(const bool external,
  1868. const uint groupA, const uint portA, const uint groupB, const uint portB) override
  1869. {
  1870. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  1871. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  1872. return CarlaEngine::patchbayConnect(false, groupA, portA, groupB, portB);
  1873. const CarlaMutexLocker cml(fUsedPorts.mutex);
  1874. const char* const fullPortNameA = fUsedPorts.getFullPortName(groupA, portA);
  1875. CARLA_SAFE_ASSERT_RETURN(fullPortNameA != nullptr && fullPortNameA[0] != '\0', false);
  1876. const char* const fullPortNameB = fUsedPorts.getFullPortName(groupB, portB);
  1877. CARLA_SAFE_ASSERT_RETURN(fullPortNameB != nullptr && fullPortNameB[0] != '\0', false);
  1878. if (! jackbridge_connect(fClient, fullPortNameA, fullPortNameB))
  1879. {
  1880. setLastError("JACK operation failed");
  1881. return false;
  1882. }
  1883. return true;
  1884. }
  1885. bool patchbayDisconnect(const bool external, const uint connectionId) override
  1886. {
  1887. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  1888. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  1889. return CarlaEngine::patchbayDisconnect(false, connectionId);
  1890. ConnectionToId connectionToId = { 0, 0, 0, 0, 0 };
  1891. {
  1892. const CarlaMutexLocker cml(fUsedConnections.mutex);
  1893. for (LinkedList<ConnectionToId>::Itenerator it = fUsedConnections.list.begin2(); it.valid(); it.next())
  1894. {
  1895. connectionToId = it.getValue(kConnectionToIdFallback);
  1896. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  1897. if (connectionToId.id == connectionId)
  1898. break;
  1899. }
  1900. }
  1901. if (connectionToId.id == 0 || connectionToId.id != connectionId)
  1902. {
  1903. setLastError("Failed to find the requested connection");
  1904. return false;
  1905. }
  1906. const CarlaMutexLocker cml(fUsedPorts.mutex);
  1907. const char* const fullPortNameA = fUsedPorts.getFullPortName(connectionToId.groupA, connectionToId.portA);
  1908. CARLA_SAFE_ASSERT_RETURN(fullPortNameA != nullptr && fullPortNameA[0] != '\0', false);
  1909. const char* const fullPortNameB = fUsedPorts.getFullPortName(connectionToId.groupB, connectionToId.portB);
  1910. CARLA_SAFE_ASSERT_RETURN(fullPortNameB != nullptr && fullPortNameB[0] != '\0', false);
  1911. if (! jackbridge_disconnect(fClient, fullPortNameA, fullPortNameB))
  1912. {
  1913. setLastError("JACK operation failed");
  1914. return false;
  1915. }
  1916. return true;
  1917. }
  1918. bool patchbaySetGroupPos(const bool sendHost, const bool sendOSC, const bool external,
  1919. const uint groupId, const int x1, const int y1, const int x2, const int y2) override
  1920. {
  1921. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  1922. CARLA_SAFE_ASSERT_RETURN(! pData->loadingProject, false);
  1923. carla_debug("CarlaEngineJack::patchbaySetGroupPos(%u, %i, %i, %i, %i)", groupId, x1, y1, x2, y2);
  1924. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  1925. return CarlaEngine::patchbaySetGroupPos(sendHost, sendOSC, false, groupId, x1, y1, x2, y2);
  1926. const char* groupName;
  1927. {
  1928. const CarlaMutexLocker cml(fUsedGroups.mutex);
  1929. groupName = fUsedGroups.getGroupName(groupId);
  1930. CARLA_SAFE_ASSERT_RETURN(groupName != nullptr && groupName[0] != '\0', false);
  1931. }
  1932. bool ok;
  1933. {
  1934. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  1935. jack_uuid_t uuid;
  1936. {
  1937. char* const uuidstr = jackbridge_get_uuid_for_client_name(fClient, groupName);
  1938. CARLA_SAFE_ASSERT_RETURN(uuidstr != nullptr && uuidstr[0] != '\0', false);
  1939. const bool parsed = jackbridge_uuid_parse(uuidstr, &uuid);
  1940. jackbridge_free(uuidstr);
  1941. /* if parsing fails, meta-data is not available..
  1942. this could be because JACK version is old, or perhaps this is an internal client */
  1943. if (! parsed)
  1944. return false;
  1945. }
  1946. fLastPatchbaySetGroupPos.set(x1, y1, x2, y2);
  1947. char valueStr[STR_MAX];
  1948. std::snprintf(valueStr, STR_MAX-1, "%i:%i:%i:%i", x1, y1, x2, y2);
  1949. valueStr[STR_MAX-1] = '\0';
  1950. ok = jackbridge_set_property(fClient, uuid, URI_POSITION, valueStr, URI_TYPE_STRING);
  1951. }
  1952. callback(sendHost, sendOSC,
  1953. ENGINE_CALLBACK_PATCHBAY_CLIENT_POSITION_CHANGED,
  1954. groupId, x1, y1, x2, static_cast<float>(y2),
  1955. nullptr);
  1956. return ok;
  1957. }
  1958. bool patchbayRefresh(const bool sendHost, const bool sendOSC, const bool external) override
  1959. {
  1960. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  1961. carla_debug("patchbayRefresh(%s, %s, %s)", bool2str(sendHost), bool2str(sendOSC), bool2str(external));
  1962. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1963. {
  1964. if (sendHost)
  1965. {
  1966. fExternalPatchbayHost = external;
  1967. pData->graph.setUsingExternalHost(external);
  1968. }
  1969. if (sendOSC)
  1970. {
  1971. fExternalPatchbayOsc = external;
  1972. pData->graph.setUsingExternalOSC(external);
  1973. }
  1974. if (! external)
  1975. CarlaEngine::patchbayRefresh(sendHost, sendOSC, false);
  1976. }
  1977. initJackPatchbay(sendHost, sendOSC, jackbridge_get_client_name(fClient),
  1978. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && !external);
  1979. return true;
  1980. }
  1981. // -------------------------------------------------------------------
  1982. // Transport
  1983. void transportPlay() noexcept override
  1984. {
  1985. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  1986. return CarlaEngine::transportPlay();
  1987. if (fClient != nullptr)
  1988. {
  1989. if (! pData->timeInfo.bbt.valid)
  1990. {
  1991. // old timebase master no longer active, make ourselves master again
  1992. pData->time.setNeedsReset();
  1993. fTimebaseMaster = jackbridge_set_timebase_callback(fClient, true, carla_jack_timebase_callback, this);
  1994. }
  1995. try {
  1996. jackbridge_transport_start(fClient);
  1997. } catch(...) {}
  1998. }
  1999. }
  2000. void transportPause() noexcept override
  2001. {
  2002. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  2003. return CarlaEngine::transportPause();
  2004. if (fClient != nullptr)
  2005. {
  2006. try {
  2007. jackbridge_transport_stop(fClient);
  2008. } catch(...) {}
  2009. }
  2010. }
  2011. void transportBPM(const double bpm) noexcept override
  2012. {
  2013. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK || fTimebaseMaster)
  2014. return CarlaEngine::transportBPM(bpm);
  2015. if (fClient == nullptr)
  2016. return;
  2017. jack_position_t jpos;
  2018. // invalidate
  2019. jpos.unique_1 = 1;
  2020. jpos.unique_2 = 2;
  2021. jackbridge_transport_query(fClient, &jpos);
  2022. if (jpos.unique_1 == jpos.unique_2 && (jpos.valid & JackPositionBBT) != 0)
  2023. {
  2024. carla_stdout("NOTE: Changing BPM without being JACK timebase master");
  2025. jpos.beats_per_minute = bpm;
  2026. try {
  2027. jackbridge_transport_reposition(fClient, &jpos);
  2028. } catch(...) {}
  2029. }
  2030. }
  2031. void transportRelocate(const uint64_t frame) noexcept override
  2032. {
  2033. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  2034. return CarlaEngine::transportRelocate(frame);
  2035. if (fClient != nullptr)
  2036. {
  2037. try {
  2038. jackbridge_transport_locate(fClient, static_cast<jack_nframes_t>(frame));
  2039. } catch(...) {}
  2040. }
  2041. }
  2042. // -------------------------------------------------------------------
  2043. // Patchbay stuff
  2044. const char* const* getPatchbayConnections(const bool external) const override
  2045. {
  2046. CARLA_CUSTOM_SAFE_ASSERT_RETURN("Not connected to JACK, will not save patchbay connections",
  2047. fClient != nullptr, nullptr);
  2048. carla_debug("CarlaEngineJack::getPatchbayConnections(%s)", bool2str(external));
  2049. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  2050. return CarlaEngine::getPatchbayConnections(external);
  2051. CarlaStringList connList;
  2052. if (const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, JackPortIsOutput))
  2053. {
  2054. for (int i=0; ports[i] != nullptr; ++i)
  2055. {
  2056. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, ports[i]));
  2057. const char* const fullPortName(ports[i]);
  2058. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  2059. if (const char** const connections = jackbridge_port_get_all_connections(fClient, jackPort))
  2060. {
  2061. for (int j=0; connections[j] != nullptr; ++j)
  2062. {
  2063. connList.append(fullPortName);
  2064. connList.append(connections[j]);
  2065. }
  2066. jackbridge_free(connections);
  2067. }
  2068. }
  2069. jackbridge_free(ports);
  2070. }
  2071. if (connList.count() == 0)
  2072. return nullptr;
  2073. fRetConns = connList.toCharStringListPtr();
  2074. return fRetConns;
  2075. }
  2076. const PatchbayPosition* getPatchbayPositions(const bool external, uint& count) const override
  2077. {
  2078. CARLA_CUSTOM_SAFE_ASSERT_RETURN("Not connected to JACK, will not save patchbay positions",
  2079. fClient != nullptr, nullptr);
  2080. carla_debug("CarlaEngineJack::getPatchbayPositions(%s)", bool2str(external));
  2081. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  2082. return CarlaEngine::getPatchbayPositions(external, count);
  2083. const CarlaMutexLocker cml(fUsedGroups.mutex);
  2084. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  2085. if (const std::size_t maxCount = fUsedGroups.list.count())
  2086. {
  2087. PatchbayPosition* ret;
  2088. try {
  2089. ret = new CarlaEngine::PatchbayPosition[maxCount];
  2090. } CARLA_SAFE_EXCEPTION_RETURN("new CarlaEngine::PatchbayPosition", nullptr);
  2091. count = 0;
  2092. GroupNameToId groupNameToId;
  2093. for (LinkedList<GroupNameToId>::Itenerator it = fUsedGroups.list.begin2(); it.valid(); it.next())
  2094. {
  2095. groupNameToId = it.getValue(kGroupNameToIdFallback);
  2096. CARLA_SAFE_ASSERT_CONTINUE(groupNameToId.group != 0);
  2097. jack_uuid_t uuid;
  2098. {
  2099. char* const uuidstr = jackbridge_get_uuid_for_client_name(fClient, groupNameToId.name);
  2100. if (uuidstr == nullptr || uuidstr[0] == '\0')
  2101. continue;
  2102. const bool parsed = jackbridge_uuid_parse(uuidstr, &uuid);
  2103. jackbridge_free(uuidstr);
  2104. /* if parsing fails, meta-data is not available..
  2105. this could be because JACK version is old, or perhaps this is an internal client */
  2106. if (! parsed)
  2107. continue;
  2108. }
  2109. char* value = nullptr;
  2110. char* type = nullptr;
  2111. if (jackbridge_get_property(uuid, URI_POSITION, &value, &type)
  2112. && value != nullptr
  2113. && type != nullptr
  2114. && std::strcmp(type, URI_TYPE_STRING) == 0)
  2115. {
  2116. CarlaEngine::PatchbayPosition& ppos(ret[count++]);
  2117. ppos.name = carla_strdup_safe(groupNameToId.name);
  2118. ppos.dealloc = true;
  2119. ppos.pluginId = -1;
  2120. if (char* sep1 = std::strstr(value, ":"))
  2121. {
  2122. *sep1++ = '\0';
  2123. ppos.x1 = std::atoi(value);
  2124. if (char* sep2 = std::strstr(sep1, ":"))
  2125. {
  2126. *sep2++ = '\0';
  2127. ppos.y1 = std::atoi(sep1);
  2128. if (char* sep3 = std::strstr(sep2, ":"))
  2129. {
  2130. *sep3++ = '\0';
  2131. ppos.x2 = std::atoi(sep2);
  2132. ppos.y2 = std::atoi(sep3);
  2133. }
  2134. }
  2135. }
  2136. jackbridge_free(value);
  2137. jackbridge_free(type);
  2138. value = type = nullptr;
  2139. const bool clientBelongsToUs = (jackbridge_get_property(uuid, URI_MAIN_CLIENT_NAME, &value, &type)
  2140. && value != nullptr
  2141. && type != nullptr
  2142. && std::strcmp(type, URI_TYPE_STRING) == 0
  2143. && fClientName == value);
  2144. jackbridge_free(value);
  2145. jackbridge_free(type);
  2146. value = type = nullptr;
  2147. if (! clientBelongsToUs)
  2148. continue;
  2149. if (jackbridge_get_property(uuid, URI_PLUGIN_ID, &value, &type)
  2150. && value != nullptr
  2151. && type != nullptr
  2152. && std::strcmp(type, URI_TYPE_INTEGER) == 0)
  2153. {
  2154. ppos.pluginId = std::atoi(value);
  2155. }
  2156. jackbridge_free(value);
  2157. jackbridge_free(type);
  2158. }
  2159. }
  2160. return ret;
  2161. }
  2162. return nullptr;
  2163. }
  2164. void restorePatchbayConnection(const bool external,
  2165. const char* const connSource, const char* const connTarget) override
  2166. {
  2167. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr,);
  2168. CARLA_SAFE_ASSERT_RETURN(connSource != nullptr && connSource[0] != '\0',);
  2169. CARLA_SAFE_ASSERT_RETURN(connTarget != nullptr && connTarget[0] != '\0',);
  2170. carla_debug("CarlaEngineJack::restorePatchbayConnection(%s, \"%s\", \"%s\")",
  2171. bool2str(external), connSource, connTarget);
  2172. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  2173. return CarlaEngine::restorePatchbayConnection(external, connSource, connTarget);
  2174. if (const jack_port_t* const port = jackbridge_port_by_name(fClient, connSource))
  2175. {
  2176. if (jackbridge_port_by_name(fClient, connTarget) == nullptr)
  2177. return;
  2178. if (! jackbridge_port_connected_to(port, connTarget))
  2179. jackbridge_connect(fClient, connSource, connTarget);
  2180. }
  2181. }
  2182. bool restorePatchbayGroupPosition(const bool external, PatchbayPosition& ppos) override
  2183. {
  2184. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  2185. carla_debug("CarlaEngineJack::restorePatchbayGroupPosition(%s, {%i, %i, %i, %i, %i, \"%s\"})",
  2186. bool2str(external), ppos.pluginId, ppos.x1, ppos.y1, ppos.x2, ppos.y2, ppos.name);
  2187. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  2188. return CarlaEngine::restorePatchbayGroupPosition(external, ppos);
  2189. uint groupId = 0;
  2190. const char* const orig_name = ppos.name;
  2191. /* NOTE: When loading a project, it might take a bit to receive plugins' jack client registration callbacks.
  2192. * We try to wait a little for it, but not too much.
  2193. */
  2194. if (ppos.pluginId >= 0)
  2195. {
  2196. // strip client name prefix if already in place
  2197. if (const char* const rname2 = std::strstr(ppos.name, "."))
  2198. if (const char* const rname3 = std::strstr(rname2 + 1, "/"))
  2199. ppos.name = rname3 + 1;
  2200. if (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  2201. {
  2202. if (fClientNamePrefix.isNotEmpty())
  2203. {
  2204. char* nname = (char*)std::malloc(fClientNamePrefix.length() + std::strlen(ppos.name) + 1);
  2205. std::strcpy(nname, fClientNamePrefix.buffer());
  2206. std::strcat(nname, ppos.name);
  2207. ppos.name = nname;
  2208. ppos.dealloc = true;
  2209. }
  2210. for (int i=20; --i >=0;)
  2211. {
  2212. {
  2213. const CarlaMutexLocker cml(fUsedGroups.mutex);
  2214. if (fUsedGroups.list.count() == 0)
  2215. break;
  2216. groupId = fUsedGroups.getGroupId(ppos.name);
  2217. }
  2218. if (groupId != 0)
  2219. break;
  2220. d_msleep(100);
  2221. callback(true, true, ENGINE_CALLBACK_IDLE, 0, 0, 0, 0, 0.0f, nullptr);
  2222. }
  2223. }
  2224. }
  2225. else
  2226. {
  2227. const CarlaMutexLocker cml(fUsedGroups.mutex);
  2228. if (fUsedGroups.list.count() != 0)
  2229. groupId = fUsedGroups.getGroupId(ppos.name);
  2230. }
  2231. if (groupId == 0)
  2232. {
  2233. if (ppos.pluginId < 0 || pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  2234. carla_stdout("Previously saved client '%s' not found", ppos.name);
  2235. }
  2236. else
  2237. {
  2238. for (;;)
  2239. {
  2240. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  2241. jack_uuid_t uuid;
  2242. {
  2243. char* const uuidstr = jackbridge_get_uuid_for_client_name(fClient, ppos.name);
  2244. CARLA_SAFE_ASSERT_BREAK(uuidstr != nullptr && uuidstr[0] != '\0');
  2245. const bool parsed = jackbridge_uuid_parse(uuidstr, &uuid);
  2246. jackbridge_free(uuidstr);
  2247. CARLA_CUSTOM_SAFE_ASSERT_ONCE_BREAK("JACK meta-data support unavailable", parsed);
  2248. }
  2249. char valueStr[STR_MAX];
  2250. std::snprintf(valueStr, STR_MAX-1, "%i:%i:%i:%i", ppos.x1, ppos.y1, ppos.x2, ppos.y2);
  2251. valueStr[STR_MAX-1] = '\0';
  2252. jackbridge_set_property(fClient, uuid, URI_POSITION, valueStr, URI_TYPE_STRING);
  2253. break;
  2254. }
  2255. callback(true, true,
  2256. ENGINE_CALLBACK_PATCHBAY_CLIENT_POSITION_CHANGED,
  2257. groupId, ppos.x1, ppos.y1, ppos.x2, static_cast<float>(ppos.y2),
  2258. nullptr);
  2259. }
  2260. return ppos.name != orig_name;
  2261. }
  2262. #endif
  2263. // -------------------------------------------------------------------
  2264. protected:
  2265. void handleJackBufferSizeCallback(const uint32_t newBufferSize)
  2266. {
  2267. if (pData->bufferSize == newBufferSize)
  2268. return;
  2269. #ifndef BUILD_BRIDGE
  2270. const CarlaMutexLocker cml(fPatchbayProcThreadProtectionMutex);
  2271. #endif
  2272. pData->bufferSize = newBufferSize;
  2273. bufferSizeChanged(newBufferSize);
  2274. }
  2275. void handleJackSampleRateCallback(const double newSampleRate)
  2276. {
  2277. if (carla_isEqual(pData->sampleRate, newSampleRate))
  2278. return;
  2279. #ifndef BUILD_BRIDGE
  2280. const CarlaMutexLocker cml(fPatchbayProcThreadProtectionMutex);
  2281. #endif
  2282. pData->sampleRate = newSampleRate;
  2283. sampleRateChanged(newSampleRate);
  2284. }
  2285. void handleJackFreewheelCallback(const bool isFreewheel)
  2286. {
  2287. if (fFreewheel == isFreewheel)
  2288. return;
  2289. #ifndef BUILD_BRIDGE
  2290. const CarlaMutexLocker cml(fPatchbayProcThreadProtectionMutex);
  2291. #endif
  2292. fFreewheel = isFreewheel;
  2293. offlineModeChanged(isFreewheel);
  2294. }
  2295. void handleJackProcessCallback(const uint32_t nframes)
  2296. {
  2297. const PendingRtEventsRunner prt(this, nframes);
  2298. CARLA_SAFE_ASSERT_INT2_RETURN(nframes == pData->bufferSize, nframes, pData->bufferSize,);
  2299. #ifdef BUILD_BRIDGE
  2300. CarlaPluginPtr plugin = pData->plugins[0].plugin;
  2301. if (plugin.get() != nullptr && plugin->isEnabled() && plugin->tryLock(fFreewheel))
  2302. {
  2303. plugin->initBuffers();
  2304. processPlugin(plugin, nframes);
  2305. plugin->unlock();
  2306. }
  2307. #else
  2308. if (pData->options.transportMode == ENGINE_TRANSPORT_MODE_JACK && !fTimebaseMaster)
  2309. {
  2310. jack_position_t jpos;
  2311. // invalidate
  2312. jpos.unique_1 = 1;
  2313. jpos.unique_2 = 2;
  2314. EngineTimeInfo timeInfo;
  2315. const bool playing = jackbridge_transport_query(fClient, &jpos) == JackTransportRolling;
  2316. if (jpos.unique_1 != jpos.unique_2)
  2317. {
  2318. timeInfo.playing = false;
  2319. timeInfo.frame = 0;
  2320. timeInfo.usecs = 0;
  2321. timeInfo.bbt.valid = false;
  2322. }
  2323. else
  2324. {
  2325. timeInfo.playing = playing;
  2326. timeInfo.frame = jpos.frame;
  2327. timeInfo.usecs = jpos.usecs;
  2328. if (jpos.valid & JackPositionBBT)
  2329. {
  2330. timeInfo.bbt.valid = true;
  2331. timeInfo.bbt.bar = jpos.bar;
  2332. timeInfo.bbt.beat = jpos.beat;
  2333. #ifdef JACK_TICK_DOUBLE
  2334. if (jpos.valid & JackTickDouble)
  2335. timeInfo.bbt.tick = jpos.tick_double;
  2336. else
  2337. #endif
  2338. timeInfo.bbt.tick = jpos.tick;
  2339. timeInfo.bbt.barStartTick = jpos.bar_start_tick;
  2340. timeInfo.bbt.beatsPerBar = jpos.beats_per_bar;
  2341. timeInfo.bbt.beatType = jpos.beat_type;
  2342. timeInfo.bbt.ticksPerBeat = jpos.ticks_per_beat;
  2343. timeInfo.bbt.beatsPerMinute = jpos.beats_per_minute;
  2344. }
  2345. else
  2346. {
  2347. timeInfo.bbt.valid = false;
  2348. }
  2349. }
  2350. pData->timeInfo = timeInfo;
  2351. }
  2352. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  2353. {
  2354. if (pData->aboutToClose)
  2355. {
  2356. if (float* const audioOut1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut1], nframes))
  2357. carla_zeroFloats(audioOut1, nframes);
  2358. if (float* const audioOut2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut2], nframes))
  2359. carla_zeroFloats(audioOut2, nframes);
  2360. }
  2361. else if (pData->curPluginCount == 0)
  2362. {
  2363. float* const audioIn1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn1], nframes);
  2364. float* const audioIn2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn2], nframes);
  2365. float* const audioOut1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut1], nframes);
  2366. float* const audioOut2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut2], nframes);
  2367. // assert buffers
  2368. CARLA_SAFE_ASSERT_RETURN(audioIn1 != nullptr,);
  2369. CARLA_SAFE_ASSERT_RETURN(audioIn2 != nullptr,);
  2370. CARLA_SAFE_ASSERT_RETURN(audioOut1 != nullptr,);
  2371. CARLA_SAFE_ASSERT_RETURN(audioOut2 != nullptr,);
  2372. // pass-through
  2373. carla_copyFloats(audioOut1, audioIn1, nframes);
  2374. carla_copyFloats(audioOut2, audioIn2, nframes);
  2375. // TODO pass-through MIDI as well
  2376. if (void* const eventOut = jackbridge_port_get_buffer(fRackPorts[kRackPortEventOut], nframes))
  2377. jackbridge_midi_clear_buffer(eventOut);
  2378. return;
  2379. }
  2380. }
  2381. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  2382. {
  2383. for (uint i=0; i < pData->curPluginCount; ++i)
  2384. {
  2385. if (CarlaPluginPtr plugin = pData->plugins[i].plugin)
  2386. {
  2387. if (plugin->isEnabled() && plugin->tryLock(fFreewheel))
  2388. {
  2389. plugin->initBuffers();
  2390. processPlugin(plugin, nframes);
  2391. plugin->unlock();
  2392. }
  2393. }
  2394. }
  2395. }
  2396. else if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  2397. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  2398. {
  2399. CARLA_SAFE_ASSERT_RETURN(pData->events.in != nullptr,);
  2400. CARLA_SAFE_ASSERT_RETURN(pData->events.out != nullptr,);
  2401. // get buffers from jack
  2402. float* const audioIn1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn1], nframes);
  2403. float* const audioIn2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn2], nframes);
  2404. float* const audioOut1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut1], nframes);
  2405. float* const audioOut2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut2], nframes);
  2406. void* const eventIn = jackbridge_port_get_buffer(fRackPorts[kRackPortEventIn], nframes);
  2407. void* const eventOut = jackbridge_port_get_buffer(fRackPorts[kRackPortEventOut], nframes);
  2408. // assert buffers
  2409. CARLA_SAFE_ASSERT_RETURN(audioIn1 != nullptr,);
  2410. CARLA_SAFE_ASSERT_RETURN(audioIn2 != nullptr,);
  2411. CARLA_SAFE_ASSERT_RETURN(audioOut1 != nullptr,);
  2412. CARLA_SAFE_ASSERT_RETURN(audioOut2 != nullptr,);
  2413. // create audio buffers
  2414. const float* inBuf[2] = { audioIn1, audioIn2 };
  2415. /**/ float* outBuf[2] = { audioOut1, audioOut2 };
  2416. // initialize events
  2417. carla_zeroStructs(pData->events.in, kMaxEngineEventInternalCount);
  2418. carla_zeroStructs(pData->events.out, kMaxEngineEventInternalCount);
  2419. if (eventIn != nullptr)
  2420. {
  2421. ushort engineEventIndex = 0;
  2422. jack_midi_event_t jackEvent;
  2423. const uint32_t jackEventCount(jackbridge_midi_get_event_count(eventIn));
  2424. for (uint32_t jackEventIndex=0; jackEventIndex < jackEventCount; ++jackEventIndex)
  2425. {
  2426. if (! jackbridge_midi_event_get(&jackEvent, eventIn, jackEventIndex))
  2427. continue;
  2428. CARLA_SAFE_ASSERT_CONTINUE(jackEvent.size < 0xFF /* uint8_t max */);
  2429. EngineEvent& engineEvent(pData->events.in[engineEventIndex++]);
  2430. engineEvent.time = jackEvent.time;
  2431. engineEvent.fillFromMidiData(static_cast<uint8_t>(jackEvent.size), jackEvent.buffer, 0);
  2432. if (engineEventIndex >= kMaxEngineEventInternalCount)
  2433. break;
  2434. }
  2435. }
  2436. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  2437. {
  2438. pData->graph.processRack(pData, inBuf, outBuf, nframes);
  2439. }
  2440. else
  2441. {
  2442. const CarlaMutexLocker cml(fPatchbayProcThreadProtectionMutex);
  2443. pData->graph.process(pData, inBuf, outBuf, nframes);
  2444. }
  2445. // output control
  2446. if (eventOut != nullptr)
  2447. {
  2448. jackbridge_midi_clear_buffer(eventOut);
  2449. uint8_t size = 0;
  2450. uint8_t mdata[3] = { 0, 0, 0 };
  2451. uint8_t mdataTmp[EngineMidiEvent::kDataSize];
  2452. const uint8_t* mdataPtr;
  2453. for (ushort i=0; i < kMaxEngineEventInternalCount; ++i)
  2454. {
  2455. const EngineEvent& engineEvent(pData->events.out[i]);
  2456. /**/ if (engineEvent.type == kEngineEventTypeNull)
  2457. {
  2458. break;
  2459. }
  2460. else if (engineEvent.type == kEngineEventTypeControl)
  2461. {
  2462. const EngineControlEvent& ctrlEvent(engineEvent.ctrl);
  2463. size = ctrlEvent.convertToMidiData(engineEvent.channel, mdata);
  2464. mdataPtr = mdata;
  2465. }
  2466. else if (engineEvent.type == kEngineEventTypeMidi)
  2467. {
  2468. const EngineMidiEvent& midiEvent(engineEvent.midi);
  2469. size = midiEvent.size;
  2470. CARLA_SAFE_ASSERT_CONTINUE(size > 0);
  2471. if (size > EngineMidiEvent::kDataSize)
  2472. {
  2473. CARLA_SAFE_ASSERT_CONTINUE(midiEvent.dataExt != nullptr);
  2474. mdataPtr = midiEvent.dataExt;
  2475. }
  2476. else
  2477. {
  2478. // set first byte
  2479. mdataTmp[0] = static_cast<uint8_t>(midiEvent.data[0] | (engineEvent.channel & MIDI_CHANNEL_BIT));
  2480. if (size > 1)
  2481. {
  2482. // copy rest
  2483. carla_copy<uint8_t>(mdataTmp+1, midiEvent.data+1, size-1U);
  2484. }
  2485. // done
  2486. mdataPtr = mdataTmp;
  2487. }
  2488. }
  2489. else
  2490. {
  2491. continue;
  2492. }
  2493. if (size > 0)
  2494. jackbridge_midi_event_write(eventOut, engineEvent.time, mdataPtr, size);
  2495. }
  2496. }
  2497. }
  2498. if (pData->options.transportMode == ENGINE_TRANSPORT_MODE_JACK)
  2499. {
  2500. if (fTimebaseMaster)
  2501. {
  2502. const bool playing = jackbridge_transport_query(fClient, nullptr) == JackTransportRolling;
  2503. if (fTimebaseRolling != playing)
  2504. {
  2505. fTimebaseRolling = playing;
  2506. pData->timeInfo.playing = playing;
  2507. }
  2508. // Check if we are no longer timebase master
  2509. if (playing && fTimebaseUsecs != 0 && fTimebaseUsecs == pData->timeInfo.usecs)
  2510. {
  2511. carla_debug("No longer timerbase master");
  2512. fTimebaseMaster = false;
  2513. }
  2514. }
  2515. fTimebaseUsecs = pData->timeInfo.usecs;
  2516. }
  2517. #endif // ! BUILD_BRIDGE
  2518. }
  2519. void handleJackLatencyCallback(const jack_latency_callback_mode_t /*mode*/)
  2520. {
  2521. // TODO
  2522. }
  2523. #ifndef BUILD_BRIDGE
  2524. void handleJackTimebaseCallback(jack_nframes_t nframes, jack_position_t* const pos, const int new_pos)
  2525. {
  2526. if (new_pos)
  2527. pData->time.setNeedsReset();
  2528. pData->timeInfo.playing = fTimebaseRolling;
  2529. pData->timeInfo.frame = pos->frame;
  2530. pData->timeInfo.usecs = pos->usecs;
  2531. pData->time.fillJackTimeInfo(pos, nframes);
  2532. }
  2533. void handleJackClientUnregistrationCallback(const char* const name)
  2534. {
  2535. CARLA_SAFE_ASSERT_RETURN(name != nullptr && name[0] != '\0',);
  2536. uint groupId;
  2537. {
  2538. const CarlaMutexLocker cml(fUsedGroups.mutex);
  2539. groupId = fUsedGroups.getGroupId(name);
  2540. // clients might have been registered without ports
  2541. if (groupId == 0) return;
  2542. GroupNameToId groupNameToId;
  2543. groupNameToId.setData(groupId, name);
  2544. fUsedGroups.list.removeOne(groupNameToId);
  2545. }
  2546. // ignore callback if on internal patchbay mode
  2547. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  2548. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  2549. #else
  2550. if (! fExternalPatchbayHost) return;
  2551. #endif
  2552. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2553. ENGINE_CALLBACK_PATCHBAY_CLIENT_REMOVED,
  2554. groupId,
  2555. 0, 0, 0, 0.0f, nullptr);
  2556. }
  2557. void handleJackClientPositionChangeCallback(const jack_uuid_t uuid)
  2558. {
  2559. // ignore this if on internal patchbay mode
  2560. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  2561. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  2562. #else
  2563. if (! fExternalPatchbayHost) return;
  2564. #endif
  2565. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  2566. char uuidstr[JACK_UUID_STRING_SIZE] = {};
  2567. jackbridge_uuid_unparse(uuid, uuidstr);
  2568. if (char* const clientName = jackbridge_get_client_name_by_uuid(fClient, uuidstr))
  2569. {
  2570. CARLA_SAFE_ASSERT_RETURN(clientName != nullptr && clientName[0] != '\0',);
  2571. uint groupId;
  2572. {
  2573. const CarlaMutexLocker cml(fUsedGroups.mutex);
  2574. groupId = fUsedGroups.getGroupId(clientName);
  2575. }
  2576. jackbridge_free(clientName);
  2577. CARLA_SAFE_ASSERT_RETURN(groupId != 0,);
  2578. char* value = nullptr;
  2579. char* type = nullptr;
  2580. if (jackbridge_get_property(uuid, URI_POSITION, &value, &type)
  2581. && value != nullptr
  2582. && type != nullptr
  2583. && std::strcmp(type, URI_TYPE_STRING) == 0)
  2584. {
  2585. if (char* sep1 = std::strstr(value, ":"))
  2586. {
  2587. LastPatchbaySetGroupPos pos;
  2588. *sep1++ = '\0';
  2589. pos.x1 = std::atoi(value);
  2590. if (char* sep2 = std::strstr(sep1, ":"))
  2591. {
  2592. *sep2++ = '\0';
  2593. pos.y1 = std::atoi(sep1);
  2594. if (char* sep3 = std::strstr(sep2, ":"))
  2595. {
  2596. *sep3++ = '\0';
  2597. pos.x2 = std::atoi(sep2);
  2598. pos.y2 = std::atoi(sep3);
  2599. }
  2600. if (fLastPatchbaySetGroupPos != pos)
  2601. {
  2602. fLastPatchbaySetGroupPos.clear();
  2603. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2604. ENGINE_CALLBACK_PATCHBAY_CLIENT_POSITION_CHANGED,
  2605. groupId, pos.x1, pos.y1, pos.x2, static_cast<float>(pos.y2),
  2606. nullptr);
  2607. }
  2608. }
  2609. }
  2610. jackbridge_free(value);
  2611. jackbridge_free(type);
  2612. }
  2613. }
  2614. }
  2615. void handleJackPortRegistrationCallback(const char* const portName,
  2616. const char* const shortPortName,
  2617. const CarlaJackPortHints& jackPortHints)
  2618. {
  2619. bool groupFound;
  2620. String groupName(portName);
  2621. groupName.truncate(groupName.rfind(shortPortName, &groupFound)-1);
  2622. CARLA_SAFE_ASSERT_RETURN(groupFound,);
  2623. groupFound = false;
  2624. GroupToIdData groupData;
  2625. PortToIdData portData;
  2626. {
  2627. const CarlaMutexLocker cml1(fUsedGroups.mutex);
  2628. groupData.id = fUsedGroups.getGroupId(groupName);
  2629. if (groupData.id == 0)
  2630. {
  2631. groupData.id = ++fUsedGroups.lastId;
  2632. GroupNameToId groupNameToId;
  2633. groupNameToId.setData(groupData.id, groupName);
  2634. int pluginId = -1;
  2635. PatchbayIcon icon = jackPortHints.isHardware ? PATCHBAY_ICON_HARDWARE : PATCHBAY_ICON_APPLICATION;
  2636. findPluginIdAndIcon(groupName, pluginId, icon);
  2637. fUsedGroups.list.append(groupNameToId);
  2638. groupFound = true;
  2639. groupData.icon = icon;
  2640. groupData.pluginId = pluginId;
  2641. std::strncpy(groupData.strVal, groupName, STR_MAX-1);
  2642. groupData.strVal[STR_MAX-1] = '\0';
  2643. }
  2644. }
  2645. // ignore the rest if on internal patchbay mode
  2646. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  2647. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  2648. #else
  2649. if (! fExternalPatchbayHost) return;
  2650. #endif
  2651. {
  2652. uint canvasPortFlags = 0x0;
  2653. canvasPortFlags |= jackPortHints.isInput ? PATCHBAY_PORT_IS_INPUT : 0x0;
  2654. /**/ if (jackPortHints.isCV)
  2655. canvasPortFlags |= PATCHBAY_PORT_TYPE_CV;
  2656. else if (jackPortHints.isOSC)
  2657. canvasPortFlags |= PATCHBAY_PORT_TYPE_OSC;
  2658. else if (jackPortHints.isAudio)
  2659. canvasPortFlags |= PATCHBAY_PORT_TYPE_AUDIO;
  2660. else if (jackPortHints.isMIDI)
  2661. canvasPortFlags |= PATCHBAY_PORT_TYPE_MIDI;
  2662. const CarlaMutexLocker cml2(fUsedPorts.mutex);
  2663. portData.group = groupData.id;
  2664. portData.port = ++fUsedPorts.lastId;
  2665. portData.flags = canvasPortFlags;
  2666. std::strncpy(portData.strVal, shortPortName, STR_MAX-1);
  2667. portData.strVal[STR_MAX-1] = '\0';
  2668. PortNameToId portNameToId;
  2669. portNameToId.setData(portData.group, portData.port, shortPortName, portName);
  2670. fUsedPorts.list.append(portNameToId);
  2671. }
  2672. if (groupFound)
  2673. {
  2674. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2675. ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED,
  2676. groupData.id,
  2677. groupData.icon,
  2678. groupData.pluginId,
  2679. 0, 0.0f,
  2680. groupData.strVal);
  2681. }
  2682. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2683. ENGINE_CALLBACK_PATCHBAY_PORT_ADDED,
  2684. portData.group,
  2685. static_cast<int>(portData.port),
  2686. static_cast<int>(portData.flags),
  2687. 0, 0.0f,
  2688. portData.strVal);
  2689. }
  2690. void handleJackPortUnregistrationCallback(const char* const portName)
  2691. {
  2692. // ignore this if on internal patchbay mode
  2693. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  2694. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  2695. #else
  2696. if (! fExternalPatchbayHost) return;
  2697. #endif
  2698. uint groupId, portId;
  2699. {
  2700. const CarlaMutexLocker cml(fUsedPorts.mutex);
  2701. const PortNameToId& portNameToId(fUsedPorts.getPortNameToId(portName));
  2702. /* NOTE: Due to JACK2 async behaviour the port we get here might be the same of a previous rename-plugin request.
  2703. See the comment on CarlaEngineJack::renamePlugin() for more information. */
  2704. if (portNameToId.group <= 0 || portNameToId.port <= 0) return;
  2705. groupId = portNameToId.group;
  2706. portId = portNameToId.port;
  2707. fUsedPorts.list.removeOne(portNameToId);
  2708. }
  2709. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2710. ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED,
  2711. groupId,
  2712. static_cast<int>(portId),
  2713. 0, 0, 0.0f, nullptr);
  2714. }
  2715. void handleJackPortConnectCallback(const char* const portNameA, const char* const portNameB)
  2716. {
  2717. // ignore this if on internal patchbay mode
  2718. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  2719. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  2720. #else
  2721. if (! fExternalPatchbayHost) return;
  2722. #endif
  2723. char strBuf[STR_MAX];
  2724. uint connectionId;
  2725. {
  2726. const CarlaMutexLocker cml1(fUsedPorts.mutex);
  2727. const PortNameToId& portNameToIdA(fUsedPorts.getPortNameToId(portNameA));
  2728. const PortNameToId& portNameToIdB(fUsedPorts.getPortNameToId(portNameB));
  2729. /* NOTE: Due to JACK2 async behaviour the port we get here might be the same of a previous rename-plugin request.
  2730. See the comment on CarlaEngineJack::renamePlugin() for more information. */
  2731. if (portNameToIdA.group <= 0 || portNameToIdA.port <= 0) return;
  2732. if (portNameToIdB.group <= 0 || portNameToIdB.port <= 0) return;
  2733. const CarlaMutexLocker cml2(fUsedConnections.mutex);
  2734. std::snprintf(strBuf, STR_MAX-1, "%i:%i:%i:%i",
  2735. portNameToIdA.group, portNameToIdA.port,
  2736. portNameToIdB.group, portNameToIdB.port);
  2737. strBuf[STR_MAX-1] = '\0';
  2738. connectionId = ++fUsedConnections.lastId;
  2739. ConnectionToId connectionToId;
  2740. connectionToId.setData(connectionId,
  2741. portNameToIdA.group, portNameToIdA.port,
  2742. portNameToIdB.group, portNameToIdB.port);
  2743. fUsedConnections.list.append(connectionToId);
  2744. }
  2745. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2746. ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED,
  2747. connectionId,
  2748. 0, 0, 0, 0.0f,
  2749. strBuf);
  2750. }
  2751. void handleJackPortDisconnectCallback(const char* const portNameA, const char* const portNameB)
  2752. {
  2753. // ignore this if on internal patchbay mode
  2754. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  2755. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  2756. #else
  2757. if (! fExternalPatchbayHost) return;
  2758. #endif
  2759. uint connectionId = 0;
  2760. {
  2761. const CarlaMutexLocker cml1(fUsedPorts.mutex);
  2762. const PortNameToId& portNameToIdA(fUsedPorts.getPortNameToId(portNameA));
  2763. const PortNameToId& portNameToIdB(fUsedPorts.getPortNameToId(portNameB));
  2764. /* NOTE: Due to JACK2 async behaviour the port we get here might be the same of a previous rename-plugin request.
  2765. See the comment on CarlaEngineJack::renamePlugin() for more information. */
  2766. if (portNameToIdA.group <= 0 || portNameToIdA.port <= 0) return;
  2767. if (portNameToIdB.group <= 0 || portNameToIdB.port <= 0) return;
  2768. const CarlaMutexLocker cml2(fUsedConnections.mutex);
  2769. for (LinkedList<ConnectionToId>::Itenerator it = fUsedConnections.list.begin2(); it.valid(); it.next())
  2770. {
  2771. const ConnectionToId& connectionToId = it.getValue(kConnectionToIdFallback);
  2772. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  2773. if (connectionToId.groupA == portNameToIdA.group && connectionToId.portA == portNameToIdA.port &&
  2774. connectionToId.groupB == portNameToIdB.group && connectionToId.portB == portNameToIdB.port)
  2775. {
  2776. connectionId = connectionToId.id;
  2777. fUsedConnections.list.remove(it);
  2778. break;
  2779. }
  2780. }
  2781. }
  2782. if (connectionId != 0) {
  2783. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2784. ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED,
  2785. connectionId,
  2786. 0, 0, 0, 0.0f, nullptr);
  2787. }
  2788. }
  2789. void handleJackPortRenameCallback(const char* const oldFullName,
  2790. const char* const newFullName,
  2791. const char* const newShortName)
  2792. {
  2793. // ignore this if on internal patchbay mode
  2794. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  2795. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  2796. #else
  2797. if (! fExternalPatchbayHost) return;
  2798. #endif
  2799. CARLA_SAFE_ASSERT_RETURN(oldFullName != nullptr && oldFullName[0] != '\0',);
  2800. CARLA_SAFE_ASSERT_RETURN(newFullName != nullptr && newFullName[0] != '\0',);
  2801. bool found;
  2802. String groupName(newFullName);
  2803. groupName.truncate(groupName.rfind(newShortName, &found)-1);
  2804. CARLA_SAFE_ASSERT_RETURN(found,);
  2805. uint groupId, portId = 0;
  2806. char portName[STR_MAX];
  2807. found = false;
  2808. {
  2809. const CarlaMutexLocker cml1(fUsedGroups.mutex);
  2810. groupId = fUsedGroups.getGroupId(groupName);
  2811. CARLA_SAFE_ASSERT_RETURN(groupId != 0,);
  2812. const CarlaMutexLocker cml2(fUsedPorts.mutex);
  2813. for (LinkedList<PortNameToId>::Itenerator it = fUsedPorts.list.begin2(); it.valid(); it.next())
  2814. {
  2815. PortNameToId& portNameToId(it.getValue(kPortNameToIdFallbackNC));
  2816. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group != 0);
  2817. if (std::strncmp(portNameToId.fullName, oldFullName, STR_MAX) == 0)
  2818. {
  2819. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group == groupId);
  2820. found = true;
  2821. portId = portNameToId.port;
  2822. std::strncpy(portName, newShortName, STR_MAX-1);
  2823. portName[STR_MAX-1] = '\0';
  2824. portNameToId.rename(newShortName, newFullName);
  2825. break;
  2826. }
  2827. }
  2828. }
  2829. if (found)
  2830. {
  2831. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2832. ENGINE_CALLBACK_PATCHBAY_PORT_CHANGED,
  2833. groupId,
  2834. static_cast<int>(portId),
  2835. 0, 0, 0.0f,
  2836. portName);
  2837. }
  2838. }
  2839. #endif
  2840. void handleJackShutdownCallback()
  2841. {
  2842. #ifndef BUILD_BRIDGE
  2843. if (fIsInternalClient)
  2844. stopThread(-1);
  2845. #endif
  2846. {
  2847. const PendingRtEventsRunner prt(this, pData->bufferSize);
  2848. for (uint i=0; i < pData->curPluginCount; ++i)
  2849. {
  2850. if (const CarlaPluginPtr plugin = pData->plugins[i].plugin)
  2851. {
  2852. plugin->tryLock(true);
  2853. if (CarlaEngineJackClient* const client = (CarlaEngineJackClient*)plugin->getEngineClient())
  2854. client->invalidate();
  2855. plugin->unlock();
  2856. }
  2857. }
  2858. }
  2859. pData->runner.stopRunner();
  2860. fClient = nullptr;
  2861. #ifdef BUILD_BRIDGE
  2862. fIsRunning = false;
  2863. #else
  2864. carla_zeroPointers(fRackPorts, kRackPortCount);
  2865. #endif
  2866. callback(true, true, ENGINE_CALLBACK_ERROR, 0, 0, 0, 0, 0.0f,
  2867. "Carla has been killed by JACK, or JACK has stopped.\n"
  2868. "You can still save if you want, but you will lose patchbay connections and positions.");
  2869. }
  2870. // -------------------------------------------------------------------
  2871. void handlePluginJackShutdownCallback(const CarlaPluginPtr plugin)
  2872. {
  2873. CarlaEngineJackClient* const engineClient((CarlaEngineJackClient*)plugin->getEngineClient());
  2874. CARLA_SAFE_ASSERT_RETURN(engineClient != nullptr,);
  2875. plugin->tryLock(true);
  2876. engineClient->invalidate();
  2877. plugin->unlock();
  2878. callback(true, true, ENGINE_CALLBACK_PLUGIN_UNAVAILABLE, plugin->getId(), 0, 0, 0, 0.0f, "Killed by JACK");
  2879. }
  2880. // -------------------------------------------------------------------
  2881. private:
  2882. jack_client_t* fClient;
  2883. bool fExternalPatchbayHost;
  2884. bool fExternalPatchbayOsc;
  2885. bool fFreewheel;
  2886. String fClientName;
  2887. CarlaRecursiveMutex fThreadSafeMetadataMutex;
  2888. // -------------------------------------------------------------------
  2889. #ifdef BUILD_BRIDGE
  2890. bool fIsRunning;
  2891. #else
  2892. String fClientNamePrefix;
  2893. enum RackPorts {
  2894. kRackPortAudioIn1 = 0,
  2895. kRackPortAudioIn2 = 1,
  2896. kRackPortAudioOut1 = 2,
  2897. kRackPortAudioOut2 = 3,
  2898. kRackPortEventIn = 4,
  2899. kRackPortEventOut = 5,
  2900. kRackPortCount = 6
  2901. };
  2902. jack_port_t* fRackPorts[kRackPortCount];
  2903. bool fTimebaseMaster;
  2904. bool fTimebaseRolling;
  2905. uint64_t fTimebaseUsecs;
  2906. PatchbayGroupList fUsedGroups;
  2907. PatchbayPortList fUsedPorts;
  2908. PatchbayConnectionList fUsedConnections;
  2909. CarlaMutex fPatchbayProcThreadProtectionMutex;
  2910. mutable CharStringListPtr fRetConns;
  2911. void findPluginIdAndIcon(const char* const clientName, int& pluginId, PatchbayIcon& icon) const noexcept
  2912. {
  2913. carla_debug("CarlaEngineJack::findPluginIdAndIcon(\"%s\", ...)", clientName);
  2914. // TODO - this currently only works in multi-client mode
  2915. if (pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  2916. return;
  2917. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  2918. jack_uuid_t uuid;
  2919. {
  2920. char* const uuidstr = jackbridge_get_uuid_for_client_name(fClient, clientName);
  2921. CARLA_SAFE_ASSERT_RETURN(uuidstr != nullptr && uuidstr[0] != '\0',);
  2922. const bool parsed = jackbridge_uuid_parse(uuidstr, &uuid);
  2923. jackbridge_free(uuidstr);
  2924. /* if parsing fails, meta-data is not available..
  2925. this could be because JACK version is old, or perhaps this is an internal client */
  2926. if (! parsed)
  2927. return;
  2928. }
  2929. bool clientBelongsToUs;
  2930. {
  2931. char* value = nullptr;
  2932. char* type = nullptr;
  2933. if (! jackbridge_get_property(uuid, URI_MAIN_CLIENT_NAME, &value, &type))
  2934. return;
  2935. CARLA_SAFE_ASSERT_RETURN(type != nullptr && type[0] != '\0',);
  2936. CARLA_SAFE_ASSERT_RETURN(value != nullptr && value[0] != '\0',);
  2937. CARLA_SAFE_ASSERT_RETURN(std::strcmp(type, URI_TYPE_STRING) == 0,);
  2938. clientBelongsToUs = fClientName == value;
  2939. jackbridge_free(value);
  2940. jackbridge_free(type);
  2941. }
  2942. {
  2943. char* value = nullptr;
  2944. char* type = nullptr;
  2945. if (! jackbridge_get_property(uuid, URI_PLUGIN_ID, &value, &type))
  2946. return;
  2947. CARLA_SAFE_ASSERT_RETURN(type != nullptr && type[0] != '\0',);
  2948. CARLA_SAFE_ASSERT_RETURN(value != nullptr && value[0] != '\0',);
  2949. CARLA_SAFE_ASSERT_RETURN(std::strcmp(type, URI_TYPE_INTEGER) == 0,);
  2950. if (clientBelongsToUs)
  2951. pluginId = std::atoi(value);
  2952. icon = PATCHBAY_ICON_PLUGIN;
  2953. jackbridge_free(value);
  2954. jackbridge_free(type);
  2955. }
  2956. {
  2957. char* value = nullptr;
  2958. char* type = nullptr;
  2959. if (! jackbridge_get_property(uuid, URI_PLUGIN_ICON, &value, &type))
  2960. return;
  2961. CARLA_SAFE_ASSERT_RETURN(type != nullptr && type[0] != '\0',);
  2962. CARLA_SAFE_ASSERT_RETURN(value != nullptr && value[0] != '\0',);
  2963. CARLA_SAFE_ASSERT_RETURN(std::strcmp(type, URI_TYPE_STRING) == 0,);
  2964. /**/ if (std::strcmp(value, "app") == 0)
  2965. icon = PATCHBAY_ICON_APPLICATION;
  2966. else if (std::strcmp(value, "application") == 0)
  2967. icon = PATCHBAY_ICON_APPLICATION;
  2968. else if (std::strcmp(value, "plugin") == 0)
  2969. icon = PATCHBAY_ICON_PLUGIN;
  2970. else if (std::strcmp(value, "hardware") == 0)
  2971. icon = PATCHBAY_ICON_HARDWARE;
  2972. else if (std::strcmp(value, "carla") == 0)
  2973. icon = PATCHBAY_ICON_CARLA;
  2974. else if (std::strcmp(value, "distrho") == 0)
  2975. icon = PATCHBAY_ICON_DISTRHO;
  2976. else if (std::strcmp(value, "file") == 0)
  2977. icon = PATCHBAY_ICON_FILE;
  2978. jackbridge_free(value);
  2979. jackbridge_free(type);
  2980. }
  2981. }
  2982. // prevent recursion on patchbay group position changes
  2983. struct LastPatchbaySetGroupPos {
  2984. int x1, y1, x2, y2;
  2985. LastPatchbaySetGroupPos()
  2986. : x1(0), y1(0), x2(0), y2(0) {}
  2987. void clear() noexcept
  2988. {
  2989. x1 = y1 = x2 = y2 = 0;
  2990. }
  2991. void set(const int _x1, const int _y1, const int _x2, const int _y2) noexcept
  2992. {
  2993. x1 = _x1;
  2994. y1 = _y1;
  2995. x2 = _x2;
  2996. y2 = _y2;
  2997. }
  2998. bool operator!=(const LastPatchbaySetGroupPos& pos) const noexcept
  2999. {
  3000. return pos.x1 != x1 || pos.y1 != y1 || pos.x2 != x2 || pos.y2 != y2;
  3001. }
  3002. } fLastPatchbaySetGroupPos;
  3003. // handy stuff only needed for initJackPatchbay
  3004. struct GroupToIdData {
  3005. uint id;
  3006. PatchbayIcon icon;
  3007. int pluginId;
  3008. char strVal[STR_MAX];
  3009. };
  3010. struct PortToIdData {
  3011. uint group;
  3012. uint port;
  3013. uint flags;
  3014. char strVal[STR_MAX];
  3015. };
  3016. struct ConnectionToIdData {
  3017. uint id;
  3018. char strVal[STR_MAX];
  3019. };
  3020. void initJackPatchbay(const bool sendHost, const bool sendOSC, const char* const ourName, const bool groupsOnly)
  3021. {
  3022. CARLA_SAFE_ASSERT_RETURN(ourName != nullptr && ourName[0] != '\0',);
  3023. fLastPatchbaySetGroupPos.clear();
  3024. uint id, carlaId;
  3025. CarlaStringList parsedGroups;
  3026. LinkedList<GroupToIdData> groupCallbackData;
  3027. LinkedList<PortToIdData> portsCallbackData;
  3028. LinkedList<ConnectionToIdData> connCallbackData;
  3029. {
  3030. const CarlaMutexLocker cml1(fUsedGroups.mutex);
  3031. const CarlaMutexLocker cml2(fUsedPorts.mutex);
  3032. const CarlaMutexLocker cml3(fUsedConnections.mutex);
  3033. const CarlaMutexLocker cml4(fPostPonedEventsMutex);
  3034. fUsedGroups.clear();
  3035. fUsedPorts.clear();
  3036. fUsedConnections.clear();
  3037. fPostPonedEvents.clear();
  3038. // add our client first
  3039. {
  3040. carlaId = ++fUsedGroups.lastId;
  3041. parsedGroups.append(ourName);
  3042. GroupNameToId groupNameToId;
  3043. groupNameToId.setData(carlaId, ourName);
  3044. fUsedGroups.list.append(groupNameToId);
  3045. }
  3046. // query all jack ports
  3047. {
  3048. const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, 0);
  3049. CARLA_SAFE_ASSERT_RETURN(ports != nullptr,);
  3050. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  3051. for (int i=0; ports[i] != nullptr; ++i)
  3052. {
  3053. const char* const fullPortName(ports[i]);
  3054. CARLA_SAFE_ASSERT_CONTINUE(fullPortName != nullptr && fullPortName[0] != '\0');
  3055. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, fullPortName));
  3056. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  3057. const char* const shortPortName(jackbridge_port_short_name(jackPort));
  3058. CARLA_SAFE_ASSERT_CONTINUE(shortPortName != nullptr && shortPortName[0] != '\0');
  3059. const CarlaJackPortHints jackPortHints(CarlaJackPortHints::fromPort(jackPort));
  3060. uint groupId = 0;
  3061. bool found;
  3062. String groupName(fullPortName);
  3063. groupName.truncate(groupName.rfind(shortPortName, &found)-1);
  3064. CARLA_SAFE_ASSERT_CONTINUE(found);
  3065. if (parsedGroups.contains(groupName))
  3066. {
  3067. groupId = fUsedGroups.getGroupId(groupName);
  3068. CARLA_SAFE_ASSERT_CONTINUE(groupId > 0);
  3069. }
  3070. else
  3071. {
  3072. groupId = ++fUsedGroups.lastId;
  3073. parsedGroups.append(groupName);
  3074. GroupNameToId groupNameToId;
  3075. groupNameToId.setData(groupId, groupName);
  3076. int pluginId = -1;
  3077. PatchbayIcon icon = jackPortHints.isHardware ? PATCHBAY_ICON_HARDWARE : PATCHBAY_ICON_APPLICATION;
  3078. findPluginIdAndIcon(groupName, pluginId, icon);
  3079. fUsedGroups.list.append(groupNameToId);
  3080. if (! groupsOnly)
  3081. {
  3082. GroupToIdData groupData;
  3083. groupData.id = groupId;
  3084. groupData.icon = icon;
  3085. groupData.pluginId = pluginId;
  3086. std::strncpy(groupData.strVal, groupName, STR_MAX-1);
  3087. groupData.strVal[STR_MAX-1] = '\0';
  3088. groupCallbackData.append(groupData);
  3089. }
  3090. }
  3091. if (groupsOnly)
  3092. continue;
  3093. uint canvasPortFlags = 0x0;
  3094. canvasPortFlags |= jackPortHints.isInput ? PATCHBAY_PORT_IS_INPUT : 0x0;
  3095. /**/ if (jackPortHints.isCV)
  3096. canvasPortFlags |= PATCHBAY_PORT_TYPE_CV;
  3097. else if (jackPortHints.isOSC)
  3098. canvasPortFlags |= PATCHBAY_PORT_TYPE_OSC;
  3099. else if (jackPortHints.isAudio)
  3100. canvasPortFlags |= PATCHBAY_PORT_TYPE_AUDIO;
  3101. else if (jackPortHints.isMIDI)
  3102. canvasPortFlags |= PATCHBAY_PORT_TYPE_MIDI;
  3103. id = ++fUsedPorts.lastId;
  3104. PortNameToId portNameToId;
  3105. portNameToId.setData(groupId, id, shortPortName, fullPortName);
  3106. fUsedPorts.list.append(portNameToId);
  3107. PortToIdData portData;
  3108. portData.group = groupId;
  3109. portData.port = id;
  3110. portData.flags = canvasPortFlags;
  3111. std::strncpy(portData.strVal, shortPortName, STR_MAX-1);
  3112. portData.strVal[STR_MAX-1] = '\0';
  3113. portsCallbackData.append(portData);
  3114. }
  3115. jackbridge_free(ports);
  3116. }
  3117. if (groupsOnly)
  3118. return;
  3119. // query connections, after all ports are in place
  3120. if (const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, JackPortIsOutput))
  3121. {
  3122. for (int i=0; ports[i] != nullptr; ++i)
  3123. {
  3124. const char* const fullPortName(ports[i]);
  3125. CARLA_SAFE_ASSERT_CONTINUE(fullPortName != nullptr && fullPortName[0] != '\0');
  3126. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, fullPortName));
  3127. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  3128. const PortNameToId& thisPort(fUsedPorts.getPortNameToId(fullPortName));
  3129. CARLA_SAFE_ASSERT_CONTINUE(thisPort.group > 0);
  3130. CARLA_SAFE_ASSERT_CONTINUE(thisPort.port > 0);
  3131. if (const char** const connections = jackbridge_port_get_all_connections(fClient, jackPort))
  3132. {
  3133. for (int j=0; connections[j] != nullptr; ++j)
  3134. {
  3135. const char* const connection(connections[j]);
  3136. CARLA_SAFE_ASSERT_CONTINUE(connection != nullptr && connection[0] != '\0');
  3137. const PortNameToId& targetPort(fUsedPorts.getPortNameToId(connection));
  3138. CARLA_SAFE_ASSERT_CONTINUE(targetPort.group > 0);
  3139. CARLA_SAFE_ASSERT_CONTINUE(targetPort.port > 0);
  3140. id = ++fUsedConnections.lastId;
  3141. ConnectionToId connectionToId;
  3142. connectionToId.setData(id, thisPort.group, thisPort.port, targetPort.group, targetPort.port);
  3143. fUsedConnections.list.append(connectionToId);
  3144. ConnectionToIdData connData;
  3145. connData.id = id;
  3146. std::snprintf(connData.strVal, STR_MAX-1, "%i:%i:%i:%i",
  3147. thisPort.group, thisPort.port, targetPort.group, targetPort.port);
  3148. connData.strVal[STR_MAX-1] = '\0';
  3149. connCallbackData.append(connData);
  3150. }
  3151. jackbridge_free(connections);
  3152. }
  3153. }
  3154. jackbridge_free(ports);
  3155. }
  3156. }
  3157. const GroupToIdData groupFallback = { 0, PATCHBAY_ICON_PLUGIN, -1, { '\0' } };
  3158. const PortToIdData portFallback = { 0, 0, 0, { '\0' } };
  3159. const ConnectionToIdData connFallback = { 0, { '\0' } };
  3160. callback(sendHost, sendOSC,
  3161. ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED,
  3162. carlaId,
  3163. PATCHBAY_ICON_CARLA,
  3164. MAIN_CARLA_PLUGIN_ID,
  3165. 0, 0.0f,
  3166. ourName);
  3167. {
  3168. const CarlaRecursiveMutexLocker crml(fThreadSafeMetadataMutex);
  3169. for (LinkedList<GroupToIdData>::Itenerator it = groupCallbackData.begin2(); it.valid(); it.next())
  3170. {
  3171. const GroupToIdData& group(it.getValue(groupFallback));
  3172. callback(sendHost, sendOSC,
  3173. ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED,
  3174. group.id,
  3175. group.icon,
  3176. group.pluginId,
  3177. 0, 0.0f,
  3178. group.strVal);
  3179. jack_uuid_t uuid;
  3180. {
  3181. char* const uuidstr = jackbridge_get_uuid_for_client_name(fClient, group.strVal);
  3182. CARLA_SAFE_ASSERT_CONTINUE(uuidstr != nullptr && uuidstr[0] != '\0');
  3183. const bool parsed = jackbridge_uuid_parse(uuidstr, &uuid);
  3184. jackbridge_free(uuidstr);
  3185. /* if parsing fails, meta-data is not available..
  3186. this could be because JACK version is old, or perhaps this is an internal client */
  3187. if (! parsed)
  3188. continue;
  3189. }
  3190. char* value = nullptr;
  3191. char* type = nullptr;
  3192. if (jackbridge_get_property(uuid, URI_POSITION, &value, &type)
  3193. && value != nullptr
  3194. && type != nullptr
  3195. && std::strcmp(type, URI_TYPE_STRING) == 0)
  3196. {
  3197. if (char* sep1 = std::strstr(value, ":"))
  3198. {
  3199. int x1, y1 = 0, x2 = 0, y2 = 0;
  3200. *sep1++ = '\0';
  3201. x1 = std::atoi(value);
  3202. if (char* sep2 = std::strstr(sep1, ":"))
  3203. {
  3204. *sep2++ = '\0';
  3205. y1 = std::atoi(sep1);
  3206. if (char* sep3 = std::strstr(sep2, ":"))
  3207. {
  3208. *sep3++ = '\0';
  3209. x2 = std::atoi(sep2);
  3210. y2 = std::atoi(sep3);
  3211. }
  3212. }
  3213. jackbridge_free(value);
  3214. jackbridge_free(type);
  3215. callback(sendHost, sendOSC,
  3216. ENGINE_CALLBACK_PATCHBAY_CLIENT_POSITION_CHANGED,
  3217. group.id, x1, y1, x2, static_cast<float>(y2),
  3218. nullptr);
  3219. }
  3220. }
  3221. }
  3222. }
  3223. for (LinkedList<PortToIdData>::Itenerator it = portsCallbackData.begin2(); it.valid(); it.next())
  3224. {
  3225. const PortToIdData& port(it.getValue(portFallback));
  3226. callback(sendHost, sendOSC,
  3227. ENGINE_CALLBACK_PATCHBAY_PORT_ADDED,
  3228. port.group,
  3229. static_cast<int>(port.port),
  3230. static_cast<int>(port.flags),
  3231. 0, 0.0f,
  3232. port.strVal);
  3233. }
  3234. for (LinkedList<ConnectionToIdData>::Itenerator it = connCallbackData.begin2(); it.valid(); it.next())
  3235. {
  3236. const ConnectionToIdData& conn(it.getValue(connFallback));
  3237. callback(sendHost, sendOSC,
  3238. ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED,
  3239. conn.id,
  3240. 0, 0, 0, 0.0f,
  3241. conn.strVal);
  3242. }
  3243. groupCallbackData.clear();
  3244. portsCallbackData.clear();
  3245. connCallbackData.clear();
  3246. }
  3247. #endif
  3248. // -------------------------------------------------------------------
  3249. void processPlugin(CarlaPluginPtr& plugin, const uint32_t nframes)
  3250. {
  3251. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  3252. CarlaEngineJackClient* const client = (CarlaEngineJackClient*)plugin->getEngineClient();
  3253. CarlaEngineJackCVSourcePorts& cvSourcePorts(client->getCVSourcePorts());
  3254. const CarlaRecursiveMutexTryLocker crmtl(cvSourcePorts.getMutex(), fFreewheel);
  3255. // const CarlaRecursiveMutexLocker crml(cvSourcePorts.getMutex());
  3256. #endif
  3257. /*
  3258. const uint32_t audioInCount = client->getPortCount(kEnginePortTypeAudio, true);
  3259. const uint32_t audioOutCount = client->getPortCount(kEnginePortTypeAudio, false);
  3260. const uint32_t cvInCount = client->getPortCount(kEnginePortTypeCV, true);
  3261. const uint32_t cvOutCount = client->getPortCount(kEnginePortTypeCV, false);
  3262. */
  3263. const uint32_t audioInCount = plugin->getAudioInCount();
  3264. const uint32_t audioOutCount = plugin->getAudioOutCount();
  3265. const uint32_t cvInCount = plugin->getCVInCount();
  3266. const uint32_t cvOutCount = plugin->getCVOutCount();
  3267. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  3268. const uint32_t cvsInCount = crmtl.wasLocked() ? cvSourcePorts.getPortCount() : 0;
  3269. #else
  3270. const uint32_t cvsInCount = 0;
  3271. #endif
  3272. const float* audioIn[audioInCount];
  3273. /* */ float* audioOut[audioOutCount];
  3274. const float* cvIn[cvInCount+cvsInCount];
  3275. /* */ float* cvOut[cvOutCount];
  3276. for (uint32_t i=0; i < audioInCount; ++i)
  3277. {
  3278. if (CarlaEngineAudioPort* const port = plugin->getAudioInPort(i))
  3279. audioIn[i] = port->getBuffer();
  3280. else
  3281. audioIn[i] = nullptr;
  3282. }
  3283. for (uint32_t i=0; i < audioOutCount; ++i)
  3284. {
  3285. if (CarlaEngineAudioPort* const port = plugin->getAudioOutPort(i))
  3286. audioOut[i] = port->getBuffer();
  3287. else
  3288. audioOut[i] = nullptr;
  3289. }
  3290. for (uint32_t i=0; i < cvInCount; ++i)
  3291. {
  3292. if (CarlaEngineCVPort* const port = plugin->getCVInPort(i))
  3293. cvIn[i] = port->getBuffer();
  3294. else
  3295. cvIn[i] = nullptr;
  3296. }
  3297. #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  3298. for (uint32_t i=cvInCount, j=0; j < cvsInCount; ++i, ++j)
  3299. {
  3300. if (CarlaEngineCVPort* const port = cvSourcePorts.getPort(j))
  3301. {
  3302. port->initBuffer();
  3303. cvIn[i] = port->getBuffer();
  3304. }
  3305. else
  3306. {
  3307. cvIn[i] = nullptr;
  3308. }
  3309. }
  3310. #endif
  3311. for (uint32_t i=0; i < cvOutCount; ++i)
  3312. {
  3313. if (CarlaEngineCVPort* const port = plugin->getCVOutPort(i))
  3314. cvOut[i] = port->getBuffer();
  3315. else
  3316. cvOut[i] = nullptr;
  3317. }
  3318. float inPeaks[2] = { 0.0f };
  3319. float outPeaks[2] = { 0.0f };
  3320. for (uint32_t i=0; i < audioInCount && i < 2; ++i)
  3321. {
  3322. for (uint32_t j=0; j < nframes; ++j)
  3323. {
  3324. const float absV(std::abs(audioIn[i][j]));
  3325. if (absV > inPeaks[i])
  3326. inPeaks[i] = absV;
  3327. }
  3328. }
  3329. plugin->process(audioIn, audioOut, cvIn, cvOut, nframes);
  3330. for (uint32_t i=0; i < audioOutCount && i < 2; ++i)
  3331. {
  3332. for (uint32_t j=0; j < nframes; ++j)
  3333. {
  3334. const float absV(std::abs(audioOut[i][j]));
  3335. if (absV > outPeaks[i])
  3336. outPeaks[i] = absV;
  3337. }
  3338. }
  3339. setPluginPeaksRT(plugin->getId(), inPeaks, outPeaks);
  3340. }
  3341. #ifndef BUILD_BRIDGE
  3342. // -------------------------------------------------------------------
  3343. struct PostPonedJackEvent {
  3344. enum Type {
  3345. kTypeNull = 0,
  3346. kTypeClientUnregister,
  3347. kTypeClientPositionChange,
  3348. kTypePortRegister,
  3349. kTypePortUnregister,
  3350. kTypePortConnect,
  3351. kTypePortDisconnect,
  3352. kTypePortRename
  3353. };
  3354. Type type;
  3355. union {
  3356. struct {
  3357. char name[STR_MAX+1];
  3358. } clientRegister;
  3359. struct {
  3360. char name[STR_MAX+1];
  3361. } clientUnregister;
  3362. struct {
  3363. jack_uuid_t uuid;
  3364. } clientPositionChange;
  3365. struct {
  3366. char shortName[STR_MAX+1];
  3367. char fullName[STR_MAX+1];
  3368. CarlaJackPortHints hints;
  3369. } portRegister;
  3370. struct {
  3371. char fullName[STR_MAX+1];
  3372. } portUnregister;
  3373. struct {
  3374. char oldFullName[STR_MAX+1];
  3375. char newFullName[STR_MAX+1];
  3376. char newShortName[STR_MAX+1];
  3377. } portRename;
  3378. struct {
  3379. char portNameA[STR_MAX+1];
  3380. char portNameB[STR_MAX+1];
  3381. } portConnect;
  3382. struct {
  3383. char portNameA[STR_MAX+1];
  3384. char portNameB[STR_MAX+1];
  3385. } portDisconnect;
  3386. };
  3387. };
  3388. LinkedList<PostPonedJackEvent> fPostPonedEvents;
  3389. CarlaMutex fPostPonedEventsMutex;
  3390. bool fIsInternalClient;
  3391. void postponeJackCallback(PostPonedJackEvent& ev)
  3392. {
  3393. const CarlaMutexLocker cml(fPostPonedEventsMutex);
  3394. fPostPonedEvents.append(ev);
  3395. }
  3396. void run() override
  3397. {
  3398. for (; ! shouldThreadExit();)
  3399. {
  3400. if (fIsInternalClient)
  3401. idle();
  3402. if (fClient == nullptr)
  3403. break;
  3404. d_msleep(200);
  3405. }
  3406. }
  3407. #endif // BUILD_BRIDGE
  3408. // -------------------------------------------------------------------
  3409. // disable -Wattributes warnings
  3410. #if defined(__clang__)
  3411. # pragma clang diagnostic push
  3412. # pragma clang diagnostic ignored "-Wattributes"
  3413. #elif defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
  3414. # pragma GCC diagnostic push
  3415. # pragma GCC diagnostic ignored "-Wattributes"
  3416. #endif
  3417. #define handlePtr ((CarlaEngineJack*)arg)
  3418. static void JACKBRIDGE_API carla_jack_thread_init_callback(void*)
  3419. {
  3420. #ifdef __SSE2_MATH__
  3421. // Set FTZ and DAZ flags
  3422. _mm_setcsr(_mm_getcsr() | 0x8040);
  3423. #endif
  3424. }
  3425. static int JACKBRIDGE_API carla_jack_bufsize_callback(jack_nframes_t newBufferSize, void* arg)
  3426. {
  3427. handlePtr->handleJackBufferSizeCallback(newBufferSize);
  3428. return 0;
  3429. }
  3430. static int JACKBRIDGE_API carla_jack_srate_callback(jack_nframes_t newSampleRate, void* arg)
  3431. {
  3432. handlePtr->handleJackSampleRateCallback(newSampleRate);
  3433. return 0;
  3434. }
  3435. static void JACKBRIDGE_API carla_jack_freewheel_callback(int starting, void* arg)
  3436. {
  3437. handlePtr->handleJackFreewheelCallback(bool(starting));
  3438. }
  3439. static void JACKBRIDGE_API carla_jack_latency_callback(jack_latency_callback_mode_t mode, void* arg)
  3440. {
  3441. handlePtr->handleJackLatencyCallback(mode);
  3442. }
  3443. static int JACKBRIDGE_API carla_jack_process_callback(jack_nframes_t nframes, void* arg) __attribute__((annotate("realtime")))
  3444. {
  3445. handlePtr->handleJackProcessCallback(nframes);
  3446. return 0;
  3447. }
  3448. #ifndef BUILD_BRIDGE
  3449. static void JACKBRIDGE_API carla_jack_timebase_callback(jack_transport_state_t, jack_nframes_t nframes, jack_position_t* pos, int new_pos, void* arg) __attribute__((annotate("realtime")))
  3450. {
  3451. handlePtr->handleJackTimebaseCallback(nframes, pos, new_pos);
  3452. }
  3453. static void JACKBRIDGE_API carla_jack_client_registration_callback(const char* name, int reg, void* arg)
  3454. {
  3455. if (reg == 0)
  3456. return;
  3457. PostPonedJackEvent ev;
  3458. carla_zeroStruct(ev);
  3459. ev.type = PostPonedJackEvent::kTypeClientUnregister;
  3460. std::strncpy(ev.clientUnregister.name, name, STR_MAX);
  3461. handlePtr->postponeJackCallback(ev);
  3462. }
  3463. static void JACKBRIDGE_API carla_jack_port_registration_callback(jack_port_id_t port_id, int reg, void* arg)
  3464. {
  3465. const jack_port_t* const port = jackbridge_port_by_id(handlePtr->fClient, port_id);
  3466. CARLA_SAFE_ASSERT_RETURN(port != nullptr,);
  3467. const char* const fullName = jackbridge_port_name(port);
  3468. CARLA_SAFE_ASSERT_RETURN(fullName != nullptr && fullName[0] != '\0',);
  3469. PostPonedJackEvent ev;
  3470. carla_zeroStruct(ev);
  3471. if (reg != 0)
  3472. {
  3473. const char* const shortName = jackbridge_port_short_name(port);
  3474. CARLA_SAFE_ASSERT_RETURN(shortName != nullptr && shortName[0] != '\0',);
  3475. ev.type = PostPonedJackEvent::kTypePortRegister;
  3476. std::strncpy(ev.portRegister.fullName, fullName, STR_MAX);
  3477. std::strncpy(ev.portRegister.shortName, shortName, STR_MAX);
  3478. const CarlaRecursiveMutexLocker crml(handlePtr->fThreadSafeMetadataMutex);
  3479. ev.portRegister.hints = CarlaJackPortHints::fromPort(port);
  3480. }
  3481. else
  3482. {
  3483. ev.type = PostPonedJackEvent::kTypePortUnregister;
  3484. std::strncpy(ev.portUnregister.fullName, fullName, STR_MAX);
  3485. }
  3486. handlePtr->postponeJackCallback(ev);
  3487. }
  3488. static void JACKBRIDGE_API carla_jack_port_connect_callback(jack_port_id_t a, jack_port_id_t b, int connect, void* arg)
  3489. {
  3490. const jack_port_t* const portA = jackbridge_port_by_id(handlePtr->fClient, a);
  3491. CARLA_SAFE_ASSERT_RETURN(portA != nullptr,);
  3492. const jack_port_t* const portB = jackbridge_port_by_id(handlePtr->fClient, b);
  3493. CARLA_SAFE_ASSERT_RETURN(portB != nullptr,);
  3494. const char* const fullNameA = jackbridge_port_name(portA);
  3495. CARLA_SAFE_ASSERT_RETURN(fullNameA != nullptr && fullNameA[0] != '\0',);
  3496. const char* const fullNameB = jackbridge_port_name(portB);
  3497. CARLA_SAFE_ASSERT_RETURN(fullNameB != nullptr && fullNameB[0] != '\0',);
  3498. PostPonedJackEvent ev;
  3499. carla_zeroStruct(ev);
  3500. if (connect != 0)
  3501. {
  3502. ev.type = PostPonedJackEvent::kTypePortConnect;
  3503. std::strncpy(ev.portConnect.portNameA, fullNameA, STR_MAX);
  3504. std::strncpy(ev.portConnect.portNameB, fullNameB, STR_MAX);
  3505. }
  3506. else
  3507. {
  3508. ev.type = PostPonedJackEvent::kTypePortDisconnect;
  3509. std::strncpy(ev.portDisconnect.portNameA, fullNameA, STR_MAX);
  3510. std::strncpy(ev.portDisconnect.portNameB, fullNameB, STR_MAX);
  3511. }
  3512. handlePtr->postponeJackCallback(ev);
  3513. }
  3514. static void JACKBRIDGE_API carla_jack_port_rename_callback(jack_port_id_t port_id, const char* oldName, const char* newName, void* arg)
  3515. {
  3516. const jack_port_t* const port = jackbridge_port_by_id(handlePtr->fClient, port_id);
  3517. CARLA_SAFE_ASSERT_RETURN(port != nullptr,);
  3518. const char* const shortName = jackbridge_port_short_name(port);
  3519. CARLA_SAFE_ASSERT_RETURN(shortName != nullptr && shortName[0] != '\0',);
  3520. PostPonedJackEvent ev;
  3521. carla_zeroStruct(ev);
  3522. ev.type = PostPonedJackEvent::kTypePortRename;
  3523. std::strncpy(ev.portRename.oldFullName, oldName, STR_MAX);
  3524. std::strncpy(ev.portRename.newFullName, newName, STR_MAX);
  3525. std::strncpy(ev.portRename.newShortName, shortName, STR_MAX);
  3526. handlePtr->postponeJackCallback(ev);
  3527. }
  3528. static void carla_jack_property_change_callback(jack_uuid_t subject, const char* key, jack_property_change_t change, void* arg)
  3529. {
  3530. if (change != PropertyChanged)
  3531. return;
  3532. if (std::strcmp(key, URI_POSITION) != 0)
  3533. return;
  3534. PostPonedJackEvent ev;
  3535. carla_zeroStruct(ev);
  3536. ev.type = PostPonedJackEvent::kTypeClientPositionChange;
  3537. ev.clientPositionChange.uuid = subject;
  3538. handlePtr->postponeJackCallback(ev);
  3539. }
  3540. static int JACKBRIDGE_API carla_jack_xrun_callback(void* arg)
  3541. {
  3542. ++(handlePtr->pData->xruns);
  3543. return 0;
  3544. }
  3545. #endif
  3546. static void JACKBRIDGE_API carla_jack_shutdown_callback(void* arg)
  3547. {
  3548. handlePtr->handleJackShutdownCallback();
  3549. }
  3550. #undef handlePtr
  3551. // -------------------------------------------------------------------
  3552. #ifndef BUILD_BRIDGE
  3553. static int JACKBRIDGE_API carla_jack_process_callback_plugin(jack_nframes_t nframes, void* arg) __attribute__((annotate("realtime")))
  3554. {
  3555. CarlaPluginPtr* const pluginPtr = static_cast<CarlaPluginPtr*>(arg);
  3556. CARLA_SAFE_ASSERT_RETURN(pluginPtr != nullptr, 0);
  3557. CarlaPluginPtr plugin = *pluginPtr;
  3558. CARLA_SAFE_ASSERT_RETURN(plugin.get() != nullptr && plugin->isEnabled(), 0);
  3559. CarlaEngineJack* const engine((CarlaEngineJack*)plugin->getEngine());
  3560. CARLA_SAFE_ASSERT_RETURN(engine != nullptr, 0);
  3561. if (plugin->tryLock(engine->fFreewheel))
  3562. {
  3563. plugin->initBuffers();
  3564. engine->processPlugin(plugin, nframes);
  3565. plugin->unlock();
  3566. }
  3567. return 0;
  3568. }
  3569. /*
  3570. static int JACKBRIDGE_API carla_jack_bufsize_callback_plugin(jack_nframes_t nframes, void* arg)
  3571. {
  3572. CarlaPlugin* const plugin((CarlaPlugin*)arg);
  3573. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr && plugin->isEnabled(), 0);
  3574. plugin->bufferSizeChanged(nframes);
  3575. return 1;
  3576. }
  3577. static int JACKBRIDGE_API carla_jack_srate_callback_plugin(jack_nframes_t nframes, void* arg)
  3578. {
  3579. CarlaPlugin* const plugin((CarlaPlugin*)arg);
  3580. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr && plugin->isEnabled(), 0);
  3581. plugin->sampleRateChanged(nframes);
  3582. return 1;
  3583. }
  3584. */
  3585. static void JACKBRIDGE_API carla_jack_latency_callback_plugin(jack_latency_callback_mode_t /*mode*/, void* /*arg*/)
  3586. {
  3587. // TODO
  3588. }
  3589. static void JACKBRIDGE_API carla_jack_shutdown_callback_plugin(void* arg)
  3590. {
  3591. CarlaPluginPtr* const pluginPtr = static_cast<CarlaPluginPtr*>(arg);
  3592. CARLA_SAFE_ASSERT_RETURN(pluginPtr != nullptr,);
  3593. CarlaPluginPtr plugin = *pluginPtr;
  3594. CARLA_SAFE_ASSERT_RETURN(plugin.get() != nullptr,);
  3595. CarlaEngineJack* const engine((CarlaEngineJack*)plugin->getEngine());
  3596. CARLA_SAFE_ASSERT_RETURN(engine != nullptr,);
  3597. engine->handlePluginJackShutdownCallback(plugin);
  3598. }
  3599. #endif
  3600. // enable -Wattributes again
  3601. #if defined(__clang__)
  3602. # pragma clang diagnostic pop
  3603. #elif defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
  3604. # pragma GCC diagnostic pop
  3605. #endif
  3606. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJack)
  3607. };
  3608. // -----------------------------------------------------------------------
  3609. namespace EngineInit {
  3610. CarlaEngine* newJack()
  3611. {
  3612. carla_debug("EngineInit::newJack()");
  3613. return new CarlaEngineJack();
  3614. }
  3615. }
  3616. // -----------------------------------------------------------------------
  3617. CARLA_BACKEND_END_NAMESPACE
  3618. #if defined(JACKBRIDGE_DIRECT) && !defined(BUILD_BRIDGE)
  3619. // -----------------------------------------------------------------------
  3620. // internal jack client
  3621. CARLA_PLUGIN_EXPORT
  3622. int jack_initialize(jack_client_t *client, const char *load_init);
  3623. CARLA_PLUGIN_EXPORT
  3624. void jack_finish(void *arg);
  3625. #ifdef CARLA_OS_UNIX
  3626. # include "ThreadSafeFFTW.hpp"
  3627. #endif
  3628. // -----------------------------------------------------------------------
  3629. CARLA_PLUGIN_EXPORT
  3630. int jack_initialize(jack_client_t* const client, const char* const load_init)
  3631. {
  3632. CARLA_BACKEND_USE_NAMESPACE
  3633. #ifdef CARLA_OS_UNIX
  3634. static const ThreadSafeFFTW sThreadSafeFFTW;
  3635. #endif
  3636. EngineProcessMode mode;
  3637. if (load_init != nullptr && std::strcmp(load_init, "rack") == 0)
  3638. mode = ENGINE_PROCESS_MODE_CONTINUOUS_RACK;
  3639. else
  3640. mode = ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS;
  3641. CarlaEngineJack* const engine = new CarlaEngineJack();
  3642. engine->setOption(ENGINE_OPTION_FORCE_STEREO, 1, nullptr);
  3643. engine->setOption(ENGINE_OPTION_AUDIO_DRIVER, 0, "JACK");
  3644. engine->setOption(ENGINE_OPTION_AUDIO_DEVICE, 0, "Auto-Connect ON");
  3645. engine->setOption(ENGINE_OPTION_OSC_ENABLED, 1, nullptr);
  3646. engine->setOption(ENGINE_OPTION_OSC_PORT_TCP, 22752, nullptr);
  3647. engine->setOption(ENGINE_OPTION_OSC_PORT_UDP, 22752, nullptr);
  3648. engine->setOption(ENGINE_OPTION_PROCESS_MODE, mode, nullptr);
  3649. engine->setOption(ENGINE_OPTION_TRANSPORT_MODE, ENGINE_TRANSPORT_MODE_JACK, nullptr);
  3650. #ifdef __MOD_DEVICES__
  3651. engine->setOption(ENGINE_OPTION_FILE_PATH, FILE_AUDIO, "/data/user-files/Audio Loops:/data/user-files/Audio Tracks");
  3652. engine->setOption(ENGINE_OPTION_FILE_PATH, FILE_MIDI, "/data/user-files/MIDI Songs");
  3653. #endif
  3654. // FIXME
  3655. engine->setOption(ENGINE_OPTION_PATH_BINARIES, 0, "/usr/lib/carla");
  3656. engine->setOption(ENGINE_OPTION_PATH_RESOURCES, 0, "/usr/share/resources");
  3657. if (engine->initInternal(client))
  3658. return 0;
  3659. delete engine;
  3660. return 1;
  3661. }
  3662. CARLA_PLUGIN_EXPORT
  3663. void jack_finish(void *arg)
  3664. {
  3665. CARLA_BACKEND_USE_NAMESPACE
  3666. CarlaEngineJack* const engine = (CarlaEngineJack*)arg;;
  3667. CARLA_SAFE_ASSERT_RETURN(engine != nullptr,);
  3668. engine->setAboutToClose();
  3669. engine->removeAllPlugins();
  3670. engine->close();
  3671. delete engine;
  3672. }
  3673. // -----------------------------------------------------------------------
  3674. #endif // defined(JACKBRIDGE_DIRECT) && !defined(BUILD_BRIDGE)