Add a proxy class for IXmlRepresentationController

2026-05-08 12:30:12 +02:00 · 2021-01-08 17:33:49 +01:00
parent 30bb6d3b97
commit ebd887d565
4 changed files with 134 additions and 24 deletions
@@ -0,0 +1,79 @@
+// yabridge: a Wine VST bridge
+// Copyright (C) 2020-2021 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 <pluginterfaces/vst/ivstrepresentation.h>
+
+#include "../../common.h"
+#include "../base.h"
+
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wnon-virtual-dtor"
+
+/**
+ * Wraps around `IXmlRepresentationController` for serialization purposes. This
+ * is instantiated as part of `Vst3PluginProxy`.
+ *
+ * XXX: The docs talk about standard locations for XML representation files. Do
+ *      plugins actually use these representations, do they place them in the
+ *      standard locations, and do hosts use them? If so we should be symlinking
+ *      them in yabridgectl. See
+ *      https://steinbergmedia.github.io/vst3_doc/vstinterfaces/representation.html
+ */
+class YaXmlRepresentationController
+    : public Steinberg::Vst::IXmlRepresentationController {
+   public:
+    /**
+     * These are the arguments for creating a `YaXmlRepresentationController`.
+     */
+    struct ConstructArgs {
+        ConstructArgs();
+
+        /**
+         * Check whether an existing implementation implements
+         * `IXmlRepresentationController` and read arguments from it.
+         */
+        ConstructArgs(Steinberg::IPtr<Steinberg::FUnknown> object);
+
+        /**
+         * Whether the object supported this interface.
+         */
+        bool supported;
+
+        template <typename S>
+        void serialize(S& s) {
+            s.value1b(supported);
+        }
+    };
+
+    /**
+     * Instantiate this instance with arguments read from another interface
+     * implementation.
+     */
+    YaXmlRepresentationController(const ConstructArgs&& args);
+
+    inline bool supported() const { return arguments.supported; }
+
+    virtual tresult PLUGIN_API
+    getXmlRepresentationStream(Steinberg::Vst::RepresentationInfo& info /*in*/,
+                               Steinberg::IBStream* stream /*out*/) = 0;
+
+   protected:
+    ConstructArgs arguments;
+};
+
+#pragma GCC diagnostic pop