gst/gsttaskpool.c

   1 /* GStreamer
   2  * Copyright (C) 2009 Wim Taymans <wim.taymans@gmail.com>
   3  *
   4  * gsttaskpool.c: Pool for streaming threads
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 /**
  23  * SECTION:gsttaskpool
  24  * @title: GstTaskPool
  25  * @short_description: Pool of GStreamer streaming threads
  26  * @see_also: #GstTask, #GstPad
  27  *
  28  * This object provides an abstraction for creating threads. The default
  29  * implementation uses a regular GThreadPool to start tasks.
  30  *
  31  * Subclasses can be made to create custom threads.
  32  */
  33
  34 #include "gst_private.h"
  35
  36 #include "gstinfo.h"
  37 #include "gsttaskpool.h"
  38 #include "gsterror.h"
  39
  40 GST_DEBUG_CATEGORY_STATIC (taskpool_debug);
  41 #define GST_CAT_DEFAULT (taskpool_debug)
  42
  43 #ifndef GST_DISABLE_GST_DEBUG
  44 static void gst_task_pool_finalize (GObject * object);
  45 #endif
  46
  47 #define _do_init \
  48 { \
  49   GST_DEBUG_CATEGORY_INIT (taskpool_debug, "taskpool", 0, "Thread pool"); \
  50 }
  51
  52 G_DEFINE_TYPE_WITH_CODE (GstTaskPool, gst_task_pool, GST_TYPE_OBJECT, _do_init);
  53
  54 typedef struct
  55 {
  56   GstTaskPoolFunction func;
  57   gpointer user_data;
  58 } TaskData;
  59
  60 static void
  61 default_func (TaskData * tdata, GstTaskPool * pool)
  62 {
  63   GstTaskPoolFunction func;
  64   gpointer user_data;
  65
  66   func = tdata->func;
  67   user_data = tdata->user_data;
  68   g_slice_free (TaskData, tdata);
  69
  70   func (user_data);
  71 }
  72
  73 static void
  74 default_prepare (GstTaskPool * pool, GError ** error)
  75 {
  76   GST_OBJECT_LOCK (pool);
  77   pool->pool = g_thread_pool_new ((GFunc) default_func, pool, -1, FALSE, error);
  78   GST_OBJECT_UNLOCK (pool);
  79 }
  80
  81 static void
  82 default_cleanup (GstTaskPool * pool)
  83 {
  84   GST_OBJECT_LOCK (pool);
  85   if (pool->pool) {
  86     /* Shut down all the threads, we still process the ones scheduled
  87      * because the unref happens in the thread function.
  88      * Also wait for currently running ones to finish. */
  89     g_thread_pool_free (pool->pool, FALSE, TRUE);
  90     pool->pool = NULL;
  91   }
  92   GST_OBJECT_UNLOCK (pool);
  93 }
  94
  95 static gpointer
  96 default_push (GstTaskPool * pool, GstTaskPoolFunction func,
  97     gpointer user_data, GError ** error)
  98 {
  99   TaskData *tdata;
 100
 101   tdata = g_slice_new (TaskData);
 102   tdata->func = func;
 103   tdata->user_data = user_data;
 104
 105   GST_OBJECT_LOCK (pool);
 106   if (pool->pool)
 107     g_thread_pool_push (pool->pool, tdata, error);
 108   else {
 109     g_slice_free (TaskData, tdata);
 110     g_set_error_literal (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
 111         "No thread pool");
 112
 113   }
 114   GST_OBJECT_UNLOCK (pool);
 115
 116   return NULL;
 117 }
 118
 119 static void
 120 default_join (GstTaskPool * pool, gpointer id)
 121 {
 122   /* we do nothing here, we can't join from the pools */
 123 }
 124
 125 static void
 126 gst_task_pool_class_init (GstTaskPoolClass * klass)
 127 {
 128   GObjectClass *gobject_class;
 129   GstTaskPoolClass *gsttaskpool_class;
 130
 131   gobject_class = (GObjectClass *) klass;
 132   gsttaskpool_class = (GstTaskPoolClass *) klass;
 133
 134 #ifndef GST_DISABLE_GST_DEBUG
 135   gobject_class->finalize = gst_task_pool_finalize;
 136 #endif
 137
 138   gsttaskpool_class->prepare = default_prepare;
 139   gsttaskpool_class->cleanup = default_cleanup;
 140   gsttaskpool_class->push = default_push;
 141   gsttaskpool_class->join = default_join;
 142 }
 143
 144 static void
 145 gst_task_pool_init (GstTaskPool * pool)
 146 {
 147 }
 148
 149 #ifndef GST_DISABLE_GST_DEBUG
 150 static void
 151 gst_task_pool_finalize (GObject * object)
 152 {
 153   GST_DEBUG ("taskpool %p finalize", object);
 154
 155   G_OBJECT_CLASS (gst_task_pool_parent_class)->finalize (object);
 156 }
 157 #endif
 158 /**
 159  * gst_task_pool_new:
 160  *
 161  * Create a new default task pool. The default task pool will use a regular
 162  * GThreadPool for threads.
 163  *
 164  * Returns: (transfer full): a new #GstTaskPool. gst_object_unref() after usage.
 165  */
 166 GstTaskPool *
 167 gst_task_pool_new (void)
 168 {
 169   GstTaskPool *pool;
 170
 171   pool = g_object_new (GST_TYPE_TASK_POOL, NULL);
 172
 173   /* clear floating flag */
 174   gst_object_ref_sink (pool);
 175
 176   return pool;
 177 }
 178
 179 /**
 180  * gst_task_pool_prepare:
 181  * @pool: a #GstTaskPool
 182  * @error: an error return location
 183  *
 184  * Prepare the taskpool for accepting gst_task_pool_push() operations.
 185  *
 186  * MT safe.
 187  */
 188 void
 189 gst_task_pool_prepare (GstTaskPool * pool, GError ** error)
 190 {
 191   GstTaskPoolClass *klass;
 192
 193   g_return_if_fail (GST_IS_TASK_POOL (pool));
 194
 195   klass = GST_TASK_POOL_GET_CLASS (pool);
 196
 197   if (klass->prepare)
 198     klass->prepare (pool, error);
 199 }
 200
 201 /**
 202  * gst_task_pool_cleanup:
 203  * @pool: a #GstTaskPool
 204  *
 205  * Wait for all tasks to be stopped. This is mainly used internally
 206  * to ensure proper cleanup of internal data structures in test suites.
 207  *
 208  * MT safe.
 209  */
 210 void
 211 gst_task_pool_cleanup (GstTaskPool * pool)
 212 {
 213   GstTaskPoolClass *klass;
 214
 215   g_return_if_fail (GST_IS_TASK_POOL (pool));
 216
 217   klass = GST_TASK_POOL_GET_CLASS (pool);
 218
 219   if (klass->cleanup)
 220     klass->cleanup (pool);
 221 }
 222
 223 /**
 224  * gst_task_pool_push:
 225  * @pool: a #GstTaskPool
 226  * @func: (scope async): the function to call
 227  * @user_data: (closure): data to pass to @func
 228  * @error: return location for an error
 229  *
 230  * Start the execution of a new thread from @pool.
 231  *
 232  * Returns: (transfer none) (nullable): a pointer that should be used
 233  * for the gst_task_pool_join function. This pointer can be %NULL, you
 234  * must check @error to detect errors.
 235  */
 236 gpointer
 237 gst_task_pool_push (GstTaskPool * pool, GstTaskPoolFunction func,
 238     gpointer user_data, GError ** error)
 239 {
 240   GstTaskPoolClass *klass;
 241
 242   g_return_val_if_fail (GST_IS_TASK_POOL (pool), NULL);
 243
 244   klass = GST_TASK_POOL_GET_CLASS (pool);
 245
 246   if (klass->push == NULL)
 247     goto not_supported;
 248
 249   return klass->push (pool, func, user_data, error);
 250
 251   /* ERRORS */
 252 not_supported:
 253   {
 254     g_warning ("pushing tasks on pool %p is not supported", pool);
 255     return NULL;
 256   }
 257 }
 258
 259 /**
 260  * gst_task_pool_join:
 261  * @pool: a #GstTaskPool
 262  * @id: the id
 263  *
 264  * Join a task and/or return it to the pool. @id is the id obtained from
 265  * gst_task_pool_push().
 266  */
 267 void
 268 gst_task_pool_join (GstTaskPool * pool, gpointer id)
 269 {
 270   GstTaskPoolClass *klass;
 271
 272   g_return_if_fail (GST_IS_TASK_POOL (pool));
 273
 274   klass = GST_TASK_POOL_GET_CLASS (pool);
 275
 276   if (klass->join)
 277     klass->join (pool, id);
 278 }