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 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 (G_OBJECT_CLASS (klass), 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 (G_OBJECT_CLASS (klass), 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   gst_element_set_bus (GST_ELEMENT_CAST (pipeline), bus);
 252   GST_DEBUG_OBJECT (pipeline, "set bus %" GST_PTR_FORMAT " on pipeline", bus);
 253   gst_object_unref (bus);
 254 }
 255
 256 static void
 257 gst_pipeline_dispose (GObject * object)
 258 {
 259   GstPipeline *pipeline = GST_PIPELINE (object);
 260   GstClock **clock_p = &pipeline->fixed_clock;
 261
 262   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pipeline, "dispose");
 263
 264   /* clear and unref any fixed clock */
 265   gst_object_replace ((GstObject **) clock_p, NULL);
 266
 267   G_OBJECT_CLASS (parent_class)->dispose (object);
 268 }
 269
 270 static void
 271 gst_pipeline_set_property (GObject * object, guint prop_id,
 272     const GValue * value, GParamSpec * pspec)
 273 {
 274   GstPipeline *pipeline = GST_PIPELINE (object);
 275
 276   switch (prop_id) {
 277     case PROP_DELAY:
 278       gst_pipeline_set_delay (pipeline, g_value_get_uint64 (value));
 279       break;
 280     case PROP_AUTO_FLUSH_BUS:
 281       gst_pipeline_set_auto_flush_bus (pipeline, g_value_get_boolean (value));
 282       break;
 283     default:
 284       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 285       break;
 286   }
 287 }
 288
 289 static void
 290 gst_pipeline_get_property (GObject * object, guint prop_id,
 291     GValue * value, GParamSpec * pspec)
 292 {
 293   GstPipeline *pipeline = GST_PIPELINE (object);
 294
 295   switch (prop_id) {
 296     case PROP_DELAY:
 297       g_value_set_uint64 (value, gst_pipeline_get_delay (pipeline));
 298       break;
 299     case PROP_AUTO_FLUSH_BUS:
 300       g_value_set_boolean (value, gst_pipeline_get_auto_flush_bus (pipeline));
 301       break;
 302     default:
 303       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 304       break;
 305   }
 306 }
 307
 308 /* default pipeline seeking code:
 309  *
 310  * If the pipeline is PLAYING and a flushing seek is done, set
 311  * the pipeline to PAUSED before doing the seek.
 312  *
 313  * A flushing seek also resets the stream time to 0 so that when
 314  * we go back to PLAYING after the seek, the base_time is recalculated
 315  * and redistributed to the elements.
 316  *
 317  */
 318 static gboolean
 319 do_pipeline_seek (GstElement * element, GstEvent * event)
 320 {
 321   gdouble rate;
 322   GstSeekFlags flags;
 323   gboolean flush;
 324   gboolean was_playing = FALSE;
 325   gboolean res;
 326
 327   /* we are only interested in the FLUSH flag of the seek event. */
 328   gst_event_parse_seek (event, &rate, NULL, &flags, NULL, NULL, NULL, NULL);
 329
 330   flush = flags & GST_SEEK_FLAG_FLUSH;
 331
 332   /* if flushing seek, get the current state */
 333   if (flush) {
 334     GstState state;
 335
 336     /* need to call _get_state() since a bin state is only updated
 337      * with this call. */
 338     gst_element_get_state (element, &state, NULL, 0);
 339     was_playing = state == GST_STATE_PLAYING;
 340
 341     if (was_playing) {
 342       /* and PAUSE when the pipeline was PLAYING, we don't need
 343        * to wait for the state change to complete since we are going
 344        * to flush out any preroll sample anyway */
 345       gst_element_set_state (element, GST_STATE_PAUSED);
 346     }
 347   }
 348
 349   /* let parent class implement the seek behaviour */
 350   res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
 351
 352   /* if flushing seek restore previous state */
 353   if (flush) {
 354     gboolean need_reset;
 355
 356     GST_OBJECT_LOCK (element);
 357     need_reset = GST_PIPELINE (element)->stream_time != GST_CLOCK_TIME_NONE;
 358     GST_OBJECT_UNLOCK (element);
 359
 360     /* need to reset the stream time to 0 after a successfull flushing seek,
 361      * unless the user explicitly disabled this behavior by setting stream
 362      * time to NONE */
 363     if (need_reset && res)
 364       gst_pipeline_set_new_stream_time (GST_PIPELINE (element), 0);
 365
 366     if (was_playing)
 367       /* and continue playing, this might return ASYNC in which case the
 368        * application can wait for the PREROLL to complete after the seek.
 369        */
 370       gst_element_set_state (element, GST_STATE_PLAYING);
 371   }
 372   return res;
 373 }
 374
 375 static gboolean
 376 gst_pipeline_send_event (GstElement * element, GstEvent * event)
 377 {
 378   gboolean res;
 379   GstEventType event_type = GST_EVENT_TYPE (event);
 380
 381   switch (event_type) {
 382     case GST_EVENT_SEEK:
 383       /* do the default seek handling */
 384       res = do_pipeline_seek (element, event);
 385       break;
 386     default:
 387       /* else parent implements the defaults */
 388       res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
 389       break;
 390   }
 391
 392   return res;
 393 }
 394
 395 /**
 396  * gst_pipeline_new:
 397  * @name: name of new pipeline
 398  *
 399  * Create a new pipeline with the given name.
 400  *
 401  * Returns: newly created GstPipeline
 402  *
 403  * MT safe.
 404  */
 405 GstElement *
 406 gst_pipeline_new (const gchar * name)
 407 {
 408   return gst_element_factory_make ("pipeline", name);
 409 }
 410
 411 /* MT safe */
 412 static GstStateChangeReturn
 413 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
 414 {
 415   GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
 416   GstPipeline *pipeline = GST_PIPELINE (element);
 417   GstClock *clock;
 418
 419   switch (transition) {
 420     case GST_STATE_CHANGE_NULL_TO_READY:
 421       GST_OBJECT_LOCK (element);
 422       if (element->bus)
 423         gst_bus_set_flushing (element->bus, FALSE);
 424       GST_OBJECT_UNLOCK (element);
 425       break;
 426     case GST_STATE_CHANGE_READY_TO_PAUSED:
 427       break;
 428     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 429     {
 430       GstClockTime new_base_time;
 431
 432       /* when going to playing, select a clock */
 433       clock = gst_element_provide_clock (element);
 434
 435       if (clock) {
 436         GstClockTime start_time, stream_time, delay;
 437         gboolean new_clock;
 438
 439         start_time = gst_clock_get_time (clock);
 440
 441         GST_OBJECT_LOCK (element);
 442         new_clock = element->clock != clock;
 443         stream_time = pipeline->stream_time;
 444         delay = pipeline->delay;
 445         GST_OBJECT_UNLOCK (element);
 446
 447         if (new_clock) {
 448           /* now distribute the clock (which could be NULL). If some
 449            * element refuses the clock, this will return FALSE and
 450            * we effectively fail the state change. */
 451           if (!gst_element_set_clock (element, clock))
 452             goto invalid_clock;
 453
 454           /* if we selected and distributed a new clock, let the app
 455            * know about it */
 456           gst_element_post_message (element,
 457               gst_message_new_new_clock (GST_OBJECT_CAST (element), clock));
 458         }
 459
 460         if (stream_time != GST_CLOCK_TIME_NONE)
 461           new_base_time = start_time - stream_time + delay;
 462         else
 463           new_base_time = GST_CLOCK_TIME_NONE;
 464
 465         gst_object_unref (clock);
 466       } else {
 467         GST_DEBUG ("no clock, using base time of 0");
 468         new_base_time = 0;
 469       }
 470
 471       if (new_base_time != GST_CLOCK_TIME_NONE)
 472         gst_element_set_base_time (element, new_base_time);
 473       else
 474         GST_DEBUG_OBJECT (pipeline,
 475             "NOT adjusting base time because stream time is NONE");
 476     }
 477       break;
 478     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 479       break;
 480     case GST_STATE_CHANGE_PAUSED_TO_READY:
 481     case GST_STATE_CHANGE_READY_TO_NULL:
 482       break;
 483   }
 484
 485   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 486
 487   switch (transition) {
 488     case GST_STATE_CHANGE_NULL_TO_READY:
 489       break;
 490     case GST_STATE_CHANGE_READY_TO_PAUSED:
 491     {
 492       gboolean need_reset;
 493
 494       /* only reset the stream time when the application did not
 495        * specify a stream time explicitly */
 496       GST_OBJECT_LOCK (element);
 497       need_reset = pipeline->stream_time != GST_CLOCK_TIME_NONE;
 498       GST_OBJECT_UNLOCK (element);
 499
 500       if (need_reset)
 501         gst_pipeline_set_new_stream_time (pipeline, 0);
 502     }
 503       break;
 504     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 505       break;
 506     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 507       GST_OBJECT_LOCK (element);
 508       if ((clock = element->clock)) {
 509         GstClockTime now;
 510
 511         gst_object_ref (clock);
 512         GST_OBJECT_UNLOCK (element);
 513
 514         /* calculate the time when we stopped */
 515         now = gst_clock_get_time (clock);
 516         gst_object_unref (clock);
 517
 518         GST_OBJECT_LOCK (element);
 519         /* store the current stream time */
 520         if (pipeline->stream_time != GST_CLOCK_TIME_NONE)
 521           pipeline->stream_time = now - element->base_time;
 522         GST_DEBUG_OBJECT (element,
 523             "stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
 524             ", base time %" GST_TIME_FORMAT,
 525             GST_TIME_ARGS (pipeline->stream_time), GST_TIME_ARGS (now),
 526             GST_TIME_ARGS (element->base_time));
 527       }
 528       GST_OBJECT_UNLOCK (element);
 529       break;
 530     case GST_STATE_CHANGE_PAUSED_TO_READY:
 531       break;
 532     case GST_STATE_CHANGE_READY_TO_NULL:
 533       GST_OBJECT_LOCK (element);
 534       if (element->bus) {
 535         if (pipeline->priv->auto_flush_bus) {
 536           gst_bus_set_flushing (element->bus, TRUE);
 537         } else {
 538           GST_INFO_OBJECT (element, "not flushing bus, auto-flushing disabled");
 539         }
 540       }
 541       GST_OBJECT_UNLOCK (element);
 542       break;
 543   }
 544   return result;
 545
 546   /* ERRORS */
 547 invalid_clock:
 548   {
 549     /* we generate this error when the selected clock was not
 550      * accepted by some element */
 551     GST_ELEMENT_ERROR (pipeline, CORE, CLOCK,
 552         (_("Selected clock cannot be used in pipeline.")),
 553         ("Pipeline cannot operate with selected clock"));
 554     GST_DEBUG_OBJECT (pipeline,
 555         "Pipeline cannot operate with selected clock %p", clock);
 556     return GST_STATE_CHANGE_FAILURE;
 557   }
 558 }
 559
 560 /**
 561  * gst_pipeline_get_bus:
 562  * @pipeline: a #GstPipeline
 563  *
 564  * Gets the #GstBus of @pipeline.
 565  *
 566  * Returns: a #GstBus, unref after usage.
 567  *
 568  * MT safe.
 569  */
 570 GstBus *
 571 gst_pipeline_get_bus (GstPipeline * pipeline)
 572 {
 573   return gst_element_get_bus (GST_ELEMENT (pipeline));
 574 }
 575
 576 /**
 577  * gst_pipeline_set_new_stream_time:
 578  * @pipeline: a #GstPipeline
 579  * @time: the new stream time to set
 580  *
 581  * Set the new stream time of @pipeline to @time. The stream time is used to
 582  * set the base time on the elements (see gst_element_set_base_time())
 583  * in the PAUSED->PLAYING state transition.
 584  *
 585  * Setting @time to #GST_CLOCK_TIME_NONE will disable the pipeline's management
 586  * of element base time. The application will then be responsible for
 587  * performing base time distribution. This is sometimes useful if you want to
 588  * synchronize capture from multiple pipelines, and you can also ensure that the
 589  * pipelines have the same clock.
 590  *
 591  * MT safe.
 592  */
 593 void
 594 gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time)
 595 {
 596   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 597
 598   GST_OBJECT_LOCK (pipeline);
 599   pipeline->stream_time = time;
 600   GST_OBJECT_UNLOCK (pipeline);
 601
 602   GST_DEBUG_OBJECT (pipeline, "set new stream_time to %" GST_TIME_FORMAT,
 603       GST_TIME_ARGS (time));
 604
 605   if (time == GST_CLOCK_TIME_NONE)
 606     GST_DEBUG_OBJECT (pipeline, "told not to adjust base time");
 607 }
 608
 609 /**
 610  * gst_pipeline_get_last_stream_time:
 611  * @pipeline: a #GstPipeline
 612  *
 613  * Gets the last stream time of @pipeline. If the pipeline is PLAYING,
 614  * the returned time is the stream time used to configure the element's
 615  * base time in the PAUSED->PLAYING state. If the pipeline is PAUSED, the
 616  * returned time is the stream time when the pipeline was paused.
 617  *
 618  * This function returns #GST_CLOCK_TIME_NONE if the pipeline was
 619  * configured to not handle the management of the element's base time
 620  * (see gst_pipeline_set_new_stream_time()).
 621  *
 622  * Returns: a #GstClockTime.
 623  *
 624  * MT safe.
 625  */
 626 GstClockTime
 627 gst_pipeline_get_last_stream_time (GstPipeline * pipeline)
 628 {
 629   GstClockTime result;
 630
 631   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 632
 633   GST_OBJECT_LOCK (pipeline);
 634   result = pipeline->stream_time;
 635   GST_OBJECT_UNLOCK (pipeline);
 636
 637   return result;
 638 }
 639
 640 static GstClock *
 641 gst_pipeline_provide_clock_func (GstElement * element)
 642 {
 643   GstClock *clock = NULL;
 644   GstPipeline *pipeline = GST_PIPELINE (element);
 645
 646   /* if we have a fixed clock, use that one */
 647   GST_OBJECT_LOCK (pipeline);
 648   if (GST_OBJECT_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
 649     clock = pipeline->fixed_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.
 787  *
 788  * This option is used for tuning purposes and should normally not be
 789  * used.
 790  *
 791  * MT safe.
 792  *
 793  * Since: 0.10.5
 794  */
 795 void
 796 gst_pipeline_set_delay (GstPipeline * pipeline, GstClockTime delay)
 797 {
 798   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 799
 800   GST_OBJECT_LOCK (pipeline);
 801   pipeline->delay = delay;
 802   GST_OBJECT_UNLOCK (pipeline);
 803 }
 804
 805 /**
 806  * gst_pipeline_get_delay:
 807  * @pipeline: a #GstPipeline
 808  *
 809  * Get the configured delay (see gst_pipeline_set_delay()).
 810  *
 811  * Returns: The configured delay.
 812  *
 813  * MT safe.
 814  *
 815  * Since: 0.10.5
 816  */
 817 GstClockTime
 818 gst_pipeline_get_delay (GstPipeline * pipeline)
 819 {
 820   GstClockTime res;
 821
 822   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
 823
 824   GST_OBJECT_LOCK (pipeline);
 825   res = pipeline->delay;
 826   GST_OBJECT_UNLOCK (pipeline);
 827
 828   return res;
 829 }
 830
 831 /**
 832  * gst_pipeline_set_auto_flush_bus:
 833  * @pipeline: a #GstPipeline
 834  * @auto_flush: whether or not to automatically flush the bus when
 835  * the pipeline goes from READY to NULL state
 836  *
 837  * Usually, when a pipeline goes from READY to NULL state, it automatically
 838  * flushes all pending messages on the bus, which is done for refcounting
 839  * purposes, to break circular references.
 840  *
 841  * This means that applications that update state using (async) bus messages
 842  * (e.g. do certain things when a pipeline goes from PAUSED to READY) might
 843  * not get to see messages when the pipeline is shut down, because they might
 844  * be flushed before they can be dispatched in the main thread. This behaviour
 845  * can be disabled using this function.
 846  *
 847  * It is important that all messages on the bus are handled when the
 848  * automatic flushing is disabled else memory leaks will be introduced.
 849  *
 850  * MT safe.
 851  *
 852  * Since: 0.10.4
 853  */
 854 void
 855 gst_pipeline_set_auto_flush_bus (GstPipeline * pipeline, gboolean auto_flush)
 856 {
 857   g_return_if_fail (GST_IS_PIPELINE (pipeline));
 858
 859   GST_OBJECT_LOCK (pipeline);
 860   pipeline->priv->auto_flush_bus = auto_flush;
 861   GST_OBJECT_UNLOCK (pipeline);
 862 }
 863
 864 /**
 865  * gst_pipeline_get_auto_flush_bus:
 866  * @pipeline: a #GstPipeline
 867  *
 868  * Check if @pipeline will automatically flush messages when going to
 869  * the NULL state.
 870  *
 871  * Returns: whether the pipeline will automatically flush its bus when
 872  * going from READY to NULL state or not.
 873  *
 874  * MT safe.
 875  *
 876  * Since: 0.10.4
 877  */
 878 gboolean
 879 gst_pipeline_get_auto_flush_bus (GstPipeline * pipeline)
 880 {
 881   gboolean res;
 882
 883   g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
 884
 885   GST_OBJECT_LOCK (pipeline);
 886   res = pipeline->priv->auto_flush_bus;
 887   GST_OBJECT_UNLOCK (pipeline);
 888
 889   return res;
 890 }