annotate PyPlugin.h @ 9:d2d36e7d2276

more examples and some bug fixes
author fazekasgy
date Fri, 13 Jun 2008 16:52:59 +0000
parents a4c955e9a70b
children e9cf443b18f5
rev   line source
fazekasgy@0 1 /*
fazekasgy@0 2 Vamp
fazekasgy@0 3
fazekasgy@0 4 An API for audio analysis and feature extraction plugins.
fazekasgy@0 5
fazekasgy@0 6 Centre for Digital Music, Queen Mary, University of London.
fazekasgy@0 7 Copyright 2006 Chris Cannam.
fazekasgy@0 8
fazekasgy@0 9 Permission is hereby granted, free of charge, to any person
fazekasgy@0 10 obtaining a copy of this software and associated documentation
fazekasgy@0 11 files (the "Software"), to deal in the Software without
fazekasgy@0 12 restriction, including without limitation the rights to use, copy,
fazekasgy@0 13 modify, merge, publish, distribute, sublicense, and/or sell copies
fazekasgy@0 14 of the Software, and to permit persons to whom the Software is
fazekasgy@0 15 furnished to do so, subject to the following conditions:
fazekasgy@0 16
fazekasgy@0 17 The above copyright notice and this permission notice shall be
fazekasgy@0 18 included in all copies or substantial portions of the Software.
fazekasgy@0 19
fazekasgy@0 20 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
fazekasgy@0 21 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
fazekasgy@0 22 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
fazekasgy@0 23 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
fazekasgy@0 24 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
fazekasgy@0 25 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
fazekasgy@0 26 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
fazekasgy@0 27
fazekasgy@0 28 Except as contained in this notice, the names of the Centre for
fazekasgy@0 29 Digital Music; Queen Mary, University of London; and Chris Cannam
fazekasgy@0 30 shall not be used in advertising or otherwise to promote the sale,
fazekasgy@0 31 use or other dealings in this Software without prior written
fazekasgy@0 32 authorization.
fazekasgy@0 33 */
fazekasgy@0 34
fazekasgy@0 35 /**
cannam@7 36 * This plugin abstracts appropriate Python Scripts as a Vamp plugin.
fazekasgy@0 37 */
fazekasgy@0 38
fazekasgy@0 39 #ifndef _PYTHON_WRAPPER_PLUGIN_H_
fazekasgy@0 40 #define _PYTHON_WRAPPER_PLUGIN_H_
fazekasgy@0 41
fazekasgy@0 42 #include "vamp-sdk/Plugin.h"
cannam@3 43 #include <Python.h>
cannam@3 44
cannam@3 45 #include "Mutex.h"
fazekasgy@0 46
fazekasgy@0 47 //fields in OutputDescriptor
fazekasgy@0 48 enum eOutDescriptors {
fazekasgy@0 49 not_found,
fazekasgy@0 50 identifier,
fazekasgy@0 51 name,
fazekasgy@0 52 description,
fazekasgy@0 53 unit,
fazekasgy@0 54 hasFixedBinCount,
fazekasgy@0 55 binCount,
fazekasgy@0 56 binNames,
fazekasgy@0 57 hasKnownExtents,
fazekasgy@0 58 minValue,
fazekasgy@0 59 maxValue,
fazekasgy@0 60 isQuantized,
fazekasgy@0 61 quantizeStep,
fazekasgy@0 62 sampleType,
fazekasgy@0 63 sampleRate,
fazekasgy@0 64 endNode
fazekasgy@0 65 };
fazekasgy@0 66
fazekasgy@0 67 namespace p {
fazekasgy@0 68 enum eParmDescriptors {
fazekasgy@0 69 not_found,
fazekasgy@0 70 identifier,
fazekasgy@0 71 name,
fazekasgy@0 72 description,
fazekasgy@0 73 unit,
fazekasgy@0 74 minValue,
fazekasgy@0 75 maxValue,
fazekasgy@0 76 defaultValue,
fazekasgy@0 77 isQuantized
fazekasgy@0 78 };
fazekasgy@0 79 }
fazekasgy@0 80
fazekasgy@0 81 enum eSampleTypes {
fazekasgy@0 82 OneSamplePerStep,
fazekasgy@0 83 FixedSampleRate,
fazekasgy@0 84 VariableSampleRate
fazekasgy@0 85 };
fazekasgy@0 86
fazekasgy@0 87 enum eFeatureFields {
fazekasgy@0 88 unknown,
fazekasgy@0 89 hasTimestamp,
fazekasgy@0 90 timeStamp,
fazekasgy@0 91 values,
fazekasgy@0 92 label
fazekasgy@0 93 };
fazekasgy@0 94
fazekasgy@6 95 enum eProcessType {
fazekasgy@6 96 not_implemented,
fazekasgy@6 97 legacyProcess,
fazekasgy@6 98 numpyProcess
fazekasgy@6 99 };
fazekasgy@0 100
fazekasgy@0 101 class PyPlugin : public Vamp::Plugin
fazekasgy@0 102 {
fazekasgy@0 103 public:
fazekasgy@0 104 PyPlugin(std::string plugin,float inputSampleRate, PyObject *pyInstance);
fazekasgy@0 105 virtual ~PyPlugin();
fazekasgy@0 106
fazekasgy@0 107 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
fazekasgy@0 108 void reset();
fazekasgy@6 109
fazekasgy@0 110 InputDomain getInputDomain() const;
fazekasgy@0 111 size_t getPreferredBlockSize() const;
fazekasgy@0 112 size_t getPreferredStepSize() const;
fazekasgy@0 113 size_t getMinChannelCount() const;
fazekasgy@0 114 size_t getMaxChannelCount() const;
fazekasgy@0 115
fazekasgy@0 116 std::string getIdentifier() const;
fazekasgy@0 117 std::string getName() const;
fazekasgy@0 118 std::string getDescription() const;
fazekasgy@0 119 std::string getMaker() const;
fazekasgy@0 120 int getPluginVersion() const;
fazekasgy@0 121 std::string getCopyright() const;
fazekasgy@0 122
fazekasgy@0 123 OutputList getOutputDescriptors() const;
fazekasgy@0 124 ParameterList getParameterDescriptors() const;
fazekasgy@0 125 float getParameter(std::string paramid) const;
fazekasgy@0 126 void setParameter(std::string paramid, float newval);
fazekasgy@0 127
fazekasgy@0 128 FeatureSet process(const float *const *inputBuffers,
fazekasgy@0 129 Vamp::RealTime timestamp);
fazekasgy@0 130
fazekasgy@0 131 FeatureSet getRemainingFeatures();
fazekasgy@0 132
fazekasgy@0 133 protected:
fazekasgy@0 134 PyObject *m_pyInstance;
fazekasgy@0 135 size_t m_stepSize;
fazekasgy@6 136 size_t m_blockSize;
fazekasgy@6 137 size_t m_channels;
fazekasgy@0 138 std::string m_plugin;
fazekasgy@0 139 std::string m_class;
fazekasgy@0 140 std::string m_path;
fazekasgy@6 141 int m_processType;
fazekasgy@6 142 PyObject *m_pyProcess;
fazekasgy@6 143 InputDomain m_inputDomain;
fazekasgy@6 144
fazekasgy@6 145 bool initMaps() const;
fazekasgy@6 146 std::vector<std::string> PyList_To_StringVector (PyObject *inputList) const;
fazekasgy@6 147 std::vector<float> PyList_As_FloatVector (PyObject *inputList) const;
cannam@3 148
cannam@3 149 static Mutex m_pythonInterpreterMutex;
fazekasgy@0 150 };
fazekasgy@0 151
fazekasgy@0 152
fazekasgy@0 153 #endif