falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 42 Activity
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.
2332 Commits
16 Branches
141MB
Tree: 46ecbdbec3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '46ecbdbec3'
${ noResults }
Carla/source/backend/plugin/CarlaPluginThread.cpp

385 lines
13KB
Raw Blame History 

  1. /*

  2.  * Carla Plugin

  3.  * Copyright (C) 2011-2014 Filipe Coelho <falktx@falktx.com>

  4.  *

  5.  * This program is free software; you can redistribute it and/or

  6.  * modify it under the terms of the GNU General Public License as

  7.  * published by the Free Software Foundation; either version 2 of

  8.  * the License, or any later version.

  9.  *

  10.  * This program is distributed in the hope that it will be useful,

  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of

  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

  13.  * GNU General Public License for more details.

  14.  *

  15.  * For a full copy of the GNU General Public License see the doc/GPL.txt file.

  16.  */

  17. 

  18. #include "CarlaPlugin.hpp"

  19. #include "CarlaPluginThread.hpp"

  20. #include "CarlaEngine.hpp"

  21. 

  22. #include "juce_core.h"

  23. 

  24. using juce::String;

  25. using juce::StringArray;

  26. 

  27. CARLA_BACKEND_START_NAMESPACE

  28. 

  29. // -----------------------------------------------------------------------

  30. 

  31. #ifdef DEBUG

  32. static inline

  33. const char* PluginThreadMode2str(const CarlaPluginThread::Mode mode) noexcept

  34. {

  35.     switch (mode)

  36.     {

  37.     case CarlaPluginThread::PLUGIN_THREAD_NULL:

  38.         return "PLUGIN_THREAD_NULL";

  39.     case CarlaPluginThread::PLUGIN_THREAD_DSSI_GUI:

  40.         return "PLUGIN_THREAD_DSSI_GUI";

  41.     case CarlaPluginThread::PLUGIN_THREAD_LV2_GUI:

  42.         return "PLUGIN_THREAD_LV2_GUI";

  43.     case CarlaPluginThread::PLUGIN_THREAD_VST_GUI:

  44.         return "PLUGIN_THREAD_VST_GUI";

  45.     case CarlaPluginThread::PLUGIN_THREAD_BRIDGE:

  46.         return "PLUGIN_THREAD_BRIDGE";

  47.     }

  48. 

  49.     carla_stderr("CarlaPluginThread::PluginThreadMode2str(%i) - invalid mode", mode);

  50.     return nullptr;

  51. }

  52. #endif

  53. 

  54. // -----------------------------------------------------------------------

  55. 

  56. CarlaPluginThread::CarlaPluginThread(CarlaBackend::CarlaEngine* const engine, CarlaBackend::CarlaPlugin* const plugin, const Mode mode) noexcept

  57.     : CarlaThread("CarlaPluginThread"),

  58.       fEngine(engine),

  59.       fPlugin(plugin),

  60.       fMode(mode),

  61.       fBinary(),

  62.       fLabel(),

  63.       fExtra1(),

  64.       fExtra2(),

  65.       fProcess(nullptr),

  66.       leakDetector_CarlaPluginThread()

  67. {

  68.     carla_debug("CarlaPluginThread::CarlaPluginThread(%p, %p, %s)", engine, plugin, PluginThreadMode2str(mode));

  69. }

  70. 

  71. CarlaPluginThread::~CarlaPluginThread() noexcept

  72. {

  73.     carla_debug("CarlaPluginThread::~CarlaPluginThread()");

  74. 

  75.     if (fProcess != nullptr)

  76.     {

  77.         //fProcess.release();

  78.         //try {

  79.             //delete fProcess;

  80.         //} CARLA_SAFE_EXCEPTION("~CarlaPluginThread(): delete ChildProcess");

  81.         fProcess = nullptr;

  82.     }

  83. }

  84. 

  85. void CarlaPluginThread::setMode(const CarlaPluginThread::Mode mode) noexcept

  86. {

  87.     CARLA_SAFE_ASSERT(! isThreadRunning());

  88.     carla_debug("CarlaPluginThread::setMode(%s)", PluginThreadMode2str(mode));

  89. 

  90.     fMode = mode;

  91. }

  92. 

  93. void CarlaPluginThread::setOscData(const char* const binary, const char* const label, const char* const extra1, const char* const extra2) noexcept

  94. {

  95.     CARLA_SAFE_ASSERT(! isThreadRunning());

  96.     carla_debug("CarlaPluginThread::setOscData(\"%s\", \"%s\", \"%s\", \"%s\")", binary, label, extra1, extra2);

  97. 

  98.     fBinary = binary;

  99.     fLabel  = label;

  100.     fExtra1 = extra1;

  101.     fExtra2 = extra2;

  102. }

  103. 

  104. uintptr_t CarlaPluginThread::getPid() const

  105. {

  106.     CARLA_SAFE_ASSERT_RETURN(fProcess != nullptr, 0);

  107. 

  108.     return (uintptr_t)fProcess->getPID();

  109. }

  110. 

  111. void CarlaPluginThread::run()

  112. {

  113.     carla_debug("CarlaPluginThread::run()");

  114. 

  115.     if (fProcess == nullptr)

  116.     {

  117.        fProcess = new ChildProcess;

  118.        //fProcess->setProcessChannelMode(QProcess::ForwardedChannels);

  119.     }

  120.     else if (fProcess->isRunning())

  121.     {

  122.         carla_stderr("CarlaPluginThread::run() - already running, giving up...");

  123. 

  124.         switch (fMode)

  125.         {

  126.         case PLUGIN_THREAD_NULL:

  127.         case PLUGIN_THREAD_BRIDGE:

  128.             break;

  129. 

  130.         case PLUGIN_THREAD_DSSI_GUI:

  131.         case PLUGIN_THREAD_LV2_GUI:

  132.         case PLUGIN_THREAD_VST_GUI:

  133.             fEngine->callback(CarlaBackend::ENGINE_CALLBACK_UI_STATE_CHANGED, fPlugin->getId(), 0, 0, 0.0f, nullptr);

  134.             fProcess->kill();

  135.             fProcess = nullptr;

  136.             return;

  137.         }

  138.     }

  139. 

  140.     String name(fPlugin->getName());

  141. 

  142.     if (name.isEmpty())

  143.         name = "(none)";

  144. 

  145.     if (fLabel.isEmpty())

  146.         fLabel = "\"\"";

  147. 

  148.     StringArray arguments;

  149. 

  150. #ifndef CARLA_OS_WIN

  151.     if (fBinary.endsWith(".exe"))

  152.         arguments.add("wine");

  153. #endif

  154. 

  155.     arguments.add(fBinary.buffer());

  156. 

  157.     // use a global mutex to ensure bridge environment is correct

  158.     static CarlaMutex sEnvMutex;

  159. 

  160.     char strBuf[STR_MAX+1];

  161.     strBuf[STR_MAX] = '\0';

  162. 

  163.     const EngineOptions& options(fEngine->getOptions());

  164. 

  165.     sEnvMutex.lock();

  166. 

  167.     carla_setenv("CARLA_CLIENT_NAME", name.toRawUTF8());

  168. 

  169.     std::snprintf(strBuf, STR_MAX, "%f", fEngine->getSampleRate());

  170.     carla_setenv("CARLA_SAMPLE_RATE", strBuf);

  171. 

  172.     carla_setenv("ENGINE_OPTION_FORCE_STEREO",          bool2str(options.forceStereo));

  173.     carla_setenv("ENGINE_OPTION_PREFER_PLUGIN_BRIDGES", bool2str(options.preferPluginBridges));

  174.     carla_setenv("ENGINE_OPTION_PREFER_UI_BRIDGES",     bool2str(options.preferUiBridges));

  175.     carla_setenv("ENGINE_OPTION_UIS_ALWAYS_ON_TOP",     bool2str(options.uisAlwaysOnTop));

  176. 

  177.     std::snprintf(strBuf, STR_MAX, "%u", options.maxParameters);

  178.     carla_setenv("ENGINE_OPTION_MAX_PARAMETERS", strBuf);

  179. 

  180.     std::snprintf(strBuf, STR_MAX, "%u", options.uiBridgesTimeout);

  181.     carla_setenv("ENGINE_OPTION_UI_BRIDGES_TIMEOUT",strBuf);

  182. 

  183.     if (options.pathLADSPA != nullptr)

  184.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LADSPA", options.pathLADSPA);

  185.     else

  186.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LADSPA", "");

  187. 

  188.     if (options.pathDSSI != nullptr)

  189.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_DSSI", options.pathDSSI);

  190.     else

  191.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_DSSI", "");

  192. 

  193.     if (options.pathLV2 != nullptr)

  194.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LV2", options.pathLV2);

  195.     else

  196.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_LV2", "");

  197. 

  198.     if (options.pathVST != nullptr)

  199.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST", options.pathVST);

  200.     else

  201.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST", "");

  202. 

  203.     if (options.pathVST3 != nullptr)

  204.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST3", options.pathVST3);

  205.     else

  206.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST3", "");

  207. 

  208.     if (options.pathAU != nullptr)

  209.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_AU", options.pathAU);

  210.     else

  211.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_AU", "");

  212. 

  213.     if (options.pathGIG != nullptr)

  214.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_GIG", options.pathGIG);

  215.     else

  216.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_GIG", "");

  217. 

  218.     if (options.pathSF2 != nullptr)

  219.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SF2", options.pathSF2);

  220.     else

  221.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SF2", "");

  222. 

  223.     if (options.pathSFZ != nullptr)

  224.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SFZ", options.pathSFZ);

  225.     else

  226.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_SFZ", "");

  227. 

  228.     if (options.binaryDir != nullptr)

  229.         carla_setenv("ENGINE_OPTION_PATH_BINARIES", options.binaryDir);

  230.     else

  231.         carla_setenv("ENGINE_OPTION_PATH_BINARIES", "");

  232. 

  233.     if (options.resourceDir != nullptr)

  234.         carla_setenv("ENGINE_OPTION_PATH_RESOURCES", options.resourceDir);

  235.     else

  236.         carla_setenv("ENGINE_OPTION_PATH_RESOURCES", "");

  237. 

  238.     carla_setenv("ENGINE_OPTION_PREVENT_BAD_BEHAVIOUR", bool2str(options.preventBadBehaviour));

  239. 

  240.     std::snprintf(strBuf, STR_MAX, P_UINTPTR, options.frontendWinId);

  241.     carla_setenv("ENGINE_OPTION_FRONTEND_WIN_ID", strBuf);

  242. 

  243. #ifdef CARLA_OS_LINUX

  244.     const char* const oldPreload(std::getenv("LD_PRELOAD"));

  245.     ::unsetenv("LD_PRELOAD");

  246. #endif

  247. 

  248.     switch (fMode)

  249.     {

  250.     case PLUGIN_THREAD_NULL:

  251.         break;

  252. 

  253.     case PLUGIN_THREAD_DSSI_GUI:

  254.         /* osc-url  */ arguments.add(String(fEngine->getOscServerPathUDP()) + String("/") + String(fPlugin->getId()));

  255.         /* filename */ arguments.add(fPlugin->getFilename());

  256.         /* label    */ arguments.add(fLabel.buffer());

  257.         /* ui-title */ arguments.add(name + String(" (GUI)"));

  258.         break;

  259. 

  260.     case PLUGIN_THREAD_LV2_GUI:

  261.         /* osc-url   */ arguments.add(String(fEngine->getOscServerPathUDP()) + String("/") + String(fPlugin->getId()));

  262.         /* URI       */ arguments.add(fLabel.buffer());

  263.         /* UI URI    */ arguments.add(fExtra1.buffer());

  264.         /* UI Bundle */ arguments.add(fExtra2.buffer());

  265.         /* UI Title  */ arguments.add(name + String(" (GUI)"));

  266.         break;

  267. 

  268.     case PLUGIN_THREAD_VST_GUI:

  269.         /* osc-url  */ arguments.add(String(fEngine->getOscServerPathUDP()) + String("/") + String(fPlugin->getId()));

  270.         /* filename */ arguments.add(fPlugin->getFilename());

  271.         /* ui-title */ arguments.add(name + String(" (GUI)"));

  272.         break;

  273. 

  274.     case PLUGIN_THREAD_BRIDGE:

  275.         /* stype    */ arguments.add(fExtra1.buffer());

  276.         /* filename */ arguments.add(fPlugin->getFilename());

  277.         /* label    */ arguments.add(fLabel.buffer());

  278.         /* uniqueId */ arguments.add(String(static_cast<juce::int64>(fPlugin->getUniqueId())));

  279. 

  280.         carla_setenv("ENGINE_BRIDGE_OSC_URL", String(String(fEngine->getOscServerPathUDP()) + String("/") + String(fPlugin->getId())).toRawUTF8());

  281.         carla_setenv("ENGINE_BRIDGE_SHM_IDS", fExtra2.buffer());

  282.         carla_setenv("WINEDEBUG", "-all");

  283.         break;

  284.     }

  285. 

  286.     carla_stdout("starting app..");

  287. 

  288.     fProcess->start(arguments);

  289. 

  290. #ifdef CARLA_OS_LINUX

  291.     if (oldPreload != nullptr)

  292.         ::setenv("LD_PRELOAD", oldPreload, 1);

  293. #endif

  294. 

  295.     sEnvMutex.unlock();

  296. 

  297.     switch (fMode)

  298.     {

  299.     case PLUGIN_THREAD_NULL:

  300.         break;

  301. 

  302.     case PLUGIN_THREAD_DSSI_GUI:

  303.     case PLUGIN_THREAD_LV2_GUI:

  304.     case PLUGIN_THREAD_VST_GUI:

  305.         if (fPlugin->waitForOscGuiShow())

  306.         {

  307.             while (fProcess->isRunning() && ! shouldThreadExit())

  308.                 carla_sleep(1);

  309. 

  310.             // we only get here if UI was closed or thread asked to exit

  311.             if (fProcess->isRunning() && shouldThreadExit())

  312.             {

  313.                 fProcess->waitForProcessToFinish(static_cast<int>(fEngine->getOptions().uiBridgesTimeout));

  314. 

  315.                 if (fProcess->isRunning())

  316.                 {

  317.                     carla_stdout("CarlaPluginThread::run() - UI refused to close, force kill now");

  318.                     fProcess->kill();

  319.                 }

  320.                 else

  321.                 {

  322.                     carla_stdout("CarlaPluginThread::run() - UI auto-closed successfully");

  323.                 }

  324.             }

  325.             else if (fProcess->getExitCode() != 0 /*|| fProcess->exitStatus() == QProcess::CrashExit*/)

  326.                 carla_stderr("CarlaPluginThread::run() - UI crashed while running");

  327.             else

  328.                 carla_stdout("CarlaPluginThread::run() - UI closed cleanly");

  329. 

  330.             fEngine->callback(CarlaBackend::ENGINE_CALLBACK_UI_STATE_CHANGED, fPlugin->getId(), 0, 0, 0.0f, nullptr);

  331.         }

  332.         else

  333.         {

  334.             fProcess->kill();

  335. 

  336.             carla_stdout("CarlaPluginThread::run() - GUI timeout");

  337.             fEngine->callback(CarlaBackend::ENGINE_CALLBACK_UI_STATE_CHANGED, fPlugin->getId(), 0, 0, 0.0f, nullptr);

  338.         }

  339.         break;

  340. 

  341.     case PLUGIN_THREAD_BRIDGE:

  342.         //fProcess->waitForFinished(-1);

  343. 

  344.         while (fProcess->isRunning() && ! shouldThreadExit())

  345.             carla_sleep(1);

  346. 

  347.         // we only get here if bridge crashed or thread asked to exit

  348.         if (fProcess->isRunning() && shouldThreadExit())

  349.         {

  350.             fProcess->waitForProcessToFinish(2000);

  351. 

  352.             if (fProcess->isRunning())

  353.             {

  354.                 carla_stdout("CarlaPluginThread::run() - bridge refused to close, force kill now");

  355.                 fProcess->kill();

  356.             }

  357.             else

  358.             {

  359.                 carla_stdout("CarlaPluginThread::run() - bridge auto-closed successfully");

  360.             }

  361.         }

  362.         else

  363.         {

  364.             // forced quit, may have crashed

  365.             if (fProcess->getExitCode() != 0 /*|| fProcess->exitStatus() == QProcess::CrashExit*/)

  366.             {

  367.                 carla_stderr("CarlaPluginThread::run() - bridge crashed");

  368. 

  369.                 CarlaString errorString("Plugin '" + CarlaString(fPlugin->getName()) + "' has crashed!\n"

  370.                                         "Saving now will lose its current settings.\n"

  371.                                         "Please remove this plugin, and not rely on it from this point.");

  372.                 fEngine->callback(CarlaBackend::ENGINE_CALLBACK_ERROR, fPlugin->getId(), 0, 0, 0.0f, errorString);

  373.             }

  374.         }

  375.         break;

  376.     }

  377. 

  378.     carla_stdout("app finished");

  379.     fProcess = nullptr;

  380. }

  381. 

  382. // -----------------------------------------------------------------------

  383. 

  384. CARLA_BACKEND_END_NAMESPACE