gst/gstpipeline.c

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