cannam@173: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@173: 
cannam@173: /*
cannam@173:     Vamp
cannam@173: 
cannam@173:     An API for audio analysis and feature extraction plugins.
cannam@173: 
cannam@173:     Centre for Digital Music, Queen Mary, University of London.
cannam@173:     Copyright 2006-2008 Chris Cannam and QMUL.
cannam@173:   
cannam@173:     Permission is hereby granted, free of charge, to any person
cannam@173:     obtaining a copy of this software and associated documentation
cannam@173:     files (the "Software"), to deal in the Software without
cannam@173:     restriction, including without limitation the rights to use, copy,
cannam@173:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@173:     of the Software, and to permit persons to whom the Software is
cannam@173:     furnished to do so, subject to the following conditions:
cannam@173: 
cannam@173:     The above copyright notice and this permission notice shall be
cannam@173:     included in all copies or substantial portions of the Software.
cannam@173: 
cannam@173:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@173:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@173:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@173:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@173:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@173:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@173:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@173: 
cannam@173:     Except as contained in this notice, the names of the Centre for
cannam@173:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@173:     shall not be used in advertising or otherwise to promote the sale,
cannam@173:     use or other dealings in this Software without prior written
cannam@173:     authorization.
cannam@173: */
cannam@173: 
cannam@173: #ifndef _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_
cannam@173: #define _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_
cannam@173: 
cannam@173: #include "PluginWrapper.h"
cannam@173: 
cannam@174: #include <set>
cannam@174: 
cannam@173: namespace Vamp {
cannam@173: 
cannam@173: namespace HostExt {
cannam@173: 
cannam@173: class PluginSummarisingAdapter : public PluginWrapper
cannam@173: {
cannam@173: public:
cannam@173:     PluginSummarisingAdapter(Plugin *plugin); // I take ownership of plugin
cannam@173:     virtual ~PluginSummarisingAdapter();
cannam@173: 
cannam@173:     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@173:     FeatureSet getRemainingFeatures();
cannam@173: 
cannam@173:     typedef std::set<RealTime> SegmentBoundaries;
cannam@173:     void setSummarySegmentBoundaries(const SegmentBoundaries &);
cannam@173: 
cannam@173:     enum SummaryType {
cannam@173:         Minimum,
cannam@173:         Maximum,
cannam@173:         Mean,
cannam@173:         Median,
cannam@173:         Mode,
cannam@173:         Sum,
cannam@173:         Variance,
cannam@173:         StandardDeviation,
cannam@173:         Count
cannam@173:     };
cannam@173: 
cannam@174:     FeatureSet getSummary(int output, SummaryType type);
cannam@173: 
cannam@173: protected:
cannam@173:     class Impl;
cannam@173:     Impl *m_impl;
cannam@173: };
cannam@173: 
cannam@173: }
cannam@173: 
cannam@173: }
cannam@173: 
cannam@173: #endif