cannam@21:
PluginSummarisingAdapter.h

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@21: 00002 
cannam@21: 00003 /*
cannam@21: 00004     Vamp
cannam@21: 00005 
cannam@21: 00006     An API for audio analysis and feature extraction plugins.
cannam@21: 00007 
cannam@21: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@21: 00009     Copyright 2006-2008 Chris Cannam and QMUL.
cannam@21: 00010   
cannam@21: 00011     Permission is hereby granted, free of charge, to any person
cannam@21: 00012     obtaining a copy of this software and associated documentation
cannam@21: 00013     files (the "Software"), to deal in the Software without
cannam@21: 00014     restriction, including without limitation the rights to use, copy,
cannam@21: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@21: 00016     of the Software, and to permit persons to whom the Software is
cannam@21: 00017     furnished to do so, subject to the following conditions:
cannam@21: 00018 
cannam@21: 00019     The above copyright notice and this permission notice shall be
cannam@21: 00020     included in all copies or substantial portions of the Software.
cannam@21: 00021 
cannam@21: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@21: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@21: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@21: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@21: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@21: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@21: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@21: 00029 
cannam@21: 00030     Except as contained in this notice, the names of the Centre for
cannam@21: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@21: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@21: 00033     use or other dealings in this Software without prior written
cannam@21: 00034     authorization.
cannam@21: 00035 */
cannam@21: 00036 
cannam@21: 00037 #ifndef _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_
cannam@21: 00038 #define _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_
cannam@21: 00039 
cannam@21: 00040 #include "hostguard.h"
cannam@21: 00041 #include "PluginWrapper.h"
cannam@21: 00042 
cannam@21: 00043 #include <set>
cannam@21: 00044 
cannam@21: 00045 _VAMP_SDK_HOSTSPACE_BEGIN(PluginSummarisingAdapter.h)
cannam@21: 00046 
cannam@21: 00047 namespace Vamp {
cannam@21: 00048 
cannam@21: 00049 namespace HostExt {
cannam@21: 00050 
cannam@21: 00086 class PluginSummarisingAdapter : public PluginWrapper
cannam@21: 00087 {
cannam@21: 00088 public:
cannam@21: 00094     PluginSummarisingAdapter(Plugin *plugin); 
cannam@21: 00095     virtual ~PluginSummarisingAdapter();
cannam@21: 00096 
cannam@21: 00097     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@21: 00098 
cannam@21: 00099     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@21: 00100     FeatureSet getRemainingFeatures();
cannam@21: 00101 
cannam@21: 00102     typedef std::set<RealTime> SegmentBoundaries;
cannam@21: 00103 
cannam@21: 00117     void setSummarySegmentBoundaries(const SegmentBoundaries &);
cannam@21: 00118 
cannam@21: 00119     enum SummaryType {
cannam@21: 00120         Minimum            = 0,
cannam@21: 00121         Maximum            = 1,
cannam@21: 00122         Mean               = 2,
cannam@21: 00123         Median             = 3,
cannam@21: 00124         Mode               = 4,
cannam@21: 00125         Sum                = 5,
cannam@21: 00126         Variance           = 6,
cannam@21: 00127         StandardDeviation  = 7,
cannam@21: 00128         Count              = 8,
cannam@21: 00129 
cannam@21: 00130         UnknownSummaryType = 999
cannam@21: 00131     };
cannam@21: 00132 
cannam@21: 00155     enum AveragingMethod {
cannam@21: 00156         SampleAverage         = 0,
cannam@21: 00157         ContinuousTimeAverage = 1,
cannam@21: 00158     };
cannam@21: 00159 
cannam@21: 00168     FeatureList getSummaryForOutput(int output,
cannam@21: 00169                                     SummaryType type,
cannam@21: 00170                                     AveragingMethod method = SampleAverage);
cannam@21: 00171 
cannam@21: 00181     FeatureSet getSummaryForAllOutputs(SummaryType type,
cannam@21: 00182                                        AveragingMethod method = SampleAverage);
cannam@21: 00183 
cannam@21: 00184 protected:
cannam@21: 00185     class Impl;
cannam@21: 00186     Impl *m_impl;
cannam@21: 00187 };
cannam@21: 00188 
cannam@21: 00189 }
cannam@21: 00190 
cannam@21: 00191 }
cannam@21: 00192 
cannam@21: 00193 _VAMP_SDK_HOSTSPACE_END(PluginSummarisingAdapter.h)
cannam@21: 00194 
cannam@21: 00195 #endif
cannam@21: