changeset 172:ee9d66f669d2

Merge JSON and Cap'n Proto schema

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/capnproto/piper.capnp	Fri Oct 07 15:42:12 2016 +0100
@@ -0,0 +1,198 @@
+
+@0xc4b1c6c44c999206;
+
+using Cxx = import "/capnp/c++.capnp";
+$Cxx.namespace("piper");
+
+struct Basic {
+    identifier         @0  :Text;
+    name               @1  :Text;
+    description        @2  :Text;
+}
+
+struct ParameterDescriptor {
+    basic              @0  :Basic;
+    unit               @1  :Text;
+    minValue           @2  :Float32     = 0.0;
+    maxValue           @3  :Float32     = 0.0;
+    defaultValue       @4  :Float32     = 0.0;
+    isQuantized        @5  :Bool        = false;
+    quantizeStep       @6  :Float32     = 0.0;
+    valueNames         @7  :List(Text)  = [];
+}
+
+enum SampleType {
+    oneSamplePerStep   @0;
+    fixedSampleRate    @1;
+    variableSampleRate @2;
+}
+
+struct ConfiguredOutputDescriptor {
+    unit               @0  :Text;
+    hasFixedBinCount   @1  :Bool        = false;
+    binCount           @2  :Int32       = 0;
+    binNames           @3  :List(Text)  = [];
+    hasKnownExtents    @4  :Bool        = false;
+    minValue           @5  :Float32     = 0.0;
+    maxValue           @6  :Float32     = 0.0;
+    isQuantized        @7  :Bool        = false;
+    quantizeStep       @8  :Float32     = 0.0;
+    sampleType         @9  :SampleType;
+    sampleRate         @10 :Float32     = 0.0;
+    hasDuration        @11 :Bool        = false;
+}
+
+struct OutputDescriptor {
+    basic              @0  :Basic;
+    configured         @1  :ConfiguredOutputDescriptor;
+}
+
+enum InputDomain {
+    timeDomain         @0;
+    frequencyDomain    @1;
+}
+
+struct ExtractorStaticData {
+    key                @0  :Text;
+    basic              @1  :Basic;
+    maker              @2  :Text;
+    copyright          @3  :Text;
+    version            @4  :Int32;
+    category           @5  :List(Text);
+    minChannelCount    @6  :Int32;
+    maxChannelCount    @7  :Int32;
+    parameters         @8  :List(ParameterDescriptor);
+    programs           @9  :List(Text);
+    inputDomain        @10 :InputDomain;
+    basicOutputInfo    @11 :List(Basic);
+}
+
+struct RealTime {
+    sec                @0  :Int32       = 0;
+    nsec               @1  :Int32       = 0;
+}
+
+struct ProcessInput {
+    inputBuffers       @0  :List(List(Float32));
+    timestamp          @1  :RealTime;
+}
+
+struct Feature {
+    hasTimestamp       @0  :Bool        = false;
+    timestamp          @1  :RealTime;
+    hasDuration        @2  :Bool        = false;
+    duration           @3  :RealTime;
+    label              @4  :Text;
+    featureValues      @5  :List(Float32) = [];
+}
+
+struct FeatureSet {
+    struct FSPair {
+        output         @0  :Text;
+        features       @1  :List(Feature) = [];
+    }
+    featurePairs       @0  :List(FSPair);
+}
+
+struct Configuration {
+    struct PVPair {
+        parameter      @0  :Text;
+        value          @1  :Float32;
+    }
+    parameterValues    @0  :List(PVPair);
+    currentProgram     @1  :Text;
+    channelCount       @2  :Int32;
+    stepSize           @3  :Int32;
+    blockSize          @4  :Int32;
+}
+
+enum AdapterFlag {
+    adaptInputDomain   @0;
+    adaptChannelCount  @1;
+    adaptBufferSize    @2;
+}
+
+const adaptAllSafe :List(AdapterFlag) =
+      [ adaptInputDomain, adaptChannelCount ];
+
+const adaptAll :List(AdapterFlag) =
+      [ adaptInputDomain, adaptChannelCount, adaptBufferSize ];
+
+struct ListRequest {
+}
+
+struct ListResponse {
+    available          @0  :List(ExtractorStaticData);    
+}
+
+struct LoadRequest {
+    key                @0  :Text;
+    inputSampleRate    @1  :Float32;
+    adapterFlags       @2  :List(AdapterFlag);
+}
+
+struct LoadResponse {
+    handle             @0  :Int32;
+    staticData         @1  :ExtractorStaticData;
+    defaultConfiguration @2  :Configuration;
+}
+
+struct ConfigurationRequest {
+    handle             @0  :Int32;
+    configuration      @1  :Configuration;
+}
+
+struct ConfigurationResponse {
+    handle             @0  :Int32;
+    outputs            @1  :List(OutputDescriptor);
+}
+
+struct ProcessRequest {
+    handle             @0  :Int32;
+    processInput       @1  :ProcessInput;
+}
+
+struct ProcessResponse {
+    handle             @0  :Int32;
+    features           @1  :FeatureSet;
+}
+
+struct FinishRequest {
+    handle             @0  :Int32;
+}
+
+struct FinishResponse {
+    handle             @0  :Int32;
+    features           @1  :FeatureSet;
+}
+
+struct Error {
+    code               @0  :Int32;
+    message            @1  :Text;
+}
+
+struct RpcRequest {
+    # Request bundle for use when using Cap'n Proto serialisation without
+    # Cap'n Proto RPC layer. For Cap'n Proto RPC, see piper.rpc.capnp.
+    request :union {
+	list           @0  :ListRequest;
+	load           @1  :LoadRequest;
+	configure      @2  :ConfigurationRequest;
+	process        @3  :ProcessRequest;
+	finish         @4  :FinishRequest;     # getRemainingFeatures and unload
+    }
+}
+
+struct RpcResponse {
+    # Response bundle for use when using Cap'n Proto serialisation without
+    # Cap'n Proto RPC layer. For Cap'n Proto RPC, see piper.rpc.capnp.
+    response :union {
+        error          @0  :Error;
+	list           @1  :ListResponse;
+	load           @2  :LoadResponse;
+	configure      @3  :ConfigurationResponse;
+	process        @4  :ProcessResponse;
+	finish         @5  :FinishResponse;
+    }
+}
+

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/capnproto/piper.rpc.capnp	Fri Oct 07 15:42:12 2016 +0100
@@ -0,0 +1,16 @@
+@0xbe97303b9e5b3429;
+
+using Cxx = import "/capnp/c++.capnp";
+$Cxx.namespace("piper::rpc");
+
+using P = import "piper.capnp";
+
+interface Piper {
+    # RPC interface for use when using Cap'n Proto RPC layer.
+    list       @0 (listRequest :P.ListRequest) -> (listResponse :P.ListResponse);
+    load       @1 (loadRequest :P.LoadRequest) -> (loadResponse :P.LoadResponse);
+    configure  @2 (configurationRequest :P.ConfigurationRequest) -> (configurationResponse :P.ConfigurationResponse);
+    process    @3 (processRequest :P.ProcessRequest) -> (processResponse :P.ProcessResponse);
+    finish     @4 (finishRequest :P.FinishRequest) -> (finishResponse :P.FinishResponse);
+}
+