LV2Validator.cpp

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  @file LV2Validator.cpp
 
  Paul Licameli split from LV2Effect.cpp
 
  Audacity(R) is copyright (c) 1999-2008 Audacity Team.
  License: GPL v2 or later.  See License.txt.
 
**********************************************************************/
 
#if defined(USE_LV2)
 
#if defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wparentheses"
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#elif defined(__clang__)
#pragma clang diagnostic ignored "-Wparentheses"
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
#endif
 
#include "LV2Validator.h"
#include "effects/EffectBase.h"
#include "LV2EffectMeter.h"
#include "LV2Instance.h"
#include "LV2Wrapper.h"
 
#include "ShuttleGui.h"
 
#include <wx/button.h>
#include <wx/checkbox.h>
#include <wx/choice.h>
 
#include <wx/sizer.h>
 
#include <wx/stattext.h>
#include <wx/textctrl.h>
 
#include <wx/scrolwin.h>
 
#include "../../widgets/valnum.h"
 
#include "../../widgets/NumericTextCtrl.h"
 
#if defined(__WXGTK__)
#include <gtk/gtk.h>
#endif
 
void LV2Validator::UI::Destroy()
{
#ifdef __WXMAC__
   // Issue 3222: x42-limiter does an unbalanced release somewhere, requiring
   // the host to add an extra reference.  But other plug-ins don't expect
   // that.
   // This is how we can accommodate them either way.
 
   const auto widget = (mNativeWin && mSuilInstance)
      ? static_cast<WXWidget>(suil_instance_get_widget(mSuilInstance.get()))
      : nullptr;
   if (widget) {
      if (!mJustLeakMemory) {
         // Bump reference count twice
         wxCFRetain(widget);
         wxCFRetain(widget);
      }
      else {
         // Compensates for either an unbalanced release, or (when closing the
         // project while the dialog is open) dangling pointers remaining after
         // the last release, by adding one release.  In the second case, it
         // leaks resources.
         // (We can't detect here, which of the two cases applies.)
         wxCFRetain(widget);
      }
 
      // Do destruction of mNativeWin, which points to widget, and the suil
      // instance in the scope of an autorelease pool
      {
         wxMacAutoreleasePool pool;
         mNativeWin = nullptr;
         mSuilInstance.reset();
         // Deferred releases are forced to happen here, not later up the stack
         // in the enclosing wxMacAutoreleasePool given by wxWidgets
      }
 
      // Two increases of the reference count means there can be one unbalanced
      // release and yet we can still query the use-count safely
      if (!mJustLeakMemory) {
         int count = CFGetRetainCount(widget);
         wxCFRelease(widget);
         if (count > 1)
            // Most plug-ins should come here, but x42-limiter will not!
            wxCFRelease(widget);
      }
   }
#else
   mNativeWin = nullptr;
#endif
}
 
LV2Validator::LV2Validator(EffectBase &effect,
   const LilvPlugin &plug, LV2Instance &instance,
   EffectSettingsAccess &access, const EffectOutputs *pOutputs,
   double sampleRate,
   const LV2FeaturesList &features,
   const LV2Ports &ports, wxWindow *parent, bool useGUI
)  : EffectUIValidator{ effect, access }
   , mPlug{ plug }
   , mType{ effect.GetType() }
   , mInstance{ instance }
   , mpOutputs{ pOutputs }
   , mSampleRate{ sampleRate }
   , mPorts{ ports }
   , mPortUIStates{ instance.GetPortStates(), ports }
   , mParent{ parent }
   , mUseGUI{ useGUI }
{
   if (mParent)
      mParent->PushEventHandler(this);
}
 
enum
{
   ID_Duration = 10000,
   ID_Triggers = 11000,
   ID_Toggles = 12000,
   ID_Sliders = 13000,
   ID_Choices = 14000,
   ID_Texts = 15000,
};
 
BEGIN_EVENT_TABLE(LV2Validator, wxEvtHandler)
   EVT_COMMAND_RANGE(ID_Triggers, ID_Triggers + 999, wxEVT_COMMAND_BUTTON_CLICKED, LV2Validator::OnTrigger)
   EVT_COMMAND_RANGE(ID_Toggles, ID_Toggles + 999, wxEVT_COMMAND_CHECKBOX_CLICKED, LV2Validator::OnToggle)
   EVT_COMMAND_RANGE(ID_Sliders, ID_Sliders + 999, wxEVT_COMMAND_SLIDER_UPDATED, LV2Validator::OnSlider)
   EVT_COMMAND_RANGE(ID_Choices, ID_Choices + 999, wxEVT_COMMAND_CHOICE_SELECTED, LV2Validator::OnChoice)
   EVT_COMMAND_RANGE(ID_Texts, ID_Texts + 999, wxEVT_COMMAND_TEXT_UPDATED, LV2Validator::OnText)
 
   EVT_IDLE(LV2Validator::OnIdle)
END_EVENT_TABLE()
 
bool LV2Validator::IsGraphicalUI()
{
   return mUseGUI;
}
 
bool LV2Validator::ValidateUI()
{
   mAccess.ModifySettings([&](EffectSettings &settings){
      if (mType == EffectTypeGenerate)
         settings.extra.SetDuration(mDuration->GetValue());
      return nullptr;
   });
   return true;
}
 
void LV2Validator::Disconnect()
{
   // Disconnect the plain UI output meters
   if (!mPlainUIControls.empty()) {
      size_t p = 0;
      for (auto &port : mPorts.mControlPorts) {
         if (!port->mIsInput)
            if (auto &pMeter = mPlainUIControls[p].meter) {
               pMeter->Disconnect();
               pMeter = nullptr;
            }
         ++p;
      }
   }
   // The idle event handler for the fancy UI output must disconnect too
   mpOutputs = nullptr;
   if (mParent) {
      mParent->PopEventHandler();
      mParent = nullptr;
   }
   mUI.Destroy();
}
 
LV2Validator::~LV2Validator()
{
   Disconnect();
}
 
std::shared_ptr<SuilHost> LV2Validator::GetSuilHost()
{
   // This is a unique_ptr specialization
   using SuilHostPtr = Lilv_ptr<SuilHost, suil_host_free>;
   // The host has no dependency on the plug-in and can be shared among
   // validators
   static std::weak_ptr<SuilHost> sSuilHost;
   std::shared_ptr<SuilHost> result = sSuilHost.lock();
   if (!result)
      // shared_ptr erases type of custom deleter of SuilHostPtr
      sSuilHost = result = SuilHostPtr{ suil_host_new(
         LV2UIFeaturesList::suil_port_write,
         LV2UIFeaturesList::suil_port_index, nullptr, nullptr) };
   return result;
}
 
bool LV2Validator::BuildFancy(
   std::unique_ptr<LV2Wrapper> pWrapper, const EffectSettings &settings)
{
   assert(pWrapper);
   auto &wrapper = *pWrapper;
   mpWrapper = move(pWrapper);
   using namespace LV2Symbols;
   // Set the native UI type
   const char *nativeType =
#if defined(__WXGTK3__)
      LV2_UI__Gtk3UI;
#elif defined(__WXGTK__)
      LV2_UI__GtkUI;
#elif defined(__WXMSW__)
      LV2_UI__WindowsUI;
#elif defined(__WXMAC__)
      LV2_UI__CocoaUI;
#endif
 
   // Determine if the plugin has a supported UI
   const LilvUI *ui = nullptr;
   const LilvNode *uiType = nullptr;
   using LilvUIsPtr = Lilv_ptr<LilvUIs, lilv_uis_free>;
   LilvUIsPtr uis{ lilv_plugin_get_uis(&mPlug) };
   if (uis) {
      if (LilvNodePtr containerType{ lilv_new_uri(gWorld, nativeType) }) {
         LILV_FOREACH(uis, iter, uis.get()) {
            ui = lilv_uis_get(uis.get(), iter);
            if (lilv_ui_is_supported(ui,
               suil_ui_supported, containerType.get(), &uiType))
               break;
            if (lilv_ui_is_a(ui, node_Gtk) || lilv_ui_is_a(ui, node_Gtk3)) {
               uiType = node_Gtk;
               break;
            }
            ui = nullptr;
         }
      }
   }
 
   // Check for other supported UIs
   if (!ui && uis) {
      LILV_FOREACH(uis, iter, uis.get()) {
         ui = lilv_uis_get(uis.get(), iter);
         if (lilv_ui_is_a(ui, node_ExternalUI) || lilv_ui_is_a(ui, node_ExternalUIOld)) {
            uiType = node_ExternalUI;
            break;
         }
         ui = NULL;
      }
   }
 
   // No usable UI found
   if (ui == NULL)
      return false;
 
   const auto uinode = lilv_ui_get_uri(ui);
   lilv_world_load_resource(gWorld, uinode);
   LV2UIFeaturesList::UIHandler &handler = *this;
   auto &instance = wrapper.GetInstance();
   auto &features = mUIFeatures.emplace(
      wrapper.GetFeatures(), &handler, uinode, &instance,
      (uiType == node_ExternalUI) ? nullptr : mParent);
   if (!features.mOk)
      return false;
 
   const char *containerType;
   if (uiType == node_ExternalUI)
      containerType = LV2_EXTERNAL_UI__Widget;
   else {
      containerType = nativeType;
#if defined(__WXGTK__)
      // Make sure the parent has a window
      if (!gtk_widget_get_window(GTK_WIDGET(mParent->m_wxwindow)))
         gtk_widget_realize(GTK_WIDGET(mParent->m_wxwindow));
#endif
   }
 
   // Set before creating the UI instance so the initial size (if any) can be captured
   mNativeWinInitialSize = wxDefaultSize;
   mNativeWinLastSize = wxDefaultSize;
 
   // Create the suil host
   if (!(mSuilHost = GetSuilHost()))
      return false;
 
#if defined(__WXMSW__)
   // Plugins may have dependencies that need to be loaded from the same path
   // as the main DLL, so add this plugin's path to the DLL search order.
   LilvCharsPtr libPath{
      lilv_file_uri_parse(lilv_node_as_uri(lilv_ui_get_binary_uri(ui)),
      nullptr)
   };
   const auto path = wxPathOnly(libPath.get());
   SetDllDirectory(path.c_str());
   auto cleanup = finally([&]{ SetDllDirectory(nullptr); });
#endif
 
   LilvCharsPtr bundlePath{
      lilv_file_uri_parse(lilv_node_as_uri(lilv_ui_get_bundle_uri(ui)), nullptr)
   };
   LilvCharsPtr binaryPath{
      lilv_file_uri_parse(lilv_node_as_uri(lilv_ui_get_binary_uri(ui)), nullptr)
   };
 
   // The void* that the instance passes back to our write and index
   // callback functions, which were given to suil_host_new:
   UIHandler *pHandler = this;
 
   // Reassign the sample rate, which is pointed to by options, which are
   // pointed to by features, before we tell the library the features
   mUI.mSuilInstance.reset(suil_instance_new(mSuilHost.get(),
      pHandler, containerType,
      lilv_node_as_uri(lilv_plugin_get_uri(&mPlug)),
      lilv_node_as_uri(lilv_ui_get_uri(ui)), lilv_node_as_uri(uiType),
      bundlePath.get(), binaryPath.get(),
      features.GetFeaturePointers().data()));
 
   // Bail if the instance (no compatible UI) couldn't be created
   if (!mUI.mSuilInstance)
      return false;
 
   if (uiType == node_ExternalUI) {
      mParent->SetMinSize(wxDefaultSize);
      mTimer.mExternalWidget = static_cast<LV2_External_UI_Widget *>(
         suil_instance_get_widget(mUI.mSuilInstance.get()));
      mTimer.Start(20);
      LV2_EXTERNAL_UI_SHOW(mTimer.mExternalWidget);
   } else {
      const auto widget = static_cast<WXWidget>(
         suil_instance_get_widget(mUI.mSuilInstance.get()));
 
#if defined(__WXGTK__)
      // Needed by some plugins (e.g., Invada) to ensure the display is fully
      // populated.
      gtk_widget_show_all(widget);
 
      // See note at size_request()
      g_signal_connect(widget, "size-request", G_CALLBACK(LV2Validator::size_request), this);
#endif
 
      wxWindowPtr< NativeWindow > pNativeWin{ safenew NativeWindow() };
      if (!pNativeWin->Create(mParent, widget))
         return false;
      mUI.mNativeWin = pNativeWin;
      pNativeWin->Bind(wxEVT_SIZE, &LV2Validator::OnSize, this);
 
      // The plugin called the LV2UI_Resize::ui_resize function to set the size before
      // the native window was created, so set the size now.
      if (mNativeWinInitialSize != wxDefaultSize)
         pNativeWin->SetMinSize(mNativeWinInitialSize);
 
      wxSizerItem *si = NULL;
      auto vs = std::make_unique<wxBoxSizer>(wxVERTICAL);
      auto hs = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
      if (features.mNoResize) {
         si = hs->Add(pNativeWin.get(), 0, wxCENTER);
         vs->Add(hs.release(), 1, wxCENTER);
      } else {
         si = hs->Add(pNativeWin.get(), 1, wxEXPAND);
         vs->Add(hs.release(), 1, wxEXPAND);
      }
      if (!si)
         return false;
      mParent->SetSizerAndFit(vs.release());
   }
 
   mUIIdleInterface = static_cast<const LV2UI_Idle_Interface *>(
      suil_instance_extension_data(mUI.mSuilInstance.get(), LV2_UI__idleInterface));
 
   mUIShowInterface = static_cast<const LV2UI_Show_Interface *>(
      suil_instance_extension_data(mUI.mSuilInstance.get(), LV2_UI__showInterface));
 
//   if (mUIShowInterface && mUIShowInterface->show) {
//      mUIShowInterface->show(suil_instance_get_handle(mSuilInstance));
//   }
 
#ifdef __WXMAC__
#ifdef __WX_EVTLOOP_BUSY_WAITING__
   wxEventLoop::SetBusyWaiting(true);
#endif
#endif
 
   return true;
}
 
bool LV2Validator::BuildPlain(EffectSettingsAccess &access)
{
   auto &portUIStates = mPortUIStates;
   auto &settings = access.Get();
   auto &values = GetSettings(settings).values;
   mPlainUIControls.resize(mPorts.mControlPorts.size());
 
   int numCols = 5;
   wxSizer *innerSizer;
 
   assert(mParent); // To justify safenew
   const auto w = safenew wxScrolledWindow(mParent,
      wxID_ANY, wxDefaultPosition, wxDefaultSize, wxVSCROLL | wxTAB_TRAVERSAL);
 
   {
      auto outerSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
      w->SetScrollRate(0, 20);
      // This fools NVDA into not saying "Panel" when the dialog gets focus
      w->SetName(wxT("\a"));
      w->SetLabel(wxT("\a"));
      outerSizer->Add(w, 1, wxEXPAND);
 
      auto uInnerSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
      innerSizer = uInnerSizer.get();
 
      // Add the duration control, if a generator
      if (mType == EffectTypeGenerate) {
         auto sizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
         auto item = safenew wxStaticText(w, 0, _("&Duration:"));
         sizer->Add(item, 0, wxALIGN_CENTER | wxALL, 5);
         auto &extra = settings.extra;
         mDuration = safenew NumericTextCtrl(w, ID_Duration,
            NumericConverter::TIME, extra.GetDurationFormat(),
            extra.GetDuration(), mSampleRate,
            NumericTextCtrl::Options{}.AutoPos(true));
         mDuration->SetName( XO("Duration") );
         sizer->Add(mDuration, 0, wxALIGN_CENTER | wxALL, 5);
         auto groupSizer =
            std::make_unique<wxStaticBoxSizer>(wxVERTICAL, w, _("Generator"));
         groupSizer->Add(sizer.release(), 0, wxALIGN_CENTER | wxALL, 5);
         innerSizer->Add(groupSizer.release(), 0, wxEXPAND | wxALL, 5);
      }
 
      // Make other controls, grouped into static boxes that are named
      // according to certain control port metadata
      auto groups = mPorts.mGroups; // mutable copy
      std::sort(groups.begin(), groups.end(), TranslationLess);
      for (auto &label: groups) {
         auto gridSizer = std::make_unique<wxFlexGridSizer>(numCols, 5, 5);
         gridSizer->AddGrowableCol(3);
         for (auto & p : mPorts.mGroupMap.at(label)) /* won't throw */ {
            auto &state = portUIStates.mControlPortStates[p];
            auto &port = state.mpPort;
            auto &ctrl = mPlainUIControls[p];
            const auto &value = values[p];
            auto labelText = port->mName;
            if (!port->mUnits.empty())
               labelText += XO("(%s)").Format(port->mUnits).Translation();
 
            // A "trigger" port gets a row with just a pushbutton
            if (port->mTrigger) {
               gridSizer->Add(1, 1, 0);
 
               assert(w); // To justify safenew
               auto b = safenew wxButton(w, ID_Triggers + p, labelText);
               gridSizer->Add(b, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
               ctrl.button = b;
 
               gridSizer->Add(1, 1, 0);
               gridSizer->Add(1, 1, 0);
               gridSizer->Add(1, 1, 0);
               continue;
            }
 
            // Any other kind of port gets a name text...
            auto item = safenew wxStaticText(w, wxID_ANY, labelText + wxT(":"),
               wxDefaultPosition, wxDefaultSize, wxALIGN_RIGHT);
            gridSizer->Add(item, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT);
 
            // ... then appropriate controls and static texts in other columns
            if (port->mToggle) {
               // Toggle port gets a checkbox
               auto c = safenew wxCheckBox(w, ID_Toggles + p, wxT(""));
               c->SetName(labelText);
               c->SetValue(value > 0);
               gridSizer->Add(c, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
               ctrl.checkbox = c;
 
               gridSizer->Add(1, 1, 0);
               gridSizer->Add(1, 1, 0);
               gridSizer->Add(1, 1, 0);
            }
            else if (port->mEnumeration) {
               // Enumeration port gets a choice control
               // Discretize the value (all ports hold a float value) to
               // determine the intial selection
               auto s = port->Discretize(value);
               auto c = safenew wxChoice(w, ID_Choices + p);
               c->SetName(labelText);
               c->Append(port->mScaleLabels);
               c->SetSelection(s);
               gridSizer->Add(c, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
               ctrl.choice = c;
 
               gridSizer->Add(1, 1, 0);
               gridSizer->Add(1, 1, 0);
               gridSizer->Add(1, 1, 0);
            }
            else if (!port->mIsInput) {
               // Real-valued output gets a meter control
               gridSizer->Add(1, 1, 0);
               gridSizer->Add(1, 1, 0);
 
               static float sink;
               const auto pOutputValues =
                  static_cast<const LV2EffectOutputs*>(mpOutputs);
               const auto pValue =
                  pOutputValues ? &pOutputValues->values[p] : &sink;
               auto m = safenew LV2EffectMeter(w, port, *pValue);
               gridSizer->Add(m, 0, wxALIGN_CENTER_VERTICAL | wxEXPAND);
               ctrl.meter = m;
 
               gridSizer->Add(1, 1, 0);
            }
            else {
               // Numerical input gets a text input, with a validator...
               auto t = safenew wxTextCtrl(w, ID_Texts + p, wxT(""));
               t->SetName(labelText);
               gridSizer->Add(t, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
               ctrl.mText = t;
               auto rate = port->mSampleRate ? mSampleRate : 1.0f;
               state.mLo = port->mMin * rate;
               state.mHi = port->mMax * rate;
               state.mTmp = value * rate;
               if (port->mInteger) {
                  IntegerValidator<float> vld(&state.mTmp);
                  vld.SetRange(state.mLo, state.mHi);
                  t->SetValidator(vld);
               }
               else {
                  FloatingPointValidator<float> vld(6, &state.mTmp);
                  vld.SetRange(state.mLo, state.mHi);
 
                  // Set number of decimal places
                  float range = state.mHi - state.mLo;
                  auto style = range < 10
                     ? NumValidatorStyle::THREE_TRAILING_ZEROES
                     : range < 100
                        ? NumValidatorStyle::TWO_TRAILING_ZEROES
                        : NumValidatorStyle::ONE_TRAILING_ZERO;
                  vld.SetStyle(style);
                  t->SetValidator(vld);
               }
 
               // ... optional lower-bound static text ...
               if (port->mHasLo) {
                  wxString str;
                  if (port->mInteger || port->mSampleRate)
                     str.Printf(wxT("%d"), (int) lrintf(state.mLo));
                  else
                     str = Internat::ToDisplayString(state.mLo);
                  item = safenew wxStaticText(w, wxID_ANY, str);
                  gridSizer->Add(item, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT);
               }
               else
                  gridSizer->Add(1, 1, 0);
 
               // ... a slider ...
               auto s = safenew wxSliderWrapper(w, ID_Sliders + p,
                  0, 0, 1000, wxDefaultPosition, { 150, -1 });
               s->SetName(labelText);
               gridSizer->Add(s, 0, wxALIGN_CENTER_VERTICAL | wxEXPAND);
               ctrl.slider = s;
 
               // ... and optional upper-bound static text
               if (port->mHasHi) {
                  wxString str;
                  if (port->mInteger || port->mSampleRate)
                     str.Printf(wxT("%d"), (int) lrintf(state.mHi));
                  else
                     str = Internat::ToDisplayString(state.mHi);
                  item = safenew wxStaticText(w, wxID_ANY, str);
                  gridSizer->Add(item, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT);
               }
               else
                  gridSizer->Add(1, 1, 0);
            }
         }
 
         auto groupSizer = std::make_unique<wxStaticBoxSizer>(
            wxVERTICAL, w, label.Translation());
         groupSizer->Add(gridSizer.release(), 1, wxEXPAND | wxALL, 5);
         innerSizer->Add(groupSizer.release(), 0, wxEXPAND | wxALL, 5);
      }
 
      innerSizer->Layout();
 
      auto VisitCells = [&, cnt = innerSizer->GetChildren().GetCount()](auto f){
         for (size_t i = (mType == EffectTypeGenerate); i < cnt; ++i) {
            // For each group (skipping duration) visit the grid sizer
            auto groupSizer = innerSizer->GetItem(i)->GetSizer();
            auto gridSizer = static_cast<wxFlexGridSizer *>(
               groupSizer->GetItem(size_t{0})->GetSizer());
            auto items = gridSizer->GetChildren().GetCount();
            size_t cols = gridSizer->GetCols();
            for (size_t j = 0; j < items; ++j) {
               // For each grid item
               auto item = gridSizer->GetItem(j);
               f(item, j, cols);
            }
         }
      };
 
      // Calculate the maximum width of all columns (bypass Generator sizer)
      std::vector<int> widths(numCols);
      VisitCells([&](wxSizerItem *item, size_t j, size_t cols){
         auto &width = widths[j % cols];
         width = std::max(width, item->GetSize().GetWidth());
      });
 
      // Set each column in all of the groups to the same width.
      VisitCells([&](wxSizerItem *item, size_t j, size_t cols){
         int flags = item->GetFlag();
         if (flags & wxEXPAND)
            return;
         if (flags & wxALIGN_RIGHT)
            flags = (flags & ~wxALL) | wxLEFT;
         else
            flags = (flags & ~wxALL) | wxRIGHT;
         item->SetFlag(flags);
         item->SetBorder(widths[j % cols] - item->GetMinSize().GetWidth());
      });
 
      w->SetSizer(uInnerSizer.release());
 
      mParent->SetSizer(outerSizer.release());
   } // scope of unique_ptrs of sizers
 
   // Try to give the window a sensible default/minimum size
   wxSize sz1 = innerSizer->GetMinSize();
   wxSize sz2 = mParent->GetMinSize();
   w->SetMinSize( { -1, std::min(sz1.y, sz2.y) } );
 
   // And let the parent reduce to the NEW minimum if possible
   mParent->SetMinSize(w->GetMinSize());
 
   return true;
}
 
bool LV2Validator::UpdateUI()
{
   const auto &mySettings = GetSettings(mAccess.Get());
   auto pMaster = mInstance.GetMaster();
 
   if (pMaster && mySettings.mpState) {
      // Maybe there are other important side effects on the instance besides
      // changes of port values
      lilv_state_restore(mySettings.mpState.get(), &pMaster->GetInstance(),
         nullptr, nullptr, 0, nullptr);
      // Destroy the short lived carrier of preset state
      mySettings.mpState.reset();
   }
 
   auto &values = mySettings.values;
   {
      size_t index = 0; for (auto & state : mPortUIStates.mControlPortStates) {
         auto &port = state.mpPort;
         if (port->mIsInput)
            state.mTmp =
               values[index] * (port->mSampleRate ? mSampleRate : 1.0);
         ++index;
      }
   }
 
   if (mUseGUI) {
      // fancy UI
      if (mUI.mSuilInstance) {
         size_t index = 0;
         for (auto & port : mPorts.mControlPorts) {
            if (port->mIsInput)
               suil_instance_port_event(mUI.mSuilInstance.get(),
                  port->mIndex, sizeof(float),
                  /* Means this event sends a float: */ 0,
                  &values[index]);
            ++index;
         }
      }
      return true;
   }
 
   // else plain UI
   // Visiting controls by groups
   for (auto & group : mPorts.mGroups) {
      const auto & params = mPorts.mGroupMap.at(group); /* won't throw */
      for (auto & param : params) {
         auto &state = mPortUIStates.mControlPortStates[param];
         auto &port = state.mpPort;
         auto &ctrl = mPlainUIControls[param];
         auto &value = values[param];
         if (port->mTrigger)
            continue;
         else if (port->mToggle)
            ctrl.checkbox->SetValue(value > 0);
         else if (port->mEnumeration)      // Check before integer
            ctrl.choice->SetSelection(port->Discretize(value));
         else if (port->mIsInput) {
            state.mTmp = value * (port->mSampleRate ? mSampleRate : 1.0f);
            SetSlider(state, ctrl);
         }
      }
   }
   if (mParent && !mParent->TransferDataToWindow())
      return false;
   return true;
}
 
void LV2Validator::SetSlider(
   const LV2ControlPortState &state, const PlainUIControl &ctrl)
{
   float lo = state.mLo;
   float hi = state.mHi;
   float val = state.mTmp;
   if (state.mpPort->mLogarithmic) {
      lo = logf(lo);
      hi = logf(hi);
      val = logf(val);
   }
   ctrl.slider->SetValue(lrintf((val - lo) / (hi - lo) * 1000.0));
}
 
void LV2Validator::UpdateControlPortValue(
   LV2EffectSettings& settings, size_t controlPortIndex, float value)
{
   const auto currentValue = settings.values[controlPortIndex];
 
   // LV2 implementation allows to edit the values
   // using text boxes too. Provide sufficiently small epsilon
   // to distinguish between the values.
   // (for example, conversion from the text representation
   // is always lossy, so direct comparison of the values
   // is not possible, nor should it be used for float values)
   const auto epsilon = 1e-5f;
 
   if (std::abs(currentValue - value) < epsilon)
      return;
 
   settings.values[controlPortIndex] = value;
   Publish({ mPorts.mControlPorts[controlPortIndex]->mIndex, value });
}
 
void LV2Validator::OnTrigger(wxCommandEvent &evt)
{
   size_t idx = evt.GetId() - ID_Triggers;
   auto & port = mPorts.mControlPorts[idx];
   mAccess.ModifySettings([&](EffectSettings &settings) {
      UpdateControlPortValue(GetSettings(settings), idx, port->mDef);
      return nullptr;
   });
}
 
void LV2Validator::OnToggle(wxCommandEvent &evt)
{
   size_t idx = evt.GetId() - ID_Toggles;
   mAccess.ModifySettings([&](EffectSettings &settings) {
      UpdateControlPortValue(
         GetSettings(settings), idx, evt.GetInt() ? 1.0 : 0.0);
      return nullptr;
   });
}
 
void LV2Validator::OnChoice(wxCommandEvent &evt)
{
   size_t idx = evt.GetId() - ID_Choices;
   auto & port = mPorts.mControlPorts[idx];
   mAccess.ModifySettings([&](EffectSettings &settings) {
      UpdateControlPortValue(
         GetSettings(settings), idx, port->mScaleValues[evt.GetInt()]);
      return nullptr;
   });
}
 
void LV2Validator::OnText(wxCommandEvent &evt)
{
   size_t idx = evt.GetId() - ID_Texts;
   auto &state = mPortUIStates.mControlPortStates[idx];
   auto &port = state.mpPort;
   auto &ctrl = mPlainUIControls[idx];
   if (ctrl.mText->GetValidator()->TransferFromWindow()) {
      mAccess.ModifySettings([&](EffectSettings &settings) {
         UpdateControlPortValue(
            GetSettings(settings), idx,
               port->mSampleRate ? state.mTmp / mSampleRate : state.mTmp);
         return nullptr;
      });
      SetSlider(state, ctrl);
   }
}
 
void LV2Validator::OnSlider(wxCommandEvent &evt)
{
   size_t idx = evt.GetId() - ID_Sliders;
   auto &state = mPortUIStates.mControlPortStates[idx];
   auto &port = state.mpPort;
   float lo = state.mLo;
   float hi = state.mHi;
   if (port->mLogarithmic) {
      lo = logf(lo);
      hi = logf(hi);
   }
   state.mTmp = (((float) evt.GetInt()) / 1000.0) * (hi - lo) + lo;
   state.mTmp = std::clamp(state.mTmp, lo, hi);
   state.mTmp = port->mLogarithmic ? expf(state.mTmp) : state.mTmp;
   mAccess.ModifySettings([&](EffectSettings &settings) {
      UpdateControlPortValue(
         GetSettings(settings), idx,
            port->mSampleRate ? state.mTmp / mSampleRate : state.mTmp);
      return nullptr;
   });
   mPlainUIControls[idx].mText->GetValidator()->TransferToWindow();
}
 
void LV2Validator::Timer::Notify()
{
   if (mExternalWidget)
      LV2_EXTERNAL_UI_RUN(mExternalWidget);
}
 
void LV2Validator::OnIdle(wxIdleEvent &evt)
{
   evt.Skip();
   if (!mUI.mSuilInstance)
      return;
 
   if (mExternalUIClosed) {
      mExternalUIClosed = false;
      if (mDialog)
         mDialog->Close();
      return;
   }
 
   if (mUIIdleInterface) {
      const auto handle = suil_instance_get_handle(mUI.mSuilInstance.get());
      if (mUIIdleInterface->idle && mUIIdleInterface->idle(handle)) {
         if (mUIShowInterface && mUIShowInterface->hide)
            mUIShowInterface->hide(handle);
         if (mDialog)
            mDialog->Close();
         return;
      }
   }
 
   auto &portUIStates = mPortUIStates;
 
   if (auto &atomState = portUIStates.mControlOut) {
      atomState->SendToDialog([&](const LV2_Atom *atom, uint32_t size){
         suil_instance_port_event(mUI.mSuilInstance.get(),
            atomState->mpPort->mIndex, size,
            // Means this event sends some structured data:
            LV2Symbols::urid_EventTransfer, atom);
      });
   }
 
   // Is this idle time polling for changes of input redundant with
   // TransferDataToWindow or is it really needed?  Probably harmless.
   // In case of output control port values though, it is needed for metering.
   mAccess.Flush();
   auto& values = GetSettings(mAccess.Get()).values;
   auto pOutputValues = static_cast<const LV2EffectOutputs *>(mpOutputs);
 
   size_t index = 0; for (auto &state : portUIStates.mControlPortStates) {
      auto &port = state.mpPort;
      
      const auto pValue = port->mIsInput
         ? &values[index]
         : pOutputValues ? &pOutputValues->values[index]
         : nullptr;
      if (pValue) {
         auto &value = *pValue;
         // Let UI know that a port's value has changed
         if (value != state.mLst) {
            suil_instance_port_event(mUI.mSuilInstance.get(),
               port->mIndex, sizeof(value),
               /* Means this event sends a float: */ 0,
/*
   Quoting what suil.h says about the next argument (which is good):
 
   The `buffer` must be valid only for the duration of this call, the UI must
   not keep a reference to it.
 */
               &value);
            state.mLst = value;
        }
      }
      ++index;
   }
}
 
void LV2Validator::OnSize(wxSizeEvent & evt)
{
   evt.Skip();
 
   // Don't do anything here if we're recursing
   if (mResizing)
      return;
 
   // Indicate resizing is occurring
   mResizing = true;
 
   // Can only resize AFTER the dialog has been completely created and
   // there's no need to resize if we're already at the desired size.
   if (mDialog && evt.GetSize() != mNativeWinLastSize) {
      // Save the desired size and set the native window to match
      mNativeWinLastSize = evt.GetSize();
      mUI.mNativeWin->SetMinSize(mNativeWinLastSize);
 
      // Clear the minimum size of the parent window to allow the following
      // Fit() to make proper adjustments
      mParent->SetMinSize(wxDefaultSize);
 
#if defined(__WXGTK__)
      // If the user resized the native window, then we need to also
      // clear the dialogs minimum size.  If this isn't done, the dialog
      // will not resize properly when going from a larger size to a smaller
      // size (due to the minimum size constraint).
      //
      // In this case, mResized has been set by the "size_request()" function
      // to indicate that this is a plugin generated resize request.
      if (mResized)
         mDialog->SetMinSize(wxDefaultSize);
 
      // Resize dialog
      mDialog->Fit();
 
      // Reestablish the minimum (and maximum) now that the dialog
      // has is desired size.
      if (mResized) {
         mDialog->SetMinSize(mDialog->GetSize());
         if (mUIFeatures && mUIFeatures->mNoResize)
            mDialog->SetMaxSize(mDialog->GetSize());
      }
 
      // Tell size_request() that the native window was just resized.
      mResized = true;
#else
      // Resize the dialog to fit its content.
      mDialog->Fit();
#endif
   }
 
   // No longer resizing
   mResizing = false;
}
 
// ============================================================================
// Feature handlers
// ============================================================================
 
int LV2Validator::ui_resize(int width, int height)
{
   // Queue a wxSizeEvent to resize the plugins UI
   if (mUI.mNativeWin) {
      wxSizeEvent sw{ wxSize{ width, height } };
      sw.SetEventObject(mUI.mNativeWin.get());
      mUI.mNativeWin->GetEventHandler()->AddPendingEvent(sw);
   }
   else
      // The window hasn't been created yet, so record the desired size
      mNativeWinInitialSize = { width, height };
   return 0;
}
 
void LV2Validator::ui_closed()
{
   mExternalUIClosed = true;
}
 
// Foreign UI code wants to send a value or event to me, the host
void LV2Validator::suil_port_write(uint32_t port_index,
   uint32_t buffer_size, uint32_t protocol, const void *buffer)
{
   // Handle implicit floats
   if (protocol == 0 && buffer_size == sizeof(float)) {
      if (auto it = mPorts.mControlPortMap.find(port_index);
          it != mPorts.mControlPortMap.end())
      {
         const auto value = *static_cast<const float*>(buffer);
         mAccess.ModifySettings(
            [&](EffectSettings& settings)
            {
               GetSettings(settings).values[it->second] = value;
               return nullptr;
            });
      
         
         Publish({ size_t(port_index), value });
      }
   }
   // Handle event transfers
   else if (protocol == LV2Symbols::urid_EventTransfer) {
      auto &portUIStates = mPortUIStates;
      auto &atomPortState = portUIStates.mControlIn;
      if (atomPortState && port_index == atomPortState->mpPort->mIndex)
         atomPortState->ReceiveFromDialog(buffer, buffer_size);
   }
}
 
uint32_t LV2Validator::suil_port_index(const char *port_symbol)
{
   for (size_t i = 0, cnt = lilv_plugin_get_num_ports(&mPlug); i < cnt; ++i) {
      const auto port = lilv_plugin_get_port_by_index(&mPlug, i);
      if (strcmp(port_symbol,
            lilv_node_as_string(lilv_port_get_symbol(&mPlug, port))) == 0)
         return lilv_port_get_index(&mPlug, port);
   }
   return LV2UI_INVALID_PORT_INDEX;
}
 
#if defined(__WXGTK__)
// static callback
//
// Need to queue a wxSizeEvent when the native window gets resized outside of
// WX control.  Many of the x42 LV2 plugins can resize themselves when changing
// the scale factor. (e.g., open "x42-dpl" effect and right click to change scaling)
void LV2Validator::size_request(GtkWidget *widget, GtkRequisition *requisition,
   LV2Validator *pValidator)
{
   pValidator->SizeRequest(widget, requisition);
}
 
void LV2Validator::SizeRequest(GtkWidget *widget, GtkRequisition *requisition)
{
   // Don't do anything if the OnSize() method is active
   if (!mResizing) {
      // If the OnSize() routine has processed an event, mResized will be true,
      // so just set the widgets size.
      if (mResized) {
         gtk_widget_set_size_request(widget,
            mNativeWinLastSize.x, mNativeWinLastSize.y);
         mResized = false;
      }
      // Otherwise, the plugin has resized the widget and we need to let WX know
      // about it.
      else if (mUI.mNativeWin) {
         mResized = true;
         wxSizeEvent se(wxSize(requisition->width, requisition->height));
         se.SetEventObject(mUI.mNativeWin.get());
         mUI.mNativeWin->GetEventHandler()->AddPendingEvent(se);
      }
   }
}
#endif
#endif