Mercurial > hg > vamp-website

annotate develop.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents d5c6f7674426
children b9ecf03a2bce
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@35 22 <li><a href="http://vamp-plugins.org/wiki/">Wiki</a></li>
cannam@0 23 </ul></div>
cannam@0 24
cannam@0 25 <h2 id="firstpara">Developing Vamp plugins and hosts</h2>
cannam@0 26
cannam@0 27 <p><i>Hosted by <a href="http://sourceforge.net/projects/vamp/"><img align="center"
cannam@0 28 src="http://sourceforge.net/sflogo.php?group_id=192001&type=1"
cannam@0 29 width="88" height="31" border="0" alt="SourceForge.net Logo"/></a></i></p>
cannam@0 30
cannam@21 31 <p>Vamp is an easy system to develop plugins for. It has
cannam@0 32 a standard cross-platform SDK which includes API documentation,
cannam@0 33 example plugins, ready-to-use C++ base classes, the C API
cannam@0 34 header, and a test host.</p>
cannam@0 35
cannam@0 36 <p>The formal Vamp API is defined in C for the greatest level of
cannam@0 37 binary compatibility. However, plugins and hosts are strongly
cannam@0 38 encouraged to make use of the set of C++ base classes provided.
cannam@0 39 This is particularly advisable since the values returned by a
cannam@0 40 plugin may have relatively complex structures.</p>
cannam@0 41
cannam@35 42 <ul><li>Download the <b>Vamp plugin SDK</b> (<b><i>new!</i></b> version 2.1):
cannam@0 43
cannam@35 44 <ul><li>The development headers and source code: <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1.tar.gz">Gzipped tar file</a> or <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1.zip">ZIP file</a> (the contents are identical).</li>
cannam@0 45
cannam@35 46 <li>Pre-compiled library and host binaries for <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1-binaries-win32-mingw.zip">Windows (MinGW)</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1-staticlibs-win32-msvc.zip">Windows (MSVC: static libraries only)</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1-binaries-osx-universal.tar.gz">OS/X (universal)</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1-binaries-i686-linux.tar.gz">32-bit Linux</a>, <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1-binaries-amd64-linux.tar.gz">64-bit Linux</a>, and <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1-binaries-i686-solaris.tar.gz">32-bit x86 Solaris</a>.</li>
cannam@0 47
cannam@35 48 <li><a href="http://downloads.sourceforge.net/vamp/vamp-plugin-sdk-2.1-docs.tar.gz">API documentation bundle</a>.</li>
cannam@0 49
cannam@35 50 <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>, <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-i686-linux.tar.gz">64-bit Linux</a>, and <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-i686-solaris.tar.gz">32-bit x86 Solaris</a> (these are unchanged from version 2.0).</li>
cannam@0 51
cannam@0 52 <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 53
cannam@0 54 </ul>
cannam@0 55
cannam@0 56 <br>
cannam@0 57
cannam@35 58 <li>Download the <b>Vamp plugin tester</b> (<b><i>new!</i></b> version 1.0), a simple
cannam@27 59 command-line utility that tests your plugins for various common
cannam@27 60 failure cases. It can't check whether you're getting the right
cannam@27 61 results, but it can help you write better behaved and more
cannam@35 62 resilient plugins.
cannam@35 63
cannam@35 64 <ul><li>Source code: <a
cannam@35 65 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0.tar.gz">Gzipped tar file</a>.</li>
cannam@35 66 <li>Pre-compiled binaries for <a
cannam@35 67 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-win32.zip">Windows</a>,
cannam@35 68 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-osx-universal.tar.gz">OS/X (universal)</a>,
cannam@35 69 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-i686-linux.tar.gz">32-bit Linux</a>,
cannam@35 70 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-amd64-linux.tar.gz">64-bit Linux</a>, and
cannam@35 71 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-i686-solaris.tar.gz">32-bit x86 Solaris</a>.</li>
cannam@35 72 </ul>
cannam@27 73
cannam@31 74 </ul>
cannam@31 75 <h3>Developer Documentation</h3>
cannam@31 76 <ul>
cannam@27 77
cannam@27 78 <li>Read the Vamp plugin SDK <a href="guide.pdf">Programmers
cannam@27 79 Guide</a>.</li>
cannam@0 80
cannam@35 81 <li>Read a <a href="http://vamp-plugins.org/wiki/mtp1">tutorial on building a new plugin</a> using OS/X command-line tools.</li>
cannam@35 82
cannam@0 83 <li>Read <a href="vamp-programmer-presentation.pdf">a presentation</a> about the principles of Vamp plugins for
cannam@0 84 potential developers.</li>
cannam@0 85
cannam@0 86 <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 87
cannam@0 88 <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 89
cannam@0 90 <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 91
cannam@21 92 <li>Read documentation for all the <a href="plugin-doc/vamp-example-plugins.html">SDK example plugins</a>.
cannam@21 93
cannam@0 94 <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 95
cannam@0 96 </ul>
cannam@0 97
cannam@0 98 <p>The entire SDK is published under a very permissive BSD-style
cannam@0 99 <a
cannam@0 100 href="http://vamp.svn.sourceforge.net/viewvc/vamp/vamp-plugin-sdk/trunk/COPYING">license</a>.
cannam@0 101 You are encouraged to copy from it wholesale, whether developing
cannam@0 102 open-source or proprietary plugin or host software.</p>
cannam@0 103
cannam@0 104 <h3>Mailing list and forum</h3>
cannam@0 105
cannam@0 106 <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 107
cannam@0 108 </body>
cannam@0 109 </html>