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.

2465 lines
79KB

  1. /*
  2. * Carla VST 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. #ifdef WANT_VST
  19. #include "CarlaPluginGui.hpp"
  20. #include "CarlaVstUtils.hpp"
  21. //#ifdef Q_WS_X11
  22. //# include <QtGui/QX11Info>
  23. //#endif
  24. CARLA_BACKEND_START_NAMESPACE
  25. #if 0
  26. }
  27. #endif
  28. /*!
  29. * @defgroup PluginHints Plugin Hints
  30. * @{
  31. */
  32. const unsigned int PLUGIN_CAN_PROCESS_REPLACING = 0x1000; //!< VST Plugin cas use processReplacing()
  33. const unsigned int PLUGIN_HAS_COCKOS_EXTENSIONS = 0x2000; //!< VST Plugin has Cockos extensions
  34. const unsigned int PLUGIN_USES_OLD_VSTSDK = 0x4000; //!< VST Plugin uses an old VST SDK
  35. const unsigned int PLUGIN_WANTS_MIDI_INPUT = 0x8000; //!< VST Plugin wants MIDI input
  36. /**@}*/
  37. class VstPlugin : public CarlaPlugin,
  38. public CarlaPluginGui::Callback
  39. {
  40. public:
  41. VstPlugin(CarlaEngine* const engine, const unsigned int id)
  42. : CarlaPlugin(engine, id),
  43. fUnique1(1),
  44. fEffect(nullptr),
  45. fLastChunk(nullptr),
  46. fMidiEventCount(0),
  47. fIsProcessing(false),
  48. fNeedIdle(false),
  49. fUnique2(2)
  50. {
  51. carla_debug("VstPlugin::VstPlugin(%p, %i)", engine, id);
  52. carla_zeroStruct<VstMidiEvent>(fMidiEvents, MAX_MIDI_EVENTS*2);
  53. carla_zeroStruct<VstTimeInfo_R>(fTimeInfo);
  54. for (unsigned short i=0; i < MAX_MIDI_EVENTS*2; ++i)
  55. fEvents.data[i] = (VstEvent*)&fMidiEvents[i];
  56. kData->osc.thread.setMode(CarlaPluginThread::PLUGIN_THREAD_VST_GUI);
  57. // make plugin valid
  58. srand(id);
  59. fUnique1 = fUnique2 = rand();
  60. }
  61. ~VstPlugin()
  62. {
  63. carla_debug("VstPlugin::~VstPlugin()");
  64. // close UI
  65. if (fHints & PLUGIN_HAS_GUI)
  66. {
  67. showGui(false);
  68. if (fGui.isOsc)
  69. {
  70. // Wait a bit first, then force kill
  71. if (kData->osc.thread.isRunning() && ! kData->osc.thread.wait(kData->engine->getOptions().oscUiTimeout))
  72. {
  73. carla_stderr("VST GUI thread still running, forcing termination now");
  74. kData->osc.thread.terminate();
  75. }
  76. }
  77. }
  78. kData->singleMutex.lock();
  79. kData->masterMutex.lock();
  80. if (kData->active)
  81. {
  82. deactivate();
  83. kData->active = false;
  84. }
  85. if (fEffect != nullptr)
  86. {
  87. dispatcher(effClose, 0, 0, nullptr, 0.0f);
  88. fEffect = nullptr;
  89. }
  90. if (fLastChunk != nullptr)
  91. {
  92. delete[] fLastChunk;
  93. fLastChunk = nullptr;
  94. }
  95. // make plugin invalid
  96. fUnique2 += 1;
  97. }
  98. // -------------------------------------------------------------------
  99. // Information (base)
  100. PluginType type() const
  101. {
  102. return PLUGIN_VST;
  103. }
  104. PluginCategory category()
  105. {
  106. CARLA_ASSERT(fEffect != nullptr);
  107. {
  108. const intptr_t category = dispatcher(effGetPlugCategory, 0, 0, nullptr, 0.0f);
  109. switch (category)
  110. {
  111. case kPlugCategSynth:
  112. return PLUGIN_CATEGORY_SYNTH;
  113. case kPlugCategAnalysis:
  114. return PLUGIN_CATEGORY_UTILITY;
  115. case kPlugCategMastering:
  116. return PLUGIN_CATEGORY_DYNAMICS;
  117. case kPlugCategRoomFx:
  118. return PLUGIN_CATEGORY_DELAY;
  119. case kPlugCategRestoration:
  120. return PLUGIN_CATEGORY_UTILITY;
  121. case kPlugCategGenerator:
  122. return PLUGIN_CATEGORY_SYNTH;
  123. }
  124. if (fEffect->flags & effFlagsIsSynth)
  125. return PLUGIN_CATEGORY_SYNTH;
  126. }
  127. return getPluginCategoryFromName(fName);
  128. }
  129. long uniqueId() const
  130. {
  131. CARLA_ASSERT(fEffect != nullptr);
  132. return (fEffect != nullptr) ? fEffect->uniqueID : 0;
  133. }
  134. // -------------------------------------------------------------------
  135. // Information (current data)
  136. int32_t chunkData(void** const dataPtr)
  137. {
  138. CARLA_ASSERT(fOptions & PLUGIN_OPTION_USE_CHUNKS);
  139. CARLA_ASSERT(fEffect != nullptr);
  140. CARLA_ASSERT(dataPtr != nullptr);
  141. return dispatcher(effGetChunk, 0 /* bank */, 0, dataPtr, 0.0f);
  142. }
  143. // -------------------------------------------------------------------
  144. // Information (per-plugin data)
  145. unsigned int availableOptions()
  146. {
  147. CARLA_ASSERT(fEffect != nullptr);
  148. if (fEffect == nullptr)
  149. return 0x0;
  150. unsigned int options = 0x0;
  151. options |= PLUGIN_OPTION_FIXED_BUFFER;
  152. options |= PLUGIN_OPTION_MAP_PROGRAM_CHANGES;
  153. if (fEffect->flags & effFlagsProgramChunks)
  154. options |= PLUGIN_OPTION_USE_CHUNKS;
  155. if (vstPluginCanDo(fEffect, "receiveVstEvents") || vstPluginCanDo(fEffect, "receiveVstMidiEvent") || (fEffect->flags & effFlagsIsSynth) > 0 || (fHints & PLUGIN_WANTS_MIDI_INPUT))
  156. {
  157. options |= PLUGIN_OPTION_SEND_CONTROL_CHANGES;
  158. options |= PLUGIN_OPTION_SEND_CHANNEL_PRESSURE;
  159. options |= PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH;
  160. options |= PLUGIN_OPTION_SEND_PITCHBEND;
  161. options |= PLUGIN_OPTION_SEND_ALL_SOUND_OFF;
  162. }
  163. return options;
  164. }
  165. float getParameterValue(const uint32_t parameterId)
  166. {
  167. CARLA_ASSERT(fEffect != nullptr);
  168. CARLA_ASSERT(parameterId < kData->param.count);
  169. return fEffect->getParameter(fEffect, parameterId);
  170. }
  171. void getLabel(char* const strBuf)
  172. {
  173. CARLA_ASSERT(fEffect != nullptr);
  174. dispatcher(effGetProductString, 0, 0, strBuf, 0.0f);
  175. }
  176. void getMaker(char* const strBuf)
  177. {
  178. CARLA_ASSERT(fEffect != nullptr);
  179. dispatcher(effGetVendorString, 0, 0, strBuf, 0.0f);
  180. }
  181. void getCopyright(char* const strBuf)
  182. {
  183. CARLA_ASSERT(fEffect != nullptr);
  184. dispatcher(effGetVendorString, 0, 0, strBuf, 0.0f);
  185. }
  186. void getRealName(char* const strBuf)
  187. {
  188. CARLA_ASSERT(fEffect != nullptr);
  189. dispatcher(effGetEffectName, 0, 0, strBuf, 0.0f);
  190. }
  191. void getParameterName(const uint32_t parameterId, char* const strBuf)
  192. {
  193. CARLA_ASSERT(fEffect != nullptr);
  194. CARLA_ASSERT(parameterId < kData->param.count);
  195. dispatcher(effGetParamName, parameterId, 0, strBuf, 0.0f);
  196. }
  197. void getParameterText(const uint32_t parameterId, char* const strBuf)
  198. {
  199. CARLA_ASSERT(fEffect != nullptr);
  200. CARLA_ASSERT(parameterId < kData->param.count);
  201. dispatcher(effGetParamDisplay, parameterId, 0, strBuf, 0.0f);
  202. if (*strBuf == 0)
  203. std::sprintf(strBuf, "%f", getParameterValue(parameterId));
  204. }
  205. void getParameterUnit(const uint32_t parameterId, char* const strBuf)
  206. {
  207. CARLA_ASSERT(fEffect != nullptr);
  208. CARLA_ASSERT(parameterId < kData->param.count);
  209. dispatcher(effGetParamLabel, parameterId, 0, strBuf, 0.0f);
  210. }
  211. // -------------------------------------------------------------------
  212. // Set data (plugin-specific stuff)
  213. void setParameterValue(const uint32_t parameterId, const float value, const bool sendGui, const bool sendOsc, const bool sendCallback)
  214. {
  215. CARLA_ASSERT(fEffect != nullptr);
  216. CARLA_ASSERT(parameterId < kData->param.count);
  217. const float fixedValue = kData->param.fixValue(parameterId, value);
  218. fEffect->setParameter(fEffect, parameterId, fixedValue);
  219. CarlaPlugin::setParameterValue(parameterId, fixedValue, sendGui, sendOsc, sendCallback);
  220. }
  221. void setChunkData(const char* const stringData)
  222. {
  223. CARLA_ASSERT(fOptions & PLUGIN_OPTION_USE_CHUNKS);
  224. CARLA_ASSERT(fEffect != nullptr);
  225. CARLA_ASSERT(stringData != nullptr);
  226. if (fLastChunk != nullptr)
  227. {
  228. delete[] fLastChunk;
  229. fLastChunk = nullptr;
  230. }
  231. const size_t size(CarlaString(stringData).exportAsBase64Binary(&fLastChunk));
  232. CARLA_ASSERT(size > 0);
  233. CARLA_ASSERT(fLastChunk != nullptr);
  234. if (size > 0 && fLastChunk != nullptr)
  235. {
  236. const ScopedSingleProcessLocker spl(this, true);
  237. dispatcher(effSetChunk, 0 /* bank */, size, fLastChunk, 0.0f);
  238. }
  239. }
  240. void setProgram(int32_t index, const bool sendGui, const bool sendOsc, const bool sendCallback)
  241. {
  242. CARLA_ASSERT(fEffect != nullptr);
  243. CARLA_ASSERT(index >= -1 && index < static_cast<int32_t>(kData->prog.count));
  244. if (index < -1)
  245. index = -1;
  246. else if (index > static_cast<int32_t>(kData->prog.count))
  247. return;
  248. if (index >= 0)
  249. {
  250. const ScopedSingleProcessLocker spl(this, (sendGui || sendOsc || sendCallback));
  251. dispatcher(effBeginSetProgram, 0, 0, nullptr, 0.0f);
  252. dispatcher(effSetProgram, 0, index, nullptr, 0.0f);
  253. dispatcher(effEndSetProgram, 0, 0, nullptr, 0.0f);
  254. }
  255. CarlaPlugin::setProgram(index, sendGui, sendOsc, sendCallback);
  256. }
  257. // -------------------------------------------------------------------
  258. // Set gui stuff
  259. void showGui(const bool yesNo)
  260. {
  261. if (fGui.isOsc)
  262. {
  263. if (yesNo)
  264. {
  265. kData->osc.thread.start();
  266. }
  267. else
  268. {
  269. if (kData->osc.data.target != nullptr)
  270. {
  271. osc_send_hide(&kData->osc.data);
  272. osc_send_quit(&kData->osc.data);
  273. kData->osc.data.free();
  274. }
  275. if (kData->osc.thread.isRunning() && ! kData->osc.thread.wait(kData->engine->getOptions().oscUiTimeout))
  276. kData->osc.thread.terminate();
  277. }
  278. }
  279. else
  280. {
  281. if (yesNo)
  282. {
  283. if (kData->gui == nullptr)
  284. {
  285. struct CarlaPluginGui::Options guiOptions;
  286. guiOptions.parented = true;
  287. guiOptions.resizable = false;
  288. kData->gui = new CarlaPluginGui(kData->engine, this, guiOptions);
  289. }
  290. int32_t value = 0;
  291. #ifdef Q_WS_X11
  292. //value = (intptr_t)QX11Info::display();
  293. #endif
  294. void* const ptr = kData->gui->getContainerWinId();
  295. if (dispatcher(effEditOpen, 0, value, ptr, 0.0f) != 0)
  296. {
  297. ERect* vstRect = nullptr;
  298. dispatcher(effEditGetRect, 0, 0, &vstRect, 0.0f);
  299. if (vstRect != nullptr)
  300. {
  301. const int16_t width = vstRect->right - vstRect->left;
  302. const int16_t height = vstRect->bottom - vstRect->top;
  303. if (width > 0 && height > 0)
  304. kData->gui->setSize(width, height);
  305. }
  306. kData->gui->setWindowTitle(QString("%1 (GUI)").arg((const char*)fName).toUtf8().constData());
  307. kData->gui->show();
  308. }
  309. else
  310. {
  311. if (kData->gui != nullptr)
  312. {
  313. kData->gui->close();
  314. delete kData->gui;
  315. kData->gui = nullptr;
  316. }
  317. kData->engine->callback(CALLBACK_ERROR, fId, 0, 0, 0.0f, "Plugin refused to open its own UI");
  318. kData->engine->callback(CALLBACK_SHOW_GUI, fId, 0, 0, 0.0f, nullptr);
  319. return;
  320. }
  321. }
  322. else
  323. {
  324. dispatcher(effEditClose, 0, 0, nullptr, 0.0f);
  325. if (kData->gui != nullptr)
  326. {
  327. kData->gui->close();
  328. delete kData->gui;
  329. kData->gui = nullptr;
  330. }
  331. }
  332. }
  333. fGui.isVisible = yesNo;
  334. }
  335. void idleGui()
  336. {
  337. #ifdef VESTIGE_HEADER
  338. if (fEffect != nullptr /*&& effect->ptr1*/)
  339. #else
  340. if (fEffect != nullptr /*&& effect->resvd1*/)
  341. #endif
  342. {
  343. if (fNeedIdle)
  344. dispatcher(effIdle, 0, 0, nullptr, 0.0f);
  345. if (fGui.isVisible && ! fGui.isOsc)
  346. {
  347. dispatcher(effEditIdle, 0, 0, nullptr, 0.0f);
  348. //kData->gui->idle();
  349. }
  350. }
  351. CarlaPlugin::idleGui();
  352. }
  353. // -------------------------------------------------------------------
  354. // Plugin state
  355. void reload()
  356. {
  357. carla_debug("VstPlugin::reload() - start");
  358. CARLA_ASSERT(kData->engine != nullptr);
  359. CARLA_ASSERT(fEffect != nullptr);
  360. if (kData->engine == nullptr)
  361. return;
  362. if (fEffect == nullptr)
  363. return;
  364. const ProcessMode processMode(kData->engine->getProccessMode());
  365. // Safely disable plugin for reload
  366. const ScopedDisabler sd(this);
  367. if (kData->active)
  368. deactivate();
  369. clearBuffers();
  370. uint32_t aIns, aOuts, mIns, mOuts, params, j;
  371. bool needsCtrlIn, needsCtrlOut;
  372. needsCtrlIn = needsCtrlOut = false;
  373. aIns = fEffect->numInputs;
  374. aOuts = fEffect->numOutputs;
  375. params = fEffect->numParams;
  376. if (vstPluginCanDo(fEffect, "receiveVstEvents") || vstPluginCanDo(fEffect, "receiveVstMidiEvent") || (fEffect->flags & effFlagsIsSynth) > 0 || (fHints & PLUGIN_WANTS_MIDI_INPUT))
  377. {
  378. mIns = 1;
  379. needsCtrlIn = true;
  380. }
  381. else
  382. mIns = 0;
  383. if (vstPluginCanDo(fEffect, "sendVstEvents") || vstPluginCanDo(fEffect, "sendVstMidiEvent"))
  384. {
  385. mOuts = 1;
  386. needsCtrlOut = true;
  387. }
  388. else
  389. mOuts = 0;
  390. if (aIns > 0)
  391. {
  392. kData->audioIn.createNew(aIns);
  393. }
  394. if (aOuts > 0)
  395. {
  396. kData->audioOut.createNew(aOuts);
  397. needsCtrlIn = true;
  398. }
  399. if (params > 0)
  400. {
  401. kData->param.createNew(params);
  402. needsCtrlIn = true;
  403. }
  404. const uint portNameSize = kData->engine->maxPortNameSize();
  405. CarlaString portName;
  406. // Audio Ins
  407. for (j=0; j < aIns; ++j)
  408. {
  409. portName.clear();
  410. if (processMode == PROCESS_MODE_SINGLE_CLIENT)
  411. {
  412. portName = fName;
  413. portName += ":";
  414. }
  415. if (aIns > 1)
  416. {
  417. portName += "input_";
  418. portName += CarlaString(j+1);
  419. }
  420. else
  421. portName += "input";
  422. portName.truncate(portNameSize);
  423. kData->audioIn.ports[j].port = (CarlaEngineAudioPort*)kData->client->addPort(kEnginePortTypeAudio, portName, true);
  424. kData->audioIn.ports[j].rindex = j;
  425. }
  426. // Audio Outs
  427. for (j=0; j < aOuts; ++j)
  428. {
  429. portName.clear();
  430. if (processMode == PROCESS_MODE_SINGLE_CLIENT)
  431. {
  432. portName = fName;
  433. portName += ":";
  434. }
  435. if (aOuts > 1)
  436. {
  437. portName += "output_";
  438. portName += CarlaString(j+1);
  439. }
  440. else
  441. portName += "output";
  442. portName.truncate(portNameSize);
  443. kData->audioOut.ports[j].port = (CarlaEngineAudioPort*)kData->client->addPort(kEnginePortTypeAudio, portName, false);
  444. kData->audioOut.ports[j].rindex = j;
  445. }
  446. for (j=0; j < params; ++j)
  447. {
  448. kData->param.data[j].type = PARAMETER_INPUT;
  449. kData->param.data[j].index = j;
  450. kData->param.data[j].rindex = j;
  451. kData->param.data[j].hints = 0x0;
  452. kData->param.data[j].midiChannel = 0;
  453. kData->param.data[j].midiCC = -1;
  454. float min, max, def, step, stepSmall, stepLarge;
  455. VstParameterProperties prop;
  456. carla_zeroStruct<VstParameterProperties>(prop);
  457. if (fHints & PLUGIN_HAS_COCKOS_EXTENSIONS)
  458. {
  459. double range[2] = { 0.0, 1.0 };
  460. if (dispatcher(effVendorSpecific, 0xdeadbef0, j, range, 0.0f) >= 0xbeef)
  461. {
  462. min = range[0];
  463. max = range[1];
  464. if (min > max)
  465. max = min;
  466. else if (max < min)
  467. min = max;
  468. if (max - min == 0.0f)
  469. {
  470. carla_stderr2("WARNING - Broken plugin parameter: max - min == 0.0f (with cockos extensions)");
  471. max = min + 0.1f;
  472. }
  473. }
  474. else
  475. {
  476. min = 0.0f;
  477. max = 1.0f;
  478. }
  479. if (dispatcher(effVendorSpecific, kVstParameterUsesIntStep, j, nullptr, 0.0f) >= 0xbeef)
  480. {
  481. step = 1.0f;
  482. stepSmall = 1.0f;
  483. stepLarge = 10.0f;
  484. }
  485. else
  486. {
  487. float range = max - min;
  488. step = range/100.0f;
  489. stepSmall = range/1000.0f;
  490. stepLarge = range/10.0f;
  491. }
  492. }
  493. else if (dispatcher(effGetParameterProperties, j, 0, &prop, 0) == 1)
  494. {
  495. if (prop.flags & kVstParameterUsesIntegerMinMax)
  496. {
  497. min = float(prop.minInteger);
  498. max = float(prop.maxInteger);
  499. if (min > max)
  500. max = min;
  501. else if (max < min)
  502. min = max;
  503. if (max - min == 0.0f)
  504. {
  505. carla_stderr2("WARNING - Broken plugin parameter: max - min == 0.0f");
  506. max = min + 0.1f;
  507. }
  508. }
  509. else
  510. {
  511. min = 0.0f;
  512. max = 1.0f;
  513. }
  514. if (prop.flags & kVstParameterIsSwitch)
  515. {
  516. step = max - min;
  517. stepSmall = step;
  518. stepLarge = step;
  519. kData->param.data[j].hints |= PARAMETER_IS_BOOLEAN;
  520. }
  521. else if (prop.flags & kVstParameterUsesIntStep)
  522. {
  523. step = float(prop.stepInteger);
  524. stepSmall = float(prop.stepInteger)/10;
  525. stepLarge = float(prop.largeStepInteger);
  526. kData->param.data[j].hints |= PARAMETER_IS_INTEGER;
  527. }
  528. else if (prop.flags & kVstParameterUsesFloatStep)
  529. {
  530. step = prop.stepFloat;
  531. stepSmall = prop.smallStepFloat;
  532. stepLarge = prop.largeStepFloat;
  533. }
  534. else
  535. {
  536. float range = max - min;
  537. step = range/100.0f;
  538. stepSmall = range/1000.0f;
  539. stepLarge = range/10.0f;
  540. }
  541. if (prop.flags & kVstParameterCanRamp)
  542. kData->param.data[j].hints |= PARAMETER_IS_LOGARITHMIC;
  543. }
  544. else
  545. {
  546. min = 0.0f;
  547. max = 1.0f;
  548. step = 0.001f;
  549. stepSmall = 0.0001f;
  550. stepLarge = 0.1f;
  551. }
  552. kData->param.data[j].hints |= PARAMETER_IS_ENABLED;
  553. #ifndef BUILD_BRIDGE
  554. kData->param.data[j].hints |= PARAMETER_USES_CUSTOM_TEXT;
  555. #endif
  556. if ((fHints & PLUGIN_USES_OLD_VSTSDK) != 0 || dispatcher(effCanBeAutomated, j, 0, nullptr, 0.0f) == 1)
  557. kData->param.data[j].hints |= PARAMETER_IS_AUTOMABLE;
  558. // no such thing as VST default parameters
  559. def = fEffect->getParameter(fEffect, j);
  560. if (def < min)
  561. def = min;
  562. else if (def > max)
  563. def = max;
  564. kData->param.ranges[j].min = min;
  565. kData->param.ranges[j].max = max;
  566. kData->param.ranges[j].def = def;
  567. kData->param.ranges[j].step = step;
  568. kData->param.ranges[j].stepSmall = stepSmall;
  569. kData->param.ranges[j].stepLarge = stepLarge;
  570. }
  571. if (needsCtrlIn)
  572. {
  573. portName.clear();
  574. if (processMode == PROCESS_MODE_SINGLE_CLIENT)
  575. {
  576. portName = fName;
  577. portName += ":";
  578. }
  579. portName += "events-in";
  580. portName.truncate(portNameSize);
  581. kData->event.portIn = (CarlaEngineEventPort*)kData->client->addPort(kEnginePortTypeEvent, portName, true);
  582. }
  583. if (needsCtrlOut)
  584. {
  585. portName.clear();
  586. if (processMode == PROCESS_MODE_SINGLE_CLIENT)
  587. {
  588. portName = fName;
  589. portName += ":";
  590. }
  591. portName += "events-out";
  592. portName.truncate(portNameSize);
  593. kData->event.portOut = (CarlaEngineEventPort*)kData->client->addPort(kEnginePortTypeEvent, portName, false);
  594. }
  595. // plugin hints
  596. const intptr_t vstCategory = dispatcher(effGetPlugCategory, 0, 0, nullptr, 0.0f);
  597. fHints = 0x0;
  598. if (vstCategory == kPlugCategSynth || vstCategory == kPlugCategGenerator)
  599. fHints |= PLUGIN_IS_SYNTH;
  600. if (fEffect->flags & effFlagsHasEditor)
  601. {
  602. fHints |= PLUGIN_HAS_GUI;
  603. if (! fGui.isOsc)
  604. fHints |= PLUGIN_HAS_SINGLE_THREAD;
  605. }
  606. if (dispatcher(effGetVstVersion, 0, 0, nullptr, 0.0f) < kVstVersion)
  607. fHints |= PLUGIN_USES_OLD_VSTSDK;
  608. if ((fEffect->flags & effFlagsCanReplacing) != 0 && fEffect->processReplacing != fEffect->process)
  609. fHints |= PLUGIN_CAN_PROCESS_REPLACING;
  610. if (fEffect->flags & effFlagsHasEditor)
  611. fHints |= PLUGIN_HAS_GUI;
  612. if (static_cast<uintptr_t>(dispatcher(effCanDo, 0, 0, (void*)"hasCockosExtensions", 0.0f)) == 0xbeef0000)
  613. fHints |= PLUGIN_HAS_COCKOS_EXTENSIONS;
  614. if (aOuts > 0 && (aIns == aOuts || aIns == 1))
  615. fHints |= PLUGIN_CAN_DRYWET;
  616. if (aOuts > 0)
  617. fHints |= PLUGIN_CAN_VOLUME;
  618. if (aOuts >= 2 && aOuts % 2 == 0)
  619. fHints |= PLUGIN_CAN_BALANCE;
  620. // extra plugin hints
  621. kData->extraHints = 0x0;
  622. if (mIns > 0)
  623. kData->extraHints |= PLUGIN_HINT_HAS_MIDI_IN;
  624. if (mOuts > 0)
  625. kData->extraHints |= PLUGIN_HINT_HAS_MIDI_OUT;
  626. if (aIns <= 2 && aOuts <= 2 && (aIns == aOuts || aIns == 0 || aOuts == 0))
  627. kData->extraHints |= PLUGIN_HINT_CAN_RUN_RACK;
  628. // dummy pre-start to get latency and wantEvents() on old plugins
  629. {
  630. activate();
  631. deactivate();
  632. }
  633. // check latency
  634. if (fHints & PLUGIN_CAN_DRYWET)
  635. {
  636. #ifdef VESTIGE_HEADER
  637. char* const empty3Ptr = &fEffect->empty3[0];
  638. int32_t* initialDelayPtr = (int32_t*)empty3Ptr;
  639. kData->latency = *initialDelayPtr;
  640. #else
  641. kData->latency = fEffect->initialDelay;
  642. #endif
  643. kData->client->setLatency(kData->latency);
  644. kData->recreateLatencyBuffers();
  645. }
  646. // special plugin fixes
  647. // 1. IL Harmless - disable threaded processing
  648. if (fEffect->uniqueID == 1229484653)
  649. {
  650. char strBuf[STR_MAX+1] = { 0 };
  651. getLabel(strBuf);
  652. if (std::strcmp(strBuf, "IL Harmless") == 0)
  653. {
  654. // TODO - disable threaded processing
  655. }
  656. }
  657. bufferSizeChanged(kData->engine->getBufferSize());
  658. reloadPrograms(true);
  659. if (kData->active)
  660. activate();
  661. carla_debug("VstPlugin::reload() - end");
  662. }
  663. void reloadPrograms(const bool init)
  664. {
  665. carla_debug("VstPlugin::reloadPrograms(%s)", bool2str(init));
  666. uint32_t i, oldCount = kData->prog.count;
  667. const int32_t current = kData->prog.current;
  668. // Delete old programs
  669. kData->prog.clear();
  670. // Query new programs
  671. uint32_t count = static_cast<uint32_t>(fEffect->numPrograms);
  672. if (count > 0)
  673. {
  674. kData->prog.createNew(count);
  675. // Update names
  676. for (i=0; i < count; ++i)
  677. {
  678. char strBuf[STR_MAX+1] = { 0 };
  679. if (dispatcher(effGetProgramNameIndexed, i, 0, strBuf, 0.0f) != 1)
  680. {
  681. // program will be [re-]changed later
  682. dispatcher(effSetProgram, 0, i, nullptr, 0.0f);
  683. dispatcher(effGetProgramName, 0, 0, strBuf, 0.0f);
  684. }
  685. kData->prog.names[i] = strdup(strBuf);
  686. }
  687. }
  688. #ifndef BUILD_BRIDGE
  689. // Update OSC Names
  690. if (kData->engine->isOscControlRegistered())
  691. {
  692. kData->engine->osc_send_control_set_program_count(fId, count);
  693. for (i=0; i < count; ++i)
  694. kData->engine->osc_send_control_set_program_name(fId, i, kData->prog.names[i]);
  695. }
  696. #endif
  697. if (init)
  698. {
  699. if (count > 0)
  700. setProgram(0, false, false, false);
  701. }
  702. else
  703. {
  704. // Check if current program is invalid
  705. bool programChanged = false;
  706. if (count == oldCount+1)
  707. {
  708. // one program added, probably created by user
  709. kData->prog.current = oldCount;
  710. programChanged = true;
  711. }
  712. else if (current < 0 && count > 0)
  713. {
  714. // programs exist now, but not before
  715. kData->prog.current = 0;
  716. programChanged = true;
  717. }
  718. else if (current >= 0 && count == 0)
  719. {
  720. // programs existed before, but not anymore
  721. kData->prog.current = -1;
  722. programChanged = true;
  723. }
  724. else if (current >= static_cast<int32_t>(count))
  725. {
  726. // current program > count
  727. kData->prog.current = 0;
  728. programChanged = true;
  729. }
  730. else
  731. {
  732. // no change
  733. kData->prog.current = current;
  734. }
  735. if (programChanged)
  736. {
  737. setProgram(kData->prog.current, true, true, true);
  738. }
  739. else
  740. {
  741. // Program was changed during update, re-set it
  742. if (kData->prog.current >= 0)
  743. dispatcher(effSetProgram, 0, kData->prog.current, nullptr, 0.0f);
  744. }
  745. kData->engine->callback(CALLBACK_RELOAD_PROGRAMS, fId, 0, 0, 0.0f, nullptr);
  746. }
  747. }
  748. // -------------------------------------------------------------------
  749. // Plugin processing
  750. void activate()
  751. {
  752. dispatcher(effMainsChanged, 0, 1, nullptr, 0.0f);
  753. dispatcher(effStartProcess, 0, 0, nullptr, 0.0f);
  754. }
  755. void deactivate()
  756. {
  757. dispatcher(effStopProcess, 0, 0, nullptr, 0.0f);
  758. dispatcher(effMainsChanged, 0, 0, nullptr, 0.0f);
  759. }
  760. void process(float** const inBuffer, float** const outBuffer, const uint32_t frames)
  761. {
  762. uint32_t i, k;
  763. // --------------------------------------------------------------------------------------------------------
  764. // Check if active
  765. if (! kData->active)
  766. {
  767. // disable any output sound
  768. for (i=0; i < kData->audioOut.count; ++i)
  769. carla_zeroFloat(outBuffer[i], frames);
  770. return;
  771. }
  772. fMidiEventCount = 0;
  773. carla_zeroStruct<VstMidiEvent>(fMidiEvents, MAX_MIDI_EVENTS*2);
  774. // --------------------------------------------------------------------------------------------------------
  775. // Check if needs reset
  776. if (kData->needsReset)
  777. {
  778. // TODO!
  779. if (fOptions & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  780. {
  781. for (k=0, i=MAX_MIDI_CHANNELS; k < MAX_MIDI_CHANNELS; ++k)
  782. {
  783. fMidiEvents[k].type = kVstMidiType;
  784. fMidiEvents[k].byteSize = sizeof(VstMidiEvent);
  785. fMidiEvents[k].midiData[0] = MIDI_STATUS_CONTROL_CHANGE + k;
  786. fMidiEvents[k].midiData[1] = MIDI_CONTROL_ALL_SOUND_OFF;
  787. fMidiEvents[k+i].type = kVstMidiType;
  788. fMidiEvents[k+i].byteSize = sizeof(VstMidiEvent);
  789. fMidiEvents[k+i].midiData[0] = MIDI_STATUS_CONTROL_CHANGE + k;
  790. fMidiEvents[k+i].midiData[1] = MIDI_CONTROL_ALL_SOUND_OFF;
  791. }
  792. fMidiEventCount = MAX_MIDI_CHANNELS*2;
  793. }
  794. else
  795. {
  796. }
  797. if (kData->latency > 0)
  798. {
  799. for (i=0; i < kData->audioIn.count; ++i)
  800. carla_zeroFloat(kData->latencyBuffers[i], kData->latency);
  801. }
  802. kData->needsReset = false;
  803. }
  804. CARLA_PROCESS_CONTINUE_CHECK;
  805. // --------------------------------------------------------------------------------------------------------
  806. // Set TimeInfo
  807. const EngineTimeInfo& timeInfo(kData->engine->getTimeInfo());
  808. fTimeInfo.flags = kVstTransportChanged;
  809. if (timeInfo.playing)
  810. fTimeInfo.flags |= kVstTransportPlaying;
  811. fTimeInfo.samplePos = timeInfo.frame;
  812. fTimeInfo.sampleRate = kData->engine->getSampleRate();
  813. fTimeInfo.nanoSeconds = timeInfo.time/1000;
  814. fTimeInfo.flags |= kVstNanosValid;
  815. if (timeInfo.valid & EngineTimeInfo::ValidBBT)
  816. {
  817. double ppqBar = double(timeInfo.bbt.bar - 1) * timeInfo.bbt.beatsPerBar;
  818. double ppqBeat = double(timeInfo.bbt.beat - 1);
  819. double ppqTick = double(timeInfo.bbt.tick) / timeInfo.bbt.ticksPerBeat;
  820. // PPQ Pos
  821. fTimeInfo.ppqPos = ppqBar + ppqBeat + ppqTick;
  822. fTimeInfo.flags |= kVstPpqPosValid;
  823. // Tempo
  824. fTimeInfo.tempo = timeInfo.bbt.beatsPerMinute;
  825. fTimeInfo.flags |= kVstTempoValid;
  826. // Bars
  827. fTimeInfo.barStartPos = ppqBar;
  828. fTimeInfo.flags |= kVstBarsValid;
  829. // Time Signature
  830. fTimeInfo.timeSigNumerator = timeInfo.bbt.beatsPerBar;
  831. fTimeInfo.timeSigDenominator = timeInfo.bbt.beatType;
  832. fTimeInfo.flags |= kVstTimeSigValid;
  833. }
  834. else
  835. {
  836. // Tempo
  837. fTimeInfo.tempo = 120.0;
  838. fTimeInfo.flags |= kVstTempoValid;
  839. // Time Signature
  840. fTimeInfo.timeSigNumerator = 4;
  841. fTimeInfo.timeSigDenominator = 4;
  842. fTimeInfo.flags |= kVstTimeSigValid;
  843. // Missing info
  844. fTimeInfo.ppqPos = 0.0;
  845. fTimeInfo.barStartPos = 0.0;
  846. }
  847. CARLA_PROCESS_CONTINUE_CHECK;
  848. // --------------------------------------------------------------------------------------------------------
  849. // Event Input and Processing
  850. if (kData->event.portIn != nullptr)
  851. {
  852. // ----------------------------------------------------------------------------------------------------
  853. // MIDI Input (External)
  854. if (kData->extNotes.mutex.tryLock())
  855. {
  856. while (fMidiEventCount < MAX_MIDI_EVENTS*2 && ! kData->extNotes.data.isEmpty())
  857. {
  858. const ExternalMidiNote& note(kData->extNotes.data.getFirst(true));
  859. CARLA_ASSERT(note.channel >= 0 && note.channel < MAX_MIDI_CHANNELS);
  860. fMidiEvents[fMidiEventCount].type = kVstMidiType;
  861. fMidiEvents[fMidiEventCount].byteSize = sizeof(VstMidiEvent);
  862. fMidiEvents[fMidiEventCount].midiData[0] = (note.velo > 0) ? MIDI_STATUS_NOTE_ON : MIDI_STATUS_NOTE_OFF;
  863. fMidiEvents[fMidiEventCount].midiData[0] += note.channel;
  864. fMidiEvents[fMidiEventCount].midiData[1] = note.note;
  865. fMidiEvents[fMidiEventCount].midiData[2] = note.velo;
  866. fMidiEventCount += 1;
  867. }
  868. kData->extNotes.mutex.unlock();
  869. } // End of MIDI Input (External)
  870. // ----------------------------------------------------------------------------------------------------
  871. // Event Input (System)
  872. bool allNotesOffSent = false;
  873. bool sampleAccurate = (fOptions & PLUGIN_OPTION_FIXED_BUFFER) == 0;
  874. uint32_t time, nEvents = kData->event.portIn->getEventCount();
  875. uint32_t startTime = 0;
  876. uint32_t timeOffset = 0;
  877. for (i=0; i < nEvents; ++i)
  878. {
  879. const EngineEvent& event = kData->event.portIn->getEvent(i);
  880. time = event.time;
  881. if (time >= frames)
  882. continue;
  883. CARLA_ASSERT_INT2(time >= timeOffset, time, timeOffset);
  884. if (time > timeOffset && sampleAccurate)
  885. {
  886. if (processSingle(inBuffer, outBuffer, time - timeOffset, timeOffset))
  887. {
  888. startTime = 0;
  889. timeOffset = time;
  890. if (fMidiEventCount > 0)
  891. {
  892. carla_zeroStruct<VstMidiEvent>(fMidiEvents, fMidiEventCount);
  893. fMidiEventCount = 0;
  894. }
  895. }
  896. else
  897. startTime += timeOffset;
  898. }
  899. // Control change
  900. switch (event.type)
  901. {
  902. case kEngineEventTypeNull:
  903. break;
  904. case kEngineEventTypeControl:
  905. {
  906. const EngineControlEvent& ctrlEvent = event.ctrl;
  907. switch (ctrlEvent.type)
  908. {
  909. case kEngineControlEventTypeNull:
  910. break;
  911. case kEngineControlEventTypeParameter:
  912. {
  913. // Control backend stuff
  914. if (event.channel == kData->ctrlChannel)
  915. {
  916. float value;
  917. if (MIDI_IS_CONTROL_BREATH_CONTROLLER(ctrlEvent.param) && (fHints & PLUGIN_CAN_DRYWET) > 0)
  918. {
  919. value = ctrlEvent.value;
  920. setDryWet(value, false, false);
  921. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_DRYWET, 0, value);
  922. continue;
  923. }
  924. if (MIDI_IS_CONTROL_CHANNEL_VOLUME(ctrlEvent.param) && (fHints & PLUGIN_CAN_VOLUME) > 0)
  925. {
  926. value = ctrlEvent.value*127.0f/100.0f;
  927. setVolume(value, false, false);
  928. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_VOLUME, 0, value);
  929. continue;
  930. }
  931. if (MIDI_IS_CONTROL_BALANCE(ctrlEvent.param) && (fHints & PLUGIN_CAN_BALANCE) > 0)
  932. {
  933. float left, right;
  934. value = ctrlEvent.value/0.5f - 1.0f;
  935. if (value < 0.0f)
  936. {
  937. left = -1.0f;
  938. right = (value*2.0f)+1.0f;
  939. }
  940. else if (value > 0.0f)
  941. {
  942. left = (value*2.0f)-1.0f;
  943. right = 1.0f;
  944. }
  945. else
  946. {
  947. left = -1.0f;
  948. right = 1.0f;
  949. }
  950. setBalanceLeft(left, false, false);
  951. setBalanceRight(right, false, false);
  952. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_LEFT, 0, left);
  953. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_BALANCE_RIGHT, 0, right);
  954. continue;
  955. }
  956. }
  957. // Control plugin parameters
  958. for (k=0; k < kData->param.count; ++k)
  959. {
  960. if (kData->param.data[k].midiChannel != event.channel)
  961. continue;
  962. if (kData->param.data[k].midiCC != ctrlEvent.param)
  963. continue;
  964. if (kData->param.data[k].type != PARAMETER_INPUT)
  965. continue;
  966. if ((kData->param.data[k].hints & PARAMETER_IS_AUTOMABLE) == 0)
  967. continue;
  968. float value;
  969. if (kData->param.data[k].hints & PARAMETER_IS_BOOLEAN)
  970. {
  971. value = (ctrlEvent.value < 0.5f) ? kData->param.ranges[k].min : kData->param.ranges[k].max;
  972. }
  973. else
  974. {
  975. value = kData->param.ranges[i].unnormalizeValue(ctrlEvent.value);
  976. if (kData->param.data[k].hints & PARAMETER_IS_INTEGER)
  977. value = std::rint(value);
  978. }
  979. setParameterValue(k, value, false, false, false);
  980. postponeRtEvent(kPluginPostRtEventParameterChange, static_cast<int32_t>(k), 0, value);
  981. }
  982. break;
  983. }
  984. case kEngineControlEventTypeMidiBank:
  985. break;
  986. case kEngineControlEventTypeMidiProgram:
  987. if (event.channel == kData->ctrlChannel && (fOptions & PLUGIN_OPTION_MAP_PROGRAM_CHANGES) != 0)
  988. {
  989. if (ctrlEvent.param < kData->prog.count)
  990. {
  991. setProgram(ctrlEvent.param, false, false, false);
  992. postponeRtEvent(kPluginPostRtEventProgramChange, ctrlEvent.param, 0, 0.0f);
  993. break;
  994. }
  995. }
  996. break;
  997. case kEngineControlEventTypeAllSoundOff:
  998. if (event.channel == kData->ctrlChannel)
  999. {
  1000. if (! allNotesOffSent)
  1001. {
  1002. sendMidiAllNotesOff();
  1003. allNotesOffSent = true;
  1004. }
  1005. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_ACTIVE, 0, 0.0f);
  1006. postponeRtEvent(kPluginPostRtEventParameterChange, PARAMETER_ACTIVE, 0, 1.0f);
  1007. }
  1008. if (fMidiEventCount >= MAX_MIDI_EVENTS*2)
  1009. continue;
  1010. if (fOptions & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  1011. {
  1012. carla_zeroStruct<VstMidiEvent>(fMidiEvents[fMidiEventCount]);
  1013. fMidiEvents[fMidiEventCount].type = kVstMidiType;
  1014. fMidiEvents[fMidiEventCount].byteSize = sizeof(VstMidiEvent);
  1015. fMidiEvents[fMidiEventCount].midiData[0] = MIDI_STATUS_CONTROL_CHANGE + event.channel;
  1016. fMidiEvents[fMidiEventCount].midiData[1] = MIDI_CONTROL_ALL_SOUND_OFF;
  1017. fMidiEvents[fMidiEventCount].deltaFrames = sampleAccurate ? startTime : time;
  1018. fMidiEventCount += 1;
  1019. }
  1020. break;
  1021. case kEngineControlEventTypeAllNotesOff:
  1022. if (event.channel == kData->ctrlChannel)
  1023. {
  1024. if (! allNotesOffSent)
  1025. {
  1026. allNotesOffSent = true;
  1027. sendMidiAllNotesOff();
  1028. }
  1029. }
  1030. if (fMidiEventCount >= MAX_MIDI_EVENTS*2)
  1031. continue;
  1032. if (fOptions & PLUGIN_OPTION_SEND_ALL_SOUND_OFF)
  1033. {
  1034. carla_zeroStruct<VstMidiEvent>(fMidiEvents[fMidiEventCount]);
  1035. fMidiEvents[fMidiEventCount].type = kVstMidiType;
  1036. fMidiEvents[fMidiEventCount].byteSize = sizeof(VstMidiEvent);
  1037. fMidiEvents[fMidiEventCount].midiData[0] = MIDI_STATUS_CONTROL_CHANGE + event.channel;
  1038. fMidiEvents[fMidiEventCount].midiData[1] = MIDI_CONTROL_ALL_NOTES_OFF;
  1039. fMidiEvents[fMidiEventCount].deltaFrames = sampleAccurate ? startTime : time;
  1040. fMidiEventCount += 1;
  1041. }
  1042. break;
  1043. }
  1044. break;
  1045. }
  1046. case kEngineEventTypeMidi:
  1047. {
  1048. if (fMidiEventCount >= MAX_MIDI_EVENTS*2)
  1049. continue;
  1050. const EngineMidiEvent& midiEvent = event.midi;
  1051. uint8_t status = MIDI_GET_STATUS_FROM_DATA(midiEvent.data);
  1052. uint8_t channel = event.channel;
  1053. if (MIDI_IS_STATUS_AFTERTOUCH(status) && (fOptions & PLUGIN_OPTION_SEND_CHANNEL_PRESSURE) == 0)
  1054. continue;
  1055. if (MIDI_IS_STATUS_CONTROL_CHANGE(status) && (fOptions & PLUGIN_OPTION_SEND_CONTROL_CHANGES) == 0)
  1056. continue;
  1057. if (MIDI_IS_STATUS_POLYPHONIC_AFTERTOUCH(status) && (fOptions & PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH) == 0)
  1058. continue;
  1059. if (MIDI_IS_STATUS_PITCH_WHEEL_CONTROL(status) && (fOptions & PLUGIN_OPTION_SEND_PITCHBEND) == 0)
  1060. continue;
  1061. // Fix bad note-off
  1062. if (status == MIDI_STATUS_NOTE_ON && midiEvent.data[2] == 0)
  1063. status -= 0x10;
  1064. carla_zeroStruct<VstMidiEvent>(fMidiEvents[fMidiEventCount]);
  1065. fMidiEvents[fMidiEventCount].type = kVstMidiType;
  1066. fMidiEvents[fMidiEventCount].byteSize = sizeof(VstMidiEvent);
  1067. fMidiEvents[fMidiEventCount].midiData[0] = status + channel;
  1068. fMidiEvents[fMidiEventCount].midiData[1] = midiEvent.data[1];
  1069. fMidiEvents[fMidiEventCount].midiData[2] = midiEvent.data[2];
  1070. fMidiEvents[fMidiEventCount].deltaFrames = sampleAccurate ? startTime : time;
  1071. fMidiEventCount += 1;
  1072. if (status == MIDI_STATUS_NOTE_ON)
  1073. postponeRtEvent(kPluginPostRtEventNoteOn, channel, midiEvent.data[1], midiEvent.data[2]);
  1074. else if (status == MIDI_STATUS_NOTE_OFF)
  1075. postponeRtEvent(kPluginPostRtEventNoteOff, channel, midiEvent.data[1], 0.0f);
  1076. break;
  1077. }
  1078. }
  1079. }
  1080. kData->postRtEvents.trySplice();
  1081. if (frames > timeOffset)
  1082. processSingle(inBuffer, outBuffer, frames - timeOffset, timeOffset);
  1083. } // End of Event Input and Processing
  1084. // --------------------------------------------------------------------------------------------------------
  1085. // Plugin processing (no events)
  1086. else
  1087. {
  1088. processSingle(inBuffer, outBuffer, frames, 0);
  1089. } // End of Plugin processing (no events)
  1090. CARLA_PROCESS_CONTINUE_CHECK;
  1091. // --------------------------------------------------------------------------------------------------------
  1092. // MIDI Output
  1093. if (kData->event.portOut != nullptr)
  1094. {
  1095. // reverse lookup MIDI events
  1096. for (k = (MAX_MIDI_EVENTS*2)-1; k >= fMidiEventCount; --k)
  1097. {
  1098. if (fMidiEvents[k].type == 0)
  1099. break;
  1100. const uint8_t channel = MIDI_GET_CHANNEL_FROM_DATA(fMidiEvents[k].midiData);
  1101. uint8_t midiData[3] = { 0 };
  1102. midiData[0] = fMidiEvents[k].midiData[0];
  1103. midiData[1] = fMidiEvents[k].midiData[1];
  1104. midiData[2] = fMidiEvents[k].midiData[2];
  1105. kData->event.portOut->writeMidiEvent(fMidiEvents[k].deltaFrames, channel, 0, midiData, 3);
  1106. }
  1107. } // End of Control and MIDI Output
  1108. }
  1109. bool processSingle(float** const inBuffer, float** const outBuffer, const uint32_t frames, const uint32_t timeOffset)
  1110. {
  1111. CARLA_ASSERT(frames > 0);
  1112. if (frames == 0)
  1113. return false;
  1114. if (kData->audioIn.count > 0)
  1115. {
  1116. CARLA_ASSERT(inBuffer != nullptr);
  1117. if (inBuffer == nullptr)
  1118. return false;
  1119. }
  1120. if (kData->audioOut.count > 0)
  1121. {
  1122. CARLA_ASSERT(outBuffer != nullptr);
  1123. if (outBuffer == nullptr)
  1124. return false;
  1125. }
  1126. uint32_t i, k;
  1127. // --------------------------------------------------------------------------------------------------------
  1128. // Try lock, silence otherwise
  1129. if (kData->engine->isOffline())
  1130. {
  1131. kData->singleMutex.lock();
  1132. }
  1133. else if (! kData->singleMutex.tryLock())
  1134. {
  1135. for (i=0; i < kData->audioOut.count; ++i)
  1136. {
  1137. for (k=0; k < frames; ++k)
  1138. outBuffer[i][k+timeOffset] = 0.0f;
  1139. }
  1140. return false;
  1141. }
  1142. // --------------------------------------------------------------------------------------------------------
  1143. // Set audio buffers
  1144. float* vstInBuffer[kData->audioIn.count];
  1145. float* vstOutBuffer[kData->audioOut.count];
  1146. for (i=0; i < kData->audioIn.count; ++i)
  1147. vstInBuffer[i] = inBuffer[i]+timeOffset;
  1148. for (i=0; i < kData->audioOut.count; ++i)
  1149. vstOutBuffer[i] = outBuffer[i]+timeOffset;
  1150. // --------------------------------------------------------------------------------------------------------
  1151. // Set MIDI events
  1152. if (fMidiEventCount > 0)
  1153. {
  1154. fEvents.numEvents = fMidiEventCount;
  1155. fEvents.reserved = 0;
  1156. dispatcher(effProcessEvents, 0, 0, &fEvents, 0.0f);
  1157. }
  1158. // --------------------------------------------------------------------------------------------------------
  1159. // Run plugin
  1160. fIsProcessing = true;
  1161. if (fHints & PLUGIN_CAN_PROCESS_REPLACING)
  1162. {
  1163. fEffect->processReplacing(fEffect,
  1164. (kData->audioIn.count > 0) ? vstInBuffer : nullptr,
  1165. (kData->audioOut.count > 0) ? vstOutBuffer : nullptr,
  1166. frames);
  1167. }
  1168. else
  1169. {
  1170. for (i=0; i < kData->audioOut.count; ++i)
  1171. carla_zeroFloat(vstOutBuffer[i], frames);
  1172. #if ! VST_FORCE_DEPRECATED
  1173. fEffect->process(fEffect,
  1174. (kData->audioIn.count > 0) ? vstInBuffer : nullptr,
  1175. (kData->audioOut.count > 0) ? vstOutBuffer : nullptr,
  1176. frames);
  1177. #endif
  1178. }
  1179. fIsProcessing = false;
  1180. fTimeInfo.samplePos += frames;
  1181. // --------------------------------------------------------------------------------------------------------
  1182. // Post-processing (dry/wet, volume and balance)
  1183. {
  1184. const bool doVolume = (fHints & PLUGIN_CAN_VOLUME) != 0 && kData->postProc.volume != 1.0f;
  1185. const bool doDryWet = (fHints & PLUGIN_CAN_DRYWET) != 0 && kData->postProc.dryWet != 1.0f;
  1186. const bool doBalance = (fHints & PLUGIN_CAN_BALANCE) != 0 && (kData->postProc.balanceLeft != -1.0f || kData->postProc.balanceRight != 1.0f);
  1187. bool isPair;
  1188. float bufValue, oldBufLeft[doBalance ? frames : 1];
  1189. for (i=0; i < kData->audioOut.count; ++i)
  1190. {
  1191. // Dry/Wet
  1192. if (doDryWet)
  1193. {
  1194. for (k=0; k < frames; ++k)
  1195. {
  1196. bufValue = inBuffer[(kData->audioIn.count == 1) ? 0 : i][k+timeOffset];
  1197. outBuffer[i][k+timeOffset] = (outBuffer[i][k+timeOffset] * kData->postProc.dryWet) + (bufValue * (1.0f - kData->postProc.dryWet));
  1198. }
  1199. }
  1200. // Balance
  1201. if (doBalance)
  1202. {
  1203. isPair = (i % 2 == 0);
  1204. if (isPair)
  1205. {
  1206. CARLA_ASSERT(i+1 < kData->audioOut.count);
  1207. carla_copyFloat(oldBufLeft, outBuffer[i]+timeOffset, frames);
  1208. }
  1209. float balRangeL = (kData->postProc.balanceLeft + 1.0f)/2.0f;
  1210. float balRangeR = (kData->postProc.balanceRight + 1.0f)/2.0f;
  1211. for (k=0; k < frames; ++k)
  1212. {
  1213. if (isPair)
  1214. {
  1215. // left
  1216. outBuffer[i][k+timeOffset] = oldBufLeft[k] * (1.0f - balRangeL);
  1217. outBuffer[i][k+timeOffset] += outBuffer[i+1][k+timeOffset] * (1.0f - balRangeR);
  1218. }
  1219. else
  1220. {
  1221. // right
  1222. outBuffer[i][k+timeOffset] = outBuffer[i][k+timeOffset] * balRangeR;
  1223. outBuffer[i][k+timeOffset] += oldBufLeft[k] * balRangeL;
  1224. }
  1225. }
  1226. }
  1227. // Volume
  1228. if (doVolume)
  1229. {
  1230. for (k=0; k < frames; ++k)
  1231. outBuffer[i][k+timeOffset] *= kData->postProc.volume;
  1232. }
  1233. }
  1234. } // End of Post-processing
  1235. // --------------------------------------------------------------------------------------------------------
  1236. kData->singleMutex.unlock();
  1237. return true;
  1238. }
  1239. void bufferSizeChanged(const uint32_t newBufferSize)
  1240. {
  1241. CARLA_ASSERT_INT(newBufferSize > 0, newBufferSize);
  1242. carla_debug("VstPlugin::bufferSizeChanged(%i)", newBufferSize);
  1243. if (kData->active)
  1244. deactivate();
  1245. #if ! VST_FORCE_DEPRECATED
  1246. dispatcher(effSetBlockSizeAndSampleRate, 0, newBufferSize, nullptr, kData->engine->getSampleRate());
  1247. #endif
  1248. dispatcher(effSetBlockSize, 0, newBufferSize, nullptr, 0.0f);
  1249. if (kData->active)
  1250. activate();
  1251. }
  1252. void sampleRateChanged(const double newSampleRate)
  1253. {
  1254. CARLA_ASSERT_INT(newSampleRate > 0.0, newSampleRate);
  1255. carla_debug("VstPlugin::sampleRateChanged(%g)", newSampleRate);
  1256. if (kData->active)
  1257. deactivate();
  1258. #if ! VST_FORCE_DEPRECATED
  1259. dispatcher(effSetBlockSizeAndSampleRate, 0, kData->engine->getBufferSize(), nullptr, newSampleRate);
  1260. #endif
  1261. dispatcher(effSetSampleRate, 0, 0, nullptr, newSampleRate);
  1262. if (kData->active)
  1263. activate();
  1264. }
  1265. // -------------------------------------------------------------------
  1266. // Post-poned events
  1267. void uiParameterChange(const uint32_t index, const double value)
  1268. {
  1269. CARLA_ASSERT(index < kData->param.count);
  1270. if (index >= kData->param.count)
  1271. return;
  1272. if (! fGui.isOsc)
  1273. return;
  1274. if (kData->osc.data.target == nullptr)
  1275. return;
  1276. osc_send_control(&kData->osc.data, kData->param.data[index].rindex, value);
  1277. }
  1278. void uiProgramChange(const uint32_t index)
  1279. {
  1280. CARLA_ASSERT(index < kData->prog.count);
  1281. if (index >= kData->prog.count)
  1282. return;
  1283. if (! fGui.isOsc)
  1284. return;
  1285. if (kData->osc.data.target == nullptr)
  1286. return;
  1287. osc_send_program(&kData->osc.data, index);
  1288. }
  1289. void uiNoteOn(const uint8_t channel, const uint8_t note, const uint8_t velo)
  1290. {
  1291. CARLA_ASSERT(channel < MAX_MIDI_CHANNELS);
  1292. CARLA_ASSERT(note < MAX_MIDI_NOTE);
  1293. CARLA_ASSERT(velo > 0 && velo < MAX_MIDI_VALUE);
  1294. if (channel >= MAX_MIDI_CHANNELS)
  1295. return;
  1296. if (note >= MAX_MIDI_NOTE)
  1297. return;
  1298. if (velo >= MAX_MIDI_VALUE)
  1299. return;
  1300. if (! fGui.isOsc)
  1301. return;
  1302. if (kData->osc.data.target == nullptr)
  1303. return;
  1304. uint8_t midiData[4] = { 0 };
  1305. midiData[1] = MIDI_STATUS_NOTE_ON + channel;
  1306. midiData[2] = note;
  1307. midiData[3] = velo;
  1308. osc_send_midi(&kData->osc.data, midiData);
  1309. }
  1310. void uiNoteOff(const uint8_t channel, const uint8_t note)
  1311. {
  1312. CARLA_ASSERT(channel < MAX_MIDI_CHANNELS);
  1313. CARLA_ASSERT(note < MAX_MIDI_NOTE);
  1314. if (channel >= MAX_MIDI_CHANNELS)
  1315. return;
  1316. if (note >= MAX_MIDI_NOTE)
  1317. return;
  1318. if (! fGui.isOsc)
  1319. return;
  1320. if (kData->osc.data.target == nullptr)
  1321. return;
  1322. uint8_t midiData[4] = { 0 };
  1323. midiData[1] = MIDI_STATUS_NOTE_OFF + channel;
  1324. midiData[2] = note;
  1325. osc_send_midi(&kData->osc.data, midiData);
  1326. }
  1327. // -------------------------------------------------------------------
  1328. protected:
  1329. void guiClosedCallback()
  1330. {
  1331. showGui(false);
  1332. kData->engine->callback(CALLBACK_SHOW_GUI, fId, 0, 0, 0.0f, nullptr);
  1333. }
  1334. intptr_t dispatcher(int32_t opcode, int32_t index, intptr_t value, void* ptr, float opt)
  1335. {
  1336. #if defined(DEBUG) && ! defined(CARLA_OS_WIN)
  1337. if (opcode != effEditIdle && opcode != effProcessEvents)
  1338. carla_debug("VstPlugin::dispatcher(%02i:%s, %i, " P_INTPTR ", %p, %f)", opcode, vstEffectOpcode2str(opcode), index, value, ptr, opt);
  1339. #endif
  1340. CARLA_ASSERT(fEffect != nullptr);
  1341. return (fEffect != nullptr) ? fEffect->dispatcher(fEffect, opcode, index, value, ptr, opt) : 0;
  1342. }
  1343. intptr_t handleAudioMasterCallback(const int32_t opcode, const int32_t index, const intptr_t value, void* const ptr, const float opt)
  1344. {
  1345. #if 0
  1346. // Cockos VST extensions
  1347. if (ptr != nullptr && static_cast<uint32_t>(opcode) == 0xdeadbeef && static_cast<uint32_t>(index) == 0xdeadf00d)
  1348. {
  1349. const char* const func = (char*)ptr;
  1350. if (std::strcmp(func, "GetPlayPosition") == 0)
  1351. return 0;
  1352. if (std::strcmp(func, "GetPlayPosition2") == 0)
  1353. return 0;
  1354. if (std::strcmp(func, "GetCursorPosition") == 0)
  1355. return 0;
  1356. if (std::strcmp(func, "GetPlayState") == 0)
  1357. return 0;
  1358. if (std::strcmp(func, "SetEditCurPos") == 0)
  1359. return 0;
  1360. if (std::strcmp(func, "GetSetRepeat") == 0)
  1361. return 0;
  1362. if (std::strcmp(func, "GetProjectPath") == 0)
  1363. return 0;
  1364. if (std::strcmp(func, "OnPlayButton") == 0)
  1365. return 0;
  1366. if (std::strcmp(func, "OnStopButton") == 0)
  1367. return 0;
  1368. if (std::strcmp(func, "OnPauseButton") == 0)
  1369. return 0;
  1370. if (std::strcmp(func, "IsInRealTimeAudio") == 0)
  1371. return 0;
  1372. if (std::strcmp(func, "Audio_IsRunning") == 0)
  1373. return 0;
  1374. }
  1375. #endif
  1376. intptr_t ret = 0;
  1377. switch (opcode)
  1378. {
  1379. case audioMasterAutomate:
  1380. if (! fEnabled)
  1381. break;
  1382. // plugins should never do this:
  1383. CARLA_SAFE_ASSERT_INT(index < static_cast<int32_t>(kData->param.count), index);
  1384. if (index < 0 || index >= static_cast<int32_t>(kData->param.count))
  1385. break;
  1386. if (fGui.isVisible && ! fIsProcessing)
  1387. {
  1388. // Called from GUI
  1389. setParameterValue(index, opt, false, true, true);
  1390. }
  1391. else if (fIsProcessing)
  1392. {
  1393. // Called from engine
  1394. const float fixedValue = kData->param.fixValue(index, opt);
  1395. if (kData->engine->isOffline())
  1396. {
  1397. CarlaPlugin::setParameterValue(index, fixedValue, true, true, true);
  1398. }
  1399. else
  1400. {
  1401. CarlaPlugin::setParameterValue(index, fixedValue, false, false, false);
  1402. postponeRtEvent(kPluginPostRtEventParameterChange, index, 0, fixedValue);
  1403. }
  1404. }
  1405. else
  1406. {
  1407. carla_stdout("audioMasterAutomate called from unknown source");
  1408. }
  1409. break;
  1410. case audioMasterCurrentId:
  1411. // TODO
  1412. // if using old sdk, return effect->uniqueID
  1413. break;
  1414. case audioMasterIdle:
  1415. if (fGui.isVisible)
  1416. dispatcher(effEditIdle, 0, 0, nullptr, 0.0f);
  1417. break;
  1418. #if ! VST_FORCE_DEPRECATED
  1419. case audioMasterPinConnected:
  1420. // Deprecated in VST SDK 2.4
  1421. // TODO
  1422. break;
  1423. case audioMasterWantMidi:
  1424. // Deprecated in VST SDK 2.4
  1425. fHints |= PLUGIN_WANTS_MIDI_INPUT;
  1426. break;
  1427. #endif
  1428. case audioMasterGetTime:
  1429. #ifdef VESTIGE_HEADER
  1430. ret = getAddressFromPointer(&fTimeInfo);
  1431. #else
  1432. ret = ToVstPtr<VstTimeInfo_R>(&fTimeInfo);
  1433. #endif
  1434. break;
  1435. case audioMasterProcessEvents:
  1436. CARLA_ASSERT(fEnabled);
  1437. CARLA_ASSERT(fIsProcessing);
  1438. CARLA_ASSERT(kData->event.portOut != nullptr);
  1439. CARLA_ASSERT(ptr != nullptr);
  1440. if (! fEnabled)
  1441. return 0;
  1442. if (! fIsProcessing)
  1443. return 0;
  1444. if (kData->event.portOut == nullptr)
  1445. return 0;
  1446. if (ptr == nullptr)
  1447. return 0;
  1448. #if 0
  1449. if (! isProcessing)
  1450. {
  1451. carla_stderr2("VstPlugin::handleAudioMasterProcessEvents(%p) - received MIDI out events outside audio thread, ignoring", vstEvents);
  1452. return 0;
  1453. }
  1454. for (int32_t i=0; i < vstEvents->numEvents && events.numEvents < MAX_MIDI_EVENTS*2; ++i)
  1455. {
  1456. if (! vstEvents->events[i])
  1457. break;
  1458. const VstMidiEvent* const vstMidiEvent = (const VstMidiEvent*)vstEvents->events[i];
  1459. if (vstMidiEvent->type == kVstMidiType)
  1460. memcpy(&midiEvents[events.numEvents++], vstMidiEvent, sizeof(VstMidiEvent));
  1461. }
  1462. #endif
  1463. ret = 1;
  1464. break;
  1465. #if ! VST_FORCE_DEPRECATED
  1466. case audioMasterSetTime:
  1467. // Deprecated in VST SDK 2.4
  1468. break;
  1469. case audioMasterTempoAt:
  1470. // Deprecated in VST SDK 2.4
  1471. CARLA_ASSERT(fIsProcessing);
  1472. ret = fTimeInfo.tempo * 10000;
  1473. break;
  1474. case audioMasterGetNumAutomatableParameters:
  1475. // Deprecated in VST SDK 2.4
  1476. ret = carla_min<intptr_t>(0, fEffect->numParams, kData->engine->getOptions().maxParameters);
  1477. break;
  1478. case audioMasterGetParameterQuantization:
  1479. // Deprecated in VST SDK 2.4
  1480. ret = 1; // full single float precision
  1481. break;
  1482. #endif
  1483. #if 0
  1484. case audioMasterIOChanged:
  1485. CARLA_ASSERT(fEnabled);
  1486. // TESTING
  1487. if (! fEnabled)
  1488. {
  1489. ret = 1;
  1490. break;
  1491. }
  1492. if (x_engine->getOptions().processMode == PROCESS_MODE_CONTINUOUS_RACK)
  1493. {
  1494. carla_stderr2("VstPlugin::handleAudioMasterIOChanged() - plugin asked IO change, but it's not supported in rack mode");
  1495. return 0;
  1496. }
  1497. engineProcessLock();
  1498. m_enabled = false;
  1499. engineProcessUnlock();
  1500. if (m_active)
  1501. {
  1502. effect->dispatcher(effect, effStopProcess, 0, 0, nullptr, 0.0f);
  1503. effect->dispatcher(effect, effMainsChanged, 0, 0, nullptr, 0.0f);
  1504. }
  1505. reload();
  1506. if (m_active)
  1507. {
  1508. effect->dispatcher(effect, effMainsChanged, 0, 1, nullptr, 0.0f);
  1509. effect->dispatcher(effect, effStartProcess, 0, 0, nullptr, 0.0f);
  1510. }
  1511. x_engine->callback(CALLBACK_RELOAD_ALL, m_id, 0, 0, 0.0, nullptr);
  1512. ret = 1;
  1513. break;
  1514. #endif
  1515. case audioMasterNeedIdle:
  1516. // Deprecated in VST SDK 2.4
  1517. fNeedIdle = true;
  1518. ret = 1;
  1519. break;
  1520. case audioMasterSizeWindow:
  1521. if (kData->gui != nullptr)
  1522. {
  1523. kData->gui->setSize(index, value);
  1524. ret = 1;
  1525. }
  1526. break;
  1527. case audioMasterGetSampleRate:
  1528. ret = kData->engine->getSampleRate();
  1529. break;
  1530. case audioMasterGetBlockSize:
  1531. ret = kData->engine->getBufferSize();
  1532. break;
  1533. case audioMasterGetInputLatency:
  1534. ret = 0;
  1535. break;
  1536. case audioMasterGetOutputLatency:
  1537. ret = 0;
  1538. break;
  1539. #if ! VST_FORCE_DEPRECATED
  1540. case audioMasterGetPreviousPlug:
  1541. // Deprecated in VST SDK 2.4
  1542. // TODO
  1543. break;
  1544. case audioMasterGetNextPlug:
  1545. // Deprecated in VST SDK 2.4
  1546. // TODO
  1547. break;
  1548. case audioMasterWillReplaceOrAccumulate:
  1549. // Deprecated in VST SDK 2.4
  1550. ret = 1; // replace
  1551. break;
  1552. #endif
  1553. case audioMasterGetCurrentProcessLevel:
  1554. if (kData->engine->isOffline())
  1555. ret = kVstProcessLevelOffline;
  1556. else if (fIsProcessing)
  1557. ret = kVstProcessLevelRealtime;
  1558. else
  1559. ret = kVstProcessLevelUser;
  1560. break;
  1561. case audioMasterGetAutomationState:
  1562. ret = kData->active ? kVstAutomationReadWrite : kVstAutomationOff;
  1563. break;
  1564. case audioMasterOfflineStart:
  1565. case audioMasterOfflineRead:
  1566. case audioMasterOfflineWrite:
  1567. case audioMasterOfflineGetCurrentPass:
  1568. case audioMasterOfflineGetCurrentMetaPass:
  1569. // TODO
  1570. break;
  1571. #if ! VST_FORCE_DEPRECATED
  1572. case audioMasterSetOutputSampleRate:
  1573. // Deprecated in VST SDK 2.4
  1574. break;
  1575. case audioMasterGetOutputSpeakerArrangement:
  1576. // Deprecated in VST SDK 2.4
  1577. // TODO
  1578. break;
  1579. #endif
  1580. case audioMasterVendorSpecific:
  1581. // TODO - cockos extensions
  1582. break;
  1583. #if ! VST_FORCE_DEPRECATED
  1584. case audioMasterSetIcon:
  1585. // Deprecated in VST SDK 2.4
  1586. break;
  1587. #endif
  1588. #if ! VST_FORCE_DEPRECATED
  1589. case audioMasterOpenWindow:
  1590. case audioMasterCloseWindow:
  1591. // Deprecated in VST SDK 2.4
  1592. // TODO
  1593. break;
  1594. #endif
  1595. case audioMasterGetDirectory:
  1596. // TODO
  1597. break;
  1598. case audioMasterUpdateDisplay:
  1599. // Idle UI if visible
  1600. if (fGui.isVisible)
  1601. dispatcher(effEditIdle, 0, 0, nullptr, 0.0f);
  1602. // Update current program
  1603. if (kData->prog.count > 0)
  1604. {
  1605. const int32_t current = dispatcher(effGetProgram, 0, 0, nullptr, 0.0f);
  1606. if (current >= 0 && current < static_cast<int32_t>(kData->prog.count))
  1607. {
  1608. char strBuf[STR_MAX+1] = { 0 };
  1609. dispatcher(effGetProgramName, 0, 0, strBuf, 0.0f);
  1610. if (kData->prog.names[current] != nullptr)
  1611. delete[] kData->prog.names[current];
  1612. kData->prog.names[current] = carla_strdup(strBuf);
  1613. if (kData->prog.current != current)
  1614. {
  1615. kData->prog.current = current;
  1616. kData->engine->callback(CALLBACK_PROGRAM_CHANGED, fId, current, 0, 0.0f, nullptr);
  1617. }
  1618. }
  1619. }
  1620. kData->engine->callback(CALLBACK_UPDATE, fId, 0, 0, 0.0f, nullptr);
  1621. ret = 1;
  1622. break;
  1623. case audioMasterBeginEdit:
  1624. case audioMasterEndEdit:
  1625. // TODO
  1626. break;
  1627. case audioMasterOpenFileSelector:
  1628. case audioMasterCloseFileSelector:
  1629. // TODO
  1630. break;
  1631. #if ! VST_FORCE_DEPRECATED
  1632. case audioMasterEditFile:
  1633. // Deprecated in VST SDK 2.4
  1634. // TODO
  1635. break;
  1636. case audioMasterGetChunkFile:
  1637. // Deprecated in VST SDK 2.4
  1638. // TODO
  1639. break;
  1640. case audioMasterGetInputSpeakerArrangement:
  1641. // Deprecated in VST SDK 2.4
  1642. // TODO
  1643. break;
  1644. #endif
  1645. default:
  1646. carla_debug("VstPlugin::handleAudioMasterCallback(%02i:%s, %i, " P_INTPTR ", %p, %f)", opcode, vstMasterOpcode2str(opcode), index, value, ptr, opt);
  1647. break;
  1648. }
  1649. return ret;
  1650. }
  1651. public:
  1652. // -------------------------------------------------------------------
  1653. bool init(const char* const filename, const char* const name)
  1654. {
  1655. CARLA_ASSERT(kData->engine != nullptr);
  1656. CARLA_ASSERT(kData->client == nullptr);
  1657. CARLA_ASSERT(filename != nullptr);
  1658. // ---------------------------------------------------------------
  1659. // first checks
  1660. if (kData->engine == nullptr)
  1661. {
  1662. return false;
  1663. }
  1664. if (kData->client != nullptr)
  1665. {
  1666. kData->engine->setLastError("Plugin client is already registered");
  1667. return false;
  1668. }
  1669. if (filename == nullptr)
  1670. {
  1671. kData->engine->setLastError("null filename");
  1672. return false;
  1673. }
  1674. // ---------------------------------------------------------------
  1675. // open DLL
  1676. if (! kData->libOpen(filename))
  1677. {
  1678. kData->engine->setLastError(kData->libError(filename));
  1679. return false;
  1680. }
  1681. // ---------------------------------------------------------------
  1682. // get DLL main entry
  1683. VST_Function vstFn = (VST_Function)kData->libSymbol("VSTPluginMain");
  1684. if (vstFn == nullptr)
  1685. {
  1686. vstFn = (VST_Function)kData->libSymbol("main");
  1687. if (vstFn == nullptr)
  1688. {
  1689. kData->engine->setLastError("Could not find the VST main entry in the plugin library");
  1690. return false;
  1691. }
  1692. }
  1693. // ---------------------------------------------------------------
  1694. // initialize plugin (part 1)
  1695. sLastVstPlugin = this;
  1696. fEffect = vstFn(carla_vst_audioMasterCallback);
  1697. sLastVstPlugin = nullptr;
  1698. if (fEffect == nullptr)
  1699. {
  1700. kData->engine->setLastError("Plugin failed to initialize");
  1701. return false;
  1702. }
  1703. if (fEffect->magic != kEffectMagic)
  1704. {
  1705. kData->engine->setLastError("Plugin is not valid (wrong vst effect magic code)");
  1706. return false;
  1707. }
  1708. #ifdef VESTIGE_HEADER
  1709. fEffect->ptr1 = this;
  1710. #else
  1711. fEffect->resvd1 = ToVstPtr<VstPlugin>(this);
  1712. #endif
  1713. dispatcher(effOpen, 0, 0, nullptr, 0.0f);
  1714. // ---------------------------------------------------------------
  1715. // get info
  1716. if (name != nullptr)
  1717. {
  1718. fName = kData->engine->getNewUniquePluginName(name);
  1719. }
  1720. else
  1721. {
  1722. char strBuf[STR_MAX+1] = { '\0' };
  1723. dispatcher(effGetEffectName, 0, 0, strBuf, 0.0f);
  1724. if (strBuf[0] != '\0')
  1725. {
  1726. fName = kData->engine->getNewUniquePluginName(strBuf);
  1727. }
  1728. else
  1729. {
  1730. const char* const label = std::strrchr(filename, OS_SEP)+1;
  1731. fName = kData->engine->getNewUniquePluginName(label);
  1732. }
  1733. }
  1734. fFilename = filename;
  1735. // ---------------------------------------------------------------
  1736. // register client
  1737. kData->client = kData->engine->addClient(this);
  1738. if (kData->client == nullptr || ! kData->client->isOk())
  1739. {
  1740. kData->engine->setLastError("Failed to register plugin client");
  1741. return false;
  1742. }
  1743. // ---------------------------------------------------------------
  1744. // initialize plugin (part 2)
  1745. #if ! VST_FORCE_DEPRECATED
  1746. dispatcher(effSetBlockSizeAndSampleRate, 0, kData->engine->getBufferSize(), nullptr, kData->engine->getSampleRate());
  1747. #endif
  1748. dispatcher(effSetSampleRate, 0, 0, nullptr, kData->engine->getSampleRate());
  1749. dispatcher(effSetBlockSize, 0, kData->engine->getBufferSize(), nullptr, 0.0f);
  1750. dispatcher(effSetProcessPrecision, 0, kVstProcessPrecision32, nullptr, 0.0f);
  1751. dispatcher(effStopProcess, 0, 0, nullptr, 0.0f);
  1752. dispatcher(effMainsChanged, 0, 0, nullptr, 0.0f);
  1753. if (dispatcher(effGetVstVersion, 0, 0, nullptr, 0.0f) < kVstVersion)
  1754. fHints |= PLUGIN_USES_OLD_VSTSDK;
  1755. if (static_cast<uintptr_t>(dispatcher(effCanDo, 0, 0, (void*)"hasCockosExtensions", 0.0f)) == 0xbeef0000)
  1756. fHints |= PLUGIN_HAS_COCKOS_EXTENSIONS;
  1757. // ---------------------------------------------------------------
  1758. // gui stuff
  1759. if (fEffect->flags & effFlagsHasEditor)
  1760. {
  1761. const EngineOptions& engineOptions(kData->engine->getOptions());
  1762. #if defined(Q_WS_X11)
  1763. CarlaString uiBridgeBinary(engineOptions.bridge_vstX11);
  1764. #elif defined(CARLA_OS_MAC)
  1765. CarlaString uiBridgeBinary(engineOptions.bridge_vstCocoa);
  1766. #elif defined(CARLA_OS_WIN)
  1767. CarlaString uiBridgeBinary(engineOptions.bridge_vstHWND);
  1768. #else
  1769. CarlaString uiBridgeBinary;
  1770. #endif
  1771. if (engineOptions.preferUiBridges && uiBridgeBinary.isNotEmpty() && (fEffect->flags & effFlagsProgramChunks) == 0)
  1772. {
  1773. kData->osc.thread.setOscData(uiBridgeBinary, nullptr);
  1774. fGui.isOsc = true;
  1775. }
  1776. }
  1777. // ---------------------------------------------------------------
  1778. // load plugin settings
  1779. {
  1780. // set default options
  1781. fOptions = 0x0;
  1782. fOptions |= PLUGIN_OPTION_FIXED_BUFFER;
  1783. fOptions |= PLUGIN_OPTION_MAP_PROGRAM_CHANGES;
  1784. if (fEffect->flags & effFlagsProgramChunks)
  1785. fOptions |= PLUGIN_OPTION_USE_CHUNKS;
  1786. //if (mIns > 0)
  1787. {
  1788. fOptions |= PLUGIN_OPTION_SEND_CHANNEL_PRESSURE;
  1789. fOptions |= PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH;
  1790. fOptions |= PLUGIN_OPTION_SEND_PITCHBEND;
  1791. fOptions |= PLUGIN_OPTION_SEND_ALL_SOUND_OFF;
  1792. }
  1793. // load settings
  1794. kData->idStr = "VST/";
  1795. kData->idStr += std::strrchr(filename, OS_SEP)+1;
  1796. kData->idStr += "/";
  1797. kData->idStr += CarlaString(uniqueId());
  1798. fOptions = kData->loadSettings(fOptions, availableOptions());
  1799. }
  1800. return true;
  1801. }
  1802. private:
  1803. int fUnique1;
  1804. AEffect* fEffect;
  1805. uint8_t* fLastChunk;
  1806. uint32_t fMidiEventCount;
  1807. VstMidiEvent fMidiEvents[MAX_MIDI_EVENTS*2];
  1808. VstTimeInfo_R fTimeInfo;
  1809. struct FixedVstEvents {
  1810. int32_t numEvents;
  1811. intptr_t reserved;
  1812. VstEvent* data[MAX_MIDI_EVENTS*2];
  1813. FixedVstEvents()
  1814. : numEvents(0),
  1815. reserved(0),
  1816. data{0} {}
  1817. } fEvents;
  1818. struct GuiInfo {
  1819. bool isOsc;
  1820. bool isVisible;
  1821. GuiInfo()
  1822. : isOsc(false),
  1823. isVisible(false) {}
  1824. } fGui;
  1825. bool fIsProcessing;
  1826. bool fNeedIdle;
  1827. int fUnique2;
  1828. static VstPlugin* sLastVstPlugin;
  1829. // -------------------------------------------------------------------
  1830. static intptr_t carla_vst_hostCanDo(const char* const feature)
  1831. {
  1832. carla_debug("carla_vst_hostCanDo(\"%s\")", feature);
  1833. if (std::strcmp(feature, "supplyIdle") == 0)
  1834. return 1;
  1835. if (std::strcmp(feature, "sendVstEvents") == 0)
  1836. return 1;
  1837. if (std::strcmp(feature, "sendVstMidiEvent") == 0)
  1838. return 1;
  1839. if (std::strcmp(feature, "sendVstMidiEventFlagIsRealtime") == 0)
  1840. return 1;
  1841. if (std::strcmp(feature, "sendVstTimeInfo") == 0)
  1842. return 1;
  1843. if (std::strcmp(feature, "receiveVstEvents") == 0)
  1844. return 1;
  1845. if (std::strcmp(feature, "receiveVstMidiEvent") == 0)
  1846. return 1;
  1847. if (std::strcmp(feature, "receiveVstTimeInfo") == 0)
  1848. return -1;
  1849. if (std::strcmp(feature, "reportConnectionChanges") == 0)
  1850. return -1;
  1851. if (std::strcmp(feature, "acceptIOChanges") == 0)
  1852. return 1;
  1853. if (std::strcmp(feature, "sizeWindow") == 0)
  1854. return 1;
  1855. if (std::strcmp(feature, "offline") == 0)
  1856. return -1;
  1857. if (std::strcmp(feature, "openFileSelector") == 0)
  1858. return -1;
  1859. if (std::strcmp(feature, "closeFileSelector") == 0)
  1860. return -1;
  1861. if (std::strcmp(feature, "startStopProcess") == 0)
  1862. return 1;
  1863. if (std::strcmp(feature, "supportShell") == 0)
  1864. return -1;
  1865. if (std::strcmp(feature, "shellCategory") == 0)
  1866. return -1;
  1867. // unimplemented
  1868. carla_stderr("carla_vst_hostCanDo(\"%s\") - unknown feature", feature);
  1869. return 0;
  1870. }
  1871. static intptr_t VSTCALLBACK carla_vst_audioMasterCallback(AEffect* effect, int32_t opcode, int32_t index, intptr_t value, void* ptr, float opt)
  1872. {
  1873. #if defined(DEBUG) && ! defined(CARLA_OS_WIN)
  1874. if (opcode != audioMasterGetTime && opcode != audioMasterProcessEvents && opcode != audioMasterGetCurrentProcessLevel && opcode != audioMasterGetOutputLatency)
  1875. carla_debug("carla_vst_audioMasterCallback(%p, %02i:%s, %i, " P_INTPTR ", %p, %f)", effect, opcode, vstMasterOpcode2str(opcode), index, value, ptr, opt);
  1876. #endif
  1877. switch (opcode)
  1878. {
  1879. case audioMasterVersion:
  1880. return kVstVersion;
  1881. case audioMasterGetVendorString:
  1882. CARLA_ASSERT(ptr != nullptr);
  1883. if (ptr != nullptr)
  1884. {
  1885. std::strcpy((char*)ptr, "falkTX");
  1886. return 1;
  1887. }
  1888. else
  1889. {
  1890. carla_stderr("carla_vst_audioMasterCallback() - audioMasterGetVendorString called with invalid pointer");
  1891. return 0;
  1892. }
  1893. case audioMasterGetProductString:
  1894. CARLA_ASSERT(ptr != nullptr);
  1895. if (ptr != nullptr)
  1896. {
  1897. std::strcpy((char*)ptr, "Carla");
  1898. return 1;
  1899. }
  1900. else
  1901. {
  1902. carla_stderr("carla_vst_audioMasterCallback() - audioMasterGetProductString called with invalid pointer");
  1903. return 0;
  1904. }
  1905. case audioMasterGetVendorVersion:
  1906. return 0x1000; // 1.0.0
  1907. case audioMasterCanDo:
  1908. CARLA_ASSERT(ptr != nullptr);
  1909. if (ptr != nullptr)
  1910. {
  1911. return carla_vst_hostCanDo((const char*)ptr);
  1912. }
  1913. else
  1914. {
  1915. carla_stderr("carla_vst_audioMasterCallback() - audioMasterCanDo called with invalid pointer");
  1916. return 0;
  1917. }
  1918. case audioMasterGetLanguage:
  1919. return kVstLangEnglish;
  1920. }
  1921. // Check if 'resvd1' points to us, otherwise register ourselfs if possible
  1922. VstPlugin* self = nullptr;
  1923. if (effect != nullptr)
  1924. {
  1925. #ifdef VESTIGE_HEADER
  1926. if (effect->ptr1 != nullptr)
  1927. {
  1928. self = (VstPlugin*)effect->ptr1;
  1929. #else
  1930. if (effect->resvd1 != 0)
  1931. {
  1932. self = FromVstPtr<VstPlugin>(effect->resvd1);
  1933. #endif
  1934. if (self->fUnique1 != self->fUnique2)
  1935. self = nullptr;
  1936. }
  1937. if (self != nullptr)
  1938. {
  1939. if (self->fEffect == nullptr)
  1940. self->fEffect = effect;
  1941. if (self->fEffect != effect)
  1942. {
  1943. carla_stderr2("carla_vst_audioMasterCallback() - host pointer mismatch: %p != %p", self->fEffect, effect);
  1944. self = nullptr;
  1945. }
  1946. }
  1947. else if (sLastVstPlugin != nullptr)
  1948. {
  1949. #ifdef VESTIGE_HEADER
  1950. effect->ptr1 = sLastVstPlugin;
  1951. #else
  1952. effect->resvd1 = ToVstPtr<VstPlugin>(sLastVstPlugin);
  1953. #endif
  1954. self = sLastVstPlugin;
  1955. }
  1956. }
  1957. return (self != nullptr) ? self->handleAudioMasterCallback(opcode, index, value, ptr, opt) : 0;
  1958. }
  1959. CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(VstPlugin)
  1960. };
  1961. VstPlugin* VstPlugin::sLastVstPlugin = nullptr;
  1962. CARLA_BACKEND_END_NAMESPACE
  1963. #else // WANT_VST
  1964. # warning Building without VST support
  1965. #endif
  1966. CARLA_BACKEND_START_NAMESPACE
  1967. CarlaPlugin* CarlaPlugin::newVST(const Initializer& init)
  1968. {
  1969. carla_debug("CarlaPlugin::newVST({%p, \"%s\", \"%s\"})", init.engine, init.filename, init.name);
  1970. #ifdef WANT_VST
  1971. VstPlugin* const plugin = new VstPlugin(init.engine, init.id);
  1972. if (! plugin->init(init.filename, init.name))
  1973. {
  1974. delete plugin;
  1975. return nullptr;
  1976. }
  1977. plugin->reload();
  1978. if (init.engine->getProccessMode() == PROCESS_MODE_CONTINUOUS_RACK && ! CarlaPluginProtectedData::canRunInRack(plugin))
  1979. {
  1980. init.engine->setLastError("Carla's rack mode can only work with Stereo VST plugins, sorry!");
  1981. delete plugin;
  1982. return nullptr;
  1983. }
  1984. return plugin;
  1985. #else
  1986. init.engine->setLastError("VST support not available");
  1987. return nullptr;
  1988. #endif
  1989. }
  1990. CARLA_BACKEND_END_NAMESPACE