audiovisualizers: doc-blob and comment updates

diff --git a/gst/audiovisualizers/gstbaseaudiovisualizer.c b/gst/audiovisualizers/gstbaseaudiovisualizer.c
index 75734401428a5c48371d55647b6f0ec93a948641..3171bc1f8ca1a1ef7357fef32677cecf5b91a2de 100644 (file)
--- a/gst/audiovisualizers/gstbaseaudiovisualizer.c
+++ b/gst/audiovisualizers/gstbaseaudiovisualizer.c
@@ -20,7 +20,10 @@
 /**
  * SECTION:gstbaseaudiovisualizer
  *
- * A basclass for scopes. Takes care of re-fitting the audio-rate to video-rate.
+ * A basclass for scopes. It takes care of re-fitting the audio-rate to
+ * video-rate. It also provides several background shading effects. These
+ * effects are applied to a previous picture before the render() implementation
+ * can draw a new frame.
  */
 
 #ifdef HAVE_CONFIG_H

diff --git a/gst/audiovisualizers/gstspectrascope.c b/gst/audiovisualizers/gstspectrascope.c
index a09e944fa395ee022a42dafd34d828507bc21d34..9ab5419833f45836a2367f309c22d2f3a637af30 100644 (file)
--- a/gst/audiovisualizers/gstspectrascope.c
+++ b/gst/audiovisualizers/gstspectrascope.c
@@ -21,8 +21,8 @@
  * SECTION:element-spectrascope
  * @see_also: goom
  *
- * Wavescope is a simple audio visualisation element. It renders the waveforms
- * like on an oscilloscope.
+ * Spectrascope is a simple spectrum visualisation element. It renders the
+ * frequency spectrum as a series of bars.
  *
  * <refsect2>
  * <title>Example launch line</title>

diff --git a/gst/audiovisualizers/gstsynaescope.c b/gst/audiovisualizers/gstsynaescope.c
index 057eddd08e4cd2e91d1d2eac357627e5d88f7b5f..ac29e68d5838af58d730104e586e97474bc5819f 100644 (file)
--- a/gst/audiovisualizers/gstsynaescope.c
+++ b/gst/audiovisualizers/gstsynaescope.c
@@ -21,8 +21,8 @@
  * SECTION:element-synaescope
  * @see_also: goom
  *
- * Wavescope is a simple audio visualisation element. It renders the waveforms
- * like on an oscilloscope.
+ * Synaescope is an audio visualisation element. It analyzes frequencies and
+ * out-of phase properties of audio and draws this as clouds of stars.
  *
  * <refsect2>
  * <title>Example launch line</title>
@@ -248,6 +248,7 @@ gst_synae_scope_render (GstBaseAudioVisualizer * bscope, GstBuffer * audio,
     r = sqrt (frr * frr + fir * fir);
     fc = r + l;
 
+    /* out-of-phase'ness for this frequency component */
     clarity = (gint) (((frl + frr) * (frl - frr) + (fil + fir) * (fil - fir)) /
         (((frl + frr) * (frl + frr) + (fil - fir) * (fil - fir) + (frl -
                     frr) * (frl - frr) + (fil + fir) * (fil + fir)) * 256.0));