Mercurial > hg > vamp-website

annotate develop.html @ 51:be4e9fed3f96 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.3
author cannam
date Thu, 24 Nov 2011 14:18:47 +0000
parents f75f330aa130
children 6730097a22e6
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@21 27 <p>Vamp is an easy system to develop plugins for. It has
cannam@0 28 a standard cross-platform SDK which includes API documentation,
cannam@0 29 example plugins, ready-to-use C++ base classes, the C API
cannam@0 30 header, and a test host.</p>
cannam@0 31
cannam@37 32 <p>Vamp plugins use a C binary interface for the greatest level
cannam@37 33 of binary compatibility. However, plugins and hosts are
cannam@37 34 strongly encouraged to make use of the set of C++ base classes
cannam@49 35 provided in the SDK.</p>
cannam@0 36
cannam@49 37 <p>Alternatively, you can also now make Vamp plugins in
cannam@49 38 Python using <a href="vampy.html">VamPy</a>.</p>
cannam@49 39
cannam@49 40 <h3>Developer Downloads</h3>
cannam@51 41 <ul><li>Download the <b>Vamp plugin SDK</b> (version 2.3):
cannam@0 42
cannam@51 43 <ul><br><li>The main SDK (development headers, source code, example code):<br><a href="http://code.soundsoftware.ac.uk/attachments/download/224/vamp-plugin-sdk-2.3.tar.gz">As a gzipped tar file</a> or <a href="http://code.soundsoftware.ac.uk/attachments/download/225/vamp-plugin-sdk-2.3.zip">as a ZIP file</a>.</li><br>
cannam@37 44
cannam@51 45 <li>Pre-compiled library and host binaries:<br><a href="http://code.soundsoftware.ac.uk/attachments/download/227/vamp-plugin-sdk-2.3-binaries-win32-mingw.zip">Windows (MinGW)</a>, <a href="http://code.soundsoftware.ac.uk/attachments/download/228/vamp-plugin-sdk-2.3-staticlibs-win32-msvc.zip">Windows (MSVC: static libraries only)</a>, <a href="http://code.soundsoftware.ac.uk/attachments/download/226/vamp-plugin-sdk-2.3-binaries-osx-universal.tar.gz">OS/X (32/64 bit Intel universal)</a>, <a href="http://code.soundsoftware.ac.uk/attachments/download/222/vamp-plugin-sdk-2.3-binaries-i686-linux.tar.gz">32-bit Linux</a>, and <a href="http://code.soundsoftware.ac.uk/attachments/download/223/vamp-plugin-sdk-2.3-binaries-amd64-linux.tar.gz">64-bit Linux</a></li><br>
cannam@49 46
cannam@49 47 <li>Example plugin binaries:<br><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.2.1-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></br>
cannam@0 48
cannam@51 49 <li><a href="http://code.soundsoftware.ac.uk/attachments/download/187/vamp-docs-2.3.zip">Documentation bundle</a>.</li>
cannam@0 50
cannam@51 51 <li><a href="http://code.soundsoftware.ac.uk/projects/vamp">The code project</a> for the Vamp API and SDK.</li>
cannam@0 52
cannam@0 53 </ul>
cannam@0 54
cannam@0 55 <br>
cannam@0 56
cannam@49 57 <li>Download the <b>Vamp plugin tester</b> (version 1.0), 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@35 61 resilient plugins.
cannam@35 62
cannam@49 63 <ul><br><li>Source code: <a
cannam@49 64 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0.tar.gz">Gzipped tar file</a>.</li><br>
cannam@35 65 <li>Pre-compiled binaries for <a
cannam@35 66 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-win32.zip">Windows</a>,
cannam@35 67 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-osx-universal.tar.gz">OS/X (universal)</a>,
cannam@35 68 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-i686-linux.tar.gz">32-bit Linux</a>,
cannam@35 69 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-amd64-linux.tar.gz">64-bit Linux</a>, and
cannam@35 70 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-i686-solaris.tar.gz">32-bit x86 Solaris</a>.</li>
cannam@35 71 </ul>
cannam@27 72
cannam@31 73 </ul>
cannam@31 74 <h3>Developer Documentation</h3>
cannam@31 75 <ul>
cannam@27 76
cannam@27 77 <li>Read the Vamp plugin SDK <a href="guide.pdf">Programmers
cannam@27 78 Guide</a>.</li>
cannam@0 79
cannam@37 80 <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>
cannam@35 81
cannam@0 82 <li>Read <a href="vamp-programmer-presentation.pdf">a presentation</a> about the principles of Vamp plugins for
cannam@0 83 potential developers.</li>
cannam@0 84
cannam@49 85 <li><a href="https://code.soundsoftware.ac.uk/embedded/vamp-plugin-sdk/">Read the API documentation online</a>. Your plugins will normally derive from <a href="https://code.soundsoftware.ac.uk/embedded/vamp-plugin-sdk/classVamp_1_1Plugin.html">the Vamp::Plugin class</a>.</li>
cannam@0 86
cannam@49 87 <li><a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/README">Read the README file for the SDK</a>.</li>
cannam@0 88
cannam@49 89 <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>.
cannam@0 90
cannam@21 91 <li>Read documentation for all the <a href="plugin-doc/vamp-example-plugins.html">SDK example plugins</a>.
cannam@21 92
cannam@49 93 <li><a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk">Visit the Vamp SDK code project</a>.</li>
cannam@0 94
cannam@0 95 </ul>
cannam@0 96
cannam@0 97 <p>The entire SDK is published under a very permissive BSD-style
cannam@0 98 <a
cannam@49 99 href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/COPYING">license</a>.
cannam@0 100 You are encouraged to copy from it wholesale, whether developing
cannam@0 101 open-source or proprietary plugin or host software.</p>
cannam@0 102
cannam@0 103 <h3>Mailing list and forum</h3>
cannam@0 104
cannam@0 105 <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 106
cannam@0 107 </body>
cannam@0 108 </html>