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.

2259 lines
76KB

  1. /*
  2. * Carla Bridge Plugin
  3. * Copyright (C) 2011-2014 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License as
  7. * published by the Free Software Foundation; either version 2 of
  8. * the License, or any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16. */
  17. #include "CarlaPluginInternal.hpp"
  18. #include "CarlaEngine.hpp"
  19. #ifndef BUILD_BRIDGE
  20. #include "CarlaBackendUtils.hpp"
  21. #include "CarlaBase64Utils.hpp"
  22. #include "CarlaBridgeUtils.hpp"
  23. #include "CarlaMathUtils.hpp"
  24. #include "CarlaShmUtils.hpp"
  25. #include "jackbridge/JackBridge.hpp"
  26. #include <cerrno>
  27. #include <cmath>
  28. #include <ctime>
  29. #define CARLA_BRIDGE_CHECK_OSC_TYPES(/* argc, types, */ argcToCompare, typesToCompare) \
  30. /* check argument count */ \
  31. if (argc != argcToCompare) \
  32. { \
  33. carla_stderr("BridgePlugin::%s() - argument count mismatch: %i != %i", __FUNCTION__, argc, argcToCompare); \
  34. return 1; \
  35. } \
  36. if (argc > 0) \
  37. { \
  38. /* check for nullness */ \
  39. if (! (types && typesToCompare)) \
  40. { \
  41. carla_stderr("BridgePlugin::%s() - argument types are null", __FUNCTION__); \
  42. return 1; \
  43. } \
  44. /* check argument types */ \
  45. if (std::strcmp(types, typesToCompare) != 0) \
  46. { \
  47. carla_stderr("BridgePlugin::%s() - argument types mismatch: '%s' != '%s'", __FUNCTION__, types, typesToCompare); \
  48. return 1; \
  49. } \
  50. }
  51. // -------------------------------------------------------------------------------------------------------------------
  52. using juce::File;
  53. using juce::String;
  54. using juce::StringArray;
  55. CARLA_BACKEND_START_NAMESPACE
  56. // -------------------------------------------------------------------------------------------------------------------
  57. // call carla_shm_create with for a XXXXXX temp filename
  58. static shm_t shm_mkstemp(char* const fileBase)
  59. {
  60. CARLA_SAFE_ASSERT_RETURN(fileBase != nullptr, gNullCarlaShm);
  61. const size_t fileBaseLen(std::strlen(fileBase));
  62. CARLA_SAFE_ASSERT_RETURN(fileBaseLen > 6, gNullCarlaShm);
  63. CARLA_SAFE_ASSERT_RETURN(std::strcmp(fileBase + fileBaseLen - 6, "XXXXXX") == 0, gNullCarlaShm);
  64. static const char charSet[] = "abcdefghijklmnopqrstuvwxyz"
  65. "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  66. "0123456789";
  67. static const int charSetLen = static_cast<int>(std::strlen(charSet) - 1); // -1 to avoid trailing '\0'
  68. // try until getting a valid shm or an error occurs
  69. for (;;)
  70. {
  71. for (size_t c = fileBaseLen - 6; c < fileBaseLen; ++c)
  72. fileBase[c] = charSet[std::rand() % charSetLen];
  73. const shm_t shm = carla_shm_create(fileBase);
  74. if (carla_is_shm_valid(shm))
  75. return shm;
  76. if (errno != EEXIST)
  77. return gNullCarlaShm;
  78. }
  79. }
  80. // -------------------------------------------------------------------------------------------------------------------
  81. struct BridgeAudioPool {
  82. CarlaString filename;
  83. float* data;
  84. size_t size;
  85. shm_t shm;
  86. BridgeAudioPool() noexcept
  87. : filename(),
  88. data(nullptr),
  89. size(0)
  90. #ifdef CARLA_PROPER_CPP11_SUPPORT
  91. , shm(shm_t_INIT) {}
  92. #else
  93. {
  94. carla_shm_init(shm);
  95. }
  96. #endif
  97. ~BridgeAudioPool() noexcept
  98. {
  99. // should be cleared by now
  100. CARLA_SAFE_ASSERT(data == nullptr);
  101. clear();
  102. }
  103. void clear() noexcept
  104. {
  105. filename.clear();
  106. if (! carla_is_shm_valid(shm))
  107. return;
  108. if (data != nullptr)
  109. {
  110. carla_shm_unmap(shm, data, size);
  111. data = nullptr;
  112. }
  113. size = 0;
  114. carla_shm_close(shm);
  115. }
  116. void resize(const uint32_t bufferSize, const uint32_t portCount) noexcept
  117. {
  118. if (data != nullptr)
  119. carla_shm_unmap(shm, data, size);
  120. size = portCount*bufferSize*sizeof(float);
  121. if (size == 0)
  122. size = sizeof(float);
  123. data = (float*)carla_shm_map(shm, size);
  124. }
  125. CARLA_DECLARE_NON_COPY_STRUCT(BridgeAudioPool)
  126. };
  127. // -------------------------------------------------------------------------------------------------------------------
  128. struct BridgeRtControl : public CarlaRingBuffer<StackBuffer> {
  129. CarlaString filename;
  130. BridgeRtData* data;
  131. shm_t shm;
  132. BridgeRtControl()
  133. : filename(),
  134. data(nullptr)
  135. #ifdef CARLA_PROPER_CPP11_SUPPORT
  136. , shm(shm_t_INIT) {}
  137. #else
  138. {
  139. carla_shm_init(shm);
  140. }
  141. #endif
  142. ~BridgeRtControl() noexcept override
  143. {
  144. // should be cleared by now
  145. CARLA_SAFE_ASSERT(data == nullptr);
  146. clear();
  147. }
  148. void clear() noexcept
  149. {
  150. filename.clear();
  151. if (! carla_is_shm_valid(shm))
  152. return;
  153. if (data != nullptr)
  154. {
  155. carla_shm_unmap(shm, data, sizeof(BridgeRtData));
  156. data = nullptr;
  157. }
  158. carla_shm_close(shm);
  159. }
  160. bool mapData() noexcept
  161. {
  162. CARLA_SAFE_ASSERT(data == nullptr);
  163. if (carla_shm_map<BridgeRtData>(shm, data))
  164. {
  165. setRingBuffer(&data->ringBuffer, true);
  166. return true;
  167. }
  168. return false;
  169. }
  170. void unmapData() noexcept
  171. {
  172. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  173. carla_shm_unmap(shm, data, sizeof(BridgeRtData));
  174. data = nullptr;
  175. setRingBuffer(nullptr, false);
  176. }
  177. bool waitForServer(const int secs) noexcept
  178. {
  179. CARLA_SAFE_ASSERT_RETURN(data != nullptr, false);
  180. jackbridge_sem_post(&data->sem.server);
  181. return jackbridge_sem_timedwait(&data->sem.client, secs);
  182. }
  183. void writeOpcode(const PluginBridgeRtOpcode opcode) noexcept
  184. {
  185. writeInt(static_cast<int32_t>(opcode));
  186. }
  187. CARLA_DECLARE_NON_COPY_STRUCT(BridgeRtControl)
  188. };
  189. // -------------------------------------------------------------------------------------------------------------------
  190. struct BridgeNonRtControl : public CarlaRingBuffer<BigStackBuffer> {
  191. CarlaMutex mutex;
  192. CarlaString filename;
  193. BridgeNonRtData* data;
  194. shm_t shm;
  195. BridgeNonRtControl() noexcept
  196. : mutex(),
  197. filename(),
  198. data(nullptr)
  199. #ifdef CARLA_PROPER_CPP11_SUPPORT
  200. , shm(shm_t_INIT) {}
  201. #else
  202. {
  203. carla_shm_init(shm);
  204. }
  205. #endif
  206. ~BridgeNonRtControl() noexcept override
  207. {
  208. // should be cleared by now
  209. CARLA_SAFE_ASSERT(data == nullptr);
  210. clear();
  211. }
  212. void clear() noexcept
  213. {
  214. filename.clear();
  215. if (! carla_is_shm_valid(shm))
  216. return;
  217. if (data != nullptr)
  218. {
  219. carla_shm_unmap(shm, data, sizeof(BridgeNonRtData));
  220. data = nullptr;
  221. }
  222. carla_shm_close(shm);
  223. }
  224. bool mapData() noexcept
  225. {
  226. CARLA_SAFE_ASSERT(data == nullptr);
  227. if (carla_shm_map<BridgeNonRtData>(shm, data))
  228. {
  229. setRingBuffer(&data->ringBuffer, true);
  230. return true;
  231. }
  232. return false;
  233. }
  234. void unmapData() noexcept
  235. {
  236. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  237. carla_shm_unmap(shm, data, sizeof(BridgeNonRtData));
  238. data = nullptr;
  239. setRingBuffer(nullptr, false);
  240. }
  241. void writeOpcode(const PluginBridgeNonRtOpcode opcode) noexcept
  242. {
  243. writeInt(static_cast<int32_t>(opcode));
  244. }
  245. CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtControl)
  246. };
  247. // -------------------------------------------------------------------------------------------------------------------
  248. struct BridgeParamInfo {
  249. float value;
  250. CarlaString name;
  251. CarlaString unit;
  252. BridgeParamInfo() noexcept
  253. : value(0.0f),
  254. name(),
  255. unit() {}
  256. CARLA_DECLARE_NON_COPY_STRUCT(BridgeParamInfo)
  257. };
  258. // -------------------------------------------------------------------------------------------------------------------
  259. class BridgePlugin : public CarlaPlugin
  260. {
  261. public:
  262. BridgePlugin(CarlaEngine* const engine, const uint id, const BinaryType btype, const PluginType ptype)
  263. : CarlaPlugin(engine, id),
  264. fBinaryType(btype),
  265. fPluginType(ptype),
  266. fInitiated(false),
  267. fInitError(false),
  268. fSaved(false),
  269. fNeedsSemDestroy(false),
  270. fTimedOut(false),
  271. fLastPongCounter(-1),
  272. fBridgeBinary(),
  273. fShmAudioPool(),
  274. fShmRtControl(),
  275. fShmNonRtControl(),
  276. fInfo(),
  277. fParams(nullptr),
  278. leakDetector_BridgePlugin()
  279. {
  280. carla_debug("BridgePlugin::BridgePlugin(%p, %i, %s, %s)", engine, id, BinaryType2Str(btype), PluginType2Str(ptype));
  281. pData->osc.thread.setMode(CarlaPluginThread::PLUGIN_THREAD_BRIDGE);
  282. pData->hints |= PLUGIN_IS_BRIDGE;
  283. }
  284. ~BridgePlugin() override
  285. {
  286. carla_debug("BridgePlugin::~BridgePlugin()");
  287. // close UI
  288. if (pData->hints & PLUGIN_HAS_CUSTOM_UI)
  289. pData->transientTryCounter = 0;
  290. pData->singleMutex.lock();
  291. pData->masterMutex.lock();
  292. if (pData->client != nullptr && pData->client->isActive())
  293. pData->client->deactivate();
  294. if (pData->active)
  295. {
  296. deactivate();
  297. pData->active = false;
  298. }
  299. if (pData->osc.thread.isThreadRunning())
  300. {
  301. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtQuit);
  302. fShmNonRtControl.commitWrite();
  303. fShmRtControl.writeOpcode(kPluginBridgeRtQuit);
  304. fShmRtControl.commitWrite();
  305. if (! fTimedOut)
  306. fShmRtControl.waitForServer(3);
  307. }
  308. pData->osc.data.clear();
  309. pData->osc.thread.stopThread(3000);
  310. if (fNeedsSemDestroy)
  311. {
  312. jackbridge_sem_destroy(&fShmRtControl.data->sem.server);
  313. jackbridge_sem_destroy(&fShmRtControl.data->sem.client);
  314. }
  315. fShmAudioPool.clear();
  316. fShmRtControl.clear();
  317. fShmNonRtControl.clear();
  318. clearBuffers();
  319. fInfo.chunk.clear();
  320. }
  321. // -------------------------------------------------------------------
  322. // Information (base)
  323. BinaryType getBinaryType() const noexcept
  324. {
  325. return fBinaryType;
  326. }
  327. PluginType getType() const noexcept override
  328. {
  329. return fPluginType;
  330. }
  331. PluginCategory getCategory() const noexcept override
  332. {
  333. return fInfo.category;
  334. }
  335. int64_t getUniqueId() const noexcept override
  336. {
  337. return fInfo.uniqueId;
  338. }
  339. // -------------------------------------------------------------------
  340. // Information (count)
  341. uint32_t getMidiInCount() const noexcept override
  342. {
  343. return fInfo.mIns;
  344. }
  345. uint32_t getMidiOutCount() const noexcept override
  346. {
  347. return fInfo.mOuts;
  348. }
  349. // -------------------------------------------------------------------
  350. // Information (current data)
  351. std::size_t getChunkData(void** const dataPtr) noexcept override
  352. {
  353. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS, 0);
  354. CARLA_SAFE_ASSERT_RETURN(dataPtr != nullptr, 0);
  355. CARLA_SAFE_ASSERT_RETURN(fInfo.chunk.size() > 0, 0);
  356. *dataPtr = fInfo.chunk.data();
  357. return fInfo.chunk.size();
  358. }
  359. // -------------------------------------------------------------------
  360. // Information (per-plugin data)
  361. uint getOptionsAvailable() const noexcept override
  362. {
  363. return fInfo.optionsAvailable;
  364. }
  365. float getParameterValue(const uint32_t parameterId) const noexcept override
  366. {
  367. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count, 0.0f);
  368. return fParams[parameterId].value;
  369. }
  370. void getLabel(char* const strBuf) const noexcept override
  371. {
  372. std::strncpy(strBuf, fInfo.label, STR_MAX);
  373. }
  374. void getMaker(char* const strBuf) const noexcept override
  375. {
  376. std::strncpy(strBuf, fInfo.maker, STR_MAX);
  377. }
  378. void getCopyright(char* const strBuf) const noexcept override
  379. {
  380. std::strncpy(strBuf, fInfo.copyright, STR_MAX);
  381. }
  382. void getRealName(char* const strBuf) const noexcept override
  383. {
  384. std::strncpy(strBuf, fInfo.name, STR_MAX);
  385. }
  386. void getParameterName(const uint32_t parameterId, char* const strBuf) const noexcept override
  387. {
  388. CARLA_ASSERT(parameterId < pData->param.count);
  389. std::strncpy(strBuf, fParams[parameterId].name.buffer(), STR_MAX);
  390. }
  391. void getParameterUnit(const uint32_t parameterId, char* const strBuf) const noexcept override
  392. {
  393. CARLA_ASSERT(parameterId < pData->param.count);
  394. std::strncpy(strBuf, fParams[parameterId].unit.buffer(), STR_MAX);
  395. }
  396. // -------------------------------------------------------------------
  397. // Set data (state)
  398. void prepareForSave() override
  399. {
  400. fSaved = false;
  401. {
  402. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  403. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtPrepareForSave);
  404. fShmNonRtControl.commitWrite();
  405. }
  406. carla_stdout("BridgePlugin::prepareForSave() - sent, now waiting...");
  407. for (int i=0; i < 200; ++i)
  408. {
  409. if (fSaved)
  410. break;
  411. carla_msleep(30);
  412. pData->engine->callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  413. pData->engine->idle();
  414. }
  415. if (! fSaved)
  416. carla_stderr("BridgePlugin::prepareForSave() - Timeout while requesting save state");
  417. else
  418. carla_stdout("BridgePlugin::prepareForSave() - success!");
  419. }
  420. // -------------------------------------------------------------------
  421. // Set data (internal stuff)
  422. void setOption(const uint option, const bool yesNo, const bool sendCallback) override
  423. {
  424. {
  425. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  426. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetOption);
  427. fShmNonRtControl.writeUInt(option);
  428. fShmNonRtControl.writeBool(yesNo);
  429. fShmNonRtControl.commitWrite();
  430. }
  431. CarlaPlugin::setOption(option, yesNo, sendCallback);
  432. }
  433. void setCtrlChannel(const int8_t channel, const bool sendOsc, const bool sendCallback) noexcept override
  434. {
  435. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  436. {
  437. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  438. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetCtrlChannel);
  439. fShmNonRtControl.writeShort(channel);
  440. fShmNonRtControl.commitWrite();
  441. }
  442. CarlaPlugin::setCtrlChannel(channel, sendOsc, sendCallback);
  443. }
  444. // -------------------------------------------------------------------
  445. // Set data (plugin-specific stuff)
  446. void setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  447. {
  448. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  449. const float fixedValue(pData->param.getFixedValue(parameterId, value));
  450. fParams[parameterId].value = fixedValue;
  451. {
  452. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  453. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetParameterValue);
  454. fShmNonRtControl.writeUInt(parameterId);
  455. fShmNonRtControl.writeFloat(value);
  456. fShmNonRtControl.commitWrite();
  457. }
  458. CarlaPlugin::setParameterValue(parameterId, fixedValue, sendGui, sendOsc, sendCallback);
  459. }
  460. void setParameterMidiChannel(const uint32_t parameterId, const uint8_t channel, const bool sendOsc, const bool sendCallback) noexcept override
  461. {
  462. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  463. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  464. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  465. {
  466. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  467. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetParameterMidiChannel);
  468. fShmNonRtControl.writeUInt(parameterId);
  469. fShmNonRtControl.writeByte(channel);
  470. fShmNonRtControl.commitWrite();
  471. }
  472. CarlaPlugin::setParameterMidiChannel(parameterId, channel, sendOsc, sendCallback);
  473. }
  474. void setParameterMidiCC(const uint32_t parameterId, const int16_t cc, const bool sendOsc, const bool sendCallback) noexcept override
  475. {
  476. CARLA_SAFE_ASSERT_RETURN(sendOsc || sendCallback,); // never call this from RT
  477. CARLA_SAFE_ASSERT_RETURN(parameterId < pData->param.count,);
  478. CARLA_SAFE_ASSERT_RETURN(cc >= -1 && cc <= 0x5F,);
  479. {
  480. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  481. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetParameterMidiCC);
  482. fShmNonRtControl.writeUInt(parameterId);
  483. fShmNonRtControl.writeShort(cc);
  484. fShmNonRtControl.commitWrite();
  485. }
  486. CarlaPlugin::setParameterMidiCC(parameterId, cc, sendOsc, sendCallback);
  487. }
  488. void setProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  489. {
  490. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->prog.count),);
  491. {
  492. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  493. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetProgram);
  494. fShmNonRtControl.writeInt(index);
  495. fShmNonRtControl.commitWrite();
  496. }
  497. CarlaPlugin::setProgram(index, sendGui, sendOsc, sendCallback);
  498. }
  499. void setMidiProgram(const int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) noexcept override
  500. {
  501. CARLA_SAFE_ASSERT_RETURN(index >= -1 && index < static_cast<int32_t>(pData->midiprog.count),);
  502. {
  503. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  504. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetMidiProgram);
  505. fShmNonRtControl.writeInt(index);
  506. fShmNonRtControl.commitWrite();
  507. }
  508. CarlaPlugin::setMidiProgram(index, sendGui, sendOsc, sendCallback);
  509. }
  510. #if 0
  511. void setCustomData(const char* const type, const char* const key, const char* const value, const bool sendGui) override
  512. {
  513. CARLA_ASSERT(type);
  514. CARLA_ASSERT(key);
  515. CARLA_ASSERT(value);
  516. if (sendGui)
  517. {
  518. // TODO - if type is chunk|binary, store it in a file and send path instead
  519. QString cData;
  520. cData = type;
  521. cData += "·";
  522. cData += key;
  523. cData += "·";
  524. cData += value;
  525. osc_send_configure(&osc.data, CARLA_BRIDGE_MSG_SET_CUSTOM, cData.toUtf8().constData());
  526. }
  527. CarlaPlugin::setCustomData(type, key, value, sendGui);
  528. }
  529. #endif
  530. void setChunkData(const void* const data, const std::size_t dataSize) override
  531. {
  532. CARLA_SAFE_ASSERT_RETURN(pData->options & PLUGIN_OPTION_USE_CHUNKS,);
  533. CARLA_SAFE_ASSERT_RETURN(data != nullptr,);
  534. CARLA_SAFE_ASSERT_RETURN(dataSize > 0,);
  535. CarlaString dataBase64 = CarlaString::asBase64(data, dataSize);
  536. CARLA_SAFE_ASSERT_RETURN(dataBase64.length() > 0,);
  537. String filePath(File::getSpecialLocation(File::tempDirectory).getFullPathName());
  538. filePath += CARLA_OS_SEP_STR;
  539. filePath += ".CarlaChunk_";
  540. filePath += fShmAudioPool.filename.buffer() + 18;
  541. if (File(filePath).replaceWithText(dataBase64.buffer()))
  542. {
  543. const uint32_t ulength(static_cast<uint32_t>(filePath.length()));
  544. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  545. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetChunkDataFile);
  546. fShmNonRtControl.writeUInt(ulength);
  547. fShmNonRtControl.writeCustomData(filePath.toRawUTF8(), ulength);
  548. fShmNonRtControl.commitWrite();
  549. }
  550. }
  551. // -------------------------------------------------------------------
  552. // Set ui stuff
  553. void showCustomUI(const bool yesNo) override
  554. {
  555. {
  556. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  557. fShmNonRtControl.writeOpcode(yesNo ? kPluginBridgeNonRtShowUI : kPluginBridgeNonRtHideUI);
  558. fShmNonRtControl.commitWrite();
  559. }
  560. if (yesNo)
  561. {
  562. pData->tryTransient();
  563. }
  564. else
  565. {
  566. pData->transientTryCounter = 0;
  567. }
  568. }
  569. void idle() override
  570. {
  571. if (pData->osc.thread.isThreadRunning())
  572. {
  573. if (fTimedOut && pData->active)
  574. setActive(false, true, true);
  575. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  576. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtPing);
  577. fShmNonRtControl.commitWrite();
  578. }
  579. else
  580. carla_stderr2("TESTING: Bridge has closed!");
  581. CarlaPlugin::idle();
  582. }
  583. // -------------------------------------------------------------------
  584. // Plugin state
  585. void reload() override
  586. {
  587. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr,);
  588. carla_debug("BridgePlugin::reload() - start");
  589. const EngineProcessMode processMode(pData->engine->getProccessMode());
  590. // Safely disable plugin for reload
  591. const ScopedDisabler sd(this);
  592. bool needsCtrlIn, needsCtrlOut;
  593. needsCtrlIn = needsCtrlOut = false;
  594. if (fInfo.aIns > 0)
  595. {
  596. pData->audioIn.createNew(fInfo.aIns);
  597. }
  598. if (fInfo.aOuts > 0)
  599. {
  600. pData->audioOut.createNew(fInfo.aOuts);
  601. needsCtrlIn = true;
  602. }
  603. if (fInfo.mIns > 0)
  604. needsCtrlIn = true;
  605. if (fInfo.mOuts > 0)
  606. needsCtrlOut = true;
  607. const uint portNameSize(pData->engine->getMaxPortNameSize());
  608. CarlaString portName;
  609. // Audio Ins
  610. for (uint32_t j=0; j < fInfo.aIns; ++j)
  611. {
  612. portName.clear();
  613. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  614. {
  615. portName = pData->name;
  616. portName += ":";
  617. }
  618. if (fInfo.aIns > 1)
  619. {
  620. portName += "input_";
  621. portName += CarlaString(j+1);
  622. }
  623. else
  624. portName += "input";
  625. portName.truncate(portNameSize);
  626. pData->audioIn.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, true);
  627. pData->audioIn.ports[j].rindex = j;
  628. }
  629. // Audio Outs
  630. for (uint32_t j=0; j < fInfo.aOuts; ++j)
  631. {
  632. portName.clear();
  633. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  634. {
  635. portName = pData->name;
  636. portName += ":";
  637. }
  638. if (fInfo.aOuts > 1)
  639. {
  640. portName += "output_";
  641. portName += CarlaString(j+1);
  642. }
  643. else
  644. portName += "output";
  645. portName.truncate(portNameSize);
  646. pData->audioOut.ports[j].port = (CarlaEngineAudioPort*)pData->client->addPort(kEnginePortTypeAudio, portName, false);
  647. pData->audioOut.ports[j].rindex = j;
  648. }
  649. if (needsCtrlIn)
  650. {
  651. portName.clear();
  652. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  653. {
  654. portName = pData->name;
  655. portName += ":";
  656. }
  657. portName += "event-in";
  658. portName.truncate(portNameSize);
  659. pData->event.portIn = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, true);
  660. }
  661. if (needsCtrlOut)
  662. {
  663. portName.clear();
  664. if (processMode == ENGINE_PROCESS_MODE_SINGLE_CLIENT)
  665. {
  666. portName = pData->name;
  667. portName += ":";
  668. }
  669. portName += "event-out";
  670. portName.truncate(portNameSize);
  671. pData->event.portOut = (CarlaEngineEventPort*)pData->client->addPort(kEnginePortTypeEvent, portName, false);
  672. }
  673. // extra plugin hints
  674. pData->extraHints = 0x0;
  675. if (fInfo.mIns > 0)
  676. pData->extraHints |= PLUGIN_EXTRA_HINT_HAS_MIDI_IN;
  677. if (fInfo.mOuts > 0)
  678. pData->extraHints |= PLUGIN_EXTRA_HINT_HAS_MIDI_OUT;
  679. if (fInfo.aIns <= 2 && fInfo.aOuts <= 2 && (fInfo.aIns == fInfo.aOuts || fInfo.aIns == 0 || fInfo.aOuts == 0))
  680. pData->extraHints |= PLUGIN_EXTRA_HINT_CAN_RUN_RACK;
  681. bufferSizeChanged(pData->engine->getBufferSize());
  682. reloadPrograms(true);
  683. carla_debug("BridgePlugin::reload() - end");
  684. }
  685. // -------------------------------------------------------------------
  686. // Plugin processing
  687. void activate() noexcept override
  688. {
  689. {
  690. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  691. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtActivate);
  692. fShmNonRtControl.commitWrite();
  693. }
  694. bool timedOut = true;
  695. try {
  696. timedOut = waitForServer(1);
  697. } catch(...) {}
  698. if (! timedOut)
  699. fTimedOut = false;
  700. }
  701. void deactivate() noexcept override
  702. {
  703. {
  704. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  705. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtDeactivate);
  706. fShmNonRtControl.commitWrite();
  707. }
  708. bool timedOut = true;
  709. try {
  710. timedOut = waitForServer(1);
  711. } catch(...) {}
  712. if (! timedOut)
  713. fTimedOut = false;
  714. }
  715. void process(float** const inBuffer, float** const outBuffer, const uint32_t frames) override
  716. {
  717. // --------------------------------------------------------------------------------------------------------
  718. // Check if active
  719. if (fTimedOut || ! pData->active)
  720. {
  721. // disable any output sound
  722. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  723. FloatVectorOperations::clear(outBuffer[i], static_cast<int>(frames));
  724. return;
  725. }
  726. // --------------------------------------------------------------------------------------------------------
  727. // Check if needs reset
  728. if (pData->needsReset)
  729. {
  730. // TODO
  731. pData->needsReset = false;
  732. }
  733. // --------------------------------------------------------------------------------------------------------
  734. // Event Input
  735. if (pData->event.portIn != nullptr)
  736. {
  737. // ----------------------------------------------------------------------------------------------------
  738. // MIDI Input (External)
  739. if (pData->extNotes.mutex.tryLock())
  740. {
  741. for (RtLinkedList<ExternalMidiNote>::Itenerator it = pData->extNotes.data.begin(); it.valid(); it.next())
  742. {
  743. const ExternalMidiNote& note(it.getValue());
  744. CARLA_SAFE_ASSERT_CONTINUE(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS);
  745. uint8_t data1, data2, data3;
  746. data1 = static_cast<uint8_t>((note.velo > 0 ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF) | (note.channel & MIDI_CHANNEL_BIT));
  747. data2 = note.note;
  748. data3 = note.velo;
  749. fShmRtControl.writeOpcode(kPluginBridgeRtMidiEvent);
  750. fShmRtControl.writeUInt(0); // time
  751. fShmRtControl.writeByte(0); // port
  752. fShmRtControl.writeByte(3); // size
  753. fShmRtControl.writeByte(data1);
  754. fShmRtControl.writeByte(data2);
  755. fShmRtControl.writeByte(data3);
  756. fShmRtControl.commitWrite();
  757. }
  758. pData->extNotes.data.clear();
  759. pData->extNotes.mutex.unlock();
  760. } // End of MIDI Input (External)
  761. // ----------------------------------------------------------------------------------------------------
  762. // Event Input (System)
  763. bool allNotesOffSent = false;
  764. for (uint32_t i=0, numEvents = pData->event.portIn->getEventCount(); i < numEvents; ++i)
  765. {
  766. const EngineEvent& event(pData->event.portIn->getEvent(i));
  767. // Control change
  768. switch (event.type)
  769. {
  770. case kEngineEventTypeNull:
  771. break;
  772. case kEngineEventTypeControl: {
  773. const EngineControlEvent& ctrlEvent = event.ctrl;
  774. switch (ctrlEvent.type)
  775. {
  776. case kEngineControlEventTypeNull:
  777. break;
  778. case kEngineControlEventTypeParameter:
  779. // Control backend stuff
  780. if (event.channel == pData->ctrlChannel)
  781. {
  782. float value;
  783. if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_DRYWET) != 0)
  784. {
  785. value = ctrlEvent.value;
  786. setDryWet(value, false, false);
  787. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_DRYWET, 0, value);
  788. break;
  789. }
  790. if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_VOLUME) != 0)
  791. {
  792. value = ctrlEvent.value*127.0f/100.0f;
  793. setVolume(value, false, false);
  794. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_VOLUME, 0, value);
  795. break;
  796. }
  797. if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (pData->hints & PLUGIN_CAN_BALANCE) != 0)
  798. {
  799. float left, right;
  800. value = ctrlEvent.value/0.5f - 1.0f;
  801. if (value < 0.0f)
  802. {
  803. left = -1.0f;
  804. right = (value*2.0f)+1.0f;
  805. }
  806. else if (value > 0.0f)
  807. {
  808. left = (value*2.0f)-1.0f;
  809. right = 1.0f;
  810. }
  811. else
  812. {
  813. left = -1.0f;
  814. right = 1.0f;
  815. }
  816. setBalanceLeft(left, false, false);
  817. setBalanceRight(right, false, false);
  818. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_LEFT, 0, left);
  819. pData->postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_RIGHT, 0, right);
  820. break;
  821. }
  822. }
  823. fShmRtControl.writeOpcode(kPluginBridgeRtControlEventParameter);
  824. fShmRtControl.writeUInt(event.time);
  825. fShmRtControl.writeByte(event.channel);
  826. fShmRtControl.writeUShort(event.ctrl.param);
  827. fShmRtControl.writeFloat(event.ctrl.value);
  828. fShmRtControl.commitWrite();
  829. break;
  830. case kEngineControlEventTypeMidiBank:
  831. if (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES)
  832. {
  833. fShmRtControl.writeOpcode(kPluginBridgeRtControlEventMidiBank);
  834. fShmRtControl.writeUInt(event.time);
  835. fShmRtControl.writeByte(event.channel);
  836. fShmRtControl.writeUShort(event.ctrl.param);
  837. fShmRtControl.commitWrite();
  838. }
  839. break;
  840. case kEngineControlEventTypeMidiProgram:
  841. if (pData->options & PLUGIN_OPTION_MAP_PROGRAM_CHANGES)
  842. {
  843. fShmRtControl.writeOpcode(kPluginBridgeRtControlEventMidiProgram);
  844. fShmRtControl.writeUInt(event.time);
  845. fShmRtControl.writeByte(event.channel);
  846. fShmRtControl.writeUShort(event.ctrl.param);
  847. fShmRtControl.commitWrite();
  848. }
  849. break;
  850. case kEngineControlEventTypeAllSoundOff:
  851. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  852. {
  853. fShmRtControl.writeOpcode(kPluginBridgeRtControlEventAllSoundOff);
  854. fShmRtControl.writeUInt(event.time);
  855. fShmRtControl.writeByte(event.channel);
  856. fShmRtControl.commitWrite();
  857. }
  858. break;
  859. case kEngineControlEventTypeAllNotesOff:
  860. if (pData->options & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  861. {
  862. if (event.channel == pData->ctrlChannel && ! allNotesOffSent)
  863. {
  864. allNotesOffSent = true;
  865. sendMidiAllNotesOffToCallback();
  866. }
  867. fShmRtControl.writeOpcode(kPluginBridgeRtControlEventAllNotesOff);
  868. fShmRtControl.writeUInt(event.time);
  869. fShmRtControl.writeByte(event.channel);
  870. fShmRtControl.commitWrite();
  871. }
  872. break;
  873. } // switch (ctrlEvent.type)
  874. break;
  875. } // case kEngineEventTypeControl
  876. case kEngineEventTypeMidi: {
  877. const EngineMidiEvent& midiEvent(event.midi);
  878. if (midiEvent.size == 0 || midiEvent.size >= MAX_MIDI_VALUE)
  879. continue;
  880. uint8_t status = uint8_t(MIDI_GET_STATUS_FROM_DATA(midiEvent.data));
  881. uint8_t channel = event.channel;
  882. if (MIDI_IS_STATUS_NOTE_ON(status) && midiEvent.data[2] == 0)
  883. status = MIDI_STATUS_NOTE_OFF;
  884. if (status == MIDI_STATUS_CHANNEL_PRESSURE && (pData->options & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0)
  885. continue;
  886. if (status == MIDI_STATUS_CONTROL_CHANGE && (pData->options & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0)
  887. continue;
  888. if (status == MIDI_STATUS_POLYPHONIC_AFTERTOUCH && (pData->options & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0)
  889. continue;
  890. if (status == MIDI_STATUS_PITCH_WHEEL_CONTROL && (pData->options & PLUGIN_OPTION_SEND_PITCHBEND) == 0)
  891. continue;
  892. fShmRtControl.writeOpcode(kPluginBridgeRtMidiEvent);
  893. fShmRtControl.writeUInt(event.time);
  894. fShmRtControl.writeByte(midiEvent.port);
  895. fShmRtControl.writeByte(midiEvent.size);
  896. for (uint8_t j=0; j < midiEvent.size; ++j)
  897. fShmRtControl.writeByte(midiEvent.data[j]);
  898. fShmRtControl.commitWrite();
  899. if (status == MIDI_STATUS_NOTE_ON)
  900. pData->postponeRtEvent(kPluginPostRtEventNoteOn, channel, midiEvent.data[1], midiEvent.data[2]);
  901. else if (status == MIDI_STATUS_NOTE_OFF)
  902. pData->postponeRtEvent(kPluginPostRtEventNoteOff, channel, midiEvent.data[1], 0.0f);
  903. } break;
  904. }
  905. }
  906. pData->postRtEvents.trySplice();
  907. } // End of Event Input
  908. processSingle(inBuffer, outBuffer, frames);
  909. }
  910. bool processSingle(float** const inBuffer, float** const outBuffer, const uint32_t frames)
  911. {
  912. CARLA_SAFE_ASSERT_RETURN(frames > 0, false);
  913. if (pData->audioIn.count > 0)
  914. {
  915. CARLA_SAFE_ASSERT_RETURN(inBuffer != nullptr, false);
  916. }
  917. if (pData->audioOut.count > 0)
  918. {
  919. CARLA_SAFE_ASSERT_RETURN(outBuffer != nullptr, false);
  920. }
  921. // --------------------------------------------------------------------------------------------------------
  922. // Try lock, silence otherwise
  923. if (pData->engine->isOffline())
  924. {
  925. pData->singleMutex.lock();
  926. }
  927. else if (! pData->singleMutex.tryLock())
  928. {
  929. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  930. FloatVectorOperations::clear(outBuffer[i], static_cast<int>(frames));
  931. return false;
  932. }
  933. // --------------------------------------------------------------------------------------------------------
  934. // Reset audio buffers
  935. //std::memset(fShmAudioPool.data, 0, fShmAudioPool.size);
  936. for (uint32_t i=0; i < fInfo.aIns; ++i)
  937. FloatVectorOperations::copy(fShmAudioPool.data + (i * frames), inBuffer[i], static_cast<int>(frames));
  938. // --------------------------------------------------------------------------------------------------------
  939. // TimeInfo
  940. const EngineTimeInfo& timeInfo(pData->engine->getTimeInfo());
  941. BridgeTimeInfo& bridgeTimeInfo(fShmRtControl.data->timeInfo);
  942. bridgeTimeInfo.playing = timeInfo.playing;
  943. bridgeTimeInfo.frame = timeInfo.frame;
  944. bridgeTimeInfo.usecs = timeInfo.usecs;
  945. bridgeTimeInfo.valid = timeInfo.valid;
  946. if (timeInfo.valid & EngineTimeInfo::kValidBBT)
  947. {
  948. bridgeTimeInfo.bar = timeInfo.bbt.bar;
  949. bridgeTimeInfo.beat = timeInfo.bbt.beat;
  950. bridgeTimeInfo.tick = timeInfo.bbt.tick;
  951. bridgeTimeInfo.beatsPerBar = timeInfo.bbt.beatsPerBar;
  952. bridgeTimeInfo.beatType = timeInfo.bbt.beatType;
  953. bridgeTimeInfo.ticksPerBeat = timeInfo.bbt.ticksPerBeat;
  954. bridgeTimeInfo.beatsPerMinute = timeInfo.bbt.beatsPerMinute;
  955. bridgeTimeInfo.barStartTick = timeInfo.bbt.barStartTick;
  956. }
  957. // --------------------------------------------------------------------------------------------------------
  958. // Run plugin
  959. {
  960. fShmRtControl.writeOpcode(kPluginBridgeRtProcess);
  961. fShmRtControl.commitWrite();
  962. }
  963. if (! waitForServer(2))
  964. {
  965. pData->singleMutex.unlock();
  966. return true;
  967. }
  968. for (uint32_t i=0; i < fInfo.aOuts; ++i)
  969. FloatVectorOperations::copy(outBuffer[i], fShmAudioPool.data + ((i + fInfo.aIns) * frames), static_cast<int>(frames));
  970. // --------------------------------------------------------------------------------------------------------
  971. // Post-processing (dry/wet, volume and balance)
  972. {
  973. const bool doVolume = (pData->hints & PLUGIN_CAN_VOLUME) != 0 && ! carla_compareFloats(pData->postProc.volume, 1.0f);
  974. const bool doDryWet = (pData->hints & PLUGIN_CAN_DRYWET) != 0 && ! carla_compareFloats(pData->postProc.dryWet, 1.0f);
  975. const bool doBalance = (pData->hints & PLUGIN_CAN_BALANCE) != 0 && ! (carla_compareFloats(pData->postProc.balanceLeft, -1.0f) && carla_compareFloats(pData->postProc.balanceRight, 1.0f));
  976. bool isPair;
  977. float bufValue, oldBufLeft[doBalance ? frames : 1];
  978. for (uint32_t i=0; i < pData->audioOut.count; ++i)
  979. {
  980. // Dry/Wet
  981. if (doDryWet)
  982. {
  983. for (uint32_t k=0; k < frames; ++k)
  984. {
  985. bufValue = inBuffer[(pData->audioIn.count == 1) ? 0 : i][k];
  986. outBuffer[i][k] = (outBuffer[i][k] * pData->postProc.dryWet) + (bufValue * (1.0f - pData->postProc.dryWet));
  987. }
  988. }
  989. // Balance
  990. if (doBalance)
  991. {
  992. isPair = (i % 2 == 0);
  993. if (isPair)
  994. {
  995. CARLA_ASSERT(i+1 < pData->audioOut.count);
  996. FloatVectorOperations::copy(oldBufLeft, outBuffer[i], static_cast<int>(frames));
  997. }
  998. float balRangeL = (pData->postProc.balanceLeft + 1.0f)/2.0f;
  999. float balRangeR = (pData->postProc.balanceRight + 1.0f)/2.0f;
  1000. for (uint32_t k=0; k < frames; ++k)
  1001. {
  1002. if (isPair)
  1003. {
  1004. // left
  1005. outBuffer[i][k] = oldBufLeft[k] * (1.0f - balRangeL);
  1006. outBuffer[i][k] += outBuffer[i+1][k] * (1.0f - balRangeR);
  1007. }
  1008. else
  1009. {
  1010. // right
  1011. outBuffer[i][k] = outBuffer[i][k] * balRangeR;
  1012. outBuffer[i][k] += oldBufLeft[k] * balRangeL;
  1013. }
  1014. }
  1015. }
  1016. // Volume (and buffer copy)
  1017. if (doVolume)
  1018. {
  1019. for (uint32_t k=0; k < frames; ++k)
  1020. outBuffer[i][k] *= pData->postProc.volume;
  1021. }
  1022. }
  1023. } // End of Post-processing
  1024. // --------------------------------------------------------------------------------------------------------
  1025. pData->singleMutex.unlock();
  1026. return true;
  1027. }
  1028. void bufferSizeChanged(const uint32_t newBufferSize) override
  1029. {
  1030. resizeAudioPool(newBufferSize);
  1031. {
  1032. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1033. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetBufferSize);
  1034. fShmNonRtControl.writeUInt(newBufferSize);
  1035. fShmNonRtControl.commitWrite();
  1036. }
  1037. fShmRtControl.waitForServer(1);
  1038. }
  1039. void sampleRateChanged(const double newSampleRate) override
  1040. {
  1041. {
  1042. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1043. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetSampleRate);
  1044. fShmNonRtControl.writeDouble(newSampleRate);
  1045. fShmNonRtControl.commitWrite();
  1046. }
  1047. fShmRtControl.waitForServer(1);
  1048. }
  1049. void offlineModeChanged(const bool isOffline) override
  1050. {
  1051. {
  1052. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1053. fShmNonRtControl.writeOpcode(isOffline ? kPluginBridgeNonRtSetOffline : kPluginBridgeNonRtSetOnline);
  1054. fShmNonRtControl.commitWrite();
  1055. }
  1056. fShmRtControl.waitForServer(1);
  1057. }
  1058. // -------------------------------------------------------------------
  1059. // Plugin buffers
  1060. void clearBuffers() noexcept override
  1061. {
  1062. if (fParams != nullptr)
  1063. {
  1064. delete[] fParams;
  1065. fParams = nullptr;
  1066. }
  1067. CarlaPlugin::clearBuffers();
  1068. }
  1069. // -------------------------------------------------------------------
  1070. // OSC stuff
  1071. void updateOscURL() override
  1072. {
  1073. const String newURL(String(pData->engine->getOscServerPathUDP()) + String("/") + String(pData->id));
  1074. const uint32_t ulength(static_cast<uint32_t>(newURL.length()));
  1075. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1076. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetOscURL);
  1077. fShmNonRtControl.writeUInt(ulength);
  1078. fShmNonRtControl.writeCustomData(newURL.toRawUTF8(), ulength);
  1079. fShmNonRtControl.commitWrite();
  1080. }
  1081. // -------------------------------------------------------------------
  1082. // Post-poned UI Stuff
  1083. void uiParameterChange(const uint32_t index, const float value) noexcept override
  1084. {
  1085. CARLA_SAFE_ASSERT_RETURN(index < pData->param.count,);
  1086. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1087. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtUiParameterChange);
  1088. fShmNonRtControl.writeUInt(index);
  1089. fShmNonRtControl.writeFloat(value);
  1090. fShmNonRtControl.commitWrite();
  1091. }
  1092. void uiProgramChange(const uint32_t index) noexcept override
  1093. {
  1094. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count,);
  1095. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1096. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtUiProgramChange);
  1097. fShmNonRtControl.writeUInt(index);
  1098. fShmNonRtControl.commitWrite();
  1099. }
  1100. void uiMidiProgramChange(const uint32_t index) noexcept override
  1101. {
  1102. CARLA_SAFE_ASSERT_RETURN(index < pData->midiprog.count,);
  1103. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1104. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtUiMidiProgramChange);
  1105. fShmNonRtControl.writeUInt(index);
  1106. fShmNonRtControl.commitWrite();
  1107. }
  1108. void uiNoteOn(const uint8_t channel, const uint8_t note, const uint8_t velo) noexcept override
  1109. {
  1110. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1111. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1112. CARLA_SAFE_ASSERT_RETURN(velo > 0 && velo < MAX_MIDI_VALUE,);
  1113. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1114. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtUiNoteOn);
  1115. fShmNonRtControl.writeByte(channel);
  1116. fShmNonRtControl.writeByte(note);
  1117. fShmNonRtControl.writeByte(velo);
  1118. fShmNonRtControl.commitWrite();
  1119. }
  1120. void uiNoteOff(const uint8_t channel, const uint8_t note) noexcept override
  1121. {
  1122. CARLA_SAFE_ASSERT_RETURN(channel < MAX_MIDI_CHANNELS,);
  1123. CARLA_SAFE_ASSERT_RETURN(note < MAX_MIDI_NOTE,);
  1124. const CarlaMutexLocker _cml(fShmNonRtControl.mutex);
  1125. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtUiNoteOff);
  1126. fShmNonRtControl.writeByte(channel);
  1127. fShmNonRtControl.writeByte(note);
  1128. fShmNonRtControl.commitWrite();
  1129. }
  1130. // -------------------------------------------------------------------
  1131. int setOscPluginBridgeInfo(const PluginBridgeOscInfoType infoType, const int argc, const lo_arg* const* const argv, const char* const types)
  1132. {
  1133. #ifdef DEBUG
  1134. if (infoType != kPluginBridgeOscPong) {
  1135. carla_debug("BridgePlugin::setOscPluginBridgeInfo(%s, %i, %p, \"%s\")", PluginBridgeOscInfoType2str(infoType), argc, argv, types);
  1136. }
  1137. #endif
  1138. switch (infoType)
  1139. {
  1140. case kPluginBridgeOscNull:
  1141. break;
  1142. case kPluginBridgeOscPong:
  1143. if (fLastPongCounter > 0)
  1144. fLastPongCounter = 0;
  1145. break;
  1146. case kPluginBridgeOscPluginInfo1: {
  1147. CARLA_BRIDGE_CHECK_OSC_TYPES(5, "iiiih");
  1148. const int32_t category = argv[0]->i;
  1149. const int32_t hints = argv[1]->i;
  1150. const int32_t optionAv = argv[2]->i;
  1151. const int32_t optionEn = argv[3]->i;
  1152. const int64_t uniqueId = argv[4]->h;
  1153. CARLA_SAFE_ASSERT_BREAK(category >= 0);
  1154. CARLA_SAFE_ASSERT_BREAK(hints >= 0);
  1155. CARLA_SAFE_ASSERT_BREAK(optionAv >= 0);
  1156. CARLA_SAFE_ASSERT_BREAK(optionEn >= 0);
  1157. pData->hints = static_cast<uint>(hints);
  1158. pData->hints |= PLUGIN_IS_BRIDGE;
  1159. pData->options = static_cast<uint>(optionEn);
  1160. fInfo.category = static_cast<PluginCategory>(category);
  1161. fInfo.uniqueId = uniqueId;
  1162. fInfo.optionsAvailable = static_cast<uint>(optionAv);
  1163. break;
  1164. }
  1165. case kPluginBridgeOscPluginInfo2: {
  1166. CARLA_BRIDGE_CHECK_OSC_TYPES(4, "ssss");
  1167. const char* const realName = (const char*)&argv[0]->s;
  1168. const char* const label = (const char*)&argv[1]->s;
  1169. const char* const maker = (const char*)&argv[2]->s;
  1170. const char* const copyright = (const char*)&argv[3]->s;
  1171. CARLA_SAFE_ASSERT_BREAK(realName != nullptr);
  1172. CARLA_SAFE_ASSERT_BREAK(label != nullptr);
  1173. CARLA_SAFE_ASSERT_BREAK(maker != nullptr);
  1174. CARLA_SAFE_ASSERT_BREAK(copyright != nullptr);
  1175. fInfo.name = realName;
  1176. fInfo.label = label;
  1177. fInfo.maker = maker;
  1178. fInfo.copyright = copyright;
  1179. if (pData->name == nullptr)
  1180. pData->name = pData->engine->getUniquePluginName(realName);
  1181. break;
  1182. }
  1183. case kPluginBridgeOscAudioCount: {
  1184. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "ii");
  1185. const int32_t ins = argv[0]->i;
  1186. const int32_t outs = argv[1]->i;
  1187. CARLA_SAFE_ASSERT_BREAK(ins >= 0);
  1188. CARLA_SAFE_ASSERT_BREAK(outs >= 0);
  1189. fInfo.aIns = static_cast<uint32_t>(ins);
  1190. fInfo.aOuts = static_cast<uint32_t>(outs);
  1191. break;
  1192. }
  1193. case kPluginBridgeOscMidiCount: {
  1194. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "ii");
  1195. const int32_t ins = argv[0]->i;
  1196. const int32_t outs = argv[1]->i;
  1197. CARLA_SAFE_ASSERT_BREAK(ins >= 0);
  1198. CARLA_SAFE_ASSERT_BREAK(outs >= 0);
  1199. fInfo.mIns = static_cast<uint32_t>(ins);
  1200. fInfo.mOuts = static_cast<uint32_t>(outs);
  1201. break;
  1202. }
  1203. case kPluginBridgeOscParameterCount: {
  1204. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "ii");
  1205. const int32_t ins = argv[0]->i;
  1206. const int32_t outs = argv[1]->i;
  1207. CARLA_SAFE_ASSERT_BREAK(ins >= 0);
  1208. CARLA_SAFE_ASSERT_BREAK(outs >= 0);
  1209. // delete old data
  1210. pData->param.clear();
  1211. if (fParams != nullptr)
  1212. {
  1213. delete[] fParams;
  1214. fParams = nullptr;
  1215. }
  1216. if (int32_t count = ins+outs)
  1217. {
  1218. const int32_t maxParams(static_cast<int32_t>(pData->engine->getOptions().maxParameters));
  1219. if (count > maxParams)
  1220. {
  1221. count = maxParams;
  1222. carla_safe_assert_int2("count <= pData->engine->getOptions().maxParameters", __FILE__, __LINE__, count, maxParams);
  1223. }
  1224. const uint32_t ucount(static_cast<uint32_t>(count));
  1225. pData->param.createNew(ucount, false);
  1226. fParams = new BridgeParamInfo[ucount];
  1227. }
  1228. break;
  1229. }
  1230. case kPluginBridgeOscProgramCount: {
  1231. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i");
  1232. const int32_t count = argv[0]->i;
  1233. CARLA_SAFE_ASSERT_BREAK(count >= 0);
  1234. pData->prog.clear();
  1235. if (count > 0)
  1236. pData->prog.createNew(static_cast<uint32_t>(count));
  1237. break;
  1238. }
  1239. case kPluginBridgeOscMidiProgramCount: {
  1240. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i");
  1241. const int32_t count = argv[0]->i;
  1242. CARLA_SAFE_ASSERT_BREAK(count >= 0);
  1243. pData->midiprog.clear();
  1244. if (count > 0)
  1245. pData->midiprog.createNew(static_cast<uint32_t>(count));
  1246. break;
  1247. }
  1248. case kPluginBridgeOscParameterData1: {
  1249. CARLA_BRIDGE_CHECK_OSC_TYPES(5, "iiiii");
  1250. const int32_t index = argv[0]->i;
  1251. const int32_t rindex = argv[1]->i;
  1252. const int32_t type = argv[2]->i;
  1253. const int32_t hints = argv[3]->i;
  1254. const int32_t midiCC = argv[4]->i;
  1255. CARLA_SAFE_ASSERT_BREAK(index >= 0);
  1256. CARLA_SAFE_ASSERT_BREAK(rindex >= 0);
  1257. CARLA_SAFE_ASSERT_BREAK(type >= 0);
  1258. CARLA_SAFE_ASSERT_BREAK(hints >= 0);
  1259. CARLA_SAFE_ASSERT_BREAK(midiCC >= -1 && midiCC < 0x5F);
  1260. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->param.count), index, pData->param.count);
  1261. if (index < static_cast<int32_t>(pData->param.count))
  1262. {
  1263. pData->param.data[index].type = static_cast<ParameterType>(type);
  1264. pData->param.data[index].index = index;
  1265. pData->param.data[index].rindex = rindex;
  1266. pData->param.data[index].hints = static_cast<uint>(hints);
  1267. pData->param.data[index].midiCC = static_cast<int16_t>(midiCC);
  1268. }
  1269. break;
  1270. }
  1271. case kPluginBridgeOscParameterData2: {
  1272. CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iss");
  1273. const int32_t index = argv[0]->i;
  1274. const char* const name = (const char*)&argv[1]->s;
  1275. const char* const unit = (const char*)&argv[2]->s;
  1276. CARLA_SAFE_ASSERT_BREAK(index >= 0);
  1277. CARLA_SAFE_ASSERT_BREAK(name != nullptr);
  1278. CARLA_SAFE_ASSERT_BREAK(unit != nullptr);
  1279. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->param.count), index, pData->param.count);
  1280. if (index < static_cast<int32_t>(pData->param.count))
  1281. {
  1282. fParams[index].name = name;
  1283. fParams[index].unit = unit;
  1284. }
  1285. break;
  1286. }
  1287. case kPluginBridgeOscParameterRanges1: {
  1288. CARLA_BRIDGE_CHECK_OSC_TYPES(4, "ifff");
  1289. const int32_t index = argv[0]->i;
  1290. const float def = argv[1]->f;
  1291. const float min = argv[2]->f;
  1292. const float max = argv[3]->f;
  1293. CARLA_SAFE_ASSERT_BREAK(index >= 0);
  1294. CARLA_SAFE_ASSERT_BREAK(min < max);
  1295. CARLA_SAFE_ASSERT_BREAK(def >= min);
  1296. CARLA_SAFE_ASSERT_BREAK(def <= max);
  1297. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->param.count), index, pData->param.count);
  1298. if (index < static_cast<int32_t>(pData->param.count))
  1299. {
  1300. pData->param.ranges[index].def = def;
  1301. pData->param.ranges[index].min = min;
  1302. pData->param.ranges[index].max = max;
  1303. }
  1304. break;
  1305. }
  1306. case kPluginBridgeOscParameterRanges2: {
  1307. CARLA_BRIDGE_CHECK_OSC_TYPES(4, "ifff");
  1308. const int32_t index = argv[0]->i;
  1309. const float step = argv[1]->f;
  1310. const float stepSmall = argv[2]->f;
  1311. const float stepLarge = argv[3]->f;
  1312. CARLA_SAFE_ASSERT_BREAK(index >= 0);
  1313. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->param.count), index, pData->param.count);
  1314. if (index < static_cast<int32_t>(pData->param.count))
  1315. {
  1316. pData->param.ranges[index].step = step;
  1317. pData->param.ranges[index].stepSmall = stepSmall;
  1318. pData->param.ranges[index].stepLarge = stepLarge;
  1319. }
  1320. break;
  1321. }
  1322. case kPluginBridgeOscParameterValue: {
  1323. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "if");
  1324. const int32_t index = argv[0]->i;
  1325. const float value = argv[1]->f;
  1326. CARLA_SAFE_ASSERT_BREAK(index >= 0);
  1327. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->param.count), index, pData->param.count);
  1328. if (index < static_cast<int32_t>(pData->param.count))
  1329. {
  1330. const uint32_t uindex(static_cast<uint32_t>(index));
  1331. const float fixedValue(pData->param.getFixedValue(uindex, value));
  1332. fParams[uindex].value = fixedValue;
  1333. CarlaPlugin::setParameterValue(uindex, fixedValue, false, true, true);
  1334. }
  1335. break;
  1336. }
  1337. case kPluginBridgeOscDefaultValue: {
  1338. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "if");
  1339. const int32_t index = argv[0]->i;
  1340. const float value = argv[1]->f;
  1341. CARLA_SAFE_ASSERT_BREAK(index >= 0);
  1342. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->param.count), index, pData->param.count);
  1343. if (index < static_cast<int32_t>(pData->param.count))
  1344. pData->param.ranges[index].def = value;
  1345. break;
  1346. }
  1347. case kPluginBridgeOscCurrentProgram: {
  1348. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i");
  1349. const int32_t index = argv[0]->i;
  1350. CARLA_SAFE_ASSERT_BREAK(index >= -1);
  1351. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->prog.count), index, pData->prog.count);
  1352. CarlaPlugin::setProgram(index, false, true, true);
  1353. break;
  1354. }
  1355. case kPluginBridgeOscCurrentMidiProgram: {
  1356. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i");
  1357. const int32_t index = argv[0]->i;
  1358. CARLA_SAFE_ASSERT_BREAK(index >= -1);
  1359. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->midiprog.count), index, pData->midiprog.count);
  1360. CarlaPlugin::setMidiProgram(index, false, true, true);
  1361. break;
  1362. }
  1363. case kPluginBridgeOscProgramName: {
  1364. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "is");
  1365. const int32_t index = argv[0]->i;
  1366. const char* const name = (const char*)&argv[1]->s;
  1367. CARLA_SAFE_ASSERT_BREAK(index >= 0);
  1368. CARLA_SAFE_ASSERT_BREAK(name != nullptr);
  1369. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->prog.count), index, pData->prog.count);
  1370. if (index < static_cast<int32_t>(pData->prog.count))
  1371. {
  1372. if (pData->prog.names[index] != nullptr)
  1373. delete[] pData->prog.names[index];
  1374. pData->prog.names[index] = carla_strdup(name);
  1375. }
  1376. break;
  1377. }
  1378. case kPluginBridgeOscMidiProgramData: {
  1379. CARLA_BRIDGE_CHECK_OSC_TYPES(4, "iiis");
  1380. const int32_t index = argv[0]->i;
  1381. const int32_t bank = argv[1]->i;
  1382. const int32_t program = argv[2]->i;
  1383. const char* const name = (const char*)&argv[3]->s;
  1384. CARLA_SAFE_ASSERT_BREAK(index >= 0);
  1385. CARLA_SAFE_ASSERT_BREAK(bank >= 0);
  1386. CARLA_SAFE_ASSERT_BREAK(program >= 0);
  1387. CARLA_SAFE_ASSERT_BREAK(name != nullptr);
  1388. CARLA_SAFE_ASSERT_INT2(index < static_cast<int32_t>(pData->midiprog.count), index, pData->midiprog.count);
  1389. if (index < static_cast<int32_t>(pData->midiprog.count))
  1390. {
  1391. if (pData->midiprog.data[index].name != nullptr)
  1392. delete[] pData->midiprog.data[index].name;
  1393. pData->midiprog.data[index].bank = static_cast<uint32_t>(bank);
  1394. pData->midiprog.data[index].program = static_cast<uint32_t>(program);
  1395. pData->midiprog.data[index].name = carla_strdup(name);
  1396. }
  1397. break;
  1398. }
  1399. case kPluginBridgeOscConfigure: {
  1400. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "ss");
  1401. const char* const key = (const char*)&argv[0]->s;
  1402. const char* const value = (const char*)&argv[1]->s;
  1403. CARLA_SAFE_ASSERT_BREAK(key != nullptr);
  1404. CARLA_SAFE_ASSERT_BREAK(value != nullptr);
  1405. if (std::strcmp(key, CARLA_BRIDGE_MSG_HIDE_GUI) == 0)
  1406. pData->engine->callback(ENGINE_CALLBACK_UI_STATE_CHANGED, pData->id, 0, 0, 0.0f, nullptr);
  1407. else if (std::strcmp(key, CARLA_BRIDGE_MSG_SAVED) == 0)
  1408. fSaved = true;
  1409. break;
  1410. }
  1411. case kPluginBridgeOscSetCustomData: {
  1412. CARLA_BRIDGE_CHECK_OSC_TYPES(3, "sss");
  1413. const char* const type = (const char*)&argv[0]->s;
  1414. const char* const key = (const char*)&argv[1]->s;
  1415. const char* const value = (const char*)&argv[2]->s;
  1416. CARLA_SAFE_ASSERT_BREAK(type != nullptr);
  1417. CARLA_SAFE_ASSERT_BREAK(key != nullptr);
  1418. CARLA_SAFE_ASSERT_BREAK(value != nullptr);
  1419. CarlaPlugin::setCustomData(type, key, value, false);
  1420. break;
  1421. }
  1422. case kPluginBridgeOscSetChunkDataFile: {
  1423. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "s");
  1424. const char* const chunkFilePath = (const char*)&argv[0]->s;
  1425. CARLA_SAFE_ASSERT_BREAK(chunkFilePath != nullptr);
  1426. String realChunkFilePath(chunkFilePath);
  1427. carla_stdout("chunk save path BEFORE => %s", realChunkFilePath.toRawUTF8());
  1428. #ifndef CARLA_OS_WIN
  1429. // Using Wine, fix temp dir
  1430. if (fBinaryType == BINARY_WIN32 || fBinaryType == BINARY_WIN64)
  1431. {
  1432. // Get WINEPREFIX
  1433. String wineDir;
  1434. if (const char* const WINEPREFIX = getenv("WINEPREFIX"))
  1435. wineDir = String(WINEPREFIX);
  1436. else
  1437. wineDir = File::getSpecialLocation(File::userHomeDirectory).getFullPathName() + "/.wine";
  1438. const StringArray driveLetterSplit(StringArray::fromTokens(realChunkFilePath, ":/", ""));
  1439. realChunkFilePath = wineDir;
  1440. realChunkFilePath += "/drive_";
  1441. realChunkFilePath += driveLetterSplit[0].toLowerCase();
  1442. realChunkFilePath += "/";
  1443. realChunkFilePath += driveLetterSplit[1];
  1444. realChunkFilePath = realChunkFilePath.replace("\\", "/");
  1445. carla_stdout("chunk save path AFTER => %s", realChunkFilePath.toRawUTF8());
  1446. }
  1447. #endif
  1448. File chunkFile(realChunkFilePath);
  1449. if (chunkFile.existsAsFile())
  1450. {
  1451. fInfo.chunk = carla_getChunkFromBase64String(chunkFile.loadFileAsString().toRawUTF8());
  1452. chunkFile.deleteFile();
  1453. carla_stderr("chunk data final");
  1454. }
  1455. break;
  1456. }
  1457. case kPluginBridgeOscLatency:
  1458. // TODO
  1459. break;
  1460. case kPluginBridgeOscReady:
  1461. fInitiated = true;
  1462. break;
  1463. case kPluginBridgeOscError: {
  1464. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "s");
  1465. const char* const error = (const char*)&argv[0]->s;
  1466. CARLA_ASSERT(error != nullptr);
  1467. pData->engine->setLastError(error);
  1468. fInitError = true;
  1469. fInitiated = true;
  1470. break;
  1471. }
  1472. }
  1473. return 0;
  1474. }
  1475. // -------------------------------------------------------------------
  1476. const void* getExtraStuff() const noexcept override
  1477. {
  1478. return fBridgeBinary.isNotEmpty() ? fBridgeBinary.buffer() : nullptr;
  1479. }
  1480. bool init(const char* const filename, const char* const name, const char* const label, const char* const bridgeBinary)
  1481. {
  1482. CARLA_SAFE_ASSERT_RETURN(pData->engine != nullptr, false);
  1483. // ---------------------------------------------------------------
  1484. // first checks
  1485. if (pData->client != nullptr)
  1486. {
  1487. pData->engine->setLastError("Plugin client is already registered");
  1488. return false;
  1489. }
  1490. // ---------------------------------------------------------------
  1491. // set info
  1492. if (name != nullptr && name[0] != '\0')
  1493. pData->name = pData->engine->getUniquePluginName(name);
  1494. pData->filename = carla_strdup(filename);
  1495. if (bridgeBinary != nullptr)
  1496. fBridgeBinary = bridgeBinary;
  1497. std::srand(static_cast<uint>(std::time(nullptr)));
  1498. // ---------------------------------------------------------------
  1499. // SHM Audio Pool
  1500. {
  1501. char tmpFileBase[64];
  1502. std::sprintf(tmpFileBase, "/carla-bridge_shm_ap_XXXXXX");
  1503. fShmAudioPool.shm = shm_mkstemp(tmpFileBase);
  1504. if (! carla_is_shm_valid(fShmAudioPool.shm))
  1505. {
  1506. carla_stdout("Failed to open or create shared memory file #1");
  1507. return false;
  1508. }
  1509. fShmAudioPool.filename = tmpFileBase;
  1510. }
  1511. // ---------------------------------------------------------------
  1512. // SHM RT Control
  1513. {
  1514. char tmpFileBase[64];
  1515. std::sprintf(tmpFileBase, "/carla-bridge_shm_rt_XXXXXX");
  1516. fShmRtControl.shm = shm_mkstemp(tmpFileBase);
  1517. if (! carla_is_shm_valid(fShmRtControl.shm))
  1518. {
  1519. carla_stdout("Failed to open or create shared memory file #2");
  1520. // clear
  1521. carla_shm_close(fShmAudioPool.shm);
  1522. return false;
  1523. }
  1524. fShmRtControl.filename = tmpFileBase;
  1525. if (! fShmRtControl.mapData())
  1526. {
  1527. carla_stdout("Failed to map shared memory file #2");
  1528. // clear
  1529. carla_shm_close(fShmRtControl.shm);
  1530. carla_shm_close(fShmAudioPool.shm);
  1531. return false;
  1532. }
  1533. CARLA_SAFE_ASSERT(fShmRtControl.data != nullptr);
  1534. if (! jackbridge_sem_init(&fShmRtControl.data->sem.server))
  1535. {
  1536. carla_stdout("Failed to initialize shared memory semaphore #1");
  1537. // clear
  1538. fShmRtControl.unmapData();
  1539. carla_shm_close(fShmRtControl.shm);
  1540. carla_shm_close(fShmAudioPool.shm);
  1541. return false;
  1542. }
  1543. if (! jackbridge_sem_init(&fShmRtControl.data->sem.client))
  1544. {
  1545. carla_stdout("Failed to initialize shared memory semaphore #2");
  1546. // clear
  1547. jackbridge_sem_destroy(&fShmRtControl.data->sem.server);
  1548. fShmRtControl.unmapData();
  1549. carla_shm_close(fShmRtControl.shm);
  1550. carla_shm_close(fShmAudioPool.shm);
  1551. return false;
  1552. }
  1553. fNeedsSemDestroy = true;
  1554. }
  1555. // ---------------------------------------------------------------
  1556. // SHM Non-RT Control
  1557. {
  1558. char tmpFileBase[64];
  1559. std::sprintf(tmpFileBase, "/carla-bridge_shm_nonrt_XXXXXX");
  1560. fShmNonRtControl.shm = shm_mkstemp(tmpFileBase);
  1561. if (! carla_is_shm_valid(fShmNonRtControl.shm))
  1562. {
  1563. carla_stdout("Failed to open or create shared memory file #3");
  1564. return false;
  1565. }
  1566. fShmNonRtControl.filename = tmpFileBase;
  1567. if (! fShmNonRtControl.mapData())
  1568. {
  1569. carla_stdout("Failed to map shared memory file #3");
  1570. // clear
  1571. fShmNonRtControl.unmapData();
  1572. carla_shm_close(fShmNonRtControl.shm);
  1573. carla_shm_close(fShmRtControl.shm);
  1574. carla_shm_close(fShmAudioPool.shm);
  1575. return false;
  1576. }
  1577. }
  1578. carla_stdout("Carla Server Info:");
  1579. carla_stdout(" sizeof(BridgeRtData): " P_SIZE, sizeof(BridgeRtData));
  1580. carla_stdout(" sizeof(BridgeNonRtData): " P_SIZE, sizeof(BridgeNonRtData));
  1581. // initial values
  1582. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtNull);
  1583. fShmNonRtControl.writeInt(static_cast<int32_t>(sizeof(BridgeRtData)));
  1584. fShmNonRtControl.writeInt(static_cast<int32_t>(sizeof(BridgeNonRtData)));
  1585. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetBufferSize);
  1586. fShmNonRtControl.writeInt(static_cast<int32_t>(pData->engine->getBufferSize()));
  1587. fShmNonRtControl.writeOpcode(kPluginBridgeNonRtSetSampleRate);
  1588. fShmNonRtControl.writeDouble(pData->engine->getSampleRate());
  1589. fShmNonRtControl.commitWrite();
  1590. // register plugin now so we can receive OSC (and wait for it)
  1591. pData->hints |= PLUGIN_IS_BRIDGE;
  1592. pData->engine->registerEnginePlugin(pData->id, this);
  1593. // init OSC
  1594. {
  1595. char shmIdStr[18+1] = { 0 };
  1596. std::strncpy(shmIdStr, &fShmAudioPool.filename[fShmAudioPool.filename.length()-6], 6);
  1597. std::strncat(shmIdStr, &fShmRtControl.filename[fShmRtControl.filename.length()-6], 6);
  1598. std::strncat(shmIdStr, &fShmNonRtControl.filename[fShmNonRtControl.filename.length()-6], 6);
  1599. pData->osc.thread.setOscData(bridgeBinary, label, getPluginTypeAsString(fPluginType), shmIdStr);
  1600. pData->osc.thread.startThread();
  1601. }
  1602. fInitiated = false;
  1603. fLastPongCounter = 0;
  1604. for (; fLastPongCounter++ < 500;)
  1605. {
  1606. if (fInitiated || ! pData->osc.thread.isThreadRunning())
  1607. break;
  1608. carla_msleep(25);
  1609. pData->engine->callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  1610. pData->engine->idle();
  1611. }
  1612. fLastPongCounter = -1;
  1613. if (fInitError || ! fInitiated)
  1614. {
  1615. pData->osc.thread.stopThread(6000);
  1616. if (! fInitError)
  1617. pData->engine->setLastError("Timeout while waiting for a response from plugin-bridge\n(or the plugin crashed on initialization?)");
  1618. return false;
  1619. }
  1620. // ---------------------------------------------------------------
  1621. // register client
  1622. if (pData->name == nullptr)
  1623. {
  1624. if (name != nullptr && name[0] != '\0')
  1625. pData->name = pData->engine->getUniquePluginName(name);
  1626. else if (label != nullptr && label[0] != '\0')
  1627. pData->name = pData->engine->getUniquePluginName(label);
  1628. else
  1629. pData->name = pData->engine->getUniquePluginName("unknown");
  1630. }
  1631. pData->client = pData->engine->addClient(this);
  1632. if (pData->client == nullptr || ! pData->client->isOk())
  1633. {
  1634. pData->engine->setLastError("Failed to register plugin client");
  1635. return false;
  1636. }
  1637. return true;
  1638. }
  1639. private:
  1640. const BinaryType fBinaryType;
  1641. const PluginType fPluginType;
  1642. bool fInitiated;
  1643. bool fInitError;
  1644. bool fSaved;
  1645. bool fNeedsSemDestroy;
  1646. bool fTimedOut;
  1647. volatile int32_t fLastPongCounter;
  1648. CarlaString fBridgeBinary;
  1649. BridgeAudioPool fShmAudioPool;
  1650. BridgeRtControl fShmRtControl;
  1651. BridgeNonRtControl fShmNonRtControl;
  1652. struct Info {
  1653. uint32_t aIns, aOuts;
  1654. uint32_t mIns, mOuts;
  1655. PluginCategory category;
  1656. uint optionsAvailable;
  1657. int64_t uniqueId;
  1658. CarlaString name;
  1659. CarlaString label;
  1660. CarlaString maker;
  1661. CarlaString copyright;
  1662. std::vector<uint8_t> chunk;
  1663. Info()
  1664. : aIns(0),
  1665. aOuts(0),
  1666. mIns(0),
  1667. mOuts(0),
  1668. category(PLUGIN_CATEGORY_NONE),
  1669. optionsAvailable(0),
  1670. uniqueId(0),
  1671. name(),
  1672. label(),
  1673. maker(),
  1674. copyright(),
  1675. chunk() {}
  1676. } fInfo;
  1677. BridgeParamInfo* fParams;
  1678. void resizeAudioPool(const uint32_t bufferSize)
  1679. {
  1680. fShmAudioPool.resize(bufferSize, fInfo.aIns+fInfo.aOuts);
  1681. fShmRtControl.writeOpcode(kPluginBridgeRtSetAudioPool);
  1682. fShmRtControl.writeLong(static_cast<int64_t>(fShmAudioPool.size));
  1683. fShmRtControl.commitWrite();
  1684. waitForServer();
  1685. }
  1686. bool waitForServer(const int secs = 5)
  1687. {
  1688. CARLA_SAFE_ASSERT_RETURN(! fTimedOut, false);
  1689. if (! fShmRtControl.waitForServer(secs))
  1690. {
  1691. carla_stderr("waitForServer() timeout here");
  1692. fTimedOut = true;
  1693. return false;
  1694. }
  1695. return true;
  1696. }
  1697. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(BridgePlugin)
  1698. };
  1699. CARLA_BACKEND_END_NAMESPACE
  1700. #endif // ! BUILD_BRIDGE
  1701. // -------------------------------------------------------------------------------------------------------------------
  1702. CARLA_BACKEND_START_NAMESPACE
  1703. CarlaPlugin* CarlaPlugin::newBridge(const Initializer& init, BinaryType btype, PluginType ptype, const char* const bridgeBinary)
  1704. {
  1705. carla_debug("CarlaPlugin::newBridge({%p, \"%s\", \"%s\", \"%s\"}, %s, %s, \"%s\")", init.engine, init.filename, init.name, init.label, BinaryType2Str(btype), PluginType2Str(ptype), bridgeBinary);
  1706. #ifndef BUILD_BRIDGE
  1707. if (bridgeBinary == nullptr || bridgeBinary[0] == '\0')
  1708. {
  1709. init.engine->setLastError("Bridge not possible, bridge-binary not found");
  1710. return nullptr;
  1711. }
  1712. BridgePlugin* const plugin(new BridgePlugin(init.engine, init.id, btype, ptype));
  1713. if (! plugin->init(init.filename, init.name, init.label, bridgeBinary))
  1714. {
  1715. init.engine->registerEnginePlugin(init.id, nullptr);
  1716. delete plugin;
  1717. return nullptr;
  1718. }
  1719. plugin->reload();
  1720. if (init.engine->getProccessMode() == ENGINE_PROCESS_MODE_CONTINUOUS_RACK && ! plugin->canRunInRack())
  1721. {
  1722. init.engine->setLastError("Carla's rack mode can only work with Stereo Bridged plugins, sorry!");
  1723. delete plugin;
  1724. return nullptr;
  1725. }
  1726. return plugin;
  1727. #else
  1728. init.engine->setLastError("Plugin bridge support not available");
  1729. return nullptr;
  1730. // unused
  1731. (void)bridgeBinary;
  1732. #endif
  1733. }
  1734. #ifndef BUILD_BRIDGE
  1735. // -------------------------------------------------------------------------------------------------------------------
  1736. // Bridge Helper
  1737. #define bridgePlugin ((BridgePlugin*)plugin)
  1738. extern int CarlaPluginSetOscBridgeInfo(CarlaPlugin* const plugin, const PluginBridgeOscInfoType type,
  1739. const int argc, const lo_arg* const* const argv, const char* const types);
  1740. int CarlaPluginSetOscBridgeInfo(CarlaPlugin* const plugin, const PluginBridgeOscInfoType type,
  1741. const int argc, const lo_arg* const* const argv, const char* const types)
  1742. {
  1743. CARLA_SAFE_ASSERT(plugin != nullptr && (plugin->getHints() & PLUGIN_IS_BRIDGE) != 0);
  1744. return bridgePlugin->setOscPluginBridgeInfo(type, argc, argv, types);
  1745. }
  1746. #undef bridgePlugin
  1747. #endif
  1748. CARLA_BACKEND_END_NAMESPACE
  1749. // -------------------------------------------------------------------------------------------------------------------