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