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