opus: add test

2 files changed, 390 insertions, 0 deletions

diff --git a/tests/check/Makefile.am b/tests/check/Makefile.am
index 75750ea99..7ee8231b0 100644
--- a/tests/check/Makefile.am
+++ b/tests/check/Makefile.am
@@ -135,6 +135,12 @@ else
 check_zbar =
 endif
 
+if USE_OPUS
+check_opus = elements/opus
+else
+check_opus =
+endif
+
 VALGRIND_TO_FIX = \
 	elements/mpeg2enc \
 	elements/mplex    \
@@ -161,6 +167,7 @@ check_PROGRAMS = \
 	$(check_ofa)        \
 	$(check_timidity)  \
 	$(check_kate)  \
+	$(check_opus)  \
 	elements/autoconvert \
 	elements/autovideoconvert \
 	elements/asfmux \
diff --git a/tests/check/elements/opus.c b/tests/check/elements/opus.c
new file mode 100644
index 000000000..66c12a323
--- /dev/null
+++ b/tests/check/elements/opus.c
@@ -0,0 +1,383 @@
+/* GStreamer
+ *
+ * unit test for opus
+ *
+ * Copyright (C) <2011> Vincent Penquerc'h <vincent.penquerch@collbaora.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 <unistd.h>
+
+#include <gst/check/gstcheck.h>
+
+static const guint8 opus_ogg_id_header[19] = {
+  0x4f, 0x70, 0x75, 0x73, 0x48, 0x65, 0x61, 0x64, 0x00, 0x02, 0x00, 0x00, 0x00,
+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00
+};
+
+static const guint8 opus_ogg_comments_header[] = {
+  0x4f, 0x70, 0x75, 0x73, 0x54, 0x61, 0x67, 0x73, 0x1e, 0x00, 0x00, 0x00, 0x45,
+  0x6e, 0x63, 0x6f, 0x64, 0x65, 0x64, 0x20, 0x77, 0x69, 0x74, 0x68, 0x20, 0x47,
+  0x53, 0x74, 0x72, 0x65, 0x61, 0x6d, 0x65, 0x72, 0x20, 0x4f, 0x70, 0x75, 0x73,
+  0x65, 0x6e, 0x63, 0x00, 0x00, 0x00, 0x00
+};
+
+/* A lot of these taken from the vorbisdec test */
+
+/* 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 */
+static GstPad *mydecsrcpad, *mydecsinkpad;
+static GstPad *myencsrcpad, *myencsinkpad;
+
+static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
+    GST_PAD_SINK,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS_ANY);
+static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
+    GST_PAD_SRC,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS_ANY);
+
+static GstElement *
+setup_opusdec (void)
+{
+  GstElement *opusdec;
+
+  GST_DEBUG ("setup_opusdec");
+  opusdec = gst_check_setup_element ("opusdec");
+  mydecsrcpad = gst_check_setup_src_pad (opusdec, &srctemplate, NULL);
+  mydecsinkpad = gst_check_setup_sink_pad (opusdec, &sinktemplate, NULL);
+  gst_pad_set_active (mydecsrcpad, TRUE);
+  gst_pad_set_active (mydecsinkpad, TRUE);
+
+  return opusdec;
+}
+
+static void
+cleanup_opusdec (GstElement * opusdec)
+{
+  GST_DEBUG ("cleanup_opusdec");
+  gst_element_set_state (opusdec, GST_STATE_NULL);
+
+  gst_pad_set_active (mydecsrcpad, FALSE);
+  gst_pad_set_active (mydecsinkpad, FALSE);
+  gst_check_teardown_src_pad (opusdec);
+  gst_check_teardown_sink_pad (opusdec);
+  gst_check_teardown_element (opusdec);
+}
+
+static GstElement *
+setup_opusenc (void)
+{
+  GstElement *opusenc;
+
+  GST_DEBUG ("setup_opusenc");
+  opusenc = gst_check_setup_element ("opusenc");
+  myencsrcpad = gst_check_setup_src_pad (opusenc, &srctemplate, NULL);
+  myencsinkpad = gst_check_setup_sink_pad (opusenc, &sinktemplate, NULL);
+  gst_pad_set_active (myencsrcpad, TRUE);
+  gst_pad_set_active (myencsinkpad, TRUE);
+
+  return opusenc;
+}
+
+static void
+cleanup_opusenc (GstElement * opusenc)
+{
+  GST_DEBUG ("cleanup_opusenc");
+  gst_element_set_state (opusenc, GST_STATE_NULL);
+
+  gst_pad_set_active (myencsrcpad, FALSE);
+  gst_pad_set_active (myencsinkpad, FALSE);
+  gst_check_teardown_src_pad (opusenc);
+  gst_check_teardown_sink_pad (opusenc);
+  gst_check_teardown_element (opusenc);
+}
+
+static void
+check_buffers (guint expected, gboolean headers_in_caps)
+{
+  GstBuffer *outbuffer;
+  guint i, num_buffers;
+
+  /* check buffers are the type we expect */
+  num_buffers = g_list_length (buffers);
+  fail_unless (num_buffers >= expected);
+  for (i = 0; i < num_buffers; ++i) {
+    outbuffer = GST_BUFFER (buffers->data);
+    fail_if (outbuffer == NULL);
+    fail_if (GST_BUFFER_SIZE (outbuffer) == 0);
+
+    buffers = g_list_remove (buffers, outbuffer);
+
+    ASSERT_BUFFER_REFCOUNT (outbuffer, "outbuffer", 1);
+    gst_buffer_unref (outbuffer);
+    outbuffer = NULL;
+  }
+}
+
+GST_START_TEST (test_opus_id_header)
+{
+  GstElement *opusdec;
+  GstBuffer *inbuffer;
+
+  opusdec = setup_opusdec ();
+  fail_unless (gst_element_set_state (opusdec,
+          GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to playing");
+
+  inbuffer = gst_buffer_new_and_alloc (sizeof (opus_ogg_id_header));
+  memcpy (GST_BUFFER_DATA (inbuffer), opus_ogg_id_header,
+      sizeof (opus_ogg_id_header));
+  ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+  gst_buffer_ref (inbuffer);
+
+  /* pushing gives away my reference ... */
+  fail_unless (gst_pad_push (mydecsrcpad, inbuffer) == GST_FLOW_OK);
+  /* ... and nothing ends up on the global buffer list */
+  ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+  gst_buffer_unref (inbuffer);
+  fail_unless (g_list_length (buffers) == 0);
+
+  /* cleanup */
+  cleanup_opusdec (opusdec);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_opus_encode_nothing)
+{
+  GstElement *opusenc;
+
+  opusenc = setup_opusenc ();
+  fail_unless (gst_element_set_state (opusenc,
+          GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to playing");
+
+  fail_unless (gst_pad_push_event (myencsrcpad, gst_event_new_eos ()) == TRUE);
+
+  fail_unless (gst_element_set_state (opusenc,
+          GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to ready");
+
+  /* cleanup */
+  cleanup_opusenc (opusenc);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_opus_decode_nothing)
+{
+  GstElement *opusdec;
+
+  opusdec = setup_opusdec ();
+  fail_unless (gst_element_set_state (opusdec,
+          GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to playing");
+
+  fail_unless (gst_pad_push_event (mydecsrcpad, gst_event_new_eos ()) == TRUE);
+
+  fail_unless (gst_element_set_state (opusdec,
+          GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to ready");
+
+  /* cleanup */
+  cleanup_opusdec (opusdec);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_opus_encode_samples)
+{
+  const unsigned int nsamples = 4096;
+  GstElement *opusenc;
+  GstBuffer *inbuffer;
+  GstCaps *caps;
+  guint16 *samples;
+  unsigned int n;
+
+  opusenc = setup_opusenc ();
+
+  fail_unless (gst_element_set_state (opusenc,
+          GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to playing");
+
+  inbuffer = gst_buffer_new_and_alloc (nsamples * 2);
+  samples = (guint16 *) GST_BUFFER_DATA (inbuffer);
+  for (n = 0; n < nsamples; ++n) {
+    samples[n] = 0;
+  }
+
+  GST_BUFFER_TIMESTAMP (inbuffer) = GST_BUFFER_OFFSET (inbuffer) = 0;
+  GST_BUFFER_DURATION (inbuffer) = GST_CLOCK_TIME_NONE;
+  ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+
+  caps =
+      gst_caps_from_string
+      ("audio/x-raw-int,rate=48000,channels=1,signed=true,width=16,depth=16,endianness=1234");
+  fail_unless (caps != NULL);
+  gst_buffer_set_caps (inbuffer, caps);
+  gst_caps_unref (caps);
+  gst_buffer_ref (inbuffer);
+
+  /* pushing gives away my reference ... */
+  fail_unless (gst_pad_push (myencsrcpad, inbuffer) == GST_FLOW_OK);
+  /* ... and nothing ends up on the global buffer list */
+  fail_unless (gst_pad_push_event (myencsrcpad, gst_event_new_eos ()) == TRUE);
+
+  ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+  gst_buffer_unref (inbuffer);
+
+  fail_unless (gst_element_set_state (opusenc,
+          GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to ready");
+
+  /* default frame size is 20 ms, at 48000 Hz that's 960 samples */
+  check_buffers ((nsamples + 959) / 960, FALSE);
+
+  /* cleanup */
+  cleanup_opusenc (opusenc);
+  g_list_free (buffers);
+}
+
+GST_END_TEST;
+
+GST_START_TEST (test_opus_encode_properties)
+{
+  const unsigned int nsamples = 4096;
+  enum
+  { steps = 20 };
+  GstElement *opusenc;
+  GstBuffer *inbuffer;
+  GstCaps *caps;
+  guint16 *samples;
+  unsigned int n, step;
+  static const struct
+  {
+    const char *param;
+    int value;
+  } param_changes[steps] = {
+    {
+    "frame-size", 40}, {
+    "inband-fec", 1}, {
+    "complexity", 5}, {
+    "bandwidth", 1104}, {
+    "frame-size", 2}, {
+    "max-payload-size", 80}, {
+    "frame-size", 60}, {
+    "max-payload-size", 900}, {
+    "complexity", 1}, {
+    "bitrate", 30000}, {
+    "frame-size", 10}, {
+    "bitrate", 300000}, {
+    "inband-fec", 0}, {
+    "frame-size", 5}, {
+    "bandwidth", 1101}, {
+    "frame-size", 10}, {
+    "bitrate", 500000}, {
+    "frame-size", 5}, {
+    "bitrate", 80000}, {
+  "complexity", 8},};
+
+  opusenc = setup_opusenc ();
+
+  fail_unless (gst_element_set_state (opusenc,
+          GST_STATE_PLAYING) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to playing");
+
+  caps =
+      gst_caps_from_string
+      ("audio/x-raw-int,rate=48000,channels=1,signed=true,width=16,depth=16,endianness=1234");
+  fail_unless (caps != NULL);
+
+  for (step = 0; step < steps; ++step) {
+    inbuffer = gst_buffer_new_and_alloc (nsamples * 2);
+    samples = (guint16 *) GST_BUFFER_DATA (inbuffer);
+    for (n = 0; n < nsamples; ++n) {
+      samples[n] = 0;
+    }
+
+    GST_BUFFER_TIMESTAMP (inbuffer) = GST_BUFFER_OFFSET (inbuffer) = 0;
+    GST_BUFFER_DURATION (inbuffer) = GST_CLOCK_TIME_NONE;
+    ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+
+    gst_buffer_set_caps (inbuffer, caps);
+    gst_buffer_ref (inbuffer);
+
+    /* pushing gives away my reference ... */
+    fail_unless (gst_pad_push (myencsrcpad, inbuffer) == GST_FLOW_OK);
+    /* ... and nothing ends up on the global buffer list */
+    fail_unless (gst_pad_push_event (myencsrcpad,
+            gst_event_new_eos ()) == TRUE);
+
+    ASSERT_BUFFER_REFCOUNT (inbuffer, "inbuffer", 1);
+    gst_buffer_unref (inbuffer);
+
+    /* change random parameters */
+    g_object_set (opusenc, param_changes[step].param, param_changes[step].value,
+        NULL);
+  }
+
+  gst_caps_unref (caps);
+
+  fail_unless (gst_element_set_state (opusenc,
+          GST_STATE_READY) == GST_STATE_CHANGE_SUCCESS,
+      "could not set to ready");
+
+  /* cleanup */
+  cleanup_opusenc (opusenc);
+  g_list_free (buffers);
+}
+
+GST_END_TEST;
+
+static Suite *
+opus_suite (void)
+{
+  Suite *s = suite_create ("opus");
+  TCase *tc_chain = tcase_create ("general");
+
+  suite_add_tcase (s, tc_chain);
+
+#define X if (0)
+  tcase_add_test (tc_chain, test_opus_id_header);
+  tcase_add_test (tc_chain, test_opus_encode_nothing);
+  tcase_add_test (tc_chain, test_opus_decode_nothing);
+  tcase_add_test (tc_chain, test_opus_encode_samples);
+  tcase_add_test (tc_chain, test_opus_encode_properties);
+#undef X
+
+  return s;
+}
+
+int
+main (int argc, char **argv)
+{
+  int nf;
+
+  Suite *s = opus_suite ();
+  SRunner *sr = srunner_create (s);
+
+  gst_check_init (&argc, &argv);
+
+  srunner_run_all (sr, CK_NORMAL);
+  nf = srunner_ntests_failed (sr);
+  srunner_free (sr);
+
+  return nf;
+}