cannam@0:
PluginHostAdapter.h

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 00002 
cannam@0: 00003 /*
cannam@0: 00004     Vamp
cannam@0: 00005 
cannam@0: 00006     An API for audio analysis and feature extraction plugins.
cannam@0: 00007 
cannam@0: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@0: 00009     Copyright 2006 Chris Cannam.
cannam@0: 00010   
cannam@0: 00011     Permission is hereby granted, free of charge, to any person
cannam@0: 00012     obtaining a copy of this software and associated documentation
cannam@0: 00013     files (the "Software"), to deal in the Software without
cannam@0: 00014     restriction, including without limitation the rights to use, copy,
cannam@0: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0: 00016     of the Software, and to permit persons to whom the Software is
cannam@0: 00017     furnished to do so, subject to the following conditions:
cannam@0: 00018 
cannam@0: 00019     The above copyright notice and this permission notice shall be
cannam@0: 00020     included in all copies or substantial portions of the Software.
cannam@0: 00021 
cannam@0: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 00029 
cannam@0: 00030     Except as contained in this notice, the names of the Centre for
cannam@0: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@0: 00033     use or other dealings in this Software without prior written
cannam@0: 00034     authorization.
cannam@0: 00035 */
cannam@0: 00036 
cannam@0: 00037 #ifndef _VAMP_PLUGIN_HOST_ADAPTER_H_
cannam@0: 00038 #define _VAMP_PLUGIN_HOST_ADAPTER_H_
cannam@0: 00039 
cannam@21: 00040 #include "hostguard.h"
cannam@21: 00041 #include "Plugin.h"
cannam@0: 00042 
cannam@21: 00043 #include <vamp/vamp.h>
cannam@0: 00044 
cannam@21: 00045 #include <vector>
cannam@0: 00046 
cannam@21: 00047 _VAMP_SDK_HOSTSPACE_BEGIN(PluginHostAdapter.h)
cannam@21: 00048 
cannam@21: 00049 namespace Vamp {
cannam@21: 00050 
cannam@21: 00068 class PluginHostAdapter : public Plugin
cannam@21: 00069 {
cannam@21: 00070 public:
cannam@21: 00071     PluginHostAdapter(const VampPluginDescriptor *descriptor,
cannam@21: 00072                       float inputSampleRate);
cannam@21: 00073     virtual ~PluginHostAdapter();
cannam@21: 00074     
cannam@21: 00075     static std::vector<std::string> getPluginPath();
cannam@21: 00076 
cannam@21: 00077     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@21: 00078     void reset();
cannam@21: 00079 
cannam@21: 00080     InputDomain getInputDomain() const;
cannam@21: 00081 
cannam@21: 00082     unsigned int getVampApiVersion() const;
cannam@21: 00083     std::string getIdentifier() const;
cannam@21: 00084     std::string getName() const;
cannam@21: 00085     std::string getDescription() const;
cannam@21: 00086     std::string getMaker() const;
cannam@21: 00087     int getPluginVersion() const;
cannam@21: 00088     std::string getCopyright() const;
cannam@0: 00089 
cannam@21: 00090     ParameterList getParameterDescriptors() const;
cannam@21: 00091     float getParameter(std::string) const;
cannam@21: 00092     void setParameter(std::string, float);
cannam@0: 00093 
cannam@21: 00094     ProgramList getPrograms() const;
cannam@21: 00095     std::string getCurrentProgram() const;
cannam@21: 00096     void selectProgram(std::string);
cannam@21: 00097 
cannam@21: 00098     size_t getPreferredStepSize() const;
cannam@21: 00099     size_t getPreferredBlockSize() const;
cannam@21: 00100 
cannam@21: 00101     size_t getMinChannelCount() const;
cannam@21: 00102     size_t getMaxChannelCount() const;
cannam@0: 00103 
cannam@21: 00104     OutputList getOutputDescriptors() const;
cannam@0: 00105 
cannam@21: 00106     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@21: 00107 
cannam@21: 00108     FeatureSet getRemainingFeatures();
cannam@21: 00109 
cannam@21: 00110 protected:
cannam@21: 00111     void convertFeatures(VampFeatureList *, FeatureSet &);
cannam@0: 00112 
cannam@21: 00113     const VampPluginDescriptor *m_descriptor;
cannam@21: 00114     VampPluginHandle m_handle;
cannam@21: 00115 };
cannam@21: 00116 
cannam@21: 00117 }
cannam@21: 00118 
cannam@21: 00119 _VAMP_SDK_HOSTSPACE_END(PluginHostAdapter.h)
cannam@21: 00120 
cannam@21: 00121 #endif
cannam@21: 00122 
cannam@21: 00123 
cannam@0: