vanja/yabridge
1
0
Fork 0
mirror of https://github.com/robbert-vdh/yabridge.git synced 2026-05-06 19:40:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rename YaHostApplication implementation

Browse Source 
The context should make it obvious where it's implemented, and with the
current design we only an implementation on one of the two sides.
This commit is contained in:
Robbert van der Helm
2020-12-18 20:43:43 +01:00
parent d2585a3550
commit d99f880277
7 changed files with 41 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -16,7 +16,7 @@ This branch is still very far removed from being in a usable state. Below is an
incomplete list of things that still have to be done before this can be used:
- Interfaces left to implement:
- `YaHostApplicationHostImpl::createComponent()`
- `IHostApplication::createComponent()`
- The other parts of `IConnectionPoint`, including support for host provided proxies
- Finish implementing `IEditController{,2}`
- All other mandatory interfaces
docs/vst3.md
+13 -9
View File
@@ -35,6 +35,10 @@ instantiated and managed by the host. The basic model works as follows:
interfaces defiend in the VST3 SDK. `Vst3PluginProxy` implements all
interfaces that can be implemented by plugins, and `Vst3HostProxy` implements
all interfaces that are to be implemented by the host.
TODO: Find out if `Vst3HostProxy` is needed, or if objects provided by the
host never implement multiple interfaces (which I think might be the case)
2. For every interface `IFoo`, we provide an abstract implementation called
`YaFoo`. This implementation mostly contain message object we use to make
specific function calls on the actual objects we are proxying. The
@@ -45,15 +49,15 @@ instantiated and managed by the host. The basic model works as follows:
3. Proxy object are instantiated while handling
`IPluginFactory::createInstance()` for `Vst3PluginProxy`, and during
`IPluginBase::initialize()` and `IPluginFactory::setHostContext()` for
`Vst3HostProxy`. On the receiving side of those functions (where we call the
actual function implemented by the plugin or the host), we receive an
`IPtr<T>` smart pointer to an object provided by the host or the plugin. We
use this object to iterate over every applicable `YaFoo` as mentioend above.
All of these `YaFoo::ConstructArgs` objects along with a unique identifier
for this specific object are then serialized and transmitted to the other
side. With this information we can create a proxy object that supports all
the same interfaces (and thus allows calls to the functions in those
interfaces) as the original object we are proxying.
`Vst3HostProxy` (TODO: Same here). On the receiving side of those functions
(where we call the actual function implemented by the plugin or the host), we
receive an `IPtr<T>` smart pointer to an object provided by the host or the
plugin. We use this object to iterate over every applicable `YaFoo` as
mentioend above. All of these `YaFoo::ConstructArgs` objects along with a
unique identifier for this specific object are then serialized and
transmitted to the other side. With this information we can create a proxy
object that supports all the same interfaces (and thus allows calls to the
functions in those interfaces) as the original object we are proxying.
4. As mentioend, every object we instantiate gets assigned a unique identifier.
When dealign with objects created by the Windows VST3 plugin, the object's
`FUnknown` pointer will be stored in an `std::map<size_t, PluginObject>` map.
src/common/serialization/vst3/README.md
+11 -6
View File
@@ -5,22 +5,27 @@ TODO: After merging into master, update this link to just point to GitHub
See [docs/vst3.md](../../../../docs/vst3.md) for more information on how the
serialization works.
VST3 interfaces are implemented as follows:
VST3 plugin interfaces are implemented as follows:
| Yabridge class | Included in | Interfaces |
| yabridge class | Included in | Interfaces |
| ------------------- | ----------------- | ------------------------------------------------------ |
| `YaPluginFactory` | | `IPluginFactory`, `IPluginFactory2`, `IPluginFactory3` |
| `Vst3PluginProxy` | | All of the below: |
| `YaAudioProcessor` | `Vst3PluginProxy` | `IAudioProcessor` |
| `YaComponent` | `Vst3PluginProxy` | `IComponent` |
| `YaConnectionPoint` | `Vst3PluginProxy` | `IConnectionPoint` |
| `YaEditController` | `Vst3PluginProxy` | `IEditController`, `IEditController2` |
| `YaPluginBase` | `Vst3PluginProxy` | `IPluginBase` |
| `YaHostApplication` | | `iHostAPplication` |
| `YaPluginFactory` | | `IPluginFactory`, `IPluginFactory2`, `IPluginFactory3` |
The following interfaces are implemented purely fur serialization purposes:
VST3 host interfaces are implemented as follows:
| Yabridge class | Interfaces | Notes |
| yabridge class | Interfaces |
| ------------------- | ------------------ |
| `YaHostApplication` | `IHostApplication` |
The following (host) interfaces are also implemented fur serialization purposes:
| yabridge class | Interfaces | Notes |
| -------------------- | ------------------- | ---------------------------------------------------------------------- |
| `YaEventList` | `IEventList` | Comes with a lot of serialization wrappers around the related structs. |
| `YaParameterChanges` | `IParameterChanges` | |
src/common/serialization/vst3/host-application.h
+3 -3
View File
@@ -95,9 +95,9 @@ class YaHostApplication : public Steinberg::Vst::IHostApplication {
/**
* The lifetime of this object should be bound to the object we created it
* for. When for instance the `IComponent` instance with id `x` gets dropped
* and we also track a `YaHostApplicationHostImpl` for the component with
* instance id `x`, then that should also be dropped.
* for. When for instance the `Vst3PluginProxy` instance with id `n` gets
* dropped and we also track a `YaHostApplicationImpl` for the component
* with instance id `n`, then that should also be dropped.
*/
virtual ~YaHostApplication();
src/wine-host/bridges/vst3-impls/host-application.cpp
+7 -7
View File
@@ -18,7 +18,7 @@
#include <iostream>
YaHostApplicationHostImpl::YaHostApplicationHostImpl(
YaHostApplicationImpl::YaHostApplicationImpl(
Vst3Bridge& bridge,
YaHostApplication::ConstructArgs&& args)
: YaHostApplication(std::move(args)), bridge(bridge) {
@@ -27,8 +27,9 @@ YaHostApplicationHostImpl::YaHostApplicationHostImpl(
}
tresult PLUGIN_API
YaHostApplicationHostImpl::queryInterface(const Steinberg::TUID _iid,
void** obj) {
YaHostApplicationImpl::queryInterface(const Steinberg::TUID _iid, void** obj) {
// I don't think it's expected of a host to implement multiple interfaces on
// this object, so if we do get a call here it's important that it's logged
// TODO: Successful queries should also be logged
const tresult result = YaHostApplication::queryInterface(_iid, obj);
if (result != Steinberg::kResultOk) {
@@ -39,10 +40,9 @@ YaHostApplicationHostImpl::queryInterface(const Steinberg::TUID _iid,
return result;
}
tresult PLUGIN_API
YaHostApplicationHostImpl::createInstance(Steinberg::TUID cid,
Steinberg::TUID _iid,
void** obj) {
tresult PLUGIN_API YaHostApplicationImpl::createInstance(Steinberg::TUID cid,
Steinberg::TUID _iid,
void** obj) {
// TODO: Implement
std::cerr << "TODO: IHostApplication::createInstance()" << std::endl;
return Steinberg::kNotImplemented;
src/wine-host/bridges/vst3-impls/host-application.h
+2 -2
View File
@@ -20,9 +20,9 @@
#include "../vst3.h"
class YaHostApplicationHostImpl : public YaHostApplication {
class YaHostApplicationImpl : public YaHostApplication {
public:
YaHostApplicationHostImpl(Vst3Bridge& bridge,
YaHostApplicationImpl(Vst3Bridge& bridge,
YaHostApplication::ConstructArgs&& args);
/**
src/wine-host/bridges/vst3.cpp
+4 -3
View File
@@ -298,14 +298,15 @@ void Vst3Bridge::run() {
// If we got passed a host context, we'll create a proxy object
// and pass that to the initialize function. This object should
// be cleaned up again during `Vst3PluginProxy::Destruct`.
// TODO: This needs changing when we get to `Vst3HostProxy`
// TODO: This needs changing if it turns out we need a
// `Vst3HostProxy`
// TODO: Does this have to be run from the UI thread? Figure out
// if it does
Steinberg::FUnknown* context = nullptr;
if (request.host_application_context_args) {
object_instances[request.instance_id]
.hsot_application_context =
Steinberg::owned(new YaHostApplicationHostImpl(
Steinberg::owned(new YaHostApplicationImpl(
*this,
std::move(*request.host_application_context_args)));
context = object_instances[request.instance_id]
@@ -328,7 +329,7 @@ void Vst3Bridge::run() {
[&](YaPluginFactory::SetHostContext& request)
-> YaPluginFactory::SetHostContext::Response {
plugin_factory_host_application_context =
Steinberg::owned(new YaHostApplicationHostImpl(
Steinberg::owned(new YaHostApplicationImpl(
*this,
std::move(request.host_application_context_args)));