vanja/yabridge
1
0
Fork 0
mirror of https://github.com/robbert-vdh/yabridge.git synced 2026-05-07 03:50:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add a section about debugging in the readme

Browse Source
This commit is contained in:
Robbert van der Helm
2020-03-08 12:46:53 +01:00
parent ea4b0babcd
commit 3d92b9db28
1 changed files with 31 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+31 -2
View File
@@ -40,8 +40,10 @@ place in your home directory. If you choose to build from source, then you can
directly use the binaries from the `build/` directory. For the section below I'm directly use the binaries from the `build/` directory. For the section below I'm
going to assume you've placed the files in `~/.local/share/yabridge`. going to assume you've placed the files in `~/.local/share/yabridge`.
To set up yabridge for a VST plugin called `~/.wine/drive_c/Program Files/Steinberg/VstPlugins/plugin.dll`, simply create a symlink from To set up yabridge for a VST plugin called
`~/.local/share/yabridge/libyabridge.so` to `~/.wine/drive_c/Program Files/Steinberg/VstPlugins/plugin.so` like so: `~/.wine/drive_c/Program Files/Steinberg/VstPlugins/plugin.dll`, simply create a
symlink from `~/.local/share/yabridge/libyabridge.so` to
`~/.wine/drive_c/Program Files/Steinberg/VstPlugins/plugin.so` like so:
```shell ```shell
ln -s ~/.local/share/yabridge/libyabridge.so "$HOME/.wine/drive_c/Program Files/Steinberg/VstPlugins/plugin.so" ln -s ~/.local/share/yabridge/libyabridge.so "$HOME/.wine/drive_c/Program Files/Steinberg/VstPlugins/plugin.so"
@@ -91,6 +93,33 @@ When developing or debugging yabridge you can change the build type to either
`debug` or `debugoptimized` to enable debug symbols and optionally also disable `debug` or `debugoptimized` to enable debug symbols and optionally also disable
optimizations. optimizations.
## Debugging
Wine's error messages and warning are typically very helpful whenever a plugin
doesn't work right away. Sadly this information is not always available. For
instance Bitwig hides a plugin's STDOUT and STDERR streams from you. To make it
easier to debug malfunctioning plugins, yabridge offers two environment
variables:
- `YABRIDGE_DEBUG_FILE=<path>` allows you to write the Wine VST host's STDOUT
and STDERR messages to a file. For example, you could launch your DAW with
`env YABRIDGE_DEBUG_FILE=/tmp/yabridge.log <daw>`,
and then use `tail -F /tmp/yabridge.log` to keep track of that file. If this
option is not absent then yabridge will write its debug messages to STDERR
instead.
- `YABRIDGE_DEBUG_LEVEL={0,1}` allows you to set the verbosity of the debug
information. Every level increases the verbosity of the debug information:
- A value of `0` (the default) means that yabridge will only output messages
from the Wine process and some basic information such as the plugin being
loaded and the wineprefix being used.
- A value of `1` will log information about all events and function calls
being sent between the VST host and the plugin. This can be very verbose but
it makes it easier to see if yabridge is handling things incorrectly.
More detailed information about these levels can be found in
`src/common/logging.h`.
## Rationale ## Rationale
I started this project because the alternatives were either unmaintained, not I started this project because the alternatives were either unmaintained, not