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