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