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 clocking and bus management functionality.
27 * In almost all cases, you'll want to use a GstPipeline when creating a filter
28 * graph. The GstPipeline will manage the selection and distribution of a global
29 * clock as well as provide a GstBus to the application.
31 * The pipeline will also use the selected clock to calculate the stream time of
34 * When sending a seek event to a GstPipeline, it will make sure that the
35 * pipeline is properly PAUSED and resumed as well as update the new stream time
38 * gst_pipeline_new() is used to create a pipeline. when you are done with
39 * the pipeline, use gst_object_unref() to free its resources including all
40 * added #GstElement objects (if not otherwiese referenced).
43 #include "gst_private.h"
45 #include "gstpipeline.h"
47 #include "gstsystemclock.h"
49 static GstElementDetails gst_pipeline_details =
50 GST_ELEMENT_DETAILS ("Pipeline object",
52 "Complete pipeline object",
53 "Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>");
55 /* Pipeline signals and args */
62 #define DEFAULT_DELAY 0
72 static void gst_pipeline_base_init (gpointer g_class);
73 static void gst_pipeline_class_init (gpointer g_class, gpointer class_data);
74 static void gst_pipeline_init (GTypeInstance * instance, gpointer g_class);
76 static void gst_pipeline_dispose (GObject * object);
77 static void gst_pipeline_set_property (GObject * object, guint prop_id,
78 const GValue * value, GParamSpec * pspec);
79 static void gst_pipeline_get_property (GObject * object, guint prop_id,
80 GValue * value, GParamSpec * pspec);
82 static gboolean gst_pipeline_send_event (GstElement * element,
85 static GstClock *gst_pipeline_provide_clock_func (GstElement * element);
86 static GstStateChangeReturn gst_pipeline_change_state (GstElement * element,
87 GstStateChange transition);
89 static GstBinClass *parent_class = NULL;
91 /* static guint gst_pipeline_signals[LAST_SIGNAL] = { 0 }; */
94 gst_pipeline_get_type (void)
96 static GType pipeline_type = 0;
99 static const GTypeInfo pipeline_info = {
100 sizeof (GstPipelineClass),
101 gst_pipeline_base_init,
103 (GClassInitFunc) gst_pipeline_class_init,
106 sizeof (GstPipeline),
113 g_type_register_static (GST_TYPE_BIN, "GstPipeline", &pipeline_info, 0);
115 return pipeline_type;
119 gst_pipeline_base_init (gpointer g_class)
121 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
123 gst_element_class_set_details (gstelement_class, &gst_pipeline_details);
127 gst_pipeline_class_init (gpointer g_class, gpointer class_data)
129 GObjectClass *gobject_class = G_OBJECT_CLASS (g_class);
130 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
131 GstPipelineClass *klass = GST_PIPELINE_CLASS (g_class);
133 parent_class = g_type_class_peek_parent (klass);
135 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_pipeline_set_property);
136 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_pipeline_get_property);
138 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DELAY,
139 g_param_spec_uint64 ("delay", "Delay",
140 "Expected delay needed for elements "
141 "to spin up to PLAYING in nanoseconds", 0, G_MAXUINT64, DEFAULT_DELAY,
144 gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_pipeline_dispose);
146 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_pipeline_send_event);
147 gstelement_class->change_state =
148 GST_DEBUG_FUNCPTR (gst_pipeline_change_state);
149 gstelement_class->provide_clock =
150 GST_DEBUG_FUNCPTR (gst_pipeline_provide_clock_func);
154 gst_pipeline_init (GTypeInstance * instance, gpointer g_class)
156 GstPipeline *pipeline = GST_PIPELINE (instance);
159 pipeline->delay = DEFAULT_DELAY;
161 bus = g_object_new (gst_bus_get_type (), NULL);
162 gst_element_set_bus (GST_ELEMENT_CAST (pipeline), bus);
163 gst_object_unref (bus);
167 gst_pipeline_dispose (GObject * object)
169 GstPipeline *pipeline = GST_PIPELINE (object);
171 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pipeline, "dispose");
173 gst_object_replace ((GstObject **) & pipeline->fixed_clock, NULL);
175 G_OBJECT_CLASS (parent_class)->dispose (object);
179 gst_pipeline_set_property (GObject * object, guint prop_id,
180 const GValue * value, GParamSpec * pspec)
182 GstPipeline *pipeline = GST_PIPELINE (object);
187 pipeline->delay = g_value_get_uint64 (value);
190 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
193 GST_UNLOCK (pipeline);
197 gst_pipeline_get_property (GObject * object, guint prop_id,
198 GValue * value, GParamSpec * pspec)
200 GstPipeline *pipeline = GST_PIPELINE (object);
205 g_value_set_uint64 (value, pipeline->delay);
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;
230 /* need to call _get_state() since a bin state is only updated
232 gst_element_get_state (element, &state, NULL, 0);
233 was_playing = state == GST_STATE_PLAYING;
236 gst_element_set_state (element, GST_STATE_PAUSED);
240 res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
243 /* need to reset the stream time to 0 after a flushing seek */
244 gst_pipeline_set_new_stream_time (GST_PIPELINE (element), 0);
246 /* and continue playing */
247 gst_element_set_state (element, GST_STATE_PLAYING);
252 /* sending a seek event on the pipeline pauses the pipeline if it
256 gst_pipeline_send_event (GstElement * element, GstEvent * event)
259 GstEventType event_type = GST_EVENT_TYPE (event);
261 switch (event_type) {
263 res = do_pipeline_seek (element, event);
266 res = GST_ELEMENT_CLASS (parent_class)->send_event (element, event);
275 * @name: name of new pipeline
277 * Create a new pipeline with the given name.
279 * Returns: newly created GstPipeline
284 gst_pipeline_new (const gchar * name)
286 return gst_element_factory_make ("pipeline", name);
290 static GstStateChangeReturn
291 gst_pipeline_change_state (GstElement * element, GstStateChange transition)
293 GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
294 GstPipeline *pipeline = GST_PIPELINE (element);
297 switch (transition) {
298 case GST_STATE_CHANGE_NULL_TO_READY:
301 gst_bus_set_flushing (element->bus, FALSE);
302 GST_UNLOCK (element);
304 case GST_STATE_CHANGE_READY_TO_PAUSED:
306 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
307 /* when going to playing, select a clock */
308 if ((clock = gst_element_provide_clock (element))) {
309 GstClockTime start_time;
313 start_time = gst_clock_get_time (clock);
316 new_clock = element->clock != clock;
317 element->base_time = start_time -
318 pipeline->stream_time + pipeline->delay;
319 GST_DEBUG ("stream_time=%" GST_TIME_FORMAT ", start_time=%"
320 GST_TIME_FORMAT ", base time %" GST_TIME_FORMAT,
321 GST_TIME_ARGS (pipeline->stream_time),
322 GST_TIME_ARGS (start_time), GST_TIME_ARGS (element->base_time));
323 GST_UNLOCK (element);
326 /* now distribute the clock */
327 gst_element_set_clock (element, clock);
329 /* if we selected a new clock, let the app know about it */
330 gst_element_post_message (element,
331 gst_message_new_new_clock (GST_OBJECT_CAST (element), clock));
334 gst_object_unref (clock);
336 GST_DEBUG ("no clock, using base time of 0");
337 gst_element_set_base_time (element, 0);
340 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
341 case GST_STATE_CHANGE_PAUSED_TO_READY:
342 case GST_STATE_CHANGE_READY_TO_NULL:
346 result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
348 switch (transition) {
349 case GST_STATE_CHANGE_NULL_TO_READY:
351 case GST_STATE_CHANGE_READY_TO_PAUSED:
352 gst_pipeline_set_new_stream_time (pipeline, 0);
354 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
356 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
358 if ((clock = element->clock)) {
361 gst_object_ref (clock);
362 GST_UNLOCK (element);
364 /* calculate the time when we stopped */
365 now = gst_clock_get_time (clock);
366 gst_object_unref (clock);
369 /* store the current stream time */
370 pipeline->stream_time = now - element->base_time;
371 GST_DEBUG ("stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
372 ", base time %" GST_TIME_FORMAT,
373 GST_TIME_ARGS (pipeline->stream_time),
374 GST_TIME_ARGS (now), GST_TIME_ARGS (element->base_time));
376 GST_UNLOCK (element);
378 case GST_STATE_CHANGE_PAUSED_TO_READY:
380 case GST_STATE_CHANGE_READY_TO_NULL:
383 gst_bus_set_flushing (element->bus, TRUE);
385 GST_UNLOCK (element);
392 * gst_pipeline_get_bus:
393 * @pipeline: the pipeline
395 * Gets the #GstBus of this pipeline.
402 gst_pipeline_get_bus (GstPipeline * pipeline)
404 return gst_element_get_bus (GST_ELEMENT (pipeline));
408 * gst_pipeline_set_new_stream_time:
409 * @pipeline: the pipeline
410 * @time: the new stream time to set
412 * Set the new stream time of the pipeline. The stream time is used to
413 * set the base time on the elements (see @gst_element_set_base_time())
414 * in the PAUSED->PLAYING state transition.
419 gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time)
421 g_return_if_fail (GST_IS_PIPELINE (pipeline));
424 pipeline->stream_time = time;
425 GST_DEBUG ("%s: set new stream_time to %" GST_TIME_FORMAT,
426 GST_ELEMENT_NAME (pipeline), GST_TIME_ARGS (time));
427 GST_UNLOCK (pipeline);
431 * gst_pipeline_get_last_stream_time:
432 * @pipeline: the pipeline
434 * Gets the last stream time of the pipeline. If the pipeline is PLAYING,
435 * the returned time is the stream time used to configure the elements
436 * in the PAUSED->PLAYING state. If the pipeline is PAUSED, the returned
437 * time is the stream time when the pipeline was paused.
439 * Returns: a GstClockTime
444 gst_pipeline_get_last_stream_time (GstPipeline * pipeline)
448 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
451 result = pipeline->stream_time;
452 GST_UNLOCK (pipeline);
458 gst_pipeline_provide_clock_func (GstElement * element)
460 GstClock *clock = NULL;
461 GstPipeline *pipeline = GST_PIPELINE (element);
463 /* if we have a fixed clock, use that one */
465 if (GST_OBJECT_FLAG_IS_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK)) {
466 clock = pipeline->fixed_clock;
467 gst_object_ref (clock);
468 GST_UNLOCK (pipeline);
470 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)",
471 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
473 GST_UNLOCK (pipeline);
475 GST_ELEMENT_CLASS (parent_class)->
476 provide_clock (GST_ELEMENT (pipeline));
477 /* no clock, use a system clock */
479 clock = gst_system_clock_obtain ();
481 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained system clock: %p (%s)",
482 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
484 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline obtained clock: %p (%s)",
485 clock, clock ? GST_STR_NULL (GST_OBJECT_NAME (clock)) : "-");
492 * gst_pipeline_get_clock:
493 * @pipeline: the pipeline
495 * Gets the current clock used by the pipeline.
497 * Returns: a GstClock
500 gst_pipeline_get_clock (GstPipeline * pipeline)
502 g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
504 return gst_pipeline_provide_clock_func (GST_ELEMENT (pipeline));
509 * gst_pipeline_use_clock:
510 * @pipeline: the pipeline
511 * @clock: the clock to use
513 * Force the pipeline to use the given clock. The pipeline will
514 * always use the given clock even if new clock providers are added
520 gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock)
522 g_return_if_fail (GST_IS_PIPELINE (pipeline));
525 GST_OBJECT_FLAG_SET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
527 gst_object_replace ((GstObject **) & pipeline->fixed_clock,
528 (GstObject *) clock);
529 GST_UNLOCK (pipeline);
531 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using fixed clock %p (%s)", clock,
532 (clock ? GST_OBJECT_NAME (clock) : "nil"));
536 * gst_pipeline_set_clock:
537 * @pipeline: the pipeline
538 * @clock: the clock to set
540 * Set the clock for the pipeline. The clock will be distributed
541 * to all the elements managed by the pipeline.
546 gst_pipeline_set_clock (GstPipeline * pipeline, GstClock * clock)
548 g_return_if_fail (pipeline != NULL);
549 g_return_if_fail (GST_IS_PIPELINE (pipeline));
551 GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT (pipeline), clock);
555 * gst_pipeline_auto_clock:
556 * @pipeline: the pipeline
558 * Let the pipeline select a clock automatically.
563 gst_pipeline_auto_clock (GstPipeline * pipeline)
565 g_return_if_fail (pipeline != NULL);
566 g_return_if_fail (GST_IS_PIPELINE (pipeline));
569 GST_OBJECT_FLAG_UNSET (pipeline, GST_PIPELINE_FLAG_FIXED_CLOCK);
571 gst_object_replace ((GstObject **) & pipeline->fixed_clock, NULL);
572 GST_UNLOCK (pipeline);
574 GST_CAT_DEBUG (GST_CAT_CLOCK, "pipeline using automatic clock");