/* GStreamer * Copyright (C) 1999,2000 Erik Walthinsen * 2005 Wim Taymans * 2005 Andy Wingo * 2005 Thomas Vander Stichele * 2008 Wim Taymans * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ /** * SECTION:gstbasetransform * @short_description: Base class for simple transform filters * @see_also: #GstBaseSrc, #GstBaseSink * * This base class is for filter elements that process data. * * It provides for: * * one sinkpad and one srcpad * * Possible formats on sink and source pad implemented * with custom transform_caps function. By default uses * same format on sink and source. * * Handles state changes * Does flushing * Push mode * * Pull mode if the sub-class transform can operate on arbitrary data * * * * * Use Cases * * * * Passthrough mode * * Element has no interest in modifying the buffer. It may want to inspect it, * in which case the element should have a transform_ip function. If there * is no transform_ip function in passthrough mode, the buffer is pushed * intact. * * * On the GstBaseTransformClass is the passthrough_on_same_caps variable * which will automatically set/unset passthrough based on whether the * element negotiates the same caps on both pads. * * * passthrough_on_same_caps on an element that doesn't implement a * transform_caps function is useful for elements that only inspect data * (such as level) * * * * Example elements * Level * Videoscale, audioconvert, ffmpegcolorspace, audioresample in * certain modes. * * * * * Modifications in-place - input buffer and output buffer are the * same thing. * * The element must implement a transform_ip function. * * * Output buffer size must <= input buffer size * * * If the always_in_place flag is set, non-writable buffers will be copied * and passed to the transform_ip function, otherwise a new buffer will be * created and the transform function called. * * * Incoming writable buffers will be passed to the transform_ip function * immediately. * * only implementing transform_ip and not transform implies always_in_place * = TRUE * * * * Example elements * Volume * Audioconvert in certain modes (signed/unsigned * conversion) * ffmpegcolorspace in certain modes (endianness * swapping) * * * * * Modifications only to the caps/metadata of a buffer * * The element does not require writable data, but non-writable buffers * should be subbuffered so that the meta-information can be replaced. * * * Elements wishing to operate in this mode should replace the * prepare_output_buffer method to create subbuffers of the input buffer * and set always_in_place to TRUE * * * * Example elements * Capsfilter when setting caps on outgoing buffers that have * none. * identity when it is going to re-timestamp buffers by * datarate. * * * * Normal mode * * always_in_place flag is not set, or there is no transform_ip function * * * Element will receive an input buffer and output buffer to operate on. * * * Output buffer is allocated by calling the prepare_output_buffer function. * * * * Example elements * Videoscale, ffmpegcolorspace, audioconvert when doing * scaling/conversions * * * * Special output buffer allocations * * Elements which need to do special allocation of their output buffers * other than what gst_buffer_pad_alloc allows should implement a * prepare_output_buffer method, which calls the parent implementation and * passes the newly allocated buffer. * * * * Example elements * efence * * * * * * * Sub-class settable flags on GstBaseTransform * * * * passthrough * * Implies that in the current configuration, the sub-class is not * interested in modifying the buffers. * * * Elements which are always in passthrough mode whenever the same caps * has been negotiated on both pads can set the class variable * passthrough_on_same_caps to have this behaviour automatically. * * * * * always_in_place * * Determines whether a non-writable buffer will be copied before passing * to the transform_ip function. * * * Implied TRUE if no transform function is implemented. * * * Implied FALSE if ONLY transform function is implemented. * * * * * * */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include #include #include "../../../gst/gst_private.h" #include "../../../gst/gst-i18n-lib.h" #include "gstbasetransform.h" #include GST_DEBUG_CATEGORY_STATIC (gst_base_transform_debug); #define GST_CAT_DEFAULT gst_base_transform_debug /* BaseTransform signals and args */ enum { /* FILL ME */ LAST_SIGNAL }; #define DEFAULT_PROP_QOS FALSE enum { PROP_0, PROP_QOS }; #define GST_BASE_TRANSFORM_GET_PRIVATE(obj) \ (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_TRANSFORM, GstBaseTransformPrivate)) struct _GstBaseTransformPrivate { /* QoS *//* with LOCK */ gboolean qos_enabled; gdouble proportion; GstClockTime earliest_time; /* previous buffer had a discont */ gboolean discont; GstActivateMode pad_mode; gboolean gap_aware; /* caps used for allocating buffers */ gboolean proxy_alloc; GstCaps *sink_alloc; GstCaps *src_alloc; /* upstream caps and size suggestions */ GstCaps *sink_suggest; guint size_suggest; gboolean suggest_pending; gboolean reconfigure; }; static GstElementClass *parent_class = NULL; static void gst_base_transform_class_init (GstBaseTransformClass * klass); static void gst_base_transform_init (GstBaseTransform * trans, GstBaseTransformClass * klass); static GstFlowReturn gst_base_transform_prepare_output_buffer (GstBaseTransform * trans, GstBuffer * input, GstBuffer ** buf); GType gst_base_transform_get_type (void) { static GType base_transform_type = 0; if (!base_transform_type) { static const GTypeInfo base_transform_info = { sizeof (GstBaseTransformClass), NULL, NULL, (GClassInitFunc) gst_base_transform_class_init, NULL, NULL, sizeof (GstBaseTransform), 0, (GInstanceInitFunc) gst_base_transform_init, }; base_transform_type = g_type_register_static (GST_TYPE_ELEMENT, "GstBaseTransform", &base_transform_info, G_TYPE_FLAG_ABSTRACT); } return base_transform_type; } static void gst_base_transform_finalize (GObject * object); static void gst_base_transform_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec); static void gst_base_transform_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec); static gboolean gst_base_transform_src_activate_pull (GstPad * pad, gboolean active); static gboolean gst_base_transform_sink_activate_push (GstPad * pad, gboolean active); static gboolean gst_base_transform_activate (GstBaseTransform * trans, gboolean active); static gboolean gst_base_transform_get_unit_size (GstBaseTransform * trans, GstCaps * caps, guint * size); static gboolean gst_base_transform_src_event (GstPad * pad, GstEvent * event); static gboolean gst_base_transform_src_eventfunc (GstBaseTransform * trans, GstEvent * event); static gboolean gst_base_transform_sink_event (GstPad * pad, GstEvent * event); static gboolean gst_base_transform_sink_eventfunc (GstBaseTransform * trans, GstEvent * event); static gboolean gst_base_transform_check_get_range (GstPad * pad); static GstFlowReturn gst_base_transform_getrange (GstPad * pad, guint64 offset, guint length, GstBuffer ** buffer); static GstFlowReturn gst_base_transform_chain (GstPad * pad, GstBuffer * buffer); static GstCaps *gst_base_transform_getcaps (GstPad * pad); static gboolean gst_base_transform_setcaps (GstPad * pad, GstCaps * caps); static GstFlowReturn gst_base_transform_buffer_alloc (GstPad * pad, guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf); /* static guint gst_base_transform_signals[LAST_SIGNAL] = { 0 }; */ static void gst_base_transform_finalize (GObject * object) { GstBaseTransform *trans; trans = GST_BASE_TRANSFORM (object); gst_caps_replace (&trans->priv->sink_suggest, NULL); g_mutex_free (trans->transform_lock); G_OBJECT_CLASS (parent_class)->finalize (object); } static void gst_base_transform_class_init (GstBaseTransformClass * klass) { GObjectClass *gobject_class; gobject_class = G_OBJECT_CLASS (klass); GST_DEBUG_CATEGORY_INIT (gst_base_transform_debug, "basetransform", 0, "basetransform element"); GST_DEBUG ("gst_base_transform_class_init"); g_type_class_add_private (klass, sizeof (GstBaseTransformPrivate)); parent_class = g_type_class_peek_parent (klass); gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_transform_set_property); gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_transform_get_property); g_object_class_install_property (gobject_class, PROP_QOS, g_param_spec_boolean ("qos", "QoS", "Handle Quality-of-Service events", DEFAULT_PROP_QOS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_transform_finalize); klass->passthrough_on_same_caps = FALSE; klass->event = GST_DEBUG_FUNCPTR (gst_base_transform_sink_eventfunc); klass->src_event = GST_DEBUG_FUNCPTR (gst_base_transform_src_eventfunc); } static void gst_base_transform_init (GstBaseTransform * trans, GstBaseTransformClass * bclass) { GstPadTemplate *pad_template; GST_DEBUG ("gst_base_transform_init"); trans->priv = GST_BASE_TRANSFORM_GET_PRIVATE (trans); pad_template = gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink"); g_return_if_fail (pad_template != NULL); trans->sinkpad = gst_pad_new_from_template (pad_template, "sink"); gst_pad_set_getcaps_function (trans->sinkpad, GST_DEBUG_FUNCPTR (gst_base_transform_getcaps)); gst_pad_set_setcaps_function (trans->sinkpad, GST_DEBUG_FUNCPTR (gst_base_transform_setcaps)); gst_pad_set_event_function (trans->sinkpad, GST_DEBUG_FUNCPTR (gst_base_transform_sink_event)); gst_pad_set_chain_function (trans->sinkpad, GST_DEBUG_FUNCPTR (gst_base_transform_chain)); gst_pad_set_activatepush_function (trans->sinkpad, GST_DEBUG_FUNCPTR (gst_base_transform_sink_activate_push)); gst_pad_set_bufferalloc_function (trans->sinkpad, GST_DEBUG_FUNCPTR (gst_base_transform_buffer_alloc)); gst_element_add_pad (GST_ELEMENT (trans), trans->sinkpad); pad_template = gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src"); g_return_if_fail (pad_template != NULL); trans->srcpad = gst_pad_new_from_template (pad_template, "src"); gst_pad_set_getcaps_function (trans->srcpad, GST_DEBUG_FUNCPTR (gst_base_transform_getcaps)); gst_pad_set_event_function (trans->srcpad, GST_DEBUG_FUNCPTR (gst_base_transform_src_event)); gst_pad_set_checkgetrange_function (trans->srcpad, GST_DEBUG_FUNCPTR (gst_base_transform_check_get_range)); gst_pad_set_getrange_function (trans->srcpad, GST_DEBUG_FUNCPTR (gst_base_transform_getrange)); gst_pad_set_activatepull_function (trans->srcpad, GST_DEBUG_FUNCPTR (gst_base_transform_src_activate_pull)); gst_element_add_pad (GST_ELEMENT (trans), trans->srcpad); trans->transform_lock = g_mutex_new (); trans->pending_configure = FALSE; trans->priv->qos_enabled = DEFAULT_PROP_QOS; trans->cache_caps1 = NULL; trans->cache_caps2 = NULL; trans->priv->pad_mode = GST_ACTIVATE_NONE; trans->priv->gap_aware = FALSE; trans->passthrough = FALSE; if (bclass->transform == NULL) { /* If no transform function, always_in_place is TRUE */ GST_DEBUG_OBJECT (trans, "setting in_place TRUE"); trans->always_in_place = TRUE; if (bclass->transform_ip == NULL) { GST_DEBUG_OBJECT (trans, "setting passthrough TRUE"); trans->passthrough = TRUE; } } } /* given @caps on the src or sink pad (given by @direction) * calculate the possible caps on the other pad. * * Returns new caps, unref after usage. */ static GstCaps * gst_base_transform_transform_caps (GstBaseTransform * trans, GstPadDirection direction, GstCaps * caps) { GstCaps *ret; GstBaseTransformClass *klass; if (caps == NULL) return NULL; klass = GST_BASE_TRANSFORM_GET_CLASS (trans); /* if there is a custom transform function, use this */ if (klass->transform_caps) { GstCaps *temp; gint i; /* start with empty caps */ ret = gst_caps_new_empty (); GST_DEBUG_OBJECT (trans, "transform caps (direction = %d)", direction); if (gst_caps_is_any (caps)) { /* for any caps we still have to call the transform function */ GST_DEBUG_OBJECT (trans, "from: ANY"); temp = klass->transform_caps (trans, direction, caps); GST_DEBUG_OBJECT (trans, " to: %" GST_PTR_FORMAT, temp); temp = gst_caps_make_writable (temp); gst_caps_append (ret, temp); } else { /* we send caps with just one structure to the transform * function as this is easier for the element */ for (i = 0; i < gst_caps_get_size (caps); i++) { GstCaps *nth; nth = gst_caps_copy_nth (caps, i); GST_LOG_OBJECT (trans, "from[%d]: %" GST_PTR_FORMAT, i, nth); temp = klass->transform_caps (trans, direction, nth); gst_caps_unref (nth); GST_LOG_OBJECT (trans, " to[%d]: %" GST_PTR_FORMAT, i, temp); temp = gst_caps_make_writable (temp); /* here we need to only append those structures, that are not yet * in there, we use the merge function for this */ gst_caps_merge (ret, temp); GST_LOG_OBJECT (trans, " merged[%d]: %" GST_PTR_FORMAT, i, ret); } GST_LOG_OBJECT (trans, "merged: (%d)", gst_caps_get_size (ret)); /* we can't do much simplification here because we don't really want to * change the caps order */ } } else { GST_DEBUG_OBJECT (trans, "identity from: %" GST_PTR_FORMAT, caps); /* no transform function, use the identity transform */ ret = gst_caps_ref (caps); } GST_DEBUG_OBJECT (trans, "to: (%d) %" GST_PTR_FORMAT, gst_caps_get_size (ret), ret); return ret; } /* transform a buffer of @size with @caps on the pad with @direction to * the size of a buffer with @othercaps and store the result in @othersize * * We have two ways of doing this: * 1) use a custom transform size function, this is for complicated custom * cases with no fixed unit_size. * 2) use the unit_size functions where there is a relationship between the * caps and the size of a buffer. */ static gboolean gst_base_transform_transform_size (GstBaseTransform * trans, GstPadDirection direction, GstCaps * caps, guint size, GstCaps * othercaps, guint * othersize) { guint inunitsize, outunitsize, units; GstBaseTransformClass *klass; gboolean ret; klass = GST_BASE_TRANSFORM_GET_CLASS (trans); GST_DEBUG_OBJECT (trans, "asked to transform size %d for caps %" GST_PTR_FORMAT " to size for caps %" GST_PTR_FORMAT " in direction %s", size, caps, othercaps, direction == GST_PAD_SRC ? "SRC" : "SINK"); if (klass->transform_size) { /* if there is a custom transform function, use this */ ret = klass->transform_size (trans, direction, caps, size, othercaps, othersize); } else { /* there is no transform_size function, we have to use the unit_size * functions. This method assumes there is a fixed unit_size associated with * each caps. We provide the same amount of units on both sides. */ if (!gst_base_transform_get_unit_size (trans, caps, &inunitsize)) goto no_in_size; GST_DEBUG_OBJECT (trans, "input size %d, input unit size %d", size, inunitsize); /* input size must be a multiple of the unit_size of the input caps */ if (inunitsize == 0 || (size % inunitsize != 0)) goto no_multiple; /* get the amount of units */ units = size / inunitsize; /* now get the unit size of the output */ if (!gst_base_transform_get_unit_size (trans, othercaps, &outunitsize)) goto no_out_size; /* the output size is the unit_size times the amount of units on the * input */ *othersize = units * outunitsize; GST_DEBUG_OBJECT (trans, "transformed size to %d", *othersize); ret = TRUE; } return ret; /* ERRORS */ no_in_size: { GST_DEBUG_OBJECT (trans, "could not get in_size"); g_warning ("%s: could not get in_size", GST_ELEMENT_NAME (trans)); return FALSE; } no_multiple: { GST_DEBUG_OBJECT (trans, "Size %u is not a multiple of unit size %u", size, inunitsize); g_warning ("%s: size %u is not a multiple of unit size %u", GST_ELEMENT_NAME (trans), size, inunitsize); return FALSE; } no_out_size: { GST_DEBUG_OBJECT (trans, "could not get out_size"); g_warning ("%s: could not get out_size", GST_ELEMENT_NAME (trans)); return FALSE; } } /* get the caps that can be handled by @pad. We perforn: * * - take the caps of peer of otherpad, * - filter against the padtemplate of otherpad, * - calculate all transforms of remaining caps * - filter against template of @pad * * If there is no peer, we simply return the caps of the padtemplate of pad. */ static GstCaps * gst_base_transform_getcaps (GstPad * pad) { GstBaseTransform *trans; GstPad *otherpad; GstCaps *caps; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad; /* we can do what the peer can */ caps = gst_pad_peer_get_caps (otherpad); if (caps) { GstCaps *temp; const GstCaps *templ; GST_DEBUG_OBJECT (pad, "peer caps %" GST_PTR_FORMAT, caps); /* filtered against our padtemplate */ templ = gst_pad_get_pad_template_caps (otherpad); GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ); temp = gst_caps_intersect (caps, templ); GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp); gst_caps_unref (caps); /* then see what we can transform this to */ caps = gst_base_transform_transform_caps (trans, GST_PAD_DIRECTION (otherpad), temp); GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, caps); gst_caps_unref (temp); if (caps == NULL) goto done; /* and filter against the template again */ templ = gst_pad_get_pad_template_caps (pad); GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ); temp = gst_caps_intersect (caps, templ); GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp); gst_caps_unref (caps); /* this is what we can do */ caps = temp; } else { /* no peer, our padtemplate is enough then */ caps = gst_caps_copy (gst_pad_get_pad_template_caps (pad)); } done: GST_DEBUG_OBJECT (trans, "returning %" GST_PTR_FORMAT, caps); gst_object_unref (trans); return caps; } /* function triggered when the in and out caps are negotiated and need * to be configured in the subclass. */ static gboolean gst_base_transform_configure_caps (GstBaseTransform * trans, GstCaps * in, GstCaps * out) { gboolean ret = TRUE; GstBaseTransformClass *klass; klass = GST_BASE_TRANSFORM_GET_CLASS (trans); GST_DEBUG_OBJECT (trans, "in caps: %" GST_PTR_FORMAT, in); GST_DEBUG_OBJECT (trans, "out caps: %" GST_PTR_FORMAT, out); /* clear the cache */ gst_caps_replace (&trans->cache_caps1, NULL); gst_caps_replace (&trans->cache_caps2, NULL); /* figure out same caps state */ trans->have_same_caps = gst_caps_is_equal (in, out); GST_DEBUG_OBJECT (trans, "have_same_caps: %d", trans->have_same_caps); /* If we've a transform_ip method and same input/output caps, set in_place * by default. If for some reason the sub-class prefers using a transform * function, it can clear the in place flag in the set_caps */ gst_base_transform_set_in_place (trans, klass->transform_ip && trans->have_same_caps); /* Set the passthrough if the class wants passthrough_on_same_caps * and we have the same caps on each pad */ if (klass->passthrough_on_same_caps) gst_base_transform_set_passthrough (trans, trans->have_same_caps); /* now configure the element with the caps */ if (klass->set_caps) { GST_DEBUG_OBJECT (trans, "Calling set_caps method to setup caps"); ret = klass->set_caps (trans, in, out); } trans->negotiated = ret; return ret; } /* check if caps @in on @pad can be transformed to @out on the other pad. * We don't have a vmethod to test this yet so we have to do a somewhat less * efficient check for this. */ static gboolean gst_base_transform_can_transform (GstBaseTransform * trans, GstPad * pad, GstCaps * in, GstCaps * out) { GstCaps *othercaps; /* convert the in caps to all possible out caps */ othercaps = gst_base_transform_transform_caps (trans, GST_PAD_DIRECTION (pad), in); /* check if transform is empty */ if (!othercaps || gst_caps_is_empty (othercaps)) goto no_transform; /* check if the out caps is a subset of the othercaps */ if (!gst_caps_is_subset (out, othercaps)) goto no_subset; if (othercaps) gst_caps_unref (othercaps); GST_DEBUG_OBJECT (trans, "from %" GST_PTR_FORMAT, in); GST_DEBUG_OBJECT (trans, "to %" GST_PTR_FORMAT, out); return TRUE; /* ERRORS */ no_transform: { GST_DEBUG_OBJECT (trans, "transform returned useless %" GST_PTR_FORMAT, othercaps); if (othercaps) gst_caps_unref (othercaps); return FALSE; } no_subset: { GST_DEBUG_OBJECT (trans, "no subset"); if (othercaps) gst_caps_unref (othercaps); return FALSE; } } /* given a fixed @caps on @pad, create the best possible caps for the * other pad. * @caps must be fixed when calling this function. * * This function calls the transform caps vmethod of the basetransform to figure * out the possible target formats. It then tries to select the best format from * this list by: * * - attempt passthrough if the target caps is a superset of the input caps * - fixating by using peer caps * - fixating with transform fixate function * - fixating with pad fixate functions. * * this function returns a caps that can be transformed into and is accepted by * the peer element. */ static GstCaps * gst_base_transform_find_transform (GstBaseTransform * trans, GstPad * pad, GstCaps * caps) { GstBaseTransformClass *klass; GstPad *otherpad, *otherpeer; GstCaps *othercaps; gboolean peer_checked = FALSE; /* caps must be fixed here, this is a programming error if it's not */ g_return_val_if_fail (gst_caps_is_fixed (caps), NULL); klass = GST_BASE_TRANSFORM_GET_CLASS (trans); otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad; otherpeer = gst_pad_get_peer (otherpad); /* see how we can transform the input caps. We need to do this even for * passthrough because it might be possible that this element cannot support * passthrough at all. */ othercaps = gst_base_transform_transform_caps (trans, GST_PAD_DIRECTION (pad), caps); /* The caps we can actually output is the intersection of the transformed * caps with the pad template for the pad */ if (othercaps) { GstCaps *intersect; const GstCaps *templ_caps; templ_caps = gst_pad_get_pad_template_caps (otherpad); GST_DEBUG_OBJECT (trans, "intersecting against padtemplate %" GST_PTR_FORMAT, templ_caps); intersect = gst_caps_intersect (othercaps, templ_caps); gst_caps_unref (othercaps); othercaps = intersect; } /* check if transform is empty */ if (!othercaps || gst_caps_is_empty (othercaps)) goto no_transform; /* if the othercaps are not fixed, we need to fixate them, first attempt * is by attempting passthrough if the othercaps are a superset of caps. */ /* FIXME. maybe the caps is not fixed because it has multiple structures of * fixed caps */ if (!gst_caps_is_fixed (othercaps)) { GstCaps *temp; GST_DEBUG_OBJECT (trans, "transform returned non fixed %" GST_PTR_FORMAT, othercaps); /* see if the target caps are a superset of the source caps, in this * case we can try to perform passthrough */ temp = gst_caps_intersect (othercaps, caps); GST_DEBUG_OBJECT (trans, "intersect returned %" GST_PTR_FORMAT, temp); if (temp) { if (!gst_caps_is_empty (temp)) { GST_DEBUG_OBJECT (trans, "try passthrough with %" GST_PTR_FORMAT, caps); if (otherpeer) { /* try passthrough. we know it's fixed, because caps is fixed */ if (gst_pad_accept_caps (otherpeer, caps)) { GST_DEBUG_OBJECT (trans, "peer accepted %" GST_PTR_FORMAT, caps); /* peer accepted unmodified caps, we free the original non-fixed * caps and work with the passthrough caps */ gst_caps_unref (othercaps); othercaps = gst_caps_ref (caps); /* mark that we checked othercaps with the peer, this * makes sure we don't call accept_caps again with these same * caps */ peer_checked = TRUE; } else { GST_DEBUG_OBJECT (trans, "peer did not accept %" GST_PTR_FORMAT, caps); } } else { GST_DEBUG_OBJECT (trans, "no peer, doing passthrough"); gst_caps_unref (othercaps); othercaps = gst_caps_ref (caps); } } gst_caps_unref (temp); } } /* second attempt at fixation is done by intersecting with * the peer caps */ if (!gst_caps_is_fixed (othercaps) && otherpeer) { /* intersect against what the peer can do */ GstCaps *peercaps; GstCaps *intersect; GST_DEBUG_OBJECT (trans, "othercaps now %" GST_PTR_FORMAT, othercaps); peercaps = gst_pad_get_caps (otherpeer); intersect = gst_caps_intersect (peercaps, othercaps); gst_caps_unref (peercaps); gst_caps_unref (othercaps); othercaps = intersect; peer_checked = FALSE; GST_DEBUG_OBJECT (trans, "filtering against peer yields %" GST_PTR_FORMAT, othercaps); } if (gst_caps_is_empty (othercaps)) goto no_transform_possible; /* third attempt at fixation, call the fixate vmethod and * ultimately call the pad fixate function. */ if (!gst_caps_is_fixed (othercaps)) { GstCaps *temp; GST_DEBUG_OBJECT (trans, "trying to fixate %" GST_PTR_FORMAT " on pad %s:%s", othercaps, GST_DEBUG_PAD_NAME (otherpad)); /* since we have no other way to fixate left, we might as well just take * the first of the caps list and fixate that */ /* FIXME: when fixating using the vmethod, it might make sense to fixate * each of the caps; but Wim doesn't see a use case for that yet */ temp = gst_caps_copy_nth (othercaps, 0); gst_caps_unref (othercaps); othercaps = temp; peer_checked = FALSE; if (klass->fixate_caps) { GST_DEBUG_OBJECT (trans, "trying to fixate %" GST_PTR_FORMAT " using caps %" GST_PTR_FORMAT " on pad %s:%s using fixate_caps vmethod", othercaps, caps, GST_DEBUG_PAD_NAME (otherpad)); klass->fixate_caps (trans, GST_PAD_DIRECTION (pad), caps, othercaps); } /* if still not fixed, no other option but to let the default pad fixate * function do its job */ if (!gst_caps_is_fixed (othercaps)) { GST_DEBUG_OBJECT (trans, "trying to fixate %" GST_PTR_FORMAT " on pad %s:%s using gst_pad_fixate_caps", othercaps, GST_DEBUG_PAD_NAME (otherpad)); gst_pad_fixate_caps (otherpad, othercaps); } GST_DEBUG_OBJECT (trans, "after fixating %" GST_PTR_FORMAT, othercaps); } /* caps should be fixed now, if not we have to fail. */ if (!gst_caps_is_fixed (othercaps)) goto could_not_fixate; /* and peer should accept, don't check again if we already checked the * othercaps against the peer. */ if (!peer_checked && otherpeer && !gst_pad_accept_caps (otherpeer, othercaps)) goto peer_no_accept; GST_DEBUG_OBJECT (trans, "Input caps were %" GST_PTR_FORMAT ", and got final caps %" GST_PTR_FORMAT, caps, othercaps); if (otherpeer) gst_object_unref (otherpeer); return othercaps; /* ERRORS */ no_transform: { GST_DEBUG_OBJECT (trans, "transform returned useless %" GST_PTR_FORMAT, othercaps); goto error_cleanup; } no_transform_possible: { GST_DEBUG_OBJECT (trans, "transform could not transform %" GST_PTR_FORMAT " in anything we support", caps); goto error_cleanup; } could_not_fixate: { GST_DEBUG_OBJECT (trans, "FAILED to fixate %" GST_PTR_FORMAT, othercaps); goto error_cleanup; } peer_no_accept: { GST_DEBUG_OBJECT (trans, "FAILED to get peer of %" GST_PTR_FORMAT " to accept %" GST_PTR_FORMAT, otherpad, othercaps); goto error_cleanup; } error_cleanup: { if (otherpeer) gst_object_unref (otherpeer); if (othercaps) gst_caps_unref (othercaps); return NULL; } } /* called when new caps arrive on the sink or source pad, * We try to find the best caps for the other side using our _find_transform() * function. If there are caps, we configure the transform for this new * transformation. * * FIXME, this function is currently commutative but this should not really be * because we never set caps starting from the srcpad. */ static gboolean gst_base_transform_setcaps (GstPad * pad, GstCaps * caps) { GstBaseTransform *trans; GstBaseTransformClass *klass; GstPad *otherpad, *otherpeer; GstCaps *othercaps = NULL; gboolean ret = TRUE; GstCaps *incaps, *outcaps; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); klass = GST_BASE_TRANSFORM_GET_CLASS (trans); otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad; otherpeer = gst_pad_get_peer (otherpad); /* if we get called recursively, we bail out now to avoid an * infinite loop. */ if (GST_PAD_IS_IN_SETCAPS (otherpad)) goto done; GST_DEBUG_OBJECT (pad, "have new caps %" GST_PTR_FORMAT, caps); /* find best possible caps for the other pad */ othercaps = gst_base_transform_find_transform (trans, pad, caps); if (!othercaps || gst_caps_is_empty (othercaps)) goto no_transform_possible; /* configure the element now */ /* make sure in and out caps are correct */ if (pad == trans->sinkpad) { incaps = caps; outcaps = othercaps; } else { incaps = othercaps; outcaps = caps; } #if 0 /* if we have the same caps, we can optimize and reuse the input caps */ if (gst_caps_is_equal (incaps, outcaps)) { GST_INFO_OBJECT (trans, "reuse caps"); gst_caps_unref (outcaps); outcaps = gst_caps_ref (incaps); } #endif /* call configure now */ if (!(ret = gst_base_transform_configure_caps (trans, incaps, outcaps))) goto failed_configure; /* we know this will work, we implement the setcaps */ gst_pad_set_caps (otherpad, othercaps); if (pad == trans->srcpad && trans->priv->pad_mode == GST_ACTIVATE_PULL) { /* FIXME hm? */ ret &= gst_pad_set_caps (otherpeer, othercaps); if (!ret) { GST_INFO_OBJECT (trans, "otherpeer setcaps(%" GST_PTR_FORMAT ") failed", othercaps); } } done: if (otherpeer) gst_object_unref (otherpeer); if (othercaps) gst_caps_unref (othercaps); trans->negotiated = ret; gst_object_unref (trans); return ret; /* ERRORS */ no_transform_possible: { GST_WARNING_OBJECT (trans, "transform could not transform %" GST_PTR_FORMAT " in anything we support", caps); ret = FALSE; goto done; } failed_configure: { GST_WARNING_OBJECT (trans, "FAILED to configure caps %" GST_PTR_FORMAT " to accept %" GST_PTR_FORMAT, otherpad, othercaps); ret = FALSE; goto done; } } /* Allocate a buffer using gst_pad_alloc_buffer * * This function can do renegotiation on the source pad * * The output buffer is always writable. outbuf can be equal to * inbuf, the caller should be prepared for this and perform * appropriate refcounting. */ static GstFlowReturn gst_base_transform_prepare_output_buffer (GstBaseTransform * trans, GstBuffer * in_buf, GstBuffer ** out_buf) { GstBaseTransformClass *bclass; GstBaseTransformPrivate *priv; GstFlowReturn ret = GST_FLOW_OK; guint outsize, newsize, expsize; gboolean discard; GstCaps *incaps, *oldcaps, *newcaps; bclass = GST_BASE_TRANSFORM_GET_CLASS (trans); priv = trans->priv; /* figure out how to allocate a buffer based on the current configuration */ if (trans->passthrough) { GST_DEBUG_OBJECT (trans, "doing passthrough alloc"); /* passthrough, we don't really need to call pad alloc but we still need to * in order to get upstream negotiation. The output size is the same as the * input size. */ outsize = GST_BUFFER_SIZE (in_buf); /* we always alloc and discard here */ discard = TRUE; } else { gboolean want_in_place = (bclass->transform_ip != NULL) && trans->always_in_place; if (want_in_place) { GST_DEBUG_OBJECT (trans, "doing inplace alloc"); /* we alloc a buffer of the same size as the input */ outsize = GST_BUFFER_SIZE (in_buf); /* only discard it when the input was not writable, otherwise, we reuse * the input buffer. */ discard = gst_buffer_is_writable (in_buf); } else { GST_DEBUG_OBJECT (trans, "getting output size for copy transform"); /* copy transform, figure out the output size */ if (!gst_base_transform_transform_size (trans, GST_PAD_SINK, GST_PAD_CAPS (trans->sinkpad), GST_BUFFER_SIZE (in_buf), GST_PAD_CAPS (trans->srcpad), &outsize)) { goto unknown_size; } /* never discard this buffer, we need it for storing the output */ discard = FALSE; } } oldcaps = GST_PAD_CAPS (trans->srcpad); if (bclass->prepare_output_buffer) { GST_DEBUG_OBJECT (trans, "calling prepare buffer with caps %" GST_PTR_FORMAT, oldcaps); ret = bclass->prepare_output_buffer (trans, in_buf, outsize, oldcaps, out_buf); /* get a new ref to the srcpad caps, the prepare_output_buffer function can * update the pad caps if it wants */ oldcaps = GST_PAD_CAPS (trans->srcpad); /* FIXME 0.11: * decrease refcount again if vmethod returned refcounted in_buf. This * is because we need to make sure that the buffer is writable for the * in_place transform. The docs of the vmethod say that you should return * a reffed inbuf, which is exactly what we don't want :), oh well.. */ if (in_buf == *out_buf) gst_buffer_unref (in_buf); /* never discard the buffer from the prepare_buffer method */ if (*out_buf != NULL) discard = FALSE; } if (ret != GST_FLOW_OK) goto alloc_failed; if (*out_buf == NULL) { GST_DEBUG_OBJECT (trans, "doing alloc with caps %" GST_PTR_FORMAT, oldcaps); ret = gst_pad_alloc_buffer (trans->srcpad, GST_BUFFER_OFFSET (in_buf), outsize, oldcaps, out_buf); if (ret != GST_FLOW_OK) goto alloc_failed; } /* must always have a buffer by now */ if (*out_buf == NULL) goto no_buffer; /* check if we got different caps on this new output buffer */ newcaps = GST_BUFFER_CAPS (*out_buf); newsize = GST_BUFFER_SIZE (*out_buf); if (!gst_caps_is_equal (newcaps, oldcaps)) { GstCaps *othercaps; gboolean can_convert; GST_DEBUG_OBJECT (trans, "received new caps %" GST_PTR_FORMAT, newcaps); incaps = GST_PAD_CAPS (trans->sinkpad); /* it's possible that the buffer we got is of the wrong size, get the * expected size here, we will check the size if we are going to use the * buffer later on. */ gst_base_transform_transform_size (trans, GST_PAD_SINK, incaps, GST_BUFFER_SIZE (in_buf), newcaps, &expsize); /* check if we can convert the current incaps to the new target caps */ can_convert = gst_base_transform_can_transform (trans, trans->sinkpad, incaps, newcaps); if (can_convert) { GST_DEBUG_OBJECT (trans, "reconfigure transform for current buffer"); /* caps not empty, try to renegotiate to the new format */ if (!gst_base_transform_configure_caps (trans, incaps, newcaps)) { /* not sure we need to fail hard here, we can simply continue our * conversion with what we negotiated before */ goto failed_configure; } /* new format configure, and use the new output buffer */ gst_pad_set_caps (trans->srcpad, newcaps); discard = FALSE; /* if we got a buffer of the wrong size, discard it now and make sure we * allocate a propertly sized buffer later. */ if (newsize != expsize) { if (in_buf != *out_buf) gst_buffer_unref (*out_buf); *out_buf = NULL; } outsize = expsize; } else { GST_DEBUG_OBJECT (trans, "cannot perform transform on current buffer"); /* we cannot convert the current buffer but we might be able to suggest a * new format upstream, try to find what the best format is. */ othercaps = gst_base_transform_find_transform (trans, trans->srcpad, newcaps); if (!othercaps) { GST_DEBUG_OBJECT (trans, "incompatible caps, ignoring"); /* we received caps that we cannot transform. Upstream is behaving badly * because it should have checked if we could handle these caps. We can * simply ignore these caps and produce a buffer with our original caps. */ } else { guint size_suggest; GST_DEBUG_OBJECT (trans, "getting size of suggestion"); /* not a subset, we have a new upstream suggestion, remember it and * allocate a default buffer. First we try to convert the size */ if (gst_base_transform_transform_size (trans, GST_PAD_SRC, newcaps, expsize, othercaps, &size_suggest)) { /* ok, remember the suggestions now */ GST_DEBUG_OBJECT (trans, "storing new caps and size suggestion of %u and %" GST_PTR_FORMAT, size_suggest, othercaps); GST_OBJECT_LOCK (trans->sinkpad); if (priv->sink_suggest) gst_caps_unref (priv->sink_suggest); priv->sink_suggest = gst_caps_ref (othercaps); priv->size_suggest = size_suggest; trans->priv->suggest_pending = TRUE; GST_OBJECT_UNLOCK (trans->sinkpad); } gst_caps_unref (othercaps); } if (in_buf != *out_buf) gst_buffer_unref (*out_buf); *out_buf = NULL; } } if (*out_buf == NULL) { if (!discard) { GST_DEBUG_OBJECT (trans, "make default output buffer of size %d", outsize); /* no valid buffer yet, make one */ *out_buf = gst_buffer_new_and_alloc (outsize); gst_buffer_copy_metadata (*out_buf, in_buf, GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS); } else { GST_DEBUG_OBJECT (trans, "reuse input buffer"); *out_buf = in_buf; } } else { if (trans->passthrough && in_buf != *out_buf) { /* we are asked to perform a passthrough transform but the input and * output buffers are different. We have to discard the output buffer and * reuse the input buffer. */ GST_DEBUG_OBJECT (trans, "passthrough but different buffers"); discard = TRUE; } if (discard) { GST_DEBUG_OBJECT (trans, "discard buffer, reuse input buffer"); gst_buffer_unref (*out_buf); *out_buf = in_buf; } else { GST_DEBUG_OBJECT (trans, "using allocated buffer"); gst_buffer_copy_metadata (*out_buf, in_buf, GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS); } } gst_buffer_set_caps (*out_buf, GST_PAD_CAPS (trans->srcpad)); /* clear the GAP flag when the subclass does not understand it */ if (!trans->priv->gap_aware) GST_BUFFER_FLAG_UNSET (*out_buf, GST_BUFFER_FLAG_GAP); return ret; /* ERRORS */ alloc_failed: { GST_WARNING_OBJECT (trans, "pad-alloc failed: %s", gst_flow_get_name (ret)); return ret; } no_buffer: { GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED, ("Sub-class failed to provide an output buffer"), (NULL)); return GST_FLOW_ERROR; } unknown_size: { GST_ERROR_OBJECT (trans, "unknown output size"); return GST_FLOW_ERROR; } failed_configure: { GST_WARNING_OBJECT (trans, "failed to configure caps"); return GST_FLOW_NOT_NEGOTIATED; } } /* Given @caps calcultate the size of one unit. * * For video caps, this is the size of one frame (and thus one buffer). * For audio caps, this is the size of one sample. * * These values are cached since they do not change and the calculation * potentially involves parsing caps and other expensive stuff. * * We have two cache locations to store the size, one for the source caps * and one for the sink caps. * * this function returns FALSE if no size could be calculated. */ static gboolean gst_base_transform_get_unit_size (GstBaseTransform * trans, GstCaps * caps, guint * size) { gboolean res = FALSE; GstBaseTransformClass *bclass; /* see if we have the result cached */ if (trans->cache_caps1 == caps) { *size = trans->cache_caps1_size; GST_DEBUG_OBJECT (trans, "returned %d from first cache", *size); return TRUE; } if (trans->cache_caps2 == caps) { *size = trans->cache_caps2_size; GST_DEBUG_OBJECT (trans, "returned %d from second cached", *size); return TRUE; } bclass = GST_BASE_TRANSFORM_GET_CLASS (trans); if (bclass->get_unit_size) { res = bclass->get_unit_size (trans, caps, size); GST_DEBUG_OBJECT (trans, "caps %" GST_PTR_FORMAT ") has unit size %d, result %s", caps, *size, res ? "TRUE" : "FALSE"); if (res) { /* and cache the values */ if (trans->cache_caps1 == NULL) { gst_caps_replace (&trans->cache_caps1, caps); trans->cache_caps1_size = *size; GST_DEBUG_OBJECT (trans, "caching %d in first cache", *size); } else if (trans->cache_caps2 == NULL) { gst_caps_replace (&trans->cache_caps2, caps); trans->cache_caps2_size = *size; GST_DEBUG_OBJECT (trans, "caching %d in second cache", *size); } else { GST_DEBUG_OBJECT (trans, "no free spot to cache unit_size"); } } } else { GST_DEBUG_OBJECT (trans, "Sub-class does not implement get_unit_size"); } return res; } /* your upstream peer wants to send you a buffer * that buffer has the given offset, size and caps * you're requested to allocate a buffer */ static GstFlowReturn gst_base_transform_buffer_alloc (GstPad * pad, guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf) { GstBaseTransform *trans; GstBaseTransformPrivate *priv; GstFlowReturn res; gboolean proxy, suggest, same_caps; GstCaps *sink_suggest; guint size_suggest; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); priv = trans->priv; GST_DEBUG_OBJECT (pad, "alloc with caps %" GST_PTR_FORMAT ", size %u", caps, size); /* if the code below does not come up with a better buffer, we will return _OK * and an empty buffer. This will trigger the core to allocate a buffer with * given input size and caps. */ *buf = NULL; res = GST_FLOW_OK; /* we remember our previous alloc request to quickly see if we can proxy or * not. We skip this check if we have a pending suggestion. */ GST_OBJECT_LOCK (pad); same_caps = !priv->suggest_pending && caps && gst_caps_is_equal (priv->sink_alloc, caps); GST_OBJECT_UNLOCK (pad); if (same_caps) { /* we have seen this before, see below if we need to proxy */ GST_DEBUG_OBJECT (trans, "have old caps"); sink_suggest = caps; size_suggest = size; suggest = FALSE; } else { GstCaps *temp; const GstCaps *templ; gboolean empty; GST_DEBUG_OBJECT (trans, "new format %" GST_PTR_FORMAT, caps); /* if we have a suggestion, pretend we got these as input */ GST_OBJECT_LOCK (pad); if ((priv->sink_suggest && !gst_caps_is_equal (caps, priv->sink_suggest))) { sink_suggest = gst_caps_ref (priv->sink_suggest); size_suggest = priv->size_suggest; GST_DEBUG_OBJECT (trans, "have suggestion %" GST_PTR_FORMAT, sink_suggest); /* suggest is TRUE when we have a custom suggestion pending that we need * to unref later. */ suggest = TRUE; } else { GST_DEBUG_OBJECT (trans, "using caps %" GST_PTR_FORMAT, caps); sink_suggest = caps; size_suggest = size; suggest = FALSE; } priv->suggest_pending = FALSE; GST_OBJECT_UNLOCK (pad); /* check if we actually handle this format on the sinkpad */ if (sink_suggest) { templ = gst_pad_get_pad_template_caps (pad); temp = gst_caps_intersect (sink_suggest, templ); empty = gst_caps_is_empty (temp); gst_caps_unref (temp); if (empty) goto not_supported; } /* find the best format for the other side here we decide if we will proxy * the caps or not. */ if (sink_suggest == NULL) { /* always proxy when the caps are NULL. When this is a new format, see if * we can proxy it downstream */ GST_DEBUG_OBJECT (trans, "null caps, marking for proxy"); priv->proxy_alloc = TRUE; } else { GstCaps *othercaps; /* we have a new format, see what we need to proxy to */ othercaps = gst_base_transform_find_transform (trans, pad, sink_suggest); if (!othercaps || gst_caps_is_empty (othercaps)) { /* no transform possible, we certainly can't proxy */ GST_DEBUG_OBJECT (trans, "can't find transform, disable proxy"); priv->proxy_alloc = FALSE; } else { /* we transformed into something */ if (gst_caps_is_equal (caps, othercaps)) { GST_DEBUG_OBJECT (trans, "best caps same as input, marking for proxy"); priv->proxy_alloc = TRUE; } else { GST_DEBUG_OBJECT (trans, "best caps different from input, disable proxy"); priv->proxy_alloc = FALSE; } } if (othercaps) gst_caps_unref (othercaps); } } /* remember the new caps */ GST_OBJECT_LOCK (pad); gst_caps_replace (&priv->sink_alloc, sink_suggest); GST_OBJECT_UNLOCK (pad); proxy = priv->proxy_alloc; GST_DEBUG_OBJECT (trans, "doing default alloc, proxy %d", proxy); /* we only want to proxy if we have no suggestion pending, FIXME */ if (proxy && !suggest) { GstCaps *newcaps; GST_DEBUG_OBJECT (trans, "proxy buffer-alloc with caps %" GST_PTR_FORMAT ", size %u", caps, size); /* we always proxy the input caps, never the suggestion. The reason is that * We don't yet handle the caps of renegotiation in here. FIXME */ res = gst_pad_alloc_buffer (trans->srcpad, offset, size, caps, buf); if (res != GST_FLOW_OK) goto alloc_failed; /* check if the caps changed */ newcaps = GST_BUFFER_CAPS (*buf); GST_DEBUG_OBJECT (trans, "got caps %" GST_PTR_FORMAT, newcaps); if (!gst_caps_is_equal (newcaps, caps)) { GST_DEBUG_OBJECT (trans, "caps are new"); /* we have new caps, see if we can proxy downstream */ if (gst_pad_peer_accept_caps (pad, newcaps)) { /* peer accepts the caps, return a buffer in this format */ GST_DEBUG_OBJECT (trans, "peer accepted new caps"); /* remember the format */ GST_OBJECT_LOCK (pad); gst_caps_replace (&priv->sink_alloc, newcaps); GST_OBJECT_UNLOCK (pad); } else { GST_DEBUG_OBJECT (trans, "peer did not accept new caps"); /* peer does not accept the caps, free the buffer we received and * create a buffer of the requested format by the default handler. */ gst_buffer_unref (*buf); *buf = NULL; } } else { GST_DEBUG_OBJECT (trans, "received required caps from peer"); } } if (suggest) { /* there was a custom suggestion, create a buffer of this format and return * it. Note that this format */ *buf = gst_buffer_new_and_alloc (size_suggest); GST_DEBUG_OBJECT (trans, "doing suggestion of size %u, caps %" GST_PTR_FORMAT, size_suggest, sink_suggest); GST_BUFFER_CAPS (*buf) = sink_suggest; } gst_object_unref (trans); return res; /* ERRORS */ alloc_failed: { GST_DEBUG_OBJECT (trans, "pad alloc failed: %s", gst_flow_get_name (res)); if (suggest) gst_caps_unref (sink_suggest); gst_object_unref (trans); return res; } not_supported: { GST_DEBUG_OBJECT (trans, "pad alloc with unsupported caps"); if (suggest) gst_caps_unref (sink_suggest); gst_object_unref (trans); return GST_FLOW_NOT_NEGOTIATED; } } static gboolean gst_base_transform_sink_event (GstPad * pad, GstEvent * event) { GstBaseTransform *trans; GstBaseTransformClass *bclass; gboolean ret = TRUE; gboolean forward = TRUE; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); bclass = GST_BASE_TRANSFORM_GET_CLASS (trans); if (bclass->event) forward = bclass->event (trans, event); /* FIXME, do this in the default event handler so the subclass can do * something different. */ if (forward) ret = gst_pad_push_event (trans->srcpad, event); else gst_event_unref (event); gst_object_unref (trans); return ret; } static gboolean gst_base_transform_sink_eventfunc (GstBaseTransform * trans, GstEvent * event) { switch (GST_EVENT_TYPE (event)) { case GST_EVENT_FLUSH_START: break; case GST_EVENT_FLUSH_STOP: GST_OBJECT_LOCK (trans); /* reset QoS parameters */ trans->priv->proportion = 1.0; trans->priv->earliest_time = -1; trans->priv->discont = FALSE; GST_OBJECT_UNLOCK (trans); /* we need new segment info after the flush. */ trans->have_newsegment = FALSE; gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED); break; case GST_EVENT_EOS: break; case GST_EVENT_TAG: break; case GST_EVENT_NEWSEGMENT: { GstFormat format; gdouble rate, arate; gint64 start, stop, time; gboolean update; gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format, &start, &stop, &time); trans->have_newsegment = TRUE; gst_segment_set_newsegment_full (&trans->segment, update, rate, arate, format, start, stop, time); if (format == GST_FORMAT_TIME) { GST_DEBUG_OBJECT (trans, "received TIME NEW_SEGMENT %" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT, GST_TIME_ARGS (trans->segment.start), GST_TIME_ARGS (trans->segment.stop), GST_TIME_ARGS (trans->segment.time), GST_TIME_ARGS (trans->segment.accum)); } else { GST_DEBUG_OBJECT (trans, "received NEW_SEGMENT %" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %" G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, trans->segment.start, trans->segment.stop, trans->segment.time, trans->segment.accum); } break; } default: break; } return TRUE; } static gboolean gst_base_transform_src_event (GstPad * pad, GstEvent * event) { GstBaseTransform *trans; GstBaseTransformClass *bclass; gboolean ret = TRUE; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); bclass = GST_BASE_TRANSFORM_GET_CLASS (trans); if (bclass->src_event) ret = bclass->src_event (trans, event); gst_object_unref (trans); return ret; } static gboolean gst_base_transform_src_eventfunc (GstBaseTransform * trans, GstEvent * event) { gboolean ret; switch (GST_EVENT_TYPE (event)) { case GST_EVENT_SEEK: break; case GST_EVENT_NAVIGATION: break; case GST_EVENT_QOS: { gdouble proportion; GstClockTimeDiff diff; GstClockTime timestamp; gst_event_parse_qos (event, &proportion, &diff, ×tamp); gst_base_transform_update_qos (trans, proportion, diff, timestamp); break; } default: break; } ret = gst_pad_push_event (trans->sinkpad, event); return ret; } /* perform a transform on @inbuf and put the result in @outbuf. * * This function is common to the push and pull-based operations. * * This function takes ownership of @inbuf */ static GstFlowReturn gst_base_transform_handle_buffer (GstBaseTransform * trans, GstBuffer * inbuf, GstBuffer ** outbuf) { GstBaseTransformClass *bclass; GstFlowReturn ret = GST_FLOW_OK; gboolean want_in_place, reconfigure; GstClockTime qostime; GstCaps *incaps; bclass = GST_BASE_TRANSFORM_GET_CLASS (trans); if (G_LIKELY ((incaps = GST_BUFFER_CAPS (inbuf)))) { GST_OBJECT_LOCK (trans); reconfigure = trans->priv->reconfigure; trans->priv->reconfigure = FALSE; GST_OBJECT_UNLOCK (trans); if (G_UNLIKELY (reconfigure)) { GST_DEBUG_OBJECT (trans, "we had a pending reconfigure"); /* if we need to reconfigure we pretend a buffer with new caps arrived. This * will reconfigure the transform with the new output format. We can only * do this if the buffer actually has caps. */ if (!gst_base_transform_setcaps (trans->sinkpad, incaps)) goto not_negotiated; } } if (GST_BUFFER_OFFSET_IS_VALID (inbuf)) GST_DEBUG_OBJECT (trans, "handling buffer %p of size %d and offset %" G_GUINT64_FORMAT, inbuf, GST_BUFFER_SIZE (inbuf), GST_BUFFER_OFFSET (inbuf)); else GST_DEBUG_OBJECT (trans, "handling buffer %p of size %d and offset NONE", inbuf, GST_BUFFER_SIZE (inbuf)); /* Don't allow buffer handling before negotiation, except in passthrough mode * or if the class doesn't implement a set_caps function (in which case it doesn't * care about caps) */ if (!trans->negotiated && !trans->passthrough && (bclass->set_caps != NULL)) goto not_negotiated; /* Set discont flag so we can mark the outgoing buffer */ if (GST_BUFFER_IS_DISCONT (inbuf)) { GST_DEBUG_OBJECT (trans, "got DISCONT buffer %p", inbuf); trans->priv->discont = TRUE; } /* can only do QoS if the segment is in TIME */ if (trans->segment.format != GST_FORMAT_TIME) goto no_qos; /* QOS is done on the running time of the buffer, get it now */ qostime = gst_segment_to_running_time (&trans->segment, GST_FORMAT_TIME, GST_BUFFER_TIMESTAMP (inbuf)); if (qostime != -1) { gboolean need_skip; GstClockTime earliest_time; /* lock for getting the QoS parameters that are set (in a different thread) * with the QOS events */ GST_OBJECT_LOCK (trans); earliest_time = trans->priv->earliest_time; /* check for QoS, don't perform conversion for buffers * that are known to be late. */ need_skip = trans->priv->qos_enabled && earliest_time != -1 && qostime != -1 && qostime <= earliest_time; GST_OBJECT_UNLOCK (trans); if (need_skip) { GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "skipping transform: qostime %" GST_TIME_FORMAT " <= %" GST_TIME_FORMAT, GST_TIME_ARGS (qostime), GST_TIME_ARGS (earliest_time)); /* mark discont for next buffer */ trans->priv->discont = TRUE; goto skip; } } no_qos: /* first try to allocate an output buffer based on the currently negotiated * format. While we call pad-alloc we could renegotiate the srcpad format or * have a new suggestion for upstream buffer-alloc. * In any case, outbuf will contain a buffer suitable for doing the configured * transform after this function. */ ret = gst_base_transform_prepare_output_buffer (trans, inbuf, outbuf); if (G_UNLIKELY (ret != GST_FLOW_OK)) goto no_buffer; /* now perform the needed transform */ if (trans->passthrough) { /* In passthrough mode, give transform_ip a look at the * buffer, without making it writable, or just push the * data through */ if (bclass->transform_ip) { GST_DEBUG_OBJECT (trans, "doing passthrough transform"); ret = bclass->transform_ip (trans, *outbuf); } else { GST_DEBUG_OBJECT (trans, "element is in passthrough"); } } else { want_in_place = (bclass->transform_ip != NULL) && trans->always_in_place; if (want_in_place) { GST_DEBUG_OBJECT (trans, "doing inplace transform"); if (inbuf != *outbuf) { /* different buffers, copy the input to the output first, we then do an * in-place transform on the output buffer. */ memcpy (GST_BUFFER_DATA (*outbuf), GST_BUFFER_DATA (inbuf), GST_BUFFER_SIZE (inbuf)); } ret = bclass->transform_ip (trans, *outbuf); } else { GST_DEBUG_OBJECT (trans, "doing non-inplace transform"); if (bclass->transform) ret = bclass->transform (trans, inbuf, *outbuf); else ret = GST_FLOW_NOT_SUPPORTED; } } skip: /* only unref input buffer if we allocated a new outbuf buffer */ if (*outbuf != inbuf) gst_buffer_unref (inbuf); return ret; /* ERRORS */ not_negotiated: { gst_buffer_unref (inbuf); GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED, ("not negotiated"), ("not negotiated")); return GST_FLOW_NOT_NEGOTIATED; } no_buffer: { gst_buffer_unref (inbuf); GST_WARNING_OBJECT (trans, "could not get buffer from pool: %s", gst_flow_get_name (ret)); return ret; } } static gboolean gst_base_transform_check_get_range (GstPad * pad) { GstBaseTransform *trans; gboolean ret; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); ret = gst_pad_check_pull_range (trans->sinkpad); gst_object_unref (trans); return ret; } /* FIXME, getrange is broken, need to pull range from the other * end based on the transform_size result. */ static GstFlowReturn gst_base_transform_getrange (GstPad * pad, guint64 offset, guint length, GstBuffer ** buffer) { GstBaseTransform *trans; GstFlowReturn ret; GstBuffer *inbuf; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); ret = gst_pad_pull_range (trans->sinkpad, offset, length, &inbuf); if (ret == GST_FLOW_OK) { GST_BASE_TRANSFORM_LOCK (trans); ret = gst_base_transform_handle_buffer (trans, inbuf, buffer); GST_BASE_TRANSFORM_UNLOCK (trans); } gst_object_unref (trans); return ret; } static GstFlowReturn gst_base_transform_chain (GstPad * pad, GstBuffer * buffer) { GstBaseTransform *trans; GstFlowReturn ret; GstClockTime last_stop = GST_CLOCK_TIME_NONE; GstBuffer *outbuf = NULL; trans = GST_BASE_TRANSFORM (GST_OBJECT_PARENT (pad)); /* calculate end position of the incoming buffer */ if (GST_BUFFER_TIMESTAMP (buffer) != GST_CLOCK_TIME_NONE) { if (GST_BUFFER_DURATION (buffer) != GST_CLOCK_TIME_NONE) last_stop = GST_BUFFER_TIMESTAMP (buffer) + GST_BUFFER_DURATION (buffer); else last_stop = GST_BUFFER_TIMESTAMP (buffer); } /* protect transform method and concurrent buffer alloc */ GST_BASE_TRANSFORM_LOCK (trans); ret = gst_base_transform_handle_buffer (trans, buffer, &outbuf); GST_BASE_TRANSFORM_UNLOCK (trans); /* outbuf can be NULL, this means a dropped buffer, if we have a buffer but * GST_BASE_TRANSFORM_FLOW_DROPPED we will not push either. */ if (outbuf != NULL) { if ((ret == GST_FLOW_OK)) { /* Remember last stop position */ if ((last_stop != GST_CLOCK_TIME_NONE) && (trans->segment.format == GST_FORMAT_TIME)) gst_segment_set_last_stop (&trans->segment, GST_FORMAT_TIME, last_stop); /* apply DISCONT flag if the buffer is not yet marked as such */ if (trans->priv->discont) { if (!GST_BUFFER_IS_DISCONT (outbuf)) { outbuf = gst_buffer_make_metadata_writable (outbuf); GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT); } trans->priv->discont = FALSE; } ret = gst_pad_push (trans->srcpad, outbuf); } else gst_buffer_unref (outbuf); } /* convert internal flow to OK and mark discont for the next buffer. */ if (ret == GST_BASE_TRANSFORM_FLOW_DROPPED) { trans->priv->discont = TRUE; ret = GST_FLOW_OK; } return ret; } static void gst_base_transform_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec) { GstBaseTransform *trans; trans = GST_BASE_TRANSFORM (object); switch (prop_id) { case PROP_QOS: gst_base_transform_set_qos_enabled (trans, g_value_get_boolean (value)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void gst_base_transform_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec) { GstBaseTransform *trans; trans = GST_BASE_TRANSFORM (object); switch (prop_id) { case PROP_QOS: g_value_set_boolean (value, gst_base_transform_is_qos_enabled (trans)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } /* not a vmethod of anything, just an internal method */ static gboolean gst_base_transform_activate (GstBaseTransform * trans, gboolean active) { GstBaseTransformClass *bclass; gboolean result = TRUE; bclass = GST_BASE_TRANSFORM_GET_CLASS (trans); if (active) { if (trans->priv->pad_mode == GST_ACTIVATE_NONE && bclass->start) result &= bclass->start (trans); GST_OBJECT_LOCK (trans); if (GST_PAD_CAPS (trans->sinkpad) && GST_PAD_CAPS (trans->srcpad)) trans->have_same_caps = gst_caps_is_equal (GST_PAD_CAPS (trans->sinkpad), GST_PAD_CAPS (trans->srcpad)) || trans->passthrough; else trans->have_same_caps = trans->passthrough; GST_DEBUG_OBJECT (trans, "have_same_caps %d", trans->have_same_caps); trans->negotiated = FALSE; trans->have_newsegment = FALSE; gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED); trans->priv->proportion = 1.0; trans->priv->earliest_time = -1; trans->priv->discont = FALSE; gst_caps_replace (&trans->priv->sink_suggest, NULL); GST_OBJECT_UNLOCK (trans); } else { /* We must make sure streaming has finished before resetting things * and calling the ::stop vfunc */ GST_PAD_STREAM_LOCK (trans->sinkpad); GST_PAD_STREAM_UNLOCK (trans->sinkpad); trans->have_same_caps = FALSE; /* We can only reset the passthrough mode if the instance told us to handle it in configure_caps */ if (bclass->passthrough_on_same_caps) { gst_base_transform_set_passthrough (trans, FALSE); } gst_caps_replace (&trans->cache_caps1, NULL); gst_caps_replace (&trans->cache_caps2, NULL); gst_caps_replace (&trans->priv->sink_alloc, NULL); gst_caps_replace (&trans->priv->sink_suggest, NULL); if (trans->priv->pad_mode != GST_ACTIVATE_NONE && bclass->stop) result &= bclass->stop (trans); } return result; } static gboolean gst_base_transform_sink_activate_push (GstPad * pad, gboolean active) { gboolean result = TRUE; GstBaseTransform *trans; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); result = gst_base_transform_activate (trans, active); if (result) trans->priv->pad_mode = active ? GST_ACTIVATE_PUSH : GST_ACTIVATE_NONE; gst_object_unref (trans); return result; } static gboolean gst_base_transform_src_activate_pull (GstPad * pad, gboolean active) { gboolean result = FALSE; GstBaseTransform *trans; trans = GST_BASE_TRANSFORM (gst_pad_get_parent (pad)); result = gst_pad_activate_pull (trans->sinkpad, active); if (result) result &= gst_base_transform_activate (trans, active); if (result) trans->priv->pad_mode = active ? GST_ACTIVATE_PULL : GST_ACTIVATE_NONE; gst_object_unref (trans); return result; } /** * gst_base_transform_set_passthrough: * @trans: the #GstBaseTransform to set * @passthrough: boolean indicating passthrough mode. * * Set passthrough mode for this filter by default. This is mostly * useful for filters that do not care about negotiation. * * Always TRUE for filters which don't implement either a transform * or transform_ip method. * * MT safe. */ void gst_base_transform_set_passthrough (GstBaseTransform * trans, gboolean passthrough) { GstBaseTransformClass *bclass; g_return_if_fail (GST_IS_BASE_TRANSFORM (trans)); bclass = GST_BASE_TRANSFORM_GET_CLASS (trans); GST_OBJECT_LOCK (trans); if (passthrough == FALSE) { if (bclass->transform_ip || bclass->transform) trans->passthrough = FALSE; } else { trans->passthrough = TRUE; } GST_DEBUG_OBJECT (trans, "set passthrough %d", trans->passthrough); GST_OBJECT_UNLOCK (trans); } /** * gst_base_transform_is_passthrough: * @trans: the #GstBaseTransform to query * * See if @trans is configured as a passthrough transform. * * Returns: TRUE is the transform is configured in passthrough mode. * * MT safe. */ gboolean gst_base_transform_is_passthrough (GstBaseTransform * trans) { gboolean result; g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE); GST_OBJECT_LOCK (trans); result = trans->passthrough; GST_OBJECT_UNLOCK (trans); return result; } /** * gst_base_transform_set_in_place: * @trans: the #GstBaseTransform to modify * @in_place: Boolean value indicating that we would like to operate * on in_place buffers. * * Determines whether a non-writable buffer will be copied before passing * to the transform_ip function. * * Always TRUE if no transform function is implemented. * Always FALSE if ONLY transform function is implemented. * * * MT safe. */ void gst_base_transform_set_in_place (GstBaseTransform * trans, gboolean in_place) { GstBaseTransformClass *bclass; g_return_if_fail (GST_IS_BASE_TRANSFORM (trans)); bclass = GST_BASE_TRANSFORM_GET_CLASS (trans); GST_OBJECT_LOCK (trans); if (in_place) { if (bclass->transform_ip) { GST_DEBUG_OBJECT (trans, "setting in_place TRUE"); trans->always_in_place = TRUE; } } else { if (bclass->transform) { GST_DEBUG_OBJECT (trans, "setting in_place FALSE"); trans->always_in_place = FALSE; } } GST_OBJECT_UNLOCK (trans); } /** * gst_base_transform_is_in_place: * @trans: the #GstBaseTransform to query * * See if @trans is configured as a in_place transform. * * Returns: TRUE is the transform is configured in in_place mode. * * MT safe. */ gboolean gst_base_transform_is_in_place (GstBaseTransform * trans) { gboolean result; g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE); GST_OBJECT_LOCK (trans); result = trans->always_in_place; GST_OBJECT_UNLOCK (trans); return result; } /** * gst_base_transform_update_qos: * @trans: a #GstBaseTransform * @proportion: the proportion * @diff: the diff against the clock * @timestamp: the timestamp of the buffer generating the QoS expressed in * running_time. * * Set the QoS parameters in the transform. This function is called internally * when a QOS event is received but subclasses can provide custom information * when needed. * * MT safe. * * Since: 0.10.5 */ void gst_base_transform_update_qos (GstBaseTransform * trans, gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp) { g_return_if_fail (GST_IS_BASE_TRANSFORM (trans)); GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %" GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (timestamp)); GST_OBJECT_LOCK (trans); trans->priv->proportion = proportion; trans->priv->earliest_time = timestamp + diff; GST_OBJECT_UNLOCK (trans); } /** * gst_base_transform_set_qos_enabled: * @trans: a #GstBaseTransform * @enabled: new state * * Enable or disable QoS handling in the transform. * * MT safe. * * Since: 0.10.5 */ void gst_base_transform_set_qos_enabled (GstBaseTransform * trans, gboolean enabled) { g_return_if_fail (GST_IS_BASE_TRANSFORM (trans)); GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "enabled: %d", enabled); GST_OBJECT_LOCK (trans); trans->priv->qos_enabled = enabled; GST_OBJECT_UNLOCK (trans); } /** * gst_base_transform_is_qos_enabled: * @trans: a #GstBaseTransform * * Queries if the transform will handle QoS. * * Returns: TRUE if QoS is enabled. * * MT safe. * * Since: 0.10.5 */ gboolean gst_base_transform_is_qos_enabled (GstBaseTransform * trans) { gboolean result; g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE); GST_OBJECT_LOCK (trans); result = trans->priv->qos_enabled; GST_OBJECT_UNLOCK (trans); return result; } /** * gst_base_transform_set_gap_aware: * @trans: a #GstBaseTransform * @gap_aware: New state * * If @gap_aware is %FALSE (the default), output buffers will have the * %GST_BUFFER_FLAG_GAP flag unset. * * If set to %TRUE, the element must handle output buffers with this flag set * correctly, i.e. it can assume that the buffer contains neutral data but must * unset the flag if the output is no neutral data. * * MT safe. * * Since: 0.10.16 */ void gst_base_transform_set_gap_aware (GstBaseTransform * trans, gboolean gap_aware) { g_return_if_fail (GST_IS_BASE_TRANSFORM (trans)); GST_OBJECT_LOCK (trans); trans->priv->gap_aware = gap_aware; GST_DEBUG_OBJECT (trans, "set gap aware %d", trans->priv->gap_aware); GST_OBJECT_UNLOCK (trans); } /** * gst_base_transform_suggest: * @trans: a #GstBaseTransform * @caps: caps to suggest * @size: buffer size to suggest * * Instructs @trans to suggest new @caps upstream. A copy of @caps will be * taken. * * Since: 0.10.21 */ void gst_base_transform_suggest (GstBaseTransform * trans, GstCaps * caps, guint size) { g_return_if_fail (GST_IS_BASE_TRANSFORM (trans)); GST_OBJECT_LOCK (trans->sinkpad); if (trans->priv->sink_suggest) gst_caps_unref (trans->priv->sink_suggest); if (caps) caps = gst_caps_copy (caps); trans->priv->sink_suggest = caps; trans->priv->size_suggest = size; trans->priv->suggest_pending = TRUE; GST_DEBUG_OBJECT (trans, "new suggest %" GST_PTR_FORMAT, caps); GST_OBJECT_UNLOCK (trans->sinkpad); } /** * gst_base_transform_reconfigure: * @trans: a #GstBaseTransform * * Instructs @trans to renegotiate a new downstream transform on the next * buffer. This function is typically called after properties on the transform * were set that influence the output format. * * Since: 0.10.21 */ void gst_base_transform_reconfigure (GstBaseTransform * trans) { g_return_if_fail (GST_IS_BASE_TRANSFORM (trans)); GST_OBJECT_LOCK (trans); GST_DEBUG_OBJECT (trans, "marking reconfigure"); trans->priv->reconfigure = TRUE; GST_OBJECT_UNLOCK (trans); }