comparison vamp-support/RequestResponse.h @ 185:3eb00e5c76c4

Pull step & block size out into framing struct, return in config

Update the C++ code to separate out the framing parameters (step and
block size) from the configuration structure into their own structure,
as in the latest schema, and to return the accepted framing params in
the configuration response.

This also implies that the plugin stub (which adapts Piper API
back to Vamp) makes a note of the returned values,
making them available via its own getPreferredStep/BlockSize
so that the host can retry the initialise call in the case where it
failed for having the wrong values first time.

  * \class ConfigurationResponse
  *
  * The return value from a configuration request (i.e. setting the
  * parameters and initialising the plugin). If the configuration was
  * successful, the output list will contain the final
- * post-initialisation output descriptors. If configuration failed,
+ * post-initialisation output descriptors and the required step and
+ * block size. (The step and block size will usually match those
+ * passed to configure, but may differ if the parameter settings
+ * turned out to be incompatible with those.) If configuration failed,
  * the output list will be empty.
  *
  * \see PluginConfiguration, ConfigurationRequest, LoadRequest, LoadResponse
  */
 struct ConfigurationResponse

     ConfigurationResponse() : // failed by default
         plugin(0) { }
 
     Vamp::Plugin *plugin;
     Vamp::Plugin::OutputList outputs;
+    Framing framing;
 };
 
 /**
  * \class ProcessRequest
  *