3c430ef1ed66/code-docs/PluginAdapter_8h_source.html

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@1: 00002
Chris@1: 00003 /*
Chris@1: 00004     Vamp
Chris@1: 00005
Chris@1: 00006     An API for audio analysis and feature extraction plugins.
Chris@1: 00007
Chris@1: 00008     Centre for Digital Music, Queen Mary, University of London.
Chris@1: 00009     Copyright 2006 Chris Cannam.
Chris@1: 00010
Chris@1: 00011     Permission is hereby granted, free of charge, to any person
Chris@1: 00012     obtaining a copy of this software and associated documentation
Chris@1: 00013     files (the "Software"), to deal in the Software without
Chris@1: 00014     restriction, including without limitation the rights to use, copy,
Chris@1: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@1: 00016     of the Software, and to permit persons to whom the Software is
Chris@1: 00017     furnished to do so, subject to the following conditions:
Chris@1: 00018
Chris@1: 00019     The above copyright notice and this permission notice shall be
Chris@1: 00020     included in all copies or substantial portions of the Software.
Chris@1: 00021
Chris@1: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@1: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@1: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@1: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@1: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@1: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@1: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@1: 00029
Chris@1: 00030     Except as contained in this notice, the names of the Centre for
Chris@1: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
Chris@1: 00032     shall not be used in advertising or otherwise to promote the sale,
Chris@1: 00033     use or other dealings in this Software without prior written
Chris@1: 00034     authorization.
Chris@1: 00035 */
Chris@1: 00036
Chris@1: 00037 #ifndef _VAMP_PLUGIN_ADAPTER_H_
Chris@1: 00038 #define _VAMP_PLUGIN_ADAPTER_H_
Chris@1: 00039
Chris@1: 00040 #include <map>
Chris@1: 00041 #include <vamp/vamp.h>
Chris@1: 00042
Chris@1: 00043 #include "Plugin.h"
Chris@1: 00044
Chris@1: 00045 #include "plugguard.h"
Chris@1: 00046 _VAMP_SDK_PLUGSPACE_BEGIN(PluginAdapter.h)
Chris@1: 00047
Chris@1: 00048 namespace Vamp {
Chris@1: 00049
Chris@1: 00065 class PluginAdapterBase
Chris@1: 00066 {
Chris@1: 00067 public:
Chris@1: 00068     virtual ~PluginAdapterBase();
Chris@1: 00069
Chris@1: 00074     const VampPluginDescriptor *getDescriptor();
Chris@1: 00075
Chris@1: 00076 protected:
Chris@1: 00077     PluginAdapterBase();
Chris@1: 00078
Chris@1: 00079     virtual Plugin *createPlugin(float inputSampleRate) = 0;
Chris@1: 00080
Chris@1: 00081     class Impl;
Chris@1: 00082     Impl *m_impl;
Chris@1: 00083 };
Chris@1: 00084
Chris@1: 00094 template <typename P>
Chris@1: 00095 class PluginAdapter : public PluginAdapterBase
Chris@1: 00096 {
Chris@1: 00097 public:
Chris@1: 00098     PluginAdapter() : PluginAdapterBase() { }
Chris@1: 00099     virtual ~PluginAdapter() { }
Chris@1: 00100
Chris@1: 00101 protected:
Chris@1: 00102     Plugin *createPlugin(float inputSampleRate) {
Chris@1: 00103         P *p = new P(inputSampleRate);
Chris@1: 00104         Plugin *plugin = dynamic_cast<Plugin *>(p);
Chris@1: 00105         if (!plugin) {
Chris@1: 00106             std::cerr << "ERROR: PluginAdapter::createPlugin: "
Chris@1: 00107                       << "Template type is not a plugin!"
Chris@1: 00108                       << std::endl;
Chris@1: 00109             delete p;
Chris@1: 00110             return 0;
Chris@1: 00111         }
Chris@1: 00112         return plugin;
Chris@1: 00113     }
Chris@1: 00114 };
Chris@1: 00115
Chris@1: 00116 }
Chris@1: 00117
Chris@1: 00118 _VAMP_SDK_PLUGSPACE_END(PluginAdapter.h)
Chris@1: 00119
Chris@1: 00120 #endif
Chris@1: 00121
Chris@1: