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