cannam@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 
cannam@0: /*
cannam@0:     Vamp
cannam@0: 
cannam@0:     An API for audio analysis and feature extraction plugins.
cannam@0: 
cannam@0:     Centre for Digital Music, Queen Mary, University of London.
cannam@0:     Copyright 2006 Chris Cannam.
cannam@0:   
cannam@0:     Permission is hereby granted, free of charge, to any person
cannam@0:     obtaining a copy of this software and associated documentation
cannam@0:     files (the "Software"), to deal in the Software without
cannam@0:     restriction, including without limitation the rights to use, copy,
cannam@0:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0:     of the Software, and to permit persons to whom the Software is
cannam@0:     furnished to do so, subject to the following conditions:
cannam@0: 
cannam@0:     The above copyright notice and this permission notice shall be
cannam@0:     included in all copies or substantial portions of the Software.
cannam@0: 
cannam@0:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0:     NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR
cannam@0:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 
cannam@0:     Except as contained in this notice, the names of the Centre for
cannam@0:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0:     shall not be used in advertising or otherwise to promote the sale,
cannam@0:     use or other dealings in this Software without prior written
cannam@0:     authorization.
cannam@0: */
cannam@0: 
cannam@0: #ifndef VAMP_HEADER_INCLUDED
cannam@0: #define VAMP_HEADER_INCLUDED
cannam@0: 
cannam@0: /*
cannam@0:  * C language API for Vamp plugins.
cannam@0:  * 
cannam@0:  * This is the formal plugin API for Vamp.  Plugin authors may prefer
cannam@0:  * to use the C++ classes defined in the sdk directory, instead of
cannam@0:  * using this API directly.  There is an adapter class provided that
cannam@0:  * makes C++ plugins available using this C API with relatively little
cannam@0:  * work.  See the example plugins in the examples directory.
cannam@0:  */
cannam@0: 
cannam@0: #ifdef __cplusplus
cannam@0: extern "C" {
cannam@0: #endif
cannam@0: 
cannam@0: typedef struct _VampParameterDescriptor
cannam@0: {
cannam@0:     const char *name;
cannam@0:     const char *description;
cannam@0:     const char *unit;
cannam@0:     float minValue;
cannam@0:     float maxValue;
cannam@0:     float defaultValue;
cannam@0:     int isQuantized;
cannam@0:     float quantizeStep;
cannam@0: 
cannam@0: } VampParameterDescriptor;
cannam@0: 
cannam@0: typedef enum
cannam@0: {
cannam@0:     vampOneSamplePerStep,
cannam@0:     vampFixedSampleRate,
cannam@0:     vampVariableSampleRate
cannam@0: 
cannam@0: } VampSampleType;
cannam@0: 
cannam@0: typedef struct _VampOutputDescriptor
cannam@0: {
cannam@0:     const char *name;
cannam@0:     const char *description;
cannam@0:     const char *unit;
cannam@0:     int hasFixedValueCount;
cannam@0:     unsigned int valueCount;
cannam@0:     const char **valueNames;
cannam@0:     int hasKnownExtents;
cannam@0:     float minValue;
cannam@0:     float maxValue;
cannam@0:     int isQuantized;
cannam@0:     float quantizeStep;
cannam@0:     VampSampleType sampleType;
cannam@0:     float sampleRate;
cannam@0: 
cannam@0: } VampOutputDescriptor;
cannam@0: 
cannam@0: typedef struct _VampFeature
cannam@0: {
cannam@0:     int hasTimestamp;
cannam@0:     int sec;
cannam@0:     int nsec;
cannam@0:     unsigned int valueCount;
cannam@0:     float *values;
cannam@0:     char *label;
cannam@0: 
cannam@0: } VampFeature;
cannam@0: 
cannam@0: typedef struct _VampFeatureList
cannam@0: {
cannam@0:     unsigned int featureCount;
cannam@0:     VampFeature *features;
cannam@0: 
cannam@0: } VampFeatureList;
cannam@0: 
cannam@0: typedef enum
cannam@0: {
cannam@0:     vampTimeDomain,
cannam@0:     vampFrequencyDomain
cannam@0: 
cannam@0: } VampInputDomain;
cannam@0: 
cannam@0: typedef void *VampPluginHandle;
cannam@0: 
cannam@0: typedef struct _VampPluginDescriptor
cannam@0: {
cannam@0:     const char *name;
cannam@0:     const char *description;
cannam@0:     const char *maker;
cannam@0:     int pluginVersion;
cannam@0:     const char *copyright;
cannam@0:     unsigned int parameterCount;
cannam@0:     const VampParameterDescriptor **parameters;
cannam@0:     unsigned int programCount;
cannam@0:     const char **programs;
cannam@0:     VampInputDomain inputDomain;
cannam@0:     
cannam@0:     VampPluginHandle (*instantiate)(const struct _VampPluginDescriptor *,
cannam@0:                                    float inputSampleRate);
cannam@0: 
cannam@0:     void (*cleanup)(VampPluginHandle);
cannam@0: 
cannam@0:     int (*initialise)(VampPluginHandle,
cannam@0:                       unsigned int inputChannels,
cannam@0:                       unsigned int stepSize, 
cannam@0:                       unsigned int blockSize);
cannam@0: 
cannam@0:     void (*reset)(VampPluginHandle);
cannam@0: 
cannam@0:     float (*getParameter)(VampPluginHandle, int);
cannam@0:     void  (*setParameter)(VampPluginHandle, int, float);
cannam@0: 
cannam@0:     unsigned int (*getCurrentProgram)(VampPluginHandle);
cannam@0:     void  (*selectProgram)(VampPluginHandle, unsigned int);
cannam@0:     
cannam@0:     unsigned int (*getPreferredStepSize)(VampPluginHandle);
cannam@0:     unsigned int (*getPreferredBlockSize)(VampPluginHandle);
cannam@0:     unsigned int (*getMinChannelCount)(VampPluginHandle);
cannam@0:     unsigned int (*getMaxChannelCount)(VampPluginHandle);
cannam@0: 
cannam@0:     unsigned int (*getOutputCount)(VampPluginHandle);
cannam@0:     VampOutputDescriptor *(*getOutputDescriptor)(VampPluginHandle,
cannam@0:                                                 unsigned int);
cannam@0:     void (*releaseOutputDescriptor)(VampOutputDescriptor *);
cannam@0: 
cannam@0:     VampFeatureList **(*process)(VampPluginHandle,
cannam@0:                                 float **inputBuffers,
cannam@0:                                 int sec,
cannam@0:                                 int nsec);
cannam@0:     VampFeatureList **(*getRemainingFeatures)(VampPluginHandle);
cannam@0:     void (*releaseFeatureSet)(VampFeatureList **);
cannam@0: 
cannam@0: } VampPluginDescriptor;
cannam@0: 
cannam@0: const VampPluginDescriptor *vampGetPluginDescriptor(unsigned int index);
cannam@0: 
cannam@0: typedef const VampPluginDescriptor *(*VampGetPluginDescriptorFunction)(unsigned int);
cannam@0: 
cannam@0: #ifdef __cplusplus
cannam@0: }
cannam@0: #endif
cannam@0: 
cannam@0: #endif