comparison vamp-sdk/Plugin.h @ 290:c97e70ed5abc

* Doc updates, copyright updates, etc., in preparation for 2.1 release
author cannam
date Mon, 21 Sep 2009 09:33:05 +0000
parents 521734d2b498
children e85513153c71
comparison
equal deleted inserted replaced
289:3e5ab1c7ea8c 290:c97e70ed5abc
150 virtual void reset() = 0; 150 virtual void reset() = 0;
151 151
152 enum InputDomain { TimeDomain, FrequencyDomain }; 152 enum InputDomain { TimeDomain, FrequencyDomain };
153 153
154 /** 154 /**
155 * Get the plugin's required input domain. If this is TimeDomain, 155 * Get the plugin's required input domain.
156 * the samples provided to the process() function (below) will be 156 *
157 * in the time domain, as for a traditional audio processing 157 * If this is TimeDomain, the samples provided to the process()
158 * plugin. If this is FrequencyDomain, the host will carry out a 158 * function (below) will be in the time domain, as for a
159 * windowed FFT of size equal to the negotiated block size on the 159 * traditional audio processing plugin.
160 * data before passing the frequency bin data in to process(). 160 *
161 * If this is FrequencyDomain, the host will carry out a windowed
162 * FFT of size equal to the negotiated block size on the data
163 * before passing the frequency bin data in to process(). The
164 * input data for the FFT will be rotated so as to place the
165 * origin in the centre of the block.
161 * The plugin does not get to choose the window type -- the host 166 * The plugin does not get to choose the window type -- the host
162 * will either let the user do so, or will use a Hanning window. 167 * will either let the user do so, or will use a Hanning window.
163 */ 168 */
164 virtual InputDomain getInputDomain() const = 0; 169 virtual InputDomain getInputDomain() const = 0;
165 170