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