mirror of
https://github.com/robbert-vdh/yabridge.git
synced 2026-05-06 19:40:10 +02:00
Move data types and serializers to their own file
This commit is contained in:
Robbert van der Helm
+1
-192
@@ -16,13 +16,7 @@
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <bitsery/adapter/buffer.h>
|
||||
#include <bitsery/bitsery.h>
|
||||
#include <bitsery/ext/std_optional.h>
|
||||
#include <bitsery/traits/array.h>
|
||||
#include <bitsery/traits/string.h>
|
||||
#include <bitsery/traits/vector.h>
|
||||
#include <vestige/aeffectx.h>
|
||||
|
||||
#include <cinttypes>
|
||||
#include <iostream>
|
||||
@@ -34,192 +28,7 @@
|
||||
#include <boost/asio/local/stream_protocol.hpp>
|
||||
|
||||
#include "logging.h"
|
||||
|
||||
// This file can be divided into four sections:
|
||||
// - Data structures for passing events and their accompanying bitsery
|
||||
// serializers.
|
||||
// - Serialization functions for structs from `aeffectx.h`.
|
||||
// - Convenience functions for serializing structs and sending them over
|
||||
// sockets, and similar functions for receiving and deserializing those
|
||||
// structs.
|
||||
// - Two functions to send and passthrough `dispatch` (host -> plugin) and
|
||||
// `audioMasterCallback` (plugin -> host) events since those should be handled
|
||||
// in exactly the same way.
|
||||
|
||||
/**
|
||||
* The maximum number of audio channels supported.
|
||||
*/
|
||||
constexpr size_t max_audio_channels = 32;
|
||||
/**
|
||||
* The maximum number of samples in a buffer.
|
||||
*/
|
||||
constexpr size_t max_buffer_size = 16384;
|
||||
/**
|
||||
* The maximum size in bytes of a string or buffer passed through a void pointer
|
||||
* in one of the dispatch functions. This is used as a buffer size and also as a
|
||||
* cutoff for checking if c-style strings behind a `char*` have changed.
|
||||
*/
|
||||
constexpr size_t max_string_length = 128;
|
||||
|
||||
/**
|
||||
* A simple constant sized buffer for smaller types that can be allocated on the
|
||||
* stack.
|
||||
*/
|
||||
template <std::size_t N>
|
||||
using ArrayBuffer = std::array<uint8_t, N>;
|
||||
|
||||
template <typename B>
|
||||
using OutputAdapter = bitsery::OutputBufferAdapter<B>;
|
||||
|
||||
template <typename B>
|
||||
using InputAdapter = bitsery::InputBufferAdapter<B>;
|
||||
|
||||
/**
|
||||
* An event as dispatched by the VST host. These events will get forwarded to
|
||||
* the VST host process running under Wine. The fields here mirror those
|
||||
* arguments sent to the `AEffect::dispatch` function.
|
||||
*/
|
||||
struct Event {
|
||||
using buffer_type = ArrayBuffer<max_string_length + 32>;
|
||||
|
||||
int opcode;
|
||||
int index;
|
||||
// TODO: This is an intptr_t, if we want to support 32 bit Wine plugins all
|
||||
// of these these intptr_t types should be replace by `uint64_t` to
|
||||
// remain compatible with the Linux VST plugin.
|
||||
intptr_t value;
|
||||
float option;
|
||||
/**
|
||||
* The event dispatch function has a void pointer parameter that's used to
|
||||
* either send string messages to the event (e.g. for `effCanDo`) or to
|
||||
* write a string back into. This value will contain an (empty) string if
|
||||
* the void* parameter for the dispatch function was not a null pointer.
|
||||
*/
|
||||
std::optional<std::string> data;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.value4b(opcode);
|
||||
s.value4b(index);
|
||||
// Hard coding pointer sizes to 8 bytes should be fine, right? Even if
|
||||
// we're hosting a 32 bit plugin the native VST plugin will still use 64
|
||||
// bit large pointers.
|
||||
s.value8b(value);
|
||||
s.value4b(option);
|
||||
s.ext(data, bitsery::ext::StdOptional(),
|
||||
[](S& s, auto& v) { s.text1b(v, max_string_length); });
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* AN instance of this should be sent back as a response to an incoming event.
|
||||
*/
|
||||
struct EventResult {
|
||||
using buffer_type = ArrayBuffer<max_string_length + 32>;
|
||||
|
||||
/**
|
||||
* The result that should be returned from the dispatch function.
|
||||
*/
|
||||
intptr_t return_value;
|
||||
/**
|
||||
* If present, this should get written into the void pointer passed to the
|
||||
* dispatch function.
|
||||
*/
|
||||
std::optional<std::string> data;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.value8b(return_value);
|
||||
s.ext(data, bitsery::ext::StdOptional(),
|
||||
[](S& s, auto& v) { s.text1b(v, max_string_length); });
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Represents a call to either `getParameter` or `setParameter`, depending on
|
||||
* whether `value` contains a value or not.
|
||||
*/
|
||||
struct Parameter {
|
||||
using buffer_type = ArrayBuffer<16>;
|
||||
|
||||
int index;
|
||||
std::optional<float> value;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.value4b(index);
|
||||
s.ext(value, bitsery::ext::StdOptional(),
|
||||
[](S& s, auto& v) { s.value4b(v); });
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* The result of a `getParameter` or a `setParameter` call. For `setParameter`
|
||||
* this struct won't contain any values and mostly acts as an acknowledgement
|
||||
* from the Wine VST host.
|
||||
*/
|
||||
struct ParameterResult {
|
||||
using buffer_type = ArrayBuffer<16>;
|
||||
|
||||
std::optional<float> value;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.ext(value, bitsery::ext::StdOptional(),
|
||||
[](S& s, auto& v) { s.value4b(v); });
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* A buffer of audio for the plugin to process, or the response of that
|
||||
* processing. The number of samples is encoded in each audio buffer's length.
|
||||
*/
|
||||
struct AudioBuffers {
|
||||
// When sending data we could use a vector of the right size, but when
|
||||
// receiving data we don't know how large this vector should be in advance
|
||||
// (or without sending the message length first)
|
||||
using buffer_type =
|
||||
ArrayBuffer<max_audio_channels * max_buffer_size * sizeof(float) + 16>;
|
||||
|
||||
/**
|
||||
* An audio buffer for each of the plugin's audio channels.
|
||||
*/
|
||||
std::vector<std::vector<float>> buffers;
|
||||
|
||||
/**
|
||||
* The number of frames in a sample. If buffers is not empty, then
|
||||
* `buffers[0].size() == sample_frames`.
|
||||
*/
|
||||
int sample_frames;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.container(buffers, max_audio_channels,
|
||||
[](S& s, auto& v) { s.container4b(v, max_buffer_size); });
|
||||
s.value4b(sample_frames);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* The serialization function for `AEffect` structs. This will s serialize all
|
||||
* of the values but it will not touch any of the pointer fields. That way you
|
||||
* can deserialize to an existing `AEffect` instance.
|
||||
*/
|
||||
template <typename S>
|
||||
void serialize(S& s, AEffect& plugin) {
|
||||
s.value4b(plugin.magic);
|
||||
s.value4b(plugin.numPrograms);
|
||||
s.value4b(plugin.numParams);
|
||||
s.value4b(plugin.numInputs);
|
||||
s.value4b(plugin.numOutputs);
|
||||
s.value4b(plugin.flags);
|
||||
s.value4b(plugin.initialDelay);
|
||||
s.value4b(plugin.empty3a);
|
||||
s.value4b(plugin.empty3b);
|
||||
s.value4b(plugin.unkown_float);
|
||||
s.value4b(plugin.uniqueID);
|
||||
s.value4b(plugin.version);
|
||||
}
|
||||
#include "serialization.h"
|
||||
|
||||
// I don't want to editor 'include/vestige/aeffectx.h`. That's why this type
|
||||
// trait and the above serialization function are here.` Clang complains that
|
||||
|
||||
@@ -0,0 +1,181 @@
|
||||
#include <bitsery/adapter/buffer.h>
|
||||
#include <bitsery/ext/std_optional.h>
|
||||
#include <bitsery/traits/array.h>
|
||||
#include <bitsery/traits/string.h>
|
||||
#include <bitsery/traits/vector.h>
|
||||
#include <vestige/aeffectx.h>
|
||||
|
||||
/**
|
||||
* The maximum number of audio channels supported.
|
||||
*/
|
||||
constexpr size_t max_audio_channels = 32;
|
||||
/**
|
||||
* The maximum number of samples in a buffer.
|
||||
*/
|
||||
constexpr size_t max_buffer_size = 16384;
|
||||
/**
|
||||
* The maximum size in bytes of a string or buffer passed through a void pointer
|
||||
* in one of the dispatch functions. This is used as a buffer size and also as a
|
||||
* cutoff for checking if c-style strings behind a `char*` have changed.
|
||||
*/
|
||||
constexpr size_t max_string_length = 128;
|
||||
|
||||
/**
|
||||
* A simple constant sized buffer for smaller types that can be allocated on the
|
||||
* stack.
|
||||
*/
|
||||
template <std::size_t N>
|
||||
using ArrayBuffer = std::array<uint8_t, N>;
|
||||
|
||||
template <typename B>
|
||||
using OutputAdapter = bitsery::OutputBufferAdapter<B>;
|
||||
|
||||
template <typename B>
|
||||
using InputAdapter = bitsery::InputBufferAdapter<B>;
|
||||
|
||||
/**
|
||||
* An event as dispatched by the VST host. These events will get forwarded to
|
||||
* the VST host process running under Wine. The fields here mirror those
|
||||
* arguments sent to the `AEffect::dispatch` function.
|
||||
*/
|
||||
struct Event {
|
||||
using buffer_type = ArrayBuffer<max_string_length + 32>;
|
||||
|
||||
int opcode;
|
||||
int index;
|
||||
// TODO: This is an intptr_t, if we want to support 32 bit Wine plugins all
|
||||
// of these these intptr_t types should be replace by `uint64_t` to
|
||||
// remain compatible with the Linux VST plugin.
|
||||
intptr_t value;
|
||||
float option;
|
||||
/**
|
||||
* The event dispatch function has a void pointer parameter that's used to
|
||||
* either send string messages to the event (e.g. for `effCanDo`) or to
|
||||
* write a string back into. This value will contain an (empty) string if
|
||||
* the void* parameter for the dispatch function was not a null pointer.
|
||||
*/
|
||||
std::optional<std::string> data;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.value4b(opcode);
|
||||
s.value4b(index);
|
||||
// Hard coding pointer sizes to 8 bytes should be fine, right? Even if
|
||||
// we're hosting a 32 bit plugin the native VST plugin will still use 64
|
||||
// bit large pointers.
|
||||
s.value8b(value);
|
||||
s.value4b(option);
|
||||
s.ext(data, bitsery::ext::StdOptional(),
|
||||
[](S& s, auto& v) { s.text1b(v, max_string_length); });
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* AN instance of this should be sent back as a response to an incoming event.
|
||||
*/
|
||||
struct EventResult {
|
||||
using buffer_type = ArrayBuffer<max_string_length + 32>;
|
||||
|
||||
/**
|
||||
* The result that should be returned from the dispatch function.
|
||||
*/
|
||||
intptr_t return_value;
|
||||
/**
|
||||
* If present, this should get written into the void pointer passed to the
|
||||
* dispatch function.
|
||||
*/
|
||||
std::optional<std::string> data;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.value8b(return_value);
|
||||
s.ext(data, bitsery::ext::StdOptional(),
|
||||
[](S& s, auto& v) { s.text1b(v, max_string_length); });
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Represents a call to either `getParameter` or `setParameter`, depending on
|
||||
* whether `value` contains a value or not.
|
||||
*/
|
||||
struct Parameter {
|
||||
using buffer_type = ArrayBuffer<16>;
|
||||
|
||||
int index;
|
||||
std::optional<float> value;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.value4b(index);
|
||||
s.ext(value, bitsery::ext::StdOptional(),
|
||||
[](S& s, auto& v) { s.value4b(v); });
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* The result of a `getParameter` or a `setParameter` call. For `setParameter`
|
||||
* this struct won't contain any values and mostly acts as an acknowledgement
|
||||
* from the Wine VST host.
|
||||
*/
|
||||
struct ParameterResult {
|
||||
using buffer_type = ArrayBuffer<16>;
|
||||
|
||||
std::optional<float> value;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.ext(value, bitsery::ext::StdOptional(),
|
||||
[](S& s, auto& v) { s.value4b(v); });
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* A buffer of audio for the plugin to process, or the response of that
|
||||
* processing. The number of samples is encoded in each audio buffer's length.
|
||||
*/
|
||||
struct AudioBuffers {
|
||||
// When sending data we could use a vector of the right size, but when
|
||||
// receiving data we don't know how large this vector should be in advance
|
||||
// (or without sending the message length first)
|
||||
using buffer_type =
|
||||
ArrayBuffer<max_audio_channels * max_buffer_size * sizeof(float) + 16>;
|
||||
|
||||
/**
|
||||
* An audio buffer for each of the plugin's audio channels.
|
||||
*/
|
||||
std::vector<std::vector<float>> buffers;
|
||||
|
||||
/**
|
||||
* The number of frames in a sample. If buffers is not empty, then
|
||||
* `buffers[0].size() == sample_frames`.
|
||||
*/
|
||||
int sample_frames;
|
||||
|
||||
template <typename S>
|
||||
void serialize(S& s) {
|
||||
s.container(buffers, max_audio_channels,
|
||||
[](S& s, auto& v) { s.container4b(v, max_buffer_size); });
|
||||
s.value4b(sample_frames);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* The serialization function for `AEffect` structs. This will s serialize all
|
||||
* of the values but it will not touch any of the pointer fields. That way you
|
||||
* can deserialize to an existing `AEffect` instance.
|
||||
*/
|
||||
template <typename S>
|
||||
void serialize(S& s, AEffect& plugin) {
|
||||
s.value4b(plugin.magic);
|
||||
s.value4b(plugin.numPrograms);
|
||||
s.value4b(plugin.numParams);
|
||||
s.value4b(plugin.numInputs);
|
||||
s.value4b(plugin.numOutputs);
|
||||
s.value4b(plugin.flags);
|
||||
s.value4b(plugin.initialDelay);
|
||||
s.value4b(plugin.empty3a);
|
||||
s.value4b(plugin.empty3b);
|
||||
s.value4b(plugin.unkown_float);
|
||||
s.value4b(plugin.uniqueID);
|
||||
s.value4b(plugin.version);
|
||||
}
|
||||
Reference in New Issue
Block a user