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 behaviour 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: (transfer full): 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       if (now != GST_CLOCK_TIME_NONE)
 347         GST_ELEMENT_START_TIME (pipeline) = now - element->base_time;
 348       else
 349         GST_WARNING_OBJECT (element,
 350             "Clock %s returned invalid time, can't calculate "
 351             "running_time when going to the PAUSED state",
 352             GST_OBJECT_NAME (clock));
 353
 354       /* we went to PAUSED, when going to PLAYING select clock and new
 355        * base_time */
 356       pipeline->priv->update_clock = TRUE;
 357     }
 358     GST_DEBUG_OBJECT (element,
 359         "start_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 360         ", base_time %" GST_TIME_FORMAT,
 361         GST_TIME_ARGS (GST_ELEMENT_START_TIME (pipeline)),
 362         GST_TIME_ARGS (now), GST_TIME_ARGS (element->base_time));
 363   }
 364   GST_OBJECT_UNLOCK (element);
 365 }
 366
 367 /* MT safe */
 368 static GstStateChangeReturn
 369 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
 370 {
 371   GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
 372   GstPipeline *pipeline = GST_PIPELINE_CAST (element);
 373   GstClock *clock;
 374
 375   switch (transition) {
 376     case GST_STATE_CHANGE_NULL_TO_READY:
 377       GST_OBJECT_LOCK (element);
 378       if (element->bus)
 379         gst_bus_set_flushing (element->bus, FALSE);
 380       GST_OBJECT_UNLOCK (element);
 381       break;
 382     case GST_STATE_CHANGE_READY_TO_PAUSED:
 383       GST_OBJECT_LOCK (element);
 384       pipeline->priv->update_clock = TRUE;
 385       GST_OBJECT_UNLOCK (element);
 386       break;
 387     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 388     {
 389       GstClockTime now, start_time, last_start_time, delay;
 390       gboolean update_clock;
 391       GstClock *cur_clock;
 392
 393       GST_DEBUG_OBJECT (element, "selecting clock and base_time");
 394
 395       GST_OBJECT_LOCK (element);
 396       cur_clock = element->clock;
 397       if (cur_clock)
 398         gst_object_ref (cur_clock);
 399       /* get the desired running_time of the first buffer aka the start_time */
 400       start_time = GST_ELEMENT_START_TIME (pipeline);
 401       last_start_time = pipeline->priv->last_start_time;
 402       pipeline->priv->last_start_time = start_time;
 403       /* see if we need to update the clock */
 404       update_clock = pipeline->priv->update_clock;
 405       pipeline->priv->update_clock = FALSE;
 406       delay = pipeline->delay;
 407       GST_OBJECT_UNLOCK (element);
 408
 409       /* running time changed, either with a PAUSED or a flush, we need to check
 410        * if there is a new clock & update the base time */
 411       /* only do this for top-level, however */
 412       if (GST_OBJECT_PARENT (element) == NULL &&
 413           (update_clock || last_start_time != start_time)) {
 414         GST_DEBUG_OBJECT (pipeline, "Need to update start_time");
 415
 416         /* when going to PLAYING, select a clock when needed. If we just got
 417          * flushed, we don't reselect the clock. */
 418         if (update_clock) {
 419           GST_DEBUG_OBJECT (pipeline, "Need to update clock.");
 420           clock = gst_element_provide_clock (element);
 421         } else {
 422           GST_DEBUG_OBJECT (pipeline,
 423               "Don't need to update clock, using old clock.");
 424           clock = gst_object_ref (cur_clock);
 425         }
 426
 427         if (clock) {
 428           now = gst_clock_get_time (clock);
 429         } else {
 430           GST_DEBUG_OBJECT (pipeline, "no clock, using base time of NONE");
 431           now = GST_CLOCK_TIME_NONE;
 432         }
 433
 434         if (clock != cur_clock) {
 435           /* now distribute the clock (which could be NULL). If some
 436            * element refuses the clock, this will return FALSE and
 437            * we effectively fail the state change. */
 438           if (!gst_element_set_clock (element, clock))
 439             goto invalid_clock;
 440
 441           /* if we selected and distributed a new clock, let the app
 442            * know about it */
 443           gst_element_post_message (element,
 444               gst_message_new_new_clock (GST_OBJECT_CAST (element), clock));
 445         }
 446
 447         if (clock)
 448           gst_object_unref (clock);
 449
 450         if (start_time != GST_CLOCK_TIME_NONE && now != GST_CLOCK_TIME_NONE) {
 451           GstClockTime new_base_time = now - start_time + delay;
 452           GST_DEBUG_OBJECT (element,
 453               "start_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 454               ", base_time %" GST_TIME_FORMAT,
 455               GST_TIME_ARGS (start_time), GST_TIME_ARGS (now),
 456               GST_TIME_ARGS (new_base_time));
 457
 458           gst_element_set_base_time (element, new_base_time);
 459         } else {
 460           GST_DEBUG_OBJECT (pipeline,
 461               "NOT adjusting base_time because start_time is NONE");
 462         }
 463       } else {
 464         GST_DEBUG_OBJECT (pipeline,
 465             "NOT adjusting base_time because we selected one before");
 466       }
 467
 468       if (cur_clock)
 469         gst_object_unref (cur_clock);
 470       break;
 471     }
 472     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 473     {
 474       /* we take a start_time snapshot before calling the children state changes
 475        * so that they know about when the pipeline PAUSED. */
 476       pipeline_update_start_time (element);
 477       break;
 478     }
 479     case GST_STATE_CHANGE_PAUSED_TO_READY:
 480     case GST_STATE_CHANGE_READY_TO_NULL:
 481       break;
 482   }
 483
 484   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 485
 486   switch (transition) {
 487     case GST_STATE_CHANGE_NULL_TO_READY:
 488       break;
 489     case GST_STATE_CHANGE_READY_TO_PAUSED:
 490     {
 491       reset_start_time (pipeline);
 492       break;
 493     }
 494     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 495       break;
 496     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 497     {
 498       /* Take a new snapshot of the start_time after calling the state change on
 499        * all children. This will be the running_time of the pipeline when we go
 500        * back to PLAYING */
 501       pipeline_update_start_time (element);
 502       break;
 503     }
 504     case GST_STATE_CHANGE_PAUSED_TO_READY:
 505       break;
 506     case GST_STATE_CHANGE_READY_TO_NULL:
 507     {
 508       GstBus *bus;
 509       gboolean auto_flush;
 510
 511       /* grab some stuff before we release the lock to flush out the bus */
 512       GST_OBJECT_LOCK (element);
 513       if ((bus = element->bus))
 514         gst_object_ref (bus);
 515       auto_flush = pipeline->priv->auto_flush_bus;
 516       GST_OBJECT_UNLOCK (element);
 517
 518       if (bus) {
 519         if (auto_flush) {
 520           gst_bus_set_flushing (bus, TRUE);
 521         } else {
 522           GST_INFO_OBJECT (element, "not flushing bus, auto-flushing disabled");
 523         }
 524         gst_object_unref (bus);
 525       }
 526       break;
 527     }
 528   }
 529   return result;
 530
 531   /* ERRORS */
 532 invalid_clock:
 533   {
 534     /* we generate this error when the selected clock was not
 535      * accepted by some element */
 536     GST_ELEMENT_ERROR (pipeline, CORE, CLOCK,
 537         (_("Selected clock cannot be used in pipeline.")),
 538         ("Pipeline cannot operate with selected clock"));
 539     GST_DEBUG_OBJECT (pipeline,
 540         "Pipeline cannot operate with selected clock %p", clock);
 541     if (clock)
 542       gst_object_unref (clock);
 543     return GST_STATE_CHANGE_FAILURE;
 544   }
 545 }
 546
 547 /* intercept the bus messages from our children. We watch for the ASYNC_START
 548  * message with is posted by the elements (sinks) that require a reset of the
 549  * running_time after a flush. ASYNC_START also brings the pipeline back into
 550  * the PAUSED, pending PAUSED state. When the ASYNC_DONE message is received the
 551  * pipeline will redistribute the new base_time and will bring the elements back
 552  * to the desired state of the pipeline. */
 553 static void
 554 gst_pipeline_handle_message (GstBin * bin, GstMessage * message)
 555 {
 556   GstPipeline *pipeline = GST_PIPELINE_CAST (bin);
 557
 558   switch (GST_MESSAGE_TYPE (message)) {
 559     case GST_MESSAGE_ASYNC_START:
 560     {
 561       gboolean new_base_time;
 562
 563       gst_message_parse_async_start (message, &new_base_time);
 564
 565       /* reset our running time if we need to distribute a new base_time to the
 566        * children. */
 567       if (new_base_time)
 568         reset_start_time (pipeline);
 569
 570       break;
 571     }
 572     case GST_MESSAGE_CLOCK_LOST:
 573     {
 574       GstClock *clock;
 575
 576       gst_message_parse_clock_lost (message, &clock);
 577
 578       GST_OBJECT_LOCK (bin);
 579       if (clock == GST_ELEMENT_CAST (bin)->clock) {
 580         GST_DEBUG_OBJECT (bin, "Used clock '%s' got lost",
 581             GST_OBJECT_NAME (clock));
 582         pipeline->priv->update_clock = TRUE;
 583       }
 584       GST_OBJECT_UNLOCK (bin);
 585     }
 586     default:
 587       break;
 588   }
 589   GST_BIN_CLASS (parent_class)->handle_message (bin, message);
 590 }
 591
 592 /**
 593  * gst_pipeline_get_bus:
 594  * @pipeline: a #GstPipeline
 595  *
 596  * Gets the #GstBus of @pipeline. The bus allows applications to receive
 597  * #GstMessage packets.
 598  *
 599  * Returns: (transfer full): a #GstBus, unref after usage.
 600  *
 601  * MT safe.
 602  */
 603 GstBus *
 604 gst_pipeline_get_bus (GstPipeline * pipeline)
 605 {
 606   return gst_element_get_bus (GST_ELEMENT_CAST (pipeline));
 607 }
 608
 609 /**
 610  * gst_pipeline_set_new_stream_time:
 611  * @pipeline: a #GstPipeline
 612  * @time: the new running time to set
 613  *
 614  * Set the new start time of @pipeline to @time. The start time is used to
 615  * set the base time on the elements (see gst_element_set_base_time())
 616  * in the PAUSED->PLAYING state transition.
 617  *
 618  * Setting @time to #GST_CLOCK_TIME_NONE will disable the pipeline's management
 619  * of element base time. The application will then be responsible for
 620  * performing base time distribution. This is sometimes useful if you want to
 621  * synchronize capture from multiple pipelines, and you can also ensure that the
 622  * pipelines have the same clock.
 623  *
 624  * MT safe.
 625  *
 626  * Deprecated: This function has the wrong name and is equivalent to
 627  * gst_element_set_start_time().
 628  */
 629 #ifndef GST_REMOVE_DEPRECATED
 630 #ifdef GST_DISABLE_DEPRECATED
 631 void
 632 gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time);
 633 #endif
 634 void
 635 gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time)
 636 {
 637   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 638
 639   gst_element_set_start_time (GST_ELEMENT_CAST (pipeline), time);
 640
 641   if (time == GST_CLOCK_TIME_NONE)
 642     GST_DEBUG_OBJECT (pipeline, "told not to adjust base_time");
 643 }
 644 #endif /* GST_REMOVE_DEPRECATED */
 645
 646 /**
 647  * gst_pipeline_get_last_stream_time:
 648  * @pipeline: a #GstPipeline
 649  *
 650  * Gets the last running time of @pipeline. If the pipeline is PLAYING,
 651  * the returned time is the running time used to configure the element's
 652  * base time in the PAUSED->PLAYING state. If the pipeline is PAUSED, the
 653  * returned time is the running time when the pipeline was paused.
 654  *
 655  * This function returns #GST_CLOCK_TIME_NONE if the pipeline was
 656  * configured to not handle the management of the element's base time
 657  * (see gst_pipeline_set_new_stream_time()).
 658  *
 659  * MT safe.
 660  *
 661  * Returns: a #GstClockTime.
 662  *
 663  * Deprecated: This function has the wrong name and is equivalent to
 664  * gst_element_get_start_time().
 665  */
 666 #ifndef GST_REMOVE_DEPRECATED
 667 #ifdef GST_DISABLE_DEPRECATED
 668 GstClockTime gst_pipeline_get_last_stream_time (GstPipeline * pipeline);
 669 #endif
 670 GstClockTime
 671 gst_pipeline_get_last_stream_time (GstPipeline * pipeline)
 672 {
 673   GstClockTime result;
 674
 675   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 676
 677   result = gst_element_get_start_time (GST_ELEMENT_CAST (pipeline));
 678
 679   return result;
 680 }
 681 #endif /* GST_REMOVE_DEPRECATED */
 682
 683 static GstClock *
 684 gst_pipeline_provide_clock_func (GstElement * element)
 685 {
 686   GstClock *clock = NULL;
 687   GstPipeline *pipeline = GST_PIPELINE (element);
 688
 689   /* if we have a fixed clock, use that one */
 690   GST_OBJECT_LOCK (pipeline);
 691   if (GST_OBJECT_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
 692     clock = pipeline->fixed_clock;
 693     if (clock)
 694       gst_object_ref (clock);
 695     GST_OBJECT_UNLOCK (pipeline);
 696
 697     GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)",
 698         clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 699   } else {
 700     GST_OBJECT_UNLOCK (pipeline);
 701     /* let the parent bin select a clock */
 702     clock =
 703         GST_ELEMENT_CLASS (parent_class)->provide_clock (GST_ELEMENT
 704         (pipeline));
 705     /* no clock, use a system clock */
 706     if (!clock) {
 707       clock = gst_system_clock_obtain ();
 708
 709       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained system clock: %p (%s)",
 710           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 711     } else {
 712       GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained clock: %p (%s)",
 713           clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
 714     }
 715   }
 716   return clock;
 717 }
 718
 719 /**
 720  * gst_pipeline_get_clock:
 721  * @pipeline: a #GstPipeline
 722  *
 723  * Gets the current clock used by @pipeline.
 724  *
 725  * Returns: (transfer full): a #GstClock, unref after usage.
 726  */
 727 GstClock *
 728 gst_pipeline_get_clock (GstPipeline * pipeline)
 729 {
 730   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
 731
 732   return gst_pipeline_provide_clock_func (GST_ELEMENT_CAST (pipeline));
 733 }
 734
 735
 736 /**
 737  * gst_pipeline_use_clock:
 738  * @pipeline: a #GstPipeline
 739  * @clock: (transfer none): the clock to use
 740  *
 741  * Force @pipeline to use the given @clock. The pipeline will
 742  * always use the given clock even if new clock providers are added
 743  * to this pipeline.
 744  *
 745  * If @clock is NULL all clocking will be disabled which will make
 746  * the pipeline run as fast as possible.
 747  *
 748  * MT safe.
 749  */
 750 void
 751 gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock)
 752 {
 753   GstClock **clock_p;
 754
 755   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 756
 757   GST_OBJECT_LOCK (pipeline);
 758   GST_OBJECT_FLAG_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 759
 760   clock_p = &pipeline->fixed_clock;
 761   gst_object_replace ((GstObject **) clock_p, (GstObject *) clock);
 762   GST_OBJECT_UNLOCK (pipeline);
 763
 764   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)", clock,
 765       (clock ? GST_OBJECT_NAME (clock) : "nil"));
 766 }
 767
 768 /**
 769  * gst_pipeline_set_clock:
 770  * @pipeline: a #GstPipeline
 771  * @clock: (transfer none): the clock to set
 772  *
 773  * Set the clock for @pipeline. The clock will be distributed
 774  * to all the elements managed by the pipeline.
 775  *
 776  * Returns: TRUE if the clock could be set on the pipeline. FALSE if
 777  *   some element did not accept the clock.
 778  *
 779  * MT safe.
 780  */
 781 gboolean
 782 gst_pipeline_set_clock (GstPipeline * pipeline, GstClock * clock)
 783 {
 784   g_return_val_if_fail (pipeline != NULL, FALSE);
 785   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 786
 787   return
 788       GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT_CAST (pipeline),
 789       clock);
 790 }
 791
 792 /**
 793  * gst_pipeline_auto_clock:
 794  * @pipeline: a #GstPipeline
 795  *
 796  * Let @pipeline select a clock automatically. This is the default
 797  * behaviour.
 798  *
 799  * Use this function if you previous forced a fixed clock with
 800  * gst_pipeline_use_clock() and want to restore the default
 801  * pipeline clock selection algorithm.
 802  *
 803  * MT safe.
 804  */
 805 void
 806 gst_pipeline_auto_clock (GstPipeline * pipeline)
 807 {
 808   GstClock **clock_p;
 809
 810   g_return_if_fail (pipeline != NULL);
 811   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 812
 813   GST_OBJECT_LOCK (pipeline);
 814   GST_OBJECT_FLAG_UNSET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
 815
 816   clock_p = &pipeline->fixed_clock;
 817   gst_object_replace ((GstObject **) clock_p, NULL);
 818   GST_OBJECT_UNLOCK (pipeline);
 819
 820   GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using automatic clock");
 821 }
 822
 823 /**
 824  * gst_pipeline_set_delay:
 825  * @pipeline: a #GstPipeline
 826  * @delay: the delay
 827  *
 828  * Set the expected delay needed for all elements to perform the
 829  * PAUSED to PLAYING state change. @delay will be added to the
 830  * base time of the elements so that they wait an additional @delay
 831  * amount of time before starting to process buffers and cannot be
 832  * #GST_CLOCK_TIME_NONE.
 833  *
 834  * This option is used for tuning purposes and should normally not be
 835  * used.
 836  *
 837  * MT safe.
 838  *
 839  * Since: 0.10.5
 840  */
 841 void
 842 gst_pipeline_set_delay (GstPipeline * pipeline, GstClockTime delay)
 843 {
 844   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 845   g_return_if_fail (delay != GST_CLOCK_TIME_NONE);
 846
 847   GST_OBJECT_LOCK (pipeline);
 848   pipeline->delay = delay;
 849   GST_OBJECT_UNLOCK (pipeline);
 850 }
 851
 852 /**
 853  * gst_pipeline_get_delay:
 854  * @pipeline: a #GstPipeline
 855  *
 856  * Get the configured delay (see gst_pipeline_set_delay()).
 857  *
 858  * Returns: The configured delay.
 859  *
 860  * MT safe.
 861  *
 862  * Since: 0.10.5
 863  */
 864 GstClockTime
 865 gst_pipeline_get_delay (GstPipeline * pipeline)
 866 {
 867   GstClockTime res;
 868
 869   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 870
 871   GST_OBJECT_LOCK (pipeline);
 872   res = pipeline->delay;
 873   GST_OBJECT_UNLOCK (pipeline);
 874
 875   return res;
 876 }
 877
 878 /**
 879  * gst_pipeline_set_auto_flush_bus:
 880  * @pipeline: a #GstPipeline
 881  * @auto_flush: whether or not to automatically flush the bus when
 882  * the pipeline goes from READY to NULL state
 883  *
 884  * Usually, when a pipeline goes from READY to NULL state, it automatically
 885  * flushes all pending messages on the bus, which is done for refcounting
 886  * purposes, to break circular references.
 887  *
 888  * This means that applications that update state using (async) bus messages
 889  * (e.g. do certain things when a pipeline goes from PAUSED to READY) might
 890  * not get to see messages when the pipeline is shut down, because they might
 891  * be flushed before they can be dispatched in the main thread. This behaviour
 892  * can be disabled using this function.
 893  *
 894  * It is important that all messages on the bus are handled when the
 895  * automatic flushing is disabled else memory leaks will be introduced.
 896  *
 897  * MT safe.
 898  *
 899  * Since: 0.10.4
 900  */
 901 void
 902 gst_pipeline_set_auto_flush_bus (GstPipeline * pipeline, gboolean auto_flush)
 903 {
 904   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 905
 906   GST_OBJECT_LOCK (pipeline);
 907   pipeline->priv->auto_flush_bus = auto_flush;
 908   GST_OBJECT_UNLOCK (pipeline);
 909 }
 910
 911 /**
 912  * gst_pipeline_get_auto_flush_bus:
 913  * @pipeline: a #GstPipeline
 914  *
 915  * Check if @pipeline will automatically flush messages when going to
 916  * the NULL state.
 917  *
 918  * Returns: whether the pipeline will automatically flush its bus when
 919  * going from READY to NULL state or not.
 920  *
 921  * MT safe.
 922  *
 923  * Since: 0.10.4
 924  */
 925 gboolean
 926 gst_pipeline_get_auto_flush_bus (GstPipeline * pipeline)
 927 {
 928   gboolean res;
 929
 930   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 931
 932   GST_OBJECT_LOCK (pipeline);
 933   res = pipeline->priv->auto_flush_bus;
 934   GST_OBJECT_UNLOCK (pipeline);
 935
 936   return res;
 937 }