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