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.

2321 lines
78KB

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