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