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.

4589 lines
162KB

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