Mercurial > hg > vamp-website

annotate develop.html @ 101:bb33b0c75481 rdfquery

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Remove download.html (now dynamic)
author Chris Cannam
date Tue, 24 Jun 2014 13:32:30 +0100
parents df86d318892b
children 1e97656caa8d
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>
Chris@74 41 <ul><li>Download the <b>Vamp plugin SDK</b> (version 2.5):
cannam@0 42
Chris@58 43 <ul><br><li>The main SDK (development headers, source code, example code):
Chris@58 44 <br>
Chris@74 45 <a href="http://code.soundsoftware.ac.uk/attachments/download/690/vamp-plugin-sdk-2.5.tar.gz">As a gzipped tar file</a>
Chris@58 46 or
Chris@74 47 <a href="http://code.soundsoftware.ac.uk/attachments/download/691/vamp-plugin-sdk-2.5.zip">as a ZIP file</a>.
Chris@58 48 </li><br>
cannam@37 49
Chris@58 50 <li>Pre-compiled library and host binaries:
cannam@49 51
Chris@58 52 <br>
Chris@74 53 <a href="http://code.soundsoftware.ac.uk/attachments/download/694/vamp-plugin-sdk-2.5-binaries-win32-mingw.zip">Windows (MinGW)</a>,
Chris@74 54 <a href="http://code.soundsoftware.ac.uk/attachments/download/695/vamp-plugin-sdk-2.5-staticlibs-win32-msvc.zip">Windows (MSVC: static libraries only)</a>,
Chris@74 55 <a href="http://code.soundsoftware.ac.uk/attachments/download/693/vamp-plugin-sdk-2.5-binaries-osx.tar.gz">OS/X (32/64 bit Intel universal)</a>,
Chris@75 56 <a href="http://code.soundsoftware.ac.uk/attachments/download/704/vamp-plugin-sdk-2.5-binaries-i686-linux.tar.gz">32-bit Linux</a>,
Chris@58 57 and
Chris@75 58 <a href="http://code.soundsoftware.ac.uk/attachments/download/703/vamp-plugin-sdk-2.5-binaries-amd64-linux.tar.gz">64-bit Linux</a>
Chris@58 59 </li><br>
cannam@0 60
Chris@58 61 <li>Example plugin binaries:
Chris@58 62 <br>
Chris@58 63 <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-win32.zip">Windows</a>,
Chris@58 64 <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.2.1-osx-universal.tar.gz">OS/X</a>,
Chris@58 65 <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-i686-linux.tar.gz">32-bit Linux</a>,
Chris@58 66 <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-i686-linux.tar.gz">64-bit Linux</a>,
Chris@58 67 and
Chris@58 68 <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).
Chris@58 69 </li></br>
Chris@58 70
Chris@58 71 <li><a href="http://code.soundsoftware.ac.uk/attachments/download/531/vamp-docs-2.4.zip">Documentation bundle</a>.</li>
cannam@0 72
cannam@51 73 <li><a href="http://code.soundsoftware.ac.uk/projects/vamp">The code project</a> for the Vamp API and SDK.</li>
cannam@0 74
cannam@0 75 </ul>
cannam@0 76
cannam@0 77 <br>
cannam@0 78
cannam@49 79 <li>Download the <b>Vamp plugin tester</b> (version 1.0), a simple
cannam@27 80 command-line utility that tests your plugins for various common
cannam@27 81 failure cases. It can't check whether you're getting the right
cannam@27 82 results, but it can help you write better behaved and more
cannam@35 83 resilient plugins.
cannam@35 84
cannam@49 85 <ul><br><li>Source code: <a
cannam@49 86 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0.tar.gz">Gzipped tar file</a>.</li><br>
cannam@35 87 <li>Pre-compiled binaries for <a
cannam@35 88 href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-win32.zip">Windows</a>,
cannam@35 89 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-osx-universal.tar.gz">OS/X (universal)</a>,
cannam@35 90 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-i686-linux.tar.gz">32-bit Linux</a>,
cannam@35 91 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-amd64-linux.tar.gz">64-bit Linux</a>, and
cannam@35 92 <a href="http://downloads.sourceforge.net/vamp/vamp-plugin-tester-1.0-i686-solaris.tar.gz">32-bit x86 Solaris</a>.</li>
cannam@35 93 </ul>
cannam@27 94
cannam@31 95 </ul>
cannam@31 96 <h3>Developer Documentation</h3>
cannam@31 97 <ul>
cannam@27 98
cannam@27 99 <li>Read the Vamp plugin SDK <a href="guide.pdf">Programmers
cannam@27 100 Guide</a>.</li>
cannam@0 101
cannam@37 102 <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 103
cannam@0 104 <li>Read <a href="vamp-programmer-presentation.pdf">a presentation</a> about the principles of Vamp plugins for
cannam@0 105 potential developers.</li>
cannam@0 106
Chris@87 107 <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>
Chris@87 108
Chris@79 109 <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>
cannam@0 110
cannam@49 111 <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 112
cannam@49 113 <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 114
cannam@21 115 <li>Read documentation for all the <a href="plugin-doc/vamp-example-plugins.html">SDK example plugins</a>.
cannam@21 116
cannam@49 117 <li><a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk">Visit the Vamp SDK code project</a>.</li>
cannam@0 118
cannam@0 119 </ul>
cannam@0 120
cannam@0 121 <p>The entire SDK is published under a very permissive BSD-style
cannam@0 122 <a
cannam@49 123 href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/COPYING">license</a>.
cannam@0 124 You are encouraged to copy from it wholesale, whether developing
cannam@0 125 open-source or proprietary plugin or host software.</p>
cannam@0 126
cannam@0 127 <h3>Mailing list and forum</h3>
cannam@0 128
cannam@0 129 <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 130
cannam@0 131 </body>
cannam@0 132 </html>