Mercurial > hg > vamp-website

view develop.html @ 113:507cd6bc63d3 no-forum

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Toward a different layout for feedback/discussion
author Chris Cannam
date Mon, 15 Jan 2018 17:19:48 +0000
parents 7e14f729664d
children e4bb9267c009
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <link rel="stylesheet" media="screen" type="text/css" href="screen.css"/>
    <link rel="icon" type="image/png" href="images/waveform.png"/>
    <link rel="shortcut" type="image/png" href="images/waveform.png"/>
    <title>Vamp Plugins</title>
    <meta name="robots" content="index"/>
    <meta name="keywords" content="vamp plugin api plugins sonic visualiser visualizer visualise visualize audio music spectrogram feature extraction feapi vsi dssi"/>
    <meta name="description" content="Vamp is a system for plugins that extract feature information from audio data."/>
  </head>
  <body>
      <h1 id="header"><span>Vamp Plugins</span></h1>

      <div id="nav">
      <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <li><a href="rationale.html">Rationale</a></li>
      <li><a href="download.html">Download Plugins</a></li>
      <li><a href="develop.html">Make Plugins</a></li>
      <li><a href="http://vamp-plugins.org/forum/">Forum</a></li>
      <li><a href="http://vamp-plugins.org/wiki/">Wiki</a></li>
      </ul></div>

      <h2 id="firstpara">Developing Vamp plugins and hosts</h2>

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

      <p>Vamp plugins use a C binary interface for the greatest level
      of binary compatibility.  However, plugins and hosts are
      strongly encouraged to make use of the set of C++ base classes
      provided in the SDK.</p>

      <p>Alternatively, you can also now make Vamp plugins in
      Python using <a href="vampy.html">VamPy</a>.</p>

      <h3>Developer Downloads</h3>
      <ul><li>Download the <b>Vamp plugin SDK</b> (version 2.7.1):

      <ul><br><li>The main SDK (development headers, source code, example code):
<br>
<a href="https://code.soundsoftware.ac.uk/attachments/download/2206/vamp-plugin-sdk-2.7.1.tar.gz">As a gzipped tar file</a>
or
<a href="https://code.soundsoftware.ac.uk/attachments/download/2207/vamp-plugin-sdk-2.7.1.zip">as a ZIP file</a>.
</li><br>

      <li>Pre-compiled library and host binaries:

<br>
<a href="https://code.soundsoftware.ac.uk/attachments/download/2211/vamp-plugin-sdk-2.7.1-binaries-win32-msvc.zip">Windows (32-bit Intel x86, MSVC)</a>;
<a href="https://code.soundsoftware.ac.uk/attachments/download/2212/vamp-plugin-sdk-2.7.1-binaries-win64-msvc.zip">Windows (64-bit Intel x64, MSVC)</a>;
<a href="https://code.soundsoftware.ac.uk/attachments/download/2210/vamp-plugin-sdk-2.7.1-binaries-osx.tar.gz">macOS (64-bit Intel)</a>;
<a href="https://code.soundsoftware.ac.uk/attachments/download/2208/vamp-plugin-sdk-2.7.1-binaries-amd64-gcc4-linux.tar.gz">Linux (64-bit Intel, gcc-4 ABI)</a>;
and
<a href="https://code.soundsoftware.ac.uk/attachments/download/2209/vamp-plugin-sdk-2.7.1-binaries-amd64-gcc5-linux.tar.gz">Linux (64-bit Intel, gcc-5 ABI)</a>.
</li><br>

      <li>Example plugin binaries: <i>(unchanged since version 2.0)</i>
<br>
<a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-win32.zip">Windows (32-bit Intel x86)</a>;
<a href="https://code.soundsoftware.ac.uk/attachments/download/2199/vamp-example-plugins-2.7-win64.zip">Windows (64-bit Intel x64)</a>;
<a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.2.1-osx-universal.tar.gz">macOS (64-bit Intel)</a>;
<a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-i686-linux.tar.gz">Linux (32-bit Intel)</a>;
<a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-amd64-linux.tar.gz">Linux (64-bit Intel)</a>.
</li></br>

      <li><a href="https://code.soundsoftware.ac.uk/attachments/download/2200/vamp-docs-2.7.zip">Documentation bundle</a>.</li>

      <li><a href="http://code.soundsoftware.ac.uk/projects/vamp">The code project</a> for the Vamp API and SDK.</li>

      </ul>

      <br>

      <li>Download the <b>Vamp plugin tester</b>, a simple
      command-line utility that tests your plugins for various common
      failure cases.  It can't check whether you're getting the right
      results, but it can help you write better behaved and more
      resilient plugins.

      <ul><br><li>Download all binary and source packages <a
      href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-tester/files">from the download page</a>.</li>
      <li>See also the project <a
      href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-tester">overview page</a>.</li>
      </ul>

      </ul>
      <h3>Developer Documentation</h3>
      <ul>

      <li>Read the Vamp plugin SDK <a href="guide.pdf">Programmers
      Guide</a>.</li>

      <li>Read a tutorial on building a new plugin: <a href="http://vamp-plugins.org/wiki/mtp1">using OS/X command-line tools</a> or <a href="http://vamp-plugins.org/wiki/mtp2">using Visual C++ on Windows</a>.</li>

      <li>Read <a href="vamp-programmer-presentation.pdf">a presentation</a> about the principles of Vamp plugins for
      potential developers.</li>

      <li>Read the <a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/wiki/SampleType">detailed docs about SampleType and SampleRate</a> properties of a plugin's outputs.</li>

      <li><a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/embedded/">Read the API documentation online</a>.  Your plugins will normally derive from <a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/embedded/classVamp_1_1Plugin.html">the Vamp::Plugin class</a>.</li>

      <li><a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/README">Read the README file for the SDK</a>.</li>

      <li>Have a look at a simple example plugin: <a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/examples/ZeroCrossing.h">header</a>, <a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/examples/ZeroCrossing.cpp">source file</a>.

      <li>Read documentation for all the <a href="plugin-doc/vamp-example-plugins.html">SDK example plugins</a>.

      <li><a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk">Visit the Vamp SDK code project</a>.</li>

      </ul>

      <p>The entire SDK is published under a very permissive BSD-style
      <a
      href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/COPYING">license</a>.
      You are encouraged to copy from it wholesale, whether developing
      open-source or proprietary plugin or host software.</p>

      <h3>Mailing list and forum</h3>

      <p>Vamp plugin and host development may be discussed on the <a href="http://sourceforge.net/mail/?group_id=192001">vamp-devel list</a> and the <a href="http://vamp-plugins.org/forum/">Vamp plugins forum</a>.</p>

    </body>
</html>