Piper

The basic Piper schema is now in "shipping" state: it may be extended

in future, but always in ways that retain compatibility with existing

systems.

struct StaticOutputDescriptor {

    # Properties of an output, that is, a single stream of features

    # produced in response to process and finish requests. A feature

    # extractor may have any number of outputs, and it always

    # calculates and returns features from all of them when

    # processing; this is useful in cases where more than one feature

    # can be easily calculated using a single method.

    # 

    # This structure contains the properties of an output that are

    # static, i.e. that do not depend on the parameter values provided

    # at configuration, excluding the Basic struct parameters like id

    # and description.  The Basic struct properties are not included

    # for historical reasons: they were already referenced separately

    # in the OutputDescriptor and ExtractorStaticData before this

    # struct was introduced.

    typeURI            @0  :Text;                 # URI indicating the sort of feature that this output returns (see docs).

}

    # All the properties of an output, both static (the basic metadata and static

    # descriptor) and potentially dependent on configuration parameters (the

    # configured descriptor).

    static             @2  :StaticOutputDescriptor;        # Properties (other than Basic) that do not depend on parameters.

    struct SOPair {

        # A mapping between output identifier and static descriptor for

	# that output.

        output         @0  :Text;                 # Output id, matching the output's descriptor's basic identifier.

        static         @1  :StaticOutputDescriptor;

    }

    staticOutputInfo   @12 :List(SOPair);         # Static descriptors for all outputs that have any static metadata.

{"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": [], "staticOutputInfo": {"onsets": {"typeURI": "http://purl.org/ontology/af/Onset"}, "detectionfunction": {"typeURI": "http://purl.org/ontology/af/OnsetDetectionFunction"}}, "version": 2}

{"typeURI": "http://purl.org/ontology/af/OnsetDetectionFunction"}

	},

        "staticOutputInfo": {

            "type": "object",

            "patternProperties": {

                "^[a-zA-Z0-9_-]+$": {

                    "$ref": "http://vamp-plugins.org/piper/json/schema/staticoutputdescriptor#"

                }

            }

        }

{

  "id": "http://vamp-plugins.org/piper/json/schema/staticoutputdescriptor#",

  "$schema": "http://json-schema.org/draft-04/schema#",

  "description": "schema for any additional static metadata fields (besides the basic metadata) of an output descriptor belonging to a feature extractor",

  "type": "object",

  "properties": {

  "typeURI": {

    "type": "string"

  }

  },

  "additionalProperties": false

}