Update all references to libyabridge.so

This commit is contained in:
Robbert van der Helm
2020-11-28 13:26:00 +01:00
parent a428d08eff
commit 9d40e04a62
9 changed files with 43 additions and 39 deletions
+2 -2
View File
@@ -33,8 +33,8 @@
* they can share resources. Configuration file loading works as follows:
*
* 1. `load_config_for(path)` from `src/plugin/utils.h` gets called with a path
* to the copy of or symlink to `libyabridge.so` that the plugin host has
* tried to load.
* to the copy of or symlink to `libyabridge-{vst2,vst3}.so` that the plugin
* host has tried to load.
* 2. We start looking for a file named `yabridge.toml` in the same directory as
* that `.so` file, iteratively continuing to search one directory higher
* until we either find the file or we reach the filesystem root.
+2 -2
View File
@@ -140,7 +140,7 @@ fs::path find_vst_plugin() {
// In case this files does not exist and our `.so` file is a symlink, we'll
// also repeat this check after resolving that symlink to support links to
// copies of `libyabridge.so` as described in issue #3
// copies of `libyabridge-vst2.so` as described in issue #3
fs::path alternative_plugin_path = fs::canonical(this_plugin_path);
alternative_plugin_path.replace_extension(".dll");
if (fs::exists(alternative_plugin_path)) {
@@ -151,7 +151,7 @@ fs::path find_vst_plugin() {
// throw when the path could not be found
throw std::runtime_error("'" + plugin_path.string() +
"' does not exist, make sure to rename "
"'libyabridge.so' to match a "
"'libyabridge-vst2.so' to match a "
"VST plugin .dll file.");
}
+17 -14
View File
@@ -76,10 +76,10 @@ PluginArchitecture find_vst_architecture(boost::filesystem::path);
* Finds the Wine VST host (either `yabridge-host.exe` or `yabridge-host.exe`
* depending on the plugin). For this we will search in two places:
*
* 1. Alongside libyabridge.so if the file got symlinked. This is useful
* when developing, as you can simply symlink the the libyabridge.so
* file in the build directory without having to install anything to
* /usr.
* 1. Alongside libyabridge-{vst2,vst3}.so if the file got symlinked. This is
* useful when developing, as you can simply symlink the
* `libyabridge-{vst2,vst3}.so` file in the build directory without having
* to install anything to /usr.
* 2. In the regular search path, augmented with `~/.local/share/yabridge` to
* ease the setup process.
*
@@ -96,11 +96,14 @@ boost::filesystem::path find_vst_host(PluginArchitecture plugin_arch,
/**
* Find the VST plugin .dll file that corresponds to this copy of
* `libyabridge.so`. This should be the same as the name of this file but with a
* `.dll` file extension instead of `.so`. In case this file does not exist and
* the `.so` file is a symlink, we'll also repeat this check for the file it
* links to. This is to support the workflow described in issue #3 where you use
* symlinks to copies of `libyabridge.so`.
* `libyabridge-vst2.so`. This should be the same as the name of this file but
* with a `.dll` file extension instead of `.so`. In case this file does not
* exist and the `.so` file is a symlink, we'll also repeat this check for the
* file it links to. This is to support the workflow described in issue #3 where
* you use symlinks to copies of `libyabridge-vst2.so`.
*
* TODO: This should probably be renamed to `find_vst2_plugin()` so we can have
* a separate `find_vst3_plugin()`
*
* @return The a path to the accompanying VST plugin .dll file.
* @throw std::runtime_error If no matching .dll file could be found.
@@ -156,7 +159,7 @@ std::vector<boost::filesystem::path> get_augmented_search_path();
/**
* Return a path to this `.so` file. This can be used to find out from where
* this link to or copy of `libyabridge.so` was loaded.
* this link to or copy of `libyabridge-{vst2,vst3}.so` was loaded.
*/
boost::filesystem::path get_this_file_location();
@@ -180,10 +183,10 @@ std::string join_quoted_strings(std::vector<std::string>& strings);
/**
* Load the configuration that belongs to a copy of or symlink to
* `libyabridge.so`. If no configuration file could be found then this will
* return an empty configuration object with default settings. See the docstrong
* on the `Configuration` class for more details on how to choose the config
* file to load.
* `libyabridge-{vst2,vst3}.so`. If no configuration file could be found then
* this will return an empty configuration object with default settings. See the
* docstrong on the `Configuration` class for more details on how to choose the
* config file to load.
*
* This function will take any optional compile-time features that have not been
* enabled into account.
+5 -5
View File
@@ -30,11 +30,11 @@
* This works very similar to the host application defined in
* `individual-host.cpp`, but instead of just loading a single plugin this will
* act as a daemon that can host multiple 'grouped' plugins. This works by
* allowing the `libyabridge.so` instance to connect this this process over a
* socket to ask this process to host a VST `.dll` file using a provided socket.
* After that initialization step both the regular individual plugin host and
* this group plugin host will function identically on both the plugin and the
* Wine VST host side.
* allowing the `libyabridge-{vst2,vst3}.so` instance to connect this this
* process over a socket to ask this process to host a VST `.dll` file using a
* provided socket. After that initialization step both the regular individual
* plugin host and this group plugin host will function identically on both the
* plugin and the Wine VST host side.
*
* The explicit calling convention is needed to work around a bug introduced in
* Wine 5.7: https://bugs.winehq.org/show_bug.cgi?id=49138
+2 -2
View File
@@ -26,8 +26,8 @@
/**
* This is the default VST host application. It will load the specified VST2
* plugin, and then connect back to the `libyabridge.so` instance that spawned
* this over the socket.
* plugin, and then connect back to the `libyabridge-{vst2,vst3}.so` instance
* that spawned this over the socket.
*
* The explicit calling convention is needed to work around a bug introduced in
* Wine 5.7: https://bugs.winehq.org/show_bug.cgi?id=49138