Files
yabridge/src/common/serialization/vst3/plugin/xml-representation-controller.h
T
Robbert van der Helm 9b62386099 Move VectorStream to a new YaBStream
We'll have to extend this with `IStreamAttributes` for VST 3.6.0 preset
meta data.
2021-01-10 15:12:47 +01:00

128 lines
3.7 KiB
C++

// 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"
#include "../bstream.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; }
/**
* The response code and written state for a call to
* `IXmlRepresentationController::getXmlRepresentationStream(info,
* &stream)`.
*/
struct GetXmlRepresentationStreamResponse {
UniversalTResult result;
YaBStream stream;
template <typename S>
void serialize(S& s) {
s.object(result);
s.object(stream);
}
};
/**
* Message to pass through a call to
* `IXmlRepresentationController::getXmlRepresentationStream(info, &stream)`
* to the Wine plugin host.
*/
struct GetXmlRepresentationStream {
using Response = GetXmlRepresentationStreamResponse;
native_size_t instance_id;
Steinberg::Vst::RepresentationInfo info;
template <typename S>
void serialize(S& s) {
s.value8b(instance_id);
s.object(info);
}
};
virtual tresult PLUGIN_API
getXmlRepresentationStream(Steinberg::Vst::RepresentationInfo& info /*in*/,
Steinberg::IBStream* stream /*out*/) = 0;
protected:
ConstructArgs arguments;
};
#pragma GCC diagnostic pop
namespace Steinberg {
namespace Vst {
template <typename S>
void serialize(S& s, RepresentationInfo& info) {
s.text1b(info.vendor);
s.text1b(info.name);
s.text1b(info.version);
s.text1b(info.host);
}
} // namespace Vst
} // namespace Steinberg