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