Mercurial > hg > piper

annotate README.md @ 216:72a3b8faba89 tip master

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
programParameters should not have a pattern enforced on its keys - a program name can be anything
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 08 Apr 2020 14:57:24 +0100
parents 0a482ae2525f
children
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@184 28 utilities can be found in neighbouring repositories.
c@173 29
cannam@206 30 The basic Piper schema is now in "shipping" state: it may be extended
cannam@206 31 in future, but always in ways that retain compatibility with existing
cannam@206 32 systems.
cannam@204 33
cannam@190 34 [![Build Status](https://travis-ci.org/piper-audio/piper.svg?branch=master)](https://travis-ci.org/piper-audio/piper)
cannam@190 35
c@173 36 ## Authors and licensing
c@173 37
c@173 38 Piper was made by Lucas Thompson and Chris Cannam at the Centre for
c@173 39 Digital Music, Queen Mary, University of London.
c@173 40
c@184 41 Copyright (c) 2015-2017 Queen Mary, University of London, provided
c@173 42 under a BSD-style licence. See the file COPYING for details.
c@173 43