Split up the VST3 class implementations

2026-05-16 05:33:07 +02:00 · 2020-12-11 22:37:20 +01:00
parent 9439a62d94
commit d1d85711f0
6 changed files with 106 additions and 72 deletions
@@ -0,0 +1,97 @@
+// yabridge: a Wine VST bridge
+// Copyright (C) 2020  Robbert van der Helm
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+#include "component.h"
+
+YaComponentPluginImpl::YaComponentPluginImpl(Vst3PluginBridge& bridge,
+                                             YaComponent::Arguments&& args)
+    : YaComponent(std::move(args)), bridge(bridge) {}
+
+YaComponentPluginImpl::~YaComponentPluginImpl() {
+    // TODO: Send a control message to destroy the instance on the Wine side
+}
+
+tresult PLUGIN_API
+YaComponentPluginImpl::queryInterface(const ::Steinberg::TUID _iid,
+                                      void** obj) {
+    // TODO: Log when this fails on debug level 1, and on debug level 2 also log
+    //       successful queries. This behaviour should be implemented for all
+    //       interfaces.
+    return YaComponent::queryInterface(_iid, obj);
+}
+
+tresult PLUGIN_API YaComponentPluginImpl::initialize(FUnknown* context) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+tresult PLUGIN_API YaComponentPluginImpl::terminate() {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+tresult PLUGIN_API
+YaComponentPluginImpl::setIoMode(Steinberg::Vst::IoMode mode) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+int32 PLUGIN_API
+YaComponentPluginImpl::getBusCount(Steinberg::Vst::MediaType type,
+                                   Steinberg::Vst::BusDirection dir) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+tresult PLUGIN_API
+YaComponentPluginImpl::getBusInfo(Steinberg::Vst::MediaType type,
+                                  Steinberg::Vst::BusDirection dir,
+                                  int32 index,
+                                  Steinberg::Vst::BusInfo& bus /*out*/) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+tresult PLUGIN_API YaComponentPluginImpl::getRoutingInfo(
+    Steinberg::Vst::RoutingInfo& inInfo,
+    Steinberg::Vst::RoutingInfo& outInfo /*out*/) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+tresult PLUGIN_API
+YaComponentPluginImpl::activateBus(Steinberg::Vst::MediaType type,
+                                   Steinberg::Vst::BusDirection dir,
+                                   int32 index,
+                                   TBool state) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+tresult PLUGIN_API YaComponentPluginImpl::setActive(TBool state) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+tresult PLUGIN_API YaComponentPluginImpl::setState(Steinberg::IBStream* state) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
+
+tresult PLUGIN_API YaComponentPluginImpl::getState(Steinberg::IBStream* state) {
+    // TODO: Implement
+    return Steinberg::kNotImplemented;
+}
@@ -0,0 +1,64 @@
+// yabridge: a Wine VST bridge
+// Copyright (C) 2020  Robbert van der Helm
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+#pragma once
+
+#include "../vst3.h"
+
+class YaComponentPluginImpl : public YaComponent {
+   public:
+    YaComponentPluginImpl(Vst3PluginBridge& bridge,
+                          YaComponent::Arguments&& args);
+
+    /**
+     * When the reference count reaches zero and this destructor is called,
+     * we'll send a request to the Wine plugin host to destroy the corresponding
+     * object.
+     */
+    ~YaComponentPluginImpl();
+
+    /**
+     * We'll override the query interface to log queries for interfaces we do
+     * not (yet) support.
+     */
+    tresult PLUGIN_API queryInterface(const ::Steinberg::TUID _iid,
+                                      void** obj) override;
+
+    tresult PLUGIN_API initialize(FUnknown* context) override;
+    tresult PLUGIN_API terminate() override;
+
+    tresult PLUGIN_API setIoMode(Steinberg::Vst::IoMode mode) override;
+    int32 PLUGIN_API getBusCount(Steinberg::Vst::MediaType type,
+                                 Steinberg::Vst::BusDirection dir) override;
+    tresult PLUGIN_API
+    getBusInfo(Steinberg::Vst::MediaType type,
+               Steinberg::Vst::BusDirection dir,
+               int32 index,
+               Steinberg::Vst::BusInfo& bus /*out*/) override;
+    tresult PLUGIN_API
+    getRoutingInfo(Steinberg::Vst::RoutingInfo& inInfo,
+                   Steinberg::Vst::RoutingInfo& outInfo /*out*/) override;
+    tresult PLUGIN_API activateBus(Steinberg::Vst::MediaType type,
+                                   Steinberg::Vst::BusDirection dir,
+                                   int32 index,
+                                   TBool state) override;
+    tresult PLUGIN_API setActive(TBool state) override;
+    tresult PLUGIN_API setState(Steinberg::IBStream* state) override;
+    tresult PLUGIN_API getState(Steinberg::IBStream* state) override;
+
+   private:
+    Vst3PluginBridge& bridge;
+};
@@ -0,0 +1,69 @@
+// yabridge: a Wine VST bridge
+// Copyright (C) 2020  Robbert van der Helm
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+#include "plugin-factory.h"
+
+#include <pluginterfaces/vst/ivstcomponent.h>
+
+#include "component.h"
+
+YaPluginFactoryPluginImpl::YaPluginFactoryPluginImpl(Vst3PluginBridge& bridge)
+    : bridge(bridge) {}
+
+tresult PLUGIN_API
+YaPluginFactoryPluginImpl::createInstance(Steinberg::FIDString cid,
+                                          Steinberg::FIDString _iid,
+                                          void** obj) {
+    // TODO: Do the same thing for other types
+    ArrayUID cid_array;
+    std::copy(cid, cid + sizeof(Steinberg::TUID), cid_array.begin());
+    if (Steinberg::FIDStringsEqual(_iid, Steinberg::Vst::IComponent::iid)) {
+        std::optional<YaComponent::Arguments> args =
+            bridge.send_message(YaComponent::Create{.cid = cid_array});
+        if (args) {
+            // I find all of these raw pointers scary
+            *obj = new YaComponentPluginImpl(bridge, std::move(*args));
+            return Steinberg::kResultOk;
+        } else {
+            return Steinberg::kNotImplemented;
+        }
+    } else {
+        // When the host requests an interface we do not (yet) implement, we'll
+        // print a recognizable log message. I don't think they include a safe
+        // way to convert a `FIDString/char*` into a `FUID`, so this will have
+        // to do.
+        char iid_string[128] = "<invalid_pointer>";
+        constexpr size_t uid_size = sizeof(Steinberg::TUID);
+        if (_iid && strnlen(_iid, uid_size + 1) == uid_size) {
+            Steinberg::FUID iid = Steinberg::FUID::fromTUID(
+                *reinterpret_cast<const Steinberg::TUID*>(&_iid));
+            iid.print(iid_string, Steinberg::FUID::UIDPrintStyle::kCLASS_UID);
+        }
+
+        bridge.logger.log("[Unknown interface] " + std::string(iid_string));
+
+        return Steinberg::kNotImplemented;
+    }
+}
+
+tresult PLUGIN_API
+YaPluginFactoryPluginImpl::setHostContext(Steinberg::FUnknown* /*context*/) {
+    // TODO: The docs don't clearly specify what this should be doing, but from
+    //       what I've seen this is only used to pass a `IHostApplication`
+    //       instance. That's used to allow the plugin to create objects in the
+    //       host.
+    return Steinberg::kNotImplemented;
+}
@@ -0,0 +1,32 @@
+// yabridge: a Wine VST bridge
+// Copyright (C) 2020  Robbert van der Helm
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+#pragma once
+
+#include "../vst3.h"
+
+class YaPluginFactoryPluginImpl : public YaPluginFactory {
+   public:
+    YaPluginFactoryPluginImpl(Vst3PluginBridge& bridge);
+
+    tresult PLUGIN_API createInstance(Steinberg::FIDString cid,
+                                      Steinberg::FIDString _iid,
+                                      void** obj) override;
+    tresult PLUGIN_API setHostContext(Steinberg::FUnknown* context) override;
+
+   private:
+    Vst3PluginBridge& bridge;
+};