gst/gstpipeline.c

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