annotate README.md @ 181:549d3d44d729

Add top-level check script, & one in capnp, & rename json test to check
author Chris Cannam <c.cannam@qmul.ac.uk>
date Thu, 19 Jan 2017 20:24:40 +0000
parents 2a05c8380e8a
children 3bb643b45735
rev   line source
c@173 1
c@173 2 # Piper
c@173 3
c@173 4 ## A protocol for driving audio feature extractors
c@173 5
c@173 6 Piper is a protocol for audio analysis and feature extraction. That
c@173 7 is, the task of processing sampled audio data to produce descriptive
c@173 8 output (measurements or semantic observations).
c@173 9
c@173 10 Piper defines a data schema and API that can be used for remote audio
c@173 11 feature extraction services, or for feature extractors loaded directly
c@173 12 into a host application.
c@173 13
c@173 14 Piper is intended to be used
c@173 15
c@173 16 * as a programmatic interface for audio analysis and feature
c@173 17 extraction methods for web applications and servers
c@173 18
c@173 19 * to make [Vamp plugins](http://vamp-plugins.org), and feature
c@173 20 extractors written in other languages such as Javascript, available
c@173 21 through a service API or as loadable modules
c@173 22
c@173 23 The Piper schema is language- and serialisation-independent and the
c@173 24 API is transport-independent. We provide initial implementations using
c@173 25 JSON in Javascript and C++, and using Cap'n Proto in C++.
c@173 26
c@173 27 This repository contains the basic Piper schema. Implementations and
c@173 28 utilities can be found in related repositories.
c@173 29
c@173 30 ## Authors and licensing
c@173 31
c@173 32 Piper was made by Lucas Thompson and Chris Cannam at the Centre for
c@173 33 Digital Music, Queen Mary, University of London.
c@173 34
c@173 35 Copyright (c) 2015-2016 Queen Mary, University of London, provided
c@173 36 under a BSD-style licence. See the file COPYING for details.
c@173 37