vst3_plug_view.hpp

Go to the documentation of this file.

#pragma once
 
// VST3 IPlugView implementation for Pulp
// Creates an AutoUi-based editor view that embeds in the host's window.
// Uses PluginViewHost for platform-native rendering (CoreGraphics or GPU).
//
// Built from VST3 SDK (MIT license) CPluginView base class.
 
#include <pulp/format/processor.hpp>
#include <pulp/state/store.hpp>
 
#ifdef PULP_VST3_GUI
 
#include <pulp/format/view_bridge.hpp>
#include <pulp/view/plugin_view_host.hpp>
 
#include <memory>
 
// VST3 SDK
#include <public.sdk/source/common/pluginview.h>
 
namespace pulp::format::vst3 {
 
// IPlugView implementation that owns a ViewBridge. The bridge builds the
// view tree (custom create_view() or scripted/AutoUi fallback), dispatches
// lifecycle callbacks on the Processor, and tracks secondary views.
class PulpPlugView : public Steinberg::CPluginView {
public:
    PulpPlugView(Processor& processor, state::StateStore& store,
                 runtime::AliveToken::Handle owner_alive = {});
    ~PulpPlugView() override;
 
    // IPlugView overrides
    Steinberg::tresult PLUGIN_API isPlatformTypeSupported(Steinberg::FIDString type) override;
    Steinberg::tresult PLUGIN_API attached(void* parent, Steinberg::FIDString type) override;
    Steinberg::tresult PLUGIN_API removed() override;
    Steinberg::tresult PLUGIN_API setFrame(Steinberg::IPlugFrame* frame) override;
    Steinberg::tresult PLUGIN_API getSize(Steinberg::ViewRect* size) override;
    Steinberg::tresult PLUGIN_API onSize(Steinberg::ViewRect* newSize) override;
    // Resize negotiation (proportional + aspect-locked). The host calls
    // checkSizeConstraint() during a user drag to snap the candidate
    // rect to the editor's design aspect; onSize() then applies it. The
    // PluginViewHost scales content to fit via its design viewport.
    Steinberg::tresult PLUGIN_API canResize() override;
    Steinberg::tresult PLUGIN_API checkSizeConstraint(Steinberg::ViewRect* rect) override;
    // Space-to-focused-text-field via the IPlugView key pipeline. REAPER (with
    // "send all keyboard input to plug-in" OFF — its default) offers keys to the
    // view through onKeyDown BEFORE its own accelerator table; returning
    // kResultFalse is what lets Space fall through to transport, so the NSView
    // key path never sees it at all (host_quirks: reaper_keyboard_only_space —
    // Space is also the only key REAPER delivers well-formed here). Consumed
    // only when a text field inside THIS editor's tree holds focus.
    Steinberg::tresult PLUGIN_API onKeyDown(Steinberg::char16 key, Steinberg::int16 keyCode,
                                            Steinberg::int16 modifiers) override;
 
  private:
#if defined(__linux__)
    class LinuxFrameTimer;
    friend class LinuxFrameTimer;
    void register_linux_frame_timer();
    void unregister_linux_frame_timer();
    void on_linux_frame_timer();
    std::unique_ptr<LinuxFrameTimer> linux_frame_timer_;
    Steinberg::Linux::IRunLoop* linux_run_loop_ = nullptr;
    bool linux_timer_registered_ = false;
#else
    void register_linux_frame_timer() {}
    void unregister_linux_frame_timer() {}
#endif
    friend struct PulpPlugViewTestAccess;
    Processor& processor_;
    state::StateStore& store_;
    ViewBridge bridge_;
    std::unique_ptr<view::PluginViewHost> editor_host_;
    // Forwards the host's GPU-surface transitions into the scripted UI session.
    // Declared AFTER editor_host_ so destruction order alone already drops it
    // before the host; removed() resets it explicitly because bridge_ (which
    // owns the session the observer writes into) outlives both.
    view::PluginViewHost::GpuSurfaceSubscription gpu_surface_binding_;
};
 
} // namespace pulp::format::vst3
 
#endif // PULP_VST3_GUI