source/backend/engine/CarlaEngineRunner.cpp

   1 /*
   2  * Carla Plugin Host
   3  * Copyright (C) 2011-2022 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 "CarlaEngineRunner.hpp"
  19 #include "CarlaEngineInternal.hpp"
  20 #include "CarlaPlugin.hpp"
  21
  22 #include "water/misc/Time.h"
  23
  24 CARLA_BACKEND_START_NAMESPACE
  25
  26 // -----------------------------------------------------------------------
  27
  28 CarlaEngineRunner::CarlaEngineRunner(CarlaEngine* const engine) noexcept
  29     : CarlaRunner("CarlaEngineRunner"),
  30       kEngine(engine),
  31       fEngineHasIdleOnMainThread(false),
  32       fIsAlwaysRunning(false),
  33       fIsPlugin(false)
  34 {
  35     CARLA_SAFE_ASSERT(engine != nullptr);
  36     carla_debug("CarlaEngineRunner::CarlaEngineRunner(%p)", engine);
  37 }
  38
  39 CarlaEngineRunner::~CarlaEngineRunner() noexcept
  40 {
  41     carla_debug("CarlaEngineRunner::~CarlaEngineRunner()");
  42 }
  43
  44 void CarlaEngineRunner::start()
  45 {
  46     carla_debug("CarlaEngineRunner::start()");
  47     if (isRunnerActive())
  48         stopRunner();
  49
  50     fEngineHasIdleOnMainThread = kEngine->hasIdleOnMainThread();
  51     fIsPlugin = kEngine->getType() == kEngineTypePlugin;
  52     fIsAlwaysRunning = kEngine->getType() == kEngineTypeBridge || fIsPlugin;
  53
  54     startRunner(25);
  55 }
  56
  57 void CarlaEngineRunner::stop()
  58 {
  59     carla_debug("CarlaEngineRunner::stop()");
  60     stopRunner();
  61 }
  62
  63 // -----------------------------------------------------------------------
  64
  65 bool CarlaEngineRunner::run() noexcept
  66 {
  67     CARLA_SAFE_ASSERT_RETURN(kEngine != nullptr, false);
  68
  69     float value;
  70
  71 #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  72     // int64_t lastPingTime = 0;
  73     const CarlaEngineOsc& engineOsc(kEngine->pData->osc);
  74 #endif
  75
  76     // runner must do something...
  77     CARLA_SAFE_ASSERT_RETURN(fIsAlwaysRunning || kEngine->isRunning(), false);
  78
  79 #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
  80     const bool oscRegistedForUDP = engineOsc.isControlRegisteredForUDP();
  81 #else
  82     const bool oscRegistedForUDP = false;
  83 #endif
  84
  85 #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
  86     if (fIsPlugin)
  87         engineOsc.idle();
  88 #endif
  89
  90     for (uint i=0, count = kEngine->getCurrentPluginCount(); i < count; ++i)
  91     {
  92         const CarlaPluginPtr plugin = kEngine->getPluginUnchecked(i);
  93
  94         CARLA_SAFE_ASSERT_CONTINUE(plugin.get() != nullptr && plugin->isEnabled());
  95         CARLA_SAFE_ASSERT_UINT2(i == plugin->getId(), i, plugin->getId());
  96
  97         const uint hints = plugin->getHints();
  98         const bool useIdle = (hints & PLUGIN_NEEDS_MAIN_THREAD_IDLE) == 0 || !fEngineHasIdleOnMainThread;
  99         const bool updateUI = (hints & PLUGIN_HAS_CUSTOM_UI) != 0 && (hints & PLUGIN_NEEDS_UI_MAIN_THREAD) == 0;
 100
 101         // -----------------------------------------------------------
 102         // DSP Idle
 103
 104         if (useIdle)
 105         {
 106             try {
 107                 plugin->idle();
 108             } CARLA_SAFE_EXCEPTION("idle()")
 109         }
 110
 111         // -----------------------------------------------------------
 112         // Post-poned events
 113
 114         if (oscRegistedForUDP || updateUI)
 115         {
 116             // -------------------------------------------------------
 117             // Update parameter outputs
 118
 119             for (uint32_t j=0, pcount=plugin->getParameterCount(); j < pcount; ++j)
 120             {
 121                 if (! plugin->isParameterOutput(j))
 122                     continue;
 123
 124                 value = plugin->getParameterValue(j);
 125
 126 #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
 127                 // Update OSC engine client
 128                 if (oscRegistedForUDP)
 129                     engineOsc.sendParameterValue(i, j, value);
 130 #endif
 131                 // Update UI
 132                 if (updateUI)
 133                     plugin->uiParameterChange(j, value);
 134             }
 135
 136             if (updateUI)
 137             {
 138                 try {
 139                     plugin->uiIdle();
 140                 } CARLA_SAFE_EXCEPTION("uiIdle()")
 141             }
 142         }
 143
 144 #if defined(HAVE_LIBLO) && ! defined(BUILD_BRIDGE)
 145         // -----------------------------------------------------------
 146         // Update OSC control client peaks
 147
 148         if (oscRegistedForUDP)
 149             engineOsc.sendPeaks(i, kEngine->getPeaks(i));
 150 #endif
 151     }
 152
 153 #if defined(HAVE_LIBLO) && !defined(BUILD_BRIDGE)
 154     if (oscRegistedForUDP)
 155         engineOsc.sendRuntimeInfo();
 156
 157     /*
 158     if (engineOsc.isControlRegisteredForTCP())
 159     {
 160         const int64_t timeNow = water::Time::currentTimeMillis();
 161
 162         if (timeNow - lastPingTime > 1000)
 163         {
 164             engineOsc.sendPing();
 165             lastPingTime = timeNow;
 166         }
 167     }
 168     */
 169 #endif
 170
 171     return true;
 172 }
 173
 174 // -----------------------------------------------------------------------
 175
 176 CARLA_BACKEND_END_NAMESPACE