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