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