2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2005 Wim Taymans <wim@fluendo.com>
4 * 2005 Andy Wingo <wingo@fluendo.com>
5 * 2005 Thomas Vander Stichele <thomas at apestaart dot org>
6 * 2008 Wim Taymans <wim.taymans@gmail.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
25 * SECTION:gstbasetransform
26 * @short_description: Base class for simple transform filters
27 * @see_also: #GstBaseSrc, #GstBaseSink
29 * This base class is for filter elements that process data.
33 * <listitem><para>one sinkpad and one srcpad</para></listitem>
35 * Possible formats on sink and source pad implemented
36 * with custom transform_caps function. By default uses
37 * same format on sink and source.
39 * <listitem><para>Handles state changes</para></listitem>
40 * <listitem><para>Does flushing</para></listitem>
41 * <listitem><para>Push mode</para></listitem>
43 * Pull mode if the sub-class transform can operate on arbitrary data
48 * <title>Use Cases</title>
52 * <itemizedlist><title>Passthrough mode</title>
54 * Element has no interest in modifying the buffer. It may want to inspect it,
55 * in which case the element should have a transform_ip function. If there
56 * is no transform_ip function in passthrough mode, the buffer is pushed
60 * On the GstBaseTransformClass is the passthrough_on_same_caps variable
61 * which will automatically set/unset passthrough based on whether the
62 * element negotiates the same caps on both pads.
65 * passthrough_on_same_caps on an element that doesn't implement a
66 * transform_caps function is useful for elements that only inspect data
71 * <title>Example elements</title>
72 * <listitem>Level</listitem>
73 * <listitem>Videoscale, audioconvert, ffmpegcolorspace, audioresample in
74 * certain modes.</listitem>
79 * <title>Modifications in-place - input buffer and output buffer are the
82 * The element must implement a transform_ip function.
85 * Output buffer size must <= input buffer size
88 * If the always_in_place flag is set, non-writable buffers will be copied
89 * and passed to the transform_ip function, otherwise a new buffer will be
90 * created and the transform function called.
93 * Incoming writable buffers will be passed to the transform_ip function
94 * immediately. </para></listitem>
96 * only implementing transform_ip and not transform implies always_in_place
101 * <title>Example elements</title>
102 * <listitem>Volume</listitem>
103 * <listitem>Audioconvert in certain modes (signed/unsigned
104 * conversion)</listitem>
105 * <listitem>ffmpegcolorspace in certain modes (endianness
106 * swapping)</listitem>
111 * <title>Modifications only to the caps/metadata of a buffer</title>
113 * The element does not require writable data, but non-writable buffers
114 * should be subbuffered so that the meta-information can be replaced.
117 * Elements wishing to operate in this mode should replace the
118 * prepare_output_buffer method to create subbuffers of the input buffer
119 * and set always_in_place to TRUE
123 * <title>Example elements</title>
124 * <listitem>Capsfilter when setting caps on outgoing buffers that have
126 * <listitem>identity when it is going to re-timestamp buffers by
127 * datarate.</listitem>
131 * <itemizedlist><title>Normal mode</title>
133 * always_in_place flag is not set, or there is no transform_ip function
136 * Element will receive an input buffer and output buffer to operate on.
139 * Output buffer is allocated by calling the prepare_output_buffer function.
143 * <title>Example elements</title>
144 * <listitem>Videoscale, ffmpegcolorspace, audioconvert when doing
145 * scaling/conversions</listitem>
149 * <itemizedlist><title>Special output buffer allocations</title>
151 * Elements which need to do special allocation of their output buffers
152 * other than what gst_buffer_pad_alloc allows should implement a
153 * prepare_output_buffer method, which calls the parent implementation and
154 * passes the newly allocated buffer.
158 * <title>Example elements</title>
159 * <listitem>efence</listitem>
166 * <title>Sub-class settable flags on GstBaseTransform</title>
170 * <itemizedlist><title>passthrough</title>
172 * Implies that in the current configuration, the sub-class is not
173 * interested in modifying the buffers.
176 * Elements which are always in passthrough mode whenever the same caps
177 * has been negotiated on both pads can set the class variable
178 * passthrough_on_same_caps to have this behaviour automatically.
183 * <itemizedlist><title>always_in_place</title>
185 * Determines whether a non-writable buffer will be copied before passing
186 * to the transform_ip function.
189 * Implied TRUE if no transform function is implemented.
192 * Implied FALSE if ONLY transform function is implemented.
208 #include "../../../gst/gst_private.h"
209 #include "../../../gst/gst-i18n-lib.h"
210 #include "../../../gst/glib-compat-private.h"
211 #include "gstbasetransform.h"
212 #include <gst/gstmarshal.h>
214 GST_DEBUG_CATEGORY_STATIC (gst_base_transform_debug);
215 #define GST_CAT_DEFAULT gst_base_transform_debug
217 /* BaseTransform signals and args */
224 #define DEFAULT_PROP_QOS FALSE
232 #define GST_BASE_TRANSFORM_GET_PRIVATE(obj) \
233 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_TRANSFORM, GstBaseTransformPrivate))
235 struct _GstBaseTransformPrivate
237 /* QoS *//* with LOCK */
238 gboolean qos_enabled;
240 GstClockTime earliest_time;
241 /* previous buffer had a discont */
248 gboolean reconfigure;
254 GstClockTime position_out;
257 GstAllocator *allocator;
263 static GstElementClass *parent_class = NULL;
265 static void gst_base_transform_class_init (GstBaseTransformClass * klass);
266 static void gst_base_transform_init (GstBaseTransform * trans,
267 GstBaseTransformClass * klass);
269 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
270 * method to get to the padtemplates */
272 gst_base_transform_get_type (void)
274 static volatile gsize base_transform_type = 0;
276 if (g_once_init_enter (&base_transform_type)) {
278 static const GTypeInfo base_transform_info = {
279 sizeof (GstBaseTransformClass),
282 (GClassInitFunc) gst_base_transform_class_init,
285 sizeof (GstBaseTransform),
287 (GInstanceInitFunc) gst_base_transform_init,
290 _type = g_type_register_static (GST_TYPE_ELEMENT,
291 "GstBaseTransform", &base_transform_info, G_TYPE_FLAG_ABSTRACT);
292 g_once_init_leave (&base_transform_type, _type);
294 return base_transform_type;
297 static void gst_base_transform_finalize (GObject * object);
298 static void gst_base_transform_set_property (GObject * object, guint prop_id,
299 const GValue * value, GParamSpec * pspec);
300 static void gst_base_transform_get_property (GObject * object, guint prop_id,
301 GValue * value, GParamSpec * pspec);
302 static gboolean gst_base_transform_src_activate_mode (GstPad * pad,
303 GstObject * parent, GstPadMode mode, gboolean active);
304 static gboolean gst_base_transform_sink_activate_mode (GstPad * pad,
305 GstObject * parent, GstPadMode mode, gboolean active);
306 static gboolean gst_base_transform_activate (GstBaseTransform * trans,
308 static gboolean gst_base_transform_get_unit_size (GstBaseTransform * trans,
309 GstCaps * caps, gsize * size);
311 static gboolean gst_base_transform_src_event (GstPad * pad, GstObject * parent,
313 static gboolean gst_base_transform_src_eventfunc (GstBaseTransform * trans,
315 static gboolean gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
317 static gboolean gst_base_transform_sink_eventfunc (GstBaseTransform * trans,
319 static GstFlowReturn gst_base_transform_getrange (GstPad * pad,
320 GstObject * parent, guint64 offset, guint length, GstBuffer ** buffer);
321 static GstFlowReturn gst_base_transform_chain (GstPad * pad, GstObject * parent,
323 static GstCaps *gst_base_transform_default_transform_caps (GstBaseTransform *
324 trans, GstPadDirection direction, GstCaps * caps, GstCaps * filter);
325 static void gst_base_transform_default_fixate (GstBaseTransform * trans,
326 GstPadDirection direction, GstCaps * caps, GstCaps * othercaps);
327 static GstCaps *gst_base_transform_query_caps (GstBaseTransform * trans,
328 GstPad * pad, GstCaps * filter);
329 static gboolean gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
330 GstPadDirection direction, GstCaps * caps);
331 static gboolean gst_base_transform_setcaps (GstBaseTransform * trans,
332 GstPad * pad, GstCaps * caps);
333 static gboolean gst_base_transform_query (GstPad * pad, GstObject * parent,
335 static gboolean gst_base_transform_default_query (GstBaseTransform * trans,
336 GstPadDirection direction, GstQuery * query);
337 static gboolean gst_base_transform_default_transform_size (GstBaseTransform *
338 trans, GstPadDirection direction, GstCaps * caps, gsize size,
339 GstCaps * othercaps, gsize * othersize);
341 static GstFlowReturn default_prepare_output_buffer (GstBaseTransform * trans,
342 GstBuffer * inbuf, GstBuffer ** outbuf);
343 static gboolean default_copy_metadata (GstBaseTransform * trans,
344 GstBuffer * inbuf, GstBuffer * outbuf);
346 /* static guint gst_base_transform_signals[LAST_SIGNAL] = { 0 }; */
350 gst_base_transform_finalize (GObject * object)
352 GstBaseTransform *trans;
354 trans = GST_BASE_TRANSFORM (object);
356 g_mutex_clear (&trans->transform_lock);
358 G_OBJECT_CLASS (parent_class)->finalize (object);
362 gst_base_transform_class_init (GstBaseTransformClass * klass)
364 GObjectClass *gobject_class;
366 gobject_class = G_OBJECT_CLASS (klass);
368 GST_DEBUG_CATEGORY_INIT (gst_base_transform_debug, "basetransform", 0,
369 "basetransform element");
371 GST_DEBUG ("gst_base_transform_class_init");
373 g_type_class_add_private (klass, sizeof (GstBaseTransformPrivate));
375 parent_class = g_type_class_peek_parent (klass);
377 gobject_class->set_property = gst_base_transform_set_property;
378 gobject_class->get_property = gst_base_transform_get_property;
380 g_object_class_install_property (gobject_class, PROP_QOS,
381 g_param_spec_boolean ("qos", "QoS", "Handle Quality-of-Service events",
382 DEFAULT_PROP_QOS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
384 gobject_class->finalize = gst_base_transform_finalize;
386 klass->passthrough_on_same_caps = FALSE;
388 klass->transform_caps =
389 GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_caps);
390 klass->fixate_caps = GST_DEBUG_FUNCPTR (gst_base_transform_default_fixate);
392 GST_DEBUG_FUNCPTR (gst_base_transform_acceptcaps_default);
393 klass->query = GST_DEBUG_FUNCPTR (gst_base_transform_default_query);
394 klass->transform_size =
395 GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_size);
397 klass->sink_event = GST_DEBUG_FUNCPTR (gst_base_transform_sink_eventfunc);
398 klass->src_event = GST_DEBUG_FUNCPTR (gst_base_transform_src_eventfunc);
399 klass->prepare_output_buffer =
400 GST_DEBUG_FUNCPTR (default_prepare_output_buffer);
401 klass->copy_metadata = GST_DEBUG_FUNCPTR (default_copy_metadata);
405 gst_base_transform_init (GstBaseTransform * trans,
406 GstBaseTransformClass * bclass)
408 GstPadTemplate *pad_template;
410 GST_DEBUG ("gst_base_transform_init");
412 trans->priv = GST_BASE_TRANSFORM_GET_PRIVATE (trans);
415 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
416 g_return_if_fail (pad_template != NULL);
417 trans->sinkpad = gst_pad_new_from_template (pad_template, "sink");
418 gst_pad_set_event_function (trans->sinkpad,
419 GST_DEBUG_FUNCPTR (gst_base_transform_sink_event));
420 gst_pad_set_chain_function (trans->sinkpad,
421 GST_DEBUG_FUNCPTR (gst_base_transform_chain));
422 gst_pad_set_activatemode_function (trans->sinkpad,
423 GST_DEBUG_FUNCPTR (gst_base_transform_sink_activate_mode));
424 gst_pad_set_query_function (trans->sinkpad,
425 GST_DEBUG_FUNCPTR (gst_base_transform_query));
426 gst_element_add_pad (GST_ELEMENT (trans), trans->sinkpad);
429 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
430 g_return_if_fail (pad_template != NULL);
431 trans->srcpad = gst_pad_new_from_template (pad_template, "src");
432 gst_pad_set_event_function (trans->srcpad,
433 GST_DEBUG_FUNCPTR (gst_base_transform_src_event));
434 gst_pad_set_getrange_function (trans->srcpad,
435 GST_DEBUG_FUNCPTR (gst_base_transform_getrange));
436 gst_pad_set_activatemode_function (trans->srcpad,
437 GST_DEBUG_FUNCPTR (gst_base_transform_src_activate_mode));
438 gst_pad_set_query_function (trans->srcpad,
439 GST_DEBUG_FUNCPTR (gst_base_transform_query));
440 gst_element_add_pad (GST_ELEMENT (trans), trans->srcpad);
442 g_mutex_init (&trans->transform_lock);
443 trans->priv->qos_enabled = DEFAULT_PROP_QOS;
444 trans->cache_caps1 = NULL;
445 trans->cache_caps2 = NULL;
446 trans->priv->pad_mode = GST_PAD_MODE_NONE;
447 trans->priv->gap_aware = FALSE;
449 trans->passthrough = FALSE;
450 if (bclass->transform == NULL) {
451 /* If no transform function, always_in_place is TRUE */
452 GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
453 trans->always_in_place = TRUE;
455 if (bclass->transform_ip == NULL) {
456 GST_DEBUG_OBJECT (trans, "setting passthrough TRUE");
457 trans->passthrough = TRUE;
461 trans->priv->processed = 0;
462 trans->priv->dropped = 0;
466 gst_base_transform_default_transform_caps (GstBaseTransform * trans,
467 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
471 GST_DEBUG_OBJECT (trans, "identity from: %" GST_PTR_FORMAT, caps);
472 /* no transform function, use the identity transform */
474 ret = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
476 ret = gst_caps_ref (caps);
481 /* given @caps on the src or sink pad (given by @direction)
482 * calculate the possible caps on the other pad.
484 * Returns new caps, unref after usage.
487 gst_base_transform_transform_caps (GstBaseTransform * trans,
488 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
491 GstBaseTransformClass *klass;
496 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
498 /* if there is a custom transform function, use this */
499 if (klass->transform_caps) {
500 GST_DEBUG_OBJECT (trans, "transform caps (direction = %d)", direction);
502 GST_LOG_OBJECT (trans, "from: %" GST_PTR_FORMAT, caps);
503 ret = klass->transform_caps (trans, direction, caps, filter);
504 GST_LOG_OBJECT (trans, " to: %" GST_PTR_FORMAT, ret);
506 #ifndef G_DISABLE_ASSERT
508 if (!gst_caps_is_subset (ret, filter)) {
509 GstCaps *intersection;
511 GST_ERROR_OBJECT (trans,
512 "transform_caps returned caps %" GST_PTR_FORMAT
513 " which are not a real subset of the filter caps %"
514 GST_PTR_FORMAT, ret, filter);
515 g_warning ("%s: transform_caps returned caps which are not a real "
516 "subset of the filter caps", GST_ELEMENT_NAME (trans));
519 gst_caps_intersect_full (filter, ret, GST_CAPS_INTERSECT_FIRST);
520 gst_caps_unref (ret);
527 GST_DEBUG_OBJECT (trans, "to: %" GST_PTR_FORMAT, ret);
533 gst_base_transform_default_transform_size (GstBaseTransform * trans,
534 GstPadDirection direction, GstCaps * caps, gsize size,
535 GstCaps * othercaps, gsize * othersize)
537 gsize inunitsize, outunitsize, units;
538 GstBaseTransformClass *klass;
540 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
542 if (klass->get_unit_size == NULL) {
543 /* if there is no transform_size and no unit_size, it means the
544 * element does not modify the size of a buffer */
547 /* there is no transform_size function, we have to use the unit_size
548 * functions. This method assumes there is a fixed unit_size associated with
549 * each caps. We provide the same amount of units on both sides. */
550 if (!gst_base_transform_get_unit_size (trans, caps, &inunitsize))
553 GST_DEBUG_OBJECT (trans,
554 "input size %" G_GSIZE_FORMAT ", input unit size %" G_GSIZE_FORMAT,
557 /* input size must be a multiple of the unit_size of the input caps */
558 if (inunitsize == 0 || (size % inunitsize != 0))
561 /* get the amount of units */
562 units = size / inunitsize;
564 /* now get the unit size of the output */
565 if (!gst_base_transform_get_unit_size (trans, othercaps, &outunitsize))
568 /* the output size is the unit_size times the amount of units on the
570 *othersize = units * outunitsize;
571 GST_DEBUG_OBJECT (trans, "transformed size to %" G_GSIZE_FORMAT,
579 GST_DEBUG_OBJECT (trans, "could not get in_size");
580 g_warning ("%s: could not get in_size", GST_ELEMENT_NAME (trans));
585 GST_DEBUG_OBJECT (trans, "Size %" G_GSIZE_FORMAT " is not a multiple of"
586 "unit size %" G_GSIZE_FORMAT, size, inunitsize);
587 g_warning ("%s: size %" G_GSIZE_FORMAT " is not a multiple of unit size %"
588 G_GSIZE_FORMAT, GST_ELEMENT_NAME (trans), size, inunitsize);
593 GST_DEBUG_OBJECT (trans, "could not get out_size");
594 g_warning ("%s: could not get out_size", GST_ELEMENT_NAME (trans));
599 /* transform a buffer of @size with @caps on the pad with @direction to
600 * the size of a buffer with @othercaps and store the result in @othersize
602 * We have two ways of doing this:
603 * 1) use a custom transform size function, this is for complicated custom
604 * cases with no fixed unit_size.
605 * 2) use the unit_size functions where there is a relationship between the
606 * caps and the size of a buffer.
609 gst_base_transform_transform_size (GstBaseTransform * trans,
610 GstPadDirection direction, GstCaps * caps,
611 gsize size, GstCaps * othercaps, gsize * othersize)
613 GstBaseTransformClass *klass;
614 gboolean ret = FALSE;
616 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
618 GST_DEBUG_OBJECT (trans,
619 "asked to transform size %" G_GSIZE_FORMAT " for caps %"
620 GST_PTR_FORMAT " to size for caps %" GST_PTR_FORMAT " in direction %s",
621 size, caps, othercaps, direction == GST_PAD_SRC ? "SRC" : "SINK");
623 if (klass->transform_size) {
624 /* if there is a custom transform function, use this */
625 ret = klass->transform_size (trans, direction, caps, size, othercaps,
631 /* get the caps that can be handled by @pad. We perform:
633 * - take the caps of peer of otherpad,
634 * - filter against the padtemplate of otherpad,
635 * - calculate all transforms of remaining caps
636 * - filter against template of @pad
638 * If there is no peer, we simply return the caps of the padtemplate of pad.
641 gst_base_transform_query_caps (GstBaseTransform * trans, GstPad * pad,
645 GstCaps *peercaps, *caps, *temp, *peerfilter = NULL;
648 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
650 /* we can do what the peer can */
653 GST_DEBUG_OBJECT (pad, "filter caps %" GST_PTR_FORMAT, filter);
655 /* filtered against our padtemplate on the other side */
656 templ = gst_pad_get_pad_template_caps (pad);
657 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
658 temp = gst_caps_intersect_full (filter, templ, GST_CAPS_INTERSECT_FIRST);
659 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
660 gst_caps_unref (templ);
662 /* then see what we can transform this to */
663 peerfilter = gst_base_transform_transform_caps (trans,
664 GST_PAD_DIRECTION (pad), temp, NULL);
665 GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, peerfilter);
666 gst_caps_unref (temp);
668 /* and filter against the template of this pad */
669 templ = gst_pad_get_pad_template_caps (otherpad);
670 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
671 /* We keep the caps sorted like the returned caps */
673 gst_caps_intersect_full (peerfilter, templ, GST_CAPS_INTERSECT_FIRST);
674 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
675 gst_caps_unref (peerfilter);
676 gst_caps_unref (templ);
680 peercaps = gst_pad_peer_query_caps (otherpad, peerfilter);
683 gst_caps_unref (peerfilter);
686 GST_DEBUG_OBJECT (pad, "peer caps %" GST_PTR_FORMAT, peercaps);
688 /* filtered against our padtemplate on the other side */
689 templ = gst_pad_get_pad_template_caps (otherpad);
690 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
691 temp = gst_caps_intersect_full (peercaps, templ, GST_CAPS_INTERSECT_FIRST);
692 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
693 gst_caps_unref (templ);
695 temp = gst_pad_get_pad_template_caps (otherpad);
698 /* then see what we can transform this to */
699 caps = gst_base_transform_transform_caps (trans,
700 GST_PAD_DIRECTION (otherpad), temp, filter);
701 GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, caps);
702 gst_caps_unref (temp);
707 /* and filter against the template of this pad */
708 templ = gst_pad_get_pad_template_caps (pad);
709 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
710 /* We keep the caps sorted like the returned caps */
711 temp = gst_caps_intersect_full (caps, templ, GST_CAPS_INTERSECT_FIRST);
712 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
713 gst_caps_unref (caps);
714 gst_caps_unref (templ);
717 /* Now try if we can put the untransformed downstream caps first */
718 temp = gst_caps_intersect_full (peercaps, caps, GST_CAPS_INTERSECT_FIRST);
719 if (!gst_caps_is_empty (temp)) {
720 gst_caps_merge (temp, caps);
723 gst_caps_unref (temp);
726 gst_caps_unref (caps);
727 /* no peer or the peer can do anything, our padtemplate is enough then */
728 caps = gst_pad_get_pad_template_caps (pad);
733 temp = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
734 gst_caps_unref (caps);
740 GST_DEBUG_OBJECT (trans, "returning %" GST_PTR_FORMAT, caps);
743 gst_caps_unref (peercaps);
749 gst_base_transform_set_allocation (GstBaseTransform * trans,
750 GstBufferPool * pool, GstAllocator * allocator, guint prefix,
753 GstAllocator *oldalloc;
754 GstBufferPool *oldpool;
755 GstBaseTransformPrivate *priv = trans->priv;
759 GST_DEBUG_OBJECT (trans, "setting pool %p active", pool);
760 if (!gst_buffer_pool_set_active (pool, TRUE))
761 goto activate_failed;
764 GST_OBJECT_LOCK (trans);
765 oldpool = priv->pool;
767 oldalloc = priv->allocator;
768 priv->allocator = allocator;
769 priv->prefix = prefix;
770 priv->alignment = alignment;
771 GST_OBJECT_UNLOCK (trans);
774 GST_DEBUG_OBJECT (trans, "deactivating old pool %p", oldpool);
775 gst_buffer_pool_set_active (oldpool, FALSE);
776 gst_object_unref (oldpool);
779 gst_allocator_unref (oldalloc);
786 GST_ERROR_OBJECT (trans, "failed to activate bufferpool.");
792 gst_base_transform_do_bufferpool (GstBaseTransform * trans, GstCaps * outcaps)
795 gboolean result = TRUE;
796 GstBufferPool *pool = NULL, *oldpool;
797 guint size, min, max, prefix, alignment;
798 GstBaseTransformClass *klass;
799 GstAllocator *allocator = NULL;
801 /* there are these possibilities:
803 * 1) we negotiated passthrough, we can proxy the bufferpool directly and we
804 * will do that whenever some upstream does an allocation query.
805 * 2) we need to do a transform, we need to get a bufferpool from downstream
806 * and configure it. When upstream does the ALLOCATION query, the
807 * propose_allocation vmethod will be called and we will configure the
808 * upstream allocator with our porposed values then.
812 oldpool = trans->priv->pool;
814 GST_DEBUG_OBJECT (trans, "unreffing old pool");
815 gst_buffer_pool_set_active (oldpool, FALSE);
816 gst_object_unref (oldpool);
817 trans->priv->pool = oldpool = NULL;
820 if (trans->passthrough || trans->always_in_place) {
821 /* we are in passthrough, the input buffer is never copied and always passed
822 * along. We never allocate an output buffer on the srcpad. What we do is
823 * let the upstream element decide if it wants to use a bufferpool and
824 * then we will proxy the downstream pool */
825 GST_DEBUG_OBJECT (trans, "we're passthough, delay bufferpool");
829 /* not passthrough, we need to allocate */
830 /* find a pool for the negotiated caps now */
831 GST_DEBUG_OBJECT (trans, "doing allocation query");
832 query = gst_query_new_allocation (outcaps, TRUE);
833 if (!gst_pad_peer_query (trans->srcpad, query)) {
834 /* not a problem, just debug a little */
835 GST_DEBUG_OBJECT (trans, "peer ALLOCATION query failed");
838 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
840 GST_DEBUG_OBJECT (trans, "calling decide_allocation");
841 if (G_LIKELY (klass->decide_allocation))
842 result = klass->decide_allocation (trans, query);
844 /* we got configuration from our peer, parse them */
845 gst_query_parse_allocation_params (query, &size, &min, &max, &prefix,
849 const gchar *mem = NULL;
851 /* no size, we have variable size buffers */
852 if (gst_query_get_n_allocation_memories (query) > 0) {
853 mem = gst_query_parse_nth_allocation_memory (query, 0);
855 allocator = gst_allocator_find (mem);
856 GST_DEBUG_OBJECT (trans, "no size, using allocator %s", GST_STR_NULL (mem));
857 } else if (pool == NULL) {
858 GstStructure *config;
860 /* we did not get a pool, make one ourselves then */
861 pool = gst_buffer_pool_new ();
863 GST_DEBUG_OBJECT (trans, "no pool, making one");
864 config = gst_buffer_pool_get_config (pool);
865 gst_buffer_pool_config_set (config, outcaps, size, min, max, prefix,
867 gst_buffer_pool_set_config (pool, config);
870 gst_query_unref (query);
874 gst_base_transform_set_allocation (trans, pool, allocator, prefix,
880 /* function triggered when the in and out caps are negotiated and need
881 * to be configured in the subclass. */
883 gst_base_transform_configure_caps (GstBaseTransform * trans, GstCaps * in,
887 GstBaseTransformClass *klass;
889 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
891 GST_DEBUG_OBJECT (trans, "in caps: %" GST_PTR_FORMAT, in);
892 GST_DEBUG_OBJECT (trans, "out caps: %" GST_PTR_FORMAT, out);
894 /* clear the cache */
895 gst_caps_replace (&trans->cache_caps1, NULL);
896 gst_caps_replace (&trans->cache_caps2, NULL);
898 /* figure out same caps state */
899 trans->have_same_caps = gst_caps_is_equal (in, out);
900 GST_DEBUG_OBJECT (trans, "have_same_caps: %d", trans->have_same_caps);
902 /* If we've a transform_ip method and same input/output caps, set in_place
903 * by default. If for some reason the sub-class prefers using a transform
904 * function, it can clear the in place flag in the set_caps */
905 gst_base_transform_set_in_place (trans,
906 klass->transform_ip && trans->have_same_caps);
908 /* Set the passthrough if the class wants passthrough_on_same_caps
909 * and we have the same caps on each pad */
910 if (klass->passthrough_on_same_caps)
911 gst_base_transform_set_passthrough (trans, trans->have_same_caps);
913 /* now configure the element with the caps */
914 if (klass->set_caps) {
915 GST_DEBUG_OBJECT (trans, "Calling set_caps method to setup caps");
916 ret = klass->set_caps (trans, in, out);
919 trans->negotiated = ret;
925 gst_base_transform_default_fixate (GstBaseTransform * trans,
926 GstPadDirection direction, GstCaps * caps, GstCaps * othercaps)
928 GST_DEBUG_OBJECT (trans, "using default caps fixate function");
929 gst_caps_fixate (othercaps);
932 /* given a fixed @caps on @pad, create the best possible caps for the
934 * @caps must be fixed when calling this function.
936 * This function calls the transform caps vmethod of the basetransform to figure
937 * out the possible target formats. It then tries to select the best format from
940 * - attempt passthrough if the target caps is a superset of the input caps
941 * - fixating by using peer caps
942 * - fixating with transform fixate function
943 * - fixating with pad fixate functions.
945 * this function returns a caps that can be transformed into and is accepted by
949 gst_base_transform_find_transform (GstBaseTransform * trans, GstPad * pad,
952 GstBaseTransformClass *klass;
953 GstPad *otherpad, *otherpeer;
957 /* caps must be fixed here, this is a programming error if it's not */
958 g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
960 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
962 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
963 otherpeer = gst_pad_get_peer (otherpad);
965 /* see how we can transform the input caps. We need to do this even for
966 * passthrough because it might be possible that this element cannot support
967 * passthrough at all. */
968 othercaps = gst_base_transform_transform_caps (trans,
969 GST_PAD_DIRECTION (pad), caps, NULL);
971 /* The caps we can actually output is the intersection of the transformed
972 * caps with the pad template for the pad */
974 GstCaps *intersect, *templ_caps;
976 templ_caps = gst_pad_get_pad_template_caps (otherpad);
977 GST_DEBUG_OBJECT (trans,
978 "intersecting against padtemplate %" GST_PTR_FORMAT, templ_caps);
981 gst_caps_intersect_full (othercaps, templ_caps,
982 GST_CAPS_INTERSECT_FIRST);
984 gst_caps_unref (othercaps);
985 gst_caps_unref (templ_caps);
986 othercaps = intersect;
989 /* check if transform is empty */
990 if (!othercaps || gst_caps_is_empty (othercaps))
993 /* if the othercaps are not fixed, we need to fixate them, first attempt
994 * is by attempting passthrough if the othercaps are a superset of caps. */
995 /* FIXME. maybe the caps is not fixed because it has multiple structures of
997 is_fixed = gst_caps_is_fixed (othercaps);
999 GST_DEBUG_OBJECT (trans,
1000 "transform returned non fixed %" GST_PTR_FORMAT, othercaps);
1002 /* Now let's see what the peer suggests based on our transformed caps */
1004 GstCaps *peercaps, *intersection, *templ_caps;
1006 GST_DEBUG_OBJECT (trans,
1007 "Checking peer caps with filter %" GST_PTR_FORMAT, othercaps);
1009 peercaps = gst_pad_query_caps (otherpeer, othercaps);
1010 GST_DEBUG_OBJECT (trans, "Resulted in %" GST_PTR_FORMAT, peercaps);
1011 if (!gst_caps_is_empty (peercaps)) {
1012 templ_caps = gst_pad_get_pad_template_caps (otherpad);
1014 GST_DEBUG_OBJECT (trans,
1015 "Intersecting with template caps %" GST_PTR_FORMAT, templ_caps);
1018 gst_caps_intersect_full (peercaps, templ_caps,
1019 GST_CAPS_INTERSECT_FIRST);
1020 GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1022 gst_caps_unref (peercaps);
1023 gst_caps_unref (templ_caps);
1024 peercaps = intersection;
1026 GST_DEBUG_OBJECT (trans,
1027 "Intersecting with transformed caps %" GST_PTR_FORMAT, othercaps);
1029 gst_caps_intersect_full (peercaps, othercaps,
1030 GST_CAPS_INTERSECT_FIRST);
1031 GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1033 gst_caps_unref (peercaps);
1034 gst_caps_unref (othercaps);
1035 othercaps = intersection;
1037 othercaps = peercaps;
1040 is_fixed = gst_caps_is_fixed (othercaps);
1042 GST_DEBUG_OBJECT (trans, "no peer, doing passthrough");
1043 gst_caps_unref (othercaps);
1044 othercaps = gst_caps_ref (caps);
1048 if (gst_caps_is_empty (othercaps))
1049 goto no_transform_possible;
1051 GST_DEBUG ("have %sfixed caps %" GST_PTR_FORMAT, (is_fixed ? "" : "non-"),
1054 /* second attempt at fixation, call the fixate vmethod */
1055 /* caps could be fixed but the subclass may want to add fields */
1056 if (klass->fixate_caps) {
1057 othercaps = gst_caps_make_writable (othercaps);
1059 GST_DEBUG_OBJECT (trans, "calling fixate_caps for %" GST_PTR_FORMAT
1060 " using caps %" GST_PTR_FORMAT " on pad %s:%s", othercaps, caps,
1061 GST_DEBUG_PAD_NAME (otherpad));
1062 /* note that we pass the complete array of structures to the fixate
1063 * function, it needs to truncate itself */
1064 klass->fixate_caps (trans, GST_PAD_DIRECTION (pad), caps, othercaps);
1065 is_fixed = gst_caps_is_fixed (othercaps);
1066 GST_DEBUG_OBJECT (trans, "after fixating %" GST_PTR_FORMAT, othercaps);
1069 /* caps should be fixed now, if not we have to fail. */
1071 goto could_not_fixate;
1073 /* and peer should accept */
1074 if (otherpeer && !gst_pad_query_accept_caps (otherpeer, othercaps))
1075 goto peer_no_accept;
1077 GST_DEBUG_OBJECT (trans, "Input caps were %" GST_PTR_FORMAT
1078 ", and got final caps %" GST_PTR_FORMAT, caps, othercaps);
1081 gst_object_unref (otherpeer);
1088 GST_DEBUG_OBJECT (trans,
1089 "transform returned useless %" GST_PTR_FORMAT, othercaps);
1092 no_transform_possible:
1094 GST_DEBUG_OBJECT (trans,
1095 "transform could not transform %" GST_PTR_FORMAT
1096 " in anything we support", caps);
1101 GST_DEBUG_OBJECT (trans, "FAILED to fixate %" GST_PTR_FORMAT, othercaps);
1106 GST_DEBUG_OBJECT (trans, "FAILED to get peer of %" GST_PTR_FORMAT
1107 " to accept %" GST_PTR_FORMAT, otherpad, othercaps);
1113 gst_object_unref (otherpeer);
1115 gst_caps_unref (othercaps);
1121 gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
1122 GstPadDirection direction, GstCaps * caps)
1126 GstCaps *othercaps = NULL;
1128 gboolean ret = TRUE;
1131 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
1133 /* we need fixed caps for the check, fall back to the default implementation
1135 if (!gst_caps_is_fixed (caps))
1140 GST_DEBUG_OBJECT (trans, "non fixed accept caps %" GST_PTR_FORMAT, caps);
1142 /* get all the formats we can handle on this pad */
1143 if (direction == GST_PAD_SRC)
1144 allowed = gst_pad_query_caps (trans->srcpad, NULL);
1146 allowed = gst_pad_query_caps (trans->sinkpad, NULL);
1149 GST_DEBUG_OBJECT (trans, "gst_pad_query_caps() failed");
1150 goto no_transform_possible;
1153 GST_DEBUG_OBJECT (trans, "allowed caps %" GST_PTR_FORMAT, allowed);
1155 /* intersect with the requested format */
1156 ret = gst_caps_is_subset (caps, allowed);
1157 gst_caps_unref (allowed);
1160 goto no_transform_possible;
1164 GST_DEBUG_OBJECT (pad, "accept caps %" GST_PTR_FORMAT, caps);
1166 /* find best possible caps for the other pad as a way to see if we can
1167 * transform this caps. */
1168 othercaps = gst_base_transform_find_transform (trans, pad, caps, FALSE);
1169 if (!othercaps || gst_caps_is_empty (othercaps))
1170 goto no_transform_possible;
1172 GST_DEBUG_OBJECT (pad, "we can transform to %" GST_PTR_FORMAT, othercaps);
1178 /* We know it's always NULL since we never use it */
1180 gst_caps_unref (othercaps);
1186 no_transform_possible:
1188 GST_DEBUG_OBJECT (trans,
1189 "transform could not transform %" GST_PTR_FORMAT
1190 " in anything we support", caps);
1196 /* called when new caps arrive on the sink or source pad,
1197 * We try to find the best caps for the other side using our _find_transform()
1198 * function. If there are caps, we configure the transform for this new
1201 * FIXME, this function is currently commutative but this should not really be
1202 * because we never set caps starting from the srcpad.
1205 gst_base_transform_setcaps (GstBaseTransform * trans, GstPad * pad,
1208 GstPad *otherpad, *otherpeer;
1209 GstCaps *othercaps = NULL;
1210 gboolean ret = TRUE;
1211 GstCaps *incaps, *outcaps;
1213 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
1214 otherpeer = gst_pad_get_peer (otherpad);
1216 GST_DEBUG_OBJECT (pad, "have new caps %p %" GST_PTR_FORMAT, caps, caps);
1218 /* find best possible caps for the other pad */
1219 othercaps = gst_base_transform_find_transform (trans, pad, caps);
1220 if (!othercaps || gst_caps_is_empty (othercaps))
1221 goto no_transform_possible;
1223 /* configure the element now */
1224 /* make sure in and out caps are correct */
1225 if (pad == trans->sinkpad) {
1227 outcaps = othercaps;
1233 /* if we have the same caps, we can optimize and reuse the input caps */
1234 if (gst_caps_is_equal (incaps, outcaps)) {
1235 GST_INFO_OBJECT (trans, "reuse caps");
1236 gst_caps_unref (othercaps);
1237 outcaps = othercaps = gst_caps_ref (incaps);
1240 /* call configure now */
1241 if (!(ret = gst_base_transform_configure_caps (trans, incaps, outcaps)))
1242 goto failed_configure;
1244 GST_OBJECT_LOCK (trans->sinkpad);
1245 GST_OBJECT_FLAG_UNSET (trans->srcpad, GST_PAD_FLAG_NEED_RECONFIGURE);
1246 trans->priv->reconfigure = FALSE;
1247 GST_OBJECT_UNLOCK (trans->sinkpad);
1249 /* we know this will work, we implement the setcaps */
1250 gst_pad_push_event (otherpad, gst_event_new_caps (othercaps));
1252 if (pad == trans->srcpad && trans->priv->pad_mode == GST_PAD_MODE_PULL) {
1254 ret &= gst_pad_push_event (otherpeer, gst_event_new_caps (othercaps));
1256 GST_INFO_OBJECT (trans, "otherpeer setcaps(%" GST_PTR_FORMAT ") failed",
1262 /* try to get a pool when needed */
1263 ret = gst_base_transform_do_bufferpool (trans, othercaps);
1268 gst_object_unref (otherpeer);
1270 gst_caps_unref (othercaps);
1272 trans->negotiated = ret;
1277 no_transform_possible:
1279 GST_WARNING_OBJECT (trans,
1280 "transform could not transform %" GST_PTR_FORMAT
1281 " in anything we support", caps);
1287 GST_WARNING_OBJECT (trans, "FAILED to configure caps %" GST_PTR_FORMAT
1288 " to accept %" GST_PTR_FORMAT, otherpad, othercaps);
1295 gst_base_transform_default_query (GstBaseTransform * trans,
1296 GstPadDirection direction, GstQuery * query)
1298 gboolean ret = FALSE;
1299 GstPad *pad, *otherpad;
1300 GstBaseTransformClass *klass;
1302 if (direction == GST_PAD_SRC) {
1303 pad = trans->srcpad;
1304 otherpad = trans->sinkpad;
1306 pad = trans->sinkpad;
1307 otherpad = trans->srcpad;
1310 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1312 switch (GST_QUERY_TYPE (query)) {
1313 case GST_QUERY_ALLOCATION:
1315 gboolean passthrough;
1317 /* can only be done on the sinkpad */
1318 if (direction != GST_PAD_SINK)
1321 GST_BASE_TRANSFORM_LOCK (trans);
1322 passthrough = trans->passthrough;
1323 GST_BASE_TRANSFORM_UNLOCK (trans);
1325 GST_DEBUG_OBJECT (trans, "propose allocation values");
1326 /* pass the query to the propose_allocation vmethod if any */
1327 if (G_LIKELY (klass->propose_allocation)) {
1328 ret = klass->propose_allocation (trans, query);
1329 } else if (passthrough) {
1330 GST_DEBUG_OBJECT (trans, "doing passthrough query");
1331 ret = gst_pad_peer_query (otherpad, query);
1335 GST_DEBUG_OBJECT (trans, "ALLOCATION ret %d, %" GST_PTR_FORMAT, ret,
1339 case GST_QUERY_POSITION:
1343 gst_query_parse_position (query, &format, NULL);
1344 if (format == GST_FORMAT_TIME && trans->segment.format == GST_FORMAT_TIME) {
1348 if ((direction == GST_PAD_SINK)
1349 || (trans->priv->position_out == GST_CLOCK_TIME_NONE)) {
1351 gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1352 trans->segment.position);
1354 pos = gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1355 trans->priv->position_out);
1357 gst_query_set_position (query, format, pos);
1359 ret = gst_pad_peer_query (otherpad, query);
1363 case GST_QUERY_ACCEPT_CAPS:
1367 gst_query_parse_accept_caps (query, &caps);
1368 if (klass->accept_caps) {
1369 ret = klass->accept_caps (trans, direction, caps);
1370 gst_query_set_accept_caps_result (query, ret);
1371 /* return TRUE, we answered the query */
1376 case GST_QUERY_CAPS:
1378 GstCaps *filter, *caps;
1380 gst_query_parse_caps (query, &filter);
1381 caps = gst_base_transform_query_caps (trans, pad, filter);
1382 gst_query_set_caps_result (query, caps);
1383 gst_caps_unref (caps);
1388 ret = gst_pad_peer_query (otherpad, query);
1397 gst_base_transform_query (GstPad * pad, GstObject * parent, GstQuery * query)
1399 GstBaseTransform *trans;
1400 GstBaseTransformClass *bclass;
1401 gboolean ret = FALSE;
1403 trans = GST_BASE_TRANSFORM (parent);
1404 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1407 ret = bclass->query (trans, GST_PAD_DIRECTION (pad), query);
1412 /* this function either returns the input buffer without incrementing the
1413 * refcount or it allocates a new (writable) buffer */
1414 static GstFlowReturn
1415 default_prepare_output_buffer (GstBaseTransform * trans,
1416 GstBuffer * inbuf, GstBuffer ** outbuf)
1418 GstBaseTransformPrivate *priv;
1419 GstFlowReturn ret = GST_FLOW_OK;
1420 GstBaseTransformClass *bclass;
1423 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1425 /* figure out how to allocate an output buffer */
1426 if (trans->passthrough) {
1427 /* passthrough, we will not modify the incomming buffer so we can just
1429 GST_DEBUG_OBJECT (trans, "passthrough: reusing input buffer");
1432 /* we can't reuse the input buffer */
1434 GST_DEBUG_OBJECT (trans, "using pool alloc");
1435 ret = gst_buffer_pool_acquire_buffer (priv->pool, outbuf, NULL);
1437 gsize insize, outsize;
1440 /* no pool, we need to figure out the size of the output buffer first */
1441 insize = gst_buffer_get_size (inbuf);
1443 if (trans->passthrough) {
1444 GST_DEBUG_OBJECT (trans, "doing passthrough alloc");
1445 /* passthrough, the output size is the same as the input size. */
1448 gboolean want_in_place = (bclass->transform_ip != NULL)
1449 && trans->always_in_place;
1451 if (want_in_place) {
1452 GST_DEBUG_OBJECT (trans, "doing inplace alloc");
1453 /* we alloc a buffer of the same size as the input */
1456 GstCaps *incaps, *outcaps;
1458 /* else use the transform function to get the size */
1459 incaps = gst_pad_get_current_caps (trans->sinkpad);
1460 outcaps = gst_pad_get_current_caps (trans->srcpad);
1462 GST_DEBUG_OBJECT (trans, "getting output size for alloc");
1463 /* copy transform, figure out the output size */
1464 res = gst_base_transform_transform_size (trans,
1465 GST_PAD_SINK, incaps, insize, outcaps, &outsize);
1467 gst_caps_unref (incaps);
1468 gst_caps_unref (outcaps);
1474 GST_DEBUG_OBJECT (trans, "doing alloc of size %" G_GSIZE_FORMAT, outsize);
1476 gst_buffer_new_allocate (priv->allocator, outsize, priv->alignment);
1484 GST_ERROR_OBJECT (trans, "unknown output size");
1485 return GST_FLOW_ERROR;
1490 default_copy_metadata (GstBaseTransform * trans,
1491 GstBuffer * inbuf, GstBuffer * outbuf)
1493 GstBaseTransformPrivate *priv = trans->priv;
1495 /* now copy the metadata */
1496 GST_DEBUG_OBJECT (trans, "copying metadata");
1498 /* this should not happen, buffers allocated from a pool or with
1499 * new_allocate should always be writable. */
1500 if (!gst_buffer_is_writable (outbuf))
1503 /* when we get here, the metadata should be writable */
1504 gst_buffer_copy_into (outbuf, inbuf,
1505 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1507 /* clear the GAP flag when the subclass does not understand it */
1508 if (!priv->gap_aware)
1509 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_GAP);
1516 GST_WARNING_OBJECT (trans, "buffer %p not writable", outbuf);
1521 /* Given @caps calcultate the size of one unit.
1523 * For video caps, this is the size of one frame (and thus one buffer).
1524 * For audio caps, this is the size of one sample.
1526 * These values are cached since they do not change and the calculation
1527 * potentially involves parsing caps and other expensive stuff.
1529 * We have two cache locations to store the size, one for the source caps
1530 * and one for the sink caps.
1532 * this function returns FALSE if no size could be calculated.
1535 gst_base_transform_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
1538 gboolean res = FALSE;
1539 GstBaseTransformClass *bclass;
1541 /* see if we have the result cached */
1542 if (trans->cache_caps1 == caps) {
1543 *size = trans->cache_caps1_size;
1544 GST_DEBUG_OBJECT (trans,
1545 "returned %" G_GSIZE_FORMAT " from first cache", *size);
1548 if (trans->cache_caps2 == caps) {
1549 *size = trans->cache_caps2_size;
1550 GST_DEBUG_OBJECT (trans,
1551 "returned %" G_GSIZE_FORMAT " from second cached", *size);
1555 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1556 res = bclass->get_unit_size (trans, caps, size);
1557 GST_DEBUG_OBJECT (trans,
1558 "caps %" GST_PTR_FORMAT ") has unit size %" G_GSIZE_FORMAT ", res %s",
1559 caps, *size, res ? "TRUE" : "FALSE");
1562 /* and cache the values */
1563 if (trans->cache_caps1 == NULL) {
1564 gst_caps_replace (&trans->cache_caps1, caps);
1565 trans->cache_caps1_size = *size;
1566 GST_DEBUG_OBJECT (trans,
1567 "caching %" G_GSIZE_FORMAT " in first cache", *size);
1568 } else if (trans->cache_caps2 == NULL) {
1569 gst_caps_replace (&trans->cache_caps2, caps);
1570 trans->cache_caps2_size = *size;
1571 GST_DEBUG_OBJECT (trans,
1572 "caching %" G_GSIZE_FORMAT " in second cache", *size);
1574 GST_DEBUG_OBJECT (trans, "no free spot to cache unit_size");
1581 gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
1584 GstBaseTransform *trans;
1585 GstBaseTransformClass *bclass;
1586 gboolean ret = TRUE;
1588 trans = GST_BASE_TRANSFORM (parent);
1589 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1591 if (bclass->sink_event)
1592 ret = bclass->sink_event (trans, event);
1594 gst_event_unref (event);
1600 gst_base_transform_sink_eventfunc (GstBaseTransform * trans, GstEvent * event)
1602 gboolean ret = TRUE, forward = TRUE;
1604 switch (GST_EVENT_TYPE (event)) {
1605 case GST_EVENT_FLUSH_START:
1607 case GST_EVENT_FLUSH_STOP:
1608 GST_OBJECT_LOCK (trans);
1609 /* reset QoS parameters */
1610 trans->priv->proportion = 1.0;
1611 trans->priv->earliest_time = -1;
1612 trans->priv->discont = FALSE;
1613 trans->priv->processed = 0;
1614 trans->priv->dropped = 0;
1615 GST_OBJECT_UNLOCK (trans);
1616 /* we need new segment info after the flush. */
1617 trans->have_segment = FALSE;
1618 gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
1619 trans->priv->position_out = GST_CLOCK_TIME_NONE;
1625 case GST_EVENT_CAPS:
1629 gst_event_parse_caps (event, &caps);
1630 ret = gst_base_transform_setcaps (trans, trans->sinkpad, caps);
1635 case GST_EVENT_SEGMENT:
1637 gst_event_copy_segment (event, &trans->segment);
1638 trans->have_segment = TRUE;
1640 GST_DEBUG_OBJECT (trans, "received SEGMENT %" GST_SEGMENT_FORMAT,
1649 ret = gst_pad_push_event (trans->srcpad, event);
1651 gst_event_unref (event);
1657 gst_base_transform_src_event (GstPad * pad, GstObject * parent,
1660 GstBaseTransform *trans;
1661 GstBaseTransformClass *bclass;
1662 gboolean ret = TRUE;
1664 trans = GST_BASE_TRANSFORM (parent);
1665 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1667 if (bclass->src_event)
1668 ret = bclass->src_event (trans, event);
1670 gst_event_unref (event);
1676 gst_base_transform_src_eventfunc (GstBaseTransform * trans, GstEvent * event)
1680 GST_DEBUG_OBJECT (trans, "handling event %p %" GST_PTR_FORMAT, event, event);
1682 switch (GST_EVENT_TYPE (event)) {
1683 case GST_EVENT_SEEK:
1685 case GST_EVENT_NAVIGATION:
1690 GstClockTimeDiff diff;
1691 GstClockTime timestamp;
1693 gst_event_parse_qos (event, NULL, &proportion, &diff, ×tamp);
1694 gst_base_transform_update_qos (trans, proportion, diff, timestamp);
1701 ret = gst_pad_push_event (trans->sinkpad, event);
1706 /* perform a transform on @inbuf and put the result in @outbuf.
1708 * This function is common to the push and pull-based operations.
1710 * This function takes ownership of @inbuf */
1711 static GstFlowReturn
1712 gst_base_transform_handle_buffer (GstBaseTransform * trans, GstBuffer * inbuf,
1713 GstBuffer ** outbuf)
1715 GstBaseTransformClass *bclass;
1716 GstFlowReturn ret = GST_FLOW_OK;
1717 gboolean want_in_place;
1718 GstClockTime running_time;
1719 GstClockTime timestamp;
1720 gboolean reconfigure;
1722 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1724 GST_OBJECT_LOCK (trans->sinkpad);
1725 reconfigure = GST_PAD_NEEDS_RECONFIGURE (trans->srcpad)
1726 || trans->priv->reconfigure;
1727 GST_OBJECT_FLAG_UNSET (trans->srcpad, GST_PAD_FLAG_NEED_RECONFIGURE);
1728 trans->priv->reconfigure = FALSE;
1729 GST_OBJECT_UNLOCK (trans->sinkpad);
1731 if (G_UNLIKELY (reconfigure)) {
1734 GST_DEBUG_OBJECT (trans, "we had a pending reconfigure");
1736 incaps = gst_pad_get_current_caps (trans->sinkpad);
1738 goto no_reconfigure;
1740 /* if we need to reconfigure we pretend a buffer with new caps arrived. This
1741 * will reconfigure the transform with the new output format. We can only
1742 * do this if the buffer actually has caps. */
1743 if (!gst_base_transform_setcaps (trans, trans->sinkpad, incaps)) {
1744 gst_caps_unref (incaps);
1745 goto not_negotiated;
1747 gst_caps_unref (incaps);
1751 if (GST_BUFFER_OFFSET_IS_VALID (inbuf))
1752 GST_DEBUG_OBJECT (trans,
1753 "handling buffer %p of size %" G_GSIZE_FORMAT " and offset %"
1754 G_GUINT64_FORMAT, inbuf, gst_buffer_get_size (inbuf),
1755 GST_BUFFER_OFFSET (inbuf));
1757 GST_DEBUG_OBJECT (trans,
1758 "handling buffer %p of size %" G_GSIZE_FORMAT " and offset NONE", inbuf,
1759 gst_buffer_get_size (inbuf));
1761 /* Don't allow buffer handling before negotiation, except in passthrough mode
1762 * or if the class doesn't implement a set_caps function (in which case it doesn't
1765 if (!trans->negotiated && !trans->passthrough && (bclass->set_caps != NULL))
1766 goto not_negotiated;
1768 /* Set discont flag so we can mark the outgoing buffer */
1769 if (GST_BUFFER_IS_DISCONT (inbuf)) {
1770 GST_DEBUG_OBJECT (trans, "got DISCONT buffer %p", inbuf);
1771 trans->priv->discont = TRUE;
1774 /* can only do QoS if the segment is in TIME */
1775 if (trans->segment.format != GST_FORMAT_TIME)
1778 /* QOS is done on the running time of the buffer, get it now */
1779 timestamp = GST_BUFFER_TIMESTAMP (inbuf);
1780 running_time = gst_segment_to_running_time (&trans->segment, GST_FORMAT_TIME,
1783 if (running_time != -1) {
1785 GstClockTime earliest_time;
1788 /* lock for getting the QoS parameters that are set (in a different thread)
1789 * with the QOS events */
1790 GST_OBJECT_LOCK (trans);
1791 earliest_time = trans->priv->earliest_time;
1792 proportion = trans->priv->proportion;
1793 /* check for QoS, don't perform conversion for buffers
1794 * that are known to be late. */
1795 need_skip = trans->priv->qos_enabled &&
1796 earliest_time != -1 && running_time <= earliest_time;
1797 GST_OBJECT_UNLOCK (trans);
1800 GstMessage *qos_msg;
1801 GstClockTime duration;
1802 guint64 stream_time;
1805 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "skipping transform: qostime %"
1806 GST_TIME_FORMAT " <= %" GST_TIME_FORMAT,
1807 GST_TIME_ARGS (running_time), GST_TIME_ARGS (earliest_time));
1809 trans->priv->dropped++;
1811 duration = GST_BUFFER_DURATION (inbuf);
1813 gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1815 jitter = GST_CLOCK_DIFF (running_time, earliest_time);
1818 gst_message_new_qos (GST_OBJECT_CAST (trans), FALSE, running_time,
1819 stream_time, timestamp, duration);
1820 gst_message_set_qos_values (qos_msg, jitter, proportion, 1000000);
1821 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS,
1822 trans->priv->processed, trans->priv->dropped);
1823 gst_element_post_message (GST_ELEMENT_CAST (trans), qos_msg);
1825 /* mark discont for next buffer */
1826 trans->priv->discont = TRUE;
1833 /* first try to allocate an output buffer based on the currently negotiated
1834 * format. outbuf will contain a buffer suitable for doing the configured
1835 * transform after this function. */
1836 if (bclass->prepare_output_buffer == NULL)
1839 GST_DEBUG_OBJECT (trans, "calling prepare buffer");
1840 ret = bclass->prepare_output_buffer (trans, inbuf, outbuf);
1842 if (ret != GST_FLOW_OK || *outbuf == NULL)
1845 if (inbuf == *outbuf) {
1846 GST_DEBUG_OBJECT (trans, "reusing input buffer");
1847 } else if (trans->passthrough) {
1848 /* we are asked to perform a passthrough transform but the input and
1849 * output buffers are different. We have to discard the output buffer and
1850 * reuse the input buffer. This is rather weird, it means that the prepare
1851 * output buffer does something wrong. */
1852 GST_WARNING_OBJECT (trans, "passthrough but different buffers, check the "
1853 "prepare_output_buffer implementation");
1854 gst_buffer_unref (*outbuf);
1857 /* copy the metadata */
1858 if (bclass->copy_metadata)
1859 if (!bclass->copy_metadata (trans, inbuf, *outbuf)) {
1860 /* something failed, post a warning */
1861 GST_ELEMENT_WARNING (trans, STREAM, NOT_IMPLEMENTED,
1862 ("could not copy metadata"), (NULL));
1865 GST_DEBUG_OBJECT (trans, "using allocated buffer in %p, out %p", inbuf,
1868 /* now perform the needed transform */
1869 if (trans->passthrough) {
1870 /* In passthrough mode, give transform_ip a look at the
1871 * buffer, without making it writable, or just push the
1873 if (bclass->transform_ip) {
1874 GST_DEBUG_OBJECT (trans, "doing passthrough transform");
1875 ret = bclass->transform_ip (trans, *outbuf);
1877 GST_DEBUG_OBJECT (trans, "element is in passthrough");
1880 want_in_place = (bclass->transform_ip != NULL) && trans->always_in_place;
1882 if (want_in_place) {
1883 GST_DEBUG_OBJECT (trans, "doing inplace transform");
1885 if (inbuf != *outbuf) {
1886 GstMapInfo ininfo, outinfo;
1888 /* Different buffer. The data can still be the same when we are dealing
1889 * with subbuffers of the same buffer. Note that because of the FIXME in
1890 * prepare_output_buffer() we have decreased the refcounts of inbuf and
1891 * outbuf to keep them writable */
1892 g_assert (gst_buffer_map (inbuf, &ininfo, GST_MAP_READ));
1893 g_assert (gst_buffer_map (*outbuf, &outinfo, GST_MAP_WRITE));
1895 if (ininfo.data != outinfo.data)
1896 memcpy (outinfo.data, ininfo.data, ininfo.size);
1898 gst_buffer_unmap (inbuf, &ininfo);
1899 gst_buffer_unmap (*outbuf, &outinfo);
1901 ret = bclass->transform_ip (trans, *outbuf);
1903 GST_DEBUG_OBJECT (trans, "doing non-inplace transform");
1905 if (bclass->transform)
1906 ret = bclass->transform (trans, inbuf, *outbuf);
1908 ret = GST_FLOW_NOT_SUPPORTED;
1913 /* only unref input buffer if we allocated a new outbuf buffer. If we reused
1914 * the input buffer, no refcount is changed to keep the input buffer writable
1916 if (*outbuf != inbuf)
1917 gst_buffer_unref (inbuf);
1924 gst_buffer_unref (inbuf);
1926 GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED,
1927 ("not negotiated"), ("not negotiated"));
1928 return GST_FLOW_NOT_NEGOTIATED;
1932 gst_buffer_unref (inbuf);
1933 GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED,
1934 ("Sub-class has no prepare_output_buffer implementation"), (NULL));
1935 return GST_FLOW_NOT_SUPPORTED;
1939 gst_buffer_unref (inbuf);
1941 GST_WARNING_OBJECT (trans, "could not get buffer from pool: %s",
1942 gst_flow_get_name (ret));
1947 /* FIXME, getrange is broken, need to pull range from the other
1948 * end based on the transform_size result.
1950 static GstFlowReturn
1951 gst_base_transform_getrange (GstPad * pad, GstObject * parent, guint64 offset,
1952 guint length, GstBuffer ** buffer)
1954 GstBaseTransform *trans;
1955 GstBaseTransformClass *klass;
1959 trans = GST_BASE_TRANSFORM (parent);
1961 ret = gst_pad_pull_range (trans->sinkpad, offset, length, &inbuf);
1962 if (G_UNLIKELY (ret != GST_FLOW_OK))
1965 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1966 if (klass->before_transform)
1967 klass->before_transform (trans, inbuf);
1969 GST_BASE_TRANSFORM_LOCK (trans);
1970 ret = gst_base_transform_handle_buffer (trans, inbuf, buffer);
1971 GST_BASE_TRANSFORM_UNLOCK (trans);
1979 GST_DEBUG_OBJECT (trans, "failed to pull a buffer: %s",
1980 gst_flow_get_name (ret));
1985 static GstFlowReturn
1986 gst_base_transform_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
1988 GstBaseTransform *trans;
1989 GstBaseTransformClass *klass;
1991 GstClockTime position = GST_CLOCK_TIME_NONE;
1992 GstClockTime timestamp, duration;
1993 GstBuffer *outbuf = NULL;
1995 trans = GST_BASE_TRANSFORM (parent);
1997 timestamp = GST_BUFFER_TIMESTAMP (buffer);
1998 duration = GST_BUFFER_DURATION (buffer);
2000 /* calculate end position of the incoming buffer */
2001 if (timestamp != GST_CLOCK_TIME_NONE) {
2002 if (duration != GST_CLOCK_TIME_NONE)
2003 position = timestamp + duration;
2005 position = timestamp;
2008 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2009 if (klass->before_transform)
2010 klass->before_transform (trans, buffer);
2012 /* protect transform method and concurrent buffer alloc */
2013 GST_BASE_TRANSFORM_LOCK (trans);
2014 ret = gst_base_transform_handle_buffer (trans, buffer, &outbuf);
2015 GST_BASE_TRANSFORM_UNLOCK (trans);
2017 /* outbuf can be NULL, this means a dropped buffer, if we have a buffer but
2018 * GST_BASE_TRANSFORM_FLOW_DROPPED we will not push either. */
2019 if (outbuf != NULL) {
2020 if (ret == GST_FLOW_OK) {
2021 GstClockTime position_out = GST_CLOCK_TIME_NONE;
2023 /* Remember last stop position */
2024 if (position != GST_CLOCK_TIME_NONE &&
2025 trans->segment.format == GST_FORMAT_TIME)
2026 trans->segment.position = position;
2028 if (GST_BUFFER_TIMESTAMP_IS_VALID (outbuf)) {
2029 position_out = GST_BUFFER_TIMESTAMP (outbuf);
2030 if (GST_BUFFER_DURATION_IS_VALID (outbuf))
2031 position_out += GST_BUFFER_DURATION (outbuf);
2032 } else if (position != GST_CLOCK_TIME_NONE) {
2033 position_out = position;
2035 if (position_out != GST_CLOCK_TIME_NONE
2036 && trans->segment.format == GST_FORMAT_TIME)
2037 trans->priv->position_out = position_out;
2039 /* apply DISCONT flag if the buffer is not yet marked as such */
2040 if (trans->priv->discont) {
2041 GST_DEBUG_OBJECT (trans, "we have a pending DISCONT");
2042 if (!GST_BUFFER_IS_DISCONT (outbuf)) {
2043 GST_DEBUG_OBJECT (trans, "marking DISCONT on output buffer");
2044 outbuf = gst_buffer_make_writable (outbuf);
2045 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
2047 trans->priv->discont = FALSE;
2049 trans->priv->processed++;
2051 ret = gst_pad_push (trans->srcpad, outbuf);
2053 GST_DEBUG_OBJECT (trans, "we got return %s", gst_flow_get_name (ret));
2054 gst_buffer_unref (outbuf);
2058 /* convert internal flow to OK and mark discont for the next buffer. */
2059 if (ret == GST_BASE_TRANSFORM_FLOW_DROPPED) {
2060 GST_DEBUG_OBJECT (trans, "dropped a buffer, marking DISCONT");
2061 trans->priv->discont = TRUE;
2069 gst_base_transform_set_property (GObject * object, guint prop_id,
2070 const GValue * value, GParamSpec * pspec)
2072 GstBaseTransform *trans;
2074 trans = GST_BASE_TRANSFORM (object);
2078 gst_base_transform_set_qos_enabled (trans, g_value_get_boolean (value));
2081 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2087 gst_base_transform_get_property (GObject * object, guint prop_id,
2088 GValue * value, GParamSpec * pspec)
2090 GstBaseTransform *trans;
2092 trans = GST_BASE_TRANSFORM (object);
2096 g_value_set_boolean (value, gst_base_transform_is_qos_enabled (trans));
2099 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2104 /* not a vmethod of anything, just an internal method */
2106 gst_base_transform_activate (GstBaseTransform * trans, gboolean active)
2108 GstBaseTransformClass *bclass;
2109 gboolean result = TRUE;
2111 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2114 GstCaps *incaps, *outcaps;
2116 if (trans->priv->pad_mode == GST_PAD_MODE_NONE && bclass->start)
2117 result &= bclass->start (trans);
2119 incaps = gst_pad_get_current_caps (trans->sinkpad);
2120 outcaps = gst_pad_get_current_caps (trans->srcpad);
2122 GST_OBJECT_LOCK (trans);
2123 if (incaps && outcaps)
2124 trans->have_same_caps =
2125 gst_caps_is_equal (incaps, outcaps) || trans->passthrough;
2127 trans->have_same_caps = trans->passthrough;
2128 GST_DEBUG_OBJECT (trans, "have_same_caps %d", trans->have_same_caps);
2129 trans->negotiated = FALSE;
2130 trans->have_segment = FALSE;
2131 gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
2132 trans->priv->position_out = GST_CLOCK_TIME_NONE;
2133 trans->priv->proportion = 1.0;
2134 trans->priv->earliest_time = -1;
2135 trans->priv->discont = FALSE;
2136 trans->priv->processed = 0;
2137 trans->priv->dropped = 0;
2138 GST_OBJECT_UNLOCK (trans);
2141 gst_caps_unref (incaps);
2143 gst_caps_unref (outcaps);
2145 /* We must make sure streaming has finished before resetting things
2146 * and calling the ::stop vfunc */
2147 GST_PAD_STREAM_LOCK (trans->sinkpad);
2148 GST_PAD_STREAM_UNLOCK (trans->sinkpad);
2150 trans->have_same_caps = FALSE;
2151 /* We can only reset the passthrough mode if the instance told us to
2152 handle it in configure_caps */
2153 if (bclass->passthrough_on_same_caps) {
2154 gst_base_transform_set_passthrough (trans, FALSE);
2156 gst_caps_replace (&trans->cache_caps1, NULL);
2157 gst_caps_replace (&trans->cache_caps2, NULL);
2159 if (trans->priv->pad_mode != GST_PAD_MODE_NONE && bclass->stop)
2160 result &= bclass->stop (trans);
2162 gst_base_transform_set_allocation (trans, NULL, NULL, 0, 0);
2169 gst_base_transform_sink_activate_mode (GstPad * pad, GstObject * parent,
2170 GstPadMode mode, gboolean active)
2172 gboolean result = FALSE;
2173 GstBaseTransform *trans;
2175 trans = GST_BASE_TRANSFORM (parent);
2178 case GST_PAD_MODE_PUSH:
2180 result = gst_base_transform_activate (trans, active);
2183 trans->priv->pad_mode = active ? GST_PAD_MODE_PUSH : GST_PAD_MODE_NONE;
2195 gst_base_transform_src_activate_mode (GstPad * pad, GstObject * parent,
2196 GstPadMode mode, gboolean active)
2198 gboolean result = FALSE;
2199 GstBaseTransform *trans;
2201 trans = GST_BASE_TRANSFORM (parent);
2204 case GST_PAD_MODE_PULL:
2207 gst_pad_activate_mode (trans->sinkpad, GST_PAD_MODE_PULL, active);
2210 result &= gst_base_transform_activate (trans, active);
2213 trans->priv->pad_mode = active ? mode : GST_PAD_MODE_NONE;
2225 * gst_base_transform_set_passthrough:
2226 * @trans: the #GstBaseTransform to set
2227 * @passthrough: boolean indicating passthrough mode.
2229 * Set passthrough mode for this filter by default. This is mostly
2230 * useful for filters that do not care about negotiation.
2232 * Always TRUE for filters which don't implement either a transform
2233 * or transform_ip method.
2238 gst_base_transform_set_passthrough (GstBaseTransform * trans,
2239 gboolean passthrough)
2241 GstBaseTransformClass *bclass;
2243 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2245 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2247 GST_OBJECT_LOCK (trans);
2248 if (passthrough == FALSE) {
2249 if (bclass->transform_ip || bclass->transform)
2250 trans->passthrough = FALSE;
2252 trans->passthrough = TRUE;
2255 GST_DEBUG_OBJECT (trans, "set passthrough %d", trans->passthrough);
2256 GST_OBJECT_UNLOCK (trans);
2260 * gst_base_transform_is_passthrough:
2261 * @trans: the #GstBaseTransform to query
2263 * See if @trans is configured as a passthrough transform.
2265 * Returns: TRUE is the transform is configured in passthrough mode.
2270 gst_base_transform_is_passthrough (GstBaseTransform * trans)
2274 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2276 GST_OBJECT_LOCK (trans);
2277 result = trans->passthrough;
2278 GST_OBJECT_UNLOCK (trans);
2284 * gst_base_transform_set_in_place:
2285 * @trans: the #GstBaseTransform to modify
2286 * @in_place: Boolean value indicating that we would like to operate
2287 * on in_place buffers.
2289 * Determines whether a non-writable buffer will be copied before passing
2290 * to the transform_ip function.
2292 * <listitem>Always TRUE if no transform function is implemented.</listitem>
2293 * <listitem>Always FALSE if ONLY transform function is implemented.</listitem>
2299 gst_base_transform_set_in_place (GstBaseTransform * trans, gboolean in_place)
2301 GstBaseTransformClass *bclass;
2303 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2305 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2307 GST_OBJECT_LOCK (trans);
2310 if (bclass->transform_ip) {
2311 GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
2312 trans->always_in_place = TRUE;
2315 if (bclass->transform) {
2316 GST_DEBUG_OBJECT (trans, "setting in_place FALSE");
2317 trans->always_in_place = FALSE;
2321 GST_OBJECT_UNLOCK (trans);
2325 * gst_base_transform_is_in_place:
2326 * @trans: the #GstBaseTransform to query
2328 * See if @trans is configured as a in_place transform.
2330 * Returns: TRUE is the transform is configured in in_place mode.
2335 gst_base_transform_is_in_place (GstBaseTransform * trans)
2339 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2341 GST_OBJECT_LOCK (trans);
2342 result = trans->always_in_place;
2343 GST_OBJECT_UNLOCK (trans);
2349 * gst_base_transform_update_qos:
2350 * @trans: a #GstBaseTransform
2351 * @proportion: the proportion
2352 * @diff: the diff against the clock
2353 * @timestamp: the timestamp of the buffer generating the QoS expressed in
2356 * Set the QoS parameters in the transform. This function is called internally
2357 * when a QOS event is received but subclasses can provide custom information
2365 gst_base_transform_update_qos (GstBaseTransform * trans,
2366 gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp)
2369 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2371 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans,
2372 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2373 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (timestamp));
2375 GST_OBJECT_LOCK (trans);
2376 trans->priv->proportion = proportion;
2377 trans->priv->earliest_time = timestamp + diff;
2378 GST_OBJECT_UNLOCK (trans);
2382 * gst_base_transform_set_qos_enabled:
2383 * @trans: a #GstBaseTransform
2384 * @enabled: new state
2386 * Enable or disable QoS handling in the transform.
2393 gst_base_transform_set_qos_enabled (GstBaseTransform * trans, gboolean enabled)
2395 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2397 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "enabled: %d", enabled);
2399 GST_OBJECT_LOCK (trans);
2400 trans->priv->qos_enabled = enabled;
2401 GST_OBJECT_UNLOCK (trans);
2405 * gst_base_transform_is_qos_enabled:
2406 * @trans: a #GstBaseTransform
2408 * Queries if the transform will handle QoS.
2410 * Returns: TRUE if QoS is enabled.
2417 gst_base_transform_is_qos_enabled (GstBaseTransform * trans)
2421 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2423 GST_OBJECT_LOCK (trans);
2424 result = trans->priv->qos_enabled;
2425 GST_OBJECT_UNLOCK (trans);
2431 * gst_base_transform_set_gap_aware:
2432 * @trans: a #GstBaseTransform
2433 * @gap_aware: New state
2435 * If @gap_aware is %FALSE (the default), output buffers will have the
2436 * %GST_BUFFER_FLAG_GAP flag unset.
2438 * If set to %TRUE, the element must handle output buffers with this flag set
2439 * correctly, i.e. it can assume that the buffer contains neutral data but must
2440 * unset the flag if the output is no neutral data.
2447 gst_base_transform_set_gap_aware (GstBaseTransform * trans, gboolean gap_aware)
2449 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2451 GST_OBJECT_LOCK (trans);
2452 trans->priv->gap_aware = gap_aware;
2453 GST_DEBUG_OBJECT (trans, "set gap aware %d", trans->priv->gap_aware);
2454 GST_OBJECT_UNLOCK (trans);
2458 * gst_base_transform_suggest:
2459 * @trans: a #GstBaseTransform
2460 * @caps: (transfer none): caps to suggest
2461 * @size: buffer size to suggest
2463 * Instructs @trans to suggest new @caps upstream. A copy of @caps will be
2469 gst_base_transform_suggest (GstBaseTransform * trans, GstCaps * caps,
2472 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2474 /* push the renegotiate event */
2475 if (!gst_pad_push_event (GST_BASE_TRANSFORM_SINK_PAD (trans),
2476 gst_event_new_reconfigure ()))
2477 GST_DEBUG_OBJECT (trans, "Renegotiate event wasn't handled");
2481 * gst_base_transform_reconfigure:
2482 * @trans: a #GstBaseTransform
2484 * Instructs @trans to renegotiate a new downstream transform on the next
2485 * buffer. This function is typically called after properties on the transform
2486 * were set that influence the output format.
2491 gst_base_transform_reconfigure (GstBaseTransform * trans)
2493 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2495 GST_OBJECT_LOCK (trans);
2496 GST_DEBUG_OBJECT (trans, "marking reconfigure");
2497 trans->priv->reconfigure = TRUE;
2498 GST_OBJECT_UNLOCK (trans);