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