gst/gstpipeline.c

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