9.5.6 SonicVisualiser Vamp Plugins

9.5.6.1 Instalation

Requirements:

• CMake (http://www.cmake.org/).
• SonicVisualiser (http://www.sonicvisualiser.org/).
• Vamp Plugin SDK:
  • Latest revision: $ svn co https://vamp.svn.sourceforge.net/svnroot/vamp/vamp-plugin-sdk/trunk vamp-plugin-sdk.
  • Distribution: http://sourceforge.net/projects/vamp/files/vamp-plugin-sdk/.
  • Build and install the plugin sdk using the supplied instructions.
    (vamp-simple-host, a command-line host for Vamp plugins, is installed along)
• Vamp Tester [optional]
  A command line application for testing plugins, giving you a very detailed report about the compliance of the plugin:
  • Latest revision: $ svn co https://vamp.svn.sourceforge.net/svnroot/vamp/vamp-plugin-tester/trunk vamp-plugin-tester.
  • Distribution (source + binaries): http://sourceforge.net/projects/vamp/files/vamp-plugin-tester/.
  • Add vamp-plugin-tester path to environment PATH.

MacOSX:
(Tested in 10.6 with gcc 4.2 for i386 and x86_64, linking to both the static and dynamic build of Marsyas.
Note that x86_64 is not supported by Sonic Visualiser yet, but fat binaries with both architectures work fine.)

1. Building Marsyas Vamp Plugin:
   
   • $ cmake-gui
WITH_VAMP ON;
     MARSYAS_STATIC OFF (static linking not supported)
     VAMP_LIBRARY: dynamic/static version of libvamp-sdk, from the install path -> /usr/local/lib/libvamp-sdk.dylib or /usr/local/lib/libvamp-sdk.a
VAMP_INCLUDE_DIR: vamp sdk src main path -> /usr/local/include/
     (choose your own paths if different)
   • $ make
     (If you generate an XCode project, the mvamp target won't be included so you'll need to build using plain "make")
     (vamp plugin compiled as shared dynamic library at marsyas_path/build_dir/lib/libmvamp.dylib)
2. Marsyas Vamp Plugin Integration in SonicVisualiser Transforms:
   • Copy libmvamp.dylib to one of the following paths:

                    ~/Library/Audio/Plug-Ins/Vamp (user use)
                    /Library/Audio/Plug-Ins/Vamp (system use)
     

   (mvamp-plugins.cat, in pre-compiled version or in path/to/marsyas/src/mvamp/, is a txt file for organizing the plugin functions within SonicVisualiser Transforms - for such you may also copy it to the chosen path above, yet it seems to be unnecessary)
3. (Optional) Testing Plugin with vamp-plugin-tester:
   • $ VAMP_PATH=Path/To/Vamp_Plugins_Directory
   • $ vamp-plugin-tester -a
4. (Optional) Testing Plugin with vamp-simple-host:
   • $ VAMP_PATH=Path/To/Vamp_Plugins_Directory
   • List the plugin libraries and Vamp plugins in the library search path: $ vamp-simple-host -l
   • Run the plugin: $ vamp-simple-host [-s] pluginlibrary[.dylib]:plugin file.wav [outputno] [-o out.txt]
     (check pluginlibrary and plugin name with -l above)

Linux OS:
(Tested in Linux Ubuntu 9.04-32bits with gcc 4.3 -> may work on others)

1. Building Marsyas Vamp Plugin:
   (Alternatively simply download pre-compiled plugin for Linux i686 at http://marsyas.info/download/vamp_plugins)
   • $ cmake-gui
WITH_VAMP ON;
     MARSYAS_STATIC OFF (static linking not supported)
     VAMP_LIBRARY: dynamic/static version of libvamp-sdk, from the install path -> /usr/local/lib/libvamp-sdk.so or /usr/local/lib/libvamp-sdk.a
VAMP_INCLUDE_DIR: vamp sdk src main path -> /usr/local/include/
     (choose your own paths if different)
   • $ make
     (vamp plugin compiled as shared dynamic library at marsyas_path/build/lib/libmvamp.so)
2. Marsyas Vamp Plugin Integration in SonicVisualiser Transforms:
   • Copy libmvamp.so (or pre-compiled mvamp.so) to one of the following paths:

                    /home/(user)/vamp (user use)
                    /usr/local/lib/vamp (system use)
     

   (mvamp-plugins.cat, in pre-compiled version or in path/to/marsyas/src/mvamp/, is a txt file for organizing the plugin functions within SonicVisualiser Transforms - for such you may also copy it to the chosen path above, yet it seems to be unnecessary)
3. (Optional) Testing Plugin with vamp-plugin-tester:
   • $ VAMP_PATH=Path/To/Vamp_Plugins_Directory
   • $ vamp-plugin-tester -a
4. (Optional) Testing Plugin with vamp-simple-host:
   • $ VAMP_PATH=Path/To/Vamp_Plugins_Directory
   • List the plugin libraries and Vamp plugins in the library search path: $ vamp-simple-host -l
   • Run the plugin: $ vamp-simple-host [-s] pluginlibrary[.so]:plugin file.wav [outputno] [-o out.txt]
     (check pluginlibrary and plugin name with -l above)

Windows OS:
(Tested in Windows Vista-32bists with VS2008 and Windows 7 with VS2010 -> may work on others)

1. Building Marsyas Vamp Plugin:
   
   • Run CMake-GUI:
     WITH_VAMP ON;
     MARSYAS_STATIC OFF (static linking not supported)
     VAMP_LIBRARY: static version of libvamp-sdk -> path\to\vamp-plugin-sdk-x.x\build_dir\Release\VampPluginSDK.lib
VAMP_INCLUDE_DIR: vamp sdk src main path -> path\to\vamp-plugin-sdk-x.x
     (choose your own paths if different)
   • Load marsyas_path\build\Marsyas.sln in Visual Studio
     
   • Open mvamp project proprieties:
     
     • Go to Configuration Properties -> Linker -> Command Line -> Additional options
     • Add /EXPORT:vampGetPluginDescriptor
   • Build marsyas + mvamp in Release mode and in Win32 architecture.
     (x64 not currently supported by SonicVisualiser)
2. Marsyas Vamp Plugin Integration in SonicVisualiser Transforms:
   • Copy mvamp.dll from marsyas_path\build\bin\Release\ to C:\Program Files\Vamp Plugins\ (default VAMP_PATH)
     (if used different path for Vamp Plugins define it in environment VAMP_PATH)
   • Run-time linking to Marsyas (one of the two options below):
     • Set marsyas_path\build\bin\Release\ to environment variable PATH
     • Copy marsyas.dll from marsyas_path\build\bin\Release\ to SonicVisualiser main directory.
3. (Optional) Testing Plugin with vamp-plugin-tester:
   • $ vamp-plugin-tester.exe -a
4. (Optional) Testing Plugin with vamp-simple-host:
   • List the plugin libraries and Vamp plugins in the library search path: $ vamp-simple-host.exe -l
   • Run the plugin: $ vamp-simple-host.exe [-s] pluginlibrary[.dylib]:plugin file.wav [outputno] [-o out.txt]
     (check pluginlibrary and plugin name with -l above)

9.5.6.2 Writing Plugin

Check tutorial on http://www.vamp-plugins.org/develop.html