PluginSummarisingAdapter.h

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

Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by  doxygen 1.5.6