Mercurial > hg > piper-vamp-js
annotate README.md @ 158:dcd4bdf095e7
Update example builds with output metadata
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Wed, 14 Jun 2017 11:36:13 +0100 |
| parents | bc181392fc7f |
| children | 577e5e55cc21 |
| rev | line source |
|---|---|
| cannam@147 | 1 |
| cannam@147 | 2 # Piper Vamp Javascript and JSON Adapter |
| cannam@147 | 3 |
| cannam@147 | 4 Compile your C++ Vamp plugin code into a Javascript module that |
| cannam@147 | 5 exports the Piper JSON protocol, for use with Javascript code that |
| cannam@147 | 6 uses Piper audio feature extractors. |
| cannam@147 | 7 |
| cannam@149 | 8 _This is pre-1.0 code and the API may change at any time_ |
| cannam@149 | 9 |
| cannam@147 | 10 ## What this repository contains |
| cannam@147 | 11 |
| cannam@147 | 12 * Adapter code to make a Vamp plugin library into a module that |
| cannam@147 | 13 exports request-handling functions for the Piper protocol's JSON |
| cannam@147 | 14 serialisation. This code is in C++ and can be compiled to a native |
| cannam@147 | 15 shared library or to Javascript with Emscripten. |
| cannam@147 | 16 |
| cannam@147 | 17 * Examples of usage with Vamp plugin code, found in the |
| cannam@147 | 18 examples/vamp-example-plugins and examples/vamp-test-plugin |
| cannam@147 | 19 directories. |
| cannam@147 | 20 |
| cannam@147 | 21 ## Authors and licensing |
| cannam@147 | 22 |
| cannam@147 | 23 Written by Chris Cannam and Lucas Thompson at the Centre for Digital |
| cannam@147 | 24 Music, Queen Mary, University of London. |
| cannam@147 | 25 |
| cannam@147 | 26 Copyright (c) 2015-2017 Queen Mary, University of London, provided |
| cannam@147 | 27 under a BSD-style licence. See the file COPYING for details. |
| cannam@147 | 28 |