Mercurial > hg > vamp-website

annotate develop.html @ 128:817c3988afc7 website tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 1982d4ba2ea3
children
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>
Chris@120 18 <li><a href="news.html">News</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@35 21 <li><a href="http://vamp-plugins.org/wiki/">Wiki</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@21 26 <p>Vamp is an easy system to develop plugins for. It has
cannam@0 27 a standard cross-platform SDK which includes API documentation,
cannam@0 28 example plugins, ready-to-use C++ base classes, the C API
cannam@0 29 header, and a test host.</p>
cannam@0 30
cannam@37 31 <p>Vamp plugins use a C binary interface for the greatest level
cannam@37 32 of binary compatibility. However, plugins and hosts are
cannam@37 33 strongly encouraged to make use of the set of C++ base classes
cannam@49 34 provided in the SDK.</p>
cannam@0 35
cannam@49 36 <p>Alternatively, you can also now make Vamp plugins in
cannam@49 37 Python using <a href="vampy.html">VamPy</a>.</p>
cannam@49 38
cannam@49 39 <h3>Developer Downloads</h3>
Chris@126 40 <ul><li>Download the <b>Vamp plugin SDK</b> (version 2.9):
cannam@0 41
Chris@58 42 <ul><br><li>The main SDK (development headers, source code, example code):
Chris@58 43 <br>
Chris@126 44 <a href="https://code.soundsoftware.ac.uk/attachments/download/2588/vamp-plugin-sdk-2.9.0.tar.gz">As a gzipped tar file</a>
Chris@58 45 or
Chris@126 46 <a href="https://code.soundsoftware.ac.uk/attachments/download/2589/vamp-plugin-sdk-2.9.0.zip">as a ZIP file</a>.
Chris@58 47 </li><br>
cannam@37 48
Chris@58 49 <li>Pre-compiled library and host binaries:
cannam@49 50
Chris@58 51 <br>
Chris@126 52 <a href="https://code.soundsoftware.ac.uk/attachments/download/2597/vamp-plugin-sdk-2.9.0-binaries-win64-msvc2017.zip">Windows (64-bit Intel x64, MSVC 2017)</a>;
Chris@126 53 <a href="https://code.soundsoftware.ac.uk/attachments/download/2593/vamp-plugin-sdk-2.9.0-binaries-macos.tar.gz">macOS (64-bit Intel)</a>;
Chris@58 54 and
Chris@126 55 <a href="https://code.soundsoftware.ac.uk/attachments/download/2590/vamp-plugin-sdk-2.9.0-binaries-amd64-linux.tar.gz">Linux (64-bit Intel)</a>.
Chris@58 56 </li><br>
cannam@0 57
Chris@126 58 <li>Example plugin binaries:
Chris@58 59 <br>
Chris@126 60 <a href="https://code.soundsoftware.ac.uk/attachments/download/2596/vamp-example-plugins-2.9.0-win64.zip">Windows (64-bit Intel x64)</a>;
Chris@126 61 <a href="https://code.soundsoftware.ac.uk/attachments/download/2592/vamp-example-plugins-2.9.0-macos.tar.gz">macOS (64-bit Intel)</a>;
Chris@126 62 <a href="https://code.soundsoftware.ac.uk/attachments/download/2591/vamp-example-plugins-2.9.0-amd64-linux.tar.gz">Linux (64-bit Intel)</a>.
Chris@58 63 </li></br>
Chris@58 64
Chris@111 65 <li><a href="https://code.soundsoftware.ac.uk/attachments/download/2200/vamp-docs-2.7.zip">Documentation bundle</a>.</li>
cannam@0 66
cannam@51 67 <li><a href="http://code.soundsoftware.ac.uk/projects/vamp">The code project</a> for the Vamp API and SDK.</li>
cannam@0 68
cannam@0 69 </ul>
cannam@0 70
cannam@0 71 <br>
cannam@0 72
Chris@110 73 <li>Download the <b>Vamp plugin tester</b>, a simple
cannam@27 74 command-line utility that tests your plugins for various common
cannam@27 75 failure cases. It can't check whether you're getting the right
cannam@27 76 results, but it can help you write better behaved and more
cannam@35 77 resilient plugins.
cannam@35 78
Chris@110 79 <ul><br><li>Download all binary and source packages <a
Chris@110 80 href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-tester/files">from the download page</a>.</li>
Chris@110 81 <li>See also the project <a
Chris@110 82 href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-tester">overview page</a>.</li>
cannam@35 83 </ul>
cannam@27 84
cannam@31 85 </ul>
cannam@31 86 <h3>Developer Documentation</h3>
cannam@31 87 <ul>
cannam@27 88
cannam@27 89 <li>Read the Vamp plugin SDK <a href="guide.pdf">Programmers
cannam@27 90 Guide</a>.</li>
cannam@0 91
cannam@37 92 <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 93
cannam@0 94 <li>Read <a href="vamp-programmer-presentation.pdf">a presentation</a> about the principles of Vamp plugins for
cannam@0 95 potential developers.</li>
cannam@0 96
Chris@87 97 <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 98
Chris@79 99 <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 100
cannam@49 101 <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 102
cannam@49 103 <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 104
cannam@21 105 <li>Read documentation for all the <a href="plugin-doc/vamp-example-plugins.html">SDK example plugins</a>.
cannam@21 106
cannam@49 107 <li><a href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk">Visit the Vamp SDK code project</a>.</li>
cannam@0 108
cannam@0 109 </ul>
cannam@0 110
cannam@0 111 <p>The entire SDK is published under a very permissive BSD-style
cannam@0 112 <a
cannam@49 113 href="https://code.soundsoftware.ac.uk/projects/vamp-plugin-sdk/repository/entry/COPYING">license</a>.
cannam@0 114 You are encouraged to copy from it wholesale, whether developing
cannam@0 115 open-source or proprietary plugin or host software.</p>
cannam@0 116
cannam@0 117 <h3>Mailing list and forum</h3>
cannam@0 118
cannam@0 119 <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 120
cannam@0 121 </body>
cannam@0 122 </html>