From 023d381dcc15e96bfcd000cf69d0758f1c224bc6 Mon Sep 17 00:00:00 2001
From: Camilo Celis Guzman <camilo@pexip.com>
Date: Fri, 18 Mar 2022 13:54:23 +0100
Subject: [PATCH] gstreamer/harness: make pull timesout configurable

Although 60 seconds is often enough, we have seen cases where
the harnessed pipeline could taken longer than that to process a buffer.

This is especially true when we run under additional tools like Valgrind
or Debug builds.
---
 .../gstreamer/libs/gst/check/gstharness.c     | 44 ++++++++++++++++---
 .../gstreamer/libs/gst/check/gstharness.h     |  3 ++
 2 files changed, 40 insertions(+), 7 deletions(-)

diff --git a/subprojects/gstreamer/libs/gst/check/gstharness.c b/subprojects/gstreamer/libs/gst/check/gstharness.c
index fc1ab0dafe..21d386e0c5 100644
--- a/subprojects/gstreamer/libs/gst/check/gstharness.c
+++ b/subprojects/gstreamer/libs/gst/check/gstharness.c
@@ -206,6 +206,8 @@ struct _GstHarnessPrivate
   gboolean eos_received;
 
   GPtrArray *stress;
+
+  guint64 pull_timeout;
 };
 
 static GstFlowReturn
@@ -716,6 +718,9 @@ gst_harness_new_empty (void)
   /* we have forwarding on as a default */
   gst_harness_set_forwarding (h, TRUE);
 
+  /* we default to 60s as pull timeout */
+  gst_harness_set_pull_timeout (h, G_USEC_PER_SEC * 60);
+
   return h;
 }
 
@@ -1598,6 +1603,31 @@ gst_harness_set_forward_pad (GstHarness * h, GstPad * fwdpad)
       (GstObject *) fwdpad);
 }
 
+/**
+ * gst_harness_set_pull_timeout:
+ * @h: a #GstHarness
+ * @timeout: timeout in microseconds
+ *
+ * Sets the timeout to use on all pull-like methods. This affects src and sink
+ * harnesses if any.
+ *
+ * MT safe.
+ *
+ * Since: 1.20
+ **/
+void
+gst_harness_set_pull_timeout (GstHarness * h, guint64 timeout)
+{
+  GstHarnessPrivate *priv = h->priv;
+  priv->pull_timeout = timeout;
+
+  /* propagate timeout to src and sink harnesses, if any */
+  if (h->src_harness)
+    gst_harness_set_pull_timeout (h->src_harness, timeout);
+  if (h->sink_harness)
+    gst_harness_set_pull_timeout (h->sink_harness, timeout);
+}
+
 /**
  * gst_harness_create_buffer:
  * @h: a #GstHarness
@@ -1671,8 +1701,8 @@ gst_harness_push (GstHarness * h, GstBuffer * buffer)
  * @h: a #GstHarness
  *
  * Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. The pull
- * will timeout in 60 seconds. This is the standard way of getting a buffer
- * from a harnessed #GstElement.
+ * will timeout in #GstHarness.pull_timeout seconds. This is the standard way
+ * of getting a buffer from a harnessed #GstElement.
  *
  * MT safe.
  *
@@ -1685,7 +1715,7 @@ gst_harness_pull (GstHarness * h)
 {
   GstHarnessPrivate *priv = h->priv;
   GstBuffer *buf = (GstBuffer *) g_async_queue_timeout_pop (priv->buffer_queue,
-      G_USEC_PER_SEC * 60);
+      priv->pull_timeout);
 
   if (priv->blocking_push_mode) {
     g_mutex_lock (&priv->blocking_push_mutex);
@@ -2005,7 +2035,7 @@ gst_harness_push_event (GstHarness * h, GstEvent * event)
  * @h: a #GstHarness
  *
  * Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness sinkpad.
- * Timeouts after 60 seconds similar to gst_harness_pull.
+ * Timeouts after #GstHarness.pull_timeout seconds similar to gst_harness_pull.
  *
  * MT safe.
  *
@@ -2018,7 +2048,7 @@ gst_harness_pull_event (GstHarness * h)
 {
   GstHarnessPrivate *priv = h->priv;
   return (GstEvent *) g_async_queue_timeout_pop (priv->sink_event_queue,
-      G_USEC_PER_SEC * 60);
+      priv->pull_timeout);
 }
 
 /**
@@ -2108,7 +2138,7 @@ gst_harness_push_upstream_event (GstHarness * h, GstEvent * event)
  * @h: a #GstHarness
  *
  * Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness srcpad.
- * Timeouts after 60 seconds similar to gst_harness_pull.
+ * Timeouts after #GstHarness.pull_timeout seconds similar to gst_harness_pull.
  *
  * MT safe.
  *
@@ -2121,7 +2151,7 @@ gst_harness_pull_upstream_event (GstHarness * h)
 {
   GstHarnessPrivate *priv = h->priv;
   return (GstEvent *) g_async_queue_timeout_pop (priv->src_event_queue,
-      G_USEC_PER_SEC * 60);
+      priv->pull_timeout);
 }
 
 /**
diff --git a/subprojects/gstreamer/libs/gst/check/gstharness.h b/subprojects/gstreamer/libs/gst/check/gstharness.h
index 160fdb01d8..9680dfaddc 100644
--- a/subprojects/gstreamer/libs/gst/check/gstharness.h
+++ b/subprojects/gstreamer/libs/gst/check/gstharness.h
@@ -174,6 +174,9 @@ void           gst_harness_set_blocking_push_mode (GstHarness * h);
 GST_CHECK_API
 void           gst_harness_set_forwarding (GstHarness * h, gboolean forwarding);
 
+GST_CHECK_API
+void           gst_harness_set_pull_timeout (GstHarness * h, guint64 timeout);
+
 /* buffers */
 
 GST_CHECK_API