Vamp Plugins

cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: Vamp Plugins cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:

cannam@0:

Home
Rationale
Download Plugins
Make Plugins
Forum
Wiki

cannam@0: cannam@0:

Developing Vamp plugins and hosts

cannam@0: cannam@21:

Vamp is an easy system to develop plugins for. It has cannam@0: a standard cross-platform SDK which includes API documentation, cannam@0: example plugins, ready-to-use C++ base classes, the C API cannam@0: header, and a test host.

cannam@0: cannam@37:

Vamp plugins use a C binary interface for the greatest level cannam@37: of binary compatibility. However, plugins and hosts are cannam@37: strongly encouraged to make use of the set of C++ base classes cannam@49: provided in the SDK.

cannam@0: cannam@49:

Alternatively, you can also now make Vamp plugins in cannam@49: Python using VamPy.

cannam@49: cannam@49:

Developer Downloads

Chris@74:

Download the Vamp plugin SDK (version 2.5): cannam@0: Chris@58:
- The main SDK (development headers, source code, example code): Chris@58:
  Chris@74: As a gzipped tar file Chris@58: or Chris@74: as a ZIP file. Chris@58:
- Pre-compiled library and host binaries: cannam@49: Chris@58:
  Chris@74: Windows (MinGW), Chris@74: Windows (MSVC: static libraries only), Chris@74: OS/X (32/64 bit Intel universal), Chris@75: 32-bit Linux, Chris@58: and Chris@75: 64-bit Linux Chris@58:
- Example plugin binaries: Chris@58:
  Chris@58: Windows, Chris@58: OS/X, Chris@58: 32-bit Linux, Chris@58: 64-bit Linux, Chris@58: and Chris@58: 32-bit x86 Solaris (these are unchanged from version 2.0). Chris@58:
- Documentation bundle.
- The code project for the Vamp API and SDK.
cannam@0: cannam@0:
cannam@0: cannam@49:
Download the Vamp plugin tester (version 1.0), a simple cannam@27: command-line utility that tests your plugins for various common cannam@27: failure cases. It can't check whether you're getting the right cannam@27: results, but it can help you write better behaved and more cannam@35: resilient plugins. cannam@35: cannam@49:
- Source code: Gzipped tar file.
- Pre-compiled binaries for Windows, cannam@35: OS/X (universal), cannam@35: 32-bit Linux, cannam@35: 64-bit Linux, and cannam@35: 32-bit x86 Solaris.
cannam@27: cannam@31:

cannam@31:

Developer Documentation

cannam@31:

Read the Vamp plugin SDK Programmers cannam@27: Guide.
Read a tutorial on building a new plugin: using OS/X command-line tools or using Visual C++ on Windows.
Read a presentation about the principles of Vamp plugins for cannam@0: potential developers.
Read the API documentation online. Your plugins will normally derive from the Vamp::Plugin class.
Read the README file for the SDK.
Have a look at a simple example plugin: header, source file. cannam@0: cannam@21:
Read documentation for all the SDK example plugins. cannam@21: cannam@49:
Visit the Vamp SDK code project.

cannam@0: cannam@0:

The entire SDK is published under a very permissive BSD-style cannam@0: license. cannam@0: You are encouraged to copy from it wholesale, whether developing cannam@0: open-source or proprietary plugin or host software.

cannam@0: cannam@0:

Mailing list and forum

cannam@0: cannam@0:

Vamp plugin and host development may be discussed on the vamp-devel list and the Vamp plugins forum.

cannam@0: cannam@0: cannam@0: