Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@1: VampPluginSDK: PluginSummarisingAdapter.h Source File Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@3:  2.4 Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1: Chris@3: Chris@1: Chris@1: Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1:
PluginSummarisingAdapter.h
Chris@3:
Chris@1:
Chris@1: Go to the documentation of this file.
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-2009 Chris Cannam and QMUL.
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_SUMMARISING_ADAPTER_H_
Chris@1: 00038 #define _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_
Chris@1: 00039 
Chris@1: 00040 #include "hostguard.h"
Chris@1: 00041 #include "PluginWrapper.h"
Chris@1: 00042 
Chris@1: 00043 #include <set>
Chris@1: 00044 
Chris@1: 00045 _VAMP_SDK_HOSTSPACE_BEGIN(PluginSummarisingAdapter.h)
Chris@1: 00046 
Chris@1: 00047 namespace Vamp {
Chris@1: 00048 
Chris@1: 00049 namespace HostExt {
Chris@1: 00050 
Chris@1: 00086 class PluginSummarisingAdapter : public PluginWrapper
Chris@1: 00087 {
Chris@1: 00088 public:
Chris@1: 00094     PluginSummarisingAdapter(Plugin *plugin); 
Chris@1: 00095     virtual ~PluginSummarisingAdapter();
Chris@1: 00096 
Chris@1: 00097     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
Chris@1: 00098 
Chris@1: 00099     void reset();
Chris@1: 00100 
Chris@1: 00101     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
Chris@1: 00102     FeatureSet getRemainingFeatures();
Chris@1: 00103 
Chris@1: 00104     typedef std::set<RealTime> SegmentBoundaries;
Chris@1: 00105 
Chris@1: 00119     void setSummarySegmentBoundaries(const SegmentBoundaries &);
Chris@1: 00120 
Chris@1: 00121     enum SummaryType {
Chris@1: 00122         Minimum            = 0,
Chris@1: 00123         Maximum            = 1,
Chris@1: 00124         Mean               = 2,
Chris@1: 00125         Median             = 3,
Chris@1: 00126         Mode               = 4,
Chris@1: 00127         Sum                = 5,
Chris@1: 00128         Variance           = 6,
Chris@1: 00129         StandardDeviation  = 7,
Chris@1: 00130         Count              = 8,
Chris@1: 00131 
Chris@1: 00132         UnknownSummaryType = 999
Chris@1: 00133     };
Chris@1: 00134 
Chris@1: 00157     enum AveragingMethod {
Chris@1: 00158         SampleAverage         = 0,
Chris@1: 00159         ContinuousTimeAverage = 1
Chris@1: 00160     };
Chris@1: 00161 
Chris@1: 00170     FeatureList getSummaryForOutput(int output,
Chris@1: 00171                                     SummaryType type,
Chris@1: 00172                                     AveragingMethod method = SampleAverage);
Chris@1: 00173 
Chris@1: 00183     FeatureSet getSummaryForAllOutputs(SummaryType type,
Chris@1: 00184                                        AveragingMethod method = SampleAverage);
Chris@1: 00185 
Chris@1: 00186 protected:
Chris@1: 00187     class Impl;
Chris@1: 00188     Impl *m_impl;
Chris@1: 00189 };
Chris@1: 00190 
Chris@1: 00191 }
Chris@1: 00192 
Chris@1: 00193 }
Chris@1: 00194 
Chris@1: 00195 _VAMP_SDK_HOSTSPACE_END(PluginSummarisingAdapter.h)
Chris@1: 00196 
Chris@1: 00197 #endif
Chris@3:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: