gst/gstpipeline.c

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