Mercurial > hg > piper-cpp
annotate README.md @ 217:d06300b789ea
Name, defensive comment
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Wed, 22 Feb 2017 11:02:36 +0000 |
| parents | 8dff3213f77c |
| children | 02de5df3a884 |
| rev | line source |
|---|---|
| cannam@162 | 1 |
| cannam@217 | 2 # Piper Vamp C++ |
| cannam@162 | 3 |
| cannam@162 | 4 Supporting code in C++ for the Piper audio feature extractor protocol, |
| cannam@162 | 5 primarily for making Vamp plugins work with the Piper protocol. |
| cannam@162 | 6 |
| cannam@217 | 7 _This is pre-1.0 code and the API may change at any time_ |
| cannam@217 | 8 |
| cannam@165 | 9 ## Contents |
| cannam@162 | 10 |
| cannam@162 | 11 * code to adapt Piper messages to the classes used in the Vamp SDK |
| cannam@215 | 12 * a command-line converter between Piper serialisations that goes |
| cannam@215 | 13 via Vamp SDK classes |
| cannam@162 | 14 * a server that makes Vamp plugins available via Piper messages |
| cannam@162 | 15 |
| cannam@165 | 16 ## Directory index |
| cannam@162 | 17 |
| cannam@164 | 18 *vamp-json* - convert between Piper JSON messages and Vamp SDK classes |
| cannam@162 | 19 |
| cannam@164 | 20 *vamp-capnp* - convert between Piper Cap'n Proto messages and Vamp |
| cannam@164 | 21 abstractions |
| cannam@162 | 22 |
| cannam@164 | 23 *vamp-support* - support classes for the above |
| cannam@162 | 24 |
| cannam@164 | 25 *vamp-server* - main programs for command-line converter and server |
| cannam@162 | 26 |
| cannam@164 | 27 *vamp-client* - logic to make Piper servers available to Vamp hosts |
| cannam@164 | 28 through a Vamp-like API |
| cannam@162 | 29 |
| cannam@164 | 30 *vamp-client/qt* - logic specific to hosts written with Qt |
| cannam@162 | 31 |
| cannam@166 | 32 *ext* - json11 and base-n third-party libraries: see individual |
| cannam@166 | 33 directories for copyright details |
| cannam@166 | 34 |
| cannam@215 | 35 [](https://travis-ci.org/piper-audio/piper-vamp-cpp) |
| cannam@162 | 36 |
| cannam@162 | 37 ## Authors and licensing |
| cannam@162 | 38 |
| cannam@204 | 39 Written by Chris Cannam and Lucas Thompson at the Centre for Digital |
| cannam@204 | 40 Music, Queen Mary, University of London. |
| cannam@162 | 41 |
| cannam@162 | 42 Copyright (c) 2015-2017 Queen Mary, University of London, provided |
| cannam@162 | 43 under a BSD-style licence. See the file COPYING for details. |
| cannam@162 | 44 |