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