Files
yabridge/src/common/serialization/vst3/plugin/component.h
T
Robbert van der Helm b422f6fd42 Don't cache IComponent::getControllerClassId()
For the same reasons as the last commit. Now we don't have any of these
cached methods anymore.
2020-12-19 18:56:47 +01:00

295 lines
8.2 KiB
C++

// 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 <bitsery/ext/std_optional.h>
#include <bitsery/traits/array.h>
#include <pluginterfaces/vst/ivstcomponent.h>
#include "../../../bitsery/ext/vst3.h"
#include "../../common.h"
#include "../base.h"
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wnon-virtual-dtor"
/**
* Wraps around `IComponent` for serialization purposes. This is instantiated as
* part of `Vst3PluginProxy`. Event though `IComponent` inherits from
* `IPlguinBase`, we'll implement that separately in `YaPluginBase` because
* `IEditController` also inherits from `IPluginBase`.
*/
class YaComponent : public Steinberg::Vst::IComponent {
public:
/**
* These are the arguments for creating a `YaComponent`.
*/
struct ConstructArgs {
ConstructArgs();
/**
* Check whether an existing implementation implements `IComponent` 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.
*/
YaComponent(const ConstructArgs&& args);
inline bool supported() const { return arguments.supported; }
/**
* The response code and returned CID for a call to
* `IComponent::getControllerClassId()`.
*/
struct GetControllerClassIdResponse {
UniversalTResult result;
ArrayUID editor_cid;
template <typename S>
void serialize(S& s) {
s.object(result);
s.container1b(editor_cid);
}
};
/**
* Message to pass through a call to `IComponent::getControllerClassId()` to
* the Wine plugin host.
*/
struct GetControllerClassId {
using Response = GetControllerClassIdResponse;
native_size_t instance_id;
template <typename S>
void serialize(S& s) {
s.value8b(instance_id);
}
};
virtual tresult PLUGIN_API
getControllerClassId(Steinberg::TUID classId) override = 0;
/**
* Message to pass through a call to `IComponent::setIoMode(mode)` to the
* Wine plugin host.
*/
struct SetIoMode {
using Response = UniversalTResult;
native_size_t instance_id;
Steinberg::Vst::IoMode mode;
template <typename S>
void serialize(S& s) {
s.value8b(instance_id);
s.value4b(mode);
}
};
virtual tresult PLUGIN_API
setIoMode(Steinberg::Vst::IoMode mode) override = 0;
/**
* Message to pass through a call to `IComponent::getBusCount(type, dir)` to
* the Wine plugin host.
*/
struct GetBusCount {
using Response = PrimitiveWrapper<int32>;
native_size_t instance_id;
Steinberg::Vst::BusType type;
Steinberg::Vst::BusDirection dir;
template <typename S>
void serialize(S& s) {
s.value8b(instance_id);
s.value4b(type);
s.value4b(dir);
}
};
virtual int32 PLUGIN_API
getBusCount(Steinberg::Vst::MediaType type,
Steinberg::Vst::BusDirection dir) override = 0;
/**
* The response code and returned bus information for a call to
* `IComponent::getBusInfo(type, dir, index, bus <out>)`.
*/
struct GetBusInfoResponse {
UniversalTResult result;
Steinberg::Vst::BusInfo updated_bus;
template <typename S>
void serialize(S& s) {
s.object(result);
s.object(updated_bus);
}
};
/**
* Message to pass through a call to `IComponent::getBusInfo(type, dir,
* index, bus <out>)` to the Wine plugin host.
*/
struct GetBusInfo {
using Response = GetBusInfoResponse;
native_size_t instance_id;
Steinberg::Vst::BusType type;
Steinberg::Vst::BusDirection dir;
int32 index;
Steinberg::Vst::BusInfo bus;
template <typename S>
void serialize(S& s) {
s.value8b(instance_id);
s.value4b(type);
s.value4b(dir);
s.object(bus);
}
};
virtual tresult PLUGIN_API
getBusInfo(Steinberg::Vst::MediaType type,
Steinberg::Vst::BusDirection dir,
int32 index,
Steinberg::Vst::BusInfo& bus /*out*/) override = 0;
/**
* The response code and returned routing information for a call to
* `IComponent::getRoutingInfo(in_info, out_info <out>)`.
*/
struct GetRoutingInfoResponse {
UniversalTResult result;
Steinberg::Vst::RoutingInfo updated_in_info;
Steinberg::Vst::RoutingInfo updated_out_info;
template <typename S>
void serialize(S& s) {
s.object(result);
s.object(updated_in_info);
s.object(updated_out_info);
}
};
/**
* Message to pass through a call to `IComponent::getRoutingInfo(in_info,
* out_info <out>)` to the Wine plugin host.
*/
struct GetRoutingInfo {
using Response = GetRoutingInfoResponse;
native_size_t instance_id;
Steinberg::Vst::RoutingInfo in_info;
Steinberg::Vst::RoutingInfo out_info;
template <typename S>
void serialize(S& s) {
s.value8b(instance_id);
s.object(in_info);
s.object(out_info);
}
};
virtual tresult PLUGIN_API
getRoutingInfo(Steinberg::Vst::RoutingInfo& inInfo,
Steinberg::Vst::RoutingInfo& outInfo /*out*/) override = 0;
/**
* Message to pass through a call to `IComponent::activateBus(type, dir,
* index, state)` to the Wine plugin host.
*/
struct ActivateBus {
using Response = UniversalTResult;
native_size_t instance_id;
Steinberg::Vst::MediaType type;
Steinberg::Vst::BusDirection dir;
int32 index;
TBool state;
template <typename S>
void serialize(S& s) {
s.value8b(instance_id);
s.value4b(type);
s.value4b(dir);
s.value4b(index);
s.value1b(state);
}
};
virtual tresult PLUGIN_API activateBus(Steinberg::Vst::MediaType type,
Steinberg::Vst::BusDirection dir,
int32 index,
TBool state) override = 0;
/**
* Message to pass through a call to `IComponent::setActive(state)` to the
* Wine plugin host.
*/
struct SetActive {
using Response = UniversalTResult;
native_size_t instance_id;
TBool state;
template <typename S>
void serialize(S& s) {
s.value8b(instance_id);
s.value1b(state);
}
};
virtual tresult PLUGIN_API setActive(TBool state) override = 0;
// `setState()` and `getState()` are defiend in both `IComponent` and
// `IEditController`. Since an object can only ever implement one or the
// other, the messages for calling either are defined directly on
// `Vst3PluginProxy`.
virtual tresult PLUGIN_API
setState(Steinberg::IBStream* state) override = 0;
virtual tresult PLUGIN_API
getState(Steinberg::IBStream* state) override = 0;
protected:
ConstructArgs arguments;
};
#pragma GCC diagnostic pop