Add an echo/reverb filter to the audiofx plugin, with configurable echo delay, intensity and feedback. Fixes bug #567...

Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-good-plugins-docs.sgml:
* docs/plugins/gst-plugins-good-plugins-sections.txt:
* docs/plugins/gst-plugins-good-plugins.args:
* docs/plugins/gst-plugins-good-plugins.hierarchy:
* docs/plugins/inspect/plugin-audiofx.xml:
* docs/plugins/inspect/plugin-spectrum.xml:
* gst/audiofx/Makefile.am:
* gst/audiofx/audiofx.c: (plugin_init):
* gst/audiofx/audioreverb.c: (gst_audio_reverb_base_init),
(gst_audio_reverb_class_init), (gst_audio_reverb_init),
(gst_audio_reverb_finalize), (gst_audio_reverb_set_property),
(gst_audio_reverb_get_property), (gst_audio_reverb_setup),
(gst_audio_reverb_stop), (gst_audio_reverb_transform_ip):
* gst/audiofx/audioreverb.h:
* tests/check/Makefile.am:
* tests/check/elements/audioreverb.c: (setup_reverb),
(cleanup_reverb), (GST_START_TEST), (audioreverb_suite):
Add an echo/reverb filter to the audiofx plugin, with configurable
echo delay, intensity and feedback. Fixes bug #567874.

2 files changed, 230 insertions, 0 deletions

diff --git a/tests/check/Makefile.am b/tests/check/Makefile.am
index 5cc63dbb..ee0afdc9 100644
--- a/tests/check/Makefile.am
+++ b/tests/check/Makefile.am
@@ -74,6 +74,7 @@ check_PROGRAMS = \
 	elements/audiocheblimit \
 	elements/audioiirfilter \
 	elements/audioamplify \
+	elements/audioreverb \
 	elements/audiodynamic \
 	elements/audiowsincband \
 	elements/audiowsinclimit \
diff --git a/tests/check/elements/audioreverb.c b/tests/check/elements/audioreverb.c
new file mode 100644
index 00000000..cafe8bbe
--- /dev/null
+++ b/tests/check/elements/audioreverb.c
@@ -0,0 +1,229 @@
+/* GStreamer
+ *
+ * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include <gst/check/gstcheck.h>
+
+gboolean have_eos = FALSE;
+
+/* For ease of programming we use globals to keep refs for our floating
+ * src and sink pads we create; otherwise we always have to do get_pad,
+ * get_peer, and then remove references in every test function */
+GstPad *mysrcpad, *mysinkpad;
+
+#define REVERB_CAPS_STRING    \
+    "audio/x-raw-float, "               \
+    "channels = (int) 2, "              \
+    "rate = (int) 100000, "             \
+    "endianness = (int) BYTE_ORDER, "   \
+    "width = (int) 64"
+
+static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
+    GST_PAD_SINK,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS ("audio/x-raw-float, "
+        "channels = (int) [ 1, 2 ], "
+        "rate = (int) [ 1,  MAX ], "
+        "endianness = (int) BYTE_ORDER, " "width = (int) { 32, 64 }")
+    );
+static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
+    GST_PAD_SRC,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS ("audio/x-raw-float, "
+        "channels = (int) [ 1, 2 ], "
+        "rate = (int) [ 1,  MAX ], "
+        "endianness = (int) BYTE_ORDER, " "width = (int) { 32, 64 }")
+    );
+
+GstElement *
+setup_reverb ()
+{
+  GstElement *reverb;
+
+  GST_DEBUG ("setup_reverb");
+  reverb = gst_check_setup_element ("audioreverb");
+  mysrcpad = gst_check_setup_src_pad (reverb, &srctemplate, NULL);
+  mysinkpad = gst_check_setup_sink_pad (reverb, &sinktemplate, NULL);
+  gst_pad_set_active (mysrcpad, TRUE);
+  gst_pad_set_active (mysinkpad, TRUE);
+
+  return reverb;
+}
+
+void
+cleanup_reverb (GstElement * reverb)
+{
+  GST_DEBUG ("cleanup_reverb");
+
+  g_list_foreach (buffers, (GFunc) gst_mini_object_unref, NULL);
+  g_list_free (buffers);
+  buffers = NULL;
+
+  gst_pad_set_active (mysrcpad, FALSE);
+  gst_pad_set_active (mysinkpad, FALSE);
+  gst_check_teardown_src_pad (reverb);
+  gst_check_teardown_sink_pad (reverb);
+  gst_check_teardown_element (reverb);
+}
+
+GST_START_TEST (test_passthrough)
+{
+  GstElement *reverb;
+  GstBuffer *inbuffer, *outbuffer;
+  GstCaps *caps;
+  gdouble in[] = { 1.0, -1.0, 0.0, 0.5, -0.5, 0.0 };
+  gdouble *res;
+
+  reverb = setup_reverb ();
+  g_object_set (G_OBJECT (reverb), "delay", 1, "intensity", 0.0, "feedback",
+      0.0, NULL);
+  fail_unless (gst_element_set_state (reverb,
+          GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to playing");
+
+  inbuffer = gst_buffer_new_and_alloc (sizeof (in));
+  memcpy (GST_BUFFER_DATA (inbuffer), in, sizeof (in));
+  fail_unless (memcmp (GST_BUFFER_DATA (inbuffer), in, sizeof (in)) == 0);
+  caps = gst_caps_from_string (REVERB_CAPS_STRING);
+  gst_buffer_set_caps (inbuffer, caps);
+  gst_caps_unref (caps);
+  ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+
+  /* pushing gives away my reference ... */
+  fail_unless (gst_pad_push (mysrcpad, inbuffer) == GST_FLOW_OK);
+  /* ... but it ends up being collected on the global buffer list */
+  fail_unless_equals_int (g_list_length (buffers), 1);
+  fail_if ((outbuffer = (GstBuffer *) buffers->data) == NULL);
+
+  res = (gdouble *) GST_BUFFER_DATA (outbuffer);
+  GST_INFO
+      ("expected %+lf %+lf %+lf %+lf %+lf %+lf real %+lf %+lf %+lf %+lf %+lf %+lf",
+      in[0], in[1], in[2], in[3], in[4], in[5], res[0], res[1], res[2], res[3],
+      res[4], res[5]);
+  fail_unless (memcmp (GST_BUFFER_DATA (outbuffer), in, sizeof (in)) == 0);
+
+  /* cleanup */
+  cleanup_reverb (reverb);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_reverb)
+{
+  GstElement *reverb;
+  GstBuffer *inbuffer, *outbuffer;
+  GstCaps *caps;
+  gdouble in[] = { 1.0, -1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, };
+  gdouble out[] = { 1.0, -1.0, 0.0, 0.0, 1.0, -1.0, 0.0, 0.0, 0.0, 0.0 };
+  gdouble *res;
+
+  reverb = setup_reverb ();
+  g_object_set (G_OBJECT (reverb), "delay", 20000, "intensity", 1.0, "feedback",
+      0.0, NULL);
+  fail_unless (gst_element_set_state (reverb,
+          GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to playing");
+
+  inbuffer = gst_buffer_new_and_alloc (sizeof (in));
+  memcpy (GST_BUFFER_DATA (inbuffer), in, sizeof (in));
+  fail_unless (memcmp (GST_BUFFER_DATA (inbuffer), in, sizeof (in)) == 0);
+  caps = gst_caps_from_string (REVERB_CAPS_STRING);
+  gst_buffer_set_caps (inbuffer, caps);
+  gst_caps_unref (caps);
+  ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+
+  /* pushing gives away my reference ... */
+  fail_unless (gst_pad_push (mysrcpad, inbuffer) == GST_FLOW_OK);
+  /* ... but it ends up being collected on the global buffer list */
+  fail_unless_equals_int (g_list_length (buffers), 1);
+  fail_if ((outbuffer = (GstBuffer *) buffers->data) == NULL);
+
+  res = (gdouble *) GST_BUFFER_DATA (outbuffer);
+  GST_INFO
+      ("expected %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf real %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf",
+      out[0], out[1], out[2], out[3], out[4], out[5], out[6], out[7], out[8],
+      out[9], res[0], res[1], res[2], res[3], res[4], res[5], res[6], res[7],
+      res[8], res[9]);
+  fail_unless (memcmp (GST_BUFFER_DATA (outbuffer), out, sizeof (out)) == 0);
+
+  /* cleanup */
+  cleanup_reverb (reverb);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_feedback)
+{
+  GstElement *reverb;
+  GstBuffer *inbuffer, *outbuffer;
+  GstCaps *caps;
+  gdouble in[] = { 1.0, -1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, };
+  gdouble out[] = { 1.0, -1.0, 0.0, 0.0, 1.0, -1.0, 0.0, 0.0, 1.0, -1.0 };
+  gdouble *res;
+
+  reverb = setup_reverb ();
+  g_object_set (G_OBJECT (reverb), "delay", 20000, "intensity", 1.0, "feedback",
+      1.0, NULL);
+  fail_unless (gst_element_set_state (reverb,
+          GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to playing");
+
+  inbuffer = gst_buffer_new_and_alloc (sizeof (in));
+  memcpy (GST_BUFFER_DATA (inbuffer), in, sizeof (in));
+  fail_unless (memcmp (GST_BUFFER_DATA (inbuffer), in, sizeof (in)) == 0);
+  caps = gst_caps_from_string (REVERB_CAPS_STRING);
+  gst_buffer_set_caps (inbuffer, caps);
+  gst_caps_unref (caps);
+  ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+
+  /* pushing gives away my reference ... */
+  fail_unless (gst_pad_push (mysrcpad, inbuffer) == GST_FLOW_OK);
+  /* ... but it ends up being collected on the global buffer list */
+  fail_unless_equals_int (g_list_length (buffers), 1);
+  fail_if ((outbuffer = (GstBuffer *) buffers->data) == NULL);
+
+  res = (gdouble *) GST_BUFFER_DATA (outbuffer);
+  GST_INFO
+      ("expected %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf real %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf %+lf",
+      out[0], out[1], out[2], out[3], out[4], out[5], out[6], out[7], out[8],
+      out[9], res[0], res[1], res[2], res[3], res[4], res[5], res[6], res[7],
+      res[8], res[9]);
+  fail_unless (memcmp (GST_BUFFER_DATA (outbuffer), out, sizeof (out)) == 0);
+
+  /* cleanup */
+  cleanup_reverb (reverb);
+}
+
+GST_END_TEST;
+
+static Suite *
+audioreverb_suite (void)
+{
+  Suite *s = suite_create ("audioreverb");
+  TCase *tc_chain = tcase_create ("general");
+
+  suite_add_tcase (s, tc_chain);
+  tcase_add_test (tc_chain, test_passthrough);
+  tcase_add_test (tc_chain, test_reverb);
+  tcase_add_test (tc_chain, test_feedback);
+
+  return s;
+}
+
+GST_CHECK_MAIN (audioreverb);