summaryrefslogtreecommitdiffstats
path: root/gst/equalizer/gstiirequalizer.c
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sourceforge.net>2007-06-20 10:15:00 +0000
committerStefan Kost <ensonic@users.sourceforge.net>2007-06-20 10:15:00 +0000
commit7619871a052c837d76c72ef54314d9c8fae82a9c (patch)
tree56a03fe61ba04aae541807f009e446ff264964e5 /gst/equalizer/gstiirequalizer.c
parent3dbc3b7ad1caac2e7fe319a68e3a0864d661681e (diff)
downloadgst-plugins-bad-7619871a052c837d76c72ef54314d9c8fae82a9c.tar.gz
gst-plugins-bad-7619871a052c837d76c72ef54314d9c8fae82a9c.tar.bz2
gst-plugins-bad-7619871a052c837d76c72ef54314d9c8fae82a9c.zip
gst/equalizer/gstiirequalizer.c: Document parameter mapping.
Original commit message from CVS: * gst/equalizer/gstiirequalizer.c: Document parameter mapping.
Diffstat (limited to 'gst/equalizer/gstiirequalizer.c')
-rw-r--r--gst/equalizer/gstiirequalizer.c14
1 files changed, 11 insertions, 3 deletions
diff --git a/gst/equalizer/gstiirequalizer.c b/gst/equalizer/gstiirequalizer.c
index 926b1e0a..ff11c9e7 100644
--- a/gst/equalizer/gstiirequalizer.c
+++ b/gst/equalizer/gstiirequalizer.c
@@ -311,9 +311,17 @@ gst_iir_equalizer_finalize (GObject * object)
G_OBJECT_CLASS (parent_class)->finalize (object);
}
-/* args are in the range [-1 ... 1] with 0 meaning "no action"
- * convert to [-0.2 ... 1] with 0 meaning no action via the function
- * f(x) = 0.25 * 5 ^ x - 0.25
+/*
+ * converts gain values to scale factors.
+ *
+ * arguments are in the range [-1 ... 1] with 0 meaning "no action"
+ * results are in the range [-0.2 ... 1] with 0 meaning "no action"
+ * via the function
+ * f(x) = 0.25 * 5 ^ x - 0.25
+ *
+ * visualize via gnuplot:
+ * set xrange [-1:1]
+ * plot 0.25 * exp (log (5) * x) - 0.25
*/
static gdouble
arg_to_scale (gdouble arg)