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