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