Mercurial > hg > vamp-website

annotate develop.html @ 27:d50fb6b58cd8 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Add note about plugin tester
author cannam
date Fri, 20 Mar 2009 16:19:23 +0000
parents d83d60afe81e
children d5c6f7674426
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html>
cannam@0 3 <head>
cannam@0 4 <link rel="stylesheet" media="screen" type="text/css" href="screen.css"/>
cannam@0 5 <link rel="icon" type="image/png" href="images/waveform.png"/>
cannam@0 6 <link rel="shortcut" type="image/png" href="images/waveform.png"/>
cannam@0 7 <title>Vamp Plugins</title>
cannam@0 8 <meta name="robots" content="index"/>
cannam@0 9 <meta name="keywords" content="vamp plugin api plugins sonic visualiser visualizer visualise visualize audio music spectrogram feature extraction feapi vsi dssi"/>
cannam@0 10 <meta name="description" content="Vamp is a system for plugins that extract feature information from audio data."/>
cannam@0 11 </head>
cannam@0 12 <body>
cannam@0 13 <h1 id="header"><span>Vamp Plugins</span></h1>
cannam@0 14
cannam@0 15 <div id="nav">
cannam@0 16 <ul>
cannam@0 17 <li class="first"><a href="index.html">Home</a></li>
cannam@0 18 <li><a href="rationale.html">Rationale</a></li>
cannam@0 19 <li><a href="download.html">Download Plugins</a></li>
cannam@0 20 <li><a href="develop.html">Make Plugins</a></li>
cannam@0 21 <li><a href="http://vamp-plugins.org/forum/">Forum</a></li>
cannam@0 22 </ul></div>
cannam@0 23
cannam@0 24 <h2 id="firstpara">Developing Vamp plugins and hosts</h2>
cannam@0 25
cannam@0 26 <p><i>Hosted by <a href="http://sourceforge.net/projects/vamp/"><img align="center"
cannam@0 27 src="http://sourceforge.net/sflogo.php?group_id=192001&type=1"
cannam@0 28 width="88" height="31" border="0" alt="SourceForge.net Logo"/></a></i></p>
cannam@0 29
cannam@21 30 <p>Vamp is an easy system to develop plugins for. It has
cannam@0 31 a standard cross-platform SDK which includes API documentation,
cannam@0 32 example plugins, ready-to-use C++ base classes, the C API
cannam@0 33 header, and a test host.</p>
cannam@0 34
cannam@0 35 <p>The formal Vamp API is defined in C for the greatest level of
cannam@0 36 binary compatibility. However, plugins and hosts are strongly
cannam@0 37 encouraged to make use of the set of C++ base classes provided.
cannam@0 38 This is particularly advisable since the values returned by a
cannam@0 39 plugin may have relatively complex structures.</p>
cannam@0 40
cannam@21 41 <ul><li>Download the Vamp plugin SDK (current version 2.0):
cannam@0 42
cannam@21 43 <ul><li>The development headers and source code: <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.0.tar.gz">Gzipped tar file</a> or <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.0.zip">ZIP file</a> (the contents are identical).</li>
cannam@0 44
cannam@22 45 <li>Pre-compiled library and host binaries for <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.0-binaries-win32-mingw32.zip">Windows (MinGW)</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.0-staticlibs-win32-msvc.zip">Windows (MSVC: static libraries only)</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.0-binaries-osx-universal.tar.gz">OS/X</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.0-binaries-i686-linux.tar.gz">32-bit Linux</a>, and <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.0-binaries-amd64-linux.tar.gz">64-bit Linux</a>.</li>
cannam@0 46
cannam@21 47 <li><a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.0-docs.tar.gz">API documentation bundle</a>.</li>
cannam@0 48
cannam@21 49 <li>Example plugin binaries for <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-win32.zip">Windows</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-osx-universal.tar.gz">OS/X</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-i686-linux.tar.gz">32-bit Linux</a>, and <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-i686-linux.tar.gz">64-bit Linux</a>.</li>
cannam@0 50
cannam@0 51 <li><a href="http://sourceforge.net/project/showfiles.php?group_id=192001&package_id=225765">The SourceForge download area</a> for any files not listed above.</li>
cannam@0 52
cannam@0 53 </ul>
cannam@0 54
cannam@0 55 <br>
cannam@0 56
cannam@27 57 <li><b>New!</b> Download the Vamp plugin tester, a simple
cannam@27 58 command-line utility that tests your plugins for various common
cannam@27 59 failure cases. It can't check whether you're getting the right
cannam@27 60 results, but it can help you write better behaved and more
cannam@27 61 resilient plugins. Get the <a
cannam@27 62 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-0.1.tar.bz2">source
cannam@27 63 code</a>, <a
cannam@27 64 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-0.1-osx-universal.tar.bz2">OS/X
cannam@27 65 universal binary</a>, or <a
cannam@27 66 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-0.1-win32.zip">Windows
cannam@27 67 binary</a> of the initial version 0.1 release.</li>
cannam@27 68
cannam@27 69 <br>
cannam@27 70
cannam@27 71 <li>Read the Vamp plugin SDK <a href="guide.pdf">Programmers
cannam@27 72 Guide</a>.</li>
cannam@0 73
cannam@0 74 <li>Read <a href="vamp-programmer-presentation.pdf">a presentation</a> about the principles of Vamp plugins for
cannam@0 75 potential developers.</li>
cannam@0 76
cannam@0 77 <li><a href="code-doc/index.html">Read the API documentation online</a>. Your plugins will normally derive from <a href="code-doc/classVamp_1_1Plugin.html">the Vamp::Plugin class</a>.</li>
cannam@0 78
cannam@0 79 <li><a href="http://vamp.svn.sourceforge.net/viewvc/vamp/vamp-plugin-sdk/trunk/README?view=markup">Read the README file for the SDK</a>.</li>
cannam@0 80
cannam@0 81 <li>Have a look at a simple example plugin: <a href="http://vamp.svn.sourceforge.net/viewvc/*checkout*/vamp/vamp-plugin-sdk/trunk/examples/ZeroCrossing.h">header</a>, <a href="http://vamp.svn.sourceforge.net/viewvc/*checkout*/vamp/vamp-plugin-sdk/trunk/examples/ZeroCrossing.cpp">source file</a>.
cannam@0 82
cannam@21 83 <li>Read documentation for all the <a href="plugin-doc/vamp-example-plugins.html">SDK example plugins</a>.
cannam@21 84
cannam@0 85 <li><a href="http://vamp.svn.sourceforge.net/viewvc/vamp/vamp-plugin-sdk/trunk/">Browse the SDK and examples code</a> in the Subversion repository.</li>
cannam@0 86
cannam@0 87 </ul>
cannam@0 88
cannam@0 89 <p>The entire SDK is published under a very permissive BSD-style
cannam@0 90 <a
cannam@0 91 href="http://vamp.svn.sourceforge.net/viewvc/vamp/vamp-plugin-sdk/trunk/COPYING">license</a>.
cannam@0 92 You are encouraged to copy from it wholesale, whether developing
cannam@0 93 open-source or proprietary plugin or host software.</p>
cannam@0 94
cannam@0 95 <h3>Mailing list and forum</h3>
cannam@0 96
cannam@0 97 <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>
cannam@0 98
cannam@0 99 </body>
cannam@0 100 </html>