gst/gstpipeline.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2004,2005 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstpipeline.c: Overall pipeline management element
   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:gstpipeline
  25  * @short_description: Top-level bin with clocking and bus management
  26                        functionality.
  27  * @see_also: #GstElement, #GstBin, #GstClock, #GstBus
  28  *
  29  * A #GstPipeline is a special #GstBin used as the toplevel container for
  30  * the filter graph. The #GstPipeline will manage the selection and
  31  * distribution of a global #GstClock as well as provide a #GstBus to the
  32  * application. It will also implement a default behavour for managing
  33  * seek events (see gst_element_seek()).
  34  *
  35  * gst_pipeline_new() is used to create a pipeline. when you are done with
  36  * the pipeline, use gst_object_unref() to free its resources including all
  37  * added #GstElement objects (if not otherwise referenced).
  38  *
  39  * Elements are added and removed from the pipeline using the #GstBin
  40  * methods like gst_bin_add() and gst_bin_remove() (see #GstBin).
  41  *
  42  * Before changing the state of the #GstPipeline (see #GstElement) a #GstBus
  43  * can be retrieved with gst_pipeline_get_bus(). This bus can then be
  44  * used to receive #GstMessage from the elements in the pipeline.
  45  *
  46  * By default, a #GstPipeline will automatically flush the pending #GstBus
  47  * messages when going to the NULL state to ensure that no circular
  48  * references exist when no messages are read from the #GstBus. This
  49  * behaviour can be changed with gst_pipeline_set_auto_flush_bus().
  50  *
  51  * When the #GstPipeline performs the PAUSED to PLAYING state change it will
  52  * select a clock for the elements. The clock selection algorithm will by
  53  * default select a clock provided by an element that is most upstream
  54  * (closest to the source). For live pipelines (ones that return
  55  * #GST_STATE_CHANGE_NO_PREROLL from the gst_element_set_state() call) this
  56  * will select the clock provided by the live source. For normal pipelines
  57  * this will select a clock provided by the sinks (most likely the audio
  58  * sink). If no element provides a clock, a default #GstSystemClock is used.
  59  *
  60  * The clock selection can be controlled with the gst_pipeline_use_clock()
  61  * method, which will enforce a given clock on the pipeline. With
  62  * gst_pipeline_auto_clock() the default clock selection algorithm can be
  63  * restored.
  64  *
  65  * A #GstPipeline maintains a stream time for the elements. The stream
  66  * time is defined as the difference between the current clock time and
  67  * the base time. When the pipeline goes to READY or a flushing seek is
  68  * performed on it, the stream time is reset to 0. When the pipeline is
  69  * set from PLAYING to PAUSED, the current clock time is sampled and used to
  70  * configure the base time for the elements when the pipeline is set
  71  * to PLAYING again. This default behaviour can be changed with the
  72  * gst_pipeline_set_new_stream_time() method.
  73  *
  74  * When sending a flushing seek event to a GstPipeline (see
  75  * gst_element_seek()), it will make sure that the pipeline is properly
  76  * PAUSED and resumed as well as set the new stream time to 0 when the
  77  * seek succeeded.
  78  *
  79  * Last reviewed on 2006-03-12 (0.10.5)
  80  */
  81
  82 #include "gst_private.h"
  83 #include "gsterror.h"
  84 #include "gst-i18n-lib.h"
  85
  86 #include "gstpipeline.h"
  87 #include "gstinfo.h"
  88 #include "gstsystemclock.h"
  89
  90 GST_DEBUG_CATEGORY_STATIC (pipeline_debug);
  91 #define GST_CAT_DEFAULT pipeline_debug
  92
  93 static GstElementDetails gst_pipeline_details =
  94 GST_ELEMENT_DETAILS ("Pipeline object",
  95     "Generic/Bin",
  96     "Complete pipeline object",
  97     "Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>");
  98
  99 /* Pipeline signals and args */
 100 enum
 101 {
 102   /* FILL ME */
 103   LAST_SIGNAL
 104 };
 105
 106 #define DEFAULT_DELAY           0
 107 #define DEFAULT_AUTO_FLUSH_BUS  TRUE
 108
 109 enum
 110 {
 111   PROP_0,
 112   PROP_DELAY,
 113   PROP_AUTO_FLUSH_BUS
 114       /* FILL ME */
 115 };
 116
 117 #define GST_PIPELINE_GET_PRIVATE(obj)  \
 118    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PIPELINE, GstPipelinePrivate))
 119
 120 struct _GstPipelinePrivate
 121 {
 122   /* with LOCK */
 123   gboolean auto_flush_bus;
 124 };
 125
 126
 127 static void gst_pipeline_base_init (gpointer g_class);
 128 static void gst_pipeline_class_init (gpointer g_class, gpointer class_data);
 129 static void gst_pipeline_init (GTypeInstance * instance, gpointer g_class);
 130
 131 static void gst_pipeline_dispose (GObject * object);
 132 static void gst_pipeline_set_property (GObject * object, guint prop_id,
 133     const GValue * value, GParamSpec * pspec);
 134 static void gst_pipeline_get_property (GObject * object, guint prop_id,
 135     GValue * value, GParamSpec * pspec);
 136
 137 static gboolean gst_pipeline_send_event (GstElement * element,
 138     GstEvent * event);
 139
 140 static GstClock *gst_pipeline_provide_clock_func (GstElement * element);
 141 static GstStateChangeReturn gst_pipeline_change_state (GstElement * element,
 142     GstStateChange transition);
 143
 144 static GstBinClass *parent_class = NULL;
 145
 146 /* static guint gst_pipeline_signals[LAST_SIGNAL] = { 0 }; */
 147
 148 GType
 149 gst_pipeline_get_type (void)
 150 {
 151   static GType pipeline_type = 0;
 152
 153   if (G_UNLIKELY (pipeline_type == 0)) {
 154     static const GTypeInfo pipeline_info = {
 155       sizeof (GstPipelineClass),
 156       gst_pipeline_base_init,
 157       NULL,
 158       (GClassInitFunc) gst_pipeline_class_init,
 159       NULL,
 160       NULL,
 161       sizeof (GstPipeline),
 162       0,
 163       gst_pipeline_init,
 164       NULL
 165     };
 166
 167     pipeline_type =
 168         g_type_register_static (GST_TYPE_BIN, "GstPipeline", &pipeline_info, 0);
 169
 170     GST_DEBUG_CATEGORY_INIT (pipeline_debug, "pipeline", GST_DEBUG_BOLD,
 171         "debugging info for the 'pipeline' container element");
 172   }
 173   return pipeline_type;
 174 }
 175
 176 static void
 177 gst_pipeline_base_init (gpointer g_class)
 178 {
 179   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 180
 181   gst_element_class_set_details (gstelement_class, &gst_pipeline_details);
 182 }
 183
 184 static void
 185 gst_pipeline_class_init (gpointer g_class, gpointer class_data)
 186 {
 187   GObjectClass *gobject_class = G_OBJECT_CLASS (g_class);
 188   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 189   GstPipelineClass *klass = GST_PIPELINE_CLASS (g_class);
 190
 191   parent_class = g_type_class_peek_parent (klass);
 192
 193   g_type_class_add_private (klass, sizeof (GstPipelinePrivate));
 194
 195   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_pipeline_set_property);
 196   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_pipeline_get_property);
 197
 198   /**
 199    * GstPipeline:delay
 200    *
 201    * The expected delay needed for elements to spin up to the
 202    * PLAYING state expressed in nanoseconds.
 203    * see gst_pipeline_set_delay() for more information on this option.
 204    *
 205    * Since: 0.10.5
 206    **/
 207   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DELAY,
 208       g_param_spec_uint64 ("delay", "Delay",
 209           "Expected delay needed for elements "
 210           "to spin up to PLAYING in nanoseconds", 0, G_MAXUINT64, DEFAULT_DELAY,
 211           G_PARAM_READWRITE));
 212
 213   /**
 214    * GstPipeline:auto-flush-bus:
 215    *
 216    * Whether or not to automatically flush all messages on the
 217    * pipeline's bus when going from READY to NULL state. Please see
 218    * gst_pipeline_set_auto_flush_bus() for more information on this option.
 219    *
 220    * Since: 0.10.4
 221    **/
 222   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_AUTO_FLUSH_BUS,
 223       g_param_spec_boolean ("auto-flush-bus", "Auto Flush Bus",
 224           "Whether to automatically flush the pipeline's bus when going "
 225           "from READY into NULL state", DEFAULT_AUTO_FLUSH_BUS,
 226           G_PARAM_READWRITE));
 227
 228   gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_pipeline_dispose);
 229
 230   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_pipeline_send_event);
 231   gstelement_class->change_state =
 232       GST_DEBUG_FUNCPTR (gst_pipeline_change_state);
 233   gstelement_class->provide_clock =
 234       GST_DEBUG_FUNCPTR (gst_pipeline_provide_clock_func);
 235 }
 236
 237 static void
 238 gst_pipeline_init (GTypeInstance * instance, gpointer g_class)
 239 {
 240   GstPipeline *pipeline = GST_PIPELINE (instance);
 241   GstBus *bus;
 242
 243   pipeline->priv = GST_PIPELINE_GET_PRIVATE (pipeline);
 244
 245   /* set default property values */
 246   pipeline->priv->auto_flush_bus = DEFAULT_AUTO_FLUSH_BUS;
 247   pipeline->delay = DEFAULT_DELAY;
 248
 249   /* create and set a default bus */
 250   bus = gst_bus_new ();
 251   gst_element_set_bus (GST_ELEMENT_CAST (pipeline), bus);
 252   GST_DEBUG_OBJECT (pipeline, "set bus %" GST_PTR_FORMAT " on pipeline", bus);
 253   gst_object_unref (bus);
 254 }
 255
 256 static void
 257 gst_pipeline_dispose (GObject * object)
 258 {
 259   GstPipeline *pipeline = GST_PIPELINE (object);
 260
 261   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pipeline, "dispose");
 262
 263   /* clear and unref any fixed clock */
 264   gst_object_replace ((GstObject **) & pipeline->fixed_clock, NULL);
 265
 266   G_OBJECT_CLASS (parent_class)->dispose (object);
 267 }
 268
 269 static void
 270 gst_pipeline_set_property (GObject * object, guint prop_id,
 271     const GValue * value, GParamSpec * pspec)
 272 {
 273   GstPipeline *pipeline = GST_PIPELINE (object);
 274
 275   switch (prop_id) {
 276     case PROP_DELAY:
 277       gst_pipeline_set_delay (pipeline, g_value_get_uint64 (value));
 278       break;
 279     case PROP_AUTO_FLUSH_BUS:
 280       gst_pipeline_set_auto_flush_bus (pipeline, g_value_get_boolean (value));
 281       break;
 282     default:
 283       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 284       break;
 285   }
 286 }
 287
 288 static void
 289 gst_pipeline_get_property (GObject * object, guint prop_id,
 290     GValue * value, GParamSpec * pspec)
 291 {
 292   GstPipeline *pipeline = GST_PIPELINE (object);
 293
 294   switch (prop_id) {
 295     case PROP_DELAY:
 296       g_value_set_uint64 (value, gst_pipeline_get_delay (pipeline));
 297       break;
 298     case PROP_AUTO_FLUSH_BUS:
 299       g_value_set_boolean (value, gst_pipeline_get_auto_flush_bus (pipeline));
 300       break;
 301     default:
 302       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 303       break;
 304   }
 305 }
 306
 307 /* default pipeline seeking code:
 308  *
 309  * If the pipeline is PLAYING and a flushing seek is done, set
 310  * the pipeline to PAUSED before doing the seek.
 311  *
 312  * A flushing seek also resets the stream time to 0 so that when
 313  * we go back to PLAYING after the seek, the base_time is recalculated
 314  * and redistributed to the elements.
 315  *
 316  */
 317 static gboolean
 318 do_pipeline_seek (GstElement * element, GstEvent * event)
 319 {
 320   gdouble rate;
 321   GstSeekFlags flags;
 322   gboolean flush;
 323   gboolean was_playing = FALSE;
 324   gboolean res;
 325
 326   /* we are only interested in the FLUSH flag of the seek event. */
 327   gst_event_parse_seek (event, &rate, NULL, &flags, NULL, NULL, NULL, NULL);
 328
 329   flush = flags & GST_SEEK_FLAG_FLUSH;
 330
 331   /* if flushing seek, get the current state */
 332   if (flush) {
 333     GstState state;
 334
 335     /* need to call _get_state() since a bin state is only updated
 336      * with this call. */
 337     gst_element_get_state (element, &state, NULL, 0);
 338     was_playing = state == GST_STATE_PLAYING;
 339
 340     if (was_playing) {
 341       /* and PAUSE when the pipeline was PLAYING, we don't need
 342        * to wait for the state change to complete since we are going
 343        * to flush out any preroll sample anyway */
 344       gst_element_set_state (element, GST_STATE_PAUSED);
 345     }
 346   }
 347
 348   /* let parent class implement the seek behaviour */
 349   res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
 350
 351   /* if flushing seek restore previous state */
 352   if (flush) {
 353     gboolean need_reset;
 354
 355     GST_OBJECT_LOCK (element);
 356     need_reset = GST_PIPELINE (element)->stream_time != GST_CLOCK_TIME_NONE;
 357     GST_OBJECT_UNLOCK (element);
 358
 359     /* need to reset the stream time to 0 after a successfull flushing seek,
 360      * unless the user explicitly disabled this behavior by setting stream
 361      * time to NONE */
 362     if (need_reset && res)
 363       gst_pipeline_set_new_stream_time (GST_PIPELINE (element), 0);
 364
 365     if (was_playing)
 366       /* and continue playing, this might return ASYNC in which case the
 367        * application can wait for the PREROLL to complete after the seek.
 368        */
 369       gst_element_set_state (element, GST_STATE_PLAYING);
 370   }
 371   return res;
 372 }
 373
 374 static gboolean
 375 gst_pipeline_send_event (GstElement * element, GstEvent * event)
 376 {
 377   gboolean res;
 378   GstEventType event_type = GST_EVENT_TYPE (event);
 379
 380   switch (event_type) {
 381     case GST_EVENT_SEEK:
 382       /* do the default seek handling */
 383       res = do_pipeline_seek (element, event);
 384       break;
 385     default:
 386       /* else parent implements the defaults */
 387       res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
 388       break;
 389   }
 390
 391   return res;
 392 }
 393
 394 /**
 395  * gst_pipeline_new:
 396  * @name: name of new pipeline
 397  *
 398  * Create a new pipeline with the given name.
 399  *
 400  * Returns: newly created GstPipeline
 401  *
 402  * MT safe.
 403  */
 404 GstElement *
 405 gst_pipeline_new (const gchar * name)
 406 {
 407   return gst_element_factory_make ("pipeline", name);
 408 }
 409
 410 /* MT safe */
 411 static GstStateChangeReturn
 412 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
 413 {
 414   GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
 415   GstPipeline *pipeline = GST_PIPELINE (element);
 416   GstClock *clock;
 417
 418   switch (transition) {
 419     case GST_STATE_CHANGE_NULL_TO_READY:
 420       GST_OBJECT_LOCK (element);
 421       if (element->bus)
 422         gst_bus_set_flushing (element->bus, FALSE);
 423       GST_OBJECT_UNLOCK (element);
 424       break;
 425     case GST_STATE_CHANGE_READY_TO_PAUSED:
 426       break;
 427     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 428     {
 429       GstClockTime new_base_time;
 430
 431       /* when going to playing, select a clock */
 432       clock = gst_element_provide_clock (element);
 433
 434       if (clock) {
 435         GstClockTime start_time, stream_time, delay;
 436         gboolean new_clock;
 437
 438         start_time = gst_clock_get_time (clock);
 439
 440         GST_OBJECT_LOCK (element);
 441         new_clock = element->clock != clock;
 442         stream_time = pipeline->stream_time;
 443         delay = pipeline->delay;
 444         GST_OBJECT_UNLOCK (element);
 445
 446         if (new_clock) {
 447           /* now distribute the clock (which could be NULL). If some
 448            * element refuses the clock, this will return FALSE and
 449            * we effectively fail the state change. */
 450           if (!gst_element_set_clock (element, clock))
 451             goto invalid_clock;
 452
 453           /* if we selected and distributed a new clock, let the app
 454            * know about it */
 455           gst_element_post_message (element,
 456               gst_message_new_new_clock (GST_OBJECT_CAST (element), clock));
 457         }
 458
 459         if (stream_time != GST_CLOCK_TIME_NONE)
 460           new_base_time = start_time - stream_time + delay;
 461         else
 462           new_base_time = GST_CLOCK_TIME_NONE;
 463
 464         gst_object_unref (clock);
 465       } else {
 466         GST_DEBUG ("no clock, using base time of 0");
 467         new_base_time = 0;
 468       }
 469
 470       if (new_base_time != GST_CLOCK_TIME_NONE)
 471         gst_element_set_base_time (element, new_base_time);
 472       else
 473         GST_DEBUG_OBJECT (pipeline,
 474             "NOT adjusting base time because stream time is NONE");
 475     }
 476       break;
 477     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 478       break;
 479     case GST_STATE_CHANGE_PAUSED_TO_READY:
 480     case GST_STATE_CHANGE_READY_TO_NULL:
 481       break;
 482   }
 483
 484   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 485
 486   switch (transition) {
 487     case GST_STATE_CHANGE_NULL_TO_READY:
 488       break;
 489     case GST_STATE_CHANGE_READY_TO_PAUSED:
 490     {
 491       gboolean need_reset;
 492
 493       /* only reset the stream time when the application did not
 494        * specify a stream time explicitly */
 495       GST_OBJECT_LOCK (element);
 496       need_reset = pipeline->stream_time != GST_CLOCK_TIME_NONE;
 497       GST_OBJECT_UNLOCK (element);
 498
 499       if (need_reset)
 500         gst_pipeline_set_new_stream_time (pipeline, 0);
 501     }
 502       break;
 503     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 504       break;
 505     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 506       GST_OBJECT_LOCK (element);
 507       if ((clock = element->clock)) {
 508         GstClockTime now;
 509
 510         gst_object_ref (clock);
 511         GST_OBJECT_UNLOCK (element);
 512
 513         /* calculate the time when we stopped */
 514         now = gst_clock_get_time (clock);
 515         gst_object_unref (clock);
 516
 517         GST_OBJECT_LOCK (element);
 518         /* store the current stream time */
 519         if (pipeline->stream_time != GST_CLOCK_TIME_NONE)
 520           pipeline->stream_time = now - element->base_time;
 521         GST_DEBUG_OBJECT (element,
 522             "stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 523             ", base time %" GST_TIME_FORMAT,
 524             GST_TIME_ARGS (pipeline->stream_time), GST_TIME_ARGS (now),
 525             GST_TIME_ARGS (element->base_time));
 526       }
 527       GST_OBJECT_UNLOCK (element);
 528       break;
 529     case GST_STATE_CHANGE_PAUSED_TO_READY:
 530       break;
 531     case GST_STATE_CHANGE_READY_TO_NULL:
 532       GST_OBJECT_LOCK (element);
 533       if (element->bus) {
 534         if (pipeline->priv->auto_flush_bus) {
 535           gst_bus_set_flushing (element->bus, TRUE);
 536         } else {
 537           GST_INFO_OBJECT (element, "not flushing bus, auto-flushing disabled");
 538         }
 539       }
 540       GST_OBJECT_UNLOCK (element);
 541       break;
 542   }
 543   return result;
 544
 545   /* ERRORS */
 546 invalid_clock:
 547   {
 548     /* we generate this error when the selected clock was not
 549      * accepted by some element */
 550     GST_ELEMENT_ERROR (pipeline, CORE, CLOCK,
 551         (_("Selected clock cannot be used in pipeline.")),
 552         ("Pipeline cannot operate with selected clock"));
 553     GST_DEBUG_OBJECT (pipeline,
 554         "Pipeline cannot operate with selected clock %p", clock);
 555     return GST_STATE_CHANGE_FAILURE;
 556   }
 557 }
 558
 559 /**
 560  * gst_pipeline_get_bus:
 561  * @pipeline: a #GstPipeline
 562  *
 563  * Gets the #GstBus of @pipeline.
 564  *
 565  * Returns: a #GstBus, unref after usage.
 566  *
 567  * MT safe.
 568  */
 569 GstBus *
 570 gst_pipeline_get_bus (GstPipeline * pipeline)
 571 {
 572   return gst_element_get_bus (GST_ELEMENT (pipeline));
 573 }
 574
 575 /**
 576  * gst_pipeline_set_new_stream_time:
 577  * @pipeline: a #GstPipeline
 578  * @time: the new stream time to set
 579  *
 580  * Set the new stream time of @pipeline to @time. The stream time is used to
 581  * set the base time on the elements (see gst_element_set_base_time())
 582  * in the PAUSED->PLAYING state transition.
 583  *
 584  * Setting @time to #GST_CLOCK_TIME_NONE will disable the pipeline's management
 585  * of element base time. The application will then be responsible for
 586  * performing base time distribution. This is sometimes useful if you want to
 587  * synchronize capture from multiple pipelines, and you can also ensure that the
 588  * pipelines have the same clock.
 589  *
 590  * MT safe.
 591  */
 592 void
 593 gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time)
 594 {
 595   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 596
 597   GST_OBJECT_LOCK (pipeline);
 598   pipeline->stream_time = time;
 599   GST_OBJECT_UNLOCK (pipeline);
 600
 601   GST_DEBUG_OBJECT (pipeline, "set new stream_time to %" GST_TIME_FORMAT,
 602       GST_TIME_ARGS (time));
 603
 604   if (time == GST_CLOCK_TIME_NONE)
 605     GST_DEBUG_OBJECT (pipeline, "told not to adjust base time");
 606 }
 607
 608 /**
 609  * gst_pipeline_get_last_stream_time:
 610  * @pipeline: a #GstPipeline
 611  *
 612  * Gets the last stream time of @pipeline. If the pipeline is PLAYING,
 613  * the returned time is the stream time used to configure the element's
 614  * base time in the PAUSED->PLAYING state. If the pipeline is PAUSED, the
 615  * returned time is the stream time when the pipeline was paused.
 616  *
 617  * This function returns #GST_CLOCK_TIME_NONE if the pipeline was
 618  * configured to not handle the management of the element's base time
 619  * (see gst_pipeline_set_new_stream_time()).
 620  *
 621  * Returns: a #GstClockTime.
 622  *
 623  * MT safe.
 624  */
 625 GstClockTime
 626 gst_pipeline_get_last_stream_time (GstPipeline * pipeline)
 627 {
 628   GstClockTime result;
 629
 630   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 631
 632   GST_OBJECT_LOCK (pipeline);
 633   result = pipeline->stream_time;
 634   GST_OBJECT_UNLOCK (pipeline);
 635
 636   return result;
 637 }
 638
 639 static GstClock *
 640 gst_pipeline_provide_clock_func (GstElement * element)
 641 {
 642   GstClock *clock = NULL;
 643   GstPipeline *pipeline = GST_PIPELINE (element);
 644
 645   /* if we have a fixed clock, use that one */
 646   GST_OBJECT_LOCK (pipeline);
 647   if (GST_OBJECT_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
 648     clock = pipeline->fixed_clock;
 649     gst_object_ref (clock);
 650     GST_OBJECT_UNLOCK (pipeline);
 651
 652     GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)",
 653         clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 654   } else {
 655     GST_OBJECT_UNLOCK (pipeline);
 656     /* let the parent bin select a clock */
 657     clock =
 658         GST_ELEMENT_CLASS (parent_class)->
 659         provide_clock (GST_ELEMENT (pipeline));
 660     /* no clock, use a system clock */
 661     if (!clock) {
 662       clock = gst_system_clock_obtain ();
 663
 664       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained system clock: %p (%s)",
 665           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 666     } else {
 667       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained clock: %p (%s)",
 668           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 669     }
 670   }
 671   return clock;
 672 }
 673
 674 /**
 675  * gst_pipeline_get_clock:
 676  * @pipeline: a #GstPipeline
 677  *
 678  * Gets the current clock used by @pipeline.
 679  *
 680  * Returns: a #GstClock, unref after usage.
 681  */
 682 GstClock *
 683 gst_pipeline_get_clock (GstPipeline * pipeline)
 684 {
 685   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
 686
 687   return gst_pipeline_provide_clock_func (GST_ELEMENT (pipeline));
 688 }
 689
 690
 691 /**
 692  * gst_pipeline_use_clock:
 693  * @pipeline: a #GstPipeline
 694  * @clock: the clock to use
 695  *
 696  * Force @pipeline to use the given @clock. The pipeline will
 697  * always use the given clock even if new clock providers are added
 698  * to this pipeline.
 699  *
 700  * If @clock is NULL all clocking will be disabled which will make
 701  * the pipeline run as fast as possible.
 702  *
 703  * MT safe.
 704  */
 705 void
 706 gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock)
 707 {
 708   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 709
 710   GST_OBJECT_LOCK (pipeline);
 711   GST_OBJECT_FLAG_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 712
 713   gst_object_replace ((GstObject **) & pipeline->fixed_clock,
 714       (GstObject *) clock);
 715   GST_OBJECT_UNLOCK (pipeline);
 716
 717   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)", clock,
 718       (clock ? GST_OBJECT_NAME (clock) : "nil"));
 719 }
 720
 721 /**
 722  * gst_pipeline_set_clock:
 723  * @pipeline: a #GstPipeline
 724  * @clock: the clock to set
 725  *
 726  * Set the clock for @pipeline. The clock will be distributed
 727  * to all the elements managed by the pipeline.
 728  *
 729  * Returns: TRUE if the clock could be set on the pipeline. FALSE if
 730  *   some element did not accept the clock.
 731  *
 732  * MT safe.
 733  */
 734 gboolean
 735 gst_pipeline_set_clock (GstPipeline * pipeline, GstClock * clock)
 736 {
 737   g_return_val_if_fail (pipeline != NULL, FALSE);
 738   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 739
 740   return GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT (pipeline),
 741       clock);
 742 }
 743
 744 /**
 745  * gst_pipeline_auto_clock:
 746  * @pipeline: a #GstPipeline
 747  *
 748  * Let @pipeline select a clock automatically. This is the default
 749  * behaviour.
 750  *
 751  * Use this function if you previous forced a fixed clock with
 752  * gst_pipeline_use_clock() and want to restore the default
 753  * pipeline clock selection algorithm.
 754  *
 755  * MT safe.
 756  */
 757 void
 758 gst_pipeline_auto_clock (GstPipeline * pipeline)
 759 {
 760   g_return_if_fail (pipeline != NULL);
 761   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 762
 763   GST_OBJECT_LOCK (pipeline);
 764   GST_OBJECT_FLAG_UNSET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 765
 766   gst_object_replace ((GstObject **) & pipeline->fixed_clock, NULL);
 767   GST_OBJECT_UNLOCK (pipeline);
 768
 769   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using automatic clock");
 770 }
 771
 772 /**
 773  * gst_pipeline_set_delay:
 774  * @pipeline: a #GstPipeline
 775  * @delay: the delay
 776  *
 777  * Set the expected delay needed for all elements to perform the
 778  * PAUSED to PLAYING state change. @delay will be added to the
 779  * base time of the elements so that they wait an additional @delay
 780  * amount of time before starting to process buffers.
 781  *
 782  * This option is used for tuning purposes and should normally not be
 783  * used.
 784  *
 785  * MT safe.
 786  *
 787  * Since: 0.10.5
 788  */
 789 void
 790 gst_pipeline_set_delay (GstPipeline * pipeline, GstClockTime delay)
 791 {
 792   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 793
 794   GST_OBJECT_LOCK (pipeline);
 795   pipeline->delay = delay;
 796   GST_OBJECT_UNLOCK (pipeline);
 797 }
 798
 799 /**
 800  * gst_pipeline_get_delay:
 801  * @pipeline: a #GstPipeline
 802  *
 803  * Get the configured delay (see gst_pipeline_set_delay()).
 804  *
 805  * Returns: The configured delay.
 806  *
 807  * MT safe.
 808  *
 809  * Since: 0.10.5
 810  */
 811 GstClockTime
 812 gst_pipeline_get_delay (GstPipeline * pipeline)
 813 {
 814   GstClockTime res;
 815
 816   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 817
 818   GST_OBJECT_LOCK (pipeline);
 819   res = pipeline->delay;
 820   GST_OBJECT_UNLOCK (pipeline);
 821
 822   return res;
 823 }
 824
 825 /**
 826  * gst_pipeline_set_auto_flush_bus:
 827  * @pipeline: a #GstPipeline
 828  * @auto_flush: whether or not to automatically flush the bus when
 829  * the pipeline goes from READY to NULL state
 830  *
 831  * Usually, when a pipeline goes from READY to NULL state, it automatically
 832  * flushes all pending messages on the bus, which is done for refcounting
 833  * purposes, to break circular references.
 834  *
 835  * This means that applications that update state using (async) bus messages
 836  * (e.g. do certain things when a pipeline goes from PAUSED to READY) might
 837  * not get to see messages when the pipeline is shut down, because they might
 838  * be flushed before they can be dispatched in the main thread. This behaviour
 839  * can be disabled using this function.
 840  *
 841  * It is important that all messages on the bus are handled when the
 842  * automatic flushing is disabled else memory leaks will be introduced.
 843  *
 844  * MT safe.
 845  *
 846  * Since: 0.10.4
 847  */
 848 void
 849 gst_pipeline_set_auto_flush_bus (GstPipeline * pipeline, gboolean auto_flush)
 850 {
 851   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 852
 853   GST_OBJECT_LOCK (pipeline);
 854   pipeline->priv->auto_flush_bus = auto_flush;
 855   GST_OBJECT_UNLOCK (pipeline);
 856 }
 857
 858 /**
 859  * gst_pipeline_get_auto_flush_bus:
 860  * @pipeline: a #GstPipeline
 861  *
 862  * Check if @pipeline will automatically flush messages when going to
 863  * the NULL state.
 864  *
 865  * Returns: whether the pipeline will automatically flush its bus when
 866  * going from READY to NULL state or not.
 867  *
 868  * MT safe.
 869  *
 870  * Since: 0.10.4
 871  */
 872 gboolean
 873 gst_pipeline_get_auto_flush_bus (GstPipeline * pipeline)
 874 {
 875   gboolean res;
 876
 877   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 878
 879   GST_OBJECT_LOCK (pipeline);
 880   res = pipeline->priv->auto_flush_bus;
 881   GST_OBJECT_UNLOCK (pipeline);
 882
 883   return res;
 884 }