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