mirror of
https://github.com/robbert-vdh/yabridge.git
synced 2026-05-07 03:50:11 +02:00
Robbert van der Helm
417 lines
12 KiB
C++
417 lines
12 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 <pluginterfaces/vst/ivsteditcontroller.h>
|
|
|
|
#include "../../common.h"
|
|
#include "../base.h"
|
|
#include "../component-handler-proxy.h"
|
|
#include "../plug-view-proxy.h"
|
|
|
|
#pragma GCC diagnostic push
|
|
#pragma GCC diagnostic ignored "-Wnon-virtual-dtor"
|
|
|
|
/**
|
|
* Wraps around `IEditController` for serialization purposes. This is
|
|
* instantiated as part of `Vst3PluginProxy`.
|
|
*/
|
|
class YaEditController : public Steinberg::Vst::IEditController {
|
|
public:
|
|
/**
|
|
* These are the arguments for creating a `YaEditController`.
|
|
*/
|
|
struct ConstructArgs {
|
|
ConstructArgs();
|
|
|
|
/**
|
|
* Check whether an existing implementation implements
|
|
* `IEditController` 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.
|
|
*/
|
|
YaEditController(const ConstructArgs&& args);
|
|
|
|
inline bool supported() const { return arguments.supported; }
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::setComponentState(state)` to the Wine plugin host.
|
|
*/
|
|
struct SetComponentState {
|
|
using Response = UniversalTResult;
|
|
|
|
native_size_t instance_id;
|
|
|
|
VectorStream state;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.object(state);
|
|
}
|
|
};
|
|
|
|
virtual tresult PLUGIN_API
|
|
setComponentState(Steinberg::IBStream* 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;
|
|
|
|
/**
|
|
* Message to pass through a call to `IEditController::getParameterCount()`
|
|
* to the Wine plugin host.
|
|
*/
|
|
struct GetParameterCount {
|
|
using Response = PrimitiveWrapper<int32>;
|
|
|
|
native_size_t instance_id;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
}
|
|
};
|
|
|
|
virtual int32 PLUGIN_API getParameterCount() override = 0;
|
|
|
|
/**
|
|
* The response code and returned parameter information for a call to
|
|
* `IEditController::getParameterInfo(param_index, &info)`.
|
|
*/
|
|
struct GetParameterInfoResponse {
|
|
UniversalTResult result;
|
|
Steinberg::Vst::ParameterInfo updated_info;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.object(result);
|
|
s.object(updated_info);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::getParameterInfo(param_index, &info)` to the Wine
|
|
* plugin host.
|
|
*/
|
|
struct GetParameterInfo {
|
|
using Response = GetParameterInfoResponse;
|
|
|
|
native_size_t instance_id;
|
|
|
|
int32 param_index;
|
|
Steinberg::Vst::ParameterInfo info;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.value4b(param_index);
|
|
s.object(info);
|
|
}
|
|
};
|
|
|
|
virtual tresult PLUGIN_API
|
|
getParameterInfo(int32 paramIndex,
|
|
Steinberg::Vst::ParameterInfo& info /*out*/) override = 0;
|
|
|
|
/**
|
|
* The response code and returned parameter information for a call to
|
|
* `IEditController::getParamStringByValue(id, value_normalized,
|
|
* &string)`.
|
|
*/
|
|
struct GetParamStringByValueResponse {
|
|
UniversalTResult result;
|
|
|
|
std::u16string string;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.object(result);
|
|
s.container2b(string, std::extent_v<Steinberg::Vst::String128>);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::getParamStringByValue(id, value_normalized, &string)`
|
|
* to the Wine plugin host.
|
|
*/
|
|
struct GetParamStringByValue {
|
|
using Response = GetParamStringByValueResponse;
|
|
|
|
native_size_t instance_id;
|
|
|
|
Steinberg::Vst::ParamID id;
|
|
Steinberg::Vst::ParamValue value_normalized;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.value4b(id);
|
|
s.value8b(value_normalized);
|
|
}
|
|
};
|
|
|
|
virtual tresult PLUGIN_API getParamStringByValue(
|
|
Steinberg::Vst::ParamID id,
|
|
Steinberg::Vst::ParamValue valueNormalized /*in*/,
|
|
Steinberg::Vst::String128 string /*out*/) override = 0;
|
|
|
|
/**
|
|
* The response code and returned parameter information for a call to
|
|
* `IEditController::getParamValueByString(id, string,
|
|
* &&value_normalized)`.
|
|
*/
|
|
struct GetParamValueByStringResponse {
|
|
UniversalTResult result;
|
|
|
|
Steinberg::Vst::ParamValue value_normalized;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.object(result);
|
|
s.value8b(value_normalized);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::getParamValueByString(id, string, &value_normalized)`
|
|
* to the Wine plugin host.
|
|
*/
|
|
struct GetParamValueByString {
|
|
using Response = GetParamValueByStringResponse;
|
|
|
|
native_size_t instance_id;
|
|
|
|
Steinberg::Vst::ParamID id;
|
|
std::u16string string;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.value4b(id);
|
|
s.container2b(string, std::extent_v<Steinberg::Vst::String128>);
|
|
}
|
|
};
|
|
|
|
virtual tresult PLUGIN_API getParamValueByString(
|
|
Steinberg::Vst::ParamID id,
|
|
Steinberg::Vst::TChar* string /*in*/,
|
|
Steinberg::Vst::ParamValue& valueNormalized /*out*/) override = 0;
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::normalizedParamToPlain(id, value_normalized)` to the
|
|
* Wine plugin host.
|
|
*/
|
|
struct NormalizedParamToPlain {
|
|
using Response = PrimitiveWrapper<Steinberg::Vst::ParamValue>;
|
|
|
|
native_size_t instance_id;
|
|
|
|
Steinberg::Vst::ParamID id;
|
|
Steinberg::Vst::ParamValue value_normalized;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.value4b(id);
|
|
s.value8b(value_normalized);
|
|
}
|
|
};
|
|
|
|
virtual Steinberg::Vst::ParamValue PLUGIN_API normalizedParamToPlain(
|
|
Steinberg::Vst::ParamID id,
|
|
Steinberg::Vst::ParamValue valueNormalized) override = 0;
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::plainParamToNormalized(id, plain_value)` to the Wine
|
|
* plugin host.
|
|
*/
|
|
struct PlainParamToNormalized {
|
|
using Response = PrimitiveWrapper<Steinberg::Vst::ParamValue>;
|
|
|
|
native_size_t instance_id;
|
|
|
|
Steinberg::Vst::ParamID id;
|
|
Steinberg::Vst::ParamValue plain_value;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.value4b(id);
|
|
s.value8b(plain_value);
|
|
}
|
|
};
|
|
|
|
virtual Steinberg::Vst::ParamValue PLUGIN_API
|
|
plainParamToNormalized(Steinberg::Vst::ParamID id,
|
|
Steinberg::Vst::ParamValue plainValue) override = 0;
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::getParamNormalized(id)` to the Wine plugin host.
|
|
*/
|
|
struct GetParamNormalized {
|
|
using Response = PrimitiveWrapper<Steinberg::Vst::ParamValue>;
|
|
|
|
native_size_t instance_id;
|
|
|
|
Steinberg::Vst::ParamID id;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.value4b(id);
|
|
}
|
|
};
|
|
|
|
virtual Steinberg::Vst::ParamValue PLUGIN_API
|
|
getParamNormalized(Steinberg::Vst::ParamID id) override = 0;
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::setParamNormalized(id, value)` to the Wine plugin host.
|
|
*/
|
|
struct SetParamNormalized {
|
|
using Response = UniversalTResult;
|
|
|
|
native_size_t instance_id;
|
|
|
|
Steinberg::Vst::ParamID id;
|
|
Steinberg::Vst::ParamValue value;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.value4b(id);
|
|
s.value8b(value);
|
|
}
|
|
};
|
|
|
|
virtual tresult PLUGIN_API
|
|
setParamNormalized(Steinberg::Vst::ParamID id,
|
|
Steinberg::Vst::ParamValue value) override = 0;
|
|
|
|
/**
|
|
* Message to pass through a call to
|
|
* `IEditController::setComponentHandler(handler)` to the Wine plugin host.
|
|
* Like when creating a proxy for a plugin object, we'll read all supported
|
|
* interfaces form the component handler instance passed by the host. We'll
|
|
* then create a perfect proxy on the plugin side, that can do callbacks to
|
|
* the actual component handler passed by the host.
|
|
*/
|
|
struct SetComponentHandler {
|
|
using Response = UniversalTResult;
|
|
|
|
native_size_t instance_id;
|
|
|
|
Vst3ComponentHandlerProxy::ConstructArgs component_handler_proxy_args;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.object(component_handler_proxy_args);
|
|
}
|
|
};
|
|
|
|
virtual tresult PLUGIN_API setComponentHandler(
|
|
Steinberg::Vst::IComponentHandler* handler) override = 0;
|
|
|
|
/**
|
|
* The `IPlugView` proxy arguments returned from a call to
|
|
* `IEditController::createView(name)`. If not empty, then we'll use this to
|
|
* construct a proxy object that can send control messages to the plugin
|
|
* instance's actual `IPlugView` object.
|
|
*/
|
|
struct CreateViewResponse {
|
|
std::optional<Vst3PlugViewProxy::ConstructArgs> plug_view_args;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.ext(plug_view_args, bitsery::ext::StdOptional{});
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Message to pass through a call to `IEditController::createView(name)` to
|
|
* the Wine plugin host.
|
|
*/
|
|
struct CreateView {
|
|
using Response = CreateViewResponse;
|
|
|
|
native_size_t instance_id;
|
|
|
|
std::string name;
|
|
|
|
template <typename S>
|
|
void serialize(S& s) {
|
|
s.value8b(instance_id);
|
|
s.text1b(name, 128);
|
|
}
|
|
};
|
|
|
|
virtual Steinberg::IPlugView* PLUGIN_API
|
|
createView(Steinberg::FIDString name) override = 0;
|
|
|
|
protected:
|
|
ConstructArgs arguments;
|
|
};
|
|
|
|
#pragma GCC diagnostic pop
|
|
|
|
namespace Steinberg {
|
|
namespace Vst {
|
|
template <typename S>
|
|
void serialize(S& s, ParameterInfo& info) {
|
|
s.value4b(info.id);
|
|
s.container2b(info.title);
|
|
s.container2b(info.shortTitle);
|
|
s.container2b(info.units);
|
|
s.value4b(info.stepCount);
|
|
s.value8b(info.defaultNormalizedValue);
|
|
s.value4b(info.unitId);
|
|
s.value4b(info.flags);
|
|
}
|
|
} // namespace Vst
|
|
} // namespace Steinberg
|