Mercurial > hg > vamp-website

annotate develop.html @ 111:a830b8e4cba1 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for v2.7
author Chris Cannam
date Fri, 24 Feb 2017 16:50:10 +0000
parents 32977fa2c012
children 7e14f729664d
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@111 41 <ul><li>Download the <b>Vamp plugin SDK</b> (version 2.7):
cannam@0 42
Chris@58 43 <ul><br><li>The main SDK (development headers, source code, example code):
Chris@58 44 <br>
Chris@111 45 <a href="https://code.soundsoftware.ac.uk/attachments/download/2190/vamp-plugin-sdk-2.7.tar.gz">As a gzipped tar file</a>
Chris@58 46 or
Chris@111 47 <a href="https://code.soundsoftware.ac.uk/attachments/download/2191/vamp-plugin-sdk-2.7.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@111 53 <a href="https://code.soundsoftware.ac.uk/attachments/download/2196/vamp-plugin-sdk-2.7-binaries-win32-msvc.zip">Windows (32-bit Intel x86, MSVC)</a>;
Chris@111 54 <a href="https://code.soundsoftware.ac.uk/attachments/download/2195/vamp-plugin-sdk-2.7-binaries-win64-msvc.zip">Windows (64-bit Intel x64, MSVC)</a>;
Chris@111 55 <a href="https://code.soundsoftware.ac.uk/attachments/download/2198/vamp-plugin-sdk-2.7-binaries-osx.tar.gz">macOS (64-bit Intel)</a>;
Chris@111 56 <a href="https://code.soundsoftware.ac.uk/attachments/download/2192/vamp-plugin-sdk-2.7-binaries-amd64-gcc4-linux.tar.gz">Linux (64-bit Intel, gcc-4 ABI)</a>;
Chris@58 57 and
Chris@111 58 <a href="https://code.soundsoftware.ac.uk/attachments/download/2193/vamp-plugin-sdk-2.7-binaries-amd64-gcc5-linux.tar.gz">Linux (64-bit Intel, gcc-5 ABI)</a>.
Chris@58 59 </li><br>
cannam@0 60
Chris@58 61 <li>Example plugin binaries:
Chris@58 62 <br>
Chris@111 63 <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-win32.zip">Windows (32-bit Intel x86)</a>;
Chris@111 64 <a href="https://code.soundsoftware.ac.uk/attachments/download/2199/vamp-example-plugins-2.7-win64.zip">Windows (64-bit Intel x64)</a>;
Chris@111 65 <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.2.1-osx-universal.tar.gz">macOS (64-bit Intel)</a>;
Chris@111 66 <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-i686-linux.tar.gz">Linux (32-bit Intel)</a>;
Chris@111 67 <a href="http://downloads.sourceforge.net/vamp/vamp-example-plugins-2.0-amd64-linux.tar.gz">Linux (64-bit Intel)</a>.
Chris@58 68 </li></br>
Chris@58 69
Chris@111 70 <li><a href="https://code.soundsoftware.ac.uk/attachments/download/2200/vamp-docs-2.7.zip">Documentation bundle</a>.</li>
cannam@0 71
cannam@51 72 <li><a href="http://code.soundsoftware.ac.uk/projects/vamp">The code project</a> for the Vamp API and SDK.</li>
cannam@0 73
cannam@0 74 </ul>
cannam@0 75
cannam@0 76 <br>
cannam@0 77
Chris@110 78 <li>Download the <b>Vamp plugin tester</b>, a simple
cannam@27 79 command-line utility that tests your plugins for various common
cannam@27 80 failure cases. It can't check whether you're getting the right
cannam@27 81 results, but it can help you write better behaved and more
cannam@35 82 resilient plugins.
cannam@35 83
Chris@110 84 <ul><br><li>Download all binary and source packages <a
Chris@110 85 href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-tester/files">from the download page</a>.</li>
Chris@110 86 <li>See also the project <a
Chris@110 87 href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-tester">overview page</a>.</li>
cannam@35 88 </ul>
cannam@27 89
cannam@31 90 </ul>
cannam@31 91 <h3>Developer Documentation</h3>
cannam@31 92 <ul>
cannam@27 93
cannam@27 94 <li>Read the Vamp plugin SDK <a href="guide.pdf">Programmers
cannam@27 95 Guide</a>.</li>
cannam@0 96
cannam@37 97 <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 98
cannam@0 99 <li>Read <a href="vamp-programmer-presentation.pdf">a presentation</a> about the principles of Vamp plugins for
cannam@0 100 potential developers.</li>
cannam@0 101
Chris@87 102 <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 103
Chris@79 104 <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 105
cannam@49 106 <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 107
cannam@49 108 <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 109
cannam@21 110 <li>Read documentation for all the <a href="plugin-doc/vamp-example-plugins.html">SDK example plugins</a>.
cannam@21 111
cannam@49 112 <li><a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk">Visit the Vamp SDK code project</a>.</li>
cannam@0 113
cannam@0 114 </ul>
cannam@0 115
cannam@0 116 <p>The entire SDK is published under a very permissive BSD-style
cannam@0 117 <a
cannam@49 118 href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/COPYING">license</a>.
cannam@0 119 You are encouraged to copy from it wholesale, whether developing
cannam@0 120 open-source or proprietary plugin or host software.</p>
cannam@0 121
cannam@0 122 <h3>Mailing list and forum</h3>
cannam@0 123
cannam@0 124 <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 125
cannam@0 126 </body>
cannam@0 127 </html>