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