/**
* SECTION:element-tee
+ * @title: tee
* @see_also: #GstIdentity
*
* Split data to multiple pads. Branching the data flow is useful when e.g.
* provide separate threads for each branch. Otherwise a blocked dataflow in one
* branch would stall the other branches.
*
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
* |[
- * gst-launch filesrc location=song.ogg ! decodebin2 ! tee name=t ! queue ! autoaudiosink t. ! queue ! audioconvert ! goom ! videoconvert ! autovideosink
- * ]| Play a song.ogg from local dir and render visualisations using the goom
- * element.
- * </refsect2>
+ * gst-launch-1.0 filesrc location=song.ogg ! decodebin ! tee name=t ! queue ! audioconvert ! audioresample ! autoaudiosink t. ! queue ! audioconvert ! goom ! videoconvert ! autovideosink
+ * ]|
+ *
+ * Play song.ogg audio file which must be in the current working directory
+ * and render visualisations using the goom element (this can be easier done
+ * using the playbin element, this is just an example pipeline).
*/
#ifdef HAVE_CONFIG_H
#define DEFAULT_PROP_SILENT TRUE
#define DEFAULT_PROP_LAST_MESSAGE NULL
#define DEFAULT_PULL_MODE GST_TEE_PULL_MODE_NEVER
+#define DEFAULT_PROP_ALLOW_NOT_LINKED FALSE
enum
{
PROP_LAST_MESSAGE,
PROP_PULL_MODE,
PROP_ALLOC_PAD,
+ PROP_ALLOW_NOT_LINKED,
};
-static GstStaticPadTemplate tee_src_template =
-GST_STATIC_PAD_TEMPLATE ("src_%u",
+static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src_%u",
GST_PAD_SRC,
GST_PAD_REQUEST,
GST_STATIC_CAPS_ANY);
DEFAULT_PULL_MODE,
G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
pspec_alloc_pad = g_param_spec_object ("alloc-pad", "Allocation Src Pad",
- "The pad ALLOCATION queries will be proxied to (unused)", GST_TYPE_PAD,
- G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
+ "The pad ALLOCATION queries will be proxied to (DEPRECATED, has no effect)",
+ GST_TYPE_PAD,
+ G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_DEPRECATED);
g_object_class_install_property (gobject_class, PROP_ALLOC_PAD,
pspec_alloc_pad);
+ /**
+ * GstTee:allow-not-linked
+ *
+ * This property makes sink pad return GST_FLOW_OK even if there are no
+ * source pads or any of them is linked.
+ *
+ * This is useful to avoid errors when you have a dynamic pipeline and during
+ * a reconnection you can have all the pads unlinked or removed.
+ *
+ * Since: 1.6
+ */
+ g_object_class_install_property (gobject_class, PROP_ALLOW_NOT_LINKED,
+ g_param_spec_boolean ("allow-not-linked", "Allow not linked",
+ "Return GST_FLOW_OK even if there are no source pads or they are "
+ "all unlinked", DEFAULT_PROP_ALLOW_NOT_LINKED,
+ G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
gst_element_class_set_static_metadata (gstelement_class,
"Tee pipe fitting",
"Generic",
"1-to-N pipe fitting",
"Erik Walthinsen <omega@cse.ogi.edu>, " "Wim Taymans <wim@fluendo.com>");
- gst_element_class_add_pad_template (gstelement_class,
- gst_static_pad_template_get (&sinktemplate));
- gst_element_class_add_pad_template (gstelement_class,
- gst_static_pad_template_get (&tee_src_template));
+ gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
+ gst_element_class_add_static_pad_template (gstelement_class, &src_template);
gstelement_class->request_new_pad =
GST_DEBUG_FUNCPTR (gst_tee_request_new_pad);
forward_sticky_events (GstPad * pad, GstEvent ** event, gpointer user_data)
{
GstPad *srcpad = GST_PAD_CAST (user_data);
+ GstFlowReturn ret;
- gst_pad_push_event (srcpad, gst_event_ref (*event));
+ ret = gst_pad_store_sticky_event (srcpad, *event);
+ if (ret != GST_FLOW_OK) {
+ GST_DEBUG_OBJECT (srcpad, "storing sticky event %p (%s) failed: %s", *event,
+ GST_EVENT_TYPE_NAME (*event), gst_flow_get_name (ret));
+ }
return TRUE;
}
GST_OBJECT_LOCK (tee);
- if (name_templ) {
- sscanf (name_templ, "src_%u", &index);
+ if (name_templ && sscanf (name_templ, "src_%u", &index) == 1) {
GST_LOG_OBJECT (element, "name: %s (index %d)", name_templ, index);
if (g_hash_table_contains (tee->pad_indexes, GUINT_TO_POINTER (index))) {
GST_ERROR_OBJECT (element, "pad name %s is not unique", name_templ);
gst_pad_set_query_function (srcpad, GST_DEBUG_FUNCPTR (gst_tee_src_query));
gst_pad_set_getrange_function (srcpad,
GST_DEBUG_FUNCPTR (gst_tee_src_get_range));
+ GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PROXY_CAPS);
/* Forward sticky events to the new srcpad */
gst_pad_sticky_events_foreach (tee->sinkpad, forward_sticky_events, srcpad);
- GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PROXY_CAPS);
gst_element_add_pad (GST_ELEMENT_CAST (tee), srcpad);
return srcpad;
}
GST_OBJECT_UNLOCK (tee);
- gst_object_ref (pad);
- gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
-
gst_pad_set_active (pad, FALSE);
-
- gst_object_unref (pad);
+ gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
if (changed) {
gst_tee_notify_alloc_pad (tee);
GST_OBJECT_UNLOCK (pad);
break;
}
+ case PROP_ALLOW_NOT_LINKED:
+ tee->allow_not_linked = g_value_get_boolean (value);
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
case PROP_ALLOC_PAD:
g_value_set_object (value, tee->allocpad);
break;
+ case PROP_ALLOW_NOT_LINKED:
+ g_value_set_boolean (value, tee->allow_not_linked);
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
return res;
}
+struct AllocQueryCtx
+{
+ GstTee *tee;
+ GstQuery *query;
+ GstAllocationParams params;
+ guint size;
+ guint min_buffers;
+ gboolean first_query;
+ guint num_pads;
+};
+
+/* This function will aggregate some of the allocation query information with
+ * the strategy to force upstream allocation. Depending on downstream
+ * allocation would otherwise make dynamic pipelines much more complicated as
+ * application would need to now drain buffer in certain cases before getting
+ * rid of a tee branch. */
+static gboolean
+gst_tee_query_allocation (const GValue * item, GValue * ret, gpointer user_data)
+{
+ struct AllocQueryCtx *ctx = user_data;
+ GstPad *src_pad = g_value_get_object (item);
+ GstPad *peer_pad;
+ GstCaps *caps;
+ GstQuery *query;
+ guint count, i, size, min;
+
+ GST_DEBUG_OBJECT (ctx->tee, "Aggregating allocation from pad %s:%s",
+ GST_DEBUG_PAD_NAME (src_pad));
+
+ peer_pad = gst_pad_get_peer (src_pad);
+ if (!peer_pad) {
+ if (ctx->tee->allow_not_linked) {
+ GST_DEBUG_OBJECT (ctx->tee, "Pad %s:%s has no peer, but allowed.",
+ GST_DEBUG_PAD_NAME (src_pad));
+ return TRUE;
+ } else {
+ GST_DEBUG_OBJECT (ctx->tee, "Pad %s:%s has no peer, ignoring allocation.",
+ GST_DEBUG_PAD_NAME (src_pad));
+ g_value_set_boolean (ret, FALSE);
+ return FALSE;
+ }
+ }
+
+ gst_query_parse_allocation (ctx->query, &caps, NULL);
+
+ query = gst_query_new_allocation (caps, FALSE);
+ if (!gst_pad_query (peer_pad, query)) {
+ GST_DEBUG_OBJECT (ctx->tee,
+ "Allocation query failed on pad %s, ignoring allocation",
+ GST_PAD_NAME (src_pad));
+ g_value_set_boolean (ret, FALSE);
+ gst_query_unref (query);
+ gst_object_unref (peer_pad);
+ return FALSE;
+ }
+
+ gst_object_unref (peer_pad);
+
+ /* Allocation Params:
+ * store the maximum alignment, prefix and padding, but ignore the
+ * allocators and the flags which are tied to downstream allocation */
+ count = gst_query_get_n_allocation_params (query);
+ for (i = 0; i < count; i++) {
+ GstAllocationParams params = { 0, };
+
+ gst_query_parse_nth_allocation_param (query, i, NULL, ¶ms);
+
+ GST_DEBUG_OBJECT (ctx->tee, "Aggregating AllocationParams align=%"
+ G_GSIZE_FORMAT " prefix=%" G_GSIZE_FORMAT " padding=%"
+ G_GSIZE_FORMAT, params.align, params.prefix, params.padding);
+
+ if (ctx->params.align < params.align)
+ ctx->params.align = params.align;
+
+ if (ctx->params.prefix < params.prefix)
+ ctx->params.prefix = params.prefix;
+
+ if (ctx->params.padding < params.padding)
+ ctx->params.padding = params.padding;
+ }
+
+ /* Allocation Pool:
+ * We want to keep the biggest size and biggest minimum number of buffers to
+ * make sure downstream requirement can be satisfied. We don't really care
+ * about the maximum, as this is a parameter of the downstream provided
+ * pool. We only read the first allocation pool as the minimum number of
+ * buffers is normally constant regardless of the pool being used. */
+ if (gst_query_get_n_allocation_pools (query) > 0) {
+ gst_query_parse_nth_allocation_pool (query, 0, NULL, &size, &min, NULL);
+
+ GST_DEBUG_OBJECT (ctx->tee,
+ "Aggregating allocation pool size=%u min_buffers=%u", size, min);
+
+ if (ctx->size < size)
+ ctx->size = size;
+
+ if (ctx->min_buffers < min)
+ ctx->min_buffers = min;
+ }
+
+ /* Allocation Meta:
+ * For allocation meta, we'll need to aggregate the argument using the new
+ * GstMetaInfo::agggregate_func */
+ count = gst_query_get_n_allocation_metas (query);
+ for (i = 0; i < count; i++) {
+ guint ctx_index;
+ GType api;
+ const GstStructure *param;
+
+ api = gst_query_parse_nth_allocation_meta (query, i, ¶m);
+
+ /* For the first query, copy all metas */
+ if (ctx->first_query) {
+ gst_query_add_allocation_meta (ctx->query, api, param);
+ continue;
+ }
+
+ /* Afterward, aggregate the common params */
+ if (gst_query_find_allocation_meta (ctx->query, api, &ctx_index)) {
+ const GstStructure *ctx_param;
+
+ gst_query_parse_nth_allocation_meta (ctx->query, ctx_index, &ctx_param);
+
+ /* Keep meta which has no params */
+ if (ctx_param == NULL && param == NULL)
+ continue;
+
+ GST_DEBUG_OBJECT (ctx->tee, "Dropping allocation meta %s",
+ g_type_name (api));
+ gst_query_remove_nth_allocation_meta (ctx->query, ctx_index);
+ }
+ }
+
+ /* Finally, cleanup metas from the stored query that aren't support on this
+ * pad. */
+ count = gst_query_get_n_allocation_metas (ctx->query);
+ for (i = 0; i < count;) {
+ GType api = gst_query_parse_nth_allocation_meta (ctx->query, i, NULL);
+
+ if (!gst_query_find_allocation_meta (query, api, NULL)) {
+ GST_DEBUG_OBJECT (ctx->tee, "Dropping allocation meta %s",
+ g_type_name (api));
+ gst_query_remove_nth_allocation_meta (ctx->query, i);
+ count--;
+ continue;
+ }
+
+ i++;
+ }
+
+ ctx->first_query = FALSE;
+ ctx->num_pads++;
+ gst_query_unref (query);
+
+ return TRUE;
+}
+
+
+static void
+gst_tee_clear_query_allocation_meta (GstQuery * query)
+{
+ guint count = gst_query_get_n_allocation_metas (query);
+ guint i;
+
+ for (i = 1; i <= count; i++)
+ gst_query_remove_nth_allocation_meta (query, count - i);
+}
+
static gboolean
gst_tee_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
{
+ GstTee *tee = GST_TEE (parent);
gboolean res;
switch (GST_QUERY_TYPE (query)) {
+ case GST_QUERY_ALLOCATION:
+ {
+ GstIterator *iter;
+ GValue ret = G_VALUE_INIT;
+ struct AllocQueryCtx ctx = { tee, query, };
+
+ g_value_init (&ret, G_TYPE_BOOLEAN);
+ g_value_set_boolean (&ret, TRUE);
+
+ ctx.first_query = TRUE;
+ gst_allocation_params_init (&ctx.params);
+
+ iter = gst_element_iterate_src_pads (GST_ELEMENT (tee));
+ while (GST_ITERATOR_RESYNC ==
+ gst_iterator_fold (iter, gst_tee_query_allocation, &ret, &ctx)) {
+ gst_iterator_resync (iter);
+ ctx.first_query = TRUE;
+ gst_allocation_params_init (&ctx.params);
+ ctx.size = 0;
+ ctx.min_buffers = 0;
+ ctx.num_pads = 0;
+ gst_tee_clear_query_allocation_meta (query);
+ }
+
+ gst_iterator_free (iter);
+ res = g_value_get_boolean (&ret);
+ g_value_unset (&ret);
+
+ if (res) {
+ GST_DEBUG_OBJECT (tee, "Aggregated AllocationParams to align=%"
+ G_GSIZE_FORMAT " prefix=%" G_GSIZE_FORMAT " padding=%"
+ G_GSIZE_FORMAT, ctx.params.align, ctx.params.prefix,
+ ctx.params.padding);
+
+ GST_DEBUG_OBJECT (tee,
+ "Aggregated allocation pools size=%u min_buffers=%u", ctx.size,
+ ctx.min_buffers);
+
+#ifndef GST_DISABLE_GST_DEBUG
+ {
+ guint count = gst_query_get_n_allocation_metas (query);
+ guint i;
+
+ GST_DEBUG_OBJECT (tee, "Aggregated %u allocation meta:", count);
+
+ for (i = 0; i < count; i++)
+ GST_DEBUG_OBJECT (tee, " + aggregated allocation meta %s",
+ g_type_name (gst_query_parse_nth_allocation_meta (ctx.query, i,
+ NULL)));
+ }
+#endif
+
+ /* Allocate one more buffers when multiplexing so we don't starve the
+ * downstream threads. */
+ if (ctx.num_pads > 1)
+ ctx.min_buffers++;
+
+ /* Check that we actually have parameters besides the defaults. */
+ if (ctx.params.align || ctx.params.prefix || ctx.params.padding) {
+ gst_query_add_allocation_param (ctx.query, NULL, &ctx.params);
+ }
+ /* When size == 0, buffers created from this pool would have no memory
+ * allocated. */
+ if (ctx.size) {
+ gst_query_add_allocation_pool (ctx.query, NULL, ctx.size,
+ ctx.min_buffers, 0);
+ }
+ } else {
+ gst_tee_clear_query_allocation_meta (query);
+ }
+ break;
+ }
default:
res = gst_pad_query_default (pad, parent, query);
break;
ret = gst_pad_push (pad, GST_BUFFER_CAST (data));
}
+ GST_OBJECT_LOCK (tee);
+ if (GST_TEE_PAD_CAST (pad)->removed)
+ ret = GST_FLOW_NOT_LINKED;
+
+ if (ret == GST_FLOW_NOT_LINKED && tee->allow_not_linked) {
+ ret = GST_FLOW_OK;
+ }
+ GST_OBJECT_UNLOCK (tee);
+
gst_object_unref (pad);
return ret;
g_list_foreach (pads, (GFunc) clear_pads, tee);
restart:
- cret = GST_FLOW_NOT_LINKED;
+ if (tee->allow_not_linked) {
+ cret = GST_FLOW_OK;
+ } else {
+ cret = GST_FLOW_NOT_LINKED;
+ }
pads = GST_ELEMENT_CAST (tee)->srcpads;
cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
gst_object_ref (pad);
GST_OBJECT_UNLOCK (tee);
- GST_LOG_OBJECT (tee, "Starting to push %s %p",
+ GST_LOG_OBJECT (pad, "Starting to push %s %p",
is_list ? "list" : "buffer", data);
ret = gst_tee_do_push (tee, pad, data, is_list);
- GST_LOG_OBJECT (tee, "Pushing item %p yielded result %s", data,
+ GST_LOG_OBJECT (pad, "Pushing item %p yielded result %s", data,
gst_flow_get_name (ret));
GST_OBJECT_LOCK (tee);
/* keep track of which pad we pushed and the result value */
+ if (GST_TEE_PAD_CAST (pad)->removed)
+ ret = GST_FLOW_NOT_LINKED;
GST_TEE_PAD_CAST (pad)->pushed = TRUE;
GST_TEE_PAD_CAST (pad)->result = ret;
gst_object_unref (pad);
+ pad = NULL;
} else {
/* already pushed, use previous return value */
ret = GST_TEE_PAD_CAST (pad)->result;
- GST_LOG_OBJECT (tee, "pad already pushed with %s",
+ GST_LOG_OBJECT (pad, "pad already pushed with %s",
gst_flow_get_name (ret));
}
/* ERRORS */
no_pads:
{
- GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
- ret = GST_FLOW_NOT_LINKED;
- goto error;
+ if (tee->allow_not_linked) {
+ GST_DEBUG_OBJECT (tee, "there are no pads, dropping %s",
+ is_list ? "buffer-list" : "buffer");
+ ret = GST_FLOW_OK;
+ } else {
+ GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
+ ret = GST_FLOW_NOT_LINKED;
+ }
+ goto end;
}
error:
{
GST_DEBUG_OBJECT (tee, "received error %s", gst_flow_get_name (ret));
+ goto end;
+ }
+end:
+ {
GST_OBJECT_UNLOCK (tee);
gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
return ret;
GstIterator *iter;
iter = gst_element_iterate_src_pads (GST_ELEMENT (tee));
- gst_iterator_foreach (iter, (GstIteratorForeachFunction) gst_tee_push_eos,
- tee);
+ while (gst_iterator_foreach (iter,
+ (GstIteratorForeachFunction) gst_tee_push_eos,
+ tee) == GST_ITERATOR_RESYNC)
+ gst_iterator_resync (iter);
gst_iterator_free (iter);
}
projects / platform / upstream / gstreamer.git / blobdiff