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

Better document the serialization part

Browse Source
This commit is contained in:
Robbert van der Helm
2020-02-10 18:24:38 +01:00
parent 309a6cb00e
commit 4f22597970
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -6
View File
@@ -13,7 +13,7 @@ There are a few things that should be done before making this public, including:
rewrite some parts of it to make it clearer. rewrite some parts of it to make it clearer.
- Document what this has been tested on and what does or does not work. - Document what this has been tested on and what does or does not work.
- Document wine32 support. - Document wine32 support.
- Swap out msgpack for Bosot.Serializaton and update the architecture section. - Swap out msgpack for bitsery and update the architecture section.
- Add proper debugging support activated using an environment variable. - Add proper debugging support activated using an environment variable.
- Write all stdout and stderr output from the plugin to a temporary file so it - Write all stdout and stderr output from the plugin to a temporary file so it
can be inspected when using a host such as Bitwig that hides this by can be inspected when using a host such as Bitwig that hides this by
@@ -103,11 +103,13 @@ follows:
VST plugin through the Wine VST host using a single socket. VST plugin through the Wine VST host using a single socket.
- TODO: This is missing updates to the AEffect struct. - TODO: This is missing updates to the AEffect struct.
When communicating over these sockets, the request and corresponding response The first step when passing through any of these function calls over a socket
objects from `src/common/communication.h` will be serialized as binary data. is to serialize the function's parameters as binary data. Both request and
Right now we're using `msgpack`, but this should be switched out for the corresponding response objects for all of these function calls can be
`Bosot.Serialization` since we don't need interoperability and it allows us found in `src/common/communication.h`, along with functions to read and write
to drop a dependency. these objects over streams and sockets. Right now we're using `msgpack`, but
this should be switched out for [bitsery](https://github.com/fraillt/bitsery)
for lower overhead serialization.
6. The Wine VST host loads the Windows VST plugin and starts forwarding messages 6. The Wine VST host loads the Windows VST plugin and starts forwarding messages
over the sockets described above. over the sockets described above.