annotate vamp-hostsdk/PluginChannelAdapter.h @ 248:c88a3cdb0215

* Tidy up --list-full output a bit * Some documentation, including docs for PluginSummarisingAdapter
author cannam
date Tue, 11 Nov 2008 12:07:09 +0000
parents 3cf5bd155e5b
children 4454843ff384
rev   line source
cannam@233 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
cannam@233 2
cannam@233 3 /*
cannam@233 4 Vamp
cannam@233 5
cannam@233 6 An API for audio analysis and feature extraction plugins.
cannam@233 7
cannam@233 8 Centre for Digital Music, Queen Mary, University of London.
cannam@233 9 Copyright 2006-2007 Chris Cannam and QMUL.
cannam@233 10
cannam@233 11 Permission is hereby granted, free of charge, to any person
cannam@233 12 obtaining a copy of this software and associated documentation
cannam@233 13 files (the "Software"), to deal in the Software without
cannam@233 14 restriction, including without limitation the rights to use, copy,
cannam@233 15 modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@233 16 of the Software, and to permit persons to whom the Software is
cannam@233 17 furnished to do so, subject to the following conditions:
cannam@233 18
cannam@233 19 The above copyright notice and this permission notice shall be
cannam@233 20 included in all copies or substantial portions of the Software.
cannam@233 21
cannam@233 22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@233 23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@233 24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@233 25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@233 26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@233 27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@233 28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@233 29
cannam@233 30 Except as contained in this notice, the names of the Centre for
cannam@233 31 Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@233 32 shall not be used in advertising or otherwise to promote the sale,
cannam@233 33 use or other dealings in this Software without prior written
cannam@233 34 authorization.
cannam@233 35 */
cannam@233 36
cannam@233 37 #ifndef _VAMP_PLUGIN_CHANNEL_ADAPTER_H_
cannam@233 38 #define _VAMP_PLUGIN_CHANNEL_ADAPTER_H_
cannam@233 39
cannam@243 40 #include "hostguard.h"
cannam@233 41 #include "PluginWrapper.h"
cannam@233 42
cannam@233 43 namespace Vamp {
cannam@233 44
cannam@233 45 namespace HostExt {
cannam@233 46
cannam@233 47 /**
cannam@233 48 * \class PluginChannelAdapter PluginChannelAdapter.h <vamp-hostsdk/PluginChannelAdapter.h>
cannam@233 49 *
cannam@233 50 * PluginChannelAdapter is a Vamp plugin adapter that implements a
cannam@233 51 * policy for management of plugins that expect a different number of
cannam@233 52 * input channels from the number actually available in the source
cannam@233 53 * audio data.
cannam@233 54 *
cannam@233 55 * A host using PluginChannelAdapter may ignore the getMinChannelCount
cannam@233 56 * and getMaxChannelCount reported by the plugin, and still expect the
cannam@233 57 * plugin to run.
cannam@233 58 *
cannam@233 59 * PluginChannelAdapter implements the following policy:
cannam@233 60 *
cannam@233 61 * - If the plugin supports the provided number of channels directly,
cannam@233 62 * PluginChannelAdapter will just run the plugin as normal.
cannam@233 63 *
cannam@233 64 * - If the plugin only supports exactly one channel but more than
cannam@233 65 * one channel is provided, PluginChannelAdapter will use the mean of
cannam@233 66 * the channels. This ensures that the resulting values remain
cannam@233 67 * within the same magnitude range as expected for mono data.
cannam@233 68 *
cannam@233 69 * - If the plugin requires more than one channel but exactly one is
cannam@233 70 * provided, the provided channel will be duplicated across all the
cannam@233 71 * plugin input channels.
cannam@233 72 *
cannam@233 73 * If none of the above apply:
cannam@233 74 *
cannam@233 75 * - If the plugin requires more channels than are provided, the
cannam@233 76 * minimum acceptable number of channels will be produced by adding
cannam@233 77 * empty (zero valued) channels to those provided.
cannam@233 78 *
cannam@233 79 * - If the plugin requires fewer channels than are provided, the
cannam@233 80 * maximum acceptable number of channels will be produced by
cannam@233 81 * discarding the excess channels.
cannam@233 82 *
cannam@233 83 * Hosts requiring a different channel policy from the above will need
cannam@233 84 * to implement it themselves, instead of using PluginChannelAdapter.
cannam@233 85 *
cannam@233 86 * Note that PluginChannelAdapter does not override the minimum and
cannam@233 87 * maximum channel counts returned by the wrapped plugin. The host
cannam@233 88 * will need to be aware that it is using a PluginChannelAdapter, and
cannam@233 89 * be prepared to ignore these counts as necessary. (This contrasts
cannam@233 90 * with the approach used in PluginInputDomainAdapter, which aims to
cannam@233 91 * make the host completely unaware of which underlying input domain
cannam@233 92 * is in fact in use.)
cannam@233 93 *
cannam@233 94 * (The rationale for this is that a host may wish to use the
cannam@233 95 * PluginChannelAdapter but still discriminate in some way on the
cannam@233 96 * basis of the number of channels actually supported. For example, a
cannam@233 97 * simple stereo audio host may prefer to reject plugins that require
cannam@233 98 * more than two channels on the grounds that doesn't actually
cannam@233 99 * understand what they are for, rather than allow the channel adapter
cannam@233 100 * to make a potentially meaningless channel conversion for them.)
cannam@233 101 *
cannam@233 102 * In every respect other than its management of channels, the
cannam@233 103 * PluginChannelAdapter behaves identically to the plugin that it
cannam@233 104 * wraps. The wrapped plugin will be deleted when the wrapper is
cannam@233 105 * deleted.
cannam@233 106 *
cannam@233 107 * \note This class was introduced in version 1.1 of the Vamp plugin SDK.
cannam@233 108 */
cannam@233 109
cannam@233 110 class PluginChannelAdapter : public PluginWrapper
cannam@233 111 {
cannam@233 112 public:
cannam@248 113 /**
cannam@248 114 * Construct a PluginChannelAdapter wrapping the given plugin.
cannam@248 115 * The adapter takes ownership of the plugin, which will be
cannam@248 116 * deleted when the adapter is deleted.
cannam@248 117 */
cannam@248 118 PluginChannelAdapter(Plugin *plugin);
cannam@233 119 virtual ~PluginChannelAdapter();
cannam@233 120
cannam@233 121 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@233 122
cannam@233 123 FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@233 124
cannam@233 125 /**
cannam@233 126 * Call process(), providing interleaved audio data with the
cannam@233 127 * number of channels passed to initialise(). The adapter will
cannam@233 128 * de-interleave into temporary buffers as appropriate before
cannam@233 129 * calling process().
cannam@233 130 *
cannam@233 131 * \note This function was introduced in version 1.4 of the Vamp
cannam@233 132 * plugin SDK.
cannam@233 133 */
cannam@233 134 FeatureSet processInterleaved(const float *inputBuffer, RealTime timestamp);
cannam@233 135
cannam@233 136 protected:
cannam@233 137 class Impl;
cannam@233 138 Impl *m_impl;
cannam@233 139 };
cannam@233 140
cannam@233 141 }
cannam@233 142
cannam@233 143 }
cannam@233 144
cannam@233 145 #endif