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.
2521 Commits
16 Branches
201MB
Tree: 7b286f144e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '7b286f144e'
${ noResults }
Carla/source/backend/plugin/CarlaPluginThread.cpp

393 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. #if 0

  19. 

  20. #include "CarlaPlugin.hpp"

  21. #include "CarlaPluginThread.hpp"

  22. #include "CarlaEngine.hpp"

  23. 

  24. #include "juce_core.h"

  25. 

  26. using juce::String;

  27. using juce::StringArray;

  28. 

  29. CARLA_BACKEND_START_NAMESPACE

  30. 

  31. // -----------------------------------------------------------------------

  32. 

  33. #ifdef DEBUG

  34. static inline

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

  36. {

  37.     switch (mode)

  38.     {

  39.     case CarlaPluginThread::PLUGIN_THREAD_NULL:

  40.         return "PLUGIN_THREAD_NULL";

  41.     case CarlaPluginThread::PLUGIN_THREAD_DSSI_GUI:

  42.         return "PLUGIN_THREAD_DSSI_GUI";

  43.     case CarlaPluginThread::PLUGIN_THREAD_LV2_GUI:

  44.         return "PLUGIN_THREAD_LV2_GUI";

  45.     case CarlaPluginThread::PLUGIN_THREAD_VST2_GUI:

  46.         return "PLUGIN_THREAD_VST2_GUI";

  47.     case CarlaPluginThread::PLUGIN_THREAD_BRIDGE:

  48.         return "PLUGIN_THREAD_BRIDGE";

  49.     }

  50. 

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

  52.     return nullptr;

  53. }

  54. #endif

  55. 

  56. // -----------------------------------------------------------------------

  57. 

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

  59.     : CarlaThread("CarlaPluginThread"),

  60.       fEngine(engine),

  61.       fPlugin(plugin),

  62.       fMode(mode),

  63.       fBinary(),

  64.       fLabel(),

  65.       fExtra1(),

  66.       fExtra2(),

  67.       fProcess(nullptr),

  68.       leakDetector_CarlaPluginThread()

  69. {

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

  71. }

  72. 

  73. CarlaPluginThread::~CarlaPluginThread() noexcept

  74. {

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

  76. 

  77.     if (fProcess != nullptr)

  78.     {

  79.         //fProcess.release();

  80.         //try {

  81.             //delete fProcess;

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

  83.         fProcess = nullptr;

  84.     }

  85. }

  86. 

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

  88. {

  89.     CARLA_SAFE_ASSERT(! isThreadRunning());

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

  91. 

  92.     fMode = mode;

  93. }

  94. 

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

  96. {

  97.     CARLA_SAFE_ASSERT(! isThreadRunning());

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

  99. 

  100.     fBinary = binary;

  101.     fLabel  = label;

  102.     fExtra1 = extra1;

  103.     fExtra2 = extra2;

  104. }

  105. 

  106. uintptr_t CarlaPluginThread::getPid() const

  107. {

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

  109. 

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

  111. }

  112. 

  113. void CarlaPluginThread::run()

  114. {

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

  116. 

  117.     if (fProcess == nullptr)

  118.     {

  119.        fProcess = new ChildProcess;

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

  121.     }

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

  123.     {

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

  125. 

  126.         switch (fMode)

  127.         {

  128.         case PLUGIN_THREAD_NULL:

  129.         case PLUGIN_THREAD_BRIDGE:

  130.             break;

  131. 

  132.         case PLUGIN_THREAD_DSSI_GUI:

  133.         case PLUGIN_THREAD_LV2_GUI:

  134.         case PLUGIN_THREAD_VST2_GUI:

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

  136.             fProcess->kill();

  137.             fProcess = nullptr;

  138.             return;

  139.         }

  140.     }

  141. 

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

  143.     String filename(fPlugin->getFilename());

  144. 

  145.     if (name.isEmpty())

  146.         name = "(none)";

  147. 

  148.     if (filename.isEmpty())

  149.         filename = "\"\"";

  150. 

  151.     if (fLabel.isEmpty())

  152.         fLabel = "\"\"";

  153. 

  154.     StringArray arguments;

  155. 

  156. #ifndef CARLA_OS_WIN

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

  158.         arguments.add("wine");

  159. #endif

  160. 

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

  162. 

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

  164.     static CarlaMutex sEnvMutex;

  165. 

  166.     char strBuf[STR_MAX+1];

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

  168. 

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

  170. 

  171.     sEnvMutex.lock();

  172. 

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

  174. 

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

  176.     carla_setenv("CARLA_SAMPLE_RATE", strBuf);

  177. 

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

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

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

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

  182. 

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

  184.     carla_setenv("ENGINE_OPTION_MAX_PARAMETERS", strBuf);

  185. 

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

  187.     carla_setenv("ENGINE_OPTION_UI_BRIDGES_TIMEOUT",strBuf);

  188. 

  189.     if (options.pathLADSPA != nullptr)

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

  191.     else

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

  193. 

  194.     if (options.pathDSSI != nullptr)

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

  196.     else

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

  198. 

  199.     if (options.pathLV2 != nullptr)

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

  201.     else

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

  203. 

  204.     if (options.pathVST2 != nullptr)

  205.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST2", options.pathVST2);

  206.     else

  207.         carla_setenv("ENGINE_OPTION_PLUGIN_PATH_VST2", "");

  208. 

  209.     if (options.pathVST3 != nullptr)

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

  211.     else

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

  213. 

  214.     if (options.pathAU != nullptr)

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

  216.     else

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

  218. 

  219.     if (options.pathGIG != nullptr)

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

  221.     else

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

  223. 

  224.     if (options.pathSF2 != nullptr)

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

  226.     else

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

  228. 

  229.     if (options.pathSFZ != nullptr)

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

  231.     else

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

  233. 

  234.     if (options.binaryDir != nullptr)

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

  236.     else

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

  238. 

  239.     if (options.resourceDir != nullptr)

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

  241.     else

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

  243. 

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

  245. 

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

  247.     carla_setenv("ENGINE_OPTION_FRONTEND_WIN_ID", strBuf);

  248. 

  249. #ifdef CARLA_OS_LINUX

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

  251.     ::unsetenv("LD_PRELOAD");

  252. #endif

  253. 

  254.     switch (fMode)

  255.     {

  256.     case PLUGIN_THREAD_NULL:

  257.         break;

  258. 

  259.     case PLUGIN_THREAD_DSSI_GUI:

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

  261.         /* filename */ arguments.add(filename);

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

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

  264.         break;

  265. 

  266.     case PLUGIN_THREAD_LV2_GUI:

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

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

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

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

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

  272.         break;

  273. 

  274.     case PLUGIN_THREAD_VST2_GUI:

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

  276.         /* filename */ arguments.add(filename);

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

  278.         break;

  279. 

  280.     case PLUGIN_THREAD_BRIDGE:

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

  282.         /* filename */ arguments.add(filename);

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

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

  285. 

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

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

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

  289.         break;

  290.     }

  291. 

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

  293. 

  294.     fProcess->start(arguments);

  295. 

  296. #ifdef CARLA_OS_LINUX

  297.     if (oldPreload != nullptr)

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

  299. #endif

  300. 

  301.     sEnvMutex.unlock();

  302. 

  303.     switch (fMode)

  304.     {

  305.     case PLUGIN_THREAD_NULL:

  306.         break;

  307. 

  308.     case PLUGIN_THREAD_DSSI_GUI:

  309.     case PLUGIN_THREAD_LV2_GUI:

  310.     case PLUGIN_THREAD_VST2_GUI:

  311.         if (fPlugin->waitForOscGuiShow())

  312.         {

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

  314.                 carla_sleep(1);

  315. 

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

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

  318.             {

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

  320. 

  321.                 if (fProcess->isRunning())

  322.                 {

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

  324.                     fProcess->kill();

  325.                 }

  326.                 else

  327.                 {

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

  329.                 }

  330.             }

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

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

  333.             else

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

  335. 

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

  337.         }

  338.         else

  339.         {

  340.             fProcess->kill();

  341. 

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

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

  344.         }

  345.         break;

  346. 

  347.     case PLUGIN_THREAD_BRIDGE:

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

  349. 

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

  351.             carla_sleep(1);

  352. 

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

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

  355.         {

  356.             fProcess->waitForProcessToFinish(2000);

  357. 

  358.             if (fProcess->isRunning())

  359.             {

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

  361.                 fProcess->kill();

  362.             }

  363.             else

  364.             {

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

  366.             }

  367.         }

  368.         else

  369.         {

  370.             // forced quit, may have crashed

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

  372.             {

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

  374. 

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

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

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

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

  379.             }

  380.         }

  381.         break;

  382.     }

  383. 

  384.     carla_stdout("app finished");

  385.     fProcess = nullptr;

  386. }

  387. 

  388. // -----------------------------------------------------------------------

  389. 

  390. CARLA_BACKEND_END_NAMESPACE

  391. 

  392. #endif