Chris@25: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ Chris@25: Chris@25: /* Chris@25: Vamp Chris@25: Chris@25: An API for audio analysis and feature extraction plugins. Chris@25: Chris@25: Centre for Digital Music, Queen Mary, University of London. Chris@25: Copyright 2006-2009 Chris Cannam and QMUL. Chris@25: Chris@25: Permission is hereby granted, free of charge, to any person Chris@25: obtaining a copy of this software and associated documentation Chris@25: files (the "Software"), to deal in the Software without Chris@25: restriction, including without limitation the rights to use, copy, Chris@25: modify, merge, publish, distribute, sublicense, and/or sell copies Chris@25: of the Software, and to permit persons to whom the Software is Chris@25: furnished to do so, subject to the following conditions: Chris@25: Chris@25: The above copyright notice and this permission notice shall be Chris@25: included in all copies or substantial portions of the Software. Chris@25: Chris@25: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, Chris@25: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF Chris@25: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND Chris@25: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR Chris@25: ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF Chris@25: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION Chris@25: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Chris@25: Chris@25: Except as contained in this notice, the names of the Centre for Chris@25: Digital Music; Queen Mary, University of London; and Chris Cannam Chris@25: shall not be used in advertising or otherwise to promote the sale, Chris@25: use or other dealings in this Software without prior written Chris@25: authorization. Chris@25: */ Chris@25: Chris@25: #ifndef _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_ Chris@25: #define _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_ Chris@25: Chris@25: #include "hostguard.h" Chris@25: #include "PluginWrapper.h" Chris@25: Chris@25: #include Chris@25: Chris@25: _VAMP_SDK_HOSTSPACE_BEGIN(PluginSummarisingAdapter.h) Chris@25: Chris@25: namespace Vamp { Chris@25: Chris@25: namespace HostExt { Chris@25: Chris@25: /** Chris@25: * \class PluginSummarisingAdapter PluginSummarisingAdapter.h Chris@25: * Chris@25: * PluginSummarisingAdapter is a Vamp plugin adapter that provides Chris@25: * summarisation methods such as mean and median averages of output Chris@25: * features, for use in any context where an available plugin produces Chris@25: * individual values but the result that is actually needed is some Chris@25: * sort of aggregate. Chris@25: * Chris@25: * To make use of PluginSummarisingAdapter, the host should configure, Chris@25: * initialise and run the plugin through the adapter interface just as Chris@25: * normal. Then, after the process and getRemainingFeatures methods Chris@25: * have been properly called and processing is complete, the host may Chris@25: * call getSummaryForOutput or getSummaryForAllOutputs to obtain Chris@25: * summarised features: averages, maximum values, etc, depending on Chris@25: * the SummaryType passed to the function. Chris@25: * Chris@25: * By default PluginSummarisingAdapter calculates a single summary of Chris@25: * each output's feature across the whole duration of processed audio. Chris@25: * A host needing summaries of sub-segments of the whole audio may Chris@25: * call setSummarySegmentBoundaries before retrieving the summaries, Chris@25: * providing a list of times such that one summary will be provided Chris@25: * for each segment between two consecutive times. Chris@25: * Chris@25: * PluginSummarisingAdapter is straightforward rather than fast. It Chris@25: * calculates all of the summary types for all outputs always, and Chris@25: * then returns only the ones that are requested. It is designed on Chris@25: * the basis that, for most features, summarising and storing Chris@25: * summarised results is far cheaper than calculating the results in Chris@25: * the first place. If this is not true for your particular feature, Chris@25: * PluginSummarisingAdapter may not be the best approach for you. Chris@25: * Chris@25: * \note This class was introduced in version 2.0 of the Vamp plugin SDK. Chris@25: */ Chris@25: Chris@25: class PluginSummarisingAdapter : public PluginWrapper Chris@25: { Chris@25: public: Chris@25: /** Chris@25: * Construct a PluginSummarisingAdapter wrapping the given plugin. Chris@25: * The adapter takes ownership of the plugin, which will be Chris@25: * deleted when the adapter is deleted. Chris@25: */ Chris@25: PluginSummarisingAdapter(Plugin *plugin); Chris@25: virtual ~PluginSummarisingAdapter(); Chris@25: Chris@25: bool initialise(size_t channels, size_t stepSize, size_t blockSize); Chris@25: Chris@25: void reset(); Chris@25: Chris@25: FeatureSet process(const float *const *inputBuffers, RealTime timestamp); Chris@25: FeatureSet getRemainingFeatures(); Chris@25: Chris@25: typedef std::set SegmentBoundaries; Chris@25: Chris@25: /** Chris@25: * Specify a series of segment boundaries, such that one summary Chris@25: * will be returned for each of the contiguous intra-boundary Chris@25: * segments. This function must be called before Chris@25: * getSummaryForOutput or getSummaryForAllOutputs. Chris@25: * Chris@25: * Note that you cannot retrieve results with multiple different Chris@25: * segmentations by repeatedly calling this function followed by Chris@25: * one of the getSummary functions. The summaries are all Chris@25: * calculated at the first call to any getSummary function, and Chris@25: * once the summaries have been calculated, they remain Chris@25: * calculated. Chris@25: */ Chris@25: void setSummarySegmentBoundaries(const SegmentBoundaries &); Chris@25: Chris@25: enum SummaryType { Chris@25: Minimum = 0, Chris@25: Maximum = 1, Chris@25: Mean = 2, Chris@25: Median = 3, Chris@25: Mode = 4, Chris@25: Sum = 5, Chris@25: Variance = 6, Chris@25: StandardDeviation = 7, Chris@25: Count = 8, Chris@25: Chris@25: UnknownSummaryType = 999 Chris@25: }; Chris@25: Chris@25: /** Chris@25: * AveragingMethod indicates how the adapter should handle Chris@25: * average-based summaries of features whose results are not Chris@25: * equally spaced in time. Chris@25: * Chris@25: * If SampleAverage is specified, summary types based on averages Chris@25: * will be calculated by treating each result individually without Chris@25: * regard to its time: for example, the mean will be the sum of Chris@25: * all values divided by the number of values. Chris@25: * Chris@25: * If ContinuousTimeAverage is specified, each feature will be Chris@25: * considered to have a duration, either as specified in the Chris@25: * feature's duration field, or until the following feature: thus, Chris@25: * for example, the mean will be the sum of the products of values Chris@25: * and durations, divided by the total duration. Chris@25: * Chris@25: * Although SampleAverage is useful for many types of feature, Chris@25: * ContinuousTimeAverage is essential for some situations, for Chris@25: * example finding the result that spans the largest proportion of Chris@25: * the input given a feature that emits a new result only when the Chris@25: * value changes (the modal value integrated over time). Chris@25: */ Chris@25: enum AveragingMethod { Chris@25: SampleAverage = 0, Chris@25: ContinuousTimeAverage = 1 Chris@25: }; Chris@25: Chris@25: /** Chris@25: * Return summaries of the features that were returned on the Chris@25: * given output, using the given SummaryType and AveragingMethod. Chris@25: * Chris@25: * The plugin must have been fully run (process() and Chris@25: * getRemainingFeatures() calls all made as appropriate) before Chris@25: * this function is called. Chris@25: */ Chris@25: FeatureList getSummaryForOutput(int output, Chris@25: SummaryType type, Chris@25: AveragingMethod method = SampleAverage); Chris@25: Chris@25: /** Chris@25: * Return summaries of the features that were returned on all of Chris@25: * the plugin's outputs, using the given SummaryType and Chris@25: * AveragingMethod. Chris@25: * Chris@25: * The plugin must have been fully run (process() and Chris@25: * getRemainingFeatures() calls all made as appropriate) before Chris@25: * this function is called. Chris@25: */ Chris@25: FeatureSet getSummaryForAllOutputs(SummaryType type, Chris@25: AveragingMethod method = SampleAverage); Chris@25: Chris@25: protected: Chris@25: class Impl; Chris@25: Impl *m_impl; Chris@25: }; Chris@25: Chris@25: } Chris@25: Chris@25: } Chris@25: Chris@25: _VAMP_SDK_HOSTSPACE_END(PluginSummarisingAdapter.h) Chris@25: Chris@25: #endif