mirror of
https://github.com/robbert-vdh/yabridge.git
synced 2026-05-08 04:20:13 +02:00
💥 Rename HostBridge to PluginBridge
As mentioned in the last commit. The original reasoning behind these names was that the HostBridge talks to the host, and the PluginBridge talks to the plugin, but you could also argue that the HostBridge should be part of the Wine VST host and the PluginBridge should be part of the VST plugin. This removes that ambiguity.
This commit is contained in:
Robbert van der Helm
@@ -0,0 +1,245 @@
|
||||
// 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 <vestige/aeffectx.h>
|
||||
|
||||
#include <boost/asio/io_context.hpp>
|
||||
#include <boost/asio/local/stream_protocol.hpp>
|
||||
#include <boost/asio/streambuf.hpp>
|
||||
#include <boost/process/async_pipe.hpp>
|
||||
#include <boost/process/child.hpp>
|
||||
#include <mutex>
|
||||
#include <thread>
|
||||
|
||||
#include "../common/logging.h"
|
||||
|
||||
/**
|
||||
* Boost 1.72 was released with a known breaking bug caused by a missing
|
||||
* typedef: https://github.com/boostorg/process/issues/116.
|
||||
*
|
||||
* Luckily this is easy to fix since it's not really possible to downgrade Boost
|
||||
* as it would break other applications.
|
||||
*
|
||||
* Check if this is still needed for other distros after Arch starts packaging
|
||||
* Boost 1.73.
|
||||
*/
|
||||
class patched_async_pipe : public boost::process::async_pipe {
|
||||
public:
|
||||
using boost::process::async_pipe::async_pipe;
|
||||
|
||||
typedef typename handle_type::executor_type executor_type;
|
||||
};
|
||||
|
||||
/**
|
||||
* A tag to differentiate between 32 and 64-bit plugins, used to determine which
|
||||
* host application to use.
|
||||
*/
|
||||
enum class PluginArchitecture { vst_32, vst_64 };
|
||||
|
||||
/**
|
||||
* This handles the communication between the Linux native VST plugin and the
|
||||
* Wine VST host. The functions below should be used as callback functions in an
|
||||
* `AEffect` object.
|
||||
*/
|
||||
class PluginBridge {
|
||||
public:
|
||||
/**
|
||||
* Initializes the Wine VST bridge. This sets up the sockets for event
|
||||
* handling.
|
||||
*
|
||||
* @param host_callback The callback function passed to the VST plugin by
|
||||
* the host.
|
||||
*
|
||||
* @throw std::runtime_error Thrown when the VST host could not be found, or
|
||||
* if it could not locate and load a VST .dll file.
|
||||
*/
|
||||
PluginBridge(audioMasterCallback host_callback);
|
||||
|
||||
// The four below functions are the handlers from the VST2 API. They are
|
||||
// called through proxy functions in `plugin.cpp`.
|
||||
|
||||
/**
|
||||
* Handle an event sent by the VST host. Most of these opcodes will be
|
||||
* passed through to the winelib VST host.
|
||||
*/
|
||||
intptr_t dispatch(AEffect* plugin,
|
||||
int opcode,
|
||||
int index,
|
||||
intptr_t value,
|
||||
void* data,
|
||||
float option);
|
||||
/**
|
||||
* Ask the VST plugin to process audio for us. If the plugin somehow does
|
||||
* not support `processReplacing()` and only supports the old `process()`
|
||||
* function, then this will be handled implicitely in
|
||||
* `WineBridge::handle_process_replacing()`.
|
||||
*/
|
||||
void process_replacing(AEffect* plugin,
|
||||
float** inputs,
|
||||
float** outputs,
|
||||
int sample_frames);
|
||||
float get_parameter(AEffect* plugin, int index);
|
||||
void set_parameter(AEffect* plugin, int index, float value);
|
||||
|
||||
/**
|
||||
* The path to the .dll being loaded in the Wine VST host.
|
||||
*/
|
||||
const boost::filesystem::path vst_plugin_path;
|
||||
/**
|
||||
* Whether the plugin is 64-bit or 32-bit.
|
||||
*/
|
||||
const PluginArchitecture vst_plugin_arch;
|
||||
/**
|
||||
* The path to the host application (i.e. a path to either
|
||||
* `yabridge-host.exe` or `yabridge-host-32.exe`). The host application will
|
||||
* be chosen depending on the architecture of the VST plugin .dll file.
|
||||
*/
|
||||
const boost::filesystem::path vst_host_path;
|
||||
|
||||
/**
|
||||
* This AEffect struct will be populated using the data passed by the Wine
|
||||
* VST host during initialization and then passed as a pointer to the Linux
|
||||
* native VST host from the Linux VST plugin's entry point.
|
||||
*/
|
||||
AEffect plugin;
|
||||
|
||||
/**
|
||||
* The VST hsot can query a plugin for arbitrary binary data such as
|
||||
* presets. It will expect the plugin to write back a pointer that points to
|
||||
* that data. This vector is where we store the chunk data for the last
|
||||
* `effGetChunk` event.
|
||||
*/
|
||||
std::vector<uint8_t> chunk_data;
|
||||
/**
|
||||
* The VST host will expect to be returned a pointer to a struct that stores
|
||||
* the dimensions of the editor window.
|
||||
*/
|
||||
VstRect editor_rectangle;
|
||||
|
||||
private:
|
||||
/**
|
||||
* Write output from an async pipe to the log on a line by line basis.
|
||||
* Useful for logging the Wine process's STDOUT and STDERR streams.
|
||||
*
|
||||
* @param pipe The pipe to read from.
|
||||
* @param buffer The stream buffer to write to.
|
||||
* @param prefix Text to prepend to the line before writing to the log.
|
||||
*/
|
||||
void async_log_pipe_lines(patched_async_pipe& pipe,
|
||||
boost::asio::streambuf& buffer,
|
||||
std::string prefix = "");
|
||||
|
||||
boost::asio::io_context io_context;
|
||||
boost::asio::local::stream_protocol::endpoint socket_endpoint;
|
||||
boost::asio::local::stream_protocol::acceptor socket_acceptor;
|
||||
|
||||
// The naming convention for these sockets is `<from>_<to>_<event>`. For
|
||||
// instance the socket named `host_vst_dispatch` forwards
|
||||
// `AEffect.dispatch()` calls from the native VST host to the Windows VST
|
||||
// plugin (through the Wine VST host).
|
||||
boost::asio::local::stream_protocol::socket host_vst_dispatch;
|
||||
/**
|
||||
* Used specifically for the `effProcessEvents` opcode. This is needed
|
||||
* because the Win32 API is designed to block during certain GUI
|
||||
* interactions such as resizing a window or opening a dropdown. Without
|
||||
* this MIDI input would just stop working at times.
|
||||
*/
|
||||
boost::asio::local::stream_protocol::socket host_vst_dispatch_midi_events;
|
||||
boost::asio::local::stream_protocol::socket vst_host_callback;
|
||||
/**
|
||||
* Used for both `getParameter` and `setParameter` since they mostly
|
||||
* overlap.
|
||||
*/
|
||||
boost::asio::local::stream_protocol::socket host_vst_parameters;
|
||||
boost::asio::local::stream_protocol::socket host_vst_process_replacing;
|
||||
|
||||
/**
|
||||
* This socket only handles updates of the `AEffect` struct instead of
|
||||
* passing through function calls. It's also used during initialization to
|
||||
* pass the Wine plugin's information to the host.
|
||||
*/
|
||||
boost::asio::local::stream_protocol::socket vst_host_aeffect;
|
||||
|
||||
/**
|
||||
* The thread that handles host callbacks.
|
||||
*/
|
||||
std::thread host_callback_handler;
|
||||
|
||||
/**
|
||||
* A binary semaphore to prevent race conditions from the dispatch function
|
||||
* being called by two threads at once. See `send_event()` for more
|
||||
* information.
|
||||
*/
|
||||
std::mutex dispatch_mutex;
|
||||
std::mutex dispatch_midi_events_mutex;
|
||||
/**
|
||||
* A similar semaphore as the `dispatch_*` semaphores in the rare case that
|
||||
* `getParameter()` and `setParameter()` are being called at the same time
|
||||
* since they use the same socket.
|
||||
*/
|
||||
std::mutex parameters_mutex;
|
||||
|
||||
/**
|
||||
* The callback function passed by the host to the VST plugin instance.
|
||||
*/
|
||||
audioMasterCallback host_callback_function;
|
||||
Logger logger;
|
||||
|
||||
boost::asio::streambuf wine_stdout_buffer;
|
||||
boost::asio::streambuf wine_stderr_buffer;
|
||||
/**
|
||||
* The STDOUT stream of the Wine process we can forward to the logger.
|
||||
*/
|
||||
patched_async_pipe wine_stdout;
|
||||
/**
|
||||
* The STDERR stream of the Wine process we can forward to the logger.
|
||||
*/
|
||||
patched_async_pipe wine_stderr;
|
||||
/**
|
||||
* Runs the Boost.Asio `io_context` thread for logging the Wine process
|
||||
* STDOUT and STDERR messages.
|
||||
*/
|
||||
std::thread wine_io_handler;
|
||||
|
||||
/**
|
||||
* The Wine process hosting the Windows VST plugin.
|
||||
*/
|
||||
boost::process::child vst_host;
|
||||
|
||||
/**
|
||||
* A scratch buffer for sending and receiving data during `process` and
|
||||
* `processReplacing` calls.
|
||||
*/
|
||||
std::vector<uint8_t> process_buffer;
|
||||
|
||||
/**
|
||||
* Sending MIDI events sent to the host by the plugin using
|
||||
* `audioMasterProcessEvents` function has to be done during the processing
|
||||
* function. If they are sent during any other time or from another thread,
|
||||
* then the host will just discard them. Because we're receiving our host
|
||||
* callbacks on a separate thread, we have to temporarily store any events
|
||||
* we receive so we can send them to the host at the end of
|
||||
* `process_replacing()`.
|
||||
*/
|
||||
std::vector<DynamicVstEvents> incoming_midi_events;
|
||||
/**
|
||||
* Mutex for locking the above event queue, since recieving and processing
|
||||
* now happens in two different threads.
|
||||
*/
|
||||
std::mutex incoming_midi_events_mutex;
|
||||
};
|
||||
Reference in New Issue
Block a user