changeset 173:2a05c8380e8a

README
author Chris Cannam <c.cannam@qmul.ac.uk>
date Fri, 07 Oct 2016 15:55:51 +0100
parents ee9d66f669d2
children eac8b499c018
files COPYING README.md
diffstat 2 files changed, 38 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/COPYING	Fri Oct 07 15:42:12 2016 +0100
+++ b/COPYING	Fri Oct 07 15:55:51 2016 +0100
@@ -1,5 +1,5 @@
 
-    Vamp JSON Schema
+    Piper
     Copyright (c) 2015-2016 Queen Mary, University of London
 
     Permission is hereby granted, free of charge, to any person
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Fri Oct 07 15:55:51 2016 +0100
@@ -0,0 +1,37 @@
+
+# Piper
+
+## A protocol for driving audio feature extractors
+
+Piper is a protocol for audio analysis and feature extraction. That
+is, the task of processing sampled audio data to produce descriptive
+output (measurements or semantic observations).
+
+Piper defines a data schema and API that can be used for remote audio
+feature extraction services, or for feature extractors loaded directly
+into a host application.
+
+Piper is intended to be used
+
+ * as a programmatic interface for audio analysis and feature
+   extraction methods for web applications and servers
+ 
+ * to make [Vamp plugins](http://vamp-plugins.org), and feature
+   extractors written in other languages such as Javascript, available
+   through a service API or as loadable modules
+
+The Piper schema is language- and serialisation-independent and the
+API is transport-independent. We provide initial implementations using
+JSON in Javascript and C++, and using Cap'n Proto in C++.
+
+This repository contains the basic Piper schema. Implementations and
+utilities can be found in related repositories.
+
+## Authors and licensing
+
+Piper was made by Lucas Thompson and Chris Cannam at the Centre for
+Digital Music, Queen Mary, University of London.
+
+Copyright (c) 2015-2016 Queen Mary, University of London, provided
+under a BSD-style licence. See the file COPYING for details.
+