From b508287add7d43b66437ce856098ff86965190bc Mon Sep 17 00:00:00 2001
From: Mathieu Duponchelle <mathieu@centricular.com>
Date: Tue, 3 Nov 2020 02:41:31 +0100
Subject: [PATCH] taskpool: expose dispose_handle() API

This is useful when the subclass does return a non-NULL pointer
in push(), and the user doesn't want to call join()

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/692>
---
 gst/gsttaskpool.c | 36 +++++++++++++++++++++++++++++++++++-
 gst/gsttaskpool.h | 13 +++++++++++++
 2 files changed, 48 insertions(+), 1 deletion(-)

diff --git a/gst/gsttaskpool.c b/gst/gsttaskpool.c
index ceda5350ba..b23c52bde7 100644
--- a/gst/gsttaskpool.c
+++ b/gst/gsttaskpool.c
@@ -126,6 +126,12 @@ default_join (GstTaskPool * pool, gpointer id)
   /* we do nothing here, we can't join from the pools */
 }
 
+static void
+default_dispose_handle (GstTaskPool * pool, gpointer id)
+{
+  /* we do nothing here, the default handle is NULL */
+}
+
 static void
 gst_task_pool_class_init (GstTaskPoolClass * klass)
 {
@@ -143,6 +149,7 @@ gst_task_pool_class_init (GstTaskPoolClass * klass)
   gsttaskpool_class->cleanup = default_cleanup;
   gsttaskpool_class->push = default_push;
   gsttaskpool_class->join = default_join;
+  gsttaskpool_class->dispose_handle = default_dispose_handle;
 }
 
 static void
@@ -235,7 +242,9 @@ gst_task_pool_cleanup (GstTaskPool * pool)
  *
  * Returns: (transfer full) (nullable): a pointer that should be used
  * for the gst_task_pool_join function. This pointer can be %NULL, you
- * must check @error to detect errors.
+ * must check @error to detect errors. If the pointer is not %NULL and
+ * gst_task_pool_join() is not used, call gst_task_pool_dispose_handle()
+ * instead.
  */
 gpointer
 gst_task_pool_push (GstTaskPool * pool, GstTaskPoolFunction func,
@@ -281,3 +290,28 @@ gst_task_pool_join (GstTaskPool * pool, gpointer id)
   if (klass->join)
     klass->join (pool, id);
 }
+
+/**
+ * gst_task_pool_dispose_handle:
+ * @pool: a #GstTaskPool
+ * @id: (transfer full) (nullable): the id
+ *
+ * Dispose of the handle returned by gst_task_pool_push(). This does
+ * not need to be called with the default implementation as the default
+ * push() implementation always returns %NULL. This does not need to be
+ * called either when calling gst_task_pool_join().
+ *
+ * Since: 1.20
+ */
+void
+gst_task_pool_dispose_handle (GstTaskPool * pool, gpointer id)
+{
+  GstTaskPoolClass *klass;
+
+  g_return_if_fail (GST_IS_TASK_POOL (pool));
+
+  klass = GST_TASK_POOL_GET_CLASS (pool);
+
+  if (klass->dispose_handle)
+    klass->dispose_handle (pool, id);
+}
diff --git a/gst/gsttaskpool.h b/gst/gsttaskpool.h
index 8bae5f5c65..318fad7ebf 100644
--- a/gst/gsttaskpool.h
+++ b/gst/gsttaskpool.h
@@ -67,6 +67,7 @@ struct _GstTaskPool {
  * @cleanup: make sure all threads are stopped
  * @push: start a new thread
  * @join: join a thread
+ * @dispose_handle: free / unref the handle returned in push
  *
  * The #GstTaskPoolClass object.
  */
@@ -81,6 +82,15 @@ struct _GstTaskPoolClass {
                          gpointer user_data, GError **error);
   void      (*join)     (GstTaskPool *pool, gpointer id);
 
+  /**
+   * GstTaskPoolClass::dispose_handle:
+   *
+   * free / unref the handle returned in push.
+   *
+   * Since: 1.20
+   */
+  void      (*dispose_handle) (GstTaskPool *pool, gpointer id);
+
   /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
@@ -100,6 +110,9 @@ gpointer        gst_task_pool_push        (GstTaskPool *pool, GstTaskPoolFunctio
 GST_API
 void            gst_task_pool_join        (GstTaskPool *pool, gpointer id);
 
+GST_API
+void            gst_task_pool_dispose_handle (GstTaskPool *pool, gpointer id);
+
 GST_API
 void		gst_task_pool_cleanup     (GstTaskPool *pool);