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