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

cannam@0: cannam@0:

Developing Vamp plugins and hosts

cannam@0: cannam@0:

Hosted by

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@0:

The formal Vamp API is defined in C for the greatest level of cannam@0: binary compatibility. However, plugins and hosts are strongly cannam@0: encouraged to make use of the set of C++ base classes provided. cannam@0: This is particularly advisable since the values returned by a cannam@0: plugin may have relatively complex structures.

cannam@0: cannam@21:

Download the Vamp plugin SDK (current version 2.0): cannam@0: cannam@21:
- The development headers and source code: Gzipped tar file or ZIP file (the contents are identical).
- Pre-compiled library and host binaries for Windows (MinGW), Windows (MSVC: static libraries only), OS/X, 32-bit Linux, and 64-bit Linux.
- API documentation bundle.
- Example plugin binaries for Windows, OS/X, 32-bit Linux, and 64-bit Linux.
- The SourceForge download area for any files not listed above.
cannam@0: cannam@0:
cannam@0: cannam@0:
New! Read the Vamp plugin SDK Programmers cannam@0: Guide!
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@0:
Browse the SDK and examples code in the Subversion repository.

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: