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.

2997 lines
105KB

  1. /*
  2. * Carla Plugin Host
  3. * Copyright (C) 2011-2019 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License as
  7. * published by the Free Software Foundation; either version 2 of
  8. * the License, or any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16. */
  17. #include "CarlaEngineInternal.hpp"
  18. #include "CarlaPlugin.hpp"
  19. #include "CarlaBackendUtils.hpp"
  20. #include "CarlaEngineUtils.hpp"
  21. #include "CarlaMathUtils.hpp"
  22. #include "CarlaMIDI.h"
  23. #include "CarlaPatchbayUtils.hpp"
  24. #include "CarlaStringList.hpp"
  25. #include "jackey.h"
  26. #ifdef __SSE2_MATH__
  27. # include <xmmintrin.h>
  28. #endif
  29. // must be last
  30. #include "jackbridge/JackBridge.hpp"
  31. #define URI_CANVAS_ICON "http://kxstudio.sf.net/ns/canvas/icon"
  32. CARLA_BACKEND_START_NAMESPACE
  33. class CarlaEngineJack;
  34. class CarlaEngineJackClient;
  35. // -----------------------------------------------------------------------
  36. // Fallback data
  37. static const EngineEvent kFallbackJackEngineEvent = { kEngineEventTypeNull, 0, 0, {{ kEngineControlEventTypeNull, 0, 0.0f }} };
  38. // -----------------------------------------------------------------------
  39. // Carla Engine Port removal helper
  40. class CarlaEngineJackAudioPort;
  41. class CarlaEngineJackCVPort;
  42. class CarlaEngineJackEventPort;
  43. struct JackPortDeletionCallback {
  44. virtual ~JackPortDeletionCallback() noexcept {}
  45. virtual void jackAudioPortDeleted(CarlaEngineJackAudioPort* const) noexcept = 0;
  46. virtual void jackCVPortDeleted(CarlaEngineJackCVPort* const) noexcept = 0;
  47. virtual void jackEventPortDeleted(CarlaEngineJackEventPort* const) noexcept = 0;
  48. };
  49. // -----------------------------------------------------------------------
  50. // Carla Engine JACK-Audio port
  51. class CarlaEngineJackAudioPort : public CarlaEngineAudioPort
  52. {
  53. public:
  54. CarlaEngineJackAudioPort(const CarlaEngineClient& client, const bool isInputPort, const uint32_t indexOffset, jack_client_t* const jackClient, jack_port_t* const jackPort, JackPortDeletionCallback* const delCallback) noexcept
  55. : CarlaEngineAudioPort(client, isInputPort, indexOffset),
  56. fJackClient(jackClient),
  57. fJackPort(jackPort),
  58. kDeletionCallback(delCallback)
  59. {
  60. carla_debug("CarlaEngineJackAudioPort::CarlaEngineJackAudioPort(%s, %p, %p)", bool2str(isInputPort), jackClient, jackPort);
  61. switch (kClient.getEngine().getProccessMode())
  62. {
  63. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  64. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  65. CARLA_SAFE_ASSERT_RETURN(jackClient != nullptr && jackPort != nullptr,);
  66. #ifndef BUILD_BRIDGE
  67. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  68. jackbridge_set_property(jackClient, uuid, JACKEY_SIGNAL_TYPE, "AUDIO", "text/plain");
  69. #endif
  70. break;
  71. default:
  72. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  73. break;
  74. }
  75. }
  76. ~CarlaEngineJackAudioPort() noexcept override
  77. {
  78. carla_debug("CarlaEngineJackAudioPort::~CarlaEngineJackAudioPort()");
  79. if (fJackClient != nullptr && fJackPort != nullptr)
  80. {
  81. #ifndef BUILD_BRIDGE
  82. try {
  83. if (const jack_uuid_t uuid = jackbridge_port_uuid(fJackPort))
  84. jackbridge_remove_property(fJackClient, uuid, JACKEY_SIGNAL_TYPE);
  85. } CARLA_SAFE_EXCEPTION("Audio port remove meta type");
  86. #endif
  87. try {
  88. jackbridge_port_unregister(fJackClient, fJackPort);
  89. } CARLA_SAFE_EXCEPTION("Audio port unregister");
  90. fJackClient = nullptr;
  91. fJackPort = nullptr;
  92. }
  93. if (kDeletionCallback != nullptr)
  94. kDeletionCallback->jackAudioPortDeleted(this);
  95. }
  96. void initBuffer() noexcept override
  97. {
  98. if (fJackPort == nullptr)
  99. return CarlaEngineAudioPort::initBuffer();
  100. const uint32_t bufferSize(kClient.getEngine().getBufferSize());
  101. try {
  102. fBuffer = (float*)jackbridge_port_get_buffer(fJackPort, bufferSize);
  103. }
  104. catch(...) {
  105. fBuffer = nullptr;
  106. return;
  107. }
  108. if (! kIsInput)
  109. carla_zeroFloats(fBuffer, bufferSize);
  110. }
  111. void invalidate() noexcept
  112. {
  113. fJackClient = nullptr;
  114. fJackPort = nullptr;
  115. }
  116. private:
  117. jack_client_t* fJackClient;
  118. jack_port_t* fJackPort;
  119. JackPortDeletionCallback* const kDeletionCallback;
  120. friend class CarlaEngineJackClient;
  121. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackAudioPort)
  122. };
  123. // -----------------------------------------------------------------------
  124. // Carla Engine JACK-CV port
  125. class CarlaEngineJackCVPort : public CarlaEngineCVPort
  126. {
  127. public:
  128. CarlaEngineJackCVPort(const CarlaEngineClient& client, const bool isInputPort, const uint32_t indexOffset, jack_client_t* const jackClient, jack_port_t* const jackPort, JackPortDeletionCallback* const delCallback) noexcept
  129. : CarlaEngineCVPort(client, isInputPort, indexOffset),
  130. fJackClient(jackClient),
  131. fJackPort(jackPort),
  132. kDeletionCallback(delCallback)
  133. {
  134. carla_debug("CarlaEngineJackCVPort::CarlaEngineJackCVPort(%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. #ifndef BUILD_BRIDGE
  141. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  142. jackbridge_set_property(jackClient, uuid, JACKEY_SIGNAL_TYPE, "CV", "text/plain");
  143. #endif
  144. break;
  145. default:
  146. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  147. break;
  148. }
  149. }
  150. ~CarlaEngineJackCVPort() noexcept override
  151. {
  152. carla_debug("CarlaEngineJackCVPort::~CarlaEngineJackCVPort()");
  153. if (fJackClient != nullptr && fJackPort != nullptr)
  154. {
  155. #ifndef BUILD_BRIDGE
  156. try {
  157. if (const jack_uuid_t uuid = jackbridge_port_uuid(fJackPort))
  158. jackbridge_remove_property(fJackClient, uuid, JACKEY_SIGNAL_TYPE);
  159. } CARLA_SAFE_EXCEPTION("CV port remove meta type");
  160. #endif
  161. try {
  162. jackbridge_port_unregister(fJackClient, fJackPort);
  163. } CARLA_SAFE_EXCEPTION("CV port unregister");
  164. fJackClient = nullptr;
  165. fJackPort = nullptr;
  166. }
  167. if (kDeletionCallback != nullptr)
  168. kDeletionCallback->jackCVPortDeleted(this);
  169. }
  170. void initBuffer() noexcept override
  171. {
  172. if (fJackPort == nullptr)
  173. return CarlaEngineCVPort::initBuffer();
  174. const uint32_t bufferSize(kClient.getEngine().getBufferSize());
  175. try {
  176. fBuffer = (float*)jackbridge_port_get_buffer(fJackPort, bufferSize);
  177. }
  178. catch(...) {
  179. fBuffer = nullptr;
  180. return;
  181. }
  182. if (! kIsInput)
  183. carla_zeroFloats(fBuffer, bufferSize);
  184. }
  185. void invalidate() noexcept
  186. {
  187. fJackClient = nullptr;
  188. fJackPort = nullptr;
  189. }
  190. private:
  191. jack_client_t* fJackClient;
  192. jack_port_t* fJackPort;
  193. JackPortDeletionCallback* const kDeletionCallback;
  194. friend class CarlaEngineJackClient;
  195. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackCVPort)
  196. };
  197. // -----------------------------------------------------------------------
  198. // Carla Engine JACK-Event port
  199. class CarlaEngineJackEventPort : public CarlaEngineEventPort
  200. {
  201. public:
  202. CarlaEngineJackEventPort(const CarlaEngineClient& client, const bool isInputPort, const uint32_t indexOffset, jack_client_t* const jackClient, jack_port_t* const jackPort, JackPortDeletionCallback* const delCallback) noexcept
  203. : CarlaEngineEventPort(client, isInputPort, indexOffset),
  204. fJackClient(jackClient),
  205. fJackPort(jackPort),
  206. fJackBuffer(nullptr),
  207. fRetEvent(kFallbackJackEngineEvent),
  208. kDeletionCallback(delCallback)
  209. {
  210. carla_debug("CarlaEngineJackEventPort::CarlaEngineJackEventPort(%s, %p, %p)", bool2str(isInputPort), jackClient, jackPort);
  211. switch (kClient.getEngine().getProccessMode())
  212. {
  213. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  214. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  215. CARLA_SAFE_ASSERT_RETURN(jackClient != nullptr && jackPort != nullptr,);
  216. break;
  217. default:
  218. CARLA_SAFE_ASSERT(jackClient == nullptr && jackPort == nullptr);
  219. break;
  220. }
  221. }
  222. ~CarlaEngineJackEventPort() noexcept override
  223. {
  224. carla_debug("CarlaEngineJackEventPort::~CarlaEngineJackEventPort()");
  225. if (fJackClient != nullptr && fJackPort != nullptr)
  226. {
  227. try {
  228. jackbridge_port_unregister(fJackClient, fJackPort);
  229. } CARLA_SAFE_EXCEPTION("Event port unregister");
  230. fJackClient = nullptr;
  231. fJackPort = nullptr;
  232. }
  233. if (kDeletionCallback != nullptr)
  234. kDeletionCallback->jackEventPortDeleted(this);
  235. }
  236. void initBuffer() noexcept override
  237. {
  238. if (fJackPort == nullptr)
  239. return CarlaEngineEventPort::initBuffer();
  240. try {
  241. fJackBuffer = jackbridge_port_get_buffer(fJackPort, kClient.getEngine().getBufferSize());
  242. }
  243. catch(...) {
  244. fJackBuffer = nullptr;
  245. return;
  246. }
  247. if (! kIsInput)
  248. jackbridge_midi_clear_buffer(fJackBuffer);
  249. }
  250. uint32_t getEventCount() const noexcept override
  251. {
  252. if (fJackPort == nullptr)
  253. return CarlaEngineEventPort::getEventCount();
  254. CARLA_SAFE_ASSERT_RETURN(kIsInput, 0);
  255. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, 0);
  256. try {
  257. return jackbridge_midi_get_event_count(fJackBuffer);
  258. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_get_event_count", 0);
  259. }
  260. const EngineEvent& getEvent(const uint32_t index) const noexcept override
  261. {
  262. if (fJackPort == nullptr)
  263. return CarlaEngineEventPort::getEvent(index);
  264. CARLA_SAFE_ASSERT_RETURN(kIsInput, kFallbackJackEngineEvent);
  265. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, kFallbackJackEngineEvent);
  266. return getEventUnchecked(index);
  267. }
  268. const EngineEvent& getEventUnchecked(const uint32_t index) const noexcept override
  269. {
  270. jack_midi_event_t jackEvent;
  271. bool test = false;
  272. try {
  273. test = jackbridge_midi_event_get(&jackEvent, fJackBuffer, index);
  274. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_get", kFallbackJackEngineEvent);
  275. if (! test)
  276. return kFallbackJackEngineEvent;
  277. CARLA_SAFE_ASSERT_RETURN(jackEvent.size < 0xFF /* uint8_t max */, kFallbackJackEngineEvent);
  278. uint8_t port;
  279. if (kIndexOffset < 0xFF /* uint8_t max */)
  280. {
  281. port = static_cast<uint8_t>(kIndexOffset);
  282. }
  283. else
  284. {
  285. port = 0;
  286. carla_safe_assert_uint("kIndexOffset < 0xFF", __FILE__, __LINE__, kIndexOffset);
  287. }
  288. fRetEvent.time = jackEvent.time;
  289. fRetEvent.fillFromMidiData(static_cast<uint8_t>(jackEvent.size), jackEvent.buffer, port);
  290. return fRetEvent;
  291. }
  292. bool writeControlEvent(const uint32_t time, const uint8_t channel, const EngineControlEventType type, const uint16_t param, const float value) noexcept override
  293. {
  294. if (fJackPort == nullptr)
  295. return CarlaEngineEventPort::writeControlEvent(time, channel, type, param, value);
  296. CARLA_SAFE_ASSERT_RETURN(! kIsInput, false);
  297. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, false);
  298. CARLA_SAFE_ASSERT_RETURN(type != kEngineControlEventTypeNull, false);
  299. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS, false);
  300. CARLA_SAFE_ASSERT_RETURN(param < MAX_MIDI_CONTROL, false);
  301. CARLA_SAFE_ASSERT(value >= 0.0f && value <= 1.0f);
  302. if (type == kEngineControlEventTypeParameter) {
  303. CARLA_SAFE_ASSERT(! MIDI_IS_CONTROL_BANK_SELECT(param));
  304. }
  305. uint8_t data[3] = { 0, 0, 0 };
  306. EngineControlEvent ctrlEvent = { type, param, value };
  307. const uint8_t size = ctrlEvent.convertToMidiData(channel, data);
  308. if (size == 0)
  309. return false;
  310. try {
  311. return jackbridge_midi_event_write(fJackBuffer, time, data, size);
  312. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_write", false);
  313. }
  314. bool writeMidiEvent(const uint32_t time, const uint8_t channel, const uint8_t size, const uint8_t* const data) noexcept override
  315. {
  316. if (fJackPort == nullptr)
  317. return CarlaEngineEventPort::writeMidiEvent(time, channel, size, data);
  318. CARLA_SAFE_ASSERT_RETURN(! kIsInput, false);
  319. CARLA_SAFE_ASSERT_RETURN(fJackBuffer != nullptr, false);
  320. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS, false);
  321. CARLA_SAFE_ASSERT_RETURN(size > 0, false);
  322. CARLA_SAFE_ASSERT_RETURN(data != nullptr, false);
  323. jack_midi_data_t jdata[size];
  324. jdata[0] = static_cast<jack_midi_data_t>(MIDI_GET_STATUS_FROM_DATA(data) + channel);
  325. for (uint8_t i=1; i < size; ++i)
  326. jdata[i] = data[i];
  327. try {
  328. return jackbridge_midi_event_write(fJackBuffer, time, jdata, size);
  329. } CARLA_SAFE_EXCEPTION_RETURN("jack_midi_event_write", false);
  330. }
  331. void invalidate() noexcept
  332. {
  333. fJackClient = nullptr;
  334. fJackPort = nullptr;
  335. }
  336. private:
  337. jack_client_t* fJackClient;
  338. jack_port_t* fJackPort;
  339. void* fJackBuffer;
  340. mutable EngineEvent fRetEvent;
  341. JackPortDeletionCallback* const kDeletionCallback;
  342. friend class CarlaEngineJackClient;
  343. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackEventPort)
  344. };
  345. // -----------------------------------------------------------------------
  346. // Jack Engine client
  347. class CarlaEngineJackClient : public CarlaEngineClient,
  348. private JackPortDeletionCallback
  349. {
  350. public:
  351. CarlaEngineJackClient(const CarlaEngine& engine, jack_client_t* const jackClient)
  352. : CarlaEngineClient(engine),
  353. fJackClient(jackClient),
  354. fUseClient(engine.getProccessMode() == ENGINE_PROCESS_MODE_SINGLE_CLIENT || engine.getProccessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS),
  355. fAudioPorts(),
  356. fCVPorts(),
  357. fEventPorts(),
  358. fPreRenameMutex(),
  359. fPreRenameConnections()
  360. {
  361. carla_debug("CarlaEngineJackClient::CarlaEngineJackClient(%p)", jackClient);
  362. if (fUseClient)
  363. {
  364. CARLA_SAFE_ASSERT(jackClient != nullptr);
  365. }
  366. else
  367. {
  368. CARLA_SAFE_ASSERT(jackClient == nullptr);
  369. }
  370. }
  371. ~CarlaEngineJackClient() noexcept override
  372. {
  373. carla_debug("CarlaEngineJackClient::~CarlaEngineJackClient()");
  374. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS && fJackClient != nullptr) // FIXME
  375. jackbridge_client_close(fJackClient);
  376. // ports must have been deleted by now!
  377. //fAudioPorts.clear();
  378. //fCVPorts.clear();
  379. //fEventPorts.clear();
  380. }
  381. void activate() noexcept override
  382. {
  383. carla_debug("CarlaEngineJackClient::activate()");
  384. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  385. {
  386. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr && ! isActive(),);
  387. try {
  388. jackbridge_activate(fJackClient);
  389. } catch(...) {}
  390. }
  391. CarlaEngineClient::activate();
  392. const CarlaMutexLocker cml(fPreRenameMutex);
  393. if (fJackClient != nullptr)
  394. {
  395. // restore pre-rename connections
  396. const char* portNameA = nullptr;
  397. const char* portNameB = nullptr;
  398. bool doConnection = false;
  399. for (CarlaStringList::Itenerator it = fPreRenameConnections.begin2(); it.valid(); it.next())
  400. {
  401. const bool connectNow = doConnection;
  402. doConnection = !doConnection;
  403. if (connectNow)
  404. portNameB = it.getValue(nullptr);
  405. else
  406. portNameA = it.getValue(nullptr);
  407. if (! connectNow)
  408. continue;
  409. CARLA_SAFE_ASSERT_CONTINUE(portNameA != nullptr && portNameA[0] != '\0');
  410. CARLA_SAFE_ASSERT_CONTINUE(portNameB != nullptr && portNameB[0] != '\0');
  411. jackbridge_connect(fJackClient, portNameA, portNameB);
  412. }
  413. }
  414. fPreRenameConnections.clear();
  415. }
  416. void deactivate() noexcept override
  417. {
  418. carla_debug("CarlaEngineJackClient::deactivate()");
  419. if (getProcessMode() == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  420. {
  421. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr && isActive(),);
  422. try {
  423. jackbridge_deactivate(fJackClient);
  424. } catch(...) {}
  425. }
  426. CarlaEngineClient::deactivate();
  427. }
  428. bool isOk() const noexcept override
  429. {
  430. if (fUseClient)
  431. return (fJackClient != nullptr);
  432. return CarlaEngineClient::isOk();
  433. }
  434. CarlaEnginePort* addPort(const EnginePortType portType, const char* const name, const bool isInput, const uint32_t indexOffset) override
  435. {
  436. carla_debug("CarlaEngineJackClient::addPort(%i:%s, \"%s\", %s)", portType, EnginePortType2Str(portType), name, bool2str(isInput));
  437. jack_port_t* jackPort = nullptr;
  438. const char* realName = name;
  439. // Create JACK port first, if needed
  440. if (fUseClient)
  441. {
  442. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr, nullptr);
  443. realName = _getUniquePortName(name);
  444. switch (portType)
  445. {
  446. case kEnginePortTypeNull:
  447. break;
  448. case kEnginePortTypeAudio:
  449. jackPort = jackbridge_port_register(fJackClient, realName, JACK_DEFAULT_AUDIO_TYPE, isInput ? JackPortIsInput : JackPortIsOutput, 0);
  450. break;
  451. case kEnginePortTypeCV:
  452. jackPort = jackbridge_port_register(fJackClient, realName, JACK_DEFAULT_AUDIO_TYPE, isInput ? JackPortIsInput : JackPortIsOutput, 0);
  453. break;
  454. case kEnginePortTypeEvent:
  455. jackPort = jackbridge_port_register(fJackClient, realName, JACK_DEFAULT_MIDI_TYPE, isInput ? JackPortIsInput : JackPortIsOutput, 0);
  456. break;
  457. }
  458. CARLA_SAFE_ASSERT_RETURN(jackPort != nullptr, nullptr);
  459. }
  460. // Create Engine port
  461. switch (portType)
  462. {
  463. case kEnginePortTypeNull:
  464. break;
  465. case kEnginePortTypeAudio: {
  466. _addAudioPortName(isInput, realName);
  467. if (realName != name) delete[] realName;
  468. CarlaEngineJackAudioPort* const enginePort(new CarlaEngineJackAudioPort(*this, isInput, indexOffset, fJackClient, jackPort, this));
  469. fAudioPorts.append(enginePort);
  470. return enginePort;
  471. }
  472. case kEnginePortTypeCV: {
  473. _addCVPortName(isInput, realName);
  474. if (realName != name) delete[] realName;
  475. CarlaEngineJackCVPort* const enginePort(new CarlaEngineJackCVPort(*this, isInput, indexOffset, fJackClient, jackPort, this));
  476. fCVPorts.append(enginePort);
  477. return enginePort;
  478. }
  479. case kEnginePortTypeEvent: {
  480. _addEventPortName(isInput, realName);
  481. if (realName != name) delete[] realName;
  482. CarlaEngineJackEventPort* const enginePort(new CarlaEngineJackEventPort(*this, isInput, indexOffset, fJackClient, jackPort, this));
  483. fEventPorts.append(enginePort);
  484. return enginePort;
  485. }
  486. }
  487. carla_stderr("CarlaEngineJackClient::addPort(%i, \"%s\", %s) - invalid type", portType, name, bool2str(isInput));
  488. return nullptr;
  489. }
  490. void invalidate() noexcept
  491. {
  492. for (LinkedList<CarlaEngineJackAudioPort*>::Itenerator it = fAudioPorts.begin2(); it.valid(); it.next())
  493. {
  494. CarlaEngineJackAudioPort* const port(it.getValue(nullptr));
  495. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  496. port->invalidate();
  497. }
  498. for (LinkedList<CarlaEngineJackCVPort*>::Itenerator it = fCVPorts.begin2(); it.valid(); it.next())
  499. {
  500. CarlaEngineJackCVPort* const port(it.getValue(nullptr));
  501. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  502. port->invalidate();
  503. }
  504. for (LinkedList<CarlaEngineJackEventPort*>::Itenerator it = fEventPorts.begin2(); it.valid(); it.next())
  505. {
  506. CarlaEngineJackEventPort* const port(it.getValue(nullptr));
  507. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  508. port->invalidate();
  509. }
  510. fJackClient = nullptr;
  511. CarlaEngineClient::deactivate();
  512. }
  513. const char* getJackClientName() const noexcept
  514. {
  515. CARLA_SAFE_ASSERT_RETURN(fJackClient != nullptr, nullptr);
  516. try {
  517. return jackbridge_get_client_name(fJackClient);
  518. } CARLA_SAFE_EXCEPTION_RETURN("jack_get_client_name", nullptr);
  519. }
  520. void jackAudioPortDeleted(CarlaEngineJackAudioPort* const port) noexcept override
  521. {
  522. fAudioPorts.removeAll(port);
  523. }
  524. void jackCVPortDeleted(CarlaEngineJackCVPort* const port) noexcept override
  525. {
  526. fCVPorts.removeAll(port);
  527. }
  528. void jackEventPortDeleted(CarlaEngineJackEventPort* const port) noexcept override
  529. {
  530. fEventPorts.removeAll(port);
  531. }
  532. bool renameInSingleClient(const CarlaString& newClientName)
  533. {
  534. const CarlaString clientNamePrefix(newClientName + ":");
  535. return _renamePorts(fAudioPorts, clientNamePrefix) &&
  536. _renamePorts(fCVPorts, clientNamePrefix) &&
  537. _renamePorts(fEventPorts, clientNamePrefix);
  538. }
  539. void closeForRename(jack_client_t* const newClient, const CarlaString& newClientName) noexcept
  540. {
  541. if (fJackClient != nullptr)
  542. {
  543. if (isActive())
  544. {
  545. {
  546. const CarlaString clientNamePrefix(newClientName + ":");
  547. // store current client connections
  548. const CarlaMutexLocker cml(fPreRenameMutex);
  549. fPreRenameConnections.clear();
  550. _savePortsConnections(fAudioPorts, clientNamePrefix);
  551. _savePortsConnections(fCVPorts, clientNamePrefix);
  552. _savePortsConnections(fEventPorts, clientNamePrefix);
  553. }
  554. try {
  555. jackbridge_deactivate(fJackClient);
  556. } catch(...) {}
  557. }
  558. try {
  559. jackbridge_client_close(fJackClient);
  560. } catch(...) {}
  561. invalidate();
  562. }
  563. fAudioPorts.clear();
  564. fCVPorts.clear();
  565. fEventPorts.clear();
  566. _clearPorts();
  567. fJackClient = newClient;
  568. }
  569. private:
  570. jack_client_t* fJackClient;
  571. const bool fUseClient;
  572. LinkedList<CarlaEngineJackAudioPort*> fAudioPorts;
  573. LinkedList<CarlaEngineJackCVPort*> fCVPorts;
  574. LinkedList<CarlaEngineJackEventPort*> fEventPorts;
  575. CarlaMutex fPreRenameMutex;
  576. CarlaStringList fPreRenameConnections;
  577. template<typename T>
  578. bool _renamePorts(const LinkedList<T*>& t, const CarlaString& clientNamePrefix)
  579. {
  580. for (typename LinkedList<T*>::Itenerator it = t.begin2(); it.valid(); it.next())
  581. {
  582. T* const port(it.getValue(nullptr));
  583. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  584. CARLA_SAFE_ASSERT_CONTINUE(port->fJackPort != nullptr);
  585. const char* shortPortName(jackbridge_port_short_name(port->fJackPort));
  586. CARLA_SAFE_ASSERT_CONTINUE(shortPortName != nullptr && shortPortName[0] != '\0');
  587. const char* const oldClientNameSep(std::strstr(shortPortName, ":"));
  588. CARLA_SAFE_ASSERT_CONTINUE(oldClientNameSep != nullptr && oldClientNameSep[0] != '\0' && oldClientNameSep[1] != '\0');
  589. shortPortName += oldClientNameSep-shortPortName + 1;
  590. const CarlaString newPortName(clientNamePrefix + shortPortName);
  591. if (! jackbridge_port_rename(fJackClient, port->fJackPort, newPortName))
  592. return false;
  593. }
  594. return true;
  595. }
  596. template<typename T>
  597. void _savePortsConnections(const LinkedList<T*>& t, const CarlaString& clientNamePrefix)
  598. {
  599. for (typename LinkedList<T*>::Itenerator it = t.begin2(); it.valid(); it.next())
  600. {
  601. T* const port(it.getValue(nullptr));
  602. CARLA_SAFE_ASSERT_CONTINUE(port != nullptr);
  603. CARLA_SAFE_ASSERT_CONTINUE(port->fJackPort != nullptr);
  604. const char* const shortPortName(jackbridge_port_short_name(port->fJackPort));
  605. CARLA_SAFE_ASSERT_CONTINUE(shortPortName != nullptr && shortPortName[0] != '\0');
  606. const CarlaString portName(clientNamePrefix + shortPortName);
  607. if (const char** const connections = jackbridge_port_get_all_connections(fJackClient, port->fJackPort))
  608. {
  609. for (int i=0; connections[i] != nullptr; ++i)
  610. {
  611. if (port->kIsInput)
  612. {
  613. fPreRenameConnections.append(connections[i]);
  614. fPreRenameConnections.append(portName);
  615. }
  616. else
  617. {
  618. fPreRenameConnections.append(portName);
  619. fPreRenameConnections.append(connections[i]);
  620. }
  621. }
  622. jackbridge_free(connections);
  623. }
  624. }
  625. }
  626. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJackClient)
  627. };
  628. // -----------------------------------------------------------------------
  629. // Jack Engine
  630. class CarlaEngineJack : public CarlaEngine
  631. #ifndef BUILD_BRIDGE
  632. , private CarlaThread
  633. #endif
  634. {
  635. public:
  636. CarlaEngineJack()
  637. : CarlaEngine(),
  638. #ifndef BUILD_BRIDGE
  639. CarlaThread("CarlaEngineJackCallbacks"),
  640. #endif
  641. fClient(nullptr),
  642. fExternalPatchbayHost(true),
  643. fExternalPatchbayOsc(true),
  644. fFreewheel(false),
  645. #ifdef BUILD_BRIDGE
  646. fIsRunning(false)
  647. #else
  648. fTimebaseMaster(false),
  649. fTimebaseRolling(false),
  650. fTimebaseUsecs(0),
  651. fUsedGroups(),
  652. fUsedPorts(),
  653. fUsedConnections(),
  654. fNewGroups(),
  655. fPatchbayProcThreadProtectionMutex(),
  656. fRetConns(),
  657. fPostPonedEvents(),
  658. fPostPonedEventsMutex(),
  659. fIsInternalClient(false)
  660. #endif
  661. {
  662. carla_debug("CarlaEngineJack::CarlaEngineJack()");
  663. #ifdef BUILD_BRIDGE
  664. pData->options.processMode = ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS;
  665. #else
  666. carla_zeroPointers(fRackPorts, kRackPortCount);
  667. #endif
  668. }
  669. ~CarlaEngineJack() noexcept override
  670. {
  671. carla_debug("CarlaEngineJack::~CarlaEngineJack()");
  672. CARLA_SAFE_ASSERT(fClient == nullptr);
  673. #ifndef BUILD_BRIDGE
  674. fUsedGroups.clear();
  675. fUsedPorts.clear();
  676. fUsedConnections.clear();
  677. fNewGroups.clear();
  678. CARLA_SAFE_ASSERT(fPostPonedEvents.count() == 0);
  679. #endif
  680. }
  681. // -------------------------------------------------------------------
  682. // Maximum values
  683. uint getMaxClientNameSize() const noexcept override
  684. {
  685. #ifndef BUILD_BRIDGE
  686. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT || pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  687. #endif
  688. {
  689. try {
  690. return static_cast<uint>(jackbridge_client_name_size()-1);
  691. } CARLA_SAFE_EXCEPTION_RETURN("jack_client_name_size", 32);
  692. }
  693. return CarlaEngine::getMaxClientNameSize();
  694. }
  695. uint getMaxPortNameSize() const noexcept override
  696. {
  697. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT || pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  698. {
  699. try {
  700. return static_cast<uint>(jackbridge_port_name_size()-1);
  701. } CARLA_SAFE_EXCEPTION_RETURN("jack_port_name_size", 255);
  702. }
  703. return CarlaEngine::getMaxPortNameSize();
  704. }
  705. // -------------------------------------------------------------------
  706. // Virtual, per-engine type calls
  707. bool init(const char* const clientName) override
  708. {
  709. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr || (clientName != nullptr && clientName[0] != '\0'), false);
  710. CARLA_SAFE_ASSERT_RETURN(jackbridge_is_ok(), false);
  711. carla_debug("CarlaEngineJack::init(\"%s\")", clientName);
  712. fFreewheel = false;
  713. fExternalPatchbayHost = true;
  714. fExternalPatchbayOsc = true;
  715. CarlaString truncatedClientName;
  716. if (fClient == nullptr && clientName != nullptr)
  717. {
  718. truncatedClientName = clientName;
  719. truncatedClientName.truncate(getMaxClientNameSize());
  720. }
  721. #ifdef BUILD_BRIDGE
  722. fIsRunning = true;
  723. if (! pData->init(truncatedClientName))
  724. {
  725. close();
  726. setLastError("Failed to init internal data");
  727. return false;
  728. }
  729. if (pData->bufferSize == 0 || carla_isEqual(pData->sampleRate, 0.0))
  730. {
  731. // open temp client to get initial buffer-size and sample-rate values
  732. if (jack_client_t* const tmpClient = jackbridge_client_open(truncatedClientName, JackNoStartServer, nullptr))
  733. {
  734. pData->bufferSize = jackbridge_get_buffer_size(tmpClient);
  735. pData->sampleRate = jackbridge_get_sample_rate(tmpClient);
  736. jackbridge_client_close(tmpClient);
  737. }
  738. else
  739. {
  740. close();
  741. setLastError("Failed to init temporary jack client");
  742. return false;
  743. }
  744. }
  745. return true;
  746. #else
  747. if (fClient == nullptr && clientName != nullptr)
  748. fClient = jackbridge_client_open(truncatedClientName, JackNullOption, nullptr);
  749. if (fClient == nullptr)
  750. {
  751. setLastError("Failed to create new JACK client");
  752. return false;
  753. }
  754. const char* const jackClientName = jackbridge_get_client_name(fClient);
  755. if (! pData->init(jackClientName))
  756. {
  757. jackbridge_client_close(fClient);
  758. fClient = nullptr;
  759. setLastError("Failed to init internal data");
  760. return false;
  761. }
  762. const EngineOptions& opts(pData->options);
  763. pData->bufferSize = jackbridge_get_buffer_size(fClient);
  764. pData->sampleRate = jackbridge_get_sample_rate(fClient);
  765. pData->initTime(opts.transportExtra);
  766. jackbridge_set_thread_init_callback(fClient, carla_jack_thread_init_callback, nullptr);
  767. jackbridge_set_buffer_size_callback(fClient, carla_jack_bufsize_callback, this);
  768. jackbridge_set_sample_rate_callback(fClient, carla_jack_srate_callback, this);
  769. jackbridge_set_freewheel_callback(fClient, carla_jack_freewheel_callback, this);
  770. jackbridge_set_latency_callback(fClient, carla_jack_latency_callback, this);
  771. jackbridge_set_process_callback(fClient, carla_jack_process_callback, this);
  772. jackbridge_on_shutdown(fClient, carla_jack_shutdown_callback, this);
  773. fTimebaseRolling = false;
  774. if (opts.transportMode == ENGINE_TRANSPORT_MODE_JACK)
  775. fTimebaseMaster = jackbridge_set_timebase_callback(fClient, true, carla_jack_timebase_callback, this);
  776. else
  777. fTimebaseMaster = false;
  778. if (opts.processMode != ENGINE_PROCESS_MODE_PATCHBAY)
  779. initJackPatchbay(true, false, jackClientName);
  780. jackbridge_set_client_registration_callback(fClient, carla_jack_client_registration_callback, this);
  781. jackbridge_set_port_registration_callback(fClient, carla_jack_port_registration_callback, this);
  782. jackbridge_set_port_connect_callback(fClient, carla_jack_port_connect_callback, this);
  783. jackbridge_set_port_rename_callback(fClient, carla_jack_port_rename_callback, this);
  784. jackbridge_set_xrun_callback(fClient, carla_jack_xrun_callback, this);
  785. if (opts.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK || opts.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  786. {
  787. fRackPorts[kRackPortAudioIn1] = jackbridge_port_register(fClient, "audio-in1", JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
  788. fRackPorts[kRackPortAudioIn2] = jackbridge_port_register(fClient, "audio-in2", JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0);
  789. fRackPorts[kRackPortAudioOut1] = jackbridge_port_register(fClient, "audio-out1", JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
  790. fRackPorts[kRackPortAudioOut2] = jackbridge_port_register(fClient, "audio-out2", JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0);
  791. fRackPorts[kRackPortEventIn] = jackbridge_port_register(fClient, "events-in", JACK_DEFAULT_MIDI_TYPE, JackPortIsInput, 0);
  792. fRackPorts[kRackPortEventOut] = jackbridge_port_register(fClient, "events-out", JACK_DEFAULT_MIDI_TYPE, JackPortIsOutput, 0);
  793. if (opts.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  794. {
  795. // FIXME?
  796. pData->graph.create(0, 0);
  797. }
  798. else
  799. {
  800. pData->graph.create(2, 2);
  801. // pData->graph.setUsingExternalHost(true);
  802. // pData->graph.setUsingExternalOSC(true);
  803. patchbayRefresh(true, false, false);
  804. }
  805. }
  806. if (jackbridge_activate(fClient))
  807. {
  808. if (opts.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  809. opts.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  810. {
  811. if (pData->options.audioDevice != nullptr &&
  812. std::strcmp(pData->options.audioDevice, "Auto-Connect ON") == 0 &&
  813. std::getenv("LADISH_APP_NAME") == nullptr &&
  814. std::getenv("NSM_URL") == nullptr)
  815. {
  816. char strBuf[STR_MAX];
  817. strBuf[STR_MAX-1] = '\0';
  818. if (jackbridge_port_by_name(fClient, "system:capture_1") != nullptr)
  819. {
  820. std::snprintf(strBuf, STR_MAX-2, "%s:audio-in1", jackClientName);
  821. jackbridge_connect(fClient, "system:capture_1", strBuf);
  822. std::snprintf(strBuf, STR_MAX-2, "%s:audio-in2", jackClientName);
  823. if (jackbridge_port_by_name(fClient, "system:capture_2") != nullptr)
  824. jackbridge_connect(fClient, "system:capture_2", strBuf);
  825. else
  826. jackbridge_connect(fClient, "system:capture_1", strBuf);
  827. }
  828. if (jackbridge_port_by_name(fClient, "system:playback_1") != nullptr)
  829. {
  830. std::snprintf(strBuf, STR_MAX-2, "%s:audio-out1", jackClientName);
  831. jackbridge_connect(fClient, strBuf, "system:playback_1");
  832. std::snprintf(strBuf, STR_MAX-2, "%s:audio-out2", jackClientName);
  833. if (jackbridge_port_by_name(fClient, "system:playback_2") != nullptr)
  834. jackbridge_connect(fClient, strBuf, "system:playback_2");
  835. else
  836. jackbridge_connect(fClient, strBuf, "system:playback_1");
  837. }
  838. }
  839. }
  840. startThread();
  841. callback(true, true,
  842. ENGINE_CALLBACK_ENGINE_STARTED, 0,
  843. opts.processMode,
  844. opts.transportMode,
  845. static_cast<int>(pData->bufferSize),
  846. static_cast<float>(pData->sampleRate),
  847. getCurrentDriverName());
  848. return true;
  849. }
  850. if (opts.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  851. opts.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  852. {
  853. pData->graph.destroy();
  854. }
  855. pData->close();
  856. jackbridge_client_close(fClient);
  857. fClient = nullptr;
  858. setLastError("Failed to activate the JACK client");
  859. return false;
  860. #endif
  861. }
  862. #ifndef BUILD_BRIDGE
  863. bool initInternal(jack_client_t* const client)
  864. {
  865. fClient = client;
  866. fIsInternalClient = true;
  867. return init(nullptr);
  868. }
  869. #endif
  870. bool close() override
  871. {
  872. carla_debug("CarlaEngineJack::close()");
  873. #ifdef BUILD_BRIDGE
  874. fClient = nullptr;
  875. fIsRunning = false;
  876. CarlaEngine::close();
  877. return true;
  878. #else
  879. stopThread(-1);
  880. fPostPonedEvents.clear();
  881. CARLA_SAFE_ASSERT_RETURN_ERR(fClient != nullptr, "JACK Client is null");
  882. // deactivate and close client
  883. jackbridge_deactivate(fClient);
  884. jackbridge_client_close(fClient);
  885. // clear engine data
  886. CarlaEngine::close();
  887. fUsedGroups.clear();
  888. fUsedPorts.clear();
  889. fUsedConnections.clear();
  890. fNewGroups.clear();
  891. fPostPonedEvents.clear();
  892. // clear rack/patchbay stuff
  893. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  894. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  895. {
  896. carla_zeroPointers(fRackPorts, kRackPortCount);
  897. pData->graph.destroy();
  898. }
  899. fClient = nullptr;
  900. return true;
  901. #endif
  902. }
  903. bool isRunning() const noexcept override
  904. {
  905. #ifdef BUILD_BRIDGE
  906. return (fClient != nullptr || fIsRunning);
  907. #else
  908. return (fClient != nullptr);
  909. #endif
  910. }
  911. bool isOffline() const noexcept override
  912. {
  913. return fFreewheel;
  914. }
  915. EngineType getType() const noexcept override
  916. {
  917. return kEngineTypeJack;
  918. }
  919. const char* getCurrentDriverName() const noexcept override
  920. {
  921. return "JACK";
  922. }
  923. #ifndef BUILD_BRIDGE
  924. float getDSPLoad() const noexcept override
  925. {
  926. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, 0.0f);
  927. return jackbridge_cpu_load(fClient);
  928. }
  929. #endif
  930. EngineTimeInfo getTimeInfo() const noexcept override
  931. {
  932. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  933. return CarlaEngine::getTimeInfo();
  934. if (pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  935. return CarlaEngine::getTimeInfo();
  936. jack_position_t jpos;
  937. // invalidate
  938. jpos.unique_1 = 1;
  939. jpos.unique_2 = 2;
  940. EngineTimeInfo timeInfo;
  941. const bool playing = jackbridge_transport_query(fClient, &jpos) == JackTransportRolling;
  942. if (jpos.unique_1 != jpos.unique_2)
  943. {
  944. timeInfo.playing = false;
  945. timeInfo.frame = 0;
  946. timeInfo.usecs = 0;
  947. timeInfo.bbt.valid = false;
  948. return timeInfo;
  949. }
  950. timeInfo.playing = playing;
  951. timeInfo.frame = jpos.frame;
  952. timeInfo.usecs = jpos.usecs;
  953. if (jpos.valid & JackPositionBBT)
  954. {
  955. timeInfo.bbt.valid = true;
  956. timeInfo.bbt.bar = jpos.bar;
  957. timeInfo.bbt.beat = jpos.beat;
  958. timeInfo.bbt.tick = jpos.tick;
  959. timeInfo.bbt.barStartTick = jpos.bar_start_tick;
  960. timeInfo.bbt.beatsPerBar = jpos.beats_per_bar;
  961. timeInfo.bbt.beatType = jpos.beat_type;
  962. timeInfo.bbt.ticksPerBeat = jpos.ticks_per_beat;
  963. timeInfo.bbt.beatsPerMinute = jpos.beats_per_minute;
  964. }
  965. else
  966. {
  967. timeInfo.bbt.valid = false;
  968. }
  969. return timeInfo;
  970. }
  971. #ifndef BUILD_BRIDGE
  972. void setOption(const EngineOption option, const int value, const char* const valueStr) noexcept override
  973. {
  974. if (option == ENGINE_OPTION_TRANSPORT_MODE && fClient != nullptr)
  975. {
  976. CARLA_SAFE_ASSERT_RETURN(value >= ENGINE_TRANSPORT_MODE_DISABLED && value <= ENGINE_TRANSPORT_MODE_JACK,);
  977. if (value == ENGINE_TRANSPORT_MODE_JACK)
  978. {
  979. fTimebaseMaster = jackbridge_set_timebase_callback(fClient, true, carla_jack_timebase_callback, this);
  980. }
  981. else
  982. {
  983. // jack transport cannot be disabled in multi-client
  984. callback(true, true,
  985. ENGINE_CALLBACK_TRANSPORT_MODE_CHANGED, 0,
  986. ENGINE_TRANSPORT_MODE_JACK,
  987. 0, 0, 0.0f,
  988. pData->options.transportExtra);
  989. CARLA_SAFE_ASSERT_RETURN(pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS,);
  990. jackbridge_release_timebase(fClient);
  991. fTimebaseMaster = false;
  992. }
  993. }
  994. CarlaEngine::setOption(option, value, valueStr);
  995. }
  996. #endif
  997. CarlaEngineClient* addClient(CarlaPlugin* const plugin) override
  998. {
  999. jack_client_t* client = nullptr;
  1000. #ifndef BUILD_BRIDGE
  1001. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  1002. {
  1003. client = fClient;
  1004. }
  1005. else if (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1006. #endif
  1007. {
  1008. client = jackbridge_client_open(plugin->getName(), JackNullOption, nullptr);
  1009. CARLA_SAFE_ASSERT_RETURN(client != nullptr, nullptr);
  1010. jackbridge_set_thread_init_callback(client, carla_jack_thread_init_callback, nullptr);
  1011. #ifndef BUILD_BRIDGE
  1012. /*
  1013. jackbridge_set_buffer_size_callback(fClient, carla_jack_bufsize_callback_plugin, plugin);
  1014. jackbridge_set_sample_rate_callback(fClient, carla_jack_srate_callback_plugin, plugin);
  1015. */
  1016. jackbridge_set_latency_callback(client, carla_jack_latency_callback_plugin, plugin);
  1017. jackbridge_set_process_callback(client, carla_jack_process_callback_plugin, plugin);
  1018. jackbridge_on_shutdown(client, carla_jack_shutdown_callback_plugin, plugin);
  1019. #else
  1020. fClient = client;
  1021. pData->bufferSize = jackbridge_get_buffer_size(client);
  1022. pData->sampleRate = jackbridge_get_sample_rate(client);
  1023. pData->initTime(nullptr);
  1024. jackbridge_set_buffer_size_callback(client, carla_jack_bufsize_callback, this);
  1025. jackbridge_set_sample_rate_callback(client, carla_jack_srate_callback, this);
  1026. jackbridge_set_freewheel_callback(client, carla_jack_freewheel_callback, this);
  1027. jackbridge_set_latency_callback(client, carla_jack_latency_callback, this);
  1028. jackbridge_set_process_callback(client, carla_jack_process_callback, this);
  1029. jackbridge_on_shutdown(client, carla_jack_shutdown_callback, this);
  1030. #endif
  1031. }
  1032. return new CarlaEngineJackClient(*this, client);
  1033. }
  1034. #ifndef BUILD_BRIDGE
  1035. const char* renamePlugin(const uint id, const char* const newName) override
  1036. {
  1037. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1038. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1039. {
  1040. return CarlaEngine::renamePlugin(id, newName);
  1041. }
  1042. CARLA_SAFE_ASSERT_RETURN(pData->plugins != nullptr, nullptr);
  1043. CARLA_SAFE_ASSERT_RETURN(pData->curPluginCount != 0, nullptr);
  1044. CARLA_SAFE_ASSERT_RETURN(id < pData->curPluginCount, nullptr);
  1045. CARLA_SAFE_ASSERT_RETURN(newName != nullptr && newName[0] != '\0', nullptr);
  1046. CarlaPlugin* const plugin(pData->plugins[id].plugin);
  1047. CARLA_SAFE_ASSERT_RETURN_ERRN(plugin != nullptr, "Could not find plugin to rename");
  1048. CARLA_SAFE_ASSERT_RETURN_ERRN(plugin->getId() == id, "Invalid engine internal data");
  1049. // before we stop the engine thread we might need to get the plugin data
  1050. const bool needsReinit = (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS);
  1051. const CarlaStateSave* saveStatePtr = nullptr;
  1052. if (needsReinit)
  1053. {
  1054. const CarlaStateSave& saveState(plugin->getStateSave());
  1055. saveStatePtr = &saveState;
  1056. }
  1057. CarlaString uniqueName;
  1058. try {
  1059. const char* const tmpName = getUniquePluginName(newName);
  1060. uniqueName = tmpName;
  1061. delete[] tmpName;
  1062. } CARLA_SAFE_EXCEPTION("JACK renamePlugin getUniquePluginName");
  1063. if (uniqueName.isEmpty())
  1064. {
  1065. setLastError("Failed to request new unique plugin name");
  1066. return nullptr;
  1067. }
  1068. const ScopedThreadStopper sts(this);
  1069. // rename on client client mode, just rename the ports
  1070. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  1071. {
  1072. CarlaEngineJackClient* const client((CarlaEngineJackClient*)plugin->getEngineClient());
  1073. if (! client->renameInSingleClient(uniqueName))
  1074. {
  1075. setLastError("Failed to rename some JACK ports, does your JACK version support proper port renaming?");
  1076. return nullptr;
  1077. }
  1078. }
  1079. // rename in multiple client mode
  1080. else if (pData->options.processMode == ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1081. {
  1082. CarlaEngineJackClient* const client((CarlaEngineJackClient*)plugin->getEngineClient());
  1083. // we should not be able to do this, jack really needs to allow client rename
  1084. if (jack_client_t* const jackClient = jackbridge_client_open(uniqueName, JackNullOption, nullptr))
  1085. {
  1086. // get new client name
  1087. uniqueName = jackbridge_get_client_name(jackClient);
  1088. // close client
  1089. client->closeForRename(jackClient, uniqueName);
  1090. // disable plugin
  1091. plugin->setEnabled(false);
  1092. // set new client data
  1093. jackbridge_set_latency_callback(jackClient, carla_jack_latency_callback_plugin, plugin);
  1094. jackbridge_set_process_callback(jackClient, carla_jack_process_callback_plugin, plugin);
  1095. jackbridge_on_shutdown(jackClient, carla_jack_shutdown_callback_plugin, plugin);
  1096. // NOTE: jack1 locks up here
  1097. if (jackbridge_get_version_string() != nullptr)
  1098. jackbridge_set_thread_init_callback(jackClient, carla_jack_thread_init_callback, nullptr);
  1099. /* The following code is because of a tricky situation.
  1100. We cannot lock or do jack operations during jack callbacks on jack1. jack2 events are asynchronous.
  1101. When we close the client jack will trigger unregister-port callbacks, which we handle on a separate thread ASAP.
  1102. But before that happens we already registered a new client with the same ports (the "renamed" one),
  1103. and at this point the port we receive during that callback is actually the new one from the new client..
  1104. JACK2 seems to be reusing ports to save space, which is understandable.
  1105. Anyway, this means we have to remove all our port-related data before the new client ports are created.
  1106. (we also stop the separate jack-events thread to avoid any race conditions while modying our port data) */
  1107. stopThread(-1);
  1108. const uint groupId(fUsedGroups.getGroupId(plugin->getName()));
  1109. if (groupId > 0)
  1110. {
  1111. for (LinkedList<PortNameToId>::Itenerator it = fUsedPorts.list.begin2(); it.valid(); it.next())
  1112. {
  1113. for (LinkedList<ConnectionToId>::Itenerator it2 = fUsedConnections.list.begin2(); it2.valid(); it2.next())
  1114. {
  1115. static ConnectionToId connectionFallback = { 0, 0, 0, 0, 0 };
  1116. ConnectionToId& connectionToId = it2.getValue(connectionFallback);
  1117. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  1118. if (connectionToId.groupA != groupId && connectionToId.groupB != groupId)
  1119. continue;
  1120. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1121. ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED,
  1122. connectionToId.id,
  1123. 0, 0, 0, 0.0f, nullptr);
  1124. fUsedConnections.list.remove(it2);
  1125. }
  1126. static PortNameToId portNameFallback = { 0, 0, { '\0' }, { '\0' } };
  1127. PortNameToId& portNameToId(it.getValue(portNameFallback));
  1128. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group != 0);
  1129. if (portNameToId.group != groupId)
  1130. continue;
  1131. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1132. ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED,
  1133. portNameToId.group,
  1134. static_cast<int>(portNameToId.port),
  1135. 0, 0, 0.0f, nullptr);
  1136. fUsedPorts.list.remove(it);
  1137. }
  1138. }
  1139. startThread();
  1140. }
  1141. else
  1142. {
  1143. setLastError("Failed to create new JACK client");
  1144. return nullptr;
  1145. }
  1146. }
  1147. // Rename
  1148. plugin->setName(uniqueName);
  1149. if (needsReinit)
  1150. {
  1151. // reload plugin to recreate its ports
  1152. plugin->reload();
  1153. plugin->loadStateSave(*saveStatePtr);
  1154. plugin->setEnabled(true);
  1155. }
  1156. return plugin->getName();
  1157. }
  1158. // -------------------------------------------------------------------
  1159. // Patchbay
  1160. bool patchbayConnect(const bool external,
  1161. const uint groupA, const uint portA, const uint groupB, const uint portB) override
  1162. {
  1163. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  1164. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  1165. return CarlaEngine::patchbayConnect(false, groupA, portA, groupB, portB);
  1166. const char* const fullPortNameA = fUsedPorts.getFullPortName(groupA, portA);
  1167. CARLA_SAFE_ASSERT_RETURN(fullPortNameA != nullptr && fullPortNameA[0] != '\0', false);
  1168. const char* const fullPortNameB = fUsedPorts.getFullPortName(groupB, portB);
  1169. CARLA_SAFE_ASSERT_RETURN(fullPortNameB != nullptr && fullPortNameB[0] != '\0', false);
  1170. if (! jackbridge_connect(fClient, fullPortNameA, fullPortNameB))
  1171. {
  1172. setLastError("JACK operation failed");
  1173. return false;
  1174. }
  1175. return true;
  1176. }
  1177. bool patchbayDisconnect(const bool external, const uint connectionId) override
  1178. {
  1179. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  1180. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  1181. return CarlaEngine::patchbayDisconnect(false, connectionId);
  1182. ConnectionToId connectionToId = { 0, 0, 0, 0, 0 };
  1183. {
  1184. const CarlaMutexLocker cml(fUsedConnections.mutex);
  1185. for (LinkedList<ConnectionToId>::Itenerator it = fUsedConnections.list.begin2(); it.valid(); it.next())
  1186. {
  1187. connectionToId = it.getValue(connectionToId);
  1188. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  1189. if (connectionToId.id == connectionId)
  1190. break;
  1191. }
  1192. }
  1193. if (connectionToId.id == 0 || connectionToId.id != connectionId)
  1194. {
  1195. setLastError("Failed to find the requested connection");
  1196. return false;
  1197. }
  1198. const char* const fullPortNameA = fUsedPorts.getFullPortName(connectionToId.groupA, connectionToId.portA);
  1199. CARLA_SAFE_ASSERT_RETURN(fullPortNameA != nullptr && fullPortNameA[0] != '\0', false);
  1200. const char* const fullPortNameB = fUsedPorts.getFullPortName(connectionToId.groupB, connectionToId.portB);
  1201. CARLA_SAFE_ASSERT_RETURN(fullPortNameB != nullptr && fullPortNameB[0] != '\0', false);
  1202. if (! jackbridge_disconnect(fClient, fullPortNameA, fullPortNameB))
  1203. {
  1204. setLastError("JACK operation failed");
  1205. return false;
  1206. }
  1207. return true;
  1208. }
  1209. bool patchbayRefresh(const bool sendHost, const bool sendOSC, const bool external) override
  1210. {
  1211. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, false);
  1212. carla_debug("patchbayRefresh(%s, %s, %s)", bool2str(sendHost), bool2str(sendOSC), bool2str(external));
  1213. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1214. {
  1215. if (sendHost)
  1216. {
  1217. fExternalPatchbayHost = external;
  1218. pData->graph.setUsingExternalHost(external);
  1219. }
  1220. if (sendOSC)
  1221. {
  1222. fExternalPatchbayOsc = external;
  1223. pData->graph.setUsingExternalOSC(external);
  1224. }
  1225. if (! external)
  1226. return CarlaEngine::patchbayRefresh(sendHost, sendOSC, false);
  1227. }
  1228. fUsedGroups.clear();
  1229. fUsedPorts.clear();
  1230. fUsedConnections.clear();
  1231. fNewGroups.clear();
  1232. initJackPatchbay(sendHost, sendOSC, jackbridge_get_client_name(fClient));
  1233. return true;
  1234. }
  1235. // -------------------------------------------------------------------
  1236. // Transport
  1237. void transportPlay() noexcept override
  1238. {
  1239. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  1240. return CarlaEngine::transportPlay();
  1241. if (fClient != nullptr)
  1242. {
  1243. if (! pData->timeInfo.bbt.valid)
  1244. {
  1245. // old timebase master no longer active, make ourselves master again
  1246. pData->time.setNeedsReset();
  1247. fTimebaseMaster = jackbridge_set_timebase_callback(fClient, true, carla_jack_timebase_callback, this);
  1248. }
  1249. try {
  1250. jackbridge_transport_start(fClient);
  1251. } catch(...) {}
  1252. }
  1253. }
  1254. void transportPause() noexcept override
  1255. {
  1256. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  1257. return CarlaEngine::transportPause();
  1258. if (fClient != nullptr)
  1259. {
  1260. try {
  1261. jackbridge_transport_stop(fClient);
  1262. } catch(...) {}
  1263. }
  1264. }
  1265. void transportBPM(const double bpm) noexcept override
  1266. {
  1267. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK || fTimebaseMaster)
  1268. return CarlaEngine::transportBPM(bpm);
  1269. if (fClient == nullptr)
  1270. return;
  1271. jack_position_t jpos;
  1272. // invalidate
  1273. jpos.unique_1 = 1;
  1274. jpos.unique_2 = 2;
  1275. jackbridge_transport_query(fClient, &jpos);
  1276. if (jpos.unique_1 == jpos.unique_2 && (jpos.valid & JackPositionBBT) != 0)
  1277. {
  1278. carla_stdout("NOTE: Changing BPM without being JACK timebase master");
  1279. jpos.beats_per_minute = bpm;
  1280. try {
  1281. jackbridge_transport_reposition(fClient, &jpos);
  1282. } catch(...) {}
  1283. }
  1284. }
  1285. void transportRelocate(const uint64_t frame) noexcept override
  1286. {
  1287. if (pData->options.transportMode != ENGINE_TRANSPORT_MODE_JACK)
  1288. return CarlaEngine::transportRelocate(frame);
  1289. if (fClient != nullptr)
  1290. {
  1291. try {
  1292. jackbridge_transport_locate(fClient, static_cast<jack_nframes_t>(frame));
  1293. } catch(...) {}
  1294. }
  1295. }
  1296. // -------------------------------------------------------------------
  1297. // Patchbay stuff
  1298. const char* const* getPatchbayConnections(const bool external) const override
  1299. {
  1300. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr, nullptr);
  1301. carla_debug("CarlaEngineJack::getPatchbayConnections(%s)", bool2str(external));
  1302. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  1303. return CarlaEngine::getPatchbayConnections(external);
  1304. CarlaStringList connList;
  1305. if (const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, JackPortIsOutput))
  1306. {
  1307. for (int i=0; ports[i] != nullptr; ++i)
  1308. {
  1309. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, ports[i]));
  1310. const char* const fullPortName(ports[i]);
  1311. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  1312. if (const char** const connections = jackbridge_port_get_all_connections(fClient, jackPort))
  1313. {
  1314. for (int j=0; connections[j] != nullptr; ++j)
  1315. {
  1316. connList.append(fullPortName);
  1317. connList.append(connections[j]);
  1318. }
  1319. jackbridge_free(connections);
  1320. }
  1321. }
  1322. jackbridge_free(ports);
  1323. }
  1324. if (connList.count() == 0)
  1325. return nullptr;
  1326. fRetConns = connList.toCharStringListPtr();
  1327. return fRetConns;
  1328. }
  1329. void restorePatchbayConnection(const bool external, const char* const connSource, const char* const connTarget) override
  1330. {
  1331. CARLA_SAFE_ASSERT_RETURN(fClient != nullptr,);
  1332. CARLA_SAFE_ASSERT_RETURN(connSource != nullptr && connSource[0] != '\0',);
  1333. CARLA_SAFE_ASSERT_RETURN(connTarget != nullptr && connTarget[0] != '\0',);
  1334. carla_debug("CarlaEngineJack::restorePatchbayConnection(%s, \"%s\", \"%s\")",
  1335. bool2str(external), connSource, connTarget);
  1336. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY && ! external)
  1337. return CarlaEngine::restorePatchbayConnection(external, connSource, connTarget);
  1338. if (const jack_port_t* const port = jackbridge_port_by_name(fClient, connSource))
  1339. {
  1340. if (jackbridge_port_by_name(fClient, connTarget) == nullptr)
  1341. return;
  1342. if (! jackbridge_port_connected_to(port, connTarget))
  1343. jackbridge_connect(fClient, connSource, connTarget);
  1344. }
  1345. }
  1346. #endif
  1347. // -------------------------------------------------------------------
  1348. protected:
  1349. void handleJackBufferSizeCallback(const uint32_t newBufferSize)
  1350. {
  1351. if (pData->bufferSize == newBufferSize)
  1352. return;
  1353. #ifndef BUILD_BRIDGE
  1354. const CarlaMutexLocker cml(fPatchbayProcThreadProtectionMutex);
  1355. #endif
  1356. pData->bufferSize = newBufferSize;
  1357. bufferSizeChanged(newBufferSize);
  1358. }
  1359. void handleJackSampleRateCallback(const double newSampleRate)
  1360. {
  1361. if (carla_isEqual(pData->sampleRate, newSampleRate))
  1362. return;
  1363. #ifndef BUILD_BRIDGE
  1364. const CarlaMutexLocker cml(fPatchbayProcThreadProtectionMutex);
  1365. #endif
  1366. pData->sampleRate = newSampleRate;
  1367. sampleRateChanged(newSampleRate);
  1368. }
  1369. void handleJackFreewheelCallback(const bool isFreewheel)
  1370. {
  1371. if (fFreewheel == isFreewheel)
  1372. return;
  1373. #ifndef BUILD_BRIDGE
  1374. const CarlaMutexLocker cml(fPatchbayProcThreadProtectionMutex);
  1375. #endif
  1376. fFreewheel = isFreewheel;
  1377. offlineModeChanged(isFreewheel);
  1378. }
  1379. void handleJackProcessCallback(const uint32_t nframes)
  1380. {
  1381. const PendingRtEventsRunner prt(this, nframes);
  1382. CARLA_SAFE_ASSERT_INT2_RETURN(nframes == pData->bufferSize, nframes, pData->bufferSize,);
  1383. #ifdef BUILD_BRIDGE
  1384. CarlaPlugin* const plugin(pData->plugins[0].plugin);
  1385. if (plugin != nullptr && plugin->isEnabled() && plugin->tryLock(fFreewheel))
  1386. {
  1387. plugin->initBuffers();
  1388. processPlugin(plugin, nframes);
  1389. plugin->unlock();
  1390. }
  1391. #else
  1392. if (pData->options.transportMode == ENGINE_TRANSPORT_MODE_JACK && !fTimebaseMaster)
  1393. {
  1394. jack_position_t jpos;
  1395. // invalidate
  1396. jpos.unique_1 = 1;
  1397. jpos.unique_2 = 2;
  1398. EngineTimeInfo timeInfo;
  1399. const bool playing = jackbridge_transport_query(fClient, &jpos) == JackTransportRolling;
  1400. if (jpos.unique_1 != jpos.unique_2)
  1401. {
  1402. timeInfo.playing = false;
  1403. timeInfo.frame = 0;
  1404. timeInfo.usecs = 0;
  1405. timeInfo.bbt.valid = false;
  1406. }
  1407. else
  1408. {
  1409. timeInfo.playing = playing;
  1410. timeInfo.frame = jpos.frame;
  1411. timeInfo.usecs = jpos.usecs;
  1412. if (jpos.valid & JackPositionBBT)
  1413. {
  1414. timeInfo.bbt.valid = true;
  1415. timeInfo.bbt.bar = jpos.bar;
  1416. timeInfo.bbt.beat = jpos.beat;
  1417. timeInfo.bbt.tick = jpos.tick;
  1418. timeInfo.bbt.barStartTick = jpos.bar_start_tick;
  1419. timeInfo.bbt.beatsPerBar = jpos.beats_per_bar;
  1420. timeInfo.bbt.beatType = jpos.beat_type;
  1421. timeInfo.bbt.ticksPerBeat = jpos.ticks_per_beat;
  1422. timeInfo.bbt.beatsPerMinute = jpos.beats_per_minute;
  1423. }
  1424. else
  1425. {
  1426. timeInfo.bbt.valid = false;
  1427. }
  1428. }
  1429. pData->timeInfo = timeInfo;
  1430. }
  1431. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  1432. {
  1433. if (pData->aboutToClose)
  1434. {
  1435. if (float* const audioOut1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut1], nframes))
  1436. carla_zeroFloats(audioOut1, nframes);
  1437. if (float* const audioOut2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut2], nframes))
  1438. carla_zeroFloats(audioOut2, nframes);
  1439. }
  1440. else if (pData->curPluginCount == 0)
  1441. {
  1442. float* const audioIn1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn1], nframes);
  1443. float* const audioIn2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn2], nframes);
  1444. float* const audioOut1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut1], nframes);
  1445. float* const audioOut2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut2], nframes);
  1446. // assert buffers
  1447. CARLA_SAFE_ASSERT_RETURN(audioIn1 != nullptr,);
  1448. CARLA_SAFE_ASSERT_RETURN(audioIn2 != nullptr,);
  1449. CARLA_SAFE_ASSERT_RETURN(audioOut1 != nullptr,);
  1450. CARLA_SAFE_ASSERT_RETURN(audioOut2 != nullptr,);
  1451. // pass-through
  1452. carla_copyFloats(audioOut1, audioIn1, nframes);
  1453. carla_copyFloats(audioOut2, audioIn2, nframes);
  1454. // TODO pass-through MIDI as well
  1455. if (void* const eventOut = jackbridge_port_get_buffer(fRackPorts[kRackPortEventOut], nframes))
  1456. jackbridge_midi_clear_buffer(eventOut);
  1457. return;
  1458. }
  1459. }
  1460. if (pData->options.processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  1461. {
  1462. for (uint i=0; i < pData->curPluginCount; ++i)
  1463. {
  1464. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1465. if (plugin != nullptr && plugin->isEnabled() && plugin->tryLock(fFreewheel))
  1466. {
  1467. plugin->initBuffers();
  1468. processPlugin(plugin, nframes);
  1469. plugin->unlock();
  1470. }
  1471. }
  1472. }
  1473. else if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1474. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1475. {
  1476. CARLA_SAFE_ASSERT_RETURN(pData->events.in != nullptr,);
  1477. CARLA_SAFE_ASSERT_RETURN(pData->events.out != nullptr,);
  1478. // get buffers from jack
  1479. float* const audioIn1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn1], nframes);
  1480. float* const audioIn2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioIn2], nframes);
  1481. float* const audioOut1 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut1], nframes);
  1482. float* const audioOut2 = (float*)jackbridge_port_get_buffer(fRackPorts[kRackPortAudioOut2], nframes);
  1483. void* const eventIn = jackbridge_port_get_buffer(fRackPorts[kRackPortEventIn], nframes);
  1484. void* const eventOut = jackbridge_port_get_buffer(fRackPorts[kRackPortEventOut], nframes);
  1485. // assert buffers
  1486. CARLA_SAFE_ASSERT_RETURN(audioIn1 != nullptr,);
  1487. CARLA_SAFE_ASSERT_RETURN(audioIn2 != nullptr,);
  1488. CARLA_SAFE_ASSERT_RETURN(audioOut1 != nullptr,);
  1489. CARLA_SAFE_ASSERT_RETURN(audioOut2 != nullptr,);
  1490. // create audio buffers
  1491. const float* inBuf[2] = { audioIn1, audioIn2 };
  1492. /**/ float* outBuf[2] = { audioOut1, audioOut2 };
  1493. // initialize events
  1494. carla_zeroStructs(pData->events.in, kMaxEngineEventInternalCount);
  1495. carla_zeroStructs(pData->events.out, kMaxEngineEventInternalCount);
  1496. if (eventIn != nullptr)
  1497. {
  1498. ushort engineEventIndex = 0;
  1499. jack_midi_event_t jackEvent;
  1500. const uint32_t jackEventCount(jackbridge_midi_get_event_count(eventIn));
  1501. for (uint32_t jackEventIndex=0; jackEventIndex < jackEventCount; ++jackEventIndex)
  1502. {
  1503. if (! jackbridge_midi_event_get(&jackEvent, eventIn, jackEventIndex))
  1504. continue;
  1505. CARLA_SAFE_ASSERT_CONTINUE(jackEvent.size < 0xFF /* uint8_t max */);
  1506. EngineEvent& engineEvent(pData->events.in[engineEventIndex++]);
  1507. engineEvent.time = jackEvent.time;
  1508. engineEvent.fillFromMidiData(static_cast<uint8_t>(jackEvent.size), jackEvent.buffer, 0);
  1509. if (engineEventIndex >= kMaxEngineEventInternalCount)
  1510. break;
  1511. }
  1512. }
  1513. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  1514. {
  1515. pData->graph.processRack(pData, inBuf, outBuf, nframes);
  1516. }
  1517. else
  1518. {
  1519. const CarlaMutexLocker cml(fPatchbayProcThreadProtectionMutex);
  1520. pData->graph.process(pData, inBuf, outBuf, nframes);
  1521. }
  1522. // output control
  1523. if (eventOut != nullptr)
  1524. {
  1525. jackbridge_midi_clear_buffer(eventOut);
  1526. uint8_t size = 0;
  1527. uint8_t mdata[3] = { 0, 0, 0 };
  1528. uint8_t mdataTmp[EngineMidiEvent::kDataSize];
  1529. const uint8_t* mdataPtr;
  1530. for (ushort i=0; i < kMaxEngineEventInternalCount; ++i)
  1531. {
  1532. const EngineEvent& engineEvent(pData->events.out[i]);
  1533. /**/ if (engineEvent.type == kEngineEventTypeNull)
  1534. {
  1535. break;
  1536. }
  1537. else if (engineEvent.type == kEngineEventTypeControl)
  1538. {
  1539. const EngineControlEvent& ctrlEvent(engineEvent.ctrl);
  1540. size = ctrlEvent.convertToMidiData(engineEvent.channel, mdata);
  1541. mdataPtr = mdata;
  1542. }
  1543. else if (engineEvent.type == kEngineEventTypeMidi)
  1544. {
  1545. const EngineMidiEvent& midiEvent(engineEvent.midi);
  1546. size = midiEvent.size;
  1547. CARLA_SAFE_ASSERT_CONTINUE(size > 0);
  1548. if (size > EngineMidiEvent::kDataSize)
  1549. {
  1550. CARLA_SAFE_ASSERT_CONTINUE(midiEvent.dataExt != nullptr);
  1551. mdataPtr = midiEvent.dataExt;
  1552. }
  1553. else
  1554. {
  1555. // set first byte
  1556. mdataTmp[0] = static_cast<uint8_t>(midiEvent.data[0] | (engineEvent.channel & MIDI_CHANNEL_BIT));
  1557. // copy rest
  1558. carla_copy<uint8_t>(mdataTmp+1, midiEvent.data+1, size-1U);
  1559. // done
  1560. mdataPtr = mdataTmp;
  1561. }
  1562. }
  1563. else
  1564. {
  1565. continue;
  1566. }
  1567. if (size > 0)
  1568. jackbridge_midi_event_write(eventOut, engineEvent.time, mdataPtr, size);
  1569. }
  1570. }
  1571. }
  1572. if (pData->options.transportMode == ENGINE_TRANSPORT_MODE_JACK)
  1573. {
  1574. if (fTimebaseMaster)
  1575. {
  1576. const bool playing = jackbridge_transport_query(fClient, nullptr) == JackTransportRolling;
  1577. if (fTimebaseRolling != playing)
  1578. {
  1579. fTimebaseRolling = playing;
  1580. pData->timeInfo.playing = playing;
  1581. }
  1582. // Check if we are no longer timebase master
  1583. if (playing && fTimebaseUsecs != 0 && fTimebaseUsecs == pData->timeInfo.usecs)
  1584. {
  1585. carla_debug("No longer timerbase master");
  1586. fTimebaseMaster = false;
  1587. }
  1588. }
  1589. fTimebaseUsecs = pData->timeInfo.usecs;
  1590. }
  1591. #endif // ! BUILD_BRIDGE
  1592. }
  1593. void handleJackLatencyCallback(const jack_latency_callback_mode_t /*mode*/)
  1594. {
  1595. // TODO
  1596. }
  1597. #ifndef BUILD_BRIDGE
  1598. void handleJackTimebaseCallback(jack_nframes_t nframes, jack_position_t* const pos, const int new_pos)
  1599. {
  1600. if (new_pos)
  1601. pData->time.setNeedsReset();
  1602. pData->timeInfo.playing = fTimebaseRolling;
  1603. pData->timeInfo.frame = pos->frame;
  1604. pData->timeInfo.usecs = pos->usecs;
  1605. pData->time.fillJackTimeInfo(pos, nframes);
  1606. }
  1607. void handleJackClientRegistrationCallback(const char* const name, const bool reg)
  1608. {
  1609. CARLA_SAFE_ASSERT_RETURN(name != nullptr && name[0] != '\0',);
  1610. // ignore this if on internal patchbay mode
  1611. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  1612. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  1613. #else
  1614. if (! fExternalPatchbayHost) return;
  1615. #endif
  1616. // do nothing on client registration, wait for first port
  1617. if (reg) return;
  1618. const uint groupId(fUsedGroups.getGroupId(name));
  1619. // clients might have been registered without ports
  1620. if (groupId == 0) return;
  1621. GroupNameToId groupNameToId;
  1622. groupNameToId.setData(groupId, name);
  1623. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1624. ENGINE_CALLBACK_PATCHBAY_CLIENT_REMOVED, groupNameToId.group, 0, 0, 0, 0.0f, nullptr);
  1625. fUsedGroups.list.removeOne(groupNameToId);
  1626. }
  1627. void handleJackPortRegistrationCallback(const jack_port_id_t port, const bool reg)
  1628. {
  1629. // ignore this if on internal patchbay mode
  1630. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  1631. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  1632. #else
  1633. if (! fExternalPatchbayHost) return;
  1634. #endif
  1635. const jack_port_t* const jackPort(jackbridge_port_by_id(fClient, port));
  1636. CARLA_SAFE_ASSERT_RETURN(jackPort != nullptr,);
  1637. const char* const fullPortName(jackbridge_port_name(jackPort));
  1638. CARLA_SAFE_ASSERT_RETURN(fullPortName != nullptr && fullPortName[0] != '\0',);
  1639. if (reg)
  1640. {
  1641. const char* const shortPortName(jackbridge_port_short_name(jackPort));
  1642. CARLA_SAFE_ASSERT_RETURN(shortPortName != nullptr && shortPortName[0] != '\0',);
  1643. bool found;
  1644. CarlaString groupName(fullPortName);
  1645. groupName.truncate(groupName.rfind(shortPortName, &found)-1);
  1646. CARLA_SAFE_ASSERT_RETURN(found,);
  1647. const int jackPortFlags(jackbridge_port_flags(jackPort));
  1648. uint groupId(fUsedGroups.getGroupId(groupName));
  1649. if (groupId == 0)
  1650. {
  1651. groupId = ++fUsedGroups.lastId;
  1652. GroupNameToId groupNameToId;
  1653. groupNameToId.setData(groupId, groupName);
  1654. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1655. ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED,
  1656. groupNameToId.group,
  1657. (jackPortFlags & JackPortIsPhysical) ? PATCHBAY_ICON_HARDWARE : PATCHBAY_ICON_APPLICATION,
  1658. -1,
  1659. 0, 0.0f,
  1660. groupNameToId.name);
  1661. fNewGroups.append(groupId);
  1662. fUsedGroups.list.append(groupNameToId);
  1663. }
  1664. addPatchbayJackPort(fExternalPatchbayHost, fExternalPatchbayOsc,
  1665. groupId, jackPort, shortPortName, fullPortName, jackPortFlags);
  1666. }
  1667. else
  1668. {
  1669. const PortNameToId& portNameToId(fUsedPorts.getPortNameToId(fullPortName));
  1670. /* NOTE: Due to JACK2 async behaviour the port we get here might be the same of a previous rename-plugin request.
  1671. See the comment on CarlaEngineJack::renamePlugin() for more information. */
  1672. if (portNameToId.group <= 0 || portNameToId.port <= 0) return;
  1673. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1674. ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED,
  1675. portNameToId.group,
  1676. static_cast<int>(portNameToId.port),
  1677. 0, 0, 0.0f, nullptr);
  1678. fUsedPorts.list.removeOne(portNameToId);
  1679. }
  1680. }
  1681. void handleJackPortConnectCallback(const jack_port_id_t a, const jack_port_id_t b, const bool connect)
  1682. {
  1683. // ignore this if on internal patchbay mode
  1684. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  1685. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  1686. #else
  1687. if (! fExternalPatchbayHost) return;
  1688. #endif
  1689. const jack_port_t* const jackPortA(jackbridge_port_by_id(fClient, a));
  1690. CARLA_SAFE_ASSERT_RETURN(jackPortA != nullptr,);
  1691. const jack_port_t* const jackPortB(jackbridge_port_by_id(fClient, b));
  1692. CARLA_SAFE_ASSERT_RETURN(jackPortB != nullptr,);
  1693. const char* const fullPortNameA(jackbridge_port_name(jackPortA));
  1694. CARLA_SAFE_ASSERT_RETURN(fullPortNameA != nullptr && fullPortNameA[0] != '\0',);
  1695. const char* const fullPortNameB(jackbridge_port_name(jackPortB));
  1696. CARLA_SAFE_ASSERT_RETURN(fullPortNameB != nullptr && fullPortNameB[0] != '\0',);
  1697. const PortNameToId& portNameToIdA(fUsedPorts.getPortNameToId(fullPortNameA));
  1698. const PortNameToId& portNameToIdB(fUsedPorts.getPortNameToId(fullPortNameB));
  1699. /* NOTE: Due to JACK2 async behaviour the port we get here might be the same of a previous rename-plugin request.
  1700. See the comment on CarlaEngineJack::renamePlugin() for more information. */
  1701. if (portNameToIdA.group <= 0 || portNameToIdA.port <= 0) return;
  1702. if (portNameToIdB.group <= 0 || portNameToIdB.port <= 0) return;
  1703. if (connect)
  1704. {
  1705. char strBuf[STR_MAX+1];
  1706. std::snprintf(strBuf, STR_MAX, "%i:%i:%i:%i", portNameToIdA.group, portNameToIdA.port, portNameToIdB.group, portNameToIdB.port);
  1707. strBuf[STR_MAX] = '\0';
  1708. ConnectionToId connectionToId;
  1709. connectionToId.setData(++fUsedConnections.lastId, portNameToIdA.group, portNameToIdA.port, portNameToIdB.group, portNameToIdB.port);
  1710. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1711. ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED,
  1712. connectionToId.id,
  1713. 0, 0, 0, 0.0f,
  1714. strBuf);
  1715. fUsedConnections.list.append(connectionToId);
  1716. }
  1717. else
  1718. {
  1719. ConnectionToId connectionToId = { 0, 0, 0, 0, 0 };
  1720. bool found = false;
  1721. {
  1722. const CarlaMutexLocker cml(fUsedConnections.mutex);
  1723. for (LinkedList<ConnectionToId>::Itenerator it = fUsedConnections.list.begin2(); it.valid(); it.next())
  1724. {
  1725. connectionToId = it.getValue(connectionToId);
  1726. CARLA_SAFE_ASSERT_CONTINUE(connectionToId.id != 0);
  1727. if (connectionToId.groupA == portNameToIdA.group && connectionToId.portA == portNameToIdA.port &&
  1728. connectionToId.groupB == portNameToIdB.group && connectionToId.portB == portNameToIdB.port)
  1729. {
  1730. found = true;
  1731. fUsedConnections.list.remove(it);
  1732. break;
  1733. }
  1734. }
  1735. }
  1736. if (found) {
  1737. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1738. ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED,
  1739. connectionToId.id,
  1740. 0, 0, 0, 0.0f, nullptr);
  1741. }
  1742. }
  1743. }
  1744. void handleJackPortRenameCallback(const jack_port_id_t port, const char* const oldFullName, const char* const newFullName)
  1745. {
  1746. // ignore this if on internal patchbay mode
  1747. #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  1748. if (! (fExternalPatchbayHost || (fExternalPatchbayOsc && pData->osc.isControlRegisteredForTCP()))) return;
  1749. #else
  1750. if (! fExternalPatchbayHost) return;
  1751. #endif
  1752. CARLA_SAFE_ASSERT_RETURN(oldFullName != nullptr && oldFullName[0] != '\0',);
  1753. CARLA_SAFE_ASSERT_RETURN(newFullName != nullptr && newFullName[0] != '\0',);
  1754. const jack_port_t* const jackPort(jackbridge_port_by_id(fClient, port));
  1755. CARLA_SAFE_ASSERT_RETURN(jackPort != nullptr,);
  1756. const char* const shortPortName(jackbridge_port_short_name(jackPort));
  1757. CARLA_SAFE_ASSERT_RETURN(shortPortName != nullptr && shortPortName[0] != '\0',);
  1758. bool found;
  1759. CarlaString groupName(newFullName);
  1760. groupName.truncate(groupName.rfind(shortPortName, &found)-1);
  1761. CARLA_SAFE_ASSERT_RETURN(found,);
  1762. const uint groupId(fUsedGroups.getGroupId(groupName));
  1763. CARLA_SAFE_ASSERT_RETURN(groupId > 0,);
  1764. for (LinkedList<PortNameToId>::Itenerator it = fUsedPorts.list.begin2(); it.valid(); it.next())
  1765. {
  1766. static PortNameToId portNameFallback = { 0, 0, { '\0' }, { '\0' } };
  1767. PortNameToId& portNameToId(it.getValue(portNameFallback));
  1768. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group != 0);
  1769. if (std::strncmp(portNameToId.fullName, oldFullName, STR_MAX) == 0)
  1770. {
  1771. CARLA_SAFE_ASSERT_CONTINUE(portNameToId.group == groupId);
  1772. portNameToId.rename(shortPortName, newFullName);
  1773. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  1774. ENGINE_CALLBACK_PATCHBAY_PORT_RENAMED,
  1775. portNameToId.group,
  1776. static_cast<int>(portNameToId.port),
  1777. 0, 0, 0.0f,
  1778. portNameToId.name);
  1779. break;
  1780. }
  1781. }
  1782. }
  1783. #endif
  1784. void handleJackShutdownCallback()
  1785. {
  1786. #ifndef BUILD_BRIDGE
  1787. signalThreadShouldExit();
  1788. #endif
  1789. const PendingRtEventsRunner prt(this, pData->bufferSize);
  1790. for (uint i=0; i < pData->curPluginCount; ++i)
  1791. {
  1792. if (CarlaPlugin* const plugin = pData->plugins[i].plugin)
  1793. {
  1794. plugin->tryLock(true);
  1795. if (CarlaEngineJackClient* const client = (CarlaEngineJackClient*)plugin->getEngineClient())
  1796. client->invalidate();
  1797. plugin->unlock();
  1798. }
  1799. }
  1800. fClient = nullptr;
  1801. #ifndef BUILD_BRIDGE
  1802. carla_zeroPointers(fRackPorts, kRackPortCount);
  1803. #endif
  1804. callback(true, true, ENGINE_CALLBACK_QUIT, 0, 0, 0, 0, 0.0f, nullptr);
  1805. }
  1806. // -------------------------------------------------------------------
  1807. void handlePluginJackShutdownCallback(CarlaPlugin* const plugin)
  1808. {
  1809. CarlaEngineJackClient* const engineClient((CarlaEngineJackClient*)plugin->getEngineClient());
  1810. CARLA_SAFE_ASSERT_RETURN(engineClient != nullptr,);
  1811. plugin->tryLock(true);
  1812. engineClient->invalidate();
  1813. plugin->unlock();
  1814. //if (pData->nextAction.pluginId == plugin->getId())
  1815. // pData->nextAction.clearAndReset();
  1816. callback(true, true, ENGINE_CALLBACK_PLUGIN_UNAVAILABLE, plugin->getId(), 0, 0, 0, 0.0f, "Killed by JACK");
  1817. }
  1818. // -------------------------------------------------------------------
  1819. private:
  1820. jack_client_t* fClient;
  1821. bool fExternalPatchbayHost;
  1822. bool fExternalPatchbayOsc;
  1823. bool fFreewheel;
  1824. // -------------------------------------------------------------------
  1825. #ifdef BUILD_BRIDGE
  1826. bool fIsRunning;
  1827. #else
  1828. enum RackPorts {
  1829. kRackPortAudioIn1 = 0,
  1830. kRackPortAudioIn2 = 1,
  1831. kRackPortAudioOut1 = 2,
  1832. kRackPortAudioOut2 = 3,
  1833. kRackPortEventIn = 4,
  1834. kRackPortEventOut = 5,
  1835. kRackPortCount = 6
  1836. };
  1837. jack_port_t* fRackPorts[kRackPortCount];
  1838. bool fTimebaseMaster;
  1839. bool fTimebaseRolling;
  1840. uint64_t fTimebaseUsecs;
  1841. PatchbayGroupList fUsedGroups;
  1842. PatchbayPortList fUsedPorts;
  1843. PatchbayConnectionList fUsedConnections;
  1844. LinkedList<uint> fNewGroups;
  1845. CarlaMutex fPatchbayProcThreadProtectionMutex;
  1846. mutable CharStringListPtr fRetConns;
  1847. bool findPluginIdAndIcon(const char* const clientName, int& pluginId, PatchbayIcon& icon) noexcept
  1848. {
  1849. carla_debug("CarlaEngineJack::findPluginIdAndIcon(\"%s\", ...)", clientName);
  1850. // TODO - this currently only works in multi-client mode
  1851. if (pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS)
  1852. return false;
  1853. for (uint i=0; i < pData->curPluginCount; ++i)
  1854. {
  1855. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1856. if (plugin == nullptr || ! plugin->isEnabled())
  1857. continue;
  1858. const CarlaEngineJackClient* const engineClient((const CarlaEngineJackClient*)plugin->getEngineClient());
  1859. CARLA_SAFE_ASSERT_CONTINUE(engineClient != nullptr);
  1860. const char* const engineClientName(engineClient->getJackClientName());
  1861. CARLA_SAFE_ASSERT_CONTINUE(engineClientName != nullptr && engineClientName[0] != '\0');
  1862. if (std::strcmp(clientName, engineClientName) != 0)
  1863. continue;
  1864. pluginId = static_cast<int>(i);
  1865. icon = PATCHBAY_ICON_PLUGIN;
  1866. if (const char* const pluginIcon = plugin->getIconName())
  1867. {
  1868. if (pluginIcon[0] == '\0')
  1869. pass();
  1870. else if (std::strcmp(pluginIcon, "app") == 0 || std::strcmp(pluginIcon, "application") == 0)
  1871. icon = PATCHBAY_ICON_APPLICATION;
  1872. else if (std::strcmp(pluginIcon, "plugin") == 0)
  1873. icon = PATCHBAY_ICON_PLUGIN;
  1874. else if (std::strcmp(pluginIcon, "hardware") == 0)
  1875. icon = PATCHBAY_ICON_HARDWARE;
  1876. else if (std::strcmp(pluginIcon, "carla") == 0)
  1877. icon = PATCHBAY_ICON_CARLA;
  1878. else if (std::strcmp(pluginIcon, "distrho") == 0)
  1879. icon = PATCHBAY_ICON_DISTRHO;
  1880. else if (std::strcmp(pluginIcon, "file") == 0)
  1881. icon = PATCHBAY_ICON_FILE;
  1882. }
  1883. return true;
  1884. }
  1885. return false;
  1886. }
  1887. void initJackPatchbay(const bool sendHost, const bool sendOSC, const char* const ourName)
  1888. {
  1889. CARLA_SAFE_ASSERT_RETURN(pData->options.processMode != ENGINE_PROCESS_MODE_PATCHBAY ||
  1890. (fExternalPatchbayHost && sendHost) || (fExternalPatchbayOsc && sendOSC),);
  1891. CARLA_SAFE_ASSERT_RETURN(ourName != nullptr && ourName[0] != '\0',);
  1892. CarlaStringList parsedGroups;
  1893. // add our client first
  1894. {
  1895. parsedGroups.append(ourName);
  1896. GroupNameToId groupNameToId;
  1897. groupNameToId.setData(++fUsedGroups.lastId, ourName);
  1898. callback(sendHost, sendOSC,
  1899. ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED,
  1900. groupNameToId.group,
  1901. PATCHBAY_ICON_CARLA,
  1902. -1,
  1903. 0, 0.0f,
  1904. groupNameToId.name);
  1905. fUsedGroups.list.append(groupNameToId);
  1906. }
  1907. // query all jack ports
  1908. {
  1909. const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, 0);
  1910. CARLA_SAFE_ASSERT_RETURN(ports != nullptr,);
  1911. for (int i=0; ports[i] != nullptr; ++i)
  1912. {
  1913. const char* const fullPortName(ports[i]);
  1914. CARLA_SAFE_ASSERT_CONTINUE(fullPortName != nullptr && fullPortName[0] != '\0');
  1915. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, fullPortName));
  1916. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  1917. const char* const shortPortName(jackbridge_port_short_name(jackPort));
  1918. CARLA_SAFE_ASSERT_CONTINUE(shortPortName != nullptr && shortPortName[0] != '\0');
  1919. const int jackPortFlags(jackbridge_port_flags(jackPort));
  1920. uint groupId = 0;
  1921. bool found;
  1922. CarlaString groupName(fullPortName);
  1923. groupName.truncate(groupName.rfind(shortPortName, &found)-1);
  1924. CARLA_SAFE_ASSERT_CONTINUE(found);
  1925. if (parsedGroups.contains(groupName))
  1926. {
  1927. groupId = fUsedGroups.getGroupId(groupName);
  1928. CARLA_SAFE_ASSERT_CONTINUE(groupId > 0);
  1929. }
  1930. else
  1931. {
  1932. groupId = ++fUsedGroups.lastId;
  1933. parsedGroups.append(groupName);
  1934. int pluginId = -1;
  1935. PatchbayIcon icon = (jackPortFlags & JackPortIsPhysical) ? PATCHBAY_ICON_HARDWARE : PATCHBAY_ICON_APPLICATION;
  1936. findPluginIdAndIcon(groupName, pluginId, icon);
  1937. GroupNameToId groupNameToId;
  1938. groupNameToId.setData(groupId, groupName);
  1939. callback(sendHost, sendOSC,
  1940. ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED,
  1941. groupNameToId.group,
  1942. icon,
  1943. pluginId,
  1944. 0, 0.0f,
  1945. groupNameToId.name);
  1946. fUsedGroups.list.append(groupNameToId);
  1947. }
  1948. addPatchbayJackPort(sendHost, sendOSC, groupId, jackPort, shortPortName, fullPortName, jackPortFlags);
  1949. }
  1950. jackbridge_free(ports);
  1951. }
  1952. // query connections, after all ports are in place
  1953. if (const char** const ports = jackbridge_get_ports(fClient, nullptr, nullptr, JackPortIsOutput))
  1954. {
  1955. char strBuf[STR_MAX+1];
  1956. for (int i=0; ports[i] != nullptr; ++i)
  1957. {
  1958. const char* const fullPortName(ports[i]);
  1959. CARLA_SAFE_ASSERT_CONTINUE(fullPortName != nullptr && fullPortName[0] != '\0');
  1960. const jack_port_t* const jackPort(jackbridge_port_by_name(fClient, fullPortName));
  1961. CARLA_SAFE_ASSERT_CONTINUE(jackPort != nullptr);
  1962. const PortNameToId& thisPort(fUsedPorts.getPortNameToId(fullPortName));
  1963. CARLA_SAFE_ASSERT_CONTINUE(thisPort.group > 0);
  1964. CARLA_SAFE_ASSERT_CONTINUE(thisPort.port > 0);
  1965. if (const char** const connections = jackbridge_port_get_all_connections(fClient, jackPort))
  1966. {
  1967. for (int j=0; connections[j] != nullptr; ++j)
  1968. {
  1969. const char* const connection(connections[j]);
  1970. CARLA_SAFE_ASSERT_CONTINUE(connection != nullptr && connection[0] != '\0');
  1971. const PortNameToId& targetPort(fUsedPorts.getPortNameToId(connection));
  1972. CARLA_SAFE_ASSERT_CONTINUE(targetPort.group > 0);
  1973. CARLA_SAFE_ASSERT_CONTINUE(targetPort.port > 0);
  1974. std::snprintf(strBuf, STR_MAX, "%i:%i:%i:%i", thisPort.group, thisPort.port, targetPort.group, targetPort.port);
  1975. strBuf[STR_MAX] = '\0';
  1976. ConnectionToId connectionToId;
  1977. connectionToId.setData(++fUsedConnections.lastId, thisPort.group, thisPort.port, targetPort.group, targetPort.port);
  1978. callback(sendHost, sendOSC,
  1979. ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED,
  1980. connectionToId.id,
  1981. 0, 0, 0, 0.0f,
  1982. strBuf);
  1983. fUsedConnections.list.append(connectionToId);
  1984. }
  1985. jackbridge_free(connections);
  1986. }
  1987. }
  1988. jackbridge_free(ports);
  1989. }
  1990. }
  1991. void addPatchbayJackPort(const bool sendHost, const bool sendOSC,
  1992. const uint groupId, const jack_port_t* const jackPort,
  1993. const char* const shortPortName, const char* const fullPortName, const int jackPortFlags)
  1994. {
  1995. bool portIsInput = (jackPortFlags & JackPortIsInput);
  1996. bool portIsAudio = (std::strcmp(jackbridge_port_type(jackPort), JACK_DEFAULT_AUDIO_TYPE) == 0);
  1997. bool portIsMIDI = (std::strcmp(jackbridge_port_type(jackPort), JACK_DEFAULT_MIDI_TYPE) == 0);
  1998. bool portIsCV = false;
  1999. bool portIsOSC = false;
  2000. if (const jack_uuid_t uuid = jackbridge_port_uuid(jackPort))
  2001. {
  2002. char* value = nullptr;
  2003. char* type = nullptr;
  2004. if (jackbridge_get_property(uuid, JACKEY_SIGNAL_TYPE, &value, &type)
  2005. && value != nullptr
  2006. && type != nullptr
  2007. && std::strcmp(type, "text/plain") == 0)
  2008. {
  2009. portIsCV = (std::strcmp(value, "CV") == 0);
  2010. portIsOSC = (std::strcmp(value, "OSC") == 0);
  2011. }
  2012. }
  2013. uint canvasPortFlags = 0x0;
  2014. canvasPortFlags |= portIsInput ? PATCHBAY_PORT_IS_INPUT : 0x0;
  2015. /**/ if (portIsCV)
  2016. canvasPortFlags |= PATCHBAY_PORT_TYPE_CV;
  2017. else if (portIsOSC)
  2018. canvasPortFlags |= PATCHBAY_PORT_TYPE_OSC;
  2019. else if (portIsAudio)
  2020. canvasPortFlags |= PATCHBAY_PORT_TYPE_AUDIO;
  2021. else if (portIsMIDI)
  2022. canvasPortFlags |= PATCHBAY_PORT_TYPE_MIDI;
  2023. PortNameToId portNameToId;
  2024. portNameToId.setData(groupId, ++fUsedPorts.lastId, shortPortName, fullPortName);
  2025. callback(sendHost, sendOSC,
  2026. ENGINE_CALLBACK_PATCHBAY_PORT_ADDED,
  2027. portNameToId.group,
  2028. static_cast<int>(portNameToId.port),
  2029. static_cast<int>(canvasPortFlags),
  2030. 0, 0.0f,
  2031. portNameToId.name);
  2032. fUsedPorts.list.append(portNameToId);
  2033. }
  2034. #endif
  2035. // -------------------------------------------------------------------
  2036. void processPlugin(CarlaPlugin* const plugin, const uint32_t nframes)
  2037. {
  2038. const uint32_t audioInCount(plugin->getAudioInCount());
  2039. const uint32_t audioOutCount(plugin->getAudioOutCount());
  2040. const uint32_t cvInCount(plugin->getCVInCount());
  2041. const uint32_t cvOutCount(plugin->getCVOutCount());
  2042. const float* audioIn[audioInCount];
  2043. /* */ float* audioOut[audioOutCount];
  2044. const float* cvIn[cvInCount];
  2045. /* */ float* cvOut[cvOutCount];
  2046. for (uint32_t i=0; i < audioInCount; ++i)
  2047. {
  2048. CarlaEngineAudioPort* const port(plugin->getAudioInPort(i));
  2049. audioIn[i] = port->getBuffer();
  2050. }
  2051. for (uint32_t i=0; i < audioOutCount; ++i)
  2052. {
  2053. CarlaEngineAudioPort* const port(plugin->getAudioOutPort(i));
  2054. audioOut[i] = port->getBuffer();
  2055. }
  2056. for (uint32_t i=0; i < cvInCount; ++i)
  2057. {
  2058. CarlaEngineCVPort* const port(plugin->getCVInPort(i));
  2059. cvIn[i] = port->getBuffer();
  2060. }
  2061. for (uint32_t i=0; i < cvOutCount; ++i)
  2062. {
  2063. CarlaEngineCVPort* const port(plugin->getCVOutPort(i));
  2064. cvOut[i] = port->getBuffer();
  2065. }
  2066. float inPeaks[2] = { 0.0f };
  2067. float outPeaks[2] = { 0.0f };
  2068. for (uint32_t i=0; i < audioInCount && i < 2; ++i)
  2069. {
  2070. for (uint32_t j=0; j < nframes; ++j)
  2071. {
  2072. const float absV(std::abs(audioIn[i][j]));
  2073. if (absV > inPeaks[i])
  2074. inPeaks[i] = absV;
  2075. }
  2076. }
  2077. plugin->process(audioIn, audioOut, cvIn, cvOut, nframes);
  2078. for (uint32_t i=0; i < audioOutCount && i < 2; ++i)
  2079. {
  2080. for (uint32_t j=0; j < nframes; ++j)
  2081. {
  2082. const float absV(std::abs(audioOut[i][j]));
  2083. if (absV > outPeaks[i])
  2084. outPeaks[i] = absV;
  2085. }
  2086. }
  2087. setPluginPeaksRT(plugin->getId(), inPeaks, outPeaks);
  2088. }
  2089. #ifndef BUILD_BRIDGE
  2090. // -------------------------------------------------------------------
  2091. struct PostPonedJackEvent {
  2092. enum Type {
  2093. kTypeNull = 0,
  2094. kTypeClientRegister,
  2095. kTypePortRegister,
  2096. kTypePortConnect,
  2097. kTypePortRename
  2098. };
  2099. Type type;
  2100. bool action; // register or connect
  2101. jack_port_id_t port1;
  2102. jack_port_id_t port2;
  2103. char name1[STR_MAX+1];
  2104. char name2[STR_MAX+1];
  2105. };
  2106. LinkedList<PostPonedJackEvent> fPostPonedEvents;
  2107. CarlaMutex fPostPonedEventsMutex;
  2108. bool fIsInternalClient;
  2109. void postPoneJackCallback(const PostPonedJackEvent& ev)
  2110. {
  2111. const CarlaMutexLocker cml(fPostPonedEventsMutex);
  2112. fPostPonedEvents.append(ev);
  2113. }
  2114. void run() override
  2115. {
  2116. LinkedList<PostPonedJackEvent> events;
  2117. LinkedList<uint> newPlugins;
  2118. PostPonedJackEvent nullEvent;
  2119. carla_zeroStruct(nullEvent);
  2120. for (; ! shouldThreadExit();)
  2121. {
  2122. if (fIsInternalClient)
  2123. idle();
  2124. {
  2125. const CarlaMutexLocker cml(fPostPonedEventsMutex);
  2126. if (fPostPonedEvents.count() > 0)
  2127. fPostPonedEvents.moveTo(events);
  2128. if (fNewGroups.count() > 0)
  2129. fNewGroups.moveTo(newPlugins);
  2130. }
  2131. if (fClient == nullptr)
  2132. break;
  2133. if (events.count() == 0 && newPlugins.count() == 0)
  2134. {
  2135. carla_msleep(fIsInternalClient ? 10 : 200);
  2136. continue;
  2137. }
  2138. for (LinkedList<PostPonedJackEvent>::Itenerator it = events.begin2(); it.valid(); it.next())
  2139. {
  2140. const PostPonedJackEvent& ev(it.getValue(nullEvent));
  2141. CARLA_SAFE_ASSERT_CONTINUE(ev.type != PostPonedJackEvent::kTypeNull);
  2142. switch (ev.type)
  2143. {
  2144. case PostPonedJackEvent::kTypeNull:
  2145. break;
  2146. case PostPonedJackEvent::kTypeClientRegister:
  2147. handleJackClientRegistrationCallback(ev.name1, ev.action);
  2148. break;
  2149. case PostPonedJackEvent::kTypePortRegister:
  2150. handleJackPortRegistrationCallback(ev.port1, ev.action);
  2151. break;
  2152. case PostPonedJackEvent::kTypePortConnect:
  2153. handleJackPortConnectCallback(ev.port1, ev.port2, ev.action);
  2154. break;
  2155. case PostPonedJackEvent::kTypePortRename:
  2156. handleJackPortRenameCallback(ev.port1, ev.name1, ev.name2);
  2157. break;
  2158. }
  2159. }
  2160. for (LinkedList<uint>::Itenerator it = newPlugins.begin2(); it.valid(); it.next())
  2161. {
  2162. const uint groupId(it.getValue(0));
  2163. CARLA_SAFE_ASSERT_CONTINUE(groupId > 0);
  2164. const char* const groupName(fUsedGroups.getGroupName(groupId));
  2165. CARLA_SAFE_ASSERT_CONTINUE(groupName != nullptr && groupName[0] != '\0');
  2166. int pluginId = -1;
  2167. PatchbayIcon icon = PATCHBAY_ICON_PLUGIN;
  2168. if (findPluginIdAndIcon(groupName, pluginId, icon)) {
  2169. callback(fExternalPatchbayHost, fExternalPatchbayOsc,
  2170. ENGINE_CALLBACK_PATCHBAY_CLIENT_DATA_CHANGED,
  2171. groupId,
  2172. icon,
  2173. pluginId,
  2174. 0, 0.0f, nullptr);
  2175. }
  2176. }
  2177. events.clear();
  2178. newPlugins.clear();
  2179. }
  2180. events.clear();
  2181. newPlugins.clear();
  2182. }
  2183. #endif // BUILD_BRIDGE
  2184. // -------------------------------------------------------------------
  2185. // disable -Wattributes warnings
  2186. #if defined(__clang__)
  2187. # pragma clang diagnostic push
  2188. # pragma clang diagnostic ignored "-Wattributes"
  2189. #elif defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
  2190. # pragma GCC diagnostic push
  2191. # pragma GCC diagnostic ignored "-Wattributes"
  2192. #endif
  2193. #define handlePtr ((CarlaEngineJack*)arg)
  2194. static void JACKBRIDGE_API carla_jack_thread_init_callback(void*)
  2195. {
  2196. #ifdef __SSE2_MATH__
  2197. // Set FTZ and DAZ flags
  2198. _mm_setcsr(_mm_getcsr() | 0x8040);
  2199. #endif
  2200. }
  2201. static int JACKBRIDGE_API carla_jack_bufsize_callback(jack_nframes_t newBufferSize, void* arg)
  2202. {
  2203. handlePtr->handleJackBufferSizeCallback(newBufferSize);
  2204. return 0;
  2205. }
  2206. static int JACKBRIDGE_API carla_jack_srate_callback(jack_nframes_t newSampleRate, void* arg)
  2207. {
  2208. handlePtr->handleJackSampleRateCallback(newSampleRate);
  2209. return 0;
  2210. }
  2211. static void JACKBRIDGE_API carla_jack_freewheel_callback(int starting, void* arg)
  2212. {
  2213. handlePtr->handleJackFreewheelCallback(bool(starting));
  2214. }
  2215. static void JACKBRIDGE_API carla_jack_latency_callback(jack_latency_callback_mode_t mode, void* arg)
  2216. {
  2217. handlePtr->handleJackLatencyCallback(mode);
  2218. }
  2219. static int JACKBRIDGE_API carla_jack_process_callback(jack_nframes_t nframes, void* arg) __attribute__((annotate("realtime")))
  2220. {
  2221. handlePtr->handleJackProcessCallback(nframes);
  2222. return 0;
  2223. }
  2224. #ifndef BUILD_BRIDGE
  2225. 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")))
  2226. {
  2227. handlePtr->handleJackTimebaseCallback(nframes, pos, new_pos);
  2228. }
  2229. static void JACKBRIDGE_API carla_jack_client_registration_callback(const char* name, int reg, void* arg)
  2230. {
  2231. PostPonedJackEvent ev;
  2232. carla_zeroStruct(ev);
  2233. ev.type = PostPonedJackEvent::kTypeClientRegister;
  2234. ev.action = (reg != 0);
  2235. std::strncpy(ev.name1, name, STR_MAX);
  2236. handlePtr->postPoneJackCallback(ev);
  2237. }
  2238. static void JACKBRIDGE_API carla_jack_port_registration_callback(jack_port_id_t port, int reg, void* arg)
  2239. {
  2240. PostPonedJackEvent ev;
  2241. carla_zeroStruct(ev);
  2242. ev.type = PostPonedJackEvent::kTypePortRegister;
  2243. ev.action = (reg != 0);
  2244. ev.port1 = port;
  2245. handlePtr->postPoneJackCallback(ev);
  2246. }
  2247. static void JACKBRIDGE_API carla_jack_port_connect_callback(jack_port_id_t a, jack_port_id_t b, int connect, void* arg)
  2248. {
  2249. PostPonedJackEvent ev;
  2250. carla_zeroStruct(ev);
  2251. ev.type = PostPonedJackEvent::kTypePortConnect;
  2252. ev.action = (connect != 0);
  2253. ev.port1 = a;
  2254. ev.port2 = b;
  2255. handlePtr->postPoneJackCallback(ev);
  2256. }
  2257. static void JACKBRIDGE_API carla_jack_port_rename_callback(jack_port_id_t port, const char* oldName, const char* newName, void* arg)
  2258. {
  2259. PostPonedJackEvent ev;
  2260. carla_zeroStruct(ev);
  2261. ev.type = PostPonedJackEvent::kTypePortRename;
  2262. ev.port1 = port;
  2263. std::strncpy(ev.name1, oldName, STR_MAX);
  2264. std::strncpy(ev.name2, newName, STR_MAX);
  2265. handlePtr->postPoneJackCallback(ev);
  2266. }
  2267. static int JACKBRIDGE_API carla_jack_xrun_callback(void* arg)
  2268. {
  2269. ++(handlePtr->pData->xruns);
  2270. return 0;
  2271. }
  2272. #endif
  2273. static void JACKBRIDGE_API carla_jack_shutdown_callback(void* arg)
  2274. {
  2275. handlePtr->handleJackShutdownCallback();
  2276. }
  2277. #undef handlePtr
  2278. // -------------------------------------------------------------------
  2279. #ifndef BUILD_BRIDGE
  2280. static int JACKBRIDGE_API carla_jack_process_callback_plugin(jack_nframes_t nframes, void* arg) __attribute__((annotate("realtime")))
  2281. {
  2282. CarlaPlugin* const plugin((CarlaPlugin*)arg);
  2283. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr && plugin->isEnabled(), 0);
  2284. CarlaEngineJack* const engine((CarlaEngineJack*)plugin->getEngine());
  2285. CARLA_SAFE_ASSERT_RETURN(engine != nullptr, 0);
  2286. if (plugin->tryLock(engine->fFreewheel))
  2287. {
  2288. plugin->initBuffers();
  2289. engine->processPlugin(plugin, nframes);
  2290. plugin->unlock();
  2291. }
  2292. return 0;
  2293. }
  2294. /*
  2295. static int JACKBRIDGE_API carla_jack_bufsize_callback_plugin(jack_nframes_t nframes, void* arg)
  2296. {
  2297. CarlaPlugin* const plugin((CarlaPlugin*)arg);
  2298. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr && plugin->isEnabled(), 0);
  2299. plugin->bufferSizeChanged(nframes);
  2300. return 1;
  2301. }
  2302. static int JACKBRIDGE_API carla_jack_srate_callback_plugin(jack_nframes_t nframes, void* arg)
  2303. {
  2304. CarlaPlugin* const plugin((CarlaPlugin*)arg);
  2305. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr && plugin->isEnabled(), 0);
  2306. plugin->sampleRateChanged(nframes);
  2307. return 1;
  2308. }
  2309. */
  2310. static void JACKBRIDGE_API carla_jack_latency_callback_plugin(jack_latency_callback_mode_t /*mode*/, void* /*arg*/)
  2311. {
  2312. // TODO
  2313. }
  2314. static void JACKBRIDGE_API carla_jack_shutdown_callback_plugin(void* arg)
  2315. {
  2316. CarlaPlugin* const plugin((CarlaPlugin*)arg);
  2317. CARLA_SAFE_ASSERT_RETURN(plugin != nullptr,);
  2318. CarlaEngineJack* const engine((CarlaEngineJack*)plugin->getEngine());
  2319. CARLA_SAFE_ASSERT_RETURN(engine != nullptr,);
  2320. engine->handlePluginJackShutdownCallback(plugin);
  2321. }
  2322. #endif
  2323. // enable -Wattributes again
  2324. #if defined(__clang__)
  2325. # pragma clang diagnostic pop
  2326. #elif defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
  2327. # pragma GCC diagnostic pop
  2328. #endif
  2329. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaEngineJack)
  2330. };
  2331. // -----------------------------------------------------------------------
  2332. CarlaEngine* CarlaEngine::newJack()
  2333. {
  2334. carla_debug("CarlaEngine::newJack()");
  2335. return new CarlaEngineJack();
  2336. }
  2337. // -----------------------------------------------------------------------
  2338. CARLA_BACKEND_END_NAMESPACE
  2339. #ifndef BUILD_BRIDGE
  2340. // -----------------------------------------------------------------------
  2341. // internal jack client
  2342. CARLA_EXPORT
  2343. int jack_initialize (jack_client_t *client, const char *load_init);
  2344. CARLA_EXPORT
  2345. void jack_finish(void *arg);
  2346. // -----------------------------------------------------------------------
  2347. CARLA_EXPORT
  2348. int jack_initialize(jack_client_t* const client, const char* const load_init)
  2349. {
  2350. CARLA_BACKEND_USE_NAMESPACE
  2351. EngineProcessMode mode;
  2352. if (load_init != nullptr && std::strcmp(load_init, "rack") == 0)
  2353. mode = ENGINE_PROCESS_MODE_CONTINUOUS_RACK;
  2354. else
  2355. mode = ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS;
  2356. #if 0 //def USING_JUCE
  2357. juce::initialiseJuce_GUI();
  2358. #endif
  2359. CarlaEngineJack* const engine = new CarlaEngineJack();
  2360. engine->setOption(ENGINE_OPTION_FORCE_STEREO, 1, nullptr);
  2361. engine->setOption(ENGINE_OPTION_AUDIO_DEVICE, 0, "Auto-Connect ON");
  2362. engine->setOption(ENGINE_OPTION_OSC_ENABLED, 1, nullptr);
  2363. engine->setOption(ENGINE_OPTION_OSC_PORT_TCP, 22752, nullptr);
  2364. engine->setOption(ENGINE_OPTION_OSC_PORT_UDP, 22752, nullptr);
  2365. engine->setOption(ENGINE_OPTION_PROCESS_MODE, mode, nullptr);
  2366. engine->setOption(ENGINE_OPTION_TRANSPORT_MODE, ENGINE_TRANSPORT_MODE_JACK, nullptr);
  2367. // FIXME
  2368. engine->setOption(ENGINE_OPTION_PATH_BINARIES, 0, "");
  2369. engine->setOption(ENGINE_OPTION_PATH_RESOURCES, 0, "");
  2370. if (engine->initInternal(client))
  2371. {
  2372. #if 0 //def CARLA_OS_UNIX
  2373. sThreadSafeFFTW.init();
  2374. #endif
  2375. return 0;
  2376. }
  2377. else
  2378. {
  2379. delete engine;
  2380. #if 0 //def USING_JUCE
  2381. juce::shutdownJuce_GUI();
  2382. #endif
  2383. return 1;
  2384. }
  2385. }
  2386. CARLA_EXPORT
  2387. void jack_finish(void *arg)
  2388. {
  2389. CARLA_BACKEND_USE_NAMESPACE
  2390. CarlaEngineJack* const engine = (CarlaEngineJack*)arg;;
  2391. CARLA_SAFE_ASSERT_RETURN(engine != nullptr,);
  2392. #if 0 //def CARLA_OS_UNIX
  2393. const ThreadSafeFFTW::Deinitializer tsfftwde(sThreadSafeFFTW);
  2394. #endif
  2395. engine->setAboutToClose();
  2396. engine->removeAllPlugins();
  2397. engine->close();
  2398. delete engine;
  2399. #if 0 //def USING_JUCE
  2400. juce::shutdownJuce_GUI();
  2401. #endif
  2402. }
  2403. // -----------------------------------------------------------------------
  2404. #endif