cannam@227: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@227: 
cannam@227: /*
cannam@227:     Vamp
cannam@227: 
cannam@227:     An API for audio analysis and feature extraction plugins.
cannam@227: 
cannam@227:     Centre for Digital Music, Queen Mary, University of London.
cannam@227:     Copyright 2006-2008 Chris Cannam and QMUL.
cannam@227:   
cannam@227:     Permission is hereby granted, free of charge, to any person
cannam@227:     obtaining a copy of this software and associated documentation
cannam@227:     files (the "Software"), to deal in the Software without
cannam@227:     restriction, including without limitation the rights to use, copy,
cannam@227:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@227:     of the Software, and to permit persons to whom the Software is
cannam@227:     furnished to do so, subject to the following conditions:
cannam@227: 
cannam@227:     The above copyright notice and this permission notice shall be
cannam@227:     included in all copies or substantial portions of the Software.
cannam@227: 
cannam@227:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@227:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@227:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@227:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@227:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@227:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@227:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@227: 
cannam@227:     Except as contained in this notice, the names of the Centre for
cannam@227:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@227:     shall not be used in advertising or otherwise to promote the sale,
cannam@227:     use or other dealings in this Software without prior written
cannam@227:     authorization.
cannam@227: */
cannam@227: 
cannam@227: #ifndef _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_
cannam@227: #define _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_
cannam@227: 
cannam@227: #include "PluginWrapper.h"
cannam@227: 
cannam@227: #include <set>
cannam@227: 
cannam@227: namespace Vamp {
cannam@227: 
cannam@227: namespace HostExt {
cannam@227: 
cannam@227: /**
cannam@227:  * \class PluginSummarisingAdapter PluginSummarisingAdapter.h <vamp-sdk/hostext/PluginSummarisingAdapter.h>
cannam@227:  *
cannam@227:  * \note This class was introduced in version 2.0 of the Vamp plugin SDK.
cannam@227:  */
cannam@227: 
cannam@227: class PluginSummarisingAdapter : public PluginWrapper
cannam@227: {
cannam@227: public:
cannam@227:     PluginSummarisingAdapter(Plugin *plugin); // I take ownership of plugin
cannam@227:     virtual ~PluginSummarisingAdapter();
cannam@227: 
cannam@227:     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@227: 
cannam@227:     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@227:     FeatureSet getRemainingFeatures();
cannam@227: 
cannam@227:     typedef std::set<RealTime> SegmentBoundaries;
cannam@227:     void setSummarySegmentBoundaries(const SegmentBoundaries &);
cannam@227: 
cannam@227:     enum SummaryType {
cannam@227:         Minimum            = 0,
cannam@227:         Maximum            = 1,
cannam@227:         Mean               = 2,
cannam@227:         Median             = 3,
cannam@227:         Mode               = 4,
cannam@227:         Sum                = 5,
cannam@227:         Variance           = 6,
cannam@227:         StandardDeviation  = 7,
cannam@227:         Count              = 8,
cannam@227: 
cannam@227:         UnknownSummaryType = 999
cannam@227:     };
cannam@227: 
cannam@227:     /**
cannam@227:      * AveragingMethod indicates how the adapter should handle
cannam@227:      * average-based summaries of features whose results are not
cannam@227:      * equally spaced in time.
cannam@227:      *
cannam@227:      * If SampleAverage is specified, summary types based on averages
cannam@227:      * will be calculated by treating each result individually without
cannam@227:      * regard to its time: for example, the mean will be the sum of
cannam@227:      * all values divided by the number of values.
cannam@227:      *
cannam@227:      * If ContinuousTimeAverage is specified, each feature will be
cannam@227:      * considered to have a duration, either as specified in the
cannam@227:      * feature's duration field, or until the following feature: thus,
cannam@227:      * for example, the mean will be the sum of the products of values
cannam@227:      * and durations, divided by the total duration.
cannam@227:      *
cannam@227:      * Although SampleAverage is useful for many types of feature,
cannam@227:      * ContinuousTimeAverage is essential for some situations, for
cannam@227:      * example finding the result that spans the largest proportion of
cannam@227:      * the input given a feature that emits a new result only when the
cannam@227:      * value changes (the modal value integrated over time).
cannam@227:      */
cannam@227:     enum AveragingMethod {
cannam@227:         SampleAverage         = 0,
cannam@227:         ContinuousTimeAverage = 1,
cannam@227:     };
cannam@227: 
cannam@227:     FeatureList getSummaryForOutput(int output,
cannam@227:                                     SummaryType type,
cannam@227:                                     AveragingMethod method = SampleAverage);
cannam@227: 
cannam@227:     FeatureSet getSummaryForAllOutputs(SummaryType type,
cannam@227:                                        AveragingMethod method = SampleAverage);
cannam@227: 
cannam@227: protected:
cannam@227:     class Impl;
cannam@227:     Impl *m_impl;
cannam@227: };
cannam@227: 
cannam@227: }
cannam@227: 
cannam@227: }
cannam@227: 
cannam@227: #endif