* A #GstPipeline is a special #GstBin used as the toplevel container for
* the filter graph. The #GstPipeline will manage the selection and
* distribution of a global #GstClock as well as provide a #GstBus to the
- * application. It will also implement a default behavour for managing
- * seek events (see gst_element_seek()).
+ * application.
*
* gst_pipeline_new() is used to create a pipeline. when you are done with
* the pipeline, use gst_object_unref() to free its resources including all
* gst_pipeline_auto_clock() the default clock selection algorithm can be
* restored.
*
- * A #GstPipeline maintains a stream time for the elements. The stream
+ * A #GstPipeline maintains a running time for the elements. The running
* time is defined as the difference between the current clock time and
* the base time. When the pipeline goes to READY or a flushing seek is
- * performed on it, the stream time is reset to 0. When the pipeline is
+ * performed on it, the running time is reset to 0. When the pipeline is
* set from PLAYING to PAUSED, the current clock time is sampled and used to
* configure the base time for the elements when the pipeline is set
- * to PLAYING again. This default behaviour can be changed with the
- * gst_pipeline_set_new_stream_time() method.
+ * to PLAYING again. The effect is that the running time (as the difference
+ * between the clock time and the base time) will count how much time was spent
+ * in the PLAYING state. This default behaviour can be changed with the
+ * gst_element_set_start_time() method.
*
- * When sending a flushing seek event to a GstPipeline (see
- * gst_element_seek()), it will make sure that the pipeline is properly
- * PAUSED and resumed as well as set the new stream time to 0 when the
- * seek succeeded.
- *
- * Last reviewed on 2006-03-12 (0.10.5)
+ * Last reviewed on 2012-03-29 (0.11.3)
*/
#include "gst_private.h"
#include "gstpipeline.h"
#include "gstinfo.h"
#include "gstsystemclock.h"
+#include "gstutils.h"
GST_DEBUG_CATEGORY_STATIC (pipeline_debug);
#define GST_CAT_DEFAULT pipeline_debug
/* when we need to update stream_time or clock when going back to
* PLAYING*/
- gboolean update_stream_time;
+ GstClockTime last_start_time;
gboolean update_clock;
};
-static void gst_pipeline_base_init (gpointer g_class);
-static void gst_pipeline_class_init (gpointer g_class, gpointer class_data);
-static void gst_pipeline_init (GTypeInstance * instance, gpointer g_class);
-
static void gst_pipeline_dispose (GObject * object);
static void gst_pipeline_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_pipeline_handle_message (GstBin * bin, GstMessage * message);
-static GstBinClass *parent_class = NULL;
-
/* static guint gst_pipeline_signals[LAST_SIGNAL] = { 0 }; */
-GType
-gst_pipeline_get_type (void)
-{
- static GType pipeline_type = 0;
-
- if (G_UNLIKELY (pipeline_type == 0)) {
- static const GTypeInfo pipeline_info = {
- sizeof (GstPipelineClass),
- gst_pipeline_base_init,
- NULL,
- (GClassInitFunc) gst_pipeline_class_init,
- NULL,
- NULL,
- sizeof (GstPipeline),
- 0,
- gst_pipeline_init,
- NULL
- };
-
- pipeline_type =
- g_type_register_static (GST_TYPE_BIN, "GstPipeline", &pipeline_info, 0);
-
- GST_DEBUG_CATEGORY_INIT (pipeline_debug, "pipeline", GST_DEBUG_BOLD,
- "debugging info for the 'pipeline' container element");
- }
- return pipeline_type;
+#define _do_init \
+{ \
+ GST_DEBUG_CATEGORY_INIT (pipeline_debug, "pipeline", GST_DEBUG_BOLD, \
+ "debugging info for the 'pipeline' container element"); \
}
-static void
-gst_pipeline_base_init (gpointer g_class)
-{
- GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
-
- gst_element_class_set_details_simple (gstelement_class, "Pipeline object",
- "Generic/Bin",
- "Complete pipeline object",
- "Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>");
-}
+#define gst_pipeline_parent_class parent_class
+G_DEFINE_TYPE_WITH_CODE (GstPipeline, gst_pipeline, GST_TYPE_BIN, _do_init);
static void
-gst_pipeline_class_init (gpointer g_class, gpointer class_data)
+gst_pipeline_class_init (GstPipelineClass * klass)
{
- GObjectClass *gobject_class = G_OBJECT_CLASS (g_class);
- GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
- GstBinClass *gstbin_class = GST_BIN_CLASS (g_class);
- GstPipelineClass *klass = GST_PIPELINE_CLASS (g_class);
-
- parent_class = g_type_class_peek_parent (klass);
+ GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+ GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
+ GstBinClass *gstbin_class = GST_BIN_CLASS (klass);
g_type_class_add_private (klass, sizeof (GstPipelinePrivate));
- gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_pipeline_set_property);
- gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_pipeline_get_property);
+ gobject_class->set_property = gst_pipeline_set_property;
+ gobject_class->get_property = gst_pipeline_get_property;
/**
* GstPipeline:delay
"from READY into NULL state", DEFAULT_AUTO_FLUSH_BUS,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
- gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_pipeline_dispose);
+ gobject_class->dispose = gst_pipeline_dispose;
+
+ gst_element_class_set_metadata (gstelement_class, "Pipeline object",
+ "Generic/Bin",
+ "Complete pipeline object",
+ "Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>");
gstelement_class->change_state =
GST_DEBUG_FUNCPTR (gst_pipeline_change_state);
}
static void
-gst_pipeline_init (GTypeInstance * instance, gpointer g_class)
+gst_pipeline_init (GstPipeline * pipeline)
{
- GstPipeline *pipeline = GST_PIPELINE (instance);
GstBus *bus;
pipeline->priv = GST_PIPELINE_GET_PRIVATE (pipeline);
}
}
-/* set the stream time to 0 */
+/* set the start_time to 0, this will cause us to select a new base_time and
+ * make the running_time start from 0 again. */
static void
-reset_stream_time (GstPipeline * pipeline)
+reset_start_time (GstPipeline * pipeline, GstClockTime start_time)
{
GST_OBJECT_LOCK (pipeline);
- if (pipeline->stream_time != GST_CLOCK_TIME_NONE) {
- GST_DEBUG_OBJECT (pipeline, "reset stream_time to 0");
- pipeline->stream_time = 0;
- pipeline->priv->update_stream_time = TRUE;
+ if (GST_ELEMENT_START_TIME (pipeline) != GST_CLOCK_TIME_NONE) {
+ GST_DEBUG_OBJECT (pipeline, "reset start_time to 0");
+ GST_ELEMENT_START_TIME (pipeline) = start_time;
+ pipeline->priv->last_start_time = -1;
} else {
GST_DEBUG_OBJECT (pipeline, "application asked to not reset stream_time");
}
*
* Create a new pipeline with the given name.
*
- * Returns: newly created GstPipeline
+ * Returns: (transfer floating): newly created GstPipeline
*
* MT safe.
*/
return gst_element_factory_make ("pipeline", name);
}
+/* takes a snapshot of the running_time of the pipeline and store this as the
+ * element start_time. This is the time we will set as the running_time of the
+ * pipeline when we go to PLAYING next. */
+static void
+pipeline_update_start_time (GstElement * element)
+{
+ GstPipeline *pipeline = GST_PIPELINE_CAST (element);
+ GstClock *clock;
+
+ GST_OBJECT_LOCK (element);
+ if ((clock = element->clock)) {
+ GstClockTime now;
+
+ gst_object_ref (clock);
+ GST_OBJECT_UNLOCK (element);
+
+ /* calculate the time when we stopped */
+ now = gst_clock_get_time (clock);
+ gst_object_unref (clock);
+
+ GST_OBJECT_LOCK (element);
+ /* store the current running time */
+ if (GST_ELEMENT_START_TIME (pipeline) != GST_CLOCK_TIME_NONE) {
+ if (now != GST_CLOCK_TIME_NONE)
+ GST_ELEMENT_START_TIME (pipeline) = now - element->base_time;
+ else
+ GST_WARNING_OBJECT (element,
+ "Clock %s returned invalid time, can't calculate "
+ "running_time when going to the PAUSED state",
+ GST_OBJECT_NAME (clock));
+
+ /* we went to PAUSED, when going to PLAYING select clock and new
+ * base_time */
+ pipeline->priv->update_clock = TRUE;
+ }
+ GST_DEBUG_OBJECT (element,
+ "start_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
+ ", base_time %" GST_TIME_FORMAT,
+ GST_TIME_ARGS (GST_ELEMENT_START_TIME (pipeline)),
+ GST_TIME_ARGS (now), GST_TIME_ARGS (element->base_time));
+ }
+ GST_OBJECT_UNLOCK (element);
+}
+
/* MT safe */
static GstStateChangeReturn
gst_pipeline_change_state (GstElement * element, GstStateChange transition)
{
GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
- GstPipeline *pipeline = GST_PIPELINE (element);
+ GstPipeline *pipeline = GST_PIPELINE_CAST (element);
GstClock *clock;
switch (transition) {
break;
case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
{
- GstClockTime new_base_time;
- GstClockTime start_time, stream_time, delay;
- gboolean new_clock, update_stream_time, update_clock;
+ GstClockTime now, start_time, last_start_time, delay;
+ gboolean update_clock;
GstClock *cur_clock;
GST_DEBUG_OBJECT (element, "selecting clock and base_time");
cur_clock = element->clock;
if (cur_clock)
gst_object_ref (cur_clock);
- stream_time = pipeline->stream_time;
- update_stream_time = pipeline->priv->update_stream_time;
+ /* get the desired running_time of the first buffer aka the start_time */
+ start_time = GST_ELEMENT_START_TIME (pipeline);
+ last_start_time = pipeline->priv->last_start_time;
+ pipeline->priv->last_start_time = start_time;
+ /* see if we need to update the clock */
update_clock = pipeline->priv->update_clock;
- pipeline->priv->update_stream_time = FALSE;
pipeline->priv->update_clock = FALSE;
delay = pipeline->delay;
GST_OBJECT_UNLOCK (element);
- /* stream time changed, either with a PAUSED or a flush, we need to check
+ /* running time changed, either with a PAUSED or a flush, we need to check
* if there is a new clock & update the base time */
- if (update_stream_time) {
- GST_DEBUG_OBJECT (pipeline, "Need to update stream_time");
+ /* only do this for top-level, however */
+ if (GST_OBJECT_PARENT (element) == NULL &&
+ (update_clock || last_start_time != start_time)) {
+ GST_DEBUG_OBJECT (pipeline, "Need to update start_time");
/* when going to PLAYING, select a clock when needed. If we just got
* flushed, we don't reselect the clock. */
clock = gst_object_ref (cur_clock);
}
- new_clock = (clock != cur_clock);
-
if (clock) {
- start_time = gst_clock_get_time (clock);
+ now = gst_clock_get_time (clock);
} else {
- GST_DEBUG ("no clock, using base time of NONE");
- start_time = GST_CLOCK_TIME_NONE;
- new_base_time = GST_CLOCK_TIME_NONE;
+ GST_DEBUG_OBJECT (pipeline, "no clock, using base time of NONE");
+ now = GST_CLOCK_TIME_NONE;
}
- if (new_clock) {
+ if (clock != cur_clock) {
/* now distribute the clock (which could be NULL). If some
* element refuses the clock, this will return FALSE and
* we effectively fail the state change. */
if (clock)
gst_object_unref (clock);
- if (stream_time != GST_CLOCK_TIME_NONE
- && start_time != GST_CLOCK_TIME_NONE) {
- new_base_time = start_time - stream_time + delay;
+ if (start_time != GST_CLOCK_TIME_NONE && now != GST_CLOCK_TIME_NONE) {
+ GstClockTime new_base_time = now - start_time + delay;
GST_DEBUG_OBJECT (element,
- "stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
+ "start_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
", base_time %" GST_TIME_FORMAT,
- GST_TIME_ARGS (stream_time), GST_TIME_ARGS (start_time),
+ GST_TIME_ARGS (start_time), GST_TIME_ARGS (now),
GST_TIME_ARGS (new_base_time));
- } else
- new_base_time = GST_CLOCK_TIME_NONE;
- if (new_base_time != GST_CLOCK_TIME_NONE)
gst_element_set_base_time (element, new_base_time);
- else
+ } else {
GST_DEBUG_OBJECT (pipeline,
- "NOT adjusting base_time because stream_time is NONE");
+ "NOT adjusting base_time because start_time is NONE");
+ }
} else {
GST_DEBUG_OBJECT (pipeline,
"NOT adjusting base_time because we selected one before");
break;
}
case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
+ {
+ /* we take a start_time snapshot before calling the children state changes
+ * so that they know about when the pipeline PAUSED. */
+ pipeline_update_start_time (element);
break;
+ }
case GST_STATE_CHANGE_PAUSED_TO_READY:
case GST_STATE_CHANGE_READY_TO_NULL:
break;
break;
case GST_STATE_CHANGE_READY_TO_PAUSED:
{
- reset_stream_time (pipeline);
+ /* READY to PAUSED starts running_time from 0 */
+ reset_start_time (pipeline, 0);
break;
}
case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
break;
case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
- GST_OBJECT_LOCK (element);
- if ((clock = element->clock)) {
- GstClockTime now;
-
- gst_object_ref (clock);
- GST_OBJECT_UNLOCK (element);
-
- /* calculate the time when we stopped */
- now = gst_clock_get_time (clock);
- gst_object_unref (clock);
-
- GST_OBJECT_LOCK (element);
- /* store the current stream time */
- if (pipeline->stream_time != GST_CLOCK_TIME_NONE) {
- pipeline->stream_time = now - element->base_time;
- /* we went to PAUSED, when going to PLAYING select clock and new
- * base_time */
- pipeline->priv->update_stream_time = TRUE;
- pipeline->priv->update_clock = TRUE;
- }
-
- GST_DEBUG_OBJECT (element,
- "stream_time=%" GST_TIME_FORMAT ", now=%" GST_TIME_FORMAT
- ", base_time %" GST_TIME_FORMAT,
- GST_TIME_ARGS (pipeline->stream_time), GST_TIME_ARGS (now),
- GST_TIME_ARGS (element->base_time));
- }
- GST_OBJECT_UNLOCK (element);
+ {
+ /* Take a new snapshot of the start_time after calling the state change on
+ * all children. This will be the running_time of the pipeline when we go
+ * back to PLAYING */
+ pipeline_update_start_time (element);
break;
+ }
case GST_STATE_CHANGE_PAUSED_TO_READY:
break;
case GST_STATE_CHANGE_READY_TO_NULL:
+ {
+ GstBus *bus;
+ gboolean auto_flush;
+
+ /* grab some stuff before we release the lock to flush out the bus */
GST_OBJECT_LOCK (element);
- if (element->bus) {
- if (pipeline->priv->auto_flush_bus) {
- gst_bus_set_flushing (element->bus, TRUE);
+ if ((bus = element->bus))
+ gst_object_ref (bus);
+ auto_flush = pipeline->priv->auto_flush_bus;
+ GST_OBJECT_UNLOCK (element);
+
+ if (bus) {
+ if (auto_flush) {
+ gst_bus_set_flushing (bus, TRUE);
} else {
GST_INFO_OBJECT (element, "not flushing bus, auto-flushing disabled");
}
+ gst_object_unref (bus);
}
- GST_OBJECT_UNLOCK (element);
break;
+ }
}
return result;
}
}
+/* intercept the bus messages from our children. We watch for the ASYNC_START
+ * message with is posted by the elements (sinks) that require a reset of the
+ * running_time after a flush. ASYNC_START also brings the pipeline back into
+ * the PAUSED, pending PAUSED state. When the ASYNC_DONE message is received the
+ * pipeline will redistribute the new base_time and will bring the elements back
+ * to the desired state of the pipeline. */
static void
gst_pipeline_handle_message (GstBin * bin, GstMessage * message)
{
GstPipeline *pipeline = GST_PIPELINE_CAST (bin);
switch (GST_MESSAGE_TYPE (message)) {
- case GST_MESSAGE_ASYNC_START:
+ case GST_MESSAGE_RESET_TIME:
{
- gboolean new_base_time;
+ GstClockTime running_time;
- gst_message_parse_async_start (message, &new_base_time);
+ gst_message_parse_reset_time (message, &running_time);
- /* reset our stream time if we need to distribute a new base_time to the
+ /* reset our running time if we need to distribute a new base_time to the
* children. */
- if (new_base_time)
- reset_stream_time (pipeline);
-
+ reset_start_time (pipeline, running_time);
break;
}
+ case GST_MESSAGE_CLOCK_LOST:
+ {
+ GstClock *clock;
+
+ gst_message_parse_clock_lost (message, &clock);
+
+ GST_OBJECT_LOCK (bin);
+ if (clock == GST_ELEMENT_CAST (bin)->clock) {
+ GST_DEBUG_OBJECT (bin, "Used clock '%s' got lost",
+ GST_OBJECT_NAME (clock));
+ pipeline->priv->update_clock = TRUE;
+ }
+ GST_OBJECT_UNLOCK (bin);
+ }
default:
break;
}
* gst_pipeline_get_bus:
* @pipeline: a #GstPipeline
*
- * Gets the #GstBus of @pipeline. The bus allows applications to receive #GstMessages.
+ * Gets the #GstBus of @pipeline. The bus allows applications to receive
+ * #GstMessage packets.
*
- * Returns: a #GstBus, unref after usage.
+ * Returns: (transfer full): a #GstBus, unref after usage.
*
* MT safe.
*/
GstBus *
gst_pipeline_get_bus (GstPipeline * pipeline)
{
- return gst_element_get_bus (GST_ELEMENT (pipeline));
-}
-
-/**
- * gst_pipeline_set_new_stream_time:
- * @pipeline: a #GstPipeline
- * @time: the new stream time to set
- *
- * Set the new stream time of @pipeline to @time. The stream time is used to
- * set the base time on the elements (see gst_element_set_base_time())
- * in the PAUSED->PLAYING state transition.
- *
- * Setting @time to #GST_CLOCK_TIME_NONE will disable the pipeline's management
- * of element base time. The application will then be responsible for
- * performing base time distribution. This is sometimes useful if you want to
- * synchronize capture from multiple pipelines, and you can also ensure that the
- * pipelines have the same clock.
- *
- * MT safe.
- */
-void
-gst_pipeline_set_new_stream_time (GstPipeline * pipeline, GstClockTime time)
-{
- g_return_if_fail (GST_IS_PIPELINE (pipeline));
-
- GST_OBJECT_LOCK (pipeline);
- pipeline->stream_time = time;
- pipeline->priv->update_stream_time = TRUE;
- GST_OBJECT_UNLOCK (pipeline);
-
- GST_DEBUG_OBJECT (pipeline, "set new stream_time to %" GST_TIME_FORMAT,
- GST_TIME_ARGS (time));
-
- if (time == GST_CLOCK_TIME_NONE)
- GST_DEBUG_OBJECT (pipeline, "told not to adjust base_time");
-}
-
-/**
- * gst_pipeline_get_last_stream_time:
- * @pipeline: a #GstPipeline
- *
- * Gets the last stream time of @pipeline. If the pipeline is PLAYING,
- * the returned time is the stream time used to configure the element's
- * base time in the PAUSED->PLAYING state. If the pipeline is PAUSED, the
- * returned time is the stream time when the pipeline was paused.
- *
- * This function returns #GST_CLOCK_TIME_NONE if the pipeline was
- * configured to not handle the management of the element's base time
- * (see gst_pipeline_set_new_stream_time()).
- *
- * Returns: a #GstClockTime.
- *
- * MT safe.
- */
-GstClockTime
-gst_pipeline_get_last_stream_time (GstPipeline * pipeline)
-{
- GstClockTime result;
-
- g_return_val_if_fail (GST_IS_PIPELINE (pipeline), GST_CLOCK_TIME_NONE);
-
- GST_OBJECT_LOCK (pipeline);
- result = pipeline->stream_time;
- GST_OBJECT_UNLOCK (pipeline);
-
- return result;
+ return gst_element_get_bus (GST_ELEMENT_CAST (pipeline));
}
static GstClock *
GST_OBJECT_UNLOCK (pipeline);
/* let the parent bin select a clock */
clock =
- GST_ELEMENT_CLASS (parent_class)->
- provide_clock (GST_ELEMENT (pipeline));
+ GST_ELEMENT_CLASS (parent_class)->provide_clock (GST_ELEMENT
+ (pipeline));
/* no clock, use a system clock */
if (!clock) {
clock = gst_system_clock_obtain ();
*
* Gets the current clock used by @pipeline.
*
- * Returns: a #GstClock, unref after usage.
+ * Returns: (transfer full): a #GstClock, unref after usage.
*/
GstClock *
gst_pipeline_get_clock (GstPipeline * pipeline)
{
g_return_val_if_fail (GST_IS_PIPELINE (pipeline), NULL);
- return gst_pipeline_provide_clock_func (GST_ELEMENT (pipeline));
+ return gst_pipeline_provide_clock_func (GST_ELEMENT_CAST (pipeline));
}
/**
* gst_pipeline_use_clock:
* @pipeline: a #GstPipeline
- * @clock: the clock to use
+ * @clock: (transfer none): the clock to use
*
* Force @pipeline to use the given @clock. The pipeline will
* always use the given clock even if new clock providers are added
/**
* gst_pipeline_set_clock:
* @pipeline: a #GstPipeline
- * @clock: the clock to set
+ * @clock: (transfer none): the clock to set
*
* Set the clock for @pipeline. The clock will be distributed
* to all the elements managed by the pipeline.
g_return_val_if_fail (pipeline != NULL, FALSE);
g_return_val_if_fail (GST_IS_PIPELINE (pipeline), FALSE);
- return GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT (pipeline),
+ return
+ GST_ELEMENT_CLASS (parent_class)->set_clock (GST_ELEMENT_CAST (pipeline),
clock);
}
projects / platform / upstream / gstreamer.git / blobdiff