source/bridges-ui/CarlaBridgeToolkitNative.cpp

   1 /*
   2  * Carla Bridge UI
   3  * Copyright (C) 2014-2023 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 "CarlaBridgeFormat.hpp"
  19 #include "CarlaBridgeToolkit.hpp"
  20
  21 #include "CarlaMainLoop.hpp"
  22 #include "CarlaPluginUI.hpp"
  23 #include "CarlaTimeUtils.hpp"
  24 #include "CarlaUtils.h"
  25
  26 #if defined(CARLA_OS_MAC) && defined(BRIDGE_COCOA)
  27 # include "CarlaMacUtils.hpp"
  28 #endif
  29
  30 #if defined(HAVE_X11) && defined(BRIDGE_X11)
  31 # include <X11/Xlib.h>
  32 #endif
  33
  34 CARLA_BRIDGE_UI_START_NAMESPACE
  35
  36 using CARLA_BACKEND_NAMESPACE::runMainLoopOnce;
  37
  38 // -------------------------------------------------------------------------
  39
  40 class CarlaBridgeToolkitNative : public CarlaBridgeToolkit,
  41                                  private CarlaPluginUI::Callback
  42 {
  43 public:
  44     CarlaBridgeToolkitNative(CarlaBridgeFormat* const format)
  45         : CarlaBridgeToolkit(format),
  46           fHostUI(nullptr),
  47           fIdling(false)
  48     {
  49         carla_debug("CarlaBridgeToolkitNative::CarlaBridgeToolkitNative(%p)", format);
  50     }
  51
  52     ~CarlaBridgeToolkitNative() override
  53     {
  54         CARLA_SAFE_ASSERT_RETURN(fHostUI == nullptr,);
  55         carla_debug("CarlaBridgeToolkitNative::~CarlaBridgeToolkitNative()");
  56     }
  57
  58     bool init(const int /*argc*/, const char** /*argv[]*/) override
  59     {
  60         CARLA_SAFE_ASSERT_RETURN(fHostUI == nullptr, false);
  61         carla_debug("CarlaBridgeToolkitNative::init()");
  62
  63         const CarlaBridgeFormat::Options& options(fPlugin->getOptions());
  64
  65 #if defined(CARLA_OS_MAC) && defined(BRIDGE_COCOA)
  66         CARLA_BACKEND_NAMESPACE::initStandaloneApplication();
  67         fHostUI = CarlaPluginUI::newCocoa(this, 0, options.isStandalone, options.isResizable);
  68 #elif defined(CARLA_OS_WIN) && defined(BRIDGE_HWND)
  69         fHostUI = CarlaPluginUI::newWindows(this, 0, options.isStandalone, options.isResizable);
  70 #elif defined(HAVE_X11) && defined(BRIDGE_X11)
  71         XInitThreads();
  72         fHostUI = CarlaPluginUI::newX11(this, 0, options.isStandalone, options.isResizable, true);
  73 #endif
  74         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr, false);
  75
  76 #ifndef CARLA_OS_MAC
  77         if (options.isStandalone)
  78             fPlugin->setScaleFactor(carla_get_desktop_scale_factor());
  79 #endif
  80
  81         fHostUI->setTitle(options.windowTitle.buffer());
  82
  83 #ifndef CARLA_OS_MAC
  84         if (options.transientWindowId != 0)
  85         {
  86             fHostUI->setTransientWinId(options.transientWindowId);
  87         }
  88         else if (const char* const winIdStr = std::getenv("ENGINE_OPTION_FRONTEND_WIN_ID"))
  89         {
  90             if (const long long winId = std::strtoll(winIdStr, nullptr, 16))
  91                 fHostUI->setTransientWinId(static_cast<uintptr_t>(winId));
  92         }
  93 #endif
  94
  95         return true;
  96     }
  97
  98     void exec(const bool showUI) override
  99     {
 100         CARLA_SAFE_ASSERT_RETURN(fPlugin != nullptr,);
 101         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr,);
 102         carla_debug("CarlaBridgeToolkitNative::exec(%s)", bool2str(showUI));
 103
 104         if (showUI)
 105         {
 106             fHostUI->show();
 107             fHostUI->focus();
 108         }
 109
 110         fIdling = true;
 111
 112         for (; runMainLoopOnce() && fIdling;)
 113         {
 114             if (fPlugin->isPipeRunning())
 115                 fPlugin->idlePipe();
 116
 117             fPlugin->idleUI();
 118             fHostUI->idle();
 119 #if defined(CARLA_OS_MAC) || defined(CARLA_OS_WIN)
 120             // MacOS and Win32 have event-loops to run, so minimize sleep time
 121             carla_msleep(1);
 122 #else
 123             carla_msleep(33);
 124 #endif
 125         }
 126     }
 127
 128     void quit() override
 129     {
 130         carla_debug("CarlaBridgeToolkitNative::quit()");
 131
 132         fIdling = false;
 133
 134         if (fHostUI != nullptr)
 135         {
 136             fHostUI->hide();
 137             delete fHostUI;
 138             fHostUI = nullptr;
 139         }
 140     }
 141
 142     void show() override
 143     {
 144         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr,);
 145         carla_debug("CarlaBridgeToolkitNative::show()");
 146
 147         fHostUI->show();
 148     }
 149
 150     void focus() override
 151     {
 152         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr,);
 153         carla_debug("CarlaBridgeToolkitNative::focus()");
 154
 155         fHostUI->focus();
 156     }
 157
 158     void hide() override
 159     {
 160         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr,);
 161         carla_debug("CarlaBridgeToolkitNative::hide()");
 162
 163         fHostUI->hide();
 164     }
 165
 166     void setChildWindow(void* const ptr) override
 167     {
 168         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr,);
 169         CARLA_SAFE_ASSERT_RETURN(ptr != nullptr,);
 170         carla_debug("CarlaBridgeToolkitNative::setChildWindow(%p)", ptr);
 171
 172         fHostUI->setChildWindow(ptr);
 173     }
 174
 175     void setSize(const uint width, const uint height) override
 176     {
 177         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr,);
 178         CARLA_SAFE_ASSERT_RETURN(width > 0,);
 179         CARLA_SAFE_ASSERT_RETURN(height > 0,);
 180         carla_debug("CarlaBridgeToolkitNative::resize(%i, %i)", width, height);
 181
 182         fHostUI->setSize(width, height, false, false);
 183     }
 184
 185     void setTitle(const char* const title) override
 186     {
 187         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr,);
 188         carla_debug("CarlaBridgeToolkitNative::setTitle(\"%s\")", title);
 189
 190         fHostUI->setTitle(title);
 191     }
 192
 193     void* getContainerId() const override
 194     {
 195         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr, nullptr);
 196
 197         return fHostUI->getPtr();
 198     }
 199
 200 #ifdef HAVE_X11
 201     void* getContainerId2() const override
 202     {
 203         CARLA_SAFE_ASSERT_RETURN(fHostUI != nullptr, nullptr);
 204
 205         return fHostUI->getDisplay();
 206     }
 207 #endif
 208
 209     // ---------------------------------------------------------------------
 210
 211 protected:
 212     void handlePluginUIClosed() override
 213     {
 214         fIdling = false;
 215     }
 216
 217     void handlePluginUIResized(const uint width, const uint height) override
 218     {
 219         fPlugin->uiResized(width, height);
 220     }
 221
 222     // ---------------------------------------------------------------------
 223
 224 private:
 225     CarlaPluginUI* fHostUI;
 226     bool fIdling;
 227
 228     CARLA_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(CarlaBridgeToolkitNative)
 229 };
 230
 231 // -------------------------------------------------------------------------
 232
 233 CarlaBridgeToolkit* CarlaBridgeToolkit::createNew(CarlaBridgeFormat* const format)
 234 {
 235     return new CarlaBridgeToolkitNative(format);
 236 }
 237
 238 // -------------------------------------------------------------------------
 239
 240 CARLA_BRIDGE_UI_END_NAMESPACE
 241
 242 #define CARLA_PLUGIN_UI_CLASS_PREFIX ToolkitNative
 243 #include "CarlaPluginUI.cpp"
 244 #include "utils/Windows.cpp"
 245
 246 // -------------------------------------------------------------------------