gst/audiofx/: Add small comparision with the windowed sinc filters in the docs.

Original commit message from CVS:
* gst/audiofx/audiochebyshevfreqband.c:
* gst/audiofx/audiochebyshevfreqlimit.c:
Add small comparision with the windowed sinc filters in the docs.

4 files changed, 20 insertions, 0 deletions

diff --git a/gst/audiofx/audiochebband.c b/gst/audiofx/audiochebband.c
index 56ac8bd2..e39a6465 100644
--- a/gst/audiofx/audiochebband.c
+++ b/gst/audiofx/audiochebband.c
@@ -42,6 +42,11 @@
  * band. The number of poles and the ripple parameter control the rolloff.
  * </para>
  * <para>
+ * This element has the advantage over the windowed sinc bandpass and bandreject filter that it is
+ * much faster and produces almost as good results. It's only disadvantages are the highly
+ * non-linear phase and the slower rolloff compared to a windowed sinc filter with a large kernel.
+ * </para>
+ * <para>
  * For type 1 the ripple parameter specifies how much ripple in dB is allowed in the passband, i.e.
  * some frequencies in the passband will be amplified by that value. A higher ripple value will allow
  * a faster rolloff.
diff --git a/gst/audiofx/audiocheblimit.c b/gst/audiofx/audiocheblimit.c
index ee9e5f31..0cd1ea6a 100644
--- a/gst/audiofx/audiocheblimit.c
+++ b/gst/audiofx/audiocheblimit.c
@@ -38,6 +38,11 @@
  * cutoff frequency (high-pass). The number of poles and the ripple parameter control the rolloff.
  * </para>
  * <para>
+ * This element has the advantage over the windowed sinc lowpass and highpass filter that it is
+ * much faster and produces almost as good results. It's only disadvantages are the highly
+ * non-linear phase and the slower rolloff compared to a windowed sinc filter with a large kernel.
+ * </para>
+ * <para>
  * For type 1 the ripple parameter specifies how much ripple in dB is allowed in the passband, i.e.
  * some frequencies in the passband will be amplified by that value. A higher ripple value will allow
  * a faster rolloff.
diff --git a/gst/audiofx/audiochebyshevfreqband.c b/gst/audiofx/audiochebyshevfreqband.c
index 56ac8bd2..e39a6465 100644
--- a/gst/audiofx/audiochebyshevfreqband.c
+++ b/gst/audiofx/audiochebyshevfreqband.c
@@ -42,6 +42,11 @@
  * band. The number of poles and the ripple parameter control the rolloff.
  * </para>
  * <para>
+ * This element has the advantage over the windowed sinc bandpass and bandreject filter that it is
+ * much faster and produces almost as good results. It's only disadvantages are the highly
+ * non-linear phase and the slower rolloff compared to a windowed sinc filter with a large kernel.
+ * </para>
+ * <para>
  * For type 1 the ripple parameter specifies how much ripple in dB is allowed in the passband, i.e.
  * some frequencies in the passband will be amplified by that value. A higher ripple value will allow
  * a faster rolloff.
diff --git a/gst/audiofx/audiochebyshevfreqlimit.c b/gst/audiofx/audiochebyshevfreqlimit.c
index ee9e5f31..0cd1ea6a 100644
--- a/gst/audiofx/audiochebyshevfreqlimit.c
+++ b/gst/audiofx/audiochebyshevfreqlimit.c
@@ -38,6 +38,11 @@
  * cutoff frequency (high-pass). The number of poles and the ripple parameter control the rolloff.
  * </para>
  * <para>
+ * This element has the advantage over the windowed sinc lowpass and highpass filter that it is
+ * much faster and produces almost as good results. It's only disadvantages are the highly
+ * non-linear phase and the slower rolloff compared to a windowed sinc filter with a large kernel.
+ * </para>
+ * <para>
  * For type 1 the ripple parameter specifies how much ripple in dB is allowed in the passband, i.e.
  * some frequencies in the passband will be amplified by that value. A higher ripple value will allow
  * a faster rolloff.