diff 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
line wrap: on
line diff
--- a/vamp-sdk/Plugin.h	Wed Sep 16 11:27:15 2009 +0000
+++ b/vamp-sdk/Plugin.h	Mon Sep 21 09:33:05 2009 +0000
@@ -152,12 +152,17 @@
     enum InputDomain { TimeDomain, FrequencyDomain };
     
     /**
-     * Get the plugin's required input domain.  If this is TimeDomain,
-     * the samples provided to the process() function (below) will be
-     * in the time domain, as for a traditional audio processing
-     * plugin.  If this is FrequencyDomain, the host will carry out a
-     * windowed FFT of size equal to the negotiated block size on the
-     * data before passing the frequency bin data in to process().
+     * Get the plugin's required input domain.
+     *
+     * If this is TimeDomain, the samples provided to the process()
+     * function (below) will be in the time domain, as for a
+     * traditional audio processing plugin.
+     *
+     * If this is FrequencyDomain, the host will carry out a windowed
+     * FFT of size equal to the negotiated block size on the data
+     * before passing the frequency bin data in to process().  The
+     * input data for the FFT will be rotated so as to place the
+     * origin in the centre of the block.
      * The plugin does not get to choose the window type -- the host
      * will either let the user do so, or will use a Hanning window.
      */