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.

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