cannam@97: 
cannam@97: The Vamp Plugin SDK -- Platform Notes for Visual C++ on Windows
cannam@97: ===============================================================
cannam@97: 
cannam@97: Visual C++ Project Files
cannam@97: ------------------------
cannam@97: 
cannam@97: Three Visual C++ project files are included with the SDK:
cannam@97: 
cannam@97:  - build/VampPluginSDK.vcproj
cannam@97: 
cannam@97:    This builds the plugin SDK into a single static library, but does
cannam@97:    not build the example plugins, the host SDK, or the host.  (We
cannam@97:    recommend using static linkage for the SDK rather than distributing
cannam@97:    it as a DLL, particularly when building plugins.)
cannam@97: 
cannam@97:  - build/VampHostSDK.vcproj
cannam@97: 
cannam@97:    This builds the host SDK into a single static library, but does not
cannam@97:    build the plugin SDK, example plugins, or host.
cannam@97: 
cannam@97:  - build/VampExamplePlugins.vcproj
cannam@97: 
cannam@97:    This builds the example plugins DLL, but does not build the plugin
cannam@97:    or host SDKs or the host.  You don't need to build the plugin SDK
cannam@97:    before this, because this project simply includes the plugin SDK
cannam@97:    files rather than using the library.
cannam@97: 
cannam@97: Of course, when using Visual Studio or another IDE to build a plugin
cannam@97: or host using the SDK, you may simply add the .h and .cpp files in the
cannam@97: vamp-sdk or vamp-hostsdk directories to your existing project.  This
cannam@97: is the approach taken in the VampExamplePlugins project.
cannam@97: 
cannam@97: As the command-line host has additional library dependencies (namely
cannam@97: libsndfile), no pre-packaged project is included to build it.
cannam@97: 
cannam@97: 
cannam@97: Installing the Example Plugins
cannam@97: ------------------------------
cannam@97: 
cannam@97: To install the example plugins so you can load them in Vamp hosts,
cannam@97: copy the files
cannam@97: 
cannam@97:    build\release\vamp-example-plugins.dll
cannam@97: and
cannam@97:    examples\vamp-example-plugins.cat
cannam@97: 
cannam@97: to
cannam@97: 
cannam@97:    C:\Program Files\Vamp Plugins
cannam@97: 
cannam@97: 
cannam@97: Plugin Linkage
cannam@97: --------------
cannam@97: 
cannam@97: Vamp plugins are distributed as dynamic libraries (DLLs).  A properly
cannam@97: packaged Vamp plugin DLL should export exactly one public symbol,
cannam@97: namely the Vamp API entry point vampGetPluginDescriptor.
cannam@97: 
cannam@97: One nice tidy way to achieve this with Visual Studio is to add the
cannam@97: linker option /EXPORT:vampGetPluginDescriptor to your project.  (All
cannam@97: of the other symbols will be properly hidden, because that is the
cannam@97: default for the Visual Studio linker.)  The included example plugins
cannam@97: project in build/VampExamplePlugins.vcproj does this.
cannam@97: 
cannam@97: Alternatively, you may modify vamp/vamp.h to add the
cannam@97: __declspec(dllexport) attribute to the vampGetPluginDescriptor
cannam@97: declaration.  This is not present by default, because it isn't
cannam@97: portable and, as we only want one symbol exported, the above linker
cannam@97: option works equally well without code changes.
cannam@97: 
cannam@97: (If you don't take at least one of these actions, your plugin library
cannam@97: simply will not load in any host.)
cannam@97: 
cannam@97: 
cannam@97: Using MinGW/Cygwin
cannam@97: ------------------
cannam@97: 
cannam@97: Refer to README.linux for build instructions using the GNU toolchain.
cannam@97: 
cannam@97: 
cannam@97: Test Your Plugins
cannam@97: -----------------
cannam@97: 
cannam@97: The Vamp Plugin Tester is a vital utility which you can use to test
cannam@97: your plugins for common problems.  It can help you if you're having
cannam@97: problems getting your plugin to work at all, and you're strongly
cannam@97: advised to use it before you release anything.  Download it from the
cannam@97: Vamp plugins site now!
cannam@97: