cannam@99: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@99: 
cannam@99: /*
cannam@99:     Vamp
cannam@99: 
cannam@99:     An API for audio analysis and feature extraction plugins.
cannam@99: 
cannam@99:     Centre for Digital Music, Queen Mary, University of London.
cannam@99:     Copyright 2006 Chris Cannam.
cannam@99:   
cannam@99:     Permission is hereby granted, free of charge, to any person
cannam@99:     obtaining a copy of this software and associated documentation
cannam@99:     files (the "Software"), to deal in the Software without
cannam@99:     restriction, including without limitation the rights to use, copy,
cannam@99:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@99:     of the Software, and to permit persons to whom the Software is
cannam@99:     furnished to do so, subject to the following conditions:
cannam@99: 
cannam@99:     The above copyright notice and this permission notice shall be
cannam@99:     included in all copies or substantial portions of the Software.
cannam@99: 
cannam@99:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@99:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@99:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@99:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@99:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@99:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@99:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@99: 
cannam@99:     Except as contained in this notice, the names of the Centre for
cannam@99:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@99:     shall not be used in advertising or otherwise to promote the sale,
cannam@99:     use or other dealings in this Software without prior written
cannam@99:     authorization.
cannam@99: */
cannam@99: 
cannam@99: #ifndef _VAMP_PLUGIN_HOST_ADAPTER_H_
cannam@99: #define _VAMP_PLUGIN_HOST_ADAPTER_H_
cannam@99: 
cannam@99: #include "hostguard.h"
cannam@99: #include "Plugin.h"
cannam@99: 
cannam@99: #include <vamp/vamp.h>
cannam@99: 
cannam@99: #include <vector>
cannam@99: 
cannam@99: _VAMP_SDK_HOSTSPACE_BEGIN(PluginHostAdapter.h)
cannam@99: 
cannam@99: namespace Vamp {
cannam@99: 
cannam@99: /**
cannam@99:  * \class PluginHostAdapter PluginHostAdapter.h <vamp-hostsdk/PluginHostAdapter.h>
cannam@99:  * 
cannam@99:  * PluginHostAdapter is a wrapper class that a Vamp host can use to
cannam@99:  * make the C-language VampPluginDescriptor object appear as a C++
cannam@99:  * Vamp::Plugin object.
cannam@99:  *
cannam@99:  * The Vamp API is defined in vamp/vamp.h as a C API.  The C++ objects
cannam@99:  * used for convenience by plugins and hosts actually communicate
cannam@99:  * using the C low-level API, but the details of this communication
cannam@99:  * are handled seamlessly by the Vamp SDK implementation provided the
cannam@99:  * plugin and host use the proper C++ wrapper objects.
cannam@99:  *
cannam@99:  * See also PluginAdapter, the plugin-side wrapper that makes a C++
cannam@99:  * plugin object available using the C query API.
cannam@99:  */
cannam@99: 
cannam@99: class PluginHostAdapter : public Plugin
cannam@99: {
cannam@99: public:
cannam@99:     PluginHostAdapter(const VampPluginDescriptor *descriptor,
cannam@99:                       float inputSampleRate);
cannam@99:     virtual ~PluginHostAdapter();
cannam@99:     
cannam@99:     static std::vector<std::string> getPluginPath();
cannam@99: 
cannam@99:     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@99:     void reset();
cannam@99: 
cannam@99:     InputDomain getInputDomain() const;
cannam@99: 
cannam@99:     unsigned int getVampApiVersion() const;
cannam@99:     std::string getIdentifier() const;
cannam@99:     std::string getName() const;
cannam@99:     std::string getDescription() const;
cannam@99:     std::string getMaker() const;
cannam@99:     int getPluginVersion() const;
cannam@99:     std::string getCopyright() const;
cannam@99: 
cannam@99:     ParameterList getParameterDescriptors() const;
cannam@99:     float getParameter(std::string) const;
cannam@99:     void setParameter(std::string, float);
cannam@99: 
cannam@99:     ProgramList getPrograms() const;
cannam@99:     std::string getCurrentProgram() const;
cannam@99:     void selectProgram(std::string);
cannam@99: 
cannam@99:     size_t getPreferredStepSize() const;
cannam@99:     size_t getPreferredBlockSize() const;
cannam@99: 
cannam@99:     size_t getMinChannelCount() const;
cannam@99:     size_t getMaxChannelCount() const;
cannam@99: 
cannam@99:     OutputList getOutputDescriptors() const;
cannam@99: 
cannam@99:     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@99: 
cannam@99:     FeatureSet getRemainingFeatures();
cannam@99: 
cannam@99: protected:
cannam@99:     void convertFeatures(VampFeatureList *, FeatureSet &);
cannam@99: 
cannam@99:     const VampPluginDescriptor *m_descriptor;
cannam@99:     VampPluginHandle m_handle;
cannam@99: };
cannam@99: 
cannam@99: }
cannam@99: 
cannam@99: _VAMP_SDK_HOSTSPACE_END(PluginHostAdapter.h)
cannam@99: 
cannam@99: #endif
cannam@99: 
cannam@99: