falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 43 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.
2260 Commits
17 Branches
263MB
Tree: 09a9d7da86
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '09a9d7da86'
${ noResults }
Carla/source/backend/plugin/CarlaPluginThread.cpp

349 lines
12KB
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.     std::snprintf(strBuf, STR_MAX, "%f", fEngine->getSampleRate());

  168.     carla_setenv("CARLA_SAMPLE_RATE", strBuf);

  169. 

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

  171.     carla_setenv("ENGINE_OPTION_MAX_PARAMETERS", strBuf);

  172. 

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

  174.     carla_setenv("ENGINE_OPTION_UI_BRIDGES_TIMEOUT",strBuf);

  175. 

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

  177. 

  178.     if (options.pathLADSPA != nullptr && options.pathLADSPA[0] != '\0')

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

  180. 

  181.     if (options.pathDSSI != nullptr && options.pathDSSI[0] != '\0')

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

  183. 

  184.     if (options.pathLV2 != nullptr && options.pathLV2[0] != '\0')

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

  186. 

  187.     if (options.pathVST != nullptr && options.pathVST[0] != '\0')

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

  189. 

  190.     if (options.pathVST3 != nullptr && options.pathVST3[0] != '\0')

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

  192. 

  193.     if (options.pathAU != nullptr && options.pathAU[0] != '\0')

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

  195. 

  196.     if (options.pathGIG != nullptr && options.pathGIG[0] != '\0')

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

  198. 

  199.     if (options.pathSF2 != nullptr && options.pathSF2[0] != '\0')

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

  201. 

  202.     if (options.pathSFZ != nullptr && options.pathSFZ[0] != '\0')

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

  204. 

  205.     if (options.binaryDir != nullptr && options.binaryDir[0] != '\0')

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

  207. 

  208.     if (options.resourceDir != nullptr && options.resourceDir[0] != '\0')

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

  210. 

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

  212.     carla_setenv("ENGINE_OPTION_FRONTEND_WIN_ID", strBuf);

  213. 

  214.     switch (fMode)

  215.     {

  216.     case PLUGIN_THREAD_NULL:

  217.         break;

  218. 

  219.     case PLUGIN_THREAD_DSSI_GUI:

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

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

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

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

  224.         break;

  225. 

  226.     case PLUGIN_THREAD_LV2_GUI:

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

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

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

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

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

  232.         break;

  233. 

  234.     case PLUGIN_THREAD_VST_GUI:

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

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

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

  238.         break;

  239. 

  240.     case PLUGIN_THREAD_BRIDGE:

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

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

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

  244.         /* name     */ arguments.add(name);

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

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

  247. 

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

  249.         carla_setenv("ENGINE_BRIDGE_CLIENT_NAME", name.toRawUTF8());

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

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

  252.         break;

  253.     }

  254. 

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

  256. 

  257.     fProcess->start(arguments);

  258. 

  259.     sEnvMutex.unlock();

  260. 

  261.     switch (fMode)

  262.     {

  263.     case PLUGIN_THREAD_NULL:

  264.         break;

  265. 

  266.     case PLUGIN_THREAD_DSSI_GUI:

  267.     case PLUGIN_THREAD_LV2_GUI:

  268.     case PLUGIN_THREAD_VST_GUI:

  269.         if (fPlugin->waitForOscGuiShow())

  270.         {

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

  272.                 carla_sleep(1);

  273. 

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

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

  276.             {

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

  278. 

  279.                 if (fProcess->isRunning())

  280.                 {

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

  282.                     fProcess->kill();

  283.                 }

  284.                 else

  285.                 {

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

  287.                 }

  288.             }

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

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

  291.             else

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

  293. 

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

  295.         }

  296.         else

  297.         {

  298.             fProcess->kill();

  299. 

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

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

  302.         }

  303.         break;

  304. 

  305.     case PLUGIN_THREAD_BRIDGE:

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

  307. 

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

  309.             carla_sleep(1);

  310. 

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

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

  313.         {

  314.             fProcess->waitForProcessToFinish(2000);

  315. 

  316.             if (fProcess->isRunning())

  317.             {

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

  319.                 fProcess->kill();

  320.             }

  321.             else

  322.             {

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

  324.             }

  325.         }

  326.         else

  327.         {

  328.             // forced quit, may have crashed

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

  330.             {

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

  332. 

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

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

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

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

  337.             }

  338.         }

  339.         break;

  340.     }

  341. 

  342.     carla_stdout("app finished");

  343.     fProcess = nullptr;

  344. }

  345. 

  346. // -----------------------------------------------------------------------

  347. 

  348. CARLA_BACKEND_END_NAMESPACE