c@118: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
c@118: /*
c@118:   Piper C++
c@118: 
c@118:   An API for audio analysis and feature extraction plugins.
c@118: 
c@118:   Centre for Digital Music, Queen Mary, University of London.
c@118:   Copyright 2006-2016 Chris Cannam and QMUL.
c@118:   
c@118:   Permission is hereby granted, free of charge, to any person
c@118:   obtaining a copy of this software and associated documentation
c@118:   files (the "Software"), to deal in the Software without
c@118:   restriction, including without limitation the rights to use, copy,
c@118:   modify, merge, publish, distribute, sublicense, and/or sell copies
c@118:   of the Software, and to permit persons to whom the Software is
c@118:   furnished to do so, subject to the following conditions:
c@118: 
c@118:   The above copyright notice and this permission notice shall be
c@118:   included in all copies or substantial portions of the Software.
c@118: 
c@118:   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
c@118:   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
c@118:   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
c@118:   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
c@118:   ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
c@118:   CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
c@118:   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
c@118: 
c@118:   Except as contained in this notice, the names of the Centre for
c@118:   Digital Music; Queen Mary, University of London; and Chris Cannam
c@118:   shall not be used in advertising or otherwise to promote the sale,
c@118:   use or other dealings in this Software without prior written
c@118:   authorization.
c@118: */
c@94: 
c@94: #ifndef PIPER_PLUGIN_CLIENT_H
c@94: #define PIPER_PLUGIN_CLIENT_H
c@94: 
c@97: #include "vamp-support/PluginConfiguration.h"
c@94: 
c@97: namespace piper_vamp {
c@97: namespace client {
c@94: 
cannam@208: class PiperVampPlugin;
c@94: 
cannam@187: /**
cannam@187:  * Interface for a client that accepts Vamp-like structures (Plugin
cannam@187:  * and the classes in vamp-support) and communicates with a Piper
cannam@187:  * server, using some serialisation and transport defined by the
cannam@187:  * specific implementation.
cannam@187:  */
c@94: class PluginClient
c@94: {
c@94: public:
cannam@292:     virtual ~PluginClient() { }
cannam@292:     
c@94:     virtual
cannam@185:     ConfigurationResponse
cannam@208:     configure(PiperVampPlugin *plugin,
c@97:               PluginConfiguration config) = 0;
c@94:     
c@94:     virtual
c@94:     Vamp::Plugin::FeatureSet
cannam@208:     process(PiperVampPlugin *plugin,
c@94:             std::vector<std::vector<float> > inputBuffers,
c@94:             Vamp::RealTime timestamp) = 0;
c@94: 
c@94:     virtual
c@94:     Vamp::Plugin::FeatureSet
cannam@208:     finish(PiperVampPlugin *plugin) = 0;
c@94: 
c@94:     virtual
c@94:     void
cannam@210:     reset(PiperVampPlugin *plugin,
cannam@187:           PluginConfiguration config) = 0;
c@94: };
c@94: 
c@94: }
c@94: }
c@94: 
c@94: #endif