mobile/gst/gsttask.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2005 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gsttask.c: Streaming tasks
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:gsttask
  25  * @short_description: Abstraction of GStreamer streaming threads.
  26  * @see_also: #GstElement, #GstPad
  27  *
  28  * #GstTask is used by #GstElement and #GstPad to provide the data passing
  29  * threads in a #GstPipeline.
  30  *
  31  * A #GstPad will typically start a #GstTask to push or pull data to/from the
  32  * peer pads. Most source elements start a #GstTask to push data. In some cases
  33  * a demuxer element can start a #GstTask to pull data from a peer element. This
  34  * is typically done when the demuxer can perform random access on the upstream
  35  * peer element for improved performance.
  36  *
  37  * Although convenience functions exist on #GstPad to start/pause/stop tasks, it
  38  * might sometimes be needed to create a #GstTask manually if it is not related to
  39  * a #GstPad.
  40  *
  41  * Before the #GstTask can be run, it needs a #GStaticRecMutex that can be set with
  42  * gst_task_set_lock().
  43  *
  44  * The task can be started, paused and stopped with gst_task_start(), gst_task_pause()
  45  * and gst_task_stop() respectively or with the gst_task_set_state() function.
  46  *
  47  * A #GstTask will repeatedly call the #GstTaskFunction with the user data
  48  * that was provided when creating the task with gst_task_create(). While calling
  49  * the function it will acquire the provided lock. The provided lock is released
  50  * when the task pauses or stops.
  51  *
  52  * Stopping a task with gst_task_stop() will not immediately make sure the task is
  53  * not running anymore. Use gst_task_join() to make sure the task is completely
  54  * stopped and the thread is stopped.
  55  *
  56  * After creating a #GstTask, use gst_object_unref() to free its resources. This can
  57  * only be done it the task is not running anymore.
  58  *
  59  * Task functions can send a #GstMessage to send out-of-band data to the
  60  * application. The application can receive messages from the #GstBus in its
  61  * mainloop.
  62  *
  63  * For debugging perposes, the task will configure its object name as the thread
  64  * name on Linux. Please note that the object name should be configured before the
  65  * task is started; changing the object name after the task has been started, has
  66  * no effect on the thread name.
  67  *
  68  * Last reviewed on 2010-03-15 (0.10.29)
  69  */
  70
  71 /* FIXME 0.11: suppress warnings for deprecated API such as GStaticRecMutex
  72  * with newer GLib versions (>= 2.31.0) */
  73 #define GLIB_DISABLE_DEPRECATION_WARNINGS
  74 #include "gst_private.h"
  75
  76 #include "gstinfo.h"
  77 #include "gsttask.h"
  78 #include "glib-compat-private.h"
  79
  80 #include <stdio.h>
  81
  82 #ifdef HAVE_SYS_PRCTL_H
  83 #include <sys/prctl.h>
  84 #endif
  85
  86 GST_DEBUG_CATEGORY_STATIC (task_debug);
  87 #define GST_CAT_DEFAULT (task_debug)
  88
  89 #define SET_TASK_STATE(t,s) (g_atomic_int_set (&GST_TASK_STATE(t), (s)))
  90 #define GET_TASK_STATE(t)   ((GstTaskState) g_atomic_int_get (&GST_TASK_STATE(t)))
  91
  92 #define GST_TASK_GET_PRIVATE(obj)  \
  93    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_TASK, GstTaskPrivate))
  94
  95 struct _GstTaskPrivate
  96 {
  97   /* callbacks for managing the thread of this task */
  98   GstTaskThreadCallbacks thr_callbacks;
  99   gpointer thr_user_data;
 100   GDestroyNotify thr_notify;
 101
 102   gboolean prio_set;
 103   GThreadPriority priority;
 104
 105   /* configured pool */
 106   GstTaskPool *pool;
 107
 108   /* remember the pool and id that is currently running. */
 109   gpointer id;
 110   GstTaskPool *pool_id;
 111 };
 112
 113 #ifdef _MSC_VER
 114 #include <windows.h>
 115
 116 struct _THREADNAME_INFO
 117 {
 118   DWORD dwType;                 // must be 0x1000
 119   LPCSTR szName;                // pointer to name (in user addr space)
 120   DWORD dwThreadID;             // thread ID (-1=caller thread)
 121   DWORD dwFlags;                // reserved for future use, must be zero
 122 };
 123 typedef struct _THREADNAME_INFO THREADNAME_INFO;
 124
 125 void
 126 SetThreadName (DWORD dwThreadID, LPCSTR szThreadName)
 127 {
 128   THREADNAME_INFO info;
 129   info.dwType = 0x1000;
 130   info.szName = szThreadName;
 131   info.dwThreadID = dwThreadID;
 132   info.dwFlags = 0;
 133
 134   __try {
 135     RaiseException (0x406D1388, 0, sizeof (info) / sizeof (DWORD),
 136         (DWORD *) & info);
 137   }
 138   __except (EXCEPTION_CONTINUE_EXECUTION) {
 139   }
 140 }
 141 #endif
 142
 143 static void gst_task_finalize (GObject * object);
 144
 145 static void gst_task_func (GstTask * task);
 146
 147 static GStaticMutex pool_lock = G_STATIC_MUTEX_INIT;
 148
 149 #define _do_init \
 150 { \
 151   GST_DEBUG_CATEGORY_INIT (task_debug, "task", 0, "Processing tasks"); \
 152 }
 153
 154 G_DEFINE_TYPE_WITH_CODE (GstTask, gst_task, GST_TYPE_OBJECT, _do_init);
 155
 156 static void
 157 init_klass_pool (GstTaskClass * klass)
 158 {
 159   g_static_mutex_lock (&pool_lock);
 160   if (klass->pool) {
 161     gst_task_pool_cleanup (klass->pool);
 162     gst_object_unref (klass->pool);
 163   }
 164   klass->pool = gst_task_pool_new ();
 165   gst_task_pool_prepare (klass->pool, NULL);
 166   g_static_mutex_unlock (&pool_lock);
 167 }
 168
 169 static void
 170 gst_task_class_init (GstTaskClass * klass)
 171 {
 172   GObjectClass *gobject_class;
 173
 174   gobject_class = (GObjectClass *) klass;
 175
 176   g_type_class_add_private (klass, sizeof (GstTaskPrivate));
 177
 178   gobject_class->finalize = gst_task_finalize;
 179
 180   init_klass_pool (klass);
 181 }
 182
 183 static void
 184 gst_task_init (GstTask * task)
 185 {
 186   GstTaskClass *klass;
 187
 188   klass = GST_TASK_GET_CLASS (task);
 189
 190   task->priv = GST_TASK_GET_PRIVATE (task);
 191   task->running = FALSE;
 192   task->abidata.ABI.thread = NULL;
 193   task->lock = NULL;
 194   task->cond = g_cond_new ();
 195   SET_TASK_STATE (task, GST_TASK_STOPPED);
 196   task->priv->prio_set = FALSE;
 197
 198   /* use the default klass pool for this task, users can
 199    * override this later */
 200   g_static_mutex_lock (&pool_lock);
 201   task->priv->pool = gst_object_ref (klass->pool);
 202   g_static_mutex_unlock (&pool_lock);
 203 }
 204
 205 static void
 206 gst_task_finalize (GObject * object)
 207 {
 208   GstTask *task = GST_TASK (object);
 209   GstTaskPrivate *priv = task->priv;
 210
 211   GST_DEBUG ("task %p finalize", task);
 212
 213   if (priv->thr_notify)
 214     priv->thr_notify (priv->thr_user_data);
 215   priv->thr_notify = NULL;
 216   priv->thr_user_data = NULL;
 217
 218   gst_object_unref (priv->pool);
 219
 220   /* task thread cannot be running here since it holds a ref
 221    * to the task so that the finalize could not have happened */
 222   g_cond_free (task->cond);
 223   task->cond = NULL;
 224
 225   G_OBJECT_CLASS (gst_task_parent_class)->finalize (object);
 226 }
 227
 228 /* should be called with the object LOCK */
 229 static void
 230 gst_task_configure_name (GstTask * task)
 231 {
 232 #if defined(HAVE_SYS_PRCTL_H) && defined(PR_SET_NAME)
 233   const gchar *name;
 234   gchar thread_name[17] = { 0, };
 235
 236   GST_OBJECT_LOCK (task);
 237   name = GST_OBJECT_NAME (task);
 238
 239   /* set the thread name to something easily identifiable */
 240   if (!snprintf (thread_name, 17, "%s", GST_STR_NULL (name))) {
 241     GST_DEBUG_OBJECT (task, "Could not create thread name for '%s'", name);
 242   } else {
 243     GST_DEBUG_OBJECT (task, "Setting thread name to '%s'", thread_name);
 244     if (prctl (PR_SET_NAME, (unsigned long int) thread_name, 0, 0, 0))
 245       GST_DEBUG_OBJECT (task, "Failed to set thread name");
 246   }
 247   GST_OBJECT_UNLOCK (task);
 248 #endif
 249 #ifdef _MSC_VER
 250   const gchar *name;
 251   name = GST_OBJECT_NAME (task);
 252
 253   /* set the thread name to something easily identifiable */
 254   GST_DEBUG_OBJECT (task, "Setting thread name to '%s'", name);
 255   SetThreadName (-1, name);
 256 #endif
 257 }
 258
 259 static void
 260 gst_task_func (GstTask * task)
 261 {
 262   GStaticRecMutex *lock;
 263   GThread *tself;
 264   GstTaskPrivate *priv;
 265
 266   priv = task->priv;
 267
 268   tself = g_thread_self ();
 269
 270   GST_DEBUG ("Entering task %p, thread %p", task, tself);
 271
 272   /* we have to grab the lock to get the mutex. We also
 273    * mark our state running so that nobody can mess with
 274    * the mutex. */
 275   GST_OBJECT_LOCK (task);
 276   if (GET_TASK_STATE (task) == GST_TASK_STOPPED)
 277     goto exit;
 278   lock = GST_TASK_GET_LOCK (task);
 279   if (G_UNLIKELY (lock == NULL))
 280     goto no_lock;
 281   task->abidata.ABI.thread = tself;
 282   /* only update the priority when it was changed */
 283   if (priv->prio_set) {
 284 #if !GLIB_CHECK_VERSION (2, 31, 0)
 285     g_thread_set_priority (tself, priv->priority);
 286 #else
 287     GST_INFO_OBJECT (task, "Thread priorities no longer have any effect");
 288 #endif
 289   }
 290   GST_OBJECT_UNLOCK (task);
 291
 292   /* fire the enter_thread callback when we need to */
 293   if (priv->thr_callbacks.enter_thread)
 294     priv->thr_callbacks.enter_thread (task, tself, priv->thr_user_data);
 295
 296   /* locking order is TASK_LOCK, LOCK */
 297   g_static_rec_mutex_lock (lock);
 298   /* configure the thread name now */
 299   gst_task_configure_name (task);
 300
 301   while (G_LIKELY (GET_TASK_STATE (task) != GST_TASK_STOPPED)) {
 302     if (G_UNLIKELY (GET_TASK_STATE (task) == GST_TASK_PAUSED)) {
 303       GST_OBJECT_LOCK (task);
 304       while (G_UNLIKELY (GST_TASK_STATE (task) == GST_TASK_PAUSED)) {
 305         gint t;
 306
 307         t = g_static_rec_mutex_unlock_full (lock);
 308         if (t <= 0) {
 309           g_warning ("wrong STREAM_LOCK count %d", t);
 310         }
 311         GST_TASK_SIGNAL (task);
 312         GST_TASK_WAIT (task);
 313         GST_OBJECT_UNLOCK (task);
 314         /* locking order.. */
 315         if (t > 0)
 316           g_static_rec_mutex_lock_full (lock, t);
 317
 318         GST_OBJECT_LOCK (task);
 319         if (G_UNLIKELY (GET_TASK_STATE (task) == GST_TASK_STOPPED)) {
 320           GST_OBJECT_UNLOCK (task);
 321           goto done;
 322         }
 323       }
 324       GST_OBJECT_UNLOCK (task);
 325     }
 326
 327     task->func (task->data);
 328   }
 329 done:
 330   g_static_rec_mutex_unlock (lock);
 331
 332   GST_OBJECT_LOCK (task);
 333   task->abidata.ABI.thread = NULL;
 334
 335 exit:
 336   if (priv->thr_callbacks.leave_thread) {
 337     /* fire the leave_thread callback when we need to. We need to do this before
 338      * we signal the task and with the task lock released. */
 339     GST_OBJECT_UNLOCK (task);
 340     priv->thr_callbacks.leave_thread (task, tself, priv->thr_user_data);
 341     GST_OBJECT_LOCK (task);
 342   } else {
 343     /* restore normal priority when releasing back into the pool, we will not
 344      * touch the priority when a custom callback has been installed. */
 345 #if !GLIB_CHECK_VERSION (2, 31, 0)
 346     g_thread_set_priority (tself, G_THREAD_PRIORITY_NORMAL);
 347 #endif
 348   }
 349   /* now we allow messing with the lock again by setting the running flag to
 350    * FALSE. Together with the SIGNAL this is the sign for the _join() to
 351    * complete.
 352    * Note that we still have not dropped the final ref on the task. We could
 353    * check here if there is a pending join() going on and drop the last ref
 354    * before releasing the lock as we can be sure that a ref is held by the
 355    * caller of the join(). */
 356   task->running = FALSE;
 357   GST_TASK_SIGNAL (task);
 358   GST_OBJECT_UNLOCK (task);
 359
 360   GST_DEBUG ("Exit task %p, thread %p", task, g_thread_self ());
 361
 362   gst_object_unref (task);
 363   return;
 364
 365 no_lock:
 366   {
 367     g_warning ("starting task without a lock");
 368     goto exit;
 369   }
 370 }
 371
 372 /**
 373  * gst_task_cleanup_all:
 374  *
 375  * Wait for all tasks to be stopped. This is mainly used internally
 376  * to ensure proper cleanup of internal data structures in test suites.
 377  *
 378  * MT safe.
 379  */
 380 void
 381 gst_task_cleanup_all (void)
 382 {
 383   GstTaskClass *klass;
 384
 385   if ((klass = g_type_class_peek (GST_TYPE_TASK))) {
 386     init_klass_pool (klass);
 387   }
 388 }
 389
 390 /**
 391  * gst_task_create:
 392  * @func: The #GstTaskFunction to use
 393  * @data: (closure): User data to pass to @func
 394  *
 395  * Create a new Task that will repeatedly call the provided @func
 396  * with @data as a parameter. Typically the task will run in
 397  * a new thread.
 398  *
 399  * The function cannot be changed after the task has been created. You
 400  * must create a new #GstTask to change the function.
 401  *
 402  * This function will not yet create and start a thread. Use gst_task_start() or
 403  * gst_task_pause() to create and start the GThread.
 404  *
 405  * Before the task can be used, a #GStaticRecMutex must be configured using the
 406  * gst_task_set_lock() function. This lock will always be acquired while
 407  * @func is called.
 408  *
 409  * Returns: (transfer full): A new #GstTask.
 410  *
 411  * MT safe.
 412  */
 413 GstTask *
 414 gst_task_create (GstTaskFunction func, gpointer data)
 415 {
 416   GstTask *task;
 417
 418   task = g_object_newv (GST_TYPE_TASK, 0, NULL);
 419   task->func = func;
 420   task->data = data;
 421
 422   GST_DEBUG ("Created task %p", task);
 423
 424   return task;
 425 }
 426
 427 /**
 428  * gst_task_set_lock:
 429  * @task: The #GstTask to use
 430  * @mutex: The #GMutex to use
 431  *
 432  * Set the mutex used by the task. The mutex will be acquired before
 433  * calling the #GstTaskFunction.
 434  *
 435  * This function has to be called before calling gst_task_pause() or
 436  * gst_task_start().
 437  *
 438  * MT safe.
 439  */
 440 void
 441 gst_task_set_lock (GstTask * task, GStaticRecMutex * mutex)
 442 {
 443   GST_OBJECT_LOCK (task);
 444   if (G_UNLIKELY (task->running))
 445     goto is_running;
 446   GST_TASK_GET_LOCK (task) = mutex;
 447   GST_OBJECT_UNLOCK (task);
 448
 449   return;
 450
 451   /* ERRORS */
 452 is_running:
 453   {
 454     GST_OBJECT_UNLOCK (task);
 455     g_warning ("cannot call set_lock on a running task");
 456   }
 457 }
 458
 459 /**
 460  * gst_task_set_priority:
 461  * @task: a #GstTask
 462  * @priority: a new priority for @task
 463  *
 464  * Changes the priority of @task to @priority.
 465  *
 466  * Note: try not to depend on task priorities.
 467  *
 468  * MT safe.
 469  *
 470  * Since: 0.10.24
 471  */
 472 void
 473 gst_task_set_priority (GstTask * task, GThreadPriority priority)
 474 {
 475   GstTaskPrivate *priv;
 476   GThread *thread;
 477
 478   g_return_if_fail (GST_IS_TASK (task));
 479
 480   priv = task->priv;
 481
 482   GST_OBJECT_LOCK (task);
 483   priv->prio_set = TRUE;
 484   priv->priority = priority;
 485   thread = task->abidata.ABI.thread;
 486   if (thread != NULL) {
 487     /* if this task already has a thread, we can configure the priority right
 488      * away, else we do that when we assign a thread to the task. */
 489 #if !GLIB_CHECK_VERSION (2, 31, 0)
 490     g_thread_set_priority (thread, priority);
 491 #else
 492     GST_INFO_OBJECT (task, "Thread priorities no longer have any effect");
 493 #endif
 494   }
 495   GST_OBJECT_UNLOCK (task);
 496 }
 497
 498 /**
 499  * gst_task_get_pool:
 500  * @task: a #GstTask
 501  *
 502  * Get the #GstTaskPool that this task will use for its streaming
 503  * threads.
 504  *
 505  * MT safe.
 506  *
 507  * Returns: (transfer full): the #GstTaskPool used by @task. gst_object_unref()
 508  * after usage.
 509  *
 510  * Since: 0.10.24
 511  */
 512 GstTaskPool *
 513 gst_task_get_pool (GstTask * task)
 514 {
 515   GstTaskPool *result;
 516   GstTaskPrivate *priv;
 517
 518   g_return_val_if_fail (GST_IS_TASK (task), NULL);
 519
 520   priv = task->priv;
 521
 522   GST_OBJECT_LOCK (task);
 523   result = gst_object_ref (priv->pool);
 524   GST_OBJECT_UNLOCK (task);
 525
 526   return result;
 527 }
 528
 529 /**
 530  * gst_task_set_pool:
 531  * @task: a #GstTask
 532  * @pool: (transfer none): a #GstTaskPool
 533  *
 534  * Set @pool as the new GstTaskPool for @task. Any new streaming threads that
 535  * will be created by @task will now use @pool.
 536  *
 537  * MT safe.
 538  *
 539  * Since: 0.10.24
 540  */
 541 void
 542 gst_task_set_pool (GstTask * task, GstTaskPool * pool)
 543 {
 544   GstTaskPool *old;
 545   GstTaskPrivate *priv;
 546
 547   g_return_if_fail (GST_IS_TASK (task));
 548   g_return_if_fail (GST_IS_TASK_POOL (pool));
 549
 550   priv = task->priv;
 551
 552   GST_OBJECT_LOCK (task);
 553   if (priv->pool != pool) {
 554     old = priv->pool;
 555     priv->pool = gst_object_ref (pool);
 556   } else
 557     old = NULL;
 558   GST_OBJECT_UNLOCK (task);
 559
 560   if (old)
 561     gst_object_unref (old);
 562 }
 563
 564
 565 /**
 566  * gst_task_set_thread_callbacks:
 567  * @task: The #GstTask to use
 568  * @callbacks: (in): a #GstTaskThreadCallbacks pointer
 569  * @user_data: (closure): user data passed to the callbacks
 570  * @notify: called when @user_data is no longer referenced
 571  *
 572  * Set callbacks which will be executed when a new thread is needed, the thread
 573  * function is entered and left and when the thread is joined.
 574  *
 575  * By default a thread for @task will be created from a default thread pool.
 576  *
 577  * Objects can use custom GThreads or can perform additional configuration of
 578  * the threads (such as changing the thread priority) by installing callbacks.
 579  *
 580  * MT safe.
 581  *
 582  * Since: 0.10.24
 583  */
 584 void
 585 gst_task_set_thread_callbacks (GstTask * task,
 586     GstTaskThreadCallbacks * callbacks, gpointer user_data,
 587     GDestroyNotify notify)
 588 {
 589   GDestroyNotify old_notify;
 590
 591   g_return_if_fail (task != NULL);
 592   g_return_if_fail (GST_IS_TASK (task));
 593   g_return_if_fail (callbacks != NULL);
 594
 595   GST_OBJECT_LOCK (task);
 596   old_notify = task->priv->thr_notify;
 597
 598   if (old_notify) {
 599     gpointer old_data;
 600
 601     old_data = task->priv->thr_user_data;
 602
 603     task->priv->thr_user_data = NULL;
 604     task->priv->thr_notify = NULL;
 605     GST_OBJECT_UNLOCK (task);
 606
 607     old_notify (old_data);
 608
 609     GST_OBJECT_LOCK (task);
 610   }
 611   task->priv->thr_callbacks = *callbacks;
 612   task->priv->thr_user_data = user_data;
 613   task->priv->thr_notify = notify;
 614   GST_OBJECT_UNLOCK (task);
 615 }
 616
 617 /**
 618  * gst_task_get_state:
 619  * @task: The #GstTask to query
 620  *
 621  * Get the current state of the task.
 622  *
 623  * Returns: The #GstTaskState of the task
 624  *
 625  * MT safe.
 626  */
 627 GstTaskState
 628 gst_task_get_state (GstTask * task)
 629 {
 630   GstTaskState result;
 631
 632   g_return_val_if_fail (GST_IS_TASK (task), GST_TASK_STOPPED);
 633
 634   result = GET_TASK_STATE (task);
 635
 636   return result;
 637 }
 638
 639 /* make sure the task is running and start a thread if it's not.
 640  * This function must be called with the task LOCK. */
 641 static gboolean
 642 start_task (GstTask * task)
 643 {
 644   gboolean res = TRUE;
 645   GError *error = NULL;
 646   GstTaskPrivate *priv;
 647
 648   priv = task->priv;
 649
 650   /* new task, We ref before so that it remains alive while
 651    * the thread is running. */
 652   gst_object_ref (task);
 653   /* mark task as running so that a join will wait until we schedule
 654    * and exit the task function. */
 655   task->running = TRUE;
 656
 657   /* push on the thread pool, we remember the original pool because the user
 658    * could change it later on and then we join to the wrong pool. */
 659   priv->pool_id = gst_object_ref (priv->pool);
 660   priv->id =
 661       gst_task_pool_push (priv->pool_id, (GstTaskPoolFunction) gst_task_func,
 662       task, &error);
 663
 664   if (error != NULL) {
 665     g_warning ("failed to create thread: %s", error->message);
 666     g_error_free (error);
 667     res = FALSE;
 668   }
 669   return res;
 670 }
 671
 672
 673 /**
 674  * gst_task_set_state:
 675  * @task: a #GstTask
 676  * @state: the new task state
 677  *
 678  * Sets the state of @task to @state.
 679  *
 680  * The @task must have a lock associated with it using
 681  * gst_task_set_lock() when going to GST_TASK_STARTED or GST_TASK_PAUSED or
 682  * this function will return %FALSE.
 683  *
 684  * MT safe.
 685  *
 686  * Returns: %TRUE if the state could be changed.
 687  *
 688  * Since: 0.10.24
 689  */
 690 gboolean
 691 gst_task_set_state (GstTask * task, GstTaskState state)
 692 {
 693   GstTaskState old;
 694   gboolean res = TRUE;
 695
 696   g_return_val_if_fail (GST_IS_TASK (task), FALSE);
 697
 698   GST_DEBUG_OBJECT (task, "Changing task %p to state %d", task, state);
 699
 700   GST_OBJECT_LOCK (task);
 701   if (state != GST_TASK_STOPPED)
 702     if (G_UNLIKELY (GST_TASK_GET_LOCK (task) == NULL))
 703       goto no_lock;
 704
 705   /* if the state changed, do our thing */
 706   old = GET_TASK_STATE (task);
 707   if (old != state) {
 708     SET_TASK_STATE (task, state);
 709     switch (old) {
 710       case GST_TASK_STOPPED:
 711         /* If the task already has a thread scheduled we don't have to do
 712          * anything. */
 713         if (G_UNLIKELY (!task->running))
 714           res = start_task (task);
 715         break;
 716       case GST_TASK_PAUSED:
 717         /* when we are paused, signal to go to the new state */
 718         GST_TASK_SIGNAL (task);
 719         break;
 720       case GST_TASK_STARTED:
 721         /* if we were started, we'll go to the new state after the next
 722          * iteration. */
 723         break;
 724     }
 725   }
 726   GST_OBJECT_UNLOCK (task);
 727
 728   return res;
 729
 730   /* ERRORS */
 731 no_lock:
 732   {
 733     GST_WARNING_OBJECT (task, "state %d set on task without a lock", state);
 734     GST_OBJECT_UNLOCK (task);
 735     g_warning ("task without a lock can't be set to state %d", state);
 736     return FALSE;
 737   }
 738 }
 739
 740 /**
 741  * gst_task_start:
 742  * @task: The #GstTask to start
 743  *
 744  * Starts @task. The @task must have a lock associated with it using
 745  * gst_task_set_lock() or this function will return %FALSE.
 746  *
 747  * Returns: %TRUE if the task could be started.
 748  *
 749  * MT safe.
 750  */
 751 gboolean
 752 gst_task_start (GstTask * task)
 753 {
 754   return gst_task_set_state (task, GST_TASK_STARTED);
 755 }
 756
 757 /**
 758  * gst_task_stop:
 759  * @task: The #GstTask to stop
 760  *
 761  * Stops @task. This method merely schedules the task to stop and
 762  * will not wait for the task to have completely stopped. Use
 763  * gst_task_join() to stop and wait for completion.
 764  *
 765  * Returns: %TRUE if the task could be stopped.
 766  *
 767  * MT safe.
 768  */
 769 gboolean
 770 gst_task_stop (GstTask * task)
 771 {
 772   return gst_task_set_state (task, GST_TASK_STOPPED);
 773 }
 774
 775 /**
 776  * gst_task_pause:
 777  * @task: The #GstTask to pause
 778  *
 779  * Pauses @task. This method can also be called on a task in the
 780  * stopped state, in which case a thread will be started and will remain
 781  * in the paused state. This function does not wait for the task to complete
 782  * the paused state.
 783  *
 784  * Returns: %TRUE if the task could be paused.
 785  *
 786  * MT safe.
 787  */
 788 gboolean
 789 gst_task_pause (GstTask * task)
 790 {
 791   return gst_task_set_state (task, GST_TASK_PAUSED);
 792 }
 793
 794 /**
 795  * gst_task_join:
 796  * @task: The #GstTask to join
 797  *
 798  * Joins @task. After this call, it is safe to unref the task
 799  * and clean up the lock set with gst_task_set_lock().
 800  *
 801  * The task will automatically be stopped with this call.
 802  *
 803  * This function cannot be called from within a task function as this
 804  * would cause a deadlock. The function will detect this and print a
 805  * g_warning.
 806  *
 807  * Returns: %TRUE if the task could be joined.
 808  *
 809  * MT safe.
 810  */
 811 gboolean
 812 gst_task_join (GstTask * task)
 813 {
 814   GThread *tself;
 815   GstTaskPrivate *priv;
 816   gpointer id;
 817   GstTaskPool *pool = NULL;
 818
 819   priv = task->priv;
 820
 821   g_return_val_if_fail (GST_IS_TASK (task), FALSE);
 822
 823   tself = g_thread_self ();
 824
 825   GST_DEBUG_OBJECT (task, "Joining task %p, thread %p", task, tself);
 826
 827   /* we don't use a real thread join here because we are using
 828    * thread pools */
 829   GST_OBJECT_LOCK (task);
 830   if (G_UNLIKELY (tself == task->abidata.ABI.thread))
 831     goto joining_self;
 832   SET_TASK_STATE (task, GST_TASK_STOPPED);
 833   /* signal the state change for when it was blocked in PAUSED. */
 834   GST_TASK_SIGNAL (task);
 835   /* we set the running flag when pushing the task on the thread pool.
 836    * This means that the task function might not be called when we try
 837    * to join it here. */
 838   while (G_LIKELY (task->running))
 839     GST_TASK_WAIT (task);
 840   /* clean the thread */
 841   task->abidata.ABI.thread = NULL;
 842   /* get the id and pool to join */
 843   pool = priv->pool_id;
 844   id = priv->id;
 845   priv->pool_id = NULL;
 846   priv->id = NULL;
 847   GST_OBJECT_UNLOCK (task);
 848
 849   if (pool) {
 850     if (id)
 851       gst_task_pool_join (pool, id);
 852     gst_object_unref (pool);
 853   }
 854
 855   GST_DEBUG_OBJECT (task, "Joined task %p", task);
 856
 857   return TRUE;
 858
 859   /* ERRORS */
 860 joining_self:
 861   {
 862     GST_WARNING_OBJECT (task, "trying to join task from its thread");
 863     GST_OBJECT_UNLOCK (task);
 864     g_warning ("\nTrying to join task %p from its thread would deadlock.\n"
 865         "You cannot change the state of an element from its streaming\n"
 866         "thread. Use g_idle_add() or post a GstMessage on the bus to\n"
 867         "schedule the state change from the main thread.\n", task);
 868     return FALSE;
 869   }
 870 }