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