2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2004,2005 Wim Taymans <wim@fluendo.com>
5 * gstpipeline.c: Overall pipeline management element
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.
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.
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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
26 * @short_description: Top-level bin with clocking and bus management
28 * @see_also: #GstElement, #GstBin, #GstClock, #GstBus
30 * A #GstPipeline is a special #GstBin used as the toplevel container for
31 * the filter graph. The #GstPipeline will manage the selection and
32 * distribution of a global #GstClock as well as provide a #GstBus to the
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).
39 * Elements are added and removed from the pipeline using the #GstBin
40 * methods like gst_bin_add() and gst_bin_remove() (see #GstBin).
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.
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().
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.
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
65 * A #GstPipeline maintains a running time for the elements. The running
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 running 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 running 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_element_set_start_time() method.
77 #include "gst_private.h"
79 #include "gst-i18n-lib.h"
81 #include "gstpipeline.h"
83 #include "gstsystemclock.h"
86 GST_DEBUG_CATEGORY_STATIC (pipeline_debug);
87 #define GST_CAT_DEFAULT pipeline_debug
89 /* Pipeline signals and args */
96 #define DEFAULT_DELAY 0
97 #define DEFAULT_AUTO_FLUSH_BUS TRUE
98 #define DEFAULT_LATENCY GST_CLOCK_TIME_NONE
108 #define GST_PIPELINE_GET_PRIVATE(obj) \
109 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PIPELINE, GstPipelinePrivate))
111 struct _GstPipelinePrivate
114 gboolean auto_flush_bus;
116 /* when we need to update stream_time or clock when going back to
118 GstClockTime last_start_time;
119 gboolean update_clock;
121 GstClockTime latency;
125 static void gst_pipeline_dispose (GObject * object);
126 static void gst_pipeline_set_property (GObject * object, guint prop_id,
127 const GValue * value, GParamSpec * pspec);
128 static void gst_pipeline_get_property (GObject * object, guint prop_id,
129 GValue * value, GParamSpec * pspec);
131 static GstClock *gst_pipeline_provide_clock_func (GstElement * element);
132 static GstStateChangeReturn gst_pipeline_change_state (GstElement * element,
133 GstStateChange transition);
135 static void gst_pipeline_handle_message (GstBin * bin, GstMessage * message);
136 static gboolean gst_pipeline_do_latency (GstBin * bin);
138 /* static guint gst_pipeline_signals[LAST_SIGNAL] = { 0 }; */
142 GST_DEBUG_CATEGORY_INIT (pipeline_debug, "pipeline", GST_DEBUG_BOLD, \
143 "debugging info for the 'pipeline' container element"); \
146 #define gst_pipeline_parent_class parent_class
147 G_DEFINE_TYPE_WITH_CODE (GstPipeline, gst_pipeline, GST_TYPE_BIN, _do_init);
150 gst_pipeline_class_init (GstPipelineClass * klass)
152 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
153 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
154 GstBinClass *gstbin_class = GST_BIN_CLASS (klass);
156 g_type_class_add_private (klass, sizeof (GstPipelinePrivate));
158 gobject_class->set_property = gst_pipeline_set_property;
159 gobject_class->get_property = gst_pipeline_get_property;
164 * The expected delay needed for elements to spin up to the
165 * PLAYING state expressed in nanoseconds.
166 * see gst_pipeline_set_delay() for more information on this option.
168 g_object_class_install_property (gobject_class, PROP_DELAY,
169 g_param_spec_uint64 ("delay", "Delay",
170 "Expected delay needed for elements "
171 "to spin up to PLAYING in nanoseconds", 0, G_MAXUINT64, DEFAULT_DELAY,
172 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
175 * GstPipeline:auto-flush-bus:
177 * Whether or not to automatically flush all messages on the
178 * pipeline's bus when going from READY to NULL state. Please see
179 * gst_pipeline_set_auto_flush_bus() for more information on this option.
181 g_object_class_install_property (gobject_class, PROP_AUTO_FLUSH_BUS,
182 g_param_spec_boolean ("auto-flush-bus", "Auto Flush Bus",
183 "Whether to automatically flush the pipeline's bus when going "
184 "from READY into NULL state", DEFAULT_AUTO_FLUSH_BUS,
185 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
188 * GstPipeline:latency:
190 * Latency to configure on the pipeline. See gst_pipeline_set_latency().
194 g_object_class_install_property (gobject_class, PROP_LATENCY,
195 g_param_spec_uint64 ("latency", "Latency",
196 "Latency to configure on the pipeline", 0, G_MAXUINT64,
197 DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
199 gobject_class->dispose = gst_pipeline_dispose;
201 gst_element_class_set_static_metadata (gstelement_class, "Pipeline object",
203 "Complete pipeline object",
204 "Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>");
206 gstelement_class->change_state =
207 GST_DEBUG_FUNCPTR (gst_pipeline_change_state);
208 gstelement_class->provide_clock =
209 GST_DEBUG_FUNCPTR (gst_pipeline_provide_clock_func);
210 gstbin_class->handle_message =
211 GST_DEBUG_FUNCPTR (gst_pipeline_handle_message);
212 gstbin_class->do_latency = GST_DEBUG_FUNCPTR (gst_pipeline_do_latency);
216 gst_pipeline_init (GstPipeline * pipeline)
220 pipeline->priv = GST_PIPELINE_GET_PRIVATE (pipeline);
222 /* set default property values */
223 pipeline->priv->auto_flush_bus = DEFAULT_AUTO_FLUSH_BUS;
224 pipeline->delay = DEFAULT_DELAY;
225 pipeline->priv->latency = DEFAULT_LATENCY;
227 /* create and set a default bus */
228 bus = gst_bus_new ();
230 /* FIXME, disabled for 0.10.5 release as it caused to many regressions */
231 /* Start our bus in flushing if appropriate */
232 if (pipeline->priv->auto_flush_bus)
233 gst_bus_set_flushing (bus, TRUE);
236 gst_element_set_bus (GST_ELEMENT_CAST (pipeline), bus);
237 GST_DEBUG_OBJECT (pipeline, "set bus %" GST_PTR_FORMAT " on pipeline", bus);
238 gst_object_unref (bus);
242 gst_pipeline_dispose (GObject * object)
244 GstPipeline *pipeline = GST_PIPELINE (object);
245 GstClock **clock_p = &pipeline->fixed_clock;
247 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pipeline, "%p dispose", pipeline);
249 /* clear and unref any fixed clock */
250 gst_object_replace ((GstObject **) clock_p, NULL);
252 G_OBJECT_CLASS (parent_class)->dispose (object);
256 gst_pipeline_set_property (GObject * object, guint prop_id,
257 const GValue * value, GParamSpec * pspec)
259 GstPipeline *pipeline = GST_PIPELINE (object);
263 gst_pipeline_set_delay (pipeline, g_value_get_uint64 (value));
265 case PROP_AUTO_FLUSH_BUS:
266 gst_pipeline_set_auto_flush_bus (pipeline, g_value_get_boolean (value));
269 gst_pipeline_set_latency (pipeline, g_value_get_uint64 (value));
272 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
278 gst_pipeline_get_property (GObject * object, guint prop_id,
279 GValue * value, GParamSpec * pspec)
281 GstPipeline *pipeline = GST_PIPELINE (object);
285 g_value_set_uint64 (value, gst_pipeline_get_delay (pipeline));
287 case PROP_AUTO_FLUSH_BUS:
288 g_value_set_boolean (value, gst_pipeline_get_auto_flush_bus (pipeline));
291 g_value_set_uint64 (value, gst_pipeline_get_latency (pipeline));
294 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
299 /* set the start_time to 0, this will cause us to select a new base_time and
300 * make the running_time start from 0 again. */
302 reset_start_time (GstPipeline * pipeline, GstClockTime start_time)
304 GST_OBJECT_LOCK (pipeline);
305 if (GST_ELEMENT_START_TIME (pipeline) != GST_CLOCK_TIME_NONE) {
306 GST_DEBUG_OBJECT (pipeline, "reset start_time to 0");
307 GST_ELEMENT_START_TIME (pipeline) = start_time;
308 pipeline->priv->last_start_time = -1;
310 GST_DEBUG_OBJECT (pipeline, "application asked to not reset stream_time");
312 GST_OBJECT_UNLOCK (pipeline);
317 * @name: (allow-none): name of new pipeline
319 * Create a new pipeline with the given name.
321 * Returns: (transfer floating): newly created GstPipeline
326 gst_pipeline_new (const gchar * name)
328 return gst_element_factory_make ("pipeline", name);
331 /* takes a snapshot of the running_time of the pipeline and store this as the
332 * element start_time. This is the time we will set as the running_time of the
333 * pipeline when we go to PLAYING next. */
335 pipeline_update_start_time (GstElement * element)
337 GstPipeline *pipeline = GST_PIPELINE_CAST (element);
340 GST_OBJECT_LOCK (element);
341 if ((clock = element->clock)) {
344 gst_object_ref (clock);
345 GST_OBJECT_UNLOCK (element);
347 /* calculate the time when we stopped */
348 now = gst_clock_get_time (clock);
349 gst_object_unref (clock);
351 GST_OBJECT_LOCK (element);
352 /* store the current running time */
353 if (GST_ELEMENT_START_TIME (pipeline) != GST_CLOCK_TIME_NONE) {
354 if (now != GST_CLOCK_TIME_NONE)
355 GST_ELEMENT_START_TIME (pipeline) = now - element->base_time;
357 GST_WARNING_OBJECT (element,
358 "Clock %s returned invalid time, can't calculate "
359 "running_time when going to the PAUSED state",
360 GST_OBJECT_NAME (clock));
362 /* we went to PAUSED, when going to PLAYING select clock and new
364 pipeline->priv->update_clock = TRUE;
366 GST_DEBUG_OBJECT (element,
367 "start_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
368 ", base_time %" GST_TIME_FORMAT,
369 GST_TIME_ARGS (GST_ELEMENT_START_TIME (pipeline)),
370 GST_TIME_ARGS (now), GST_TIME_ARGS (element->base_time));
372 GST_OBJECT_UNLOCK (element);
376 static GstStateChangeReturn
377 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
379 GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
380 GstPipeline *pipeline = GST_PIPELINE_CAST (element);
383 switch (transition) {
384 case GST_STATE_CHANGE_NULL_TO_READY:
385 GST_OBJECT_LOCK (element);
387 gst_bus_set_flushing (element->bus, FALSE);
388 GST_OBJECT_UNLOCK (element);
390 case GST_STATE_CHANGE_READY_TO_PAUSED:
391 GST_OBJECT_LOCK (element);
392 pipeline->priv->update_clock = TRUE;
393 GST_OBJECT_UNLOCK (element);
395 /* READY to PAUSED starts running_time from 0 */
396 reset_start_time (pipeline, 0);
398 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
400 GstClockTime now, start_time, last_start_time, delay;
401 gboolean update_clock;
404 GST_DEBUG_OBJECT (element, "selecting clock and base_time");
406 GST_OBJECT_LOCK (element);
407 cur_clock = element->clock;
409 gst_object_ref (cur_clock);
410 /* get the desired running_time of the first buffer aka the start_time */
411 start_time = GST_ELEMENT_START_TIME (pipeline);
412 last_start_time = pipeline->priv->last_start_time;
413 pipeline->priv->last_start_time = start_time;
414 /* see if we need to update the clock */
415 update_clock = pipeline->priv->update_clock;
416 pipeline->priv->update_clock = FALSE;
417 delay = pipeline->delay;
418 GST_OBJECT_UNLOCK (element);
420 /* running time changed, either with a PAUSED or a flush, we need to check
421 * if there is a new clock & update the base time */
422 /* only do this for top-level, however */
423 if (GST_OBJECT_PARENT (element) == NULL &&
424 (update_clock || last_start_time != start_time)) {
425 GST_DEBUG_OBJECT (pipeline, "Need to update start_time");
427 /* when going to PLAYING, select a clock when needed. If we just got
428 * flushed, we don't reselect the clock. */
430 GST_DEBUG_OBJECT (pipeline, "Need to update clock.");
431 clock = gst_element_provide_clock (element);
433 GST_DEBUG_OBJECT (pipeline,
434 "Don't need to update clock, using old clock.");
435 /* only try to ref if cur_clock is not NULL */
437 gst_object_ref (cur_clock);
442 now = gst_clock_get_time (clock);
444 GST_DEBUG_OBJECT (pipeline, "no clock, using base time of NONE");
445 now = GST_CLOCK_TIME_NONE;
448 if (clock != cur_clock) {
449 /* now distribute the clock (which could be NULL). If some
450 * element refuses the clock, this will return FALSE and
451 * we effectively fail the state change. */
452 if (!gst_element_set_clock (element, clock))
455 /* if we selected and distributed a new clock, let the app
457 gst_element_post_message (element,
458 gst_message_new_new_clock (GST_OBJECT_CAST (element), clock));
462 gst_object_unref (clock);
464 if (start_time != GST_CLOCK_TIME_NONE && now != GST_CLOCK_TIME_NONE) {
465 GstClockTime new_base_time = now - start_time + delay;
466 GST_DEBUG_OBJECT (element,
467 "start_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
468 ", base_time %" GST_TIME_FORMAT,
469 GST_TIME_ARGS (start_time), GST_TIME_ARGS (now),
470 GST_TIME_ARGS (new_base_time));
472 gst_element_set_base_time (element, new_base_time);
474 GST_DEBUG_OBJECT (pipeline,
475 "NOT adjusting base_time because start_time is NONE");
478 GST_DEBUG_OBJECT (pipeline,
479 "NOT adjusting base_time because we selected one before");
483 gst_object_unref (cur_clock);
486 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
488 /* we take a start_time snapshot before calling the children state changes
489 * so that they know about when the pipeline PAUSED. */
490 pipeline_update_start_time (element);
493 case GST_STATE_CHANGE_PAUSED_TO_READY:
494 reset_start_time (pipeline, 0);
496 case GST_STATE_CHANGE_READY_TO_NULL:
500 result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
502 switch (transition) {
503 case GST_STATE_CHANGE_NULL_TO_READY:
505 case GST_STATE_CHANGE_READY_TO_PAUSED:
507 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
509 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
511 /* Take a new snapshot of the start_time after calling the state change on
512 * all children. This will be the running_time of the pipeline when we go
514 pipeline_update_start_time (element);
517 case GST_STATE_CHANGE_PAUSED_TO_READY:
519 case GST_STATE_CHANGE_READY_TO_NULL:
524 /* grab some stuff before we release the lock to flush out the bus */
525 GST_OBJECT_LOCK (element);
526 if ((bus = element->bus))
527 gst_object_ref (bus);
528 auto_flush = pipeline->priv->auto_flush_bus;
529 GST_OBJECT_UNLOCK (element);
533 gst_bus_set_flushing (bus, TRUE);
535 GST_INFO_OBJECT (element, "not flushing bus, auto-flushing disabled");
537 gst_object_unref (bus);
547 /* we generate this error when the selected clock was not
548 * accepted by some element */
549 GST_ELEMENT_ERROR (pipeline, CORE, CLOCK,
550 (_("Selected clock cannot be used in pipeline.")),
551 ("Pipeline cannot operate with selected clock"));
552 GST_DEBUG_OBJECT (pipeline,
553 "Pipeline cannot operate with selected clock %p", clock);
555 gst_object_unref (clock);
556 return GST_STATE_CHANGE_FAILURE;
560 /* intercept the bus messages from our children. We watch for the ASYNC_START
561 * message with is posted by the elements (sinks) that require a reset of the
562 * running_time after a flush. ASYNC_START also brings the pipeline back into
563 * the PAUSED, pending PAUSED state. When the ASYNC_DONE message is received the
564 * pipeline will redistribute the new base_time and will bring the elements back
565 * to the desired state of the pipeline. */
567 gst_pipeline_handle_message (GstBin * bin, GstMessage * message)
569 GstPipeline *pipeline = GST_PIPELINE_CAST (bin);
571 switch (GST_MESSAGE_TYPE (message)) {
572 case GST_MESSAGE_RESET_TIME:
574 GstClockTime running_time;
576 gst_message_parse_reset_time (message, &running_time);
578 /* reset our running time if we need to distribute a new base_time to the
580 reset_start_time (pipeline, running_time);
583 case GST_MESSAGE_CLOCK_LOST:
587 gst_message_parse_clock_lost (message, &clock);
589 GST_OBJECT_LOCK (bin);
590 if (clock == GST_ELEMENT_CAST (bin)->clock) {
591 GST_DEBUG_OBJECT (bin, "Used clock '%s' got lost",
592 GST_OBJECT_NAME (clock));
593 pipeline->priv->update_clock = TRUE;
595 GST_OBJECT_UNLOCK (bin);
600 GST_BIN_CLASS (parent_class)->handle_message (bin, message);
604 gst_pipeline_do_latency (GstBin * bin)
606 GstPipeline *pipeline = GST_PIPELINE (bin);
608 GstClockTime latency;
609 GstClockTime min_latency, max_latency;
612 GST_OBJECT_LOCK (pipeline);
613 latency = pipeline->priv->latency;
614 GST_OBJECT_UNLOCK (pipeline);
616 if (latency == GST_CLOCK_TIME_NONE)
617 return GST_BIN_CLASS (parent_class)->do_latency (bin);
619 GST_DEBUG_OBJECT (pipeline, "querying latency");
621 query = gst_query_new_latency ();
622 if ((res = gst_element_query (GST_ELEMENT_CAST (pipeline), query))) {
625 gst_query_parse_latency (query, &live, &min_latency, &max_latency);
627 GST_DEBUG_OBJECT (pipeline,
628 "got min latency %" GST_TIME_FORMAT ", max latency %"
629 GST_TIME_FORMAT ", live %d", GST_TIME_ARGS (min_latency),
630 GST_TIME_ARGS (max_latency), live);
632 if (max_latency < min_latency) {
633 /* this is an impossible situation, some parts of the pipeline might not
634 * work correctly. We post a warning for now. */
635 GST_ELEMENT_WARNING (pipeline, CORE, CLOCK, (NULL),
636 ("Impossible to configure latency: max %" GST_TIME_FORMAT " < min %"
637 GST_TIME_FORMAT ". Add queues or other buffering elements.",
638 GST_TIME_ARGS (max_latency), GST_TIME_ARGS (min_latency)));
641 if (latency < min_latency) {
642 /* This is a problematic situation as we will most likely drop lots of
643 * data if we configure a too low latency */
644 GST_ELEMENT_WARNING (pipeline, CORE, CLOCK, (NULL),
645 ("Configured latency is lower than detected minimum latency: configured %"
646 GST_TIME_FORMAT " < min %" GST_TIME_FORMAT,
647 GST_TIME_ARGS (latency), GST_TIME_ARGS (min_latency)));
650 /* this is not a real problem, we just don't configure any latency. */
651 GST_WARNING_OBJECT (pipeline, "failed to query latency");
653 gst_query_unref (query);
656 /* configure latency on elements */
658 gst_element_send_event (GST_ELEMENT_CAST (pipeline),
659 gst_event_new_latency (latency));
661 GST_INFO_OBJECT (pipeline, "configured latency of %" GST_TIME_FORMAT,
662 GST_TIME_ARGS (latency));
664 GST_WARNING_OBJECT (pipeline,
665 "did not really configure latency of %" GST_TIME_FORMAT,
666 GST_TIME_ARGS (latency));
673 * gst_pipeline_get_bus:
674 * @pipeline: a #GstPipeline
676 * Gets the #GstBus of @pipeline. The bus allows applications to receive
677 * #GstMessage packets.
679 * Returns: (transfer full): a #GstBus, unref after usage.
684 gst_pipeline_get_bus (GstPipeline * pipeline)
686 return gst_element_get_bus (GST_ELEMENT_CAST (pipeline));
690 gst_pipeline_provide_clock_func (GstElement * element)
692 GstClock *clock = NULL;
693 GstPipeline *pipeline = GST_PIPELINE (element);
695 /* if we have a fixed clock, use that one */
696 GST_OBJECT_LOCK (pipeline);
697 if (GST_OBJECT_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
698 clock = pipeline->fixed_clock;
700 gst_object_ref (clock);
701 GST_OBJECT_UNLOCK (pipeline);
703 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)",
704 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
706 GST_OBJECT_UNLOCK (pipeline);
707 /* let the parent bin select a clock */
709 GST_ELEMENT_CLASS (parent_class)->provide_clock (GST_ELEMENT
711 /* no clock, use a system clock */
713 clock = gst_system_clock_obtain ();
715 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained system clock: %p (%s)",
716 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
718 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained clock: %p (%s)",
719 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
726 * gst_pipeline_get_clock: (skip)
727 * @pipeline: a #GstPipeline
729 * Gets the current clock used by @pipeline. Users of object
730 * oriented languages should use gst_pipeline_get_pipeline_clock()
731 * to avoid confusion with gst_element_get_clock() which has a different behavior.
733 * Unlike gst_element_get_clock(), this function will always return a
734 * clock, even if the pipeline is not in the PLAYING state.
736 * Returns: (transfer full): a #GstClock, unref after usage.
739 gst_pipeline_get_clock (GstPipeline * pipeline)
741 return gst_pipeline_get_pipeline_clock (pipeline);
745 * gst_pipeline_get_pipeline_clock:
746 * @pipeline: a #GstPipeline
748 * Gets the current clock used by @pipeline.
750 * Unlike gst_element_get_clock(), this function will always return a
751 * clock, even if the pipeline is not in the PLAYING state.
753 * Returns: (transfer full): a #GstClock, unref after usage.
758 gst_pipeline_get_pipeline_clock (GstPipeline * pipeline)
760 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
762 return gst_pipeline_provide_clock_func (GST_ELEMENT_CAST (pipeline));
767 * gst_pipeline_use_clock:
768 * @pipeline: a #GstPipeline
769 * @clock: (transfer none) (allow-none): the clock to use
771 * Force @pipeline to use the given @clock. The pipeline will
772 * always use the given clock even if new clock providers are added
775 * If @clock is %NULL all clocking will be disabled which will make
776 * the pipeline run as fast as possible.
781 gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock)
785 g_return_if_fail (GST_IS_PIPELINE (pipeline));
787 GST_OBJECT_LOCK (pipeline);
788 GST_OBJECT_FLAG_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
790 clock_p = &pipeline->fixed_clock;
791 gst_object_replace ((GstObject **) clock_p, (GstObject *) clock);
792 GST_OBJECT_UNLOCK (pipeline);
794 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)", clock,
795 (clock ? GST_OBJECT_NAME (clock) : "nil"));
799 * gst_pipeline_set_clock: (skip)
800 * @pipeline: a #GstPipeline
801 * @clock: (transfer none): the clock to set
803 * Set the clock for @pipeline. The clock will be distributed
804 * to all the elements managed by the pipeline.
806 * Returns: %TRUE if the clock could be set on the pipeline. %FALSE if
807 * some element did not accept the clock.
812 gst_pipeline_set_clock (GstPipeline * pipeline, GstClock * clock)
814 g_return_val_if_fail (pipeline != NULL, FALSE);
815 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
818 GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT_CAST (pipeline),
823 * gst_pipeline_auto_clock:
824 * @pipeline: a #GstPipeline
826 * Let @pipeline select a clock automatically. This is the default
829 * Use this function if you previous forced a fixed clock with
830 * gst_pipeline_use_clock() and want to restore the default
831 * pipeline clock selection algorithm.
836 gst_pipeline_auto_clock (GstPipeline * pipeline)
840 g_return_if_fail (pipeline != NULL);
841 g_return_if_fail (GST_IS_PIPELINE (pipeline));
843 GST_OBJECT_LOCK (pipeline);
844 GST_OBJECT_FLAG_UNSET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
846 clock_p = &pipeline->fixed_clock;
847 gst_object_replace ((GstObject **) clock_p, NULL);
848 GST_OBJECT_UNLOCK (pipeline);
850 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using automatic clock");
854 * gst_pipeline_set_delay:
855 * @pipeline: a #GstPipeline
858 * Set the expected delay needed for all elements to perform the
859 * PAUSED to PLAYING state change. @delay will be added to the
860 * base time of the elements so that they wait an additional @delay
861 * amount of time before starting to process buffers and cannot be
862 * #GST_CLOCK_TIME_NONE.
864 * This option is used for tuning purposes and should normally not be
870 gst_pipeline_set_delay (GstPipeline * pipeline, GstClockTime delay)
872 g_return_if_fail (GST_IS_PIPELINE (pipeline));
873 g_return_if_fail (delay != GST_CLOCK_TIME_NONE);
875 GST_OBJECT_LOCK (pipeline);
876 pipeline->delay = delay;
877 GST_OBJECT_UNLOCK (pipeline);
881 * gst_pipeline_get_delay:
882 * @pipeline: a #GstPipeline
884 * Get the configured delay (see gst_pipeline_set_delay()).
886 * Returns: The configured delay.
891 gst_pipeline_get_delay (GstPipeline * pipeline)
895 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
897 GST_OBJECT_LOCK (pipeline);
898 res = pipeline->delay;
899 GST_OBJECT_UNLOCK (pipeline);
905 * gst_pipeline_set_auto_flush_bus:
906 * @pipeline: a #GstPipeline
907 * @auto_flush: whether or not to automatically flush the bus when
908 * the pipeline goes from READY to NULL state
910 * Usually, when a pipeline goes from READY to NULL state, it automatically
911 * flushes all pending messages on the bus, which is done for refcounting
912 * purposes, to break circular references.
914 * This means that applications that update state using (async) bus messages
915 * (e.g. do certain things when a pipeline goes from PAUSED to READY) might
916 * not get to see messages when the pipeline is shut down, because they might
917 * be flushed before they can be dispatched in the main thread. This behaviour
918 * can be disabled using this function.
920 * It is important that all messages on the bus are handled when the
921 * automatic flushing is disabled else memory leaks will be introduced.
926 gst_pipeline_set_auto_flush_bus (GstPipeline * pipeline, gboolean auto_flush)
928 g_return_if_fail (GST_IS_PIPELINE (pipeline));
930 GST_OBJECT_LOCK (pipeline);
931 pipeline->priv->auto_flush_bus = auto_flush;
932 GST_OBJECT_UNLOCK (pipeline);
936 * gst_pipeline_get_auto_flush_bus:
937 * @pipeline: a #GstPipeline
939 * Check if @pipeline will automatically flush messages when going to
942 * Returns: whether the pipeline will automatically flush its bus when
943 * going from READY to NULL state or not.
948 gst_pipeline_get_auto_flush_bus (GstPipeline * pipeline)
952 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
954 GST_OBJECT_LOCK (pipeline);
955 res = pipeline->priv->auto_flush_bus;
956 GST_OBJECT_UNLOCK (pipeline);
962 * gst_pipeline_set_latency:
963 * @pipeline: a #GstPipeline
964 * @latency: latency to configure
966 * Sets the latency that should be configured on the pipeline. Setting
967 * GST_CLOCK_TIME_NONE will restore the default behaviour of using the minimum
968 * latency from the LATENCY query. Setting this is usually not required and
969 * the pipeline will figure out an appropriate latency automatically.
971 * Setting a too low latency, especially lower than the minimum latency from
972 * the LATENCY query, will most likely cause the pipeline to fail.
977 gst_pipeline_set_latency (GstPipeline * pipeline, GstClockTime latency)
981 g_return_if_fail (GST_IS_PIPELINE (pipeline));
983 GST_OBJECT_LOCK (pipeline);
984 changed = (pipeline->priv->latency != latency);
985 pipeline->priv->latency = latency;
986 GST_OBJECT_UNLOCK (pipeline);
989 gst_bin_recalculate_latency (GST_BIN_CAST (pipeline));
993 * gst_pipeline_get_latency:
994 * @pipeline: a #GstPipeline
996 * Gets the latency that should be configured on the pipeline. See
997 * gst_pipeline_set_latency().
999 * Returns: Latency to configure on the pipeline or GST_CLOCK_TIME_NONE
1005 gst_pipeline_get_latency (GstPipeline * pipeline)
1007 GstClockTime latency;
1009 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
1011 GST_OBJECT_LOCK (pipeline);
1012 latency = pipeline->priv->latency;
1013 GST_OBJECT_UNLOCK (pipeline);