annotate PyPlugin.h @ 0:e20e214bdfb5

Added VAMP-Python binding project vampy
author fazekasgy
date Tue, 11 Mar 2008 19:47:34 +0000
parents
children 134313c59d82
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 /**
fazekasgy@0 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"
fazekasgy@0 43 #include "/usr/include/python/Python.h"
fazekasgy@0 44
fazekasgy@0 45 //fields in OutputDescriptor
fazekasgy@0 46 enum eOutDescriptors {
fazekasgy@0 47 not_found,
fazekasgy@0 48 identifier,
fazekasgy@0 49 name,
fazekasgy@0 50 description,
fazekasgy@0 51 unit,
fazekasgy@0 52 hasFixedBinCount,
fazekasgy@0 53 binCount,
fazekasgy@0 54 binNames,
fazekasgy@0 55 hasKnownExtents,
fazekasgy@0 56 minValue,
fazekasgy@0 57 maxValue,
fazekasgy@0 58 isQuantized,
fazekasgy@0 59 quantizeStep,
fazekasgy@0 60 sampleType,
fazekasgy@0 61 sampleRate,
fazekasgy@0 62 endNode
fazekasgy@0 63 };
fazekasgy@0 64
fazekasgy@0 65 namespace p {
fazekasgy@0 66 enum eParmDescriptors {
fazekasgy@0 67 not_found,
fazekasgy@0 68 identifier,
fazekasgy@0 69 name,
fazekasgy@0 70 description,
fazekasgy@0 71 unit,
fazekasgy@0 72 minValue,
fazekasgy@0 73 maxValue,
fazekasgy@0 74 defaultValue,
fazekasgy@0 75 isQuantized
fazekasgy@0 76 };
fazekasgy@0 77 }
fazekasgy@0 78
fazekasgy@0 79 enum eSampleTypes {
fazekasgy@0 80 OneSamplePerStep,
fazekasgy@0 81 FixedSampleRate,
fazekasgy@0 82 VariableSampleRate
fazekasgy@0 83 };
fazekasgy@0 84
fazekasgy@0 85 enum eFeatureFields {
fazekasgy@0 86 unknown,
fazekasgy@0 87 hasTimestamp,
fazekasgy@0 88 timeStamp,
fazekasgy@0 89 values,
fazekasgy@0 90 label
fazekasgy@0 91 };
fazekasgy@0 92
fazekasgy@0 93
fazekasgy@0 94 class PyPlugin : public Vamp::Plugin
fazekasgy@0 95 {
fazekasgy@0 96 public:
fazekasgy@0 97 PyPlugin(std::string plugin,float inputSampleRate, PyObject *pyInstance);
fazekasgy@0 98 virtual ~PyPlugin();
fazekasgy@0 99
fazekasgy@0 100 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
fazekasgy@0 101 void reset();
fazekasgy@0 102 //virtuals:
fazekasgy@0 103 InputDomain getInputDomain() const;
fazekasgy@0 104 size_t getPreferredBlockSize() const;
fazekasgy@0 105 size_t getPreferredStepSize() const;
fazekasgy@0 106 size_t getMinChannelCount() const;
fazekasgy@0 107 size_t getMaxChannelCount() const;
fazekasgy@0 108
fazekasgy@0 109 std::string getIdentifier() const;
fazekasgy@0 110 std::string getName() const;
fazekasgy@0 111 std::string getDescription() const;
fazekasgy@0 112 std::string getMaker() const;
fazekasgy@0 113 int getPluginVersion() const;
fazekasgy@0 114 std::string getCopyright() const;
fazekasgy@0 115
fazekasgy@0 116 OutputList getOutputDescriptors() const;
fazekasgy@0 117 ParameterList getParameterDescriptors() const;
fazekasgy@0 118 float getParameter(std::string paramid) const;
fazekasgy@0 119 void setParameter(std::string paramid, float newval);
fazekasgy@0 120
fazekasgy@0 121 FeatureSet process(const float *const *inputBuffers,
fazekasgy@0 122 Vamp::RealTime timestamp);
fazekasgy@0 123
fazekasgy@0 124 FeatureSet getRemainingFeatures();
fazekasgy@0 125
fazekasgy@0 126 protected:
fazekasgy@0 127 PyObject *m_pyInstance;
fazekasgy@0 128 size_t m_stepSize;
fazekasgy@0 129 float m_previousSample;
fazekasgy@0 130 std::string m_plugin;
fazekasgy@0 131 std::string m_class;
fazekasgy@0 132 std::string m_path;
fazekasgy@0 133 };
fazekasgy@0 134
fazekasgy@0 135
fazekasgy@0 136 #endif