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.

1869 lines
61KB

  1. /*
  2. * Carla Bridge Plugin
  3. * Copyright (C) 2011-2013 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 GPL.txt file
  16. */
  17. #include "CarlaPluginInternal.hpp"
  18. #ifndef BUILD_BRIDGE
  19. #include "CarlaBridgeUtils.hpp"
  20. #include "CarlaShmUtils.hpp"
  21. #include "jackbridge/JackBridge.hpp"
  22. #include <cerrno>
  23. #include <cmath>
  24. #include <ctime>
  25. #include <QtCore/QDir>
  26. #include <QtCore/QFile>
  27. #include <QtCore/QStringList>
  28. #include <QtCore/QTextStream>
  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. CARLA_BACKEND_START_NAMESPACE
  52. // -------------------------------------------------------------------------------------------------------------------
  53. // Engine Helpers
  54. extern void registerEnginePlugin(CarlaEngine* const engine, const unsigned int id, CarlaPlugin* const plugin);
  55. // -------------------------------------------------------------------------------------------------------------------
  56. shm_t shm_mkstemp(char* const fileBase)
  57. {
  58. static const char charSet[] = "abcdefghijklmnopqrstuvwxyz"
  59. "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  60. "0123456789";
  61. const int size = (fileBase != nullptr) ? std::strlen(fileBase) : 0;
  62. shm_t shm;
  63. carla_shm_init(shm);
  64. if (size < 6)
  65. {
  66. errno = EINVAL;
  67. return shm;
  68. }
  69. if (std::strcmp(fileBase + size - 6, "XXXXXX") != 0)
  70. {
  71. errno = EINVAL;
  72. return shm;
  73. }
  74. while (true)
  75. {
  76. for (int c = size - 6; c < size; ++c)
  77. {
  78. // Note the -1 to avoid the trailing '\0' in charSet.
  79. fileBase[c] = charSet[std::rand() % (sizeof(charSet) - 1)];
  80. }
  81. shm_t shm = carla_shm_create(fileBase);
  82. if (carla_is_shm_valid(shm) || errno != EEXIST)
  83. return shm;
  84. }
  85. }
  86. // -------------------------------------------------------------------------------------------------------------------
  87. struct BridgeParamInfo {
  88. float value;
  89. CarlaString name;
  90. CarlaString unit;
  91. BridgeParamInfo()
  92. : value(0.0f) {}
  93. CARLA_DECLARE_NON_COPY_STRUCT_WITH_LEAK_DETECTOR(BridgeParamInfo)
  94. };
  95. class BridgePlugin : public CarlaPlugin
  96. {
  97. public:
  98. BridgePlugin(CarlaEngine* const engine, const unsigned int id, const BinaryType btype, const PluginType ptype)
  99. : CarlaPlugin(engine, id),
  100. fBinaryType(btype),
  101. fPluginType(ptype),
  102. fInitiated(false),
  103. fInitError(false),
  104. fSaved(false),
  105. fParams(nullptr)
  106. {
  107. carla_debug("BridgePlugin::BridgePlugin(%p, %i, %s, %s)", engine, id, BinaryType2Str(btype), PluginType2Str(ptype));
  108. kData->osc.thread.setMode(CarlaPluginThread::PLUGIN_THREAD_BRIDGE);
  109. fHints |= PLUGIN_IS_BRIDGE;
  110. }
  111. ~BridgePlugin() override
  112. {
  113. carla_debug("BridgePlugin::~BridgePlugin()");
  114. kData->singleMutex.lock();
  115. kData->masterMutex.lock();
  116. if (kData->active)
  117. {
  118. deactivate();
  119. kData->active = false;
  120. }
  121. if (kData->osc.thread.isRunning())
  122. {
  123. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeQuit);
  124. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  125. waitForServer();
  126. }
  127. if (kData->osc.data.target != nullptr)
  128. {
  129. osc_send_hide(&kData->osc.data);
  130. osc_send_quit(&kData->osc.data);
  131. }
  132. kData->osc.data.free();
  133. // Wait a bit first, then force kill
  134. if (kData->osc.thread.isRunning() && ! kData->osc.thread.wait(kData->engine->getOptions().oscUiTimeout))
  135. {
  136. carla_stderr("Failed to properly stop Plugin Bridge thread");
  137. kData->osc.thread.terminate();
  138. }
  139. cleanup();
  140. clearBuffers();
  141. //info.chunk.clear();
  142. }
  143. // -------------------------------------------------------------------
  144. // Information (base)
  145. BinaryType binaryType() const
  146. {
  147. return fBinaryType;
  148. }
  149. PluginType type() const override
  150. {
  151. return fPluginType;
  152. }
  153. PluginCategory category() override
  154. {
  155. return fInfo.category;
  156. }
  157. long uniqueId() const override
  158. {
  159. return fInfo.uniqueId;
  160. }
  161. // -------------------------------------------------------------------
  162. // Information (count)
  163. uint32_t midiInCount() const override
  164. {
  165. return fInfo.mIns;
  166. }
  167. uint32_t midiOutCount() const override
  168. {
  169. return fInfo.mOuts;
  170. }
  171. // -------------------------------------------------------------------
  172. // Information (current data)
  173. int32_t chunkData(void** const dataPtr) override
  174. {
  175. CARLA_ASSERT(fOptions & PLUGIN_OPTION_USE_CHUNKS);
  176. CARLA_ASSERT(dataPtr != nullptr);
  177. #if 0
  178. if (! info.chunk.isEmpty())
  179. {
  180. *dataPtr = info.chunk.data();
  181. return info.chunk.size();
  182. }
  183. #endif
  184. return 0;
  185. }
  186. // -------------------------------------------------------------------
  187. // Information (per-plugin data)
  188. unsigned int availableOptions() override
  189. {
  190. unsigned int options = 0x0;
  191. options |= PLUGIN_OPTION_MAP_PROGRAM_CHANGES;
  192. options |= PLUGIN_OPTION_USE_CHUNKS;
  193. options |= PLUGIN_OPTION_SEND_CONTROL_CHANGES;
  194. options |= PLUGIN_OPTION_SEND_CHANNEL_PRESSURE;
  195. options |= PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH;
  196. options |= PLUGIN_OPTION_SEND_PITCHBEND;
  197. options |= PLUGIN_OPTION_SEND_ALL_SOUND_OFF;
  198. return options;
  199. }
  200. float getParameterValue(const uint32_t parameterId) override
  201. {
  202. CARLA_ASSERT(parameterId < kData->param.count);
  203. return fParams[parameterId].value;
  204. }
  205. void getLabel(char* const strBuf) override
  206. {
  207. std::strncpy(strBuf, (const char*)fInfo.label, STR_MAX);
  208. }
  209. void getMaker(char* const strBuf) override
  210. {
  211. std::strncpy(strBuf, (const char*)fInfo.maker, STR_MAX);
  212. }
  213. void getCopyright(char* const strBuf) override
  214. {
  215. std::strncpy(strBuf, (const char*)fInfo.copyright, STR_MAX);
  216. }
  217. void getRealName(char* const strBuf) override
  218. {
  219. std::strncpy(strBuf, (const char*)fInfo.name, STR_MAX);
  220. }
  221. void getParameterName(const uint32_t parameterId, char* const strBuf) override
  222. {
  223. CARLA_ASSERT(parameterId < kData->param.count);
  224. std::strncpy(strBuf, (const char*)fParams[parameterId].name, STR_MAX);
  225. }
  226. void getParameterUnit(const uint32_t parameterId, char* const strBuf) override
  227. {
  228. CARLA_ASSERT(parameterId < kData->param.count);
  229. std::strncpy(strBuf, (const char*)fParams[parameterId].unit, STR_MAX);
  230. }
  231. // -------------------------------------------------------------------
  232. // Set data (state)
  233. void prepareForSave() override
  234. {
  235. #if 0
  236. m_saved = false;
  237. osc_send_configure(&osc.data, CARLA_BRIDGE_MSG_SAVE_NOW, "");
  238. for (int i=0; i < 200; ++i)
  239. {
  240. if (m_saved)
  241. break;
  242. carla_msleep(50);
  243. }
  244. if (! m_saved)
  245. carla_stderr("BridgePlugin::prepareForSave() - Timeout while requesting save state");
  246. else
  247. carla_debug("BridgePlugin::prepareForSave() - success!");
  248. #endif
  249. }
  250. // -------------------------------------------------------------------
  251. // Set data (internal stuff)
  252. // nothing
  253. // -------------------------------------------------------------------
  254. // Set data (plugin-specific stuff)
  255. void setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback) override
  256. {
  257. CARLA_ASSERT(parameterId < kData->param.count);
  258. const float fixedValue(kData->param.fixValue(parameterId, value));
  259. fParams[parameterId].value = fixedValue;
  260. const bool doLock(sendGui || sendOsc || sendCallback);
  261. if (doLock)
  262. kData->singleMutex.lock();
  263. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetParameter);
  264. rdwr_writeInt(&fShmControl.data->ringBuffer, parameterId);
  265. rdwr_writeFloat(&fShmControl.data->ringBuffer, value);
  266. if (doLock)
  267. {
  268. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  269. kData->singleMutex.unlock();
  270. }
  271. CarlaPlugin::setParameterValue(parameterId, fixedValue, sendGui, sendOsc, sendCallback);
  272. }
  273. void setProgram(int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) override
  274. {
  275. CARLA_ASSERT(index >= -1 && index < static_cast<int32_t>(kData->prog.count));
  276. if (index < -1)
  277. index = -1;
  278. else if (index > static_cast<int32_t>(kData->prog.count))
  279. return;
  280. const bool doLock(sendGui || sendOsc || sendCallback);
  281. if (doLock)
  282. kData->singleMutex.lock();
  283. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetProgram);
  284. rdwr_writeInt(&fShmControl.data->ringBuffer, index);
  285. if (doLock)
  286. {
  287. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  288. kData->singleMutex.unlock();
  289. }
  290. CarlaPlugin::setProgram(index, sendGui, sendOsc, sendCallback);
  291. }
  292. void setMidiProgram(int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback) override
  293. {
  294. CARLA_ASSERT(index >= -1 && index < static_cast<int32_t>(kData->midiprog.count));
  295. if (index < -1)
  296. index = -1;
  297. else if (index > static_cast<int32_t>(kData->midiprog.count))
  298. return;
  299. const bool doLock(sendGui || sendOsc || sendCallback);
  300. if (doLock)
  301. kData->singleMutex.lock();
  302. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetMidiProgram);
  303. rdwr_writeInt(&fShmControl.data->ringBuffer, index);
  304. if (doLock)
  305. {
  306. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  307. kData->singleMutex.unlock();
  308. }
  309. CarlaPlugin::setMidiProgram(index, sendGui, sendOsc, sendCallback);
  310. }
  311. #if 0
  312. void setCustomData(const char* const type, const char* const key, const char* const value, const bool sendGui) override
  313. {
  314. CARLA_ASSERT(type);
  315. CARLA_ASSERT(key);
  316. CARLA_ASSERT(value);
  317. if (sendGui)
  318. {
  319. // TODO - if type is chunk|binary, store it in a file and send path instead
  320. QString cData;
  321. cData = type;
  322. cData += "·";
  323. cData += key;
  324. cData += "·";
  325. cData += value;
  326. osc_send_configure(&osc.data, CARLA_BRIDGE_MSG_SET_CUSTOM, cData.toUtf8().constData());
  327. }
  328. CarlaPlugin::setCustomData(type, key, value, sendGui);
  329. }
  330. void setChunkData(const char* const stringData) override
  331. {
  332. CARLA_ASSERT(m_hints & PLUGIN_USES_CHUNKS);
  333. CARLA_ASSERT(stringData);
  334. QString filePath;
  335. filePath = QDir::tempPath();
  336. filePath += "/.CarlaChunk_";
  337. filePath += m_name;
  338. filePath = QDir::toNativeSeparators(filePath);
  339. QFile file(filePath);
  340. if (file.open(QIODevice::WriteOnly | QIODevice::Text))
  341. {
  342. QTextStream out(&file);
  343. out << stringData;
  344. file.close();
  345. osc_send_configure(&osc.data, CARLA_BRIDGE_MSG_SET_CHUNK, filePath.toUtf8().constData());
  346. }
  347. }
  348. #endif
  349. // -------------------------------------------------------------------
  350. // Set gui stuff
  351. void showGui(const bool yesNo) override
  352. {
  353. if (yesNo)
  354. osc_send_show(&kData->osc.data);
  355. else
  356. osc_send_hide(&kData->osc.data);
  357. }
  358. void idleGui() override
  359. {
  360. if (! kData->osc.thread.isRunning())
  361. carla_stderr2("TESTING: Bridge has closed!");
  362. CarlaPlugin::idleGui();
  363. }
  364. // -------------------------------------------------------------------
  365. // Plugin state
  366. void reload() override
  367. {
  368. carla_debug("BridgePlugin::reload() - start");
  369. CARLA_ASSERT(kData->engine != nullptr);
  370. if (kData->engine == nullptr)
  371. return;
  372. const ProcessMode processMode(kData->engine->getProccessMode());
  373. // Safely disable plugin for reload
  374. const ScopedDisabler sd(this);
  375. bool needsCtrlIn, needsCtrlOut;
  376. needsCtrlIn = needsCtrlOut = false;
  377. if (fInfo.aIns > 0)
  378. {
  379. kData->audioIn.createNew(fInfo.aIns);
  380. }
  381. if (fInfo.aOuts > 0)
  382. {
  383. kData->audioOut.createNew(fInfo.aOuts);
  384. needsCtrlIn = true;
  385. }
  386. if (fInfo.mIns > 0)
  387. needsCtrlIn = true;
  388. if (fInfo.mOuts > 0)
  389. needsCtrlOut = true;
  390. const uint portNameSize(kData->engine->maxPortNameSize());
  391. CarlaString portName;
  392. // Audio Ins
  393. for (uint32_t j=0; j < fInfo.aIns; ++j)
  394. {
  395. portName.clear();
  396. if (processMode == PROCESS_MODE_SINGLE_CLIENT)
  397. {
  398. portName = fName;
  399. portName += ":";
  400. }
  401. if (fInfo.aIns > 1)
  402. {
  403. portName += "input_";
  404. portName += CarlaString(j+1);
  405. }
  406. else
  407. portName += "input";
  408. portName.truncate(portNameSize);
  409. kData->audioIn.ports[j].port = (CarlaEngineAudioPort*)kData->client->addPort(kEnginePortTypeAudio, portName, true);
  410. kData->audioIn.ports[j].rindex = j;
  411. }
  412. // Audio Outs
  413. for (uint32_t j=0; j < fInfo.aOuts; ++j)
  414. {
  415. portName.clear();
  416. if (processMode == PROCESS_MODE_SINGLE_CLIENT)
  417. {
  418. portName = fName;
  419. portName += ":";
  420. }
  421. if (fInfo.aOuts > 1)
  422. {
  423. portName += "output_";
  424. portName += CarlaString(j+1);
  425. }
  426. else
  427. portName += "output";
  428. portName.truncate(portNameSize);
  429. kData->audioOut.ports[j].port = (CarlaEngineAudioPort*)kData->client->addPort(kEnginePortTypeAudio, portName, false);
  430. kData->audioOut.ports[j].rindex = j;
  431. }
  432. if (needsCtrlIn)
  433. {
  434. portName.clear();
  435. if (processMode == PROCESS_MODE_SINGLE_CLIENT)
  436. {
  437. portName = fName;
  438. portName += ":";
  439. }
  440. portName += "event-in";
  441. portName.truncate(portNameSize);
  442. kData->event.portIn = (CarlaEngineEventPort*)kData->client->addPort(kEnginePortTypeEvent, portName, true);
  443. }
  444. if (needsCtrlOut)
  445. {
  446. portName.clear();
  447. if (processMode == PROCESS_MODE_SINGLE_CLIENT)
  448. {
  449. portName = fName;
  450. portName += ":";
  451. }
  452. portName += "event-out";
  453. portName.truncate(portNameSize);
  454. kData->event.portOut = (CarlaEngineEventPort*)kData->client->addPort(kEnginePortTypeEvent, portName, false);
  455. }
  456. bufferSizeChanged(kData->engine->getBufferSize());
  457. reloadPrograms(true);
  458. carla_debug("BridgePlugin::reload() - end");
  459. }
  460. // -------------------------------------------------------------------
  461. // Plugin processing
  462. void activate() override
  463. {
  464. // already locked before
  465. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetParameter);
  466. rdwr_writeInt(&fShmControl.data->ringBuffer, PARAMETER_ACTIVE);
  467. rdwr_writeFloat(&fShmControl.data->ringBuffer, 1.0f);
  468. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  469. waitForServer();
  470. }
  471. void deactivate() override
  472. {
  473. // already locked before
  474. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetParameter);
  475. rdwr_writeInt(&fShmControl.data->ringBuffer, PARAMETER_ACTIVE);
  476. rdwr_writeFloat(&fShmControl.data->ringBuffer, 0.0f);
  477. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  478. waitForServer();
  479. }
  480. void process(float** const inBuffer, float** const outBuffer, const uint32_t frames) override
  481. {
  482. uint32_t i, k;
  483. // --------------------------------------------------------------------------------------------------------
  484. // Check if active
  485. if (! kData->active)
  486. {
  487. // disable any output sound
  488. for (i=0; i < kData->audioOut.count; ++i)
  489. carla_zeroFloat(outBuffer[i], frames);
  490. return;
  491. }
  492. // --------------------------------------------------------------------------------------------------------
  493. // Check if needs reset
  494. if (kData->needsReset)
  495. {
  496. // TODO
  497. kData->needsReset = false;
  498. }
  499. // --------------------------------------------------------------------------------------------------------
  500. // Event Input
  501. if (kData->event.portIn != nullptr)
  502. {
  503. // ----------------------------------------------------------------------------------------------------
  504. // MIDI Input (External)
  505. if (kData->extNotes.mutex.tryLock())
  506. {
  507. while (! kData->extNotes.data.isEmpty())
  508. {
  509. const ExternalMidiNote& note(kData->extNotes.data.getFirst(true));
  510. CARLA_ASSERT(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS);
  511. char data1, data2, data3;
  512. data1 = (note.velo > 0) ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF;
  513. data1 += note.channel;
  514. data2 = note.note;
  515. data3 = note.velo;
  516. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeMidiEvent);
  517. rdwr_writeLong(&fShmControl.data->ringBuffer, 0);
  518. rdwr_writeInt(&fShmControl.data->ringBuffer, 3);
  519. rdwr_writeChar(&fShmControl.data->ringBuffer, data1);
  520. rdwr_writeChar(&fShmControl.data->ringBuffer, data2);
  521. rdwr_writeChar(&fShmControl.data->ringBuffer, data3);
  522. }
  523. kData->extNotes.mutex.unlock();
  524. } // End of MIDI Input (External)
  525. // ----------------------------------------------------------------------------------------------------
  526. // Event Input (System)
  527. bool allNotesOffSent = false;
  528. uint32_t nEvents = kData->event.portIn->getEventCount();
  529. uint32_t nextBankId = 0;
  530. if (kData->midiprog.current >= 0 && kData->midiprog.count > 0)
  531. nextBankId = kData->midiprog.data[kData->midiprog.current].bank;
  532. for (i=0; i < nEvents; ++i)
  533. {
  534. const EngineEvent& event(kData->event.portIn->getEvent(i));
  535. // Control change
  536. switch (event.type)
  537. {
  538. case kEngineEventTypeNull:
  539. break;
  540. case kEngineEventTypeControl:
  541. {
  542. const EngineControlEvent& ctrlEvent = event.ctrl;
  543. switch (ctrlEvent.type)
  544. {
  545. case kEngineControlEventTypeNull:
  546. break;
  547. case kEngineControlEventTypeParameter:
  548. {
  549. // Control backend stuff
  550. if (event.channel == kData->ctrlChannel)
  551. {
  552. float value;
  553. if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (fHints & PLUGIN_CAN_DRYWET) > 0)
  554. {
  555. value = ctrlEvent.value;
  556. setDryWet(value, false, false);
  557. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_DRYWET, 0, value);
  558. }
  559. if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (fHints & PLUGIN_CAN_VOLUME) > 0)
  560. {
  561. value = ctrlEvent.value*127.0f/100.0f;
  562. setVolume(value, false, false);
  563. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_VOLUME, 0, value);
  564. }
  565. if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (fHints & PLUGIN_CAN_BALANCE) > 0)
  566. {
  567. float left, right;
  568. value = ctrlEvent.value/0.5f - 1.0f;
  569. if (value < 0.0f)
  570. {
  571. left = -1.0f;
  572. right = (value*2.0f)+1.0f;
  573. }
  574. else if (value > 0.0f)
  575. {
  576. left = (value*2.0f)-1.0f;
  577. right = 1.0f;
  578. }
  579. else
  580. {
  581. left = -1.0f;
  582. right = 1.0f;
  583. }
  584. setBalanceLeft(left, false, false);
  585. setBalanceRight(right, false, false);
  586. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_LEFT, 0, left);
  587. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_RIGHT, 0, right);
  588. }
  589. }
  590. // Control plugin parameters
  591. for (k=0; k < kData->param.count; ++k)
  592. {
  593. if (kData->param.data[k].midiChannel != event.channel)
  594. continue;
  595. if (kData->param.data[k].midiCC != ctrlEvent.param)
  596. continue;
  597. if (kData->param.data[k].type != PARAMETER_INPUT)
  598. continue;
  599. if ((kData->param.data[k].hints & PARAMETER_IS_AUTOMABLE) == 0)
  600. continue;
  601. float value;
  602. if (kData->param.data[k].hints & PARAMETER_IS_BOOLEAN)
  603. {
  604. value = (ctrlEvent.value < 0.5f) ? kData->param.ranges[k].min : kData->param.ranges[k].max;
  605. }
  606. else
  607. {
  608. value = kData->param.ranges[i].unnormalizeValue(ctrlEvent.value);
  609. if (kData->param.data[k].hints & PARAMETER_IS_INTEGER)
  610. value = std::rint(value);
  611. }
  612. setParameterValue(k, value, false, false, false);
  613. postponeRtEvent(kPluginPostRtEventParameterChange, static_cast<int32_t>(k), 0, value);
  614. }
  615. if ((fOptions & PLUGIN_OPTION_SEND_CONTROL_CHANGES) != 0 && ctrlEvent.param <= 0x5F)
  616. {
  617. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeMidiEvent);
  618. rdwr_writeLong(&fShmControl.data->ringBuffer, event.time);
  619. rdwr_writeInt(&fShmControl.data->ringBuffer, 3);
  620. rdwr_writeChar(&fShmControl.data->ringBuffer, MIDI_STATUS_CONTROL_CHANGE + event.channel);
  621. rdwr_writeChar(&fShmControl.data->ringBuffer, ctrlEvent.param);
  622. rdwr_writeChar(&fShmControl.data->ringBuffer, ctrlEvent.value*127.0f);
  623. }
  624. break;
  625. }
  626. case kEngineControlEventTypeMidiBank:
  627. if (event.channel == kData->ctrlChannel && (fOptions & PLUGIN_OPTION_MAP_PROGRAM_CHANGES) != 0)
  628. nextBankId = ctrlEvent.param;
  629. break;
  630. case kEngineControlEventTypeMidiProgram:
  631. if (event.channel == kData->ctrlChannel && (fOptions & PLUGIN_OPTION_MAP_PROGRAM_CHANGES) != 0)
  632. {
  633. const uint32_t nextProgramId(ctrlEvent.param);
  634. if (kData->midiprog.count > 0)
  635. {
  636. for (k=0; k < kData->midiprog.count; ++k)
  637. {
  638. if (kData->midiprog.data[k].bank == nextBankId && kData->midiprog.data[k].program == nextProgramId)
  639. {
  640. setMidiProgram(k, false, false, false);
  641. postponeRtEvent(kPluginPostRtEventMidiProgramChange, k, 0, 0.0f);
  642. break;
  643. }
  644. }
  645. }
  646. else
  647. {
  648. }
  649. }
  650. break;
  651. case kEngineControlEventTypeAllSoundOff:
  652. if (fOptions & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  653. {
  654. // TODO
  655. }
  656. break;
  657. case kEngineControlEventTypeAllNotesOff:
  658. if (fOptions & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  659. {
  660. if (event.channel == kData->ctrlChannel && ! allNotesOffSent)
  661. {
  662. allNotesOffSent = true;
  663. sendMidiAllNotesOffToCallback();
  664. }
  665. // TODO
  666. }
  667. break;
  668. }
  669. break;
  670. }
  671. case kEngineEventTypeMidi:
  672. {
  673. const EngineMidiEvent& midiEvent(event.midi);
  674. uint8_t status = MIDI_GET_STATUS_FROM_DATA(midiEvent.data);
  675. uint8_t channel = event.channel;
  676. if (MIDI_IS_STATUS_AFTERTOUCH(status) && (fOptions & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0)
  677. continue;
  678. if (MIDI_IS_STATUS_CONTROL_CHANGE(status) && (fOptions & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0)
  679. continue;
  680. if (MIDI_IS_STATUS_POLYPHONIC_AFTERTOUCH(status) && (fOptions & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0)
  681. continue;
  682. if (MIDI_IS_STATUS_PITCH_WHEEL_CONTROL(status) && (fOptions & PLUGIN_OPTION_SEND_PITCHBEND) == 0)
  683. continue;
  684. // Fix bad note-off
  685. if (status == MIDI_STATUS_NOTE_ON && midiEvent.data[2] == 0)
  686. status -= 0x10;
  687. char data[4];
  688. data[0] = status + channel;
  689. data[1] = midiEvent.data[1];
  690. data[2] = midiEvent.data[2];
  691. data[3] = midiEvent.data[3];
  692. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeMidiEvent);
  693. rdwr_writeLong(&fShmControl.data->ringBuffer, event.time);
  694. rdwr_writeInt(&fShmControl.data->ringBuffer, midiEvent.size);
  695. for (uint8_t j=0; j < midiEvent.size && j < 4; ++j)
  696. rdwr_writeChar(&fShmControl.data->ringBuffer, data[j]);
  697. if (status == MIDI_STATUS_NOTE_ON)
  698. postponeRtEvent(kPluginPostRtEventNoteOn, channel, midiEvent.data[1], midiEvent.data[2]);
  699. else if (status == MIDI_STATUS_NOTE_OFF)
  700. postponeRtEvent(kPluginPostRtEventNoteOff, channel, midiEvent.data[1], 0.0f);
  701. break;
  702. }
  703. }
  704. }
  705. kData->postRtEvents.trySplice();
  706. } // End of Event Input
  707. processSingle(inBuffer, outBuffer, frames);
  708. }
  709. bool processSingle(float** const inBuffer, float** const outBuffer, const uint32_t frames)
  710. {
  711. CARLA_ASSERT(frames > 0);
  712. if (frames == 0)
  713. return false;
  714. if (kData->audioIn.count > 0)
  715. {
  716. CARLA_ASSERT(inBuffer != nullptr);
  717. if (inBuffer == nullptr)
  718. return false;
  719. }
  720. if (kData->audioOut.count > 0)
  721. {
  722. CARLA_ASSERT(outBuffer != nullptr);
  723. if (outBuffer == nullptr)
  724. return false;
  725. }
  726. uint32_t i, k;
  727. // --------------------------------------------------------------------------------------------------------
  728. // Try lock, silence otherwise
  729. if (kData->engine->isOffline())
  730. {
  731. kData->singleMutex.lock();
  732. }
  733. else if (! kData->singleMutex.tryLock())
  734. {
  735. for (i=0; i < kData->audioOut.count; ++i)
  736. carla_zeroFloat(outBuffer[i], frames);
  737. return false;
  738. }
  739. // --------------------------------------------------------------------------------------------------------
  740. // Reset audio buffers
  741. for (i=0; i < fInfo.aIns; ++i)
  742. carla_copyFloat(fShmAudioPool.data + (i * frames), inBuffer[i], frames);
  743. // --------------------------------------------------------------------------------------------------------
  744. // Run plugin
  745. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeProcess);
  746. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  747. if (! waitForServer())
  748. {
  749. kData->singleMutex.unlock();
  750. return true;
  751. }
  752. for (i=0; i < fInfo.aOuts; ++i)
  753. carla_copyFloat(outBuffer[i], fShmAudioPool.data + ((i + fInfo.aIns) * frames), frames);
  754. // --------------------------------------------------------------------------------------------------------
  755. // Post-processing (dry/wet, volume and balance)
  756. {
  757. const bool doVolume = (fHints & PLUGIN_CAN_VOLUME) != 0 && kData->postProc.volume != 1.0f;
  758. const bool doDryWet = (fHints & PLUGIN_CAN_DRYWET) != 0 && kData->postProc.dryWet != 1.0f;
  759. const bool doBalance = (fHints & PLUGIN_CAN_BALANCE) != 0 && (kData->postProc.balanceLeft != -1.0f || kData->postProc.balanceRight != 1.0f);
  760. bool isPair;
  761. float bufValue, oldBufLeft[doBalance ? frames : 1];
  762. for (i=0; i < kData->audioOut.count; ++i)
  763. {
  764. // Dry/Wet
  765. if (doDryWet)
  766. {
  767. for (k=0; k < frames; ++k)
  768. {
  769. bufValue = inBuffer[(kData->audioIn.count == 1) ? 0 : i][k];
  770. outBuffer[i][k] = (outBuffer[i][k] * kData->postProc.dryWet) + (bufValue * (1.0f - kData->postProc.dryWet));
  771. }
  772. }
  773. // Balance
  774. if (doBalance)
  775. {
  776. isPair = (i % 2 == 0);
  777. if (isPair)
  778. {
  779. CARLA_ASSERT(i+1 < kData->audioOut.count);
  780. carla_copyFloat(oldBufLeft, outBuffer[i], frames);
  781. }
  782. float balRangeL = (kData->postProc.balanceLeft + 1.0f)/2.0f;
  783. float balRangeR = (kData->postProc.balanceRight + 1.0f)/2.0f;
  784. for (k=0; k < frames; ++k)
  785. {
  786. if (isPair)
  787. {
  788. // left
  789. outBuffer[i][k] = oldBufLeft[k] * (1.0f - balRangeL);
  790. outBuffer[i][k] += outBuffer[i+1][k] * (1.0f - balRangeR);
  791. }
  792. else
  793. {
  794. // right
  795. outBuffer[i][k] = outBuffer[i][k] * balRangeR;
  796. outBuffer[i][k] += oldBufLeft[k] * balRangeL;
  797. }
  798. }
  799. }
  800. // Volume
  801. if (doVolume)
  802. {
  803. for (k=0; k < frames; ++k)
  804. outBuffer[i][k] *= kData->postProc.volume;
  805. }
  806. }
  807. } // End of Post-processing
  808. // --------------------------------------------------------------------------------------------------------
  809. kData->singleMutex.unlock();
  810. return true;
  811. }
  812. void bufferSizeChanged(const uint32_t newBufferSize) override
  813. {
  814. resizeAudioPool(newBufferSize);
  815. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetBufferSize);
  816. rdwr_writeInt(&fShmControl.data->ringBuffer, newBufferSize);
  817. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  818. }
  819. void sampleRateChanged(const double newSampleRate) override
  820. {
  821. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetSampleRate);
  822. rdwr_writeFloat(&fShmControl.data->ringBuffer, newSampleRate);
  823. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  824. }
  825. // -------------------------------------------------------------------
  826. // Plugin buffers
  827. void clearBuffers() override
  828. {
  829. if (fParams != nullptr)
  830. {
  831. delete[] fParams;
  832. fParams = nullptr;
  833. }
  834. CarlaPlugin::clearBuffers();
  835. }
  836. // -------------------------------------------------------------------
  837. // Post-poned UI Stuff
  838. // nothing
  839. // -------------------------------------------------------------------
  840. int setOscPluginBridgeInfo(const PluginBridgeInfoType type, const int argc, const lo_arg* const* const argv, const char* const types)
  841. {
  842. carla_debug("setOscPluginBridgeInfo(%s, %i, %p, \"%s\")", PluginBridgeInfoType2str(type), argc, argv, types);
  843. switch (type)
  844. {
  845. case kPluginBridgeAudioCount:
  846. {
  847. CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iii");
  848. const int32_t aIns = argv[0]->i;
  849. const int32_t aOuts = argv[1]->i;
  850. const int32_t aTotal = argv[2]->i;
  851. CARLA_ASSERT(aIns >= 0);
  852. CARLA_ASSERT(aOuts >= 0);
  853. CARLA_ASSERT(aIns + aOuts == aTotal);
  854. fInfo.aIns = aIns;
  855. fInfo.aOuts = aOuts;
  856. break;
  857. // unused
  858. (void)aTotal;
  859. }
  860. case kPluginBridgeMidiCount:
  861. {
  862. CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iii");
  863. const int32_t mIns = argv[0]->i;
  864. const int32_t mOuts = argv[1]->i;
  865. const int32_t mTotal = argv[2]->i;
  866. CARLA_ASSERT(mIns >= 0);
  867. CARLA_ASSERT(mOuts >= 0);
  868. CARLA_ASSERT(mIns + mOuts == mTotal);
  869. fInfo.mIns = mIns;
  870. fInfo.mOuts = mOuts;
  871. break;
  872. // unused
  873. (void)mTotal;
  874. }
  875. case kPluginBridgeParameterCount:
  876. {
  877. CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iii");
  878. const int32_t pIns = argv[0]->i;
  879. const int32_t pOuts = argv[1]->i;
  880. const int32_t pTotal = argv[2]->i;
  881. CARLA_ASSERT(pIns >= 0);
  882. CARLA_ASSERT(pOuts >= 0);
  883. CARLA_ASSERT(pIns + pOuts <= pTotal);
  884. // delete old data
  885. kData->param.clear();
  886. if (fParams != nullptr)
  887. {
  888. delete[] fParams;
  889. fParams = nullptr;
  890. }
  891. CARLA_SAFE_ASSERT_INT2(pTotal < static_cast<int32_t>(kData->engine->getOptions().maxParameters), pTotal, kData->engine->getOptions().maxParameters);
  892. const int32_t count(carla_min<int32_t>(pTotal, kData->engine->getOptions().maxParameters, 0));
  893. if (count > 0)
  894. {
  895. kData->param.createNew(count);
  896. fParams = new BridgeParamInfo[count];
  897. }
  898. break;
  899. // unused
  900. (void)pIns;
  901. (void)pOuts;
  902. }
  903. case kPluginBridgeProgramCount:
  904. {
  905. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i");
  906. const int32_t count = argv[0]->i;
  907. CARLA_ASSERT(count >= 0);
  908. kData->prog.clear();
  909. if (count > 0)
  910. kData->prog.createNew(count);
  911. break;
  912. }
  913. case kPluginBridgeMidiProgramCount:
  914. {
  915. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i");
  916. const int32_t count = argv[0]->i;
  917. CARLA_ASSERT(count >= 0);
  918. kData->midiprog.clear();
  919. if (count > 0)
  920. kData->midiprog.createNew(count);
  921. break;
  922. }
  923. case kPluginBridgePluginInfo:
  924. {
  925. CARLA_BRIDGE_CHECK_OSC_TYPES(7, "iissssh");
  926. const int32_t category = argv[0]->i;
  927. const int32_t hints = argv[1]->i;
  928. const char* const name = (const char*)&argv[2]->s;
  929. const char* const label = (const char*)&argv[3]->s;
  930. const char* const maker = (const char*)&argv[4]->s;
  931. const char* const copyright = (const char*)&argv[5]->s;
  932. const int64_t uniqueId = argv[6]->h;
  933. CARLA_ASSERT(category >= 0);
  934. CARLA_ASSERT(hints >= 0);
  935. CARLA_ASSERT(name != nullptr);
  936. CARLA_ASSERT(label != nullptr);
  937. CARLA_ASSERT(maker != nullptr);
  938. CARLA_ASSERT(copyright != nullptr);
  939. fHints = hints | PLUGIN_IS_BRIDGE;
  940. fInfo.category = static_cast<PluginCategory>(category);
  941. fInfo.uniqueId = uniqueId;
  942. fInfo.name = name;
  943. fInfo.label = label;
  944. fInfo.maker = maker;
  945. fInfo.copyright = copyright;
  946. if (fName.isEmpty())
  947. fName = name;
  948. break;
  949. }
  950. case kPluginBridgeParameterInfo:
  951. {
  952. CARLA_BRIDGE_CHECK_OSC_TYPES(3, "iss");
  953. const int32_t index = argv[0]->i;
  954. const char* const name = (const char*)&argv[1]->s;
  955. const char* const unit = (const char*)&argv[2]->s;
  956. CARLA_ASSERT_INT2(index >= 0 && index < static_cast<int32_t>(kData->param.count), index, kData->param.count);
  957. CARLA_ASSERT(name != nullptr);
  958. CARLA_ASSERT(unit != nullptr);
  959. if (index >= 0 && static_cast<int32_t>(kData->param.count))
  960. {
  961. fParams[index].name = name;
  962. fParams[index].unit = unit;
  963. }
  964. break;
  965. }
  966. case kPluginBridgeParameterData:
  967. {
  968. CARLA_BRIDGE_CHECK_OSC_TYPES(6, "iiiiii");
  969. const int32_t index = argv[0]->i;
  970. const int32_t type = argv[1]->i;
  971. const int32_t rindex = argv[2]->i;
  972. const int32_t hints = argv[3]->i;
  973. const int32_t channel = argv[4]->i;
  974. const int32_t cc = argv[5]->i;
  975. CARLA_ASSERT_INT2(index >= 0 && index < static_cast<int32_t>(kData->param.count), index, kData->param.count);
  976. CARLA_ASSERT(type >= 0);
  977. CARLA_ASSERT(rindex >= 0);
  978. CARLA_ASSERT(hints >= 0);
  979. CARLA_ASSERT(channel >= 0 && channel < 16);
  980. CARLA_ASSERT(cc >= -1);
  981. if (index >= 0 && static_cast<int32_t>(kData->param.count))
  982. {
  983. kData->param.data[index].type = static_cast<ParameterType>(type);
  984. kData->param.data[index].index = index;
  985. kData->param.data[index].rindex = rindex;
  986. kData->param.data[index].hints = hints;
  987. kData->param.data[index].midiChannel = channel;
  988. kData->param.data[index].midiCC = cc;
  989. }
  990. break;
  991. }
  992. case kPluginBridgeParameterRanges:
  993. {
  994. CARLA_BRIDGE_CHECK_OSC_TYPES(7, "iffffff");
  995. const int32_t index = argv[0]->i;
  996. const float def = argv[1]->f;
  997. const float min = argv[2]->f;
  998. const float max = argv[3]->f;
  999. const float step = argv[4]->f;
  1000. const float stepSmall = argv[5]->f;
  1001. const float stepLarge = argv[6]->f;
  1002. CARLA_ASSERT_INT2(index >= 0 && index < static_cast<int32_t>(kData->param.count), index, kData->param.count);
  1003. CARLA_ASSERT(min < max);
  1004. CARLA_ASSERT(def >= min);
  1005. CARLA_ASSERT(def <= max);
  1006. if (index >= 0 && static_cast<int32_t>(kData->param.count))
  1007. {
  1008. kData->param.ranges[index].def = def;
  1009. kData->param.ranges[index].min = min;
  1010. kData->param.ranges[index].max = max;
  1011. kData->param.ranges[index].step = step;
  1012. kData->param.ranges[index].stepSmall = stepSmall;
  1013. kData->param.ranges[index].stepLarge = stepLarge;
  1014. }
  1015. break;
  1016. }
  1017. case kPluginBridgeProgramInfo:
  1018. {
  1019. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "is");
  1020. const int32_t index = argv[0]->i;
  1021. const char* const name = (const char*)&argv[1]->s;
  1022. CARLA_ASSERT_INT2(index >= 0 && index < static_cast<int32_t>(kData->prog.count), index, kData->prog.count);
  1023. CARLA_ASSERT(name != nullptr);
  1024. if (index >= 0 && index < static_cast<int32_t>(kData->prog.count))
  1025. {
  1026. if (kData->prog.names[index] != nullptr)
  1027. delete[] kData->prog.names[index];
  1028. kData->prog.names[index] = carla_strdup(name);
  1029. }
  1030. break;
  1031. }
  1032. case kPluginBridgeMidiProgramInfo:
  1033. {
  1034. CARLA_BRIDGE_CHECK_OSC_TYPES(4, "iiis");
  1035. const int32_t index = argv[0]->i;
  1036. const int32_t bank = argv[1]->i;
  1037. const int32_t program = argv[2]->i;
  1038. const char* const name = (const char*)&argv[3]->s;
  1039. CARLA_ASSERT_INT2(index < static_cast<int32_t>(kData->midiprog.count), index, kData->midiprog.count);
  1040. CARLA_ASSERT(bank >= 0);
  1041. CARLA_ASSERT(program >= 0 && program < 128);
  1042. CARLA_ASSERT(name != nullptr);
  1043. if (index >= 0 && index < static_cast<int32_t>(kData->midiprog.count))
  1044. {
  1045. if (kData->midiprog.data[index].name != nullptr)
  1046. delete[] kData->midiprog.data[index].name;
  1047. kData->midiprog.data[index].bank = bank;
  1048. kData->midiprog.data[index].program = program;
  1049. kData->midiprog.data[index].name = carla_strdup(name);
  1050. }
  1051. break;
  1052. }
  1053. case kPluginBridgeConfigure:
  1054. {
  1055. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "ss");
  1056. const char* const key = (const char*)&argv[0]->s;
  1057. const char* const value = (const char*)&argv[1]->s;
  1058. CARLA_ASSERT(key != nullptr);
  1059. CARLA_ASSERT(value != nullptr);
  1060. if (key == nullptr || value == nullptr)
  1061. break;
  1062. if (std::strcmp(key, CARLA_BRIDGE_MSG_HIDE_GUI) == 0)
  1063. kData->engine->callback(CALLBACK_SHOW_GUI, fId, 0, 0, 0.0f, nullptr);
  1064. else if (std::strcmp(key, CARLA_BRIDGE_MSG_SAVED) == 0)
  1065. fSaved = true;
  1066. break;
  1067. }
  1068. case kPluginBridgeSetParameterValue:
  1069. {
  1070. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "if");
  1071. const int32_t index = argv[0]->i;
  1072. const float value = argv[1]->f;
  1073. CARLA_ASSERT_INT2(index >= 0 && index < static_cast<int32_t>(kData->param.count), index, kData->param.count);
  1074. if (index >= 0 && static_cast<int32_t>(kData->param.count))
  1075. {
  1076. const float fixedValue(kData->param.fixValue(index, value));
  1077. fParams[index].value = fixedValue;
  1078. CarlaPlugin::setParameterValue(index, fixedValue, false, true, true);
  1079. }
  1080. break;
  1081. }
  1082. case kPluginBridgeSetDefaultValue:
  1083. {
  1084. CARLA_BRIDGE_CHECK_OSC_TYPES(2, "if");
  1085. const int32_t index = argv[0]->i;
  1086. const float value = argv[1]->f;
  1087. CARLA_ASSERT_INT2(index >= 0 && index < static_cast<int32_t>(kData->param.count), index, kData->param.count);
  1088. if (index >= 0 && static_cast<int32_t>(kData->param.count))
  1089. kData->param.ranges[index].def = value;
  1090. break;
  1091. }
  1092. case kPluginBridgeSetProgram:
  1093. {
  1094. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i");
  1095. const int32_t index = argv[0]->i;
  1096. CARLA_ASSERT_INT2(index >= 0 && index < static_cast<int32_t>(kData->prog.count), index, kData->prog.count);
  1097. setProgram(index, false, true, true);
  1098. break;
  1099. }
  1100. case kPluginBridgeSetMidiProgram:
  1101. {
  1102. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "i");
  1103. const int32_t index = argv[0]->i;
  1104. CARLA_ASSERT_INT2(index < static_cast<int32_t>(kData->midiprog.count), index, kData->midiprog.count);
  1105. setMidiProgram(index, false, true, true);
  1106. break;
  1107. }
  1108. case kPluginBridgeSetCustomData:
  1109. {
  1110. CARLA_BRIDGE_CHECK_OSC_TYPES(3, "sss");
  1111. const char* const type = (const char*)&argv[0]->s;
  1112. const char* const key = (const char*)&argv[1]->s;
  1113. const char* const value = (const char*)&argv[2]->s;
  1114. CARLA_ASSERT(type != nullptr);
  1115. CARLA_ASSERT(key != nullptr);
  1116. CARLA_ASSERT(value != nullptr);
  1117. setCustomData(type, key, value, false);
  1118. break;
  1119. }
  1120. case kPluginBridgeSetChunkData:
  1121. {
  1122. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "s");
  1123. #if 0
  1124. const char* const chunkFileChar = (const char*)&argv[0]->s;
  1125. CARLA_ASSERT(chunkFileChar);
  1126. QString chunkFileStr(chunkFileChar);
  1127. #ifndef Q_OS_WIN
  1128. // Using Wine, fix temp dir
  1129. if (m_binary == BINARY_WIN32 || m_binary == BINARY_WIN64)
  1130. {
  1131. // Get WINEPREFIX
  1132. QString wineDir;
  1133. if (const char* const WINEPREFIX = getenv("WINEPREFIX"))
  1134. wineDir = QString(WINEPREFIX);
  1135. else
  1136. wineDir = QDir::homePath() + "/.wine";
  1137. QStringList chunkFileStrSplit1 = chunkFileStr.split(":/");
  1138. QStringList chunkFileStrSplit2 = chunkFileStrSplit1.at(1).split("\\");
  1139. QString wineDrive = chunkFileStrSplit1.at(0).toLower();
  1140. QString wineTMP = chunkFileStrSplit2.at(0);
  1141. QString baseName = chunkFileStrSplit2.at(1);
  1142. chunkFileStr = wineDir;
  1143. chunkFileStr += "/drive_";
  1144. chunkFileStr += wineDrive;
  1145. chunkFileStr += "/";
  1146. chunkFileStr += wineTMP;
  1147. chunkFileStr += "/";
  1148. chunkFileStr += baseName;
  1149. chunkFileStr = QDir::toNativeSeparators(chunkFileStr);
  1150. }
  1151. #endif
  1152. QFile chunkFile(chunkFileStr);
  1153. if (chunkFile.open(QIODevice::ReadOnly))
  1154. {
  1155. info.chunk = chunkFile.readAll();
  1156. chunkFile.close();
  1157. chunkFile.remove();
  1158. }
  1159. #endif
  1160. break;
  1161. }
  1162. case kPluginBridgeUpdateNow:
  1163. {
  1164. fInitiated = true;
  1165. break;
  1166. }
  1167. case kPluginBridgeError:
  1168. {
  1169. CARLA_BRIDGE_CHECK_OSC_TYPES(1, "s");
  1170. const char* const error = (const char*)&argv[0]->s;
  1171. CARLA_ASSERT(error != nullptr);
  1172. kData->engine->setLastError(error);
  1173. fInitError = true;
  1174. fInitiated = true;
  1175. break;
  1176. }
  1177. }
  1178. return 0;
  1179. }
  1180. // -------------------------------------------------------------------
  1181. const void* getExtraStuff() override
  1182. {
  1183. return fBridgeBinary.isNotEmpty() ? (const char*)fBridgeBinary : nullptr;
  1184. }
  1185. bool init(const char* const filename, const char* const name, const char* const label, const char* const bridgeBinary)
  1186. {
  1187. CARLA_ASSERT(kData->engine != nullptr);
  1188. CARLA_ASSERT(kData->client == nullptr);
  1189. // ---------------------------------------------------------------
  1190. // first checks
  1191. if (kData->engine == nullptr)
  1192. {
  1193. return false;
  1194. }
  1195. if (kData->client != nullptr)
  1196. {
  1197. kData->engine->setLastError("Plugin client is already registered");
  1198. return false;
  1199. }
  1200. // ---------------------------------------------------------------
  1201. // set info
  1202. if (name != nullptr)
  1203. fName = kData->engine->getUniquePluginName(name);
  1204. fFilename = filename;
  1205. fBridgeBinary = bridgeBinary;
  1206. // ---------------------------------------------------------------
  1207. // SHM Audio Pool
  1208. {
  1209. char tmpFileBase[60];
  1210. std::srand(std::time(NULL));
  1211. std::sprintf(tmpFileBase, "/carla-bridge_shm_XXXXXX");
  1212. fShmAudioPool.shm = shm_mkstemp(tmpFileBase);
  1213. if (! carla_is_shm_valid(fShmAudioPool.shm))
  1214. {
  1215. //_cleanup();
  1216. carla_stdout("Failed to open or create shared memory file #1");
  1217. return false;
  1218. }
  1219. fShmAudioPool.filename = tmpFileBase;
  1220. }
  1221. // ---------------------------------------------------------------
  1222. // SHM Control
  1223. {
  1224. char tmpFileBase[60];
  1225. std::sprintf(tmpFileBase, "/carla-bridge_shc_XXXXXX");
  1226. fShmControl.shm = shm_mkstemp(tmpFileBase);
  1227. if (! carla_is_shm_valid(fShmControl.shm))
  1228. {
  1229. //_cleanup();
  1230. carla_stdout("Failed to open or create shared memory file #2");
  1231. return false;
  1232. }
  1233. fShmControl.filename = tmpFileBase;
  1234. if (! carla_shm_map<BridgeShmControl>(fShmControl.shm, fShmControl.data))
  1235. {
  1236. //_cleanup();
  1237. carla_stdout("Failed to mmap shared memory file");
  1238. return false;
  1239. }
  1240. CARLA_ASSERT(fShmControl.data != nullptr);
  1241. std::memset(fShmControl.data, 0, sizeof(BridgeShmControl));
  1242. std::strcpy(fShmControl.data->ringBuffer.buf, "This thing is actually working!!!!");
  1243. if (sem_init(&fShmControl.data->runServer, 1, 0) != 0)
  1244. {
  1245. //_cleanup();
  1246. carla_stdout("Failed to initialize shared memory semaphore #1");
  1247. return false;
  1248. }
  1249. if (sem_init(&fShmControl.data->runClient, 1, 0) != 0)
  1250. {
  1251. //_cleanup();
  1252. carla_stdout("Failed to initialize shared memory semaphore #2");
  1253. return false;
  1254. }
  1255. }
  1256. // initial values
  1257. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetBufferSize);
  1258. rdwr_writeInt(&fShmControl.data->ringBuffer, kData->engine->getBufferSize());
  1259. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetSampleRate);
  1260. rdwr_writeFloat(&fShmControl.data->ringBuffer, kData->engine->getSampleRate());
  1261. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  1262. // register plugin now so we can receive OSC (and wait for it)
  1263. fHints |= PLUGIN_IS_BRIDGE;
  1264. registerEnginePlugin(kData->engine, fId, this);
  1265. // init OSC
  1266. {
  1267. char shmIdStr[12+1] = { 0 };
  1268. std::strncpy(shmIdStr, &fShmAudioPool.filename[fShmAudioPool.filename.length()-6], 6);
  1269. std::strncat(shmIdStr, &fShmControl.filename[fShmControl.filename.length()-6], 6);
  1270. kData->osc.thread.setOscData(bridgeBinary, label, getPluginTypeAsString(fPluginType), shmIdStr);
  1271. kData->osc.thread.start();
  1272. }
  1273. for (int i=0; i < 200; ++i)
  1274. {
  1275. if (fInitiated || ! kData->osc.thread.isRunning())
  1276. break;
  1277. carla_msleep(50);
  1278. }
  1279. if (fInitError || ! fInitiated)
  1280. {
  1281. // unregister so it gets handled properly
  1282. registerEnginePlugin(kData->engine, fId, nullptr);
  1283. kData->osc.thread.quit();
  1284. if (kData->osc.thread.isRunning())
  1285. kData->osc.thread.terminate();
  1286. if (! fInitError)
  1287. kData->engine->setLastError("Timeout while waiting for a response from plugin-bridge\n(or the plugin crashed on initialization?)");
  1288. return false;
  1289. }
  1290. // ---------------------------------------------------------------
  1291. // register client
  1292. kData->client = kData->engine->addClient(this);
  1293. if (kData->client == nullptr || ! kData->client->isOk())
  1294. {
  1295. kData->engine->setLastError("Failed to register plugin client");
  1296. return false;
  1297. }
  1298. return true;
  1299. }
  1300. private:
  1301. const BinaryType fBinaryType;
  1302. const PluginType fPluginType;
  1303. bool fInitiated;
  1304. bool fInitError;
  1305. bool fSaved;
  1306. CarlaString fBridgeBinary;
  1307. struct BridgeAudioPool {
  1308. CarlaString filename;
  1309. float* data;
  1310. size_t size;
  1311. shm_t shm;
  1312. BridgeAudioPool()
  1313. : data(nullptr),
  1314. size(0)
  1315. {
  1316. carla_shm_init(shm);
  1317. }
  1318. } fShmAudioPool;
  1319. struct BridgeControl {
  1320. CarlaString filename;
  1321. BridgeShmControl* data;
  1322. shm_t shm;
  1323. BridgeControl()
  1324. : data(nullptr)
  1325. {
  1326. carla_shm_init(shm);
  1327. }
  1328. } fShmControl;
  1329. struct Info {
  1330. uint32_t aIns, aOuts;
  1331. uint32_t mIns, mOuts;
  1332. PluginCategory category;
  1333. long uniqueId;
  1334. CarlaString name;
  1335. CarlaString label;
  1336. CarlaString maker;
  1337. CarlaString copyright;
  1338. //QByteArray chunk;
  1339. Info()
  1340. : aIns(0),
  1341. aOuts(0),
  1342. mIns(0),
  1343. mOuts(0),
  1344. category(PLUGIN_CATEGORY_NONE),
  1345. uniqueId(0) {}
  1346. } fInfo;
  1347. BridgeParamInfo* fParams;
  1348. void cleanup()
  1349. {
  1350. if (fShmAudioPool.filename.isNotEmpty())
  1351. fShmAudioPool.filename.clear();
  1352. if (fShmControl.filename.isNotEmpty())
  1353. fShmControl.filename.clear();
  1354. if (fShmAudioPool.data != nullptr)
  1355. {
  1356. carla_shm_unmap(fShmAudioPool.shm, fShmAudioPool.data, fShmAudioPool.size);
  1357. fShmAudioPool.data = nullptr;
  1358. }
  1359. fShmAudioPool.size = 0;
  1360. if (fShmControl.data != nullptr)
  1361. {
  1362. carla_shm_unmap(fShmControl.shm, fShmControl.data, sizeof(BridgeShmControl));
  1363. fShmControl.data = nullptr;
  1364. }
  1365. if (carla_is_shm_valid(fShmAudioPool.shm))
  1366. carla_shm_close(fShmAudioPool.shm);
  1367. if (carla_is_shm_valid(fShmControl.shm))
  1368. carla_shm_close(fShmControl.shm);
  1369. }
  1370. void resizeAudioPool(uint32_t bufferSize)
  1371. {
  1372. if (fShmAudioPool.data != nullptr)
  1373. carla_shm_unmap(fShmAudioPool.shm, fShmAudioPool.data, fShmAudioPool.size);
  1374. fShmAudioPool.size = (fInfo.aIns+fInfo.aOuts)*bufferSize*sizeof(float);
  1375. if (fShmAudioPool.size == 0)
  1376. fShmAudioPool.size = sizeof(float);
  1377. fShmAudioPool.data = (float*)carla_shm_map(fShmAudioPool.shm, fShmAudioPool.size);
  1378. rdwr_writeOpcode(&fShmControl.data->ringBuffer, kPluginBridgeOpcodeSetAudioPool);
  1379. rdwr_writeInt(&fShmControl.data->ringBuffer, fShmAudioPool.size);
  1380. rdwr_commitWrite(&fShmControl.data->ringBuffer);
  1381. waitForServer();
  1382. }
  1383. bool waitForServer()
  1384. {
  1385. sem_post(&fShmControl.data->runServer);
  1386. if (! jackbridge_sem_timedwait(&fShmControl.data->runClient, 5))
  1387. {
  1388. carla_stderr("waitForServer() timeout");
  1389. kData->active = false; // TODO
  1390. return false;
  1391. }
  1392. return true;
  1393. }
  1394. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(BridgePlugin)
  1395. };
  1396. CARLA_BACKEND_END_NAMESPACE
  1397. #endif // ! BUILD_BRIDGE
  1398. CARLA_BACKEND_START_NAMESPACE
  1399. CarlaPlugin* CarlaPlugin::newBridge(const Initializer& init, BinaryType btype, PluginType ptype, const char* const bridgeBinary)
  1400. {
  1401. carla_debug("CarlaPlugin::newBridge({%p, \"%s\", \"%s\", \"%s\"}, %s, %s, \"%s\")", init.engine, init.filename, init.name, init.label, BinaryType2Str(btype), PluginType2Str(ptype), bridgeBinary);
  1402. #ifndef BUILD_BRIDGE
  1403. if (bridgeBinary == nullptr)
  1404. {
  1405. init.engine->setLastError("Bridge not possible, bridge-binary not found");
  1406. return nullptr;
  1407. }
  1408. BridgePlugin* const plugin(new BridgePlugin(init.engine, init.id, btype, ptype));
  1409. if (! plugin->init(init.filename, init.name, init.label, bridgeBinary))
  1410. {
  1411. delete plugin;
  1412. return nullptr;
  1413. }
  1414. plugin->reload();
  1415. if (init.engine->getProccessMode() == PROCESS_MODE_CONTINUOUS_RACK && ! CarlaPluginProtectedData::canRunInRack(plugin))
  1416. {
  1417. init.engine->setLastError("Carla's rack mode can only work with Stereo Bridged plugins, sorry!");
  1418. delete plugin;
  1419. return nullptr;
  1420. }
  1421. return plugin;
  1422. #else
  1423. init.engine->setLastError("Plugin bridge support not available");
  1424. return nullptr;
  1425. // unused
  1426. (void)bridgeBinary;
  1427. #endif
  1428. }
  1429. #ifndef BUILD_BRIDGE
  1430. // -------------------------------------------------------------------
  1431. // Bridge Helper
  1432. int CarlaPluginSetOscBridgeInfo(CarlaPlugin* const plugin, const PluginBridgeInfoType type,
  1433. const int argc, const lo_arg* const* const argv, const char* const types)
  1434. {
  1435. CARLA_ASSERT(plugin != nullptr && (plugin->hints() & PLUGIN_IS_BRIDGE) != 0);
  1436. return ((BridgePlugin*)plugin)->setOscPluginBridgeInfo(type, argc, argv, types);
  1437. }
  1438. BinaryType CarlaPluginGetBridgeBinaryType(CarlaPlugin* const plugin)
  1439. {
  1440. CARLA_ASSERT(plugin != nullptr && (plugin->hints() & PLUGIN_IS_BRIDGE) != 0);
  1441. return ((BridgePlugin*)plugin)->binaryType();
  1442. }
  1443. #endif
  1444. CARLA_BACKEND_END_NAMESPACE