VST 3.0 plugin version of the WebSID Commodore 64 synthesizer
Switch branches/tags
Nothing to show
Clone or download

README.md

VSTSID

This is a VST3.0 plug-in version of the WebSID Commodore 64 synthesizer.

On compatibility

Build as VST 2.4

VST3.0 is great and all, but support across DAW's is poor (shout out to Bitwig Studio for being awesome). You can however build this plugin as a VST2.4 plugin and enjoy it on a wider range of host platforms. Simply uncomment the following line in CMakeLists.txt:

set(SMTG_CREATE_VST2_VERSION "Use VST2" ON)

And rename the plugin extension from .vst3 to .vst.

Note: at the moment of writing there is an issue in SDK 3.6.9 where the VST2 plugin wrapper isn't working correctly on macOS. To correct this, add the following line to "VST3_SDK/public.sdk/source/main/macexport.exp" :

_VSTPluginMain

Compiling for both 32-bit and 64-bit architectures:

Depending on your host software having 32-bit or 64-bit support, you can best compile for a wider range of architectures, to do so replace all invocations of cmake in this README with the following:

macOS:

cmake "-DCMAKE_OSX_ARCHITECTURES=x86_64;i386" ..

Windows:

cmake.exe -G"Visual Studio 15 2017 Win64" ..
cmake.exe -G"Visual Studio 15 2017 Win32" ..

Build instructions

Environment setup

The project uses CMake to generate the build system after which you can use make to build the application.

Apart from requiring CMake and a g++ compiler, the only other dependency is the VST SDK from Steinberg. Update CMakeLists.txt to point to the root of the Steinberg SDK installation location (update "VSTSDK_PATH").

Generating the Makefiles

The project has been developed against the VST 3.6.9 Audio Plug-Ins SDK on macOS and Windows 10 and should work completely via CLI without requiring either XCode or Visual Studio (for both command line/build tools suffice). Linux build system is provided, but is as yet untested.

Additionally, the Steinberg VST sources need to be built as well. Following Steinbergs guidelines, the target is a /build-subfolder of the /VST3_SDK-folder, execute the following commands from the Steinberg VST SDK root:

./copy_vst2_to_vst3_sdk.sh
cd VST3_SDK
mkdir build
cd build
cmake ..
cmake --build .

The result being that in {VSTSDK_PATH}/VST3_SDK/build/lib all Steinberg VST libraries are prebuilt. Windows users need to append --config Release to the last cmake (build) call.

Building the VSTSID plugin

Run CMake to generate VSTSID's Makefile for your environment, after which you can compile the plugin using make. The build output will be stored in ./build/VST3/vstsid.vst as well as copied to your systems VST-plugin folder.

Compling on Unix systems:

mkdir build
cd build
cmake ..
make .

Compiling on Windows:

Assuming the Visual Studio Build Tools have been installed:

mkdir build
cd build
cmake.exe -G"Visual Studio 15 2017 Win64" ..
cmake.exe --build .

Running the plugin

You can copy the build output into your system VST(3) folder and run it directly in a VST host / DAW of your choice.

When debugging, you can also choose to run the plugin against Steinbergs validator and editor host utilities:

{VSTSDK_PATH}/build/bin/validator  build/VST3/vstsid.vst3
{VSTSDK_PATH}/build/bin/editorhost build/VST3/vstsid.vst3