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.

2038 lines
68KB

  1. /*
  2. * Carla Plugin Host
  3. * Copyright (C) 2011-2014 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License as
  7. * published by the Free Software Foundation; either version 2 of
  8. * the License, or any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16. */
  17. /* TODO:
  18. * - complete processRack(): carefully add to input, sorted events
  19. * - implement processPatchbay()
  20. * - implement oscSend_control_switch_plugins()
  21. * - proper find&load plugins
  22. * - something about the peaks?
  23. */
  24. #include "CarlaEngineInternal.hpp"
  25. #include "CarlaPlugin.hpp"
  26. #include "CarlaBackendUtils.hpp"
  27. #include "CarlaBinaryUtils.hpp"
  28. #include "CarlaEngineUtils.hpp"
  29. #include "CarlaMathUtils.hpp"
  30. #include "CarlaPipeUtils.hpp"
  31. #include "CarlaStateUtils.hpp"
  32. #include "CarlaMIDI.h"
  33. #include "jackbridge/JackBridge.hpp"
  34. #include "juce_core.h"
  35. using juce::CharPointer_UTF8;
  36. using juce::File;
  37. using juce::MemoryOutputStream;
  38. using juce::ScopedPointer;
  39. using juce::String;
  40. using juce::XmlDocument;
  41. using juce::XmlElement;
  42. CARLA_BACKEND_START_NAMESPACE
  43. // -----------------------------------------------------------------------
  44. // Carla Engine
  45. CarlaEngine::CarlaEngine()
  46. : pData(new ProtectedData(this))
  47. {
  48. carla_debug("CarlaEngine::CarlaEngine()");
  49. }
  50. CarlaEngine::~CarlaEngine()
  51. {
  52. carla_debug("CarlaEngine::~CarlaEngine()");
  53. delete pData;
  54. }
  55. // -----------------------------------------------------------------------
  56. // Static calls
  57. uint CarlaEngine::getDriverCount()
  58. {
  59. carla_debug("CarlaEngine::getDriverCount()");
  60. uint count = 0;
  61. if (jackbridge_is_ok())
  62. count += 1;
  63. #ifndef BUILD_BRIDGE
  64. # if defined(CARLA_OS_MAC) || defined(CARLA_OS_WIN)
  65. count += getJuceApiCount();
  66. # else
  67. count += getRtAudioApiCount();
  68. # endif
  69. #endif
  70. return count;
  71. }
  72. const char* CarlaEngine::getDriverName(const uint index2)
  73. {
  74. carla_debug("CarlaEngine::getDriverName(%i)", index2);
  75. uint index(index2);
  76. if (jackbridge_is_ok() && index-- == 0)
  77. return "JACK";
  78. #ifndef BUILD_BRIDGE
  79. # if defined(CARLA_OS_MAC) || defined(CARLA_OS_WIN)
  80. if (const uint count = getJuceApiCount())
  81. {
  82. if (index < count)
  83. return getJuceApiName(index);
  84. index -= count;
  85. }
  86. # else
  87. if (const uint count = getRtAudioApiCount())
  88. {
  89. if (index < count)
  90. return getRtAudioApiName(index);
  91. index -= count;
  92. }
  93. # endif
  94. #endif
  95. carla_stderr("CarlaEngine::getDriverName(%i) - invalid index", index2);
  96. return nullptr;
  97. }
  98. const char* const* CarlaEngine::getDriverDeviceNames(const uint index2)
  99. {
  100. carla_debug("CarlaEngine::getDriverDeviceNames(%i)", index2);
  101. uint index(index2);
  102. if (jackbridge_is_ok() && index-- == 0)
  103. {
  104. static const char* ret[3] = { "Auto-Connect OFF", "Auto-Connect ON", nullptr };
  105. return ret;
  106. }
  107. #ifndef BUILD_BRIDGE
  108. # if defined(CARLA_OS_MAC) || defined(CARLA_OS_WIN)
  109. if (const uint count = getJuceApiCount())
  110. {
  111. if (index < count)
  112. return getJuceApiDeviceNames(index);
  113. index -= count;
  114. }
  115. # else
  116. if (const uint count = getRtAudioApiCount())
  117. {
  118. if (index < count)
  119. return getRtAudioApiDeviceNames(index);
  120. index -= count;
  121. }
  122. # endif
  123. #endif
  124. carla_stderr("CarlaEngine::getDriverDeviceNames(%i) - invalid index", index2);
  125. return nullptr;
  126. }
  127. const EngineDriverDeviceInfo* CarlaEngine::getDriverDeviceInfo(const uint index2, const char* const deviceName)
  128. {
  129. carla_debug("CarlaEngine::getDriverDeviceInfo(%i, \"%s\")", index2, deviceName);
  130. uint index(index2);
  131. if (jackbridge_is_ok() && index-- == 0)
  132. {
  133. static uint32_t bufSizes[11] = { 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 0 };
  134. static EngineDriverDeviceInfo devInfo;
  135. devInfo.hints = ENGINE_DRIVER_DEVICE_VARIABLE_BUFFER_SIZE;
  136. devInfo.bufferSizes = bufSizes;
  137. devInfo.sampleRates = nullptr;
  138. return &devInfo;
  139. }
  140. #ifndef BUILD_BRIDGE
  141. # if defined(CARLA_OS_MAC) || defined(CARLA_OS_WIN)
  142. if (const uint count = getJuceApiCount())
  143. {
  144. if (index < count)
  145. return getJuceDeviceInfo(index, deviceName);
  146. index -= count;
  147. }
  148. # else
  149. if (const uint count = getRtAudioApiCount())
  150. {
  151. if (index < count)
  152. return getRtAudioDeviceInfo(index, deviceName);
  153. index -= count;
  154. }
  155. # endif
  156. #endif
  157. carla_stderr("CarlaEngine::getDriverDeviceNames(%i, \"%s\") - invalid index", index2, deviceName);
  158. return nullptr;
  159. }
  160. CarlaEngine* CarlaEngine::newDriverByName(const char* const driverName)
  161. {
  162. CARLA_SAFE_ASSERT_RETURN(driverName != nullptr && driverName[0] != '\0', nullptr);
  163. carla_debug("CarlaEngine::newDriverByName(\"%s\")", driverName);
  164. if (std::strcmp(driverName, "JACK") == 0)
  165. return newJack();
  166. #ifndef BUILD_BRIDGE
  167. # if defined(CARLA_OS_MAC) || defined(CARLA_OS_WIN)
  168. // -------------------------------------------------------------------
  169. // macos
  170. if (std::strcmp(driverName, "CoreAudio") == 0)
  171. return newJuce(AUDIO_API_CORE);
  172. // -------------------------------------------------------------------
  173. // windows
  174. if (std::strcmp(driverName, "ASIO") == 0)
  175. return newJuce(AUDIO_API_ASIO);
  176. if (std::strcmp(driverName, "DirectSound") == 0)
  177. return newJuce(AUDIO_API_DS);
  178. #else
  179. // -------------------------------------------------------------------
  180. // common
  181. if (std::strncmp(driverName, "JACK ", 5) == 0)
  182. return newRtAudio(AUDIO_API_JACK);
  183. // -------------------------------------------------------------------
  184. // linux
  185. if (std::strcmp(driverName, "ALSA") == 0)
  186. return newRtAudio(AUDIO_API_ALSA);
  187. if (std::strcmp(driverName, "OSS") == 0)
  188. return newRtAudio(AUDIO_API_OSS);
  189. if (std::strcmp(driverName, "PulseAudio") == 0)
  190. return newRtAudio(AUDIO_API_PULSE);
  191. # endif
  192. #endif
  193. carla_stderr("CarlaEngine::newDriverByName(\"%s\") - invalid driver name", driverName);
  194. return nullptr;
  195. }
  196. // -----------------------------------------------------------------------
  197. // Constant values
  198. uint CarlaEngine::getMaxClientNameSize() const noexcept
  199. {
  200. return STR_MAX/2;
  201. }
  202. uint CarlaEngine::getMaxPortNameSize() const noexcept
  203. {
  204. return STR_MAX;
  205. }
  206. uint CarlaEngine::getCurrentPluginCount() const noexcept
  207. {
  208. return pData->curPluginCount;
  209. }
  210. uint CarlaEngine::getMaxPluginNumber() const noexcept
  211. {
  212. return pData->maxPluginNumber;
  213. }
  214. // -----------------------------------------------------------------------
  215. // Virtual, per-engine type calls
  216. bool CarlaEngine::close()
  217. {
  218. carla_debug("CarlaEngine::close()");
  219. if (pData->curPluginCount != 0)
  220. {
  221. pData->aboutToClose = true;
  222. removeAllPlugins();
  223. }
  224. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  225. if (pData->osc.isControlRegistered())
  226. oscSend_control_exit();
  227. #endif
  228. pData->close();
  229. callback(ENGINE_CALLBACK_ENGINE_STOPPED, 0, 0, 0, 0.0f, nullptr);
  230. return true;
  231. }
  232. void CarlaEngine::idle() noexcept
  233. {
  234. CARLA_SAFE_ASSERT_RETURN(pData->nextAction.opcode == kEnginePostActionNull,); // FIXME REMOVE
  235. CARLA_SAFE_ASSERT_RETURN(pData->nextPluginId == pData->maxPluginNumber,);
  236. CARLA_SAFE_ASSERT_RETURN(getType() != kEngineTypePlugin,);
  237. for (uint i=0; i < pData->curPluginCount; ++i)
  238. {
  239. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  240. if (plugin != nullptr && plugin->isEnabled())
  241. {
  242. const uint hints(plugin->getHints());
  243. if ((hints & PLUGIN_HAS_CUSTOM_UI) != 0 && (hints & PLUGIN_NEEDS_UI_MAIN_THREAD) != 0)
  244. {
  245. try {
  246. plugin->uiIdle();
  247. } CARLA_SAFE_EXCEPTION_CONTINUE("Plugin uiIdle");
  248. }
  249. }
  250. }
  251. #ifdef HAVE_LIBLO
  252. pData->osc.idle();
  253. #endif
  254. }
  255. CarlaEngineClient* CarlaEngine::addClient(CarlaPlugin* const)
  256. {
  257. return new CarlaEngineClient(*this);
  258. }
  259. // -----------------------------------------------------------------------
  260. // Plugin management
  261. bool CarlaEngine::addPlugin(const BinaryType btype, const PluginType ptype,
  262. const char* const filename, const char* const name, const char* const label, const int64_t uniqueId,
  263. const void* const extra, const uint options)
  264. {
  265. CARLA_SAFE_ASSERT_RETURN_ERR(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  266. CARLA_SAFE_ASSERT_RETURN_ERR(pData->plugins != nullptr, "Invalid engine internal data");
  267. CARLA_SAFE_ASSERT_RETURN_ERR(pData->nextPluginId <= pData->maxPluginNumber, "Invalid engine internal data");
  268. CARLA_SAFE_ASSERT_RETURN_ERR(pData->nextAction.opcode == kEnginePostActionNull, "Invalid engine internal data");
  269. CARLA_SAFE_ASSERT_RETURN_ERR(btype != BINARY_NONE, "Invalid plugin binary mode");
  270. CARLA_SAFE_ASSERT_RETURN_ERR(ptype != PLUGIN_NONE, "Invalid plugin type");
  271. CARLA_SAFE_ASSERT_RETURN_ERR((filename != nullptr && filename[0] != '\0') || (label != nullptr && label[0] != '\0'), "Invalid plugin filename and label");
  272. carla_debug("CarlaEngine::addPlugin(%i:%s, %i:%s, \"%s\", \"%s\", \"%s\", " P_INT64 ", %p, %u)", btype, BinaryType2Str(btype), ptype, PluginType2Str(ptype), filename, name, label, uniqueId, extra, options);
  273. uint id;
  274. #ifndef BUILD_BRIDGE
  275. CarlaPlugin* oldPlugin = nullptr;
  276. if (pData->nextPluginId < pData->curPluginCount)
  277. {
  278. id = pData->nextPluginId;
  279. pData->nextPluginId = pData->maxPluginNumber;
  280. oldPlugin = pData->plugins[id].plugin;
  281. CARLA_SAFE_ASSERT_RETURN_ERR(oldPlugin != nullptr, "Invalid replace plugin Id");
  282. }
  283. else
  284. #endif
  285. {
  286. id = pData->curPluginCount;
  287. if (id == pData->maxPluginNumber)
  288. {
  289. setLastError("Maximum number of plugins reached");
  290. return false;
  291. }
  292. CARLA_SAFE_ASSERT_RETURN_ERR(pData->plugins[id].plugin == nullptr, "Invalid engine internal data");
  293. }
  294. CarlaPlugin::Initializer initializer = {
  295. this,
  296. id,
  297. filename,
  298. name,
  299. label,
  300. uniqueId,
  301. options
  302. };
  303. CarlaPlugin* plugin = nullptr;
  304. #ifndef BRIDGE_PLUGIN
  305. CarlaString bridgeBinary(pData->options.binaryDir);
  306. if (bridgeBinary.isNotEmpty())
  307. {
  308. if (btype == BINARY_NATIVE)
  309. {
  310. #ifdef CARLA_OS_WIN
  311. bridgeBinary += CARLA_OS_SEP_STR "carla-bridge-native.exe";
  312. #else
  313. bridgeBinary += CARLA_OS_SEP_STR "carla-bridge-native";
  314. #endif
  315. }
  316. else
  317. {
  318. switch (btype)
  319. {
  320. case BINARY_POSIX32:
  321. bridgeBinary += CARLA_OS_SEP_STR "carla-bridge-posix32";
  322. break;
  323. case BINARY_POSIX64:
  324. bridgeBinary += CARLA_OS_SEP_STR "carla-bridge-posix64";
  325. break;
  326. case BINARY_WIN32:
  327. bridgeBinary += CARLA_OS_SEP_STR "carla-bridge-win32.exe";
  328. break;
  329. case BINARY_WIN64:
  330. bridgeBinary += CARLA_OS_SEP_STR "carla-bridge-win64.exe";
  331. break;
  332. default:
  333. bridgeBinary.clear();
  334. break;
  335. }
  336. }
  337. if (! File(bridgeBinary.buffer()).existsAsFile())
  338. bridgeBinary.clear();
  339. }
  340. if (ptype != PLUGIN_INTERNAL && (btype != BINARY_NATIVE || (pData->options.preferPluginBridges && bridgeBinary.isNotEmpty())))
  341. {
  342. if (bridgeBinary.isNotEmpty())
  343. {
  344. plugin = CarlaPlugin::newBridge(initializer, btype, ptype, bridgeBinary);
  345. }
  346. # ifdef CARLA_OS_LINUX
  347. // fallback to dssi-vst if possible
  348. else if (btype == BINARY_WIN32 && File("/usr/lib/dssi/dssi-vst.so").existsAsFile())
  349. {
  350. const String jfilename = String(CharPointer_UTF8(filename));
  351. File file(jfilename);
  352. CarlaString label2(file.getFileName().toRawUTF8());
  353. label2.replace(' ', '*');
  354. CarlaPlugin::Initializer init2 = {
  355. this,
  356. id,
  357. "/usr/lib/dssi/dssi-vst.so",
  358. name,
  359. label2,
  360. uniqueId,
  361. options
  362. };
  363. ScopedEnvVar sev("VST_PATH", file.getParentDirectory().getFullPathName().toRawUTF8());
  364. plugin = CarlaPlugin::newDSSI(init2);
  365. }
  366. # endif
  367. else
  368. {
  369. setLastError("This Carla build cannot handle this binary");
  370. return false;
  371. }
  372. }
  373. else
  374. #endif // ! BUILD_BRIDGE
  375. {
  376. bool use16Outs;
  377. setLastError("Invalid or unsupported plugin type");
  378. switch (ptype)
  379. {
  380. case PLUGIN_NONE:
  381. break;
  382. case PLUGIN_INTERNAL:
  383. /*if (std::strcmp(label, "FluidSynth") == 0)
  384. {
  385. use16Outs = (extra != nullptr && std::strcmp((const char*)extra, "true") == 0);
  386. plugin = CarlaPlugin::newFluidSynth(initializer, use16Outs);
  387. }
  388. else if (std::strcmp(label, "LinuxSampler (GIG)") == 0)
  389. {
  390. use16Outs = (extra != nullptr && std::strcmp((const char*)extra, "true") == 0);
  391. plugin = CarlaPlugin::newLinuxSampler(initializer, "GIG", use16Outs);
  392. }
  393. else if (std::strcmp(label, "LinuxSampler (SF2)") == 0)
  394. {
  395. use16Outs = (extra != nullptr && std::strcmp((const char*)extra, "true") == 0);
  396. plugin = CarlaPlugin::newLinuxSampler(initializer, "SF2", use16Outs);
  397. }
  398. else if (std::strcmp(label, "LinuxSampler (SFZ)") == 0)
  399. {
  400. use16Outs = (extra != nullptr && std::strcmp((const char*)extra, "true") == 0);
  401. plugin = CarlaPlugin::newLinuxSampler(initializer, "SFZ", use16Outs);
  402. }*/
  403. plugin = CarlaPlugin::newNative(initializer);
  404. break;
  405. case PLUGIN_LADSPA:
  406. plugin = CarlaPlugin::newLADSPA(initializer, (const LADSPA_RDF_Descriptor*)extra);
  407. break;
  408. case PLUGIN_DSSI:
  409. plugin = CarlaPlugin::newDSSI(initializer);
  410. break;
  411. case PLUGIN_LV2:
  412. plugin = CarlaPlugin::newLV2(initializer);
  413. break;
  414. case PLUGIN_VST2:
  415. plugin = CarlaPlugin::newVST2(initializer);
  416. break;
  417. case PLUGIN_VST3:
  418. plugin = CarlaPlugin::newVST3(initializer);
  419. break;
  420. case PLUGIN_AU:
  421. plugin = CarlaPlugin::newAU(initializer);
  422. break;
  423. case PLUGIN_GIG:
  424. use16Outs = (extra != nullptr && std::strcmp((const char*)extra, "true") == 0);
  425. plugin = CarlaPlugin::newFileGIG(initializer, use16Outs);
  426. break;
  427. case PLUGIN_SF2:
  428. use16Outs = (extra != nullptr && std::strcmp((const char*)extra, "true") == 0);
  429. plugin = CarlaPlugin::newFileSF2(initializer, use16Outs);
  430. break;
  431. case PLUGIN_SFZ:
  432. plugin = CarlaPlugin::newFileSFZ(initializer);
  433. break;
  434. }
  435. }
  436. if (plugin == nullptr)
  437. return false;
  438. plugin->reload();
  439. bool canRun = true;
  440. /**/ if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK)
  441. {
  442. /**/ if (! plugin->canRunInRack())
  443. {
  444. setLastError("Carla's rack mode can only work with Mono or Stereo plugins, sorry!");
  445. canRun = false;
  446. }
  447. else if (plugin->getCVInCount() > 0 || plugin->getCVInCount() > 0)
  448. {
  449. setLastError("Carla's rack mode cannot work with plugins that have CV ports, sorry!");
  450. canRun = false;
  451. }
  452. }
  453. else if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  454. {
  455. /**/ if (plugin->getMidiInCount() > 1 || plugin->getMidiOutCount() > 1)
  456. {
  457. setLastError("Carla's patchbay mode cannot work with plugins that have multiple MIDI ports, sorry!");
  458. canRun = false;
  459. }
  460. else if (plugin->getCVInCount() > 0 || plugin->getCVInCount() > 0)
  461. {
  462. setLastError("CV ports in patchbay mode is still TODO");
  463. canRun = false;
  464. }
  465. }
  466. if (! canRun)
  467. {
  468. delete plugin;
  469. return false;
  470. }
  471. #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  472. plugin->registerToOscClient();
  473. #endif
  474. EnginePluginData& pluginData(pData->plugins[id]);
  475. pluginData.plugin = plugin;
  476. pluginData.insPeak[0] = 0.0f;
  477. pluginData.insPeak[1] = 0.0f;
  478. pluginData.outsPeak[0] = 0.0f;
  479. pluginData.outsPeak[1] = 0.0f;
  480. #ifndef BUILD_BRIDGE
  481. if (oldPlugin != nullptr)
  482. {
  483. // the engine thread might be reading from the old plugin
  484. pData->thread.stopThread(500);
  485. pData->thread.startThread();
  486. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  487. pData->graph.replacePlugin(oldPlugin, plugin);
  488. const bool wasActive = oldPlugin->getInternalParameterValue(PARAMETER_ACTIVE) >= 0.5f;
  489. const float oldDryWet = oldPlugin->getInternalParameterValue(PARAMETER_DRYWET);
  490. const float oldVolume = oldPlugin->getInternalParameterValue(PARAMETER_VOLUME);
  491. delete oldPlugin;
  492. if (plugin->getHints() & PLUGIN_CAN_DRYWET)
  493. plugin->setDryWet(oldDryWet, true, true);
  494. if (plugin->getHints() & PLUGIN_CAN_VOLUME)
  495. plugin->setVolume(oldVolume, true, true);
  496. if (wasActive)
  497. plugin->setActive(true, true, true);
  498. callback(ENGINE_CALLBACK_RELOAD_ALL, id, 0, 0, 0.0f, nullptr);
  499. }
  500. else
  501. #endif
  502. {
  503. ++pData->curPluginCount;
  504. callback(ENGINE_CALLBACK_PLUGIN_ADDED, id, 0, 0, 0.0f, plugin->getName());
  505. #ifndef BUILD_BRIDGE
  506. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  507. pData->graph.addPlugin(plugin);
  508. #endif
  509. }
  510. return true;
  511. }
  512. bool CarlaEngine::addPlugin(const PluginType ptype, const char* const filename, const char* const name, const char* const label, const int64_t uniqueId, const void* const extra)
  513. {
  514. return addPlugin(BINARY_NATIVE, ptype, filename, name, label, uniqueId, extra, 0x0);
  515. }
  516. bool CarlaEngine::removePlugin(const uint id)
  517. {
  518. CARLA_SAFE_ASSERT_RETURN_ERR(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  519. CARLA_SAFE_ASSERT_RETURN_ERR(pData->plugins != nullptr, "Invalid engine internal data");
  520. CARLA_SAFE_ASSERT_RETURN_ERR(pData->curPluginCount != 0, "Invalid engine internal data");
  521. CARLA_SAFE_ASSERT_RETURN_ERR(pData->nextAction.opcode == kEnginePostActionNull, "Invalid engine internal data");
  522. CARLA_SAFE_ASSERT_RETURN_ERR(id < pData->curPluginCount, "Invalid plugin Id");
  523. carla_debug("CarlaEngine::removePlugin(%i)", id);
  524. CarlaPlugin* const plugin(pData->plugins[id].plugin);
  525. CARLA_SAFE_ASSERT_RETURN_ERR(plugin != nullptr, "Could not find plugin to remove");
  526. CARLA_SAFE_ASSERT_RETURN_ERR(plugin->getId() == id, "Invalid engine internal data");
  527. pData->thread.stopThread(500);
  528. #ifndef BUILD_BRIDGE
  529. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  530. pData->graph.removePlugin(plugin);
  531. const bool lockWait(isRunning() /*&& pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS*/);
  532. const ScopedActionLock sal(this, kEnginePostActionRemovePlugin, id, 0, lockWait);
  533. /*
  534. for (uint i=id; i < pData->curPluginCount; ++i)
  535. {
  536. CarlaPlugin* const plugin2(pData->plugins[i].plugin);
  537. CARLA_SAFE_ASSERT_BREAK(plugin2 != nullptr);
  538. plugin2->updateOscURL();
  539. }
  540. */
  541. # ifdef HAVE_LIBLO
  542. if (isOscControlRegistered())
  543. oscSend_control_remove_plugin(id);
  544. # endif
  545. #else
  546. pData->curPluginCount = 0;
  547. carla_zeroStruct(pData->plugins, 1);
  548. #endif
  549. delete plugin;
  550. if (isRunning() && ! pData->aboutToClose)
  551. pData->thread.startThread();
  552. callback(ENGINE_CALLBACK_PLUGIN_REMOVED, id, 0, 0, 0.0f, nullptr);
  553. return true;
  554. }
  555. bool CarlaEngine::removeAllPlugins()
  556. {
  557. CARLA_SAFE_ASSERT_RETURN_ERR(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  558. CARLA_SAFE_ASSERT_RETURN_ERR(pData->plugins != nullptr, "Invalid engine internal data");
  559. CARLA_SAFE_ASSERT_RETURN_ERR(pData->nextPluginId == pData->maxPluginNumber, "Invalid engine internal data");
  560. CARLA_SAFE_ASSERT_RETURN_ERR(pData->nextAction.opcode == kEnginePostActionNull, "Invalid engine internal data");
  561. carla_debug("CarlaEngine::removeAllPlugins()");
  562. if (pData->curPluginCount == 0)
  563. return true;
  564. pData->thread.stopThread(500);
  565. #ifndef BUILD_BRIDGE
  566. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  567. pData->graph.removeAllPlugins();
  568. #endif
  569. const uint32_t curPluginCount(pData->curPluginCount);
  570. const bool lockWait(isRunning());
  571. const ScopedActionLock sal(this, kEnginePostActionZeroCount, 0, 0, lockWait);
  572. callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  573. for (uint i=0; i < curPluginCount; ++i)
  574. {
  575. EnginePluginData& pluginData(pData->plugins[i]);
  576. if (pluginData.plugin != nullptr)
  577. {
  578. delete pluginData.plugin;
  579. pluginData.plugin = nullptr;
  580. }
  581. pluginData.insPeak[0] = 0.0f;
  582. pluginData.insPeak[1] = 0.0f;
  583. pluginData.outsPeak[0] = 0.0f;
  584. pluginData.outsPeak[1] = 0.0f;
  585. callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  586. }
  587. if (isRunning() && ! pData->aboutToClose)
  588. pData->thread.startThread();
  589. return true;
  590. }
  591. #ifndef BUILD_BRIDGE
  592. const char* CarlaEngine::renamePlugin(const uint id, const char* const newName)
  593. {
  594. CARLA_SAFE_ASSERT_RETURN_ERRN(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  595. CARLA_SAFE_ASSERT_RETURN_ERRN(pData->plugins != nullptr, "Invalid engine internal data");
  596. CARLA_SAFE_ASSERT_RETURN_ERRN(pData->curPluginCount != 0, "Invalid engine internal data");
  597. CARLA_SAFE_ASSERT_RETURN_ERRN(pData->nextAction.opcode == kEnginePostActionNull, "Invalid engine internal data");
  598. CARLA_SAFE_ASSERT_RETURN_ERRN(id < pData->curPluginCount, "Invalid plugin Id");
  599. CARLA_SAFE_ASSERT_RETURN_ERRN(newName != nullptr && newName[0] != '\0', "Invalid plugin name");
  600. carla_debug("CarlaEngine::renamePlugin(%i, \"%s\")", id, newName);
  601. CarlaPlugin* const plugin(pData->plugins[id].plugin);
  602. CARLA_SAFE_ASSERT_RETURN_ERRN(plugin != nullptr, "Could not find plugin to rename");
  603. CARLA_SAFE_ASSERT_RETURN_ERRN(plugin->getId() == id, "Invalid engine internal data");
  604. if (const char* const name = getUniquePluginName(newName))
  605. {
  606. plugin->setName(name);
  607. return name;
  608. }
  609. setLastError("Unable to get new unique plugin name");
  610. return nullptr;
  611. }
  612. bool CarlaEngine::clonePlugin(const uint id)
  613. {
  614. CARLA_SAFE_ASSERT_RETURN_ERR(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  615. CARLA_SAFE_ASSERT_RETURN_ERR(pData->plugins != nullptr, "Invalid engine internal data");
  616. CARLA_SAFE_ASSERT_RETURN_ERR(pData->curPluginCount != 0, "Invalid engine internal data");
  617. CARLA_SAFE_ASSERT_RETURN_ERR(pData->nextAction.opcode == kEnginePostActionNull, "Invalid engine internal data");
  618. CARLA_SAFE_ASSERT_RETURN_ERR(id < pData->curPluginCount, "Invalid plugin Id");
  619. carla_debug("CarlaEngine::clonePlugin(%i)", id);
  620. CarlaPlugin* const plugin(pData->plugins[id].plugin);
  621. CARLA_SAFE_ASSERT_RETURN_ERR(plugin != nullptr, "Could not find plugin to clone");
  622. CARLA_SAFE_ASSERT_RETURN_ERR(plugin->getId() == id, "Invalid engine internal data");
  623. char label[STR_MAX+1];
  624. carla_zeroChar(label, STR_MAX+1);
  625. plugin->getLabel(label);
  626. const uint pluginCountBefore(pData->curPluginCount);
  627. if (! addPlugin(plugin->getBinaryType(), plugin->getType(),
  628. plugin->getFilename(), plugin->getName(), label, plugin->getUniqueId(),
  629. plugin->getExtraStuff(), plugin->getOptionsEnabled()))
  630. return false;
  631. CARLA_SAFE_ASSERT_RETURN_ERR(pluginCountBefore+1 == pData->curPluginCount, "No new plugin found");
  632. if (CarlaPlugin* const newPlugin = pData->plugins[pluginCountBefore].plugin)
  633. newPlugin->loadStateSave(plugin->getStateSave());
  634. return true;
  635. }
  636. bool CarlaEngine::replacePlugin(const uint id) noexcept
  637. {
  638. CARLA_SAFE_ASSERT_RETURN_ERR(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  639. CARLA_SAFE_ASSERT_RETURN_ERR(pData->plugins != nullptr, "Invalid engine internal data");
  640. CARLA_SAFE_ASSERT_RETURN_ERR(pData->curPluginCount != 0, "Invalid engine internal data");
  641. CARLA_SAFE_ASSERT_RETURN_ERR(pData->nextAction.opcode == kEnginePostActionNull, "Invalid engine internal data");
  642. carla_debug("CarlaEngine::replacePlugin(%i)", id);
  643. // might use this to reset
  644. if (id == pData->maxPluginNumber)
  645. {
  646. pData->nextPluginId = pData->maxPluginNumber;
  647. return true;
  648. }
  649. CARLA_SAFE_ASSERT_RETURN_ERR(id < pData->curPluginCount, "Invalid plugin Id");
  650. CarlaPlugin* const plugin(pData->plugins[id].plugin);
  651. CARLA_SAFE_ASSERT_RETURN_ERR(plugin != nullptr, "Could not find plugin to replace");
  652. CARLA_SAFE_ASSERT_RETURN_ERR(plugin->getId() == id, "Invalid engine internal data");
  653. pData->nextPluginId = id;
  654. return true;
  655. }
  656. bool CarlaEngine::switchPlugins(const uint idA, const uint idB) noexcept
  657. {
  658. CARLA_SAFE_ASSERT_RETURN_ERR(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  659. CARLA_SAFE_ASSERT_RETURN_ERR(pData->plugins != nullptr, "Invalid engine internal data");
  660. CARLA_SAFE_ASSERT_RETURN_ERR(pData->curPluginCount >= 2, "Invalid engine internal data");
  661. CARLA_SAFE_ASSERT_RETURN_ERR(pData->nextAction.opcode == kEnginePostActionNull, "Invalid engine internal data");
  662. CARLA_SAFE_ASSERT_RETURN_ERR(idA != idB, "Invalid operation, cannot switch plugin with itself");
  663. CARLA_SAFE_ASSERT_RETURN_ERR(idA < pData->curPluginCount, "Invalid plugin Id");
  664. CARLA_SAFE_ASSERT_RETURN_ERR(idB < pData->curPluginCount, "Invalid plugin Id");
  665. carla_debug("CarlaEngine::switchPlugins(%i)", idA, idB);
  666. {
  667. CarlaPlugin* const pluginA(pData->plugins[idA].plugin);
  668. CarlaPlugin* const pluginB(pData->plugins[idB].plugin);
  669. CARLA_SAFE_ASSERT_RETURN_ERR(pluginA != nullptr, "Could not find plugin to switch");
  670. CARLA_SAFE_ASSERT_RETURN_ERR(pluginA != nullptr, "Could not find plugin to switch");
  671. CARLA_SAFE_ASSERT_RETURN_ERR(pluginA->getId() == idA, "Invalid engine internal data");
  672. CARLA_SAFE_ASSERT_RETURN_ERR(pluginB->getId() == idB, "Invalid engine internal data");
  673. pData->thread.stopThread(500);
  674. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  675. pData->graph.replacePlugin(pluginA, pluginB);
  676. }
  677. const bool lockWait(isRunning() /*&& pData->options.processMode != ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS*/);
  678. const ScopedActionLock sal(this, kEnginePostActionSwitchPlugins, idA, idB, lockWait);
  679. /*
  680. CarlaPlugin* const pluginA(pData->plugins[idA].plugin);
  681. CarlaPlugin* const pluginB(pData->plugins[idB].plugin);
  682. if (pluginA != nullptr && pluginB != nullptr)
  683. {
  684. pluginA->updateOscURL();
  685. pluginB->updateOscURL();
  686. }
  687. */
  688. // TODO
  689. //if (isOscControlRegistered())
  690. // oscSend_control_switch_plugins(idA, idB);
  691. if (isRunning() && ! pData->aboutToClose)
  692. pData->thread.startThread();
  693. return true;
  694. }
  695. #endif
  696. CarlaPlugin* CarlaEngine::getPlugin(const uint id) const noexcept
  697. {
  698. CARLA_SAFE_ASSERT_RETURN_ERRN(pData->plugins != nullptr, "Invalid engine internal data");
  699. CARLA_SAFE_ASSERT_RETURN_ERRN(pData->curPluginCount != 0, "Invalid engine internal data");
  700. CARLA_SAFE_ASSERT_RETURN_ERRN(pData->nextAction.opcode == kEnginePostActionNull, "Invalid engine internal data");
  701. CARLA_SAFE_ASSERT_RETURN_ERRN(id < pData->curPluginCount, "Invalid plugin Id");
  702. return pData->plugins[id].plugin;
  703. }
  704. CarlaPlugin* CarlaEngine::getPluginUnchecked(const uint id) const noexcept
  705. {
  706. return pData->plugins[id].plugin;
  707. }
  708. const char* CarlaEngine::getUniquePluginName(const char* const name) const
  709. {
  710. CARLA_SAFE_ASSERT_RETURN(pData->nextAction.opcode == kEnginePostActionNull, nullptr);
  711. CARLA_SAFE_ASSERT_RETURN(name != nullptr && name[0] != '\0', nullptr);
  712. carla_debug("CarlaEngine::getUniquePluginName(\"%s\")", name);
  713. CarlaString sname;
  714. sname = name;
  715. if (sname.isEmpty())
  716. {
  717. sname = "(No name)";
  718. return sname.dup();
  719. }
  720. const std::size_t maxNameSize(carla_minWithBase<uint>(getMaxClientNameSize(), 0xff, 6U) - 6); // 6 = strlen(" (10)") + 1
  721. if (maxNameSize == 0 || ! isRunning())
  722. return sname.dup();
  723. sname.truncate(maxNameSize);
  724. sname.replace(':', '.'); // ':' is used in JACK1 to split client/port names
  725. for (uint i=0; i < pData->curPluginCount; ++i)
  726. {
  727. CARLA_SAFE_ASSERT_BREAK(pData->plugins[i].plugin != nullptr);
  728. // Check if unique name doesn't exist
  729. if (const char* const pluginName = pData->plugins[i].plugin->getName())
  730. {
  731. if (sname != pluginName)
  732. continue;
  733. }
  734. // Check if string has already been modified
  735. {
  736. const std::size_t len(sname.length());
  737. // 1 digit, ex: " (2)"
  738. if (sname[len-4] == ' ' && sname[len-3] == '(' && sname.isDigit(len-2) && sname[len-1] == ')')
  739. {
  740. const int number = sname[len-2] - '0';
  741. if (number == 9)
  742. {
  743. // next number is 10, 2 digits
  744. sname.truncate(len-4);
  745. sname += " (10)";
  746. //sname.replace(" (9)", " (10)");
  747. }
  748. else
  749. sname[len-2] = char('0' + number + 1);
  750. continue;
  751. }
  752. // 2 digits, ex: " (11)"
  753. if (sname[len-5] == ' ' && sname[len-4] == '(' && sname.isDigit(len-3) && sname.isDigit(len-2) && sname[len-1] == ')')
  754. {
  755. char n2 = sname[len-2];
  756. char n3 = sname[len-3];
  757. if (n2 == '9')
  758. {
  759. n2 = '0';
  760. n3 = static_cast<char>(n3 + 1);
  761. }
  762. else
  763. n2 = static_cast<char>(n2 + 1);
  764. sname[len-2] = n2;
  765. sname[len-3] = n3;
  766. continue;
  767. }
  768. }
  769. // Modify string if not
  770. sname += " (2)";
  771. }
  772. return sname.dup();
  773. }
  774. // -----------------------------------------------------------------------
  775. // Project management
  776. bool CarlaEngine::loadFile(const char* const filename)
  777. {
  778. CARLA_SAFE_ASSERT_RETURN_ERR(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  779. CARLA_SAFE_ASSERT_RETURN_ERR(filename != nullptr && filename[0] != '\0', "Invalid filename");
  780. carla_debug("CarlaEngine::loadFile(\"%s\")", filename);
  781. const String jfilename = String(CharPointer_UTF8(filename));
  782. File file(jfilename);
  783. CARLA_SAFE_ASSERT_RETURN_ERR(file.existsAsFile(), "Requested file does not exist or is not a readable file");
  784. CarlaString baseName(file.getFileNameWithoutExtension().toRawUTF8());
  785. CarlaString extension(file.getFileExtension().replace(".","").toLowerCase().toRawUTF8());
  786. const uint curPluginId(pData->nextPluginId < pData->curPluginCount ? pData->nextPluginId : pData->curPluginCount);
  787. // -------------------------------------------------------------------
  788. if (extension == "carxp" || extension == "carxs")
  789. return loadProject(filename);
  790. // -------------------------------------------------------------------
  791. if (extension == "gig")
  792. return addPlugin(PLUGIN_GIG, filename, baseName, baseName, 0, nullptr);
  793. if (extension == "sf2")
  794. return addPlugin(PLUGIN_SF2, filename, baseName, baseName, 0, nullptr);
  795. if (extension == "sfz")
  796. return addPlugin(PLUGIN_SFZ, filename, baseName, baseName, 0, nullptr);
  797. // -------------------------------------------------------------------
  798. if (extension == "aif" || extension == "aiff" || extension == "bwf" || extension == "flac" || extension == "ogg" || extension == "wav")
  799. {
  800. if (addPlugin(PLUGIN_INTERNAL, nullptr, baseName, "audiofile", 0, nullptr))
  801. {
  802. if (CarlaPlugin* const plugin = getPlugin(curPluginId))
  803. plugin->setCustomData(CUSTOM_DATA_TYPE_STRING, "file", filename, true);
  804. return true;
  805. }
  806. return false;
  807. }
  808. // -------------------------------------------------------------------
  809. if (extension == "mid" || extension == "midi")
  810. {
  811. if (addPlugin(PLUGIN_INTERNAL, nullptr, baseName, "midifile", 0, nullptr))
  812. {
  813. if (CarlaPlugin* const plugin = getPlugin(curPluginId))
  814. plugin->setCustomData(CUSTOM_DATA_TYPE_STRING, "file", filename, true);
  815. return true;
  816. }
  817. return false;
  818. }
  819. // -------------------------------------------------------------------
  820. // ZynAddSubFX
  821. if (extension == "xmz" || extension == "xiz")
  822. {
  823. #ifdef HAVE_ZYN_DEPS
  824. CarlaString nicerName("Zyn - ");
  825. const std::size_t sep(baseName.find('-')+1);
  826. if (sep < baseName.length())
  827. nicerName += baseName.buffer()+sep;
  828. else
  829. nicerName += baseName;
  830. //nicerName
  831. if (addPlugin(PLUGIN_INTERNAL, nullptr, nicerName, "zynaddsubfx", 0, nullptr))
  832. {
  833. callback(ENGINE_CALLBACK_UI_STATE_CHANGED, curPluginId, 0, 0, 0.0f, nullptr);
  834. if (CarlaPlugin* const plugin = getPlugin(curPluginId))
  835. plugin->setCustomData(CUSTOM_DATA_TYPE_STRING, (extension == "xmz") ? "CarlaAlternateFile1" : "CarlaAlternateFile2", filename, true);
  836. return true;
  837. }
  838. return false;
  839. #else
  840. setLastError("This Carla build does not have ZynAddSubFX support");
  841. return false;
  842. #endif
  843. }
  844. // -------------------------------------------------------------------
  845. setLastError("Unknown file extension");
  846. return false;
  847. }
  848. bool CarlaEngine::loadProject(const char* const filename)
  849. {
  850. CARLA_SAFE_ASSERT_RETURN_ERR(pData->isIdling == 0, "An operation is still being processed, please wait for it to finish");
  851. CARLA_SAFE_ASSERT_RETURN_ERR(filename != nullptr && filename[0] != '\0', "Invalid filename");
  852. carla_debug("CarlaEngine::loadProject(\"%s\")", filename);
  853. const String jfilename = String(CharPointer_UTF8(filename));
  854. File file(jfilename);
  855. CARLA_SAFE_ASSERT_RETURN_ERR(file.existsAsFile(), "Requested file does not exist or is not a readable file");
  856. XmlDocument xml(file);
  857. return loadProjectInternal(xml);
  858. }
  859. bool CarlaEngine::saveProject(const char* const filename)
  860. {
  861. CARLA_SAFE_ASSERT_RETURN_ERR(filename != nullptr && filename[0] != '\0', "Invalid filename");
  862. carla_debug("CarlaEngine::saveProject(\"%s\")", filename);
  863. MemoryOutputStream out;
  864. saveProjectInternal(out);
  865. const String jfilename = String(CharPointer_UTF8(filename));
  866. File file(jfilename);
  867. if (file.replaceWithData(out.getData(), out.getDataSize()))
  868. return true;
  869. setLastError("Failed to write file");
  870. return false;
  871. }
  872. // -----------------------------------------------------------------------
  873. // Information (base)
  874. uint CarlaEngine::getHints() const noexcept
  875. {
  876. return pData->hints;
  877. }
  878. uint32_t CarlaEngine::getBufferSize() const noexcept
  879. {
  880. return pData->bufferSize;
  881. }
  882. double CarlaEngine::getSampleRate() const noexcept
  883. {
  884. return pData->sampleRate;
  885. }
  886. const char* CarlaEngine::getName() const noexcept
  887. {
  888. return pData->name;
  889. }
  890. EngineProcessMode CarlaEngine::getProccessMode() const noexcept
  891. {
  892. return pData->options.processMode;
  893. }
  894. const EngineOptions& CarlaEngine::getOptions() const noexcept
  895. {
  896. return pData->options;
  897. }
  898. const EngineTimeInfo& CarlaEngine::getTimeInfo() const noexcept
  899. {
  900. return pData->timeInfo;
  901. }
  902. // -----------------------------------------------------------------------
  903. // Information (peaks)
  904. float CarlaEngine::getInputPeak(const uint pluginId, const bool isLeft) const noexcept
  905. {
  906. CARLA_SAFE_ASSERT_RETURN(pluginId < pData->curPluginCount, 0.0f);
  907. return pData->plugins[pluginId].insPeak[isLeft ? 0 : 1];
  908. }
  909. float CarlaEngine::getOutputPeak(const uint pluginId, const bool isLeft) const noexcept
  910. {
  911. CARLA_SAFE_ASSERT_RETURN(pluginId < pData->curPluginCount, 0.0f);
  912. return pData->plugins[pluginId].outsPeak[isLeft ? 0 : 1];
  913. }
  914. // -----------------------------------------------------------------------
  915. // Callback
  916. void CarlaEngine::callback(const EngineCallbackOpcode action, const uint pluginId, const int value1, const int value2, const float value3, const char* const valueStr) noexcept
  917. {
  918. #ifdef DEBUG
  919. if (action != ENGINE_CALLBACK_IDLE)
  920. carla_debug("CarlaEngine::callback(%i:%s, %i, %i, %i, %f, \"%s\")", action, EngineCallbackOpcode2Str(action), pluginId, value1, value2, value3, valueStr);
  921. #endif
  922. #ifdef BUILD_BRIDGE
  923. if (pData->isIdling)
  924. #else
  925. if (pData->isIdling && action != ENGINE_CALLBACK_PATCHBAY_CLIENT_DATA_CHANGED)
  926. #endif
  927. {
  928. carla_stdout("callback while idling (%i:%s, %i, %i, %i, %f, \"%s\")", action, EngineCallbackOpcode2Str(action), pluginId, value1, value2, value3, valueStr);
  929. }
  930. if (pData->callback != nullptr)
  931. {
  932. if (action == ENGINE_CALLBACK_IDLE)
  933. ++pData->isIdling;
  934. try {
  935. pData->callback(pData->callbackPtr, action, pluginId, value1, value2, value3, valueStr);
  936. } CARLA_SAFE_EXCEPTION("callback");
  937. if (action == ENGINE_CALLBACK_IDLE)
  938. --pData->isIdling;
  939. }
  940. }
  941. void CarlaEngine::setCallback(const EngineCallbackFunc func, void* const ptr) noexcept
  942. {
  943. carla_debug("CarlaEngine::setCallback(%p, %p)", func, ptr);
  944. pData->callback = func;
  945. pData->callbackPtr = ptr;
  946. }
  947. // -----------------------------------------------------------------------
  948. // File Callback
  949. const char* CarlaEngine::runFileCallback(const FileCallbackOpcode action, const bool isDir, const char* const title, const char* const filter) noexcept
  950. {
  951. CARLA_SAFE_ASSERT_RETURN(title != nullptr && title[0] != '\0', nullptr);
  952. CARLA_SAFE_ASSERT_RETURN(filter != nullptr, nullptr);
  953. carla_debug("CarlaEngine::runFileCallback(%i:%s, %s, \"%s\", \"%s\")", action, FileCallbackOpcode2Str(action), bool2str(isDir), title, filter);
  954. const char* ret = nullptr;
  955. if (pData->fileCallback != nullptr)
  956. {
  957. try {
  958. ret = pData->fileCallback(pData->fileCallbackPtr, action, isDir, title, filter);
  959. } CARLA_SAFE_EXCEPTION("runFileCallback");
  960. }
  961. return ret;
  962. }
  963. void CarlaEngine::setFileCallback(const FileCallbackFunc func, void* const ptr) noexcept
  964. {
  965. carla_debug("CarlaEngine::setFileCallback(%p, %p)", func, ptr);
  966. pData->fileCallback = func;
  967. pData->fileCallbackPtr = ptr;
  968. }
  969. // -----------------------------------------------------------------------
  970. // Transport
  971. void CarlaEngine::transportPlay() noexcept
  972. {
  973. pData->time.playing = true;
  974. }
  975. void CarlaEngine::transportPause() noexcept
  976. {
  977. pData->time.playing = false;
  978. }
  979. void CarlaEngine::transportRelocate(const uint64_t frame) noexcept
  980. {
  981. pData->time.frame = frame;
  982. }
  983. // -----------------------------------------------------------------------
  984. // Error handling
  985. const char* CarlaEngine::getLastError() const noexcept
  986. {
  987. return pData->lastError;
  988. }
  989. void CarlaEngine::setLastError(const char* const error) const noexcept
  990. {
  991. pData->lastError = error;
  992. }
  993. void CarlaEngine::setAboutToClose() noexcept
  994. {
  995. carla_debug("CarlaEngine::setAboutToClose()");
  996. pData->aboutToClose = true;
  997. }
  998. // -----------------------------------------------------------------------
  999. // Global options
  1000. void CarlaEngine::setOption(const EngineOption option, const int value, const char* const valueStr) noexcept
  1001. {
  1002. carla_debug("CarlaEngine::setOption(%i:%s, %i, \"%s\")", option, EngineOption2Str(option), value, valueStr);
  1003. if (isRunning() && (option == ENGINE_OPTION_PROCESS_MODE || option == ENGINE_OPTION_AUDIO_NUM_PERIODS || option == ENGINE_OPTION_AUDIO_DEVICE))
  1004. return carla_stderr("CarlaEngine::setOption(%i:%s, %i, \"%s\") - Cannot set this option while engine is running!", option, EngineOption2Str(option), value, valueStr);
  1005. // do not un-force stereo for rack mode
  1006. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK && option == ENGINE_OPTION_FORCE_STEREO && value != 0)
  1007. return;
  1008. switch (option)
  1009. {
  1010. case ENGINE_OPTION_DEBUG:
  1011. break;
  1012. case ENGINE_OPTION_PROCESS_MODE:
  1013. CARLA_SAFE_ASSERT_RETURN(value >= ENGINE_PROCESS_MODE_SINGLE_CLIENT && value <= ENGINE_PROCESS_MODE_BRIDGE,);
  1014. pData->options.processMode = static_cast<EngineProcessMode>(value);
  1015. break;
  1016. case ENGINE_OPTION_TRANSPORT_MODE:
  1017. CARLA_SAFE_ASSERT_RETURN(value >= ENGINE_TRANSPORT_MODE_INTERNAL && value <= ENGINE_TRANSPORT_MODE_BRIDGE,);
  1018. pData->options.transportMode = static_cast<EngineTransportMode>(value);
  1019. break;
  1020. case ENGINE_OPTION_FORCE_STEREO:
  1021. CARLA_SAFE_ASSERT_RETURN(value == 0 || value == 1,);
  1022. pData->options.forceStereo = (value != 0);
  1023. break;
  1024. case ENGINE_OPTION_PREFER_PLUGIN_BRIDGES:
  1025. #ifdef BUILD_BRIDGE
  1026. CARLA_SAFE_ASSERT_RETURN(value == 0,);
  1027. #else
  1028. CARLA_SAFE_ASSERT_RETURN(value == 0 || value == 1,);
  1029. #endif
  1030. pData->options.preferPluginBridges = (value != 0);
  1031. break;
  1032. case ENGINE_OPTION_PREFER_UI_BRIDGES:
  1033. CARLA_SAFE_ASSERT_RETURN(value == 0 || value == 1,);
  1034. pData->options.preferUiBridges = (value != 0);
  1035. break;
  1036. case ENGINE_OPTION_UIS_ALWAYS_ON_TOP:
  1037. CARLA_SAFE_ASSERT_RETURN(value == 0 || value == 1,);
  1038. pData->options.uisAlwaysOnTop = (value != 0);
  1039. break;
  1040. case ENGINE_OPTION_MAX_PARAMETERS:
  1041. CARLA_SAFE_ASSERT_RETURN(value >= 0,);
  1042. pData->options.maxParameters = static_cast<uint>(value);
  1043. break;
  1044. case ENGINE_OPTION_UI_BRIDGES_TIMEOUT:
  1045. CARLA_SAFE_ASSERT_RETURN(value >= 0,);
  1046. pData->options.uiBridgesTimeout = static_cast<uint>(value);
  1047. break;
  1048. case ENGINE_OPTION_AUDIO_NUM_PERIODS:
  1049. CARLA_SAFE_ASSERT_RETURN(value >= 2 && value <= 3,);
  1050. pData->options.audioNumPeriods = static_cast<uint>(value);
  1051. break;
  1052. case ENGINE_OPTION_AUDIO_BUFFER_SIZE:
  1053. CARLA_SAFE_ASSERT_RETURN(value >= 8,);
  1054. pData->options.audioBufferSize = static_cast<uint>(value);
  1055. break;
  1056. case ENGINE_OPTION_AUDIO_SAMPLE_RATE:
  1057. CARLA_SAFE_ASSERT_RETURN(value >= 22050,);
  1058. pData->options.audioSampleRate = static_cast<uint>(value);
  1059. break;
  1060. case ENGINE_OPTION_AUDIO_DEVICE:
  1061. CARLA_SAFE_ASSERT_RETURN(valueStr != nullptr,);
  1062. if (pData->options.audioDevice != nullptr)
  1063. delete[] pData->options.audioDevice;
  1064. pData->options.audioDevice = carla_strdup_safe(valueStr);
  1065. break;
  1066. case ENGINE_OPTION_PLUGIN_PATH:
  1067. CARLA_SAFE_ASSERT_RETURN(value > PLUGIN_NONE,);
  1068. CARLA_SAFE_ASSERT_RETURN(value <= PLUGIN_SFZ,);
  1069. switch (value)
  1070. {
  1071. case PLUGIN_LADSPA:
  1072. if (pData->options.pathLADSPA != nullptr)
  1073. delete[] pData->options.pathLADSPA;
  1074. if (valueStr != nullptr)
  1075. pData->options.pathLADSPA = carla_strdup_safe(valueStr);
  1076. else
  1077. pData->options.pathLADSPA = nullptr;
  1078. break;
  1079. case PLUGIN_DSSI:
  1080. if (pData->options.pathDSSI != nullptr)
  1081. delete[] pData->options.pathDSSI;
  1082. if (valueStr != nullptr)
  1083. pData->options.pathDSSI = carla_strdup_safe(valueStr);
  1084. else
  1085. pData->options.pathDSSI = nullptr;
  1086. break;
  1087. case PLUGIN_LV2:
  1088. if (pData->options.pathLV2 != nullptr)
  1089. delete[] pData->options.pathLV2;
  1090. if (valueStr != nullptr)
  1091. pData->options.pathLV2 = carla_strdup_safe(valueStr);
  1092. else
  1093. pData->options.pathLV2 = nullptr;
  1094. break;
  1095. case PLUGIN_VST2:
  1096. if (pData->options.pathVST2 != nullptr)
  1097. delete[] pData->options.pathVST2;
  1098. if (valueStr != nullptr)
  1099. pData->options.pathVST2 = carla_strdup_safe(valueStr);
  1100. else
  1101. pData->options.pathVST2 = nullptr;
  1102. break;
  1103. case PLUGIN_VST3:
  1104. if (pData->options.pathVST3 != nullptr)
  1105. delete[] pData->options.pathVST3;
  1106. if (valueStr != nullptr)
  1107. pData->options.pathVST3 = carla_strdup_safe(valueStr);
  1108. else
  1109. pData->options.pathVST3 = nullptr;
  1110. break;
  1111. case PLUGIN_GIG:
  1112. if (pData->options.pathGIG != nullptr)
  1113. delete[] pData->options.pathGIG;
  1114. if (valueStr != nullptr)
  1115. pData->options.pathGIG = carla_strdup_safe(valueStr);
  1116. else
  1117. pData->options.pathGIG = nullptr;
  1118. break;
  1119. case PLUGIN_SF2:
  1120. if (pData->options.pathSF2 != nullptr)
  1121. delete[] pData->options.pathSF2;
  1122. if (valueStr != nullptr)
  1123. pData->options.pathSF2 = carla_strdup_safe(valueStr);
  1124. else
  1125. pData->options.pathSF2 = nullptr;
  1126. break;
  1127. case PLUGIN_SFZ:
  1128. if (pData->options.pathSFZ != nullptr)
  1129. delete[] pData->options.pathSFZ;
  1130. if (valueStr != nullptr)
  1131. pData->options.pathSFZ = carla_strdup_safe(valueStr);
  1132. else
  1133. pData->options.pathSFZ = nullptr;
  1134. break;
  1135. default:
  1136. return carla_stderr("CarlaEngine::setOption(%i:%s, %i, \"%s\") - Invalid plugin type", option, EngineOption2Str(option), value, valueStr);
  1137. break;
  1138. }
  1139. break;
  1140. case ENGINE_OPTION_PATH_BINARIES:
  1141. CARLA_SAFE_ASSERT_RETURN(valueStr != nullptr && valueStr[0] != '\0',);
  1142. if (pData->options.binaryDir != nullptr)
  1143. delete[] pData->options.binaryDir;
  1144. pData->options.binaryDir = carla_strdup_safe(valueStr);
  1145. break;
  1146. case ENGINE_OPTION_PATH_RESOURCES:
  1147. CARLA_SAFE_ASSERT_RETURN(valueStr != nullptr && valueStr[0] != '\0',);
  1148. if (pData->options.resourceDir != nullptr)
  1149. delete[] pData->options.resourceDir;
  1150. pData->options.resourceDir = carla_strdup_safe(valueStr);
  1151. break;
  1152. case ENGINE_OPTION_PREVENT_BAD_BEHAVIOUR:
  1153. CARLA_SAFE_ASSERT_RETURN(pData->options.binaryDir != nullptr && pData->options.binaryDir[0] != '\0',);
  1154. #ifdef CARLA_OS_LINUX
  1155. if (value != 0)
  1156. {
  1157. CarlaString interposerPath(CarlaString(pData->options.binaryDir) + CARLA_OS_SEP_STR "libcarla_interposer.so");
  1158. ::setenv("LD_PRELOAD", interposerPath.buffer(), 1);
  1159. }
  1160. else
  1161. {
  1162. ::unsetenv("LD_PRELOAD");
  1163. }
  1164. #endif
  1165. break;
  1166. case ENGINE_OPTION_FRONTEND_WIN_ID:
  1167. CARLA_SAFE_ASSERT_RETURN(valueStr != nullptr && valueStr[0] != '\0',);
  1168. const long long winId(std::strtoll(valueStr, nullptr, 16));
  1169. CARLA_SAFE_ASSERT_RETURN(winId >= 0,);
  1170. pData->options.frontendWinId = static_cast<uintptr_t>(winId);
  1171. break;
  1172. }
  1173. }
  1174. #ifdef HAVE_LIBLO
  1175. // -----------------------------------------------------------------------
  1176. // OSC Stuff
  1177. # ifndef BUILD_BRIDGE
  1178. bool CarlaEngine::isOscControlRegistered() const noexcept
  1179. {
  1180. return pData->osc.isControlRegistered();
  1181. }
  1182. # endif
  1183. void CarlaEngine::idleOsc() const noexcept
  1184. {
  1185. pData->osc.idle();
  1186. }
  1187. const char* CarlaEngine::getOscServerPathTCP() const noexcept
  1188. {
  1189. return pData->osc.getServerPathTCP();
  1190. }
  1191. const char* CarlaEngine::getOscServerPathUDP() const noexcept
  1192. {
  1193. return pData->osc.getServerPathUDP();
  1194. }
  1195. #endif
  1196. // -----------------------------------------------------------------------
  1197. // Helper functions
  1198. EngineEvent* CarlaEngine::getInternalEventBuffer(const bool isInput) const noexcept
  1199. {
  1200. return isInput ? pData->events.in : pData->events.out;
  1201. }
  1202. // -----------------------------------------------------------------------
  1203. // Internal stuff
  1204. void CarlaEngine::bufferSizeChanged(const uint32_t newBufferSize)
  1205. {
  1206. carla_debug("CarlaEngine::bufferSizeChanged(%i)", newBufferSize);
  1207. #ifndef BUILD_BRIDGE
  1208. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1209. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1210. {
  1211. pData->graph.setBufferSize(newBufferSize);
  1212. }
  1213. #endif
  1214. for (uint i=0; i < pData->curPluginCount; ++i)
  1215. {
  1216. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1217. if (plugin != nullptr && plugin->isEnabled())
  1218. plugin->bufferSizeChanged(newBufferSize);
  1219. }
  1220. callback(ENGINE_CALLBACK_BUFFER_SIZE_CHANGED, 0, static_cast<int>(newBufferSize), 0, 0.0f, nullptr);
  1221. }
  1222. void CarlaEngine::sampleRateChanged(const double newSampleRate)
  1223. {
  1224. carla_debug("CarlaEngine::sampleRateChanged(%g)", newSampleRate);
  1225. #ifndef BUILD_BRIDGE
  1226. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1227. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1228. {
  1229. pData->graph.setSampleRate(newSampleRate);
  1230. }
  1231. #endif
  1232. for (uint i=0; i < pData->curPluginCount; ++i)
  1233. {
  1234. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1235. if (plugin != nullptr && plugin->isEnabled())
  1236. plugin->sampleRateChanged(newSampleRate);
  1237. }
  1238. callback(ENGINE_CALLBACK_SAMPLE_RATE_CHANGED, 0, 0, 0, static_cast<float>(newSampleRate), nullptr);
  1239. }
  1240. void CarlaEngine::offlineModeChanged(const bool isOfflineNow)
  1241. {
  1242. carla_debug("CarlaEngine::offlineModeChanged(%s)", bool2str(isOfflineNow));
  1243. #ifndef BUILD_BRIDGE
  1244. if (pData->options.processMode == ENGINE_PROCESS_MODE_CONTINUOUS_RACK ||
  1245. pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1246. {
  1247. pData->graph.setOffline(isOfflineNow);
  1248. }
  1249. #endif
  1250. for (uint i=0; i < pData->curPluginCount; ++i)
  1251. {
  1252. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1253. if (plugin != nullptr && plugin->isEnabled())
  1254. plugin->offlineModeChanged(isOfflineNow);
  1255. }
  1256. }
  1257. void CarlaEngine::setPluginPeaks(const uint pluginId, float const inPeaks[2], float const outPeaks[2]) noexcept
  1258. {
  1259. EnginePluginData& pluginData(pData->plugins[pluginId]);
  1260. pluginData.insPeak[0] = inPeaks[0];
  1261. pluginData.insPeak[1] = inPeaks[1];
  1262. pluginData.outsPeak[0] = outPeaks[0];
  1263. pluginData.outsPeak[1] = outPeaks[1];
  1264. }
  1265. void CarlaEngine::saveProjectInternal(juce::MemoryOutputStream& outStream) const
  1266. {
  1267. // send initial prepareForSave first, giving time for bridges to act
  1268. for (uint i=0; i < pData->curPluginCount; ++i)
  1269. {
  1270. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1271. if (plugin != nullptr && plugin->isEnabled())
  1272. {
  1273. #ifndef BUILD_BRIDGE
  1274. // deactivate bridge client-side ping check, since some plugins block during save
  1275. if (plugin->getHints() & PLUGIN_IS_BRIDGE)
  1276. plugin->setCustomData(CUSTOM_DATA_TYPE_STRING, "__CarlaPingOnOff__", "false", false);
  1277. #endif
  1278. plugin->prepareForSave();
  1279. }
  1280. }
  1281. outStream << "<?xml version='1.0' encoding='UTF-8'?>\n";
  1282. outStream << "<!DOCTYPE CARLA-PROJECT>\n";
  1283. outStream << "<CARLA-PROJECT VERSION='2.0'>\n";
  1284. const bool isPlugin(std::strcmp(getCurrentDriverName(), "Plugin") == 0);
  1285. const EngineOptions& options(pData->options);
  1286. MemoryOutputStream outSettings(1024);
  1287. // save appropriate engine settings
  1288. outSettings << " <EngineSettings>\n";
  1289. //processMode
  1290. //transportMode
  1291. outSettings << " <ForceStereo>" << bool2str(options.forceStereo) << "</ForceStereo>\n";
  1292. outSettings << " <PreferPluginBridges>" << bool2str(options.preferPluginBridges) << "</PreferPluginBridges>\n";
  1293. outSettings << " <PreferUiBridges>" << bool2str(options.preferUiBridges) << "</PreferUiBridges>\n";
  1294. outSettings << " <UIsAlwaysOnTop>" << bool2str(options.uisAlwaysOnTop) << "</UIsAlwaysOnTop>\n";
  1295. outSettings << " <MaxParameters>" << String(options.maxParameters) << "</MaxParameters>\n";
  1296. outSettings << " <UIBridgesTimeout>" << String(options.uiBridgesTimeout) << "</UIBridgesTimeout>\n";
  1297. if (isPlugin)
  1298. {
  1299. outSettings << " <LADSPA_PATH>" << xmlSafeString(options.pathLADSPA, true) << "</LADSPA_PATH>\n";
  1300. outSettings << " <DSSI_PATH>" << xmlSafeString(options.pathDSSI, true) << "</DSSI_PATH>\n";
  1301. outSettings << " <LV2_PATH>" << xmlSafeString(options.pathLV2, true) << "</LV2_PATH>\n";
  1302. outSettings << " <VST2_PATH>" << xmlSafeString(options.pathVST2, true) << "</VST2_PATH>\n";
  1303. outSettings << " <VST3_PATH>" << xmlSafeString(options.pathVST3, true) << "</VST3_PATH>\n";
  1304. outSettings << " <GIG_PATH>" << xmlSafeString(options.pathGIG, true) << "</GIG_PATH>\n";
  1305. outSettings << " <SF2_PATH>" << xmlSafeString(options.pathSF2, true) << "</SF2_PATH>\n";
  1306. outSettings << " <SFZ_PATH>" << xmlSafeString(options.pathSFZ, true) << "</SFZ_PATH>\n";
  1307. }
  1308. outSettings << " </EngineSettings>\n";
  1309. outStream << outSettings;
  1310. char strBuf[STR_MAX+1];
  1311. for (uint i=0; i < pData->curPluginCount; ++i)
  1312. {
  1313. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1314. if (plugin != nullptr && plugin->isEnabled())
  1315. {
  1316. MemoryOutputStream outPlugin(4096);
  1317. outPlugin << "\n";
  1318. strBuf[0] = '\0';
  1319. plugin->getRealName(strBuf);
  1320. if (strBuf[0] != '\0')
  1321. outPlugin << " <!-- " << xmlSafeString(strBuf, true) << " -->\n";
  1322. outPlugin << " <Plugin>\n";
  1323. outPlugin << plugin->getStateSave(false).toString();
  1324. outPlugin << " </Plugin>\n";
  1325. outStream << outPlugin;
  1326. }
  1327. }
  1328. #ifndef BUILD_BRIDGE
  1329. // tell bridges we're done saving
  1330. for (uint i=0; i < pData->curPluginCount; ++i)
  1331. {
  1332. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1333. if (plugin != nullptr && plugin->isEnabled() && (plugin->getHints() & PLUGIN_IS_BRIDGE) != 0)
  1334. plugin->setCustomData(CUSTOM_DATA_TYPE_STRING, "__CarlaPingOnOff__", "true", false);
  1335. }
  1336. // save internal connections
  1337. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1338. {
  1339. if (const char* const* const patchbayConns = getPatchbayConnections(false))
  1340. {
  1341. MemoryOutputStream outPatchbay(2048);
  1342. outPatchbay << "\n <Patchbay>\n";
  1343. for (int i=0; patchbayConns[i] != nullptr && patchbayConns[i+1] != nullptr; ++i, ++i )
  1344. {
  1345. const char* const connSource(patchbayConns[i]);
  1346. const char* const connTarget(patchbayConns[i+1]);
  1347. CARLA_SAFE_ASSERT_CONTINUE(connSource != nullptr && connSource[0] != '\0');
  1348. CARLA_SAFE_ASSERT_CONTINUE(connTarget != nullptr && connTarget[0] != '\0');
  1349. outPatchbay << " <Connection>\n";
  1350. outPatchbay << " <Source>" << connSource << "</Source>\n";
  1351. outPatchbay << " <Target>" << connTarget << "</Target>\n";
  1352. outPatchbay << " </Connection>\n";
  1353. }
  1354. outPatchbay << " </Patchbay>\n";
  1355. outStream << outPatchbay;
  1356. }
  1357. }
  1358. // if we're running inside some session-manager (and using JACK), let them handle the connections
  1359. bool saveExternalConnections;
  1360. /**/ if (std::strcmp(getCurrentDriverName(), "Plugin") == 0)
  1361. saveExternalConnections = false;
  1362. else if (std::strcmp(getCurrentDriverName(), "JACK") != 0)
  1363. saveExternalConnections = true;
  1364. else if (std::getenv("CARLA_DONT_MANAGE_CONNECTIONS") != nullptr)
  1365. saveExternalConnections = false;
  1366. else if (std::getenv("LADISH_APP_NAME") != nullptr)
  1367. saveExternalConnections = false;
  1368. else if (std::getenv("NSM_URL") != nullptr)
  1369. saveExternalConnections = false;
  1370. else
  1371. saveExternalConnections = true;
  1372. if (saveExternalConnections)
  1373. {
  1374. if (const char* const* const patchbayConns = getPatchbayConnections(true))
  1375. {
  1376. MemoryOutputStream outPatchbay(2048);
  1377. outPatchbay << "\n <ExternalPatchbay>\n";
  1378. for (int i=0; patchbayConns[i] != nullptr && patchbayConns[i+1] != nullptr; ++i, ++i )
  1379. {
  1380. const char* const connSource(patchbayConns[i]);
  1381. const char* const connTarget(patchbayConns[i+1]);
  1382. CARLA_SAFE_ASSERT_CONTINUE(connSource != nullptr && connSource[0] != '\0');
  1383. CARLA_SAFE_ASSERT_CONTINUE(connTarget != nullptr && connTarget[0] != '\0');
  1384. outPatchbay << " <Connection>\n";
  1385. outPatchbay << " <Source>" << connSource << "</Source>\n";
  1386. outPatchbay << " <Target>" << connTarget << "</Target>\n";
  1387. outPatchbay << " </Connection>\n";
  1388. }
  1389. outPatchbay << " </ExternalPatchbay>\n";
  1390. outStream << outPatchbay;
  1391. }
  1392. }
  1393. #endif
  1394. outStream << "</CARLA-PROJECT>\n";
  1395. }
  1396. bool CarlaEngine::loadProjectInternal(juce::XmlDocument& xmlDoc)
  1397. {
  1398. ScopedPointer<XmlElement> xmlElement(xmlDoc.getDocumentElement(true));
  1399. CARLA_SAFE_ASSERT_RETURN_ERR(xmlElement != nullptr, "Failed to parse project file");
  1400. const String& xmlType(xmlElement->getTagName());
  1401. const bool isPreset(xmlType.equalsIgnoreCase("carla-preset"));
  1402. if (! (xmlType.equalsIgnoreCase("carla-project") || isPreset))
  1403. {
  1404. setLastError("Not a valid Carla project or preset file");
  1405. return false;
  1406. }
  1407. // completely load file
  1408. xmlElement = xmlDoc.getDocumentElement(false);
  1409. CARLA_SAFE_ASSERT_RETURN_ERR(xmlElement != nullptr, "Failed to completely parse project file");
  1410. const bool isPlugin(std::strcmp(getCurrentDriverName(), "Plugin") == 0);
  1411. // engine settings
  1412. for (XmlElement* elem = xmlElement->getFirstChildElement(); elem != nullptr; elem = elem->getNextElement())
  1413. {
  1414. const String& tagName(elem->getTagName());
  1415. if (! tagName.equalsIgnoreCase("enginesettings"))
  1416. continue;
  1417. for (XmlElement* settElem = elem->getFirstChildElement(); settElem != nullptr; settElem = settElem->getNextElement())
  1418. {
  1419. const String& tag(settElem->getTagName());
  1420. const String text(settElem->getAllSubText().trim());
  1421. /** some settings might be incorrect or require extra work,
  1422. so we call setOption rather than modifying them direly */
  1423. int option = -1;
  1424. int value = 0;
  1425. const char* valueStr = nullptr;
  1426. /**/ if (tag.equalsIgnoreCase("forcestereo"))
  1427. {
  1428. option = ENGINE_OPTION_FORCE_STEREO;
  1429. value = text.equalsIgnoreCase("true") ? 1 : 0;
  1430. }
  1431. else if (tag.equalsIgnoreCase("preferpluginbridges"))
  1432. {
  1433. option = ENGINE_OPTION_PREFER_PLUGIN_BRIDGES;
  1434. value = text.equalsIgnoreCase("true") ? 1 : 0;
  1435. }
  1436. else if (tag.equalsIgnoreCase("preferuibridges"))
  1437. {
  1438. option = ENGINE_OPTION_PREFER_UI_BRIDGES;
  1439. value = text.equalsIgnoreCase("true") ? 1 : 0;
  1440. }
  1441. else if (tag.equalsIgnoreCase("uisalwaysontop"))
  1442. {
  1443. option = ENGINE_OPTION_UIS_ALWAYS_ON_TOP;
  1444. value = text.equalsIgnoreCase("true") ? 1 : 0;
  1445. }
  1446. else if (tag.equalsIgnoreCase("maxparameters"))
  1447. {
  1448. option = ENGINE_OPTION_MAX_PARAMETERS;
  1449. value = text.getIntValue();
  1450. }
  1451. else if (tag.equalsIgnoreCase("uibridgestimeout"))
  1452. {
  1453. option = ENGINE_OPTION_UI_BRIDGES_TIMEOUT;
  1454. value = text.getIntValue();
  1455. }
  1456. else if (isPlugin)
  1457. {
  1458. /**/ if (tag.equalsIgnoreCase("LADSPA_PATH"))
  1459. {
  1460. option = ENGINE_OPTION_PLUGIN_PATH;
  1461. value = PLUGIN_LADSPA;
  1462. valueStr = text.toRawUTF8();
  1463. }
  1464. else if (tag.equalsIgnoreCase("DSSI_PATH"))
  1465. {
  1466. option = ENGINE_OPTION_PLUGIN_PATH;
  1467. value = PLUGIN_DSSI;
  1468. valueStr = text.toRawUTF8();
  1469. }
  1470. else if (tag.equalsIgnoreCase("LV2_PATH"))
  1471. {
  1472. option = ENGINE_OPTION_PLUGIN_PATH;
  1473. value = PLUGIN_LV2;
  1474. valueStr = text.toRawUTF8();
  1475. }
  1476. else if (tag.equalsIgnoreCase("VST2_PATH"))
  1477. {
  1478. option = ENGINE_OPTION_PLUGIN_PATH;
  1479. value = PLUGIN_VST2;
  1480. valueStr = text.toRawUTF8();
  1481. }
  1482. else if (tag.equalsIgnoreCase("VST3_PATH"))
  1483. {
  1484. option = ENGINE_OPTION_PLUGIN_PATH;
  1485. value = PLUGIN_VST3;
  1486. valueStr = text.toRawUTF8();
  1487. }
  1488. else if (tag.equalsIgnoreCase("GIG_PATH"))
  1489. {
  1490. option = ENGINE_OPTION_PLUGIN_PATH;
  1491. value = PLUGIN_GIG;
  1492. valueStr = text.toRawUTF8();
  1493. }
  1494. else if (tag.equalsIgnoreCase("SF2_PATH"))
  1495. {
  1496. option = ENGINE_OPTION_PLUGIN_PATH;
  1497. value = PLUGIN_SF2;
  1498. valueStr = text.toRawUTF8();
  1499. }
  1500. else if (tag.equalsIgnoreCase("SFZ_PATH"))
  1501. {
  1502. option = ENGINE_OPTION_PLUGIN_PATH;
  1503. value = PLUGIN_SFZ;
  1504. valueStr = text.toRawUTF8();
  1505. }
  1506. }
  1507. CARLA_SAFE_ASSERT_CONTINUE(option != -1);
  1508. setOption(static_cast<EngineOption>(option), value, valueStr);
  1509. }
  1510. break;
  1511. }
  1512. // handle plugins first
  1513. for (XmlElement* elem = xmlElement->getFirstChildElement(); elem != nullptr; elem = elem->getNextElement())
  1514. {
  1515. const String& tagName(elem->getTagName());
  1516. if (isPreset || tagName.equalsIgnoreCase("plugin"))
  1517. {
  1518. CarlaStateSave stateSave;
  1519. stateSave.fillFromXmlElement(isPreset ? xmlElement.get() : elem);
  1520. callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  1521. CARLA_SAFE_ASSERT_CONTINUE(stateSave.type != nullptr);
  1522. const void* extraStuff = nullptr;
  1523. // check if using GIG or SF2 16outs
  1524. static const char kUse16OutsSuffix[] = " (16 outs)";
  1525. const BinaryType btype(getBinaryTypeFromFile(stateSave.binary));
  1526. const PluginType ptype(getPluginTypeFromString(stateSave.type));
  1527. if (CarlaString(stateSave.label).endsWith(kUse16OutsSuffix))
  1528. {
  1529. if (ptype == PLUGIN_GIG || ptype == PLUGIN_SF2)
  1530. extraStuff = "true";
  1531. }
  1532. // TODO - proper find&load plugins
  1533. if (addPlugin(btype, ptype, stateSave.binary, stateSave.name, stateSave.label, stateSave.uniqueId, extraStuff, stateSave.options))
  1534. {
  1535. if (CarlaPlugin* const plugin = getPlugin(pData->curPluginCount-1))
  1536. {
  1537. #ifndef BUILD_BRIDGE
  1538. // deactivate bridge client-side ping check, since some plugins block during load
  1539. if ((plugin->getHints() & PLUGIN_IS_BRIDGE) != 0 && ! isPreset)
  1540. plugin->setCustomData(CUSTOM_DATA_TYPE_STRING, "__CarlaPingOnOff__", "false", false);
  1541. #endif
  1542. plugin->loadStateSave(stateSave);
  1543. }
  1544. }
  1545. else
  1546. carla_stderr2("Failed to load a plugin, error was:\n%s", getLastError());
  1547. }
  1548. if (isPreset)
  1549. return true;
  1550. }
  1551. #ifndef BUILD_BRIDGE
  1552. // tell bridges we're done loading
  1553. for (uint i=0; i < pData->curPluginCount; ++i)
  1554. {
  1555. CarlaPlugin* const plugin(pData->plugins[i].plugin);
  1556. if (plugin != nullptr && plugin->isEnabled() && (plugin->getHints() & PLUGIN_IS_BRIDGE) != 0)
  1557. plugin->setCustomData(CUSTOM_DATA_TYPE_STRING, "__CarlaPingOnOff__", "true", false);
  1558. }
  1559. callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  1560. // handle connections (internal)
  1561. if (pData->options.processMode == ENGINE_PROCESS_MODE_PATCHBAY)
  1562. {
  1563. const bool isUsingExternal(pData->graph.isUsingExternal());
  1564. for (XmlElement* elem = xmlElement->getFirstChildElement(); elem != nullptr; elem = elem->getNextElement())
  1565. {
  1566. const String& tagName(elem->getTagName());
  1567. if (! tagName.equalsIgnoreCase("patchbay"))
  1568. continue;
  1569. CarlaString sourcePort, targetPort;
  1570. for (XmlElement* patchElem = elem->getFirstChildElement(); patchElem != nullptr; patchElem = patchElem->getNextElement())
  1571. {
  1572. const String& patchTag(patchElem->getTagName());
  1573. sourcePort.clear();
  1574. targetPort.clear();
  1575. if (! patchTag.equalsIgnoreCase("connection"))
  1576. continue;
  1577. for (XmlElement* connElem = patchElem->getFirstChildElement(); connElem != nullptr; connElem = connElem->getNextElement())
  1578. {
  1579. const String& tag(connElem->getTagName());
  1580. const String text(connElem->getAllSubText().trim());
  1581. /**/ if (tag.equalsIgnoreCase("source"))
  1582. sourcePort = text.toRawUTF8();
  1583. else if (tag.equalsIgnoreCase("target"))
  1584. targetPort = text.toRawUTF8();
  1585. }
  1586. if (sourcePort.isNotEmpty() && targetPort.isNotEmpty())
  1587. restorePatchbayConnection(false, sourcePort, targetPort, !isUsingExternal);
  1588. }
  1589. break;
  1590. }
  1591. }
  1592. callback(ENGINE_CALLBACK_IDLE, 0, 0, 0, 0.0f, nullptr);
  1593. // if we're running inside some session-manager (and using JACK), let them handle the external connections
  1594. bool loadExternalConnections;
  1595. /**/ if (std::strcmp(getCurrentDriverName(), "Plugin") == 0)
  1596. loadExternalConnections = false;
  1597. else if (std::strcmp(getCurrentDriverName(), "JACK") != 0)
  1598. loadExternalConnections = true;
  1599. else if (std::getenv("CARLA_DONT_MANAGE_CONNECTIONS") != nullptr)
  1600. loadExternalConnections = false;
  1601. else if (std::getenv("LADISH_APP_NAME") != nullptr)
  1602. loadExternalConnections = false;
  1603. else if (std::getenv("NSM_URL") != nullptr)
  1604. loadExternalConnections = false;
  1605. else
  1606. loadExternalConnections = true;
  1607. // handle connections (external)
  1608. if (loadExternalConnections)
  1609. {
  1610. const bool isUsingExternal(pData->graph.isUsingExternal());
  1611. for (XmlElement* elem = xmlElement->getFirstChildElement(); elem != nullptr; elem = elem->getNextElement())
  1612. {
  1613. const String& tagName(elem->getTagName());
  1614. if (! tagName.equalsIgnoreCase("externalpatchbay"))
  1615. continue;
  1616. CarlaString sourcePort, targetPort;
  1617. for (XmlElement* patchElem = elem->getFirstChildElement(); patchElem != nullptr; patchElem = patchElem->getNextElement())
  1618. {
  1619. const String& patchTag(patchElem->getTagName());
  1620. sourcePort.clear();
  1621. targetPort.clear();
  1622. if (! patchTag.equalsIgnoreCase("connection"))
  1623. continue;
  1624. for (XmlElement* connElem = patchElem->getFirstChildElement(); connElem != nullptr; connElem = connElem->getNextElement())
  1625. {
  1626. const String& tag(connElem->getTagName());
  1627. const String text(connElem->getAllSubText().trim());
  1628. /**/ if (tag.equalsIgnoreCase("source"))
  1629. sourcePort = text.toRawUTF8();
  1630. else if (tag.equalsIgnoreCase("target"))
  1631. targetPort = text.toRawUTF8();
  1632. }
  1633. if (sourcePort.isNotEmpty() && targetPort.isNotEmpty())
  1634. restorePatchbayConnection(true, sourcePort, targetPort, isUsingExternal);
  1635. }
  1636. break;
  1637. }
  1638. }
  1639. #endif
  1640. return true;
  1641. }
  1642. // -----------------------------------------------------------------------
  1643. CARLA_BACKEND_END_NAMESPACE