changeset 199:01700726e02e

Copyright -> rights, and document
author Chris Cannam <cannam@all-day-breakfast.com>
date Fri, 10 Feb 2017 17:12:48 +0000
parents ab7f270ae453
children 4635c5c2c4fc
files capnp/piper.capnp json/examples/extractorstaticdata.json json/schema/extractorstaticdata.json
diffstat 3 files changed, 6 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/capnp/piper.capnp	Fri Feb 10 14:41:43 2017 +0000
+++ b/capnp/piper.capnp	Fri Feb 10 17:12:48 2017 +0000
@@ -90,12 +90,12 @@
     # Static properties of a feature extractor. That is, metadata about the
     # extractor that are the same regardless of how you configure or run it.
 
-    key                @0  :Text;                 # Composed string that identifies the extractor among all extractors (see docs).
+    key                @0  :Text;                 # String that "globally" identifies the extractor, used to load it (see docs).
     basic              @1  :Basic;                # Basic metadata about the extractor.
     maker              @2  :Text;                 # Human-readable text naming the author or vendor of the extractor.
-    copyright          @3  :Text;                 # ???name + review
-    version            @4  :Int32;                # Version number of extractor; must increase if new algorithm changes outputs.
-    category           @5  :List(Text);           # ???name + review
+    rights             @3  :Text;                 # Human-readable summary of copyright and/or licensing terms for the extractor.
+    version            @4  :Int32;                # Version number of extractor; must increase if new algorithm changes results.
+    category           @5  :List(Text);           # List of general->specific category labels for this extractor (see docs).
     minChannelCount    @6  :Int32;                # Minimum number of input channels of audio this extractor can accept.
     maxChannelCount    @7  :Int32;                # Maximum number of input channels of audio this extractor can accept.
     parameters         @8  :List(ParameterDescriptor);    # List of configurable parameter properties for the feature extractor.
--- a/json/examples/extractorstaticdata.json	Fri Feb 10 14:41:43 2017 +0000
+++ b/json/examples/extractorstaticdata.json	Fri Feb 10 17:12:48 2017 +0000
@@ -1,1 +1,1 @@
-{"basic": {"description": "Detect percussive note onsets by identifying broadband energy rises", "identifier": "percussiononsets", "name": "Simple Percussion Onset Detector"}, "basicOutputInfo": [{"description": "Percussive note onset locations", "identifier": "onsets", "name": "Onsets"}, {"description": "Broadband energy rise detection function", "identifier": "detectionfunction", "name": "Detection Function"}], "category": ["Time", "Onsets"], "copyright": "Code copyright 2006 Queen Mary, University of London, after Dan Barry et al 2005.  Freely redistributable (BSD license)", "inputDomain": "FrequencyDomain", "key": "vamp-example-plugins:percussiononsets", "maker": "Vamp SDK Example Plugins", "maxChannelCount": 1, "minChannelCount": 1, "parameters": [{"basic": {"description": "Energy rise within a frequency bin necessary to count toward broadband total", "identifier": "threshold", "name": "Energy rise threshold"}, "defaultValue": 3, "extents": {"max": 20, "min": 0}, "unit": "dB", "valueNames": []}, {"basic": {"description": "Sensitivity of peak detector applied to broadband detection function", "identifier": "sensitivity", "name": "Sensitivity"}, "defaultValue": 40, "extents": {"max": 100, "min": 0}, "unit": "%", "valueNames": []}], "programs": [], "version": 2}
+{"basic": {"description": "Detect percussive note onsets by identifying broadband energy rises", "identifier": "percussiononsets", "name": "Simple Percussion Onset Detector"}, "basicOutputInfo": [{"description": "Percussive note onset locations", "identifier": "onsets", "name": "Onsets"}, {"description": "Broadband energy rise detection function", "identifier": "detectionfunction", "name": "Detection Function"}], "category": ["Time", "Onsets"], "rights": "Code copyright 2006 Queen Mary, University of London, after Dan Barry et al 2005.  Freely redistributable (BSD license)", "inputDomain": "FrequencyDomain", "key": "vamp-example-plugins:percussiononsets", "maker": "Vamp SDK Example Plugins", "maxChannelCount": 1, "minChannelCount": 1, "parameters": [{"basic": {"description": "Energy rise within a frequency bin necessary to count toward broadband total", "identifier": "threshold", "name": "Energy rise threshold"}, "defaultValue": 3, "extents": {"max": 20, "min": 0}, "unit": "dB", "valueNames": []}, {"basic": {"description": "Sensitivity of peak detector applied to broadband detection function", "identifier": "sensitivity", "name": "Sensitivity"}, "defaultValue": 40, "extents": {"max": 100, "min": 0}, "unit": "%", "valueNames": []}], "programs": [], "version": 2}
--- a/json/schema/extractorstaticdata.json	Fri Feb 10 14:41:43 2017 +0000
+++ b/json/schema/extractorstaticdata.json	Fri Feb 10 17:12:48 2017 +0000
@@ -13,7 +13,7 @@
 	"maker": {
 	    "type": "string"
 	},
-	"copyright": {
+	"rights": {
 	    "type": "string"
 	},
 	"version": {