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., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * @short_description: Top-level bin with scheduling and pipeline management functionality.
27 * In almost all cases, you'll want to use a GstPipeline when creating a filter
28 * graph. The GstPipeline will manage all the scheduling issues, including
29 * threading, as well as provide simple interfaces to common functions, like
32 * gst_pipeline_new() is used to create a pipeline. when you are done with
33 * the pipeline, use gst_object_unref() to free its resources including all
34 * added #GstElement objects (if not otherwiese referenced).
37 #include "gst_private.h"
39 #include "gstpipeline.h"
41 #include "gstsystemclock.h"
43 static GstElementDetails gst_pipeline_details =
44 GST_ELEMENT_DETAILS ("Pipeline object",
46 "Complete pipeline object",
47 "Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>");
49 /* Pipeline signals and args */
56 #define DEFAULT_DELAY 0
57 #define DEFAULT_PLAY_TIMEOUT (2*GST_SECOND)
67 static void gst_pipeline_base_init (gpointer g_class);
68 static void gst_pipeline_class_init (gpointer g_class, gpointer class_data);
69 static void gst_pipeline_init (GTypeInstance * instance, gpointer g_class);
71 static void gst_pipeline_dispose (GObject * object);
72 static void gst_pipeline_set_property (GObject * object, guint prop_id,
73 const GValue * value, GParamSpec * pspec);
74 static void gst_pipeline_get_property (GObject * object, guint prop_id,
75 GValue * value, GParamSpec * pspec);
77 static gboolean gst_pipeline_send_event (GstElement * element,
80 static GstClock *gst_pipeline_get_clock_func (GstElement * element);
81 static GstStateChangeReturn gst_pipeline_change_state (GstElement * element,
82 GstStateChange transition);
84 static GstBinClass *parent_class = NULL;
86 /* static guint gst_pipeline_signals[LAST_SIGNAL] = { 0 }; */
89 gst_pipeline_get_type (void)
91 static GType pipeline_type = 0;
94 static const GTypeInfo pipeline_info = {
95 sizeof (GstPipelineClass),
96 gst_pipeline_base_init,
98 (GClassInitFunc) gst_pipeline_class_init,
101 sizeof (GstPipeline),
108 g_type_register_static (GST_TYPE_BIN, "GstPipeline", &pipeline_info, 0);
110 return pipeline_type;
114 gst_pipeline_base_init (gpointer g_class)
116 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
118 gst_element_class_set_details (gstelement_class, &gst_pipeline_details);
122 gst_pipeline_class_init (gpointer g_class, gpointer class_data)
124 GObjectClass *gobject_class = G_OBJECT_CLASS (g_class);
125 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
126 GstPipelineClass *klass = GST_PIPELINE_CLASS (g_class);
128 parent_class = g_type_class_peek_parent (klass);
130 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_pipeline_set_property);
131 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_pipeline_get_property);
133 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DELAY,
134 g_param_spec_uint64 ("delay", "Delay",
135 "Expected delay needed for elements "
136 "to spin up to PLAYING in nanoseconds", 0, G_MAXUINT64, DEFAULT_DELAY,
138 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_PLAY_TIMEOUT,
139 g_param_spec_uint64 ("play-timeout", "Play Timeout",
140 "Max timeout for going to PLAYING in nanoseconds", 0, G_MAXUINT64,
141 DEFAULT_PLAY_TIMEOUT, G_PARAM_READWRITE));
143 gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_pipeline_dispose);
145 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_pipeline_send_event);
146 gstelement_class->change_state =
147 GST_DEBUG_FUNCPTR (gst_pipeline_change_state);
148 gstelement_class->get_clock = GST_DEBUG_FUNCPTR (gst_pipeline_get_clock_func);
152 gst_pipeline_init (GTypeInstance * instance, gpointer g_class)
154 GstPipeline *pipeline = GST_PIPELINE (instance);
156 pipeline->delay = DEFAULT_DELAY;
157 pipeline->play_timeout = DEFAULT_PLAY_TIMEOUT;
161 gst_pipeline_dispose (GObject * object)
163 GstPipeline *pipeline = GST_PIPELINE (object);
165 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pipeline, "dispose");
167 gst_object_replace ((GstObject **) & pipeline->fixed_clock, NULL);
169 G_OBJECT_CLASS (parent_class)->dispose (object);
173 gst_pipeline_set_property (GObject * object, guint prop_id,
174 const GValue * value, GParamSpec * pspec)
176 GstPipeline *pipeline = GST_PIPELINE (object);
181 pipeline->delay = g_value_get_uint64 (value);
183 case ARG_PLAY_TIMEOUT:
184 pipeline->play_timeout = g_value_get_uint64 (value);
187 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
190 GST_UNLOCK (pipeline);
194 gst_pipeline_get_property (GObject * object, guint prop_id,
195 GValue * value, GParamSpec * pspec)
197 GstPipeline *pipeline = GST_PIPELINE (object);
202 g_value_set_uint64 (value, pipeline->delay);
204 case ARG_PLAY_TIMEOUT:
205 g_value_set_uint64 (value, pipeline->play_timeout);
208 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
211 GST_UNLOCK (pipeline);
215 do_pipeline_seek (GstElement * element, GstEvent * event)
220 gboolean was_playing = FALSE;
223 gst_event_parse_seek (event, &rate, NULL, &flags, NULL, NULL, NULL, NULL);
225 flush = flags & GST_SEEK_FLAG_FLUSH;
231 GST_TIME_TO_TIMEVAL (0, timeout);
232 /* need to call _get_state() since a bin state is only updated
234 gst_element_get_state (element, &state, NULL, &timeout);
235 was_playing = state == GST_STATE_PLAYING;
238 gst_element_set_state (element, GST_STATE_PAUSED);
241 res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
244 /* need to reset the stream time to 0 after a flushing seek */
245 gst_pipeline_set_new_stream_time (GST_PIPELINE (element), 0);
247 /* and continue playing */
248 gst_element_set_state (element, GST_STATE_PLAYING);
254 /* sending a seek event on the pipeline pauses the pipeline if it
258 gst_pipeline_send_event (GstElement * element, GstEvent * event)
261 GstEventType event_type = GST_EVENT_TYPE (event);
263 switch (event_type) {
265 res = do_pipeline_seek (element, event);
268 res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
277 * @name: name of new pipeline
279 * Create a new pipeline with the given name.
281 * Returns: newly created GstPipeline
286 gst_pipeline_new (const gchar * name)
288 return gst_element_factory_make ("pipeline", name);
292 static GstStateChangeReturn
293 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
295 GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
296 GstPipeline *pipeline = GST_PIPELINE (element);
297 GstClockTime play_timeout;
300 switch (transition) {
301 case GST_STATE_CHANGE_NULL_TO_READY:
304 gst_bus_set_flushing (element->bus, FALSE);
305 GST_UNLOCK (element);
307 case GST_STATE_CHANGE_READY_TO_PAUSED:
309 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
310 /* when going to playing, select a clock */
311 if ((clock = gst_element_get_clock (element))) {
312 GstClockTime start_time;
314 /* distribute the clock */
315 gst_element_set_clock (element, clock);
318 start_time = gst_clock_get_time (clock);
319 gst_object_unref (clock);
322 element->base_time = start_time -
323 pipeline->stream_time + pipeline->delay;
324 GST_DEBUG ("stream_time=%" GST_TIME_FORMAT ", start_time=%"
325 GST_TIME_FORMAT ", base time %" GST_TIME_FORMAT,
326 GST_TIME_ARGS (pipeline->stream_time),
327 GST_TIME_ARGS (start_time), GST_TIME_ARGS (element->base_time));
328 GST_UNLOCK (element);
330 GST_UNLOCK (element);
331 GST_DEBUG ("no clock, using base time of 0");
332 gst_element_set_base_time (element, 0);
335 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
336 case GST_STATE_CHANGE_PAUSED_TO_READY:
337 case GST_STATE_CHANGE_READY_TO_NULL:
341 result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
343 switch (transition) {
344 case GST_STATE_CHANGE_NULL_TO_READY:
346 case GST_STATE_CHANGE_READY_TO_PAUSED:
347 gst_pipeline_set_new_stream_time (pipeline, 0);
349 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
351 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
353 if ((clock = element->clock)) {
356 gst_object_ref (clock);
357 GST_UNLOCK (element);
359 /* calculate the time when we stopped */
360 now = gst_clock_get_time (clock);
361 gst_object_unref (clock);
364 /* store the current stream time */
365 pipeline->stream_time = now - element->base_time;
366 GST_DEBUG ("stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
367 ", base time %" GST_TIME_FORMAT,
368 GST_TIME_ARGS (pipeline->stream_time),
369 GST_TIME_ARGS (now), GST_TIME_ARGS (element->base_time));
371 GST_UNLOCK (element);
373 case GST_STATE_CHANGE_PAUSED_TO_READY:
375 case GST_STATE_CHANGE_READY_TO_NULL:
378 gst_bus_set_flushing (element->bus, TRUE);
380 GST_UNLOCK (element);
384 if (result == GST_STATE_CHANGE_ASYNC) {
386 play_timeout = pipeline->play_timeout;
387 GST_UNLOCK (pipeline);
392 /* we wait for async state changes ourselves when we are in an
393 * intermediate state. */
394 if (play_timeout > 0) {
395 GTimeVal *timeval, timeout;
397 GST_STATE_UNLOCK (pipeline);
399 if (play_timeout == G_MAXUINT64) {
402 GST_TIME_TO_TIMEVAL (play_timeout, timeout);
406 result = gst_element_get_state (element, NULL, NULL, timeval);
407 if (result == GST_STATE_CHANGE_ASYNC) {
408 GST_WARNING_OBJECT (pipeline,
409 "timeout in PREROLL, forcing next state change");
410 g_warning ("timeout in PREROLL, forcing next state change");
411 result = GST_STATE_CHANGE_SUCCESS;
414 GST_STATE_LOCK (pipeline);
421 * gst_pipeline_get_bus:
422 * @pipeline: the pipeline
424 * Gets the #GstBus of this pipeline.
431 gst_pipeline_get_bus (GstPipeline * pipeline)
433 return gst_element_get_bus (GST_ELEMENT (pipeline));
437 * gst_pipeline_set_new_stream_time:
438 * @pipeline: the pipeline
439 * @time: the new stream time to set
441 * Set the new stream time of the pipeline. The stream time is used to
442 * set the base time on the elements (see @gst_element_set_base_time())
443 * in the PAUSED->PLAYING state transition.
448 gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time)
450 g_return_if_fail (GST_IS_PIPELINE (pipeline));
453 pipeline->stream_time = time;
454 GST_DEBUG ("%s: set new stream_time to %" GST_TIME_FORMAT,
455 GST_ELEMENT_NAME (pipeline), GST_TIME_ARGS (time));
456 GST_UNLOCK (pipeline);
460 * gst_pipeline_get_last_stream_time:
461 * @pipeline: the pipeline
463 * Gets the last stream time of the pipeline. If the pipeline is PLAYING,
464 * the returned time is the stream time used to configure the elements
465 * in the PAUSED->PLAYING state. If the pipeline is PAUSED, the returned
466 * time is the stream time when the pipeline was paused.
468 * Returns: a GstClockTime
473 gst_pipeline_get_last_stream_time (GstPipeline * pipeline)
477 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
480 result = pipeline->stream_time;
481 GST_UNLOCK (pipeline);
487 gst_pipeline_get_clock_func (GstElement * element)
489 GstClock *clock = NULL;
490 GstPipeline *pipeline = GST_PIPELINE (element);
492 /* if we have a fixed clock, use that one */
494 if (GST_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
495 clock = pipeline->fixed_clock;
496 gst_object_ref (clock);
497 GST_UNLOCK (pipeline);
499 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)",
500 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
502 GST_UNLOCK (pipeline);
504 GST_ELEMENT_CLASS (parent_class)->get_clock (GST_ELEMENT (pipeline));
505 /* no clock, use a system clock */
507 clock = gst_system_clock_obtain ();
509 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained system clock: %p (%s)",
510 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
512 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained clock: %p (%s)",
513 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
520 * gst_pipeline_get_clock:
521 * @pipeline: the pipeline
523 * Gets the current clock used by the pipeline.
525 * Returns: a GstClock
528 gst_pipeline_get_clock (GstPipeline * pipeline)
530 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
532 return gst_pipeline_get_clock_func (GST_ELEMENT (pipeline));
537 * gst_pipeline_use_clock:
538 * @pipeline: the pipeline
539 * @clock: the clock to use
541 * Force the pipeline to use the given clock. The pipeline will
542 * always use the given clock even if new clock providers are added
548 gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock)
550 g_return_if_fail (GST_IS_PIPELINE (pipeline));
553 GST_FLAG_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
555 gst_object_replace ((GstObject **) & pipeline->fixed_clock,
556 (GstObject *) clock);
557 GST_UNLOCK (pipeline);
559 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)", clock,
560 (clock ? GST_OBJECT_NAME (clock) : "nil"));
564 * gst_pipeline_set_clock:
565 * @pipeline: the pipeline
566 * @clock: the clock to set
568 * Set the clock for the pipeline. The clock will be distributed
569 * to all the elements managed by the pipeline.
574 gst_pipeline_set_clock (GstPipeline * pipeline, GstClock * clock)
576 g_return_if_fail (pipeline != NULL);
577 g_return_if_fail (GST_IS_PIPELINE (pipeline));
579 GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT (pipeline), clock);
583 * gst_pipeline_auto_clock:
584 * @pipeline: the pipeline
586 * Let the pipeline select a clock automatically.
591 gst_pipeline_auto_clock (GstPipeline * pipeline)
593 g_return_if_fail (pipeline != NULL);
594 g_return_if_fail (GST_IS_PIPELINE (pipeline));
597 GST_FLAG_UNSET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
599 gst_object_replace ((GstObject **) & pipeline->fixed_clock, NULL);
600 GST_UNLOCK (pipeline);
602 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using automatic clock");