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