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   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DELAY,
 206       g_param_spec_uint64 ("delay", "Delay",
 207           "Expected delay needed for elements "
 208           "to spin up to PLAYING in nanoseconds", 0, G_MAXUINT64, DEFAULT_DELAY,
 209           G_PARAM_READWRITE));
 210
 211   /**
 212    * GstPipeline:auto-flush-bus:
 213    *
 214    * Whether or not to automatically flush all messages on the
 215    * pipeline's bus when going from READY to NULL state. Please see
 216    * gst_pipeline_set_auto_flush_bus() for more information on this option.
 217    *
 218    * Since: 0.10.4
 219    **/
 220   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_AUTO_FLUSH_BUS,
 221       g_param_spec_boolean ("auto-flush-bus", "Auto Flush Bus",
 222           "Whether to automatically flush the pipeline's bus when going "
 223           "from READY into NULL state", DEFAULT_AUTO_FLUSH_BUS,
 224           G_PARAM_READWRITE));
 225
 226   gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_pipeline_dispose);
 227
 228   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_pipeline_send_event);
 229   gstelement_class->change_state =
 230       GST_DEBUG_FUNCPTR (gst_pipeline_change_state);
 231   gstelement_class->provide_clock =
 232       GST_DEBUG_FUNCPTR (gst_pipeline_provide_clock_func);
 233 }
 234
 235 static void
 236 gst_pipeline_init (GTypeInstance * instance, gpointer g_class)
 237 {
 238   GstPipeline *pipeline = GST_PIPELINE (instance);
 239   GstBus *bus;
 240
 241   pipeline->priv = GST_PIPELINE_GET_PRIVATE (pipeline);
 242
 243   /* set default property values */
 244   pipeline->priv->auto_flush_bus = DEFAULT_AUTO_FLUSH_BUS;
 245   pipeline->delay = DEFAULT_DELAY;
 246
 247   /* create and set a default bus */
 248   bus = gst_bus_new ();
 249   gst_element_set_bus (GST_ELEMENT_CAST (pipeline), bus);
 250   GST_DEBUG_OBJECT (pipeline, "set bus %" GST_PTR_FORMAT " on pipeline", bus);
 251   gst_object_unref (bus);
 252 }
 253
 254 static void
 255 gst_pipeline_dispose (GObject * object)
 256 {
 257   GstPipeline *pipeline = GST_PIPELINE (object);
 258
 259   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pipeline, "dispose");
 260
 261   /* clear and unref any fixed clock */
 262   gst_object_replace ((GstObject **) & pipeline->fixed_clock, NULL);
 263
 264   G_OBJECT_CLASS (parent_class)->dispose (object);
 265 }
 266
 267 static void
 268 gst_pipeline_set_property (GObject * object, guint prop_id,
 269     const GValue * value, GParamSpec * pspec)
 270 {
 271   GstPipeline *pipeline = GST_PIPELINE (object);
 272
 273   switch (prop_id) {
 274     case PROP_DELAY:
 275       gst_pipeline_set_delay (pipeline, g_value_get_uint64 (value));
 276       break;
 277     case PROP_AUTO_FLUSH_BUS:
 278       gst_pipeline_set_auto_flush_bus (pipeline, g_value_get_boolean (value));
 279       break;
 280     default:
 281       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 282       break;
 283   }
 284 }
 285
 286 static void
 287 gst_pipeline_get_property (GObject * object, guint prop_id,
 288     GValue * value, GParamSpec * pspec)
 289 {
 290   GstPipeline *pipeline = GST_PIPELINE (object);
 291
 292   switch (prop_id) {
 293     case PROP_DELAY:
 294       g_value_set_uint64 (value, gst_pipeline_get_delay (pipeline));
 295       break;
 296     case PROP_AUTO_FLUSH_BUS:
 297       g_value_set_boolean (value, gst_pipeline_get_auto_flush_bus (pipeline));
 298       break;
 299     default:
 300       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 301       break;
 302   }
 303 }
 304
 305 /* default pipeline seeking code:
 306  *
 307  * If the pipeline is PLAYING and a flushing seek is done, set
 308  * the pipeline to PAUSED before doing the seek.
 309  *
 310  * A flushing seek also resets the stream time to 0 so that when
 311  * we go back to PLAYING after the seek, the base_time is recalculated
 312  * and redistributed to the elements.
 313  *
 314  */
 315 static gboolean
 316 do_pipeline_seek (GstElement * element, GstEvent * event)
 317 {
 318   gdouble rate;
 319   GstSeekFlags flags;
 320   gboolean flush;
 321   gboolean was_playing = FALSE;
 322   gboolean res;
 323
 324   /* we are only interested in the FLUSH flag of the seek event. */
 325   gst_event_parse_seek (event, &rate, NULL, &flags, NULL, NULL, NULL, NULL);
 326
 327   flush = flags & GST_SEEK_FLAG_FLUSH;
 328
 329   /* if flushing seek, get the current state */
 330   if (flush) {
 331     GstState state;
 332
 333     /* need to call _get_state() since a bin state is only updated
 334      * with this call. */
 335     gst_element_get_state (element, &state, NULL, 0);
 336     was_playing = state == GST_STATE_PLAYING;
 337
 338     if (was_playing) {
 339       /* and PAUSE when the pipeline was PLAYING, we don't need
 340        * to wait for the state change to complete since we are going
 341        * to flush out any preroll sample anyway */
 342       gst_element_set_state (element, GST_STATE_PAUSED);
 343     }
 344   }
 345
 346   /* let parent class implement the seek behaviour */
 347   res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
 348
 349   /* if flushing seek restore previous state */
 350   if (flush) {
 351     gboolean need_reset;
 352
 353     GST_OBJECT_LOCK (element);
 354     need_reset = GST_PIPELINE (element)->stream_time != GST_CLOCK_TIME_NONE;
 355     GST_OBJECT_UNLOCK (element);
 356
 357     /* need to reset the stream time to 0 after a successfull flushing seek,
 358      * unless the user explicitly disabled this behavior by setting stream
 359      * time to NONE */
 360     if (need_reset && res)
 361       gst_pipeline_set_new_stream_time (GST_PIPELINE (element), 0);
 362
 363     if (was_playing)
 364       /* and continue playing, this might return ASYNC in which case the
 365        * application can wait for the PREROLL to complete after the seek.
 366        */
 367       gst_element_set_state (element, GST_STATE_PLAYING);
 368   }
 369   return res;
 370 }
 371
 372 static gboolean
 373 gst_pipeline_send_event (GstElement * element, GstEvent * event)
 374 {
 375   gboolean res;
 376   GstEventType event_type = GST_EVENT_TYPE (event);
 377
 378   switch (event_type) {
 379     case GST_EVENT_SEEK:
 380       /* do the default seek handling */
 381       res = do_pipeline_seek (element, event);
 382       break;
 383     default:
 384       /* else parent implements the defaults */
 385       res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
 386       break;
 387   }
 388
 389   return res;
 390 }
 391
 392 /**
 393  * gst_pipeline_new:
 394  * @name: name of new pipeline
 395  *
 396  * Create a new pipeline with the given name.
 397  *
 398  * Returns: newly created GstPipeline
 399  *
 400  * MT safe.
 401  */
 402 GstElement *
 403 gst_pipeline_new (const gchar * name)
 404 {
 405   return gst_element_factory_make ("pipeline", name);
 406 }
 407
 408 /* MT safe */
 409 static GstStateChangeReturn
 410 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
 411 {
 412   GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
 413   GstPipeline *pipeline = GST_PIPELINE (element);
 414   GstClock *clock;
 415
 416   switch (transition) {
 417     case GST_STATE_CHANGE_NULL_TO_READY:
 418       GST_OBJECT_LOCK (element);
 419       if (element->bus)
 420         gst_bus_set_flushing (element->bus, FALSE);
 421       GST_OBJECT_UNLOCK (element);
 422       break;
 423     case GST_STATE_CHANGE_READY_TO_PAUSED:
 424       break;
 425     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 426     {
 427       GstClockTime new_base_time;
 428
 429       /* when going to playing, select a clock */
 430       clock = gst_element_provide_clock (element);
 431
 432       if (clock) {
 433         GstClockTime start_time, stream_time, delay;
 434         gboolean new_clock;
 435
 436         start_time = gst_clock_get_time (clock);
 437
 438         GST_OBJECT_LOCK (element);
 439         new_clock = element->clock != clock;
 440         stream_time = pipeline->stream_time;
 441         delay = pipeline->delay;
 442         GST_OBJECT_UNLOCK (element);
 443
 444         if (new_clock) {
 445           /* now distribute the clock (which could be NULL). If some
 446            * element refuses the clock, this will return FALSE and
 447            * we effectively fail the state change. */
 448           if (!gst_element_set_clock (element, clock))
 449             goto invalid_clock;
 450
 451           /* if we selected and distributed a new clock, let the app
 452            * know about it */
 453           gst_element_post_message (element,
 454               gst_message_new_new_clock (GST_OBJECT_CAST (element), clock));
 455         }
 456
 457         if (stream_time != GST_CLOCK_TIME_NONE)
 458           new_base_time = start_time - stream_time + delay;
 459         else
 460           new_base_time = GST_CLOCK_TIME_NONE;
 461
 462         gst_object_unref (clock);
 463       } else {
 464         GST_DEBUG ("no clock, using base time of 0");
 465         new_base_time = 0;
 466       }
 467
 468       if (new_base_time != GST_CLOCK_TIME_NONE)
 469         gst_element_set_base_time (element, new_base_time);
 470       else
 471         GST_DEBUG_OBJECT (pipeline,
 472             "NOT adjusting base time because stream time is NONE");
 473     }
 474       break;
 475     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 476       break;
 477     case GST_STATE_CHANGE_PAUSED_TO_READY:
 478     case GST_STATE_CHANGE_READY_TO_NULL:
 479       break;
 480   }
 481
 482   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 483
 484   switch (transition) {
 485     case GST_STATE_CHANGE_NULL_TO_READY:
 486       break;
 487     case GST_STATE_CHANGE_READY_TO_PAUSED:
 488     {
 489       gboolean need_reset;
 490
 491       /* only reset the stream time when the application did not
 492        * specify a stream time explicitly */
 493       GST_OBJECT_LOCK (element);
 494       need_reset = pipeline->stream_time != GST_CLOCK_TIME_NONE;
 495       GST_OBJECT_UNLOCK (element);
 496
 497       if (need_reset)
 498         gst_pipeline_set_new_stream_time (pipeline, 0);
 499     }
 500       break;
 501     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 502       break;
 503     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 504       GST_OBJECT_LOCK (element);
 505       if ((clock = element->clock)) {
 506         GstClockTime now;
 507
 508         gst_object_ref (clock);
 509         GST_OBJECT_UNLOCK (element);
 510
 511         /* calculate the time when we stopped */
 512         now = gst_clock_get_time (clock);
 513         gst_object_unref (clock);
 514
 515         GST_OBJECT_LOCK (element);
 516         /* store the current stream time */
 517         if (pipeline->stream_time != GST_CLOCK_TIME_NONE)
 518           pipeline->stream_time = now - element->base_time;
 519         GST_DEBUG_OBJECT (element,
 520             "stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 521             ", base time %" GST_TIME_FORMAT,
 522             GST_TIME_ARGS (pipeline->stream_time), GST_TIME_ARGS (now),
 523             GST_TIME_ARGS (element->base_time));
 524       }
 525       GST_OBJECT_UNLOCK (element);
 526       break;
 527     case GST_STATE_CHANGE_PAUSED_TO_READY:
 528       break;
 529     case GST_STATE_CHANGE_READY_TO_NULL:
 530       GST_OBJECT_LOCK (element);
 531       if (element->bus) {
 532         if (pipeline->priv->auto_flush_bus) {
 533           gst_bus_set_flushing (element->bus, TRUE);
 534         } else {
 535           GST_INFO_OBJECT (element, "not flushing bus, auto-flushing disabled");
 536         }
 537       }
 538       GST_OBJECT_UNLOCK (element);
 539       break;
 540   }
 541   return result;
 542
 543   /* ERRORS */
 544 invalid_clock:
 545   {
 546     /* we generate this error when the selected clock was not
 547      * accepted by some element */
 548     GST_ELEMENT_ERROR (pipeline, CORE, CLOCK,
 549         (_("Selected clock cannot be used in pipeline.")),
 550         ("Pipeline cannot operate with selected clock"));
 551     GST_DEBUG_OBJECT (pipeline,
 552         "Pipeline cannot operate with selected clock %p", clock);
 553     return GST_STATE_CHANGE_FAILURE;
 554   }
 555 }
 556
 557 /**
 558  * gst_pipeline_get_bus:
 559  * @pipeline: a #GstPipeline
 560  *
 561  * Gets the #GstBus of @pipeline.
 562  *
 563  * Returns: a #GstBus, unref after usage.
 564  *
 565  * MT safe.
 566  */
 567 GstBus *
 568 gst_pipeline_get_bus (GstPipeline * pipeline)
 569 {
 570   return gst_element_get_bus (GST_ELEMENT (pipeline));
 571 }
 572
 573 /**
 574  * gst_pipeline_set_new_stream_time:
 575  * @pipeline: a #GstPipeline
 576  * @time: the new stream time to set
 577  *
 578  * Set the new stream time of @pipeline to @time. The stream time is used to
 579  * set the base time on the elements (see gst_element_set_base_time())
 580  * in the PAUSED->PLAYING state transition.
 581  *
 582  * Setting @time to #GST_CLOCK_TIME_NONE will disable the pipeline's management
 583  * of element base time. The application will then be responsible for
 584  * performing base time distribution. This is sometimes useful if you want to
 585  * synchronize capture from multiple pipelines, and you can also ensure that the
 586  * pipelines have the same clock.
 587  *
 588  * MT safe.
 589  */
 590 void
 591 gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time)
 592 {
 593   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 594
 595   GST_OBJECT_LOCK (pipeline);
 596   pipeline->stream_time = time;
 597   GST_OBJECT_UNLOCK (pipeline);
 598
 599   GST_DEBUG_OBJECT (pipeline, "set new stream_time to %" GST_TIME_FORMAT,
 600       GST_TIME_ARGS (time));
 601
 602   if (time == GST_CLOCK_TIME_NONE)
 603     GST_DEBUG_OBJECT (pipeline, "told not to adjust base time");
 604 }
 605
 606 /**
 607  * gst_pipeline_get_last_stream_time:
 608  * @pipeline: a #GstPipeline
 609  *
 610  * Gets the last stream time of @pipeline. If the pipeline is PLAYING,
 611  * the returned time is the stream time used to configure the element's
 612  * base time in the PAUSED->PLAYING state. If the pipeline is PAUSED, the
 613  * returned time is the stream time when the pipeline was paused.
 614  *
 615  * This function returns #GST_CLOCK_TIME_NONE if the pipeline was
 616  * configured to not handle the management of the element's base time
 617  * (see gst_pipeline_set_new_stream_time()).
 618  *
 619  * Returns: a #GstClockTime.
 620  *
 621  * MT safe.
 622  */
 623 GstClockTime
 624 gst_pipeline_get_last_stream_time (GstPipeline * pipeline)
 625 {
 626   GstClockTime result;
 627
 628   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 629
 630   GST_OBJECT_LOCK (pipeline);
 631   result = pipeline->stream_time;
 632   GST_OBJECT_UNLOCK (pipeline);
 633
 634   return result;
 635 }
 636
 637 static GstClock *
 638 gst_pipeline_provide_clock_func (GstElement * element)
 639 {
 640   GstClock *clock = NULL;
 641   GstPipeline *pipeline = GST_PIPELINE (element);
 642
 643   /* if we have a fixed clock, use that one */
 644   GST_OBJECT_LOCK (pipeline);
 645   if (GST_OBJECT_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
 646     clock = pipeline->fixed_clock;
 647     gst_object_ref (clock);
 648     GST_OBJECT_UNLOCK (pipeline);
 649
 650     GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)",
 651         clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 652   } else {
 653     GST_OBJECT_UNLOCK (pipeline);
 654     /* let the parent bin select a clock */
 655     clock =
 656         GST_ELEMENT_CLASS (parent_class)->
 657         provide_clock (GST_ELEMENT (pipeline));
 658     /* no clock, use a system clock */
 659     if (!clock) {
 660       clock = gst_system_clock_obtain ();
 661
 662       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained system clock: %p (%s)",
 663           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 664     } else {
 665       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained clock: %p (%s)",
 666           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 667     }
 668   }
 669   return clock;
 670 }
 671
 672 /**
 673  * gst_pipeline_get_clock:
 674  * @pipeline: a #GstPipeline
 675  *
 676  * Gets the current clock used by @pipeline.
 677  *
 678  * Returns: a #GstClock, unref after usage.
 679  */
 680 GstClock *
 681 gst_pipeline_get_clock (GstPipeline * pipeline)
 682 {
 683   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
 684
 685   return gst_pipeline_provide_clock_func (GST_ELEMENT (pipeline));
 686 }
 687
 688
 689 /**
 690  * gst_pipeline_use_clock:
 691  * @pipeline: a #GstPipeline
 692  * @clock: the clock to use
 693  *
 694  * Force @pipeline to use the given @clock. The pipeline will
 695  * always use the given clock even if new clock providers are added
 696  * to this pipeline.
 697  *
 698  * If @clock is NULL all clocking will be disabled which will make
 699  * the pipeline run as fast as possible.
 700  *
 701  * MT safe.
 702  */
 703 void
 704 gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock)
 705 {
 706   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 707
 708   GST_OBJECT_LOCK (pipeline);
 709   GST_OBJECT_FLAG_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 710
 711   gst_object_replace ((GstObject **) & pipeline->fixed_clock,
 712       (GstObject *) clock);
 713   GST_OBJECT_UNLOCK (pipeline);
 714
 715   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)", clock,
 716       (clock ? GST_OBJECT_NAME (clock) : "nil"));
 717 }
 718
 719 /**
 720  * gst_pipeline_set_clock:
 721  * @pipeline: a #GstPipeline
 722  * @clock: the clock to set
 723  *
 724  * Set the clock for @pipeline. The clock will be distributed
 725  * to all the elements managed by the pipeline.
 726  *
 727  * Returns: TRUE if the clock could be set on the pipeline. FALSE if
 728  *   some element did not accept the clock.
 729  *
 730  * MT safe.
 731  */
 732 gboolean
 733 gst_pipeline_set_clock (GstPipeline * pipeline, GstClock * clock)
 734 {
 735   g_return_val_if_fail (pipeline != NULL, FALSE);
 736   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 737
 738   return GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT (pipeline),
 739       clock);
 740 }
 741
 742 /**
 743  * gst_pipeline_auto_clock:
 744  * @pipeline: a #GstPipeline
 745  *
 746  * Let @pipeline select a clock automatically. This is the default
 747  * behaviour.
 748  *
 749  * Use this function if you previous forced a fixed clock with
 750  * gst_pipeline_use_clock() and want to restore the default
 751  * pipeline clock selection algorithm.
 752  *
 753  * MT safe.
 754  */
 755 void
 756 gst_pipeline_auto_clock (GstPipeline * pipeline)
 757 {
 758   g_return_if_fail (pipeline != NULL);
 759   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 760
 761   GST_OBJECT_LOCK (pipeline);
 762   GST_OBJECT_FLAG_UNSET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 763
 764   gst_object_replace ((GstObject **) & pipeline->fixed_clock, NULL);
 765   GST_OBJECT_UNLOCK (pipeline);
 766
 767   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using automatic clock");
 768 }
 769
 770 /**
 771  * gst_pipeline_set_delay:
 772  * @pipeline: a #GstPipeline
 773  * @delay: the delay
 774  *
 775  * Set the expected delay needed for all elements to perform the
 776  * PAUSED to PLAYING state change. @delay will be added to the
 777  * base time of the elements so that they wait an additional @delay
 778  * amount of time before starting to process buffers.
 779  *
 780  * This option is used for tuning purposes and should normally not be
 781  * used.
 782  *
 783  * MT safe.
 784  *
 785  * Since: 0.10.5
 786  */
 787 void
 788 gst_pipeline_set_delay (GstPipeline * pipeline, GstClockTime delay)
 789 {
 790   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 791
 792   GST_OBJECT_LOCK (pipeline);
 793   pipeline->delay = delay;
 794   GST_OBJECT_UNLOCK (pipeline);
 795 }
 796
 797 /**
 798  * gst_pipeline_get_delay:
 799  * @pipeline: a #GstPipeline
 800  *
 801  * Get the configured delay (see gst_pipeline_set_delay()).
 802  *
 803  * Returns: The configured delay.
 804  *
 805  * MT safe.
 806  *
 807  * Since: 0.10.5
 808  */
 809 GstClockTime
 810 gst_pipeline_get_delay (GstPipeline * pipeline)
 811 {
 812   GstClockTime res;
 813
 814   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 815
 816   GST_OBJECT_LOCK (pipeline);
 817   res = pipeline->delay;
 818   GST_OBJECT_UNLOCK (pipeline);
 819
 820   return res;
 821 }
 822
 823 /**
 824  * gst_pipeline_set_auto_flush_bus:
 825  * @pipeline: a #GstPipeline
 826  * @auto_flush: whether or not to automatically flush the bus when
 827  * the pipeline goes from READY to NULL state
 828  *
 829  * Usually, when a pipeline goes from READY to NULL state, it automatically
 830  * flushes all pending messages on the bus, which is done for refcounting
 831  * purposes, to break circular references.
 832  *
 833  * This means that applications that update state using (async) bus messages
 834  * (e.g. do certain things when a pipeline goes from PAUSED to READY) might
 835  * not get to see messages when the pipeline is shut down, because they might
 836  * be flushed before they can be dispatched in the main thread. This behaviour
 837  * can be disabled using this function.
 838  *
 839  * It is important that all messages on the bus are handled when the
 840  * automatic flushing is disabled else memory leaks will be introduced.
 841  *
 842  * MT safe.
 843  *
 844  * Since: 0.10.4
 845  */
 846 void
 847 gst_pipeline_set_auto_flush_bus (GstPipeline * pipeline, gboolean auto_flush)
 848 {
 849   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 850
 851   GST_OBJECT_LOCK (pipeline);
 852   pipeline->priv->auto_flush_bus = auto_flush;
 853   GST_OBJECT_UNLOCK (pipeline);
 854 }
 855
 856 /**
 857  * gst_pipeline_get_auto_flush_bus:
 858  * @pipeline: a #GstPipeline
 859  *
 860  * Check if @pipeline will automatically flush messages when going to
 861  * the NULL state.
 862  *
 863  * Returns: whether the pipeline will automatically flush its bus when
 864  * going from READY to NULL state or not.
 865  *
 866  * MT safe.
 867  *
 868  * Since: 0.10.4
 869  */
 870 gboolean
 871 gst_pipeline_get_auto_flush_bus (GstPipeline * pipeline)
 872 {
 873   gboolean res;
 874
 875   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 876
 877   GST_OBJECT_LOCK (pipeline);
 878   res = pipeline->priv->auto_flush_bus;
 879   GST_OBJECT_UNLOCK (pipeline);
 880
 881   return res;
 882 }