DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
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.
1762 Commits
7 Branches
91MB
Tree: 4f3d99304f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4f3d99304f'
${ noResults }
DPF/distrho/src/DistrhoUI.cpp

421 lines
13KB
Raw Blame History 

  1. /*

  2.  * DISTRHO Plugin Framework (DPF)

  3.  * Copyright (C) 2012-2022 Filipe Coelho <falktx@falktx.com>

  4.  *

  5.  * Permission to use, copy, modify, and/or distribute this software for any purpose with

  6.  * or without fee is hereby granted, provided that the above copyright notice and this

  7.  * permission notice appear in all copies.

  8.  *

  9.  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD

  10.  * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN

  11.  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL

  12.  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER

  13.  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN

  14.  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

  15.  */

  16. 

  17. #include "src/DistrhoPluginChecks.h"

  18. #include "src/DistrhoDefines.h"

  19. 

  20. #if !defined(DGL_FILE_BROWSER_DISABLED) && !defined(DISTRHO_UI_FILE_BROWSER) && !defined(DISTRHO_OS_MAC)

  21. # define DISTRHO_PUGL_NAMESPACE_MACRO_HELPER(NS, SEP, FUNCTION) NS ## SEP ## FUNCTION

  22. # define DISTRHO_PUGL_NAMESPACE_MACRO(NS, FUNCTION) DISTRHO_PUGL_NAMESPACE_MACRO_HELPER(NS, _, FUNCTION)

  23. # define DISTRHO_FILE_BROWSER_DIALOG_EXTRA_NAMESPACE Plugin

  24. # define x_fib_add_recent          DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_add_recent)

  25. # define x_fib_cfg_buttons         DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_cfg_buttons)

  26. # define x_fib_cfg_filter_callback DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_cfg_filter_callback)

  27. # define x_fib_close               DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_close)

  28. # define x_fib_configure           DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_configure)

  29. # define x_fib_filename            DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_filename)

  30. # define x_fib_free_recent         DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_free_recent)

  31. # define x_fib_handle_events       DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_handle_events)

  32. # define x_fib_load_recent         DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_load_recent)

  33. # define x_fib_recent_at           DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_recent_at)

  34. # define x_fib_recent_count        DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_recent_count)

  35. # define x_fib_recent_file         DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_recent_file)

  36. # define x_fib_save_recent         DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_save_recent)

  37. # define x_fib_show                DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_show)

  38. # define x_fib_status              DISTRHO_PUGL_NAMESPACE_MACRO(Plugin, x_fib_status)

  39. # include "../extra/FileBrowserDialog.cpp"

  40. #endif

  41. 

  42. #if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  43. # if defined(DISTRHO_OS_WINDOWS)

  44. #  include <winsock2.h>

  45. #  include <windows.h>

  46. # elif defined(HAVE_X11)

  47. #  include <X11/Xresource.h>

  48. # endif

  49. #else

  50. # include "src/TopLevelWidgetPrivateData.hpp"

  51. # include "src/WindowPrivateData.hpp"

  52. #endif

  53. 

  54. #include "DistrhoUIPrivateData.hpp"

  55. 

  56. START_NAMESPACE_DISTRHO

  57. 

  58. /* ------------------------------------------------------------------------------------------------------------

  59.  * Static data, see DistrhoUIInternal.hpp */

  60. 

  61. const char* g_nextBundlePath  = nullptr;

  62. #if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  63. uintptr_t   g_nextWindowId    = 0;

  64. double      g_nextScaleFactor = 1.0;

  65. #endif

  66. 

  67. #if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  68. /* ------------------------------------------------------------------------------------------------------------

  69.  * get global scale factor */

  70. 

  71. #ifdef DISTRHO_OS_MAC

  72. double getDesktopScaleFactor(uintptr_t parentWindowHandle);

  73. #else

  74. static double getDesktopScaleFactor(const uintptr_t parentWindowHandle)

  75. {

  76.     // allow custom scale for testing

  77.     if (const char* const scale = getenv("DPF_SCALE_FACTOR"))

  78.         return std::max(1.0, std::atof(scale));

  79. 

  80. #if defined(DISTRHO_OS_WINDOWS)

  81.     if (const HMODULE Shcore = LoadLibraryA("Shcore.dll"))

  82.     {

  83.         typedef HRESULT(WINAPI* PFN_GetProcessDpiAwareness)(HANDLE, DWORD*);

  84.         typedef HRESULT(WINAPI* PFN_GetScaleFactorForMonitor)(HMONITOR, DWORD*);

  85. 

  86. # if defined(__GNUC__) && (__GNUC__ >= 9)

  87. #  pragma GCC diagnostic push

  88. #  pragma GCC diagnostic ignored "-Wcast-function-type"

  89. # endif

  90.         const PFN_GetProcessDpiAwareness GetProcessDpiAwareness

  91.             = (PFN_GetProcessDpiAwareness)GetProcAddress(Shcore, "GetProcessDpiAwareness");

  92.         const PFN_GetScaleFactorForMonitor GetScaleFactorForMonitor

  93.             = (PFN_GetScaleFactorForMonitor)GetProcAddress(Shcore, "GetScaleFactorForMonitor");

  94. # if defined(__GNUC__) && (__GNUC__ >= 9)

  95. #  pragma GCC diagnostic pop

  96. # endif

  97. 

  98.         DWORD dpiAware = 0;

  99.         if (GetProcessDpiAwareness && GetScaleFactorForMonitor

  100.             && GetProcessDpiAwareness(NULL, &dpiAware) == 0 && dpiAware != 0)

  101.         {

  102.             const HMONITOR hMon = parentWindowHandle != 0

  103.                                 ? MonitorFromWindow((HWND)parentWindowHandle, MONITOR_DEFAULTTOPRIMARY)

  104.                                 : MonitorFromPoint(POINT{0,0}, MONITOR_DEFAULTTOPRIMARY);

  105. 

  106.             DWORD scaleFactor = 0;

  107.             if (GetScaleFactorForMonitor(hMon, &scaleFactor) == 0 && scaleFactor != 0)

  108.             {

  109.                 FreeLibrary(Shcore);

  110.                 return static_cast<double>(scaleFactor) / 100.0;

  111.             }

  112.         }

  113. 

  114.         FreeLibrary(Shcore);

  115.     }

  116. #elif defined(HAVE_X11)

  117.     ::Display* const display = XOpenDisplay(nullptr);

  118.     DISTRHO_SAFE_ASSERT_RETURN(display != nullptr, 1.0);

  119. 

  120.     XrmInitialize();

  121. 

  122.     if (char* const rms = XResourceManagerString(display))

  123.     {

  124.         if (const XrmDatabase sdb = XrmGetStringDatabase(rms))

  125.         {

  126.             char* type = nullptr;

  127.             XrmValue ret;

  128. 

  129.             if (XrmGetResource(sdb, "Xft.dpi", "String", &type, &ret)

  130.                 && ret.addr != nullptr

  131.                 && type != nullptr

  132.                 && std::strncmp("String", type, 6) == 0)

  133.             {

  134.                 if (const double dpi = std::atof(ret.addr))

  135.                 {

  136.                     XCloseDisplay(display);

  137.                     return dpi / 96;

  138.                 }

  139.             }

  140.         }

  141.     }

  142. 

  143.     XCloseDisplay(display);

  144. #endif

  145. 

  146.     return 1.0;

  147. 

  148.     // might be unused

  149.     (void)parentWindowHandle;

  150. }

  151. #endif // !DISTRHO_OS_MAC

  152. 

  153. #endif

  154. 

  155. /* ------------------------------------------------------------------------------------------------------------

  156.  * UI::PrivateData special handling */

  157. 

  158. UI::PrivateData* UI::PrivateData::s_nextPrivateData = nullptr;

  159. 

  160. #if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  161. ExternalWindow::PrivateData

  162. #else

  163. PluginWindow&

  164. #endif

  165. UI::PrivateData::createNextWindow(UI* const ui, const uint width, const uint height)

  166. {

  167.     UI::PrivateData* const pData = s_nextPrivateData;

  168. #if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  169.     pData->window = new PluginWindow(ui, pData->app);

  170.     ExternalWindow::PrivateData ewData;

  171.     ewData.parentWindowHandle = pData->winId;

  172.     ewData.width = width;

  173.     ewData.height = height;

  174.     ewData.scaleFactor = pData->scaleFactor != 0.0 ? pData->scaleFactor : getDesktopScaleFactor(pData->winId);

  175.     ewData.title = DISTRHO_PLUGIN_NAME;

  176.     ewData.isStandalone = DISTRHO_UI_IS_STANDALONE;

  177.     return ewData;

  178. #else

  179.     pData->window = new PluginWindow(ui, pData->app, pData->winId, width, height, pData->scaleFactor);

  180. 

  181.     // If there are no callbacks, this is most likely a temporary window, so ignore idle callbacks

  182.     if (pData->callbacksPtr == nullptr)

  183.         pData->window->setIgnoreIdleCallbacks();

  184. 

  185.     return pData->window.getObject();

  186. #endif

  187. }

  188. 

  189. /* ------------------------------------------------------------------------------------------------------------

  190.  * UI */

  191. 

  192. UI::UI(const uint width, const uint height, const bool automaticallyScaleAndSetAsMinimumSize)

  193.     : UIWidget(UI::PrivateData::createNextWindow(this, width, height)),

  194.       uiData(UI::PrivateData::s_nextPrivateData)

  195. {

  196. #if !DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  197.     if (width != 0 && height != 0)

  198.     {

  199.         Widget::setSize(width, height);

  200. 

  201.         if (automaticallyScaleAndSetAsMinimumSize)

  202.             setGeometryConstraints(width, height, true, true, true);

  203.     }

  204. #else

  205.     // unused

  206.     (void)automaticallyScaleAndSetAsMinimumSize;

  207. #endif

  208. }

  209. 

  210. UI::~UI()

  211. {

  212. }

  213. 

  214. /* ------------------------------------------------------------------------------------------------------------

  215.  * Host state */

  216. 

  217. bool UI::isResizable() const noexcept

  218. {

  219. #if DISTRHO_UI_USER_RESIZABLE

  220. # if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  221.     return true;

  222. # else

  223.     return uiData->window->isResizable();

  224. # endif

  225. #else

  226.     return false;

  227. #endif

  228. }

  229. 

  230. uint UI::getBackgroundColor() const noexcept

  231. {

  232.     return uiData->bgColor;

  233. }

  234. 

  235. uint UI::getForegroundColor() const noexcept

  236. {

  237.     return uiData->fgColor;

  238. }

  239. 

  240. double UI::getSampleRate() const noexcept

  241. {

  242.     return uiData->sampleRate;

  243. }

  244. 

  245. const char* UI::getBundlePath() const noexcept

  246. {

  247.     return uiData->bundlePath;

  248. }

  249. 

  250. void UI::editParameter(uint32_t index, bool started)

  251. {

  252.     uiData->editParamCallback(index + uiData->parameterOffset, started);

  253. }

  254. 

  255. void UI::setParameterValue(uint32_t index, float value)

  256. {

  257.     uiData->setParamCallback(index + uiData->parameterOffset, value);

  258. }

  259. 

  260. #if DISTRHO_PLUGIN_WANT_STATE

  261. void UI::setState(const char* key, const char* value)

  262. {

  263.     uiData->setStateCallback(key, value);

  264. }

  265. #endif

  266. 

  267. #if DISTRHO_PLUGIN_WANT_STATE

  268. bool UI::requestStateFile(const char* key)

  269. {

  270.     return uiData->fileRequestCallback(key);

  271. }

  272. #endif

  273. 

  274. #if DISTRHO_PLUGIN_WANT_MIDI_INPUT

  275. void UI::sendNote(uint8_t channel, uint8_t note, uint8_t velocity)

  276. {

  277.     uiData->sendNoteCallback(channel, note, velocity);

  278. }

  279. #endif

  280. 

  281. #ifndef DGL_FILE_BROWSER_DISABLED

  282. bool UI::openFileBrowser(const FileBrowserOptions& options)

  283. {

  284. # if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  285.     // TODO

  286.     return false;

  287.     (void)options;

  288. # else

  289.     return getWindow().openFileBrowser(options);

  290. # endif

  291. }

  292. #endif

  293. 

  294. #if DISTRHO_PLUGIN_WANT_DIRECT_ACCESS

  295. /* ------------------------------------------------------------------------------------------------------------

  296.  * Direct DSP access */

  297. 

  298. void* UI::getPluginInstancePointer() const noexcept

  299. {

  300.     return uiData->dspPtr;

  301. }

  302. #endif

  303. 

  304. #if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  305. /* ------------------------------------------------------------------------------------------------------------

  306.  * External UI helpers (static calls) */

  307. 

  308. const char* UI::getNextBundlePath() noexcept

  309. {

  310.     return g_nextBundlePath;

  311. }

  312. 

  313. double UI::getNextScaleFactor() noexcept

  314. {

  315.     return g_nextScaleFactor;

  316. }

  317. 

  318. # if DISTRHO_PLUGIN_HAS_EMBED_UI

  319. uintptr_t UI::getNextWindowId() noexcept

  320. {

  321.     return g_nextWindowId;

  322. }

  323. # endif

  324. #endif // DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  325. 

  326. /* ------------------------------------------------------------------------------------------------------------

  327.  * DSP/Plugin Callbacks (optional) */

  328. 

  329. void UI::sampleRateChanged(double)

  330. {

  331. }

  332. 

  333. /* ------------------------------------------------------------------------------------------------------------

  334.  * UI Callbacks (optional) */

  335. 

  336. void UI::uiScaleFactorChanged(double)

  337. {

  338. }

  339. 

  340. #if !DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  341. std::vector<DGL_NAMESPACE::ClipboardDataOffer> UI::getClipboardDataOfferTypes()

  342. {

  343.     return uiData->window->getClipboardDataOfferTypes();

  344. }

  345. 

  346. uint32_t UI::uiClipboardDataOffer()

  347. {

  348.     std::vector<DGL_NAMESPACE::ClipboardDataOffer> offers(uiData->window->getClipboardDataOfferTypes());

  349. 

  350.     for (std::vector<DGL_NAMESPACE::ClipboardDataOffer>::iterator it=offers.begin(), end=offers.end(); it != end;++it)

  351.     {

  352.         const DGL_NAMESPACE::ClipboardDataOffer offer = *it;

  353.         if (std::strcmp(offer.type, "text/plain") == 0)

  354.             return offer.id;

  355.     }

  356. 

  357.     return 0;

  358. }

  359. 

  360. void UI::uiFocus(bool, DGL_NAMESPACE::CrossingMode)

  361. {

  362. }

  363. 

  364. void UI::uiReshape(uint, uint)

  365. {

  366.     // NOTE this must be the same as Window::onReshape

  367.     pData->fallbackOnResize();

  368. }

  369. #endif // !DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  370. 

  371. #ifndef DGL_FILE_BROWSER_DISABLED

  372. void UI::uiFileBrowserSelected(const char*)

  373. {

  374. }

  375. #endif

  376. 

  377. /* ------------------------------------------------------------------------------------------------------------

  378.  * UI Resize Handling, internal */

  379. 

  380. #if DISTRHO_PLUGIN_HAS_EXTERNAL_UI

  381. void UI::sizeChanged(const uint width, const uint height)

  382. {

  383.     UIWidget::sizeChanged(width, height);

  384. 

  385.     uiData->setSizeCallback(width, height);

  386. }

  387. #else

  388. void UI::onResize(const ResizeEvent& ev)

  389. {

  390.     UIWidget::onResize(ev);

  391. 

  392. #ifndef DISTRHO_PLUGIN_TARGET_VST3

  393.     if (uiData->initializing)

  394.         return;

  395. 

  396.     const uint width = ev.size.getWidth();

  397.     const uint height = ev.size.getHeight();

  398.     uiData->setSizeCallback(width, height);

  399. #endif

  400. }

  401. 

  402. // NOTE: only used for VST3

  403. void UI::requestSizeChange(const uint width, const uint height)

  404. {

  405. # ifdef DISTRHO_PLUGIN_TARGET_VST3

  406.     if (uiData->initializing)

  407.         uiData->window->setSizeForVST3(width, height);

  408.     else

  409.         uiData->setSizeCallback(width, height);

  410. # else

  411.     // unused

  412.     (void)width;

  413.     (void)height;

  414. # endif

  415. }

  416. #endif

  417. 

  418. // -----------------------------------------------------------------------------------------------------------

  419. 

  420. END_NAMESPACE_DISTRHO