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