changeset 242:7f3a806ed1df

* Add PowerSpectrum to docs
author cannam
date Mon, 10 Nov 2008 17:34:14 +0000
parents 70e6826adc64
children 3cf5bd155e5b
files README examples/vamp-example-plugins.cat src/doc-overview
diffstat 3 files changed, 15 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README	Mon Nov 10 17:28:54 2008 +0000
+++ b/README	Mon Nov 10 17:34:14 2008 +0000
@@ -129,6 +129,13 @@
  - SpectralCentroid calculates the centre of gravity of the frequency
  domain representation of each block of audio.
 
+ - PowerSpectrum calculates a power spectrum from the input audio.
+ Actually, it doesn't do any work except converting from the cartesian
+ complex representation.  The work of converting to frequency domain
+ is all done for it by the host or host SDK; the plugin just needs to
+ declare that it wants frequency domain input.  This is the simplest
+ of the example plugins.
+
  - AmplitudeFollower is a simple implementation of SuperCollider's
  amplitude-follower algorithm.
 
--- a/examples/vamp-example-plugins.cat	Mon Nov 10 17:28:54 2008 +0000
+++ b/examples/vamp-example-plugins.cat	Mon Nov 10 17:34:14 2008 +0000
@@ -1,6 +1,6 @@
 vamp:vamp-example-plugins:zerocrossing::Low Level Features
 vamp:vamp-example-plugins:spectralcentroid::Low Level Features
+vamp:vamp-example-plugins:powerspectrum::Visualisation
 vamp:vamp-example-plugins:percussiononsets::Time > Onsets
 vamp:vamp-example-plugins:amplitudefollower::Low Level Features
 vamp:vamp-example-plugins:fixedtempo::Time > Tempo
-
--- a/src/doc-overview	Mon Nov 10 17:28:54 2008 +0000
+++ b/src/doc-overview	Mon Nov 10 17:34:14 2008 +0000
@@ -40,6 +40,13 @@
  - SpectralCentroid calculates the centre of gravity of the frequency
  domain representation of each block of audio.
 
+ - PowerSpectrum calculates a power spectrum from the input audio.
+ Actually, it doesn't do any work except converting from the cartesian
+ complex representation.  The work of converting to frequency domain
+ is all done for it by the host or host SDK; the plugin just needs to
+ declare that it wants frequency domain input.  This is the simplest
+ of the example plugins.
+
  - AmplitudeFollower is a simple implementation of SuperCollider's
  amplitude-follower algorithm.