Change wording in changelog

This commit is contained in:
Robbert van der Helm
2020-12-29 22:09:09 +01:00
parent fa4bd4bb24
commit 2b0fb8f954
2 changed files with 19 additions and 19 deletions
+14 -14
View File
@@ -13,23 +13,23 @@ TODO: Add an updates screenshot with some fancy VST3-only plugins to the readme
### Added
- Yabridge 3.0 introduces the first ever Wine VST3 bridge, allowing you to use
Windows VST3 plugins in Linux VST3 hosts with full VST 3.7.1 compatibility.
Simply tell yabridgectl to look for plugins in
- Yabridge 3.0 introduces the first ever true Wine VST3 bridge, allowing you to
use Windows VST3 plugins in Linux VST3 hosts with full VST 3.7.1
compatibility. Simply tell yabridgectl to look for plugins in
`$HOME/.wine/drive_c/Program Files/Common Files/VST3`, run `yabridgectl sync`,
and your VST3 compatible DAW will pick up the new plugins in
`~/.vst3/yabridge` automatically. Even though this feature has been tested
extensively with a variety of VST3 plugins and hosts, there's still a large
part of the VST 3.7.1 specification that none of the hosts or plugins we can
part of the VST 3.7.1 specification that none of the hosts or plugins we came
across actually used, so please let me know if you run into any weird
behaviour!
- Added the `with-vst3` compile time option to control whether yabridge should
be built with VST3 support. This is enabled by default.
- Added an
[option](https://github.com/robbert-vdh/yabridge#compatibility-options) to use
XEmbed instead of yabridge's normal window embedding method. Some plugins have
redrawing issues when using XEmbed and editor resizing won't work, so it's not
recommended to use it as a default.
Wine's XEmbed implementation instead of yabridge's normal window embedding
method. Some plugins have will have redrawing issues when using XEmbed or the
editor might not show up at all, so your mileage may very much vary.
### Changed
@@ -41,19 +41,19 @@ TODO: Add an updates screenshot with some fancy VST3-only plugins to the readme
double buffering.
- VST2 editor idle events are now handled slightly differently. This should
result in even more responsive GUIs and I have not come across any plugins
where this caused issues, but please let me know if it does break anything for
you.
where this change introduced issues, but please let me know if it does break
anything for you.
- Changed part of the build process considering [this Wine
bug](https://bugs.winehq.org/show_bug.cgi?id=49138). Building with Wine 5.7
and 5.8 required a change, but that change now breaks builds using Wine 6.0
and up. We now detect which version of Wine is used to build with, and we then
apply the change conditionally to be able to support building with both older
and newer versions of Wine.
and up. The build process now detect which version of Wine is used to build
with, and it then applies the change conditionally to be able to support
building with both older and newer versions of Wine.
### Fixed
- Added a background to the editor window to get rid of artifacts that could
occur when the plugin or the host don't resize the window correctly.
- Added a background to the editor window to get rid of artifacts that would
occur if the plugin or the host didn't resize the window correctly.
### yabridgectl
+5 -5
View File
@@ -275,11 +275,11 @@ plugin._
#### Compatibility options
| Option | Values | Description |
| --------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cache_time_info` | `{true,false}` | Compatibility option for plugins that call `audioMasterGetTime()` multiple times during a single processing cycle. With this option subsequent calls during a single audio processing cycle will reuse the value returned by the first call to this function. This is a bug in the plugin, and this option serves as a temporary workaround until the plugin fixes the issue. |
| `editor_double_embed` | `{true,false}` | Compatibility option for plugins that rely on the absolute screen coordinates of the window they're embedded in. Since the Wine window gets embedded inside of a window provided by your DAW, these coordinates won't match up and the plugin would end up drawing in the wrong location without this option. Currently the only known plugins that require this option are _PSPaudioware_ plugins with expandable GUIs, such as E27. Defaults to `false`. |
| `editor_xembed` | `{true,false}` | Use Wine's XEmbed implementation instead of yabridge's normal window embedding method. Some plugins will have redrawing issues when using XEmbed and editor resizing won't work properly with it, but it could be useful in certain setups. You may need to use [this Wine patch](https://github.com/psycha0s/airwave/blob/master/fix-xembed-wine-windows.patch) if you're getting blank editor windows. Defaults to `false`. _This option is only availble on the master branch._ |
| Option | Values | Description |
| --------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cache_time_info` | `{true,false}` | Compatibility option for plugins that call `audioMasterGetTime()` multiple times during a single processing cycle. With this option subsequent calls during a single audio processing cycle will reuse the value returned by the first call to this function. This is a bug in the plugin, and this option serves as a temporary workaround until the plugin fixes the issue. |
| `editor_double_embed` | `{true,false}` | Compatibility option for plugins that rely on the absolute screen coordinates of the window they're embedded in. Since the Wine window gets embedded inside of a window provided by your DAW, these coordinates won't match up and the plugin would end up drawing in the wrong location without this option. Currently the only known plugins that require this option are _PSPaudioware_ plugins with expandable GUIs, such as E27. Defaults to `false`. |
| `editor_xembed` | `{true,false}` | Use Wine's XEmbed implementation instead of yabridge's normal window embedding method. Some plugins will have redrawing issues when using XEmbed and editor resizing won't always work properly with it, but it could be useful in certain setups. You may need to use [this Wine patch](https://github.com/psycha0s/airwave/blob/master/fix-xembed-wine-windows.patch) if you're getting blank editor windows. Defaults to `false`. _This option is only availble on the master branch._ |
These options are workarounds for issues mentioned in the [known
issues](#runtime-dependencies-and-known-issues) section. Depending on the hosts