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 GstCaps *gst_base_transform_default_fixate_caps (GstBaseTransform *
326 trans, 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_default_propose_allocation (GstBaseTransform
334 * trans, gboolean passthrough, GstQuery * query);
335 static gboolean gst_base_transform_query (GstPad * pad, GstObject * parent,
337 static gboolean gst_base_transform_default_query (GstBaseTransform * trans,
338 GstPadDirection direction, GstQuery * query);
339 static gboolean gst_base_transform_default_transform_size (GstBaseTransform *
340 trans, GstPadDirection direction, GstCaps * caps, gsize size,
341 GstCaps * othercaps, gsize * othersize);
343 static GstFlowReturn default_prepare_output_buffer (GstBaseTransform * trans,
344 GstBuffer * inbuf, GstBuffer ** outbuf);
345 static gboolean default_copy_metadata (GstBaseTransform * trans,
346 GstBuffer * inbuf, GstBuffer * outbuf);
348 /* static guint gst_base_transform_signals[LAST_SIGNAL] = { 0 }; */
352 gst_base_transform_finalize (GObject * object)
354 GstBaseTransform *trans;
356 trans = GST_BASE_TRANSFORM (object);
358 g_mutex_clear (&trans->transform_lock);
360 G_OBJECT_CLASS (parent_class)->finalize (object);
364 gst_base_transform_class_init (GstBaseTransformClass * klass)
366 GObjectClass *gobject_class;
368 gobject_class = G_OBJECT_CLASS (klass);
370 GST_DEBUG_CATEGORY_INIT (gst_base_transform_debug, "basetransform", 0,
371 "basetransform element");
373 GST_DEBUG ("gst_base_transform_class_init");
375 g_type_class_add_private (klass, sizeof (GstBaseTransformPrivate));
377 parent_class = g_type_class_peek_parent (klass);
379 gobject_class->set_property = gst_base_transform_set_property;
380 gobject_class->get_property = gst_base_transform_get_property;
382 g_object_class_install_property (gobject_class, PROP_QOS,
383 g_param_spec_boolean ("qos", "QoS", "Handle Quality-of-Service events",
384 DEFAULT_PROP_QOS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
386 gobject_class->finalize = gst_base_transform_finalize;
388 klass->passthrough_on_same_caps = FALSE;
390 klass->transform_caps =
391 GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_caps);
393 GST_DEBUG_FUNCPTR (gst_base_transform_default_fixate_caps);
395 GST_DEBUG_FUNCPTR (gst_base_transform_acceptcaps_default);
396 klass->query = GST_DEBUG_FUNCPTR (gst_base_transform_default_query);
397 klass->propose_allocation =
398 GST_DEBUG_FUNCPTR (gst_base_transform_default_propose_allocation);
399 klass->transform_size =
400 GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_size);
402 klass->sink_event = GST_DEBUG_FUNCPTR (gst_base_transform_sink_eventfunc);
403 klass->src_event = GST_DEBUG_FUNCPTR (gst_base_transform_src_eventfunc);
404 klass->prepare_output_buffer =
405 GST_DEBUG_FUNCPTR (default_prepare_output_buffer);
406 klass->copy_metadata = GST_DEBUG_FUNCPTR (default_copy_metadata);
410 gst_base_transform_init (GstBaseTransform * trans,
411 GstBaseTransformClass * bclass)
413 GstPadTemplate *pad_template;
415 GST_DEBUG ("gst_base_transform_init");
417 trans->priv = GST_BASE_TRANSFORM_GET_PRIVATE (trans);
420 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
421 g_return_if_fail (pad_template != NULL);
422 trans->sinkpad = gst_pad_new_from_template (pad_template, "sink");
423 gst_pad_set_event_function (trans->sinkpad,
424 GST_DEBUG_FUNCPTR (gst_base_transform_sink_event));
425 gst_pad_set_chain_function (trans->sinkpad,
426 GST_DEBUG_FUNCPTR (gst_base_transform_chain));
427 gst_pad_set_activatemode_function (trans->sinkpad,
428 GST_DEBUG_FUNCPTR (gst_base_transform_sink_activate_mode));
429 gst_pad_set_query_function (trans->sinkpad,
430 GST_DEBUG_FUNCPTR (gst_base_transform_query));
431 gst_element_add_pad (GST_ELEMENT (trans), trans->sinkpad);
434 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
435 g_return_if_fail (pad_template != NULL);
436 trans->srcpad = gst_pad_new_from_template (pad_template, "src");
437 gst_pad_set_event_function (trans->srcpad,
438 GST_DEBUG_FUNCPTR (gst_base_transform_src_event));
439 gst_pad_set_getrange_function (trans->srcpad,
440 GST_DEBUG_FUNCPTR (gst_base_transform_getrange));
441 gst_pad_set_activatemode_function (trans->srcpad,
442 GST_DEBUG_FUNCPTR (gst_base_transform_src_activate_mode));
443 gst_pad_set_query_function (trans->srcpad,
444 GST_DEBUG_FUNCPTR (gst_base_transform_query));
445 gst_element_add_pad (GST_ELEMENT (trans), trans->srcpad);
447 g_mutex_init (&trans->transform_lock);
448 trans->priv->qos_enabled = DEFAULT_PROP_QOS;
449 trans->cache_caps1 = NULL;
450 trans->cache_caps2 = NULL;
451 trans->priv->pad_mode = GST_PAD_MODE_NONE;
452 trans->priv->gap_aware = FALSE;
454 trans->passthrough = FALSE;
455 if (bclass->transform == NULL) {
456 /* If no transform function, always_in_place is TRUE */
457 GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
458 trans->always_in_place = TRUE;
460 if (bclass->transform_ip == NULL) {
461 GST_DEBUG_OBJECT (trans, "setting passthrough TRUE");
462 trans->passthrough = TRUE;
466 trans->priv->processed = 0;
467 trans->priv->dropped = 0;
471 gst_base_transform_default_transform_caps (GstBaseTransform * trans,
472 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
476 GST_DEBUG_OBJECT (trans, "identity from: %" GST_PTR_FORMAT, caps);
477 /* no transform function, use the identity transform */
479 ret = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
481 ret = gst_caps_ref (caps);
486 /* given @caps on the src or sink pad (given by @direction)
487 * calculate the possible caps on the other pad.
489 * Returns new caps, unref after usage.
492 gst_base_transform_transform_caps (GstBaseTransform * trans,
493 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
496 GstBaseTransformClass *klass;
501 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
503 /* if there is a custom transform function, use this */
504 if (klass->transform_caps) {
505 GST_DEBUG_OBJECT (trans, "transform caps (direction = %d)", direction);
507 GST_LOG_OBJECT (trans, "from: %" GST_PTR_FORMAT, caps);
508 ret = klass->transform_caps (trans, direction, caps, filter);
509 GST_LOG_OBJECT (trans, " to: %" GST_PTR_FORMAT, ret);
511 #ifndef G_DISABLE_ASSERT
513 if (!gst_caps_is_subset (ret, filter)) {
514 GstCaps *intersection;
516 GST_ERROR_OBJECT (trans,
517 "transform_caps returned caps %" GST_PTR_FORMAT
518 " which are not a real subset of the filter caps %"
519 GST_PTR_FORMAT, ret, filter);
520 g_warning ("%s: transform_caps returned caps which are not a real "
521 "subset of the filter caps", GST_ELEMENT_NAME (trans));
524 gst_caps_intersect_full (filter, ret, GST_CAPS_INTERSECT_FIRST);
525 gst_caps_unref (ret);
532 GST_DEBUG_OBJECT (trans, "to: %" GST_PTR_FORMAT, ret);
538 gst_base_transform_default_transform_size (GstBaseTransform * trans,
539 GstPadDirection direction, GstCaps * caps, gsize size,
540 GstCaps * othercaps, gsize * othersize)
542 gsize inunitsize, outunitsize, units;
543 GstBaseTransformClass *klass;
545 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
547 if (klass->get_unit_size == NULL) {
548 /* if there is no transform_size and no unit_size, it means the
549 * element does not modify the size of a buffer */
552 /* there is no transform_size function, we have to use the unit_size
553 * functions. This method assumes there is a fixed unit_size associated with
554 * each caps. We provide the same amount of units on both sides. */
555 if (!gst_base_transform_get_unit_size (trans, caps, &inunitsize))
558 GST_DEBUG_OBJECT (trans,
559 "input size %" G_GSIZE_FORMAT ", input unit size %" G_GSIZE_FORMAT,
562 /* input size must be a multiple of the unit_size of the input caps */
563 if (inunitsize == 0 || (size % inunitsize != 0))
566 /* get the amount of units */
567 units = size / inunitsize;
569 /* now get the unit size of the output */
570 if (!gst_base_transform_get_unit_size (trans, othercaps, &outunitsize))
573 /* the output size is the unit_size times the amount of units on the
575 *othersize = units * outunitsize;
576 GST_DEBUG_OBJECT (trans, "transformed size to %" G_GSIZE_FORMAT,
584 GST_DEBUG_OBJECT (trans, "could not get in_size");
585 g_warning ("%s: could not get in_size", GST_ELEMENT_NAME (trans));
590 GST_DEBUG_OBJECT (trans, "Size %" G_GSIZE_FORMAT " is not a multiple of"
591 "unit size %" G_GSIZE_FORMAT, size, inunitsize);
592 g_warning ("%s: size %" G_GSIZE_FORMAT " is not a multiple of unit size %"
593 G_GSIZE_FORMAT, GST_ELEMENT_NAME (trans), size, inunitsize);
598 GST_DEBUG_OBJECT (trans, "could not get out_size");
599 g_warning ("%s: could not get out_size", GST_ELEMENT_NAME (trans));
604 /* transform a buffer of @size with @caps on the pad with @direction to
605 * the size of a buffer with @othercaps and store the result in @othersize
607 * We have two ways of doing this:
608 * 1) use a custom transform size function, this is for complicated custom
609 * cases with no fixed unit_size.
610 * 2) use the unit_size functions where there is a relationship between the
611 * caps and the size of a buffer.
614 gst_base_transform_transform_size (GstBaseTransform * trans,
615 GstPadDirection direction, GstCaps * caps,
616 gsize size, GstCaps * othercaps, gsize * othersize)
618 GstBaseTransformClass *klass;
619 gboolean ret = FALSE;
621 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
623 GST_DEBUG_OBJECT (trans,
624 "asked to transform size %" G_GSIZE_FORMAT " for caps %"
625 GST_PTR_FORMAT " to size for caps %" GST_PTR_FORMAT " in direction %s",
626 size, caps, othercaps, direction == GST_PAD_SRC ? "SRC" : "SINK");
628 if (klass->transform_size) {
629 /* if there is a custom transform function, use this */
630 ret = klass->transform_size (trans, direction, caps, size, othercaps,
636 /* get the caps that can be handled by @pad. We perform:
638 * - take the caps of peer of otherpad,
639 * - filter against the padtemplate of otherpad,
640 * - calculate all transforms of remaining caps
641 * - filter against template of @pad
643 * If there is no peer, we simply return the caps of the padtemplate of pad.
646 gst_base_transform_query_caps (GstBaseTransform * trans, GstPad * pad,
650 GstCaps *peercaps, *caps, *temp, *peerfilter = NULL;
653 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
655 /* we can do what the peer can */
658 GST_DEBUG_OBJECT (pad, "filter caps %" GST_PTR_FORMAT, filter);
660 /* filtered against our padtemplate on the other side */
661 templ = gst_pad_get_pad_template_caps (pad);
662 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
663 temp = gst_caps_intersect_full (filter, templ, GST_CAPS_INTERSECT_FIRST);
664 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
665 gst_caps_unref (templ);
667 /* then see what we can transform this to */
668 peerfilter = gst_base_transform_transform_caps (trans,
669 GST_PAD_DIRECTION (pad), temp, NULL);
670 GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, peerfilter);
671 gst_caps_unref (temp);
673 /* and filter against the template of this pad */
674 templ = gst_pad_get_pad_template_caps (otherpad);
675 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
676 /* We keep the caps sorted like the returned caps */
678 gst_caps_intersect_full (peerfilter, templ, GST_CAPS_INTERSECT_FIRST);
679 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
680 gst_caps_unref (peerfilter);
681 gst_caps_unref (templ);
685 peercaps = gst_pad_peer_query_caps (otherpad, peerfilter);
688 gst_caps_unref (peerfilter);
691 GST_DEBUG_OBJECT (pad, "peer caps %" GST_PTR_FORMAT, peercaps);
693 /* filtered against our padtemplate on the other side */
694 templ = gst_pad_get_pad_template_caps (otherpad);
695 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
696 temp = gst_caps_intersect_full (peercaps, templ, GST_CAPS_INTERSECT_FIRST);
697 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
698 gst_caps_unref (templ);
700 temp = gst_pad_get_pad_template_caps (otherpad);
703 /* then see what we can transform this to */
704 caps = gst_base_transform_transform_caps (trans,
705 GST_PAD_DIRECTION (otherpad), temp, filter);
706 GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, caps);
707 gst_caps_unref (temp);
712 /* and filter against the template of this pad */
713 templ = gst_pad_get_pad_template_caps (pad);
714 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
715 /* We keep the caps sorted like the returned caps */
716 temp = gst_caps_intersect_full (caps, templ, GST_CAPS_INTERSECT_FIRST);
717 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
718 gst_caps_unref (caps);
719 gst_caps_unref (templ);
722 /* Now try if we can put the untransformed downstream caps first */
723 temp = gst_caps_intersect_full (peercaps, caps, GST_CAPS_INTERSECT_FIRST);
724 if (!gst_caps_is_empty (temp)) {
725 gst_caps_merge (temp, caps);
728 gst_caps_unref (temp);
731 gst_caps_unref (caps);
732 /* no peer or the peer can do anything, our padtemplate is enough then */
733 caps = gst_pad_get_pad_template_caps (pad);
738 temp = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
739 gst_caps_unref (caps);
745 GST_DEBUG_OBJECT (trans, "returning %" GST_PTR_FORMAT, caps);
748 gst_caps_unref (peercaps);
753 /* takes ownership of the pool and allocator */
755 gst_base_transform_set_allocation (GstBaseTransform * trans,
756 GstBufferPool * pool, GstAllocator * allocator, guint prefix,
759 GstAllocator *oldalloc;
760 GstBufferPool *oldpool;
761 GstBaseTransformPrivate *priv = trans->priv;
765 GST_DEBUG_OBJECT (trans, "setting pool %p active", pool);
766 if (!gst_buffer_pool_set_active (pool, TRUE))
767 goto activate_failed;
770 GST_OBJECT_LOCK (trans);
771 oldpool = priv->pool;
773 oldalloc = priv->allocator;
774 priv->allocator = allocator;
775 priv->prefix = prefix;
776 priv->alignment = alignment;
777 GST_OBJECT_UNLOCK (trans);
780 GST_DEBUG_OBJECT (trans, "deactivating old pool %p", oldpool);
781 gst_buffer_pool_set_active (oldpool, FALSE);
782 gst_object_unref (oldpool);
785 gst_allocator_unref (oldalloc);
792 GST_ERROR_OBJECT (trans, "failed to activate bufferpool.");
798 gst_base_transform_do_bufferpool (GstBaseTransform * trans, GstCaps * outcaps)
801 gboolean result = TRUE;
802 GstBufferPool *pool = NULL, *oldpool;
803 guint size, min, max, prefix, alignment;
804 GstBaseTransformClass *klass;
805 GstAllocator *allocator = NULL;
807 /* there are these possibilities:
809 * 1) we negotiated passthrough, we can proxy the bufferpool directly and we
810 * will do that whenever some upstream does an allocation query.
811 * 2) we need to do a transform, we need to get a bufferpool from downstream
812 * and configure it. When upstream does the ALLOCATION query, the
813 * propose_allocation vmethod will be called and we will configure the
814 * upstream allocator with our proposed values then.
818 oldpool = trans->priv->pool;
820 GST_DEBUG_OBJECT (trans, "unreffing old pool");
821 gst_buffer_pool_set_active (oldpool, FALSE);
822 gst_object_unref (oldpool);
823 trans->priv->pool = oldpool = NULL;
826 if (trans->passthrough || trans->always_in_place) {
827 /* we are in passthrough, the input buffer is never copied and always passed
828 * along. We never allocate an output buffer on the srcpad. What we do is
829 * let the upstream element decide if it wants to use a bufferpool and
830 * then we will proxy the downstream pool */
831 GST_DEBUG_OBJECT (trans, "we're passthough, delay bufferpool");
835 /* not passthrough, we need to allocate */
836 /* find a pool for the negotiated caps now */
837 GST_DEBUG_OBJECT (trans, "doing allocation query");
838 query = gst_query_new_allocation (outcaps, TRUE);
839 if (!gst_pad_peer_query (trans->srcpad, query)) {
840 /* not a problem, just debug a little */
841 GST_DEBUG_OBJECT (trans, "peer ALLOCATION query failed");
844 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
846 GST_DEBUG_OBJECT (trans, "calling decide_allocation");
847 if (G_LIKELY (klass->decide_allocation))
848 if ((result = klass->decide_allocation (trans, query)) == FALSE)
849 goto no_decide_allocation;
851 /* we got configuration from our peer, parse them */
852 gst_query_parse_allocation_params (query, &size, &min, &max, &prefix,
856 /* no size, we have variable size buffers */
857 if (gst_query_get_n_allocation_memories (query) > 0) {
858 if ((allocator = gst_query_parse_nth_allocation_memory (query, 0)))
859 gst_allocator_ref (allocator);
861 GST_DEBUG_OBJECT (trans, "no size, using allocator %p", allocator);
862 } else if (pool == NULL) {
863 GstStructure *config;
865 /* we did not get a pool, make one ourselves then */
866 pool = gst_buffer_pool_new ();
868 GST_DEBUG_OBJECT (trans, "no pool, making one");
869 config = gst_buffer_pool_get_config (pool);
870 gst_buffer_pool_config_set (config, outcaps, size, min, max, prefix,
872 gst_buffer_pool_set_config (pool, config);
875 gst_query_unref (query);
879 gst_base_transform_set_allocation (trans, pool, allocator, prefix,
885 no_decide_allocation:
887 GST_WARNING_OBJECT (trans, "Subclass failed to decide allocation");
888 gst_query_unref (query);
894 /* function triggered when the in and out caps are negotiated and need
895 * to be configured in the subclass. */
897 gst_base_transform_configure_caps (GstBaseTransform * trans, GstCaps * in,
901 GstBaseTransformClass *klass;
903 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
905 GST_DEBUG_OBJECT (trans, "in caps: %" GST_PTR_FORMAT, in);
906 GST_DEBUG_OBJECT (trans, "out caps: %" GST_PTR_FORMAT, out);
908 /* clear the cache */
909 gst_caps_replace (&trans->cache_caps1, NULL);
910 gst_caps_replace (&trans->cache_caps2, NULL);
912 /* figure out same caps state */
913 trans->have_same_caps = gst_caps_is_equal (in, out);
914 GST_DEBUG_OBJECT (trans, "have_same_caps: %d", trans->have_same_caps);
916 /* If we've a transform_ip method and same input/output caps, set in_place
917 * by default. If for some reason the sub-class prefers using a transform
918 * function, it can clear the in place flag in the set_caps */
919 gst_base_transform_set_in_place (trans,
920 klass->transform_ip && trans->have_same_caps);
922 /* Set the passthrough if the class wants passthrough_on_same_caps
923 * and we have the same caps on each pad */
924 if (klass->passthrough_on_same_caps)
925 gst_base_transform_set_passthrough (trans, trans->have_same_caps);
927 /* now configure the element with the caps */
928 if (klass->set_caps) {
929 GST_DEBUG_OBJECT (trans, "Calling set_caps method to setup caps");
930 ret = klass->set_caps (trans, in, out);
933 trans->negotiated = ret;
939 gst_base_transform_default_fixate_caps (GstBaseTransform * trans,
940 GstPadDirection direction, GstCaps * caps, GstCaps * othercaps)
942 othercaps = gst_caps_make_writable (othercaps);
943 gst_caps_fixate (othercaps);
944 GST_DEBUG_OBJECT (trans, "fixated to %" GST_PTR_FORMAT, othercaps);
949 /* given a fixed @caps on @pad, create the best possible caps for the
951 * @caps must be fixed when calling this function.
953 * This function calls the transform caps vmethod of the basetransform to figure
954 * out the possible target formats. It then tries to select the best format from
957 * - attempt passthrough if the target caps is a superset of the input caps
958 * - fixating by using peer caps
959 * - fixating with transform fixate function
960 * - fixating with pad fixate functions.
962 * this function returns a caps that can be transformed into and is accepted by
966 gst_base_transform_find_transform (GstBaseTransform * trans, GstPad * pad,
969 GstBaseTransformClass *klass;
970 GstPad *otherpad, *otherpeer;
974 /* caps must be fixed here, this is a programming error if it's not */
975 g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
977 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
979 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
980 otherpeer = gst_pad_get_peer (otherpad);
982 /* see how we can transform the input caps. We need to do this even for
983 * passthrough because it might be possible that this element cannot support
984 * passthrough at all. */
985 othercaps = gst_base_transform_transform_caps (trans,
986 GST_PAD_DIRECTION (pad), caps, NULL);
988 /* The caps we can actually output is the intersection of the transformed
989 * caps with the pad template for the pad */
991 GstCaps *intersect, *templ_caps;
993 templ_caps = gst_pad_get_pad_template_caps (otherpad);
994 GST_DEBUG_OBJECT (trans,
995 "intersecting against padtemplate %" GST_PTR_FORMAT, templ_caps);
998 gst_caps_intersect_full (othercaps, templ_caps,
999 GST_CAPS_INTERSECT_FIRST);
1001 gst_caps_unref (othercaps);
1002 gst_caps_unref (templ_caps);
1003 othercaps = intersect;
1006 /* check if transform is empty */
1007 if (!othercaps || gst_caps_is_empty (othercaps))
1010 /* if the othercaps are not fixed, we need to fixate them, first attempt
1011 * is by attempting passthrough if the othercaps are a superset of caps. */
1012 /* FIXME. maybe the caps is not fixed because it has multiple structures of
1014 is_fixed = gst_caps_is_fixed (othercaps);
1016 GST_DEBUG_OBJECT (trans,
1017 "transform returned non fixed %" GST_PTR_FORMAT, othercaps);
1019 /* Now let's see what the peer suggests based on our transformed caps */
1021 GstCaps *peercaps, *intersection, *templ_caps;
1023 GST_DEBUG_OBJECT (trans,
1024 "Checking peer caps with filter %" GST_PTR_FORMAT, othercaps);
1026 peercaps = gst_pad_query_caps (otherpeer, othercaps);
1027 GST_DEBUG_OBJECT (trans, "Resulted in %" GST_PTR_FORMAT, peercaps);
1028 if (!gst_caps_is_empty (peercaps)) {
1029 templ_caps = gst_pad_get_pad_template_caps (otherpad);
1031 GST_DEBUG_OBJECT (trans,
1032 "Intersecting with template caps %" GST_PTR_FORMAT, templ_caps);
1035 gst_caps_intersect_full (peercaps, templ_caps,
1036 GST_CAPS_INTERSECT_FIRST);
1037 GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1039 gst_caps_unref (peercaps);
1040 gst_caps_unref (templ_caps);
1041 peercaps = intersection;
1043 GST_DEBUG_OBJECT (trans,
1044 "Intersecting with transformed caps %" GST_PTR_FORMAT, othercaps);
1046 gst_caps_intersect_full (peercaps, othercaps,
1047 GST_CAPS_INTERSECT_FIRST);
1048 GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1050 gst_caps_unref (peercaps);
1051 gst_caps_unref (othercaps);
1052 othercaps = intersection;
1054 othercaps = peercaps;
1057 is_fixed = gst_caps_is_fixed (othercaps);
1059 GST_DEBUG_OBJECT (trans, "no peer, doing passthrough");
1060 gst_caps_unref (othercaps);
1061 othercaps = gst_caps_ref (caps);
1065 if (gst_caps_is_empty (othercaps))
1066 goto no_transform_possible;
1068 GST_DEBUG ("have %sfixed caps %" GST_PTR_FORMAT, (is_fixed ? "" : "non-"),
1071 /* second attempt at fixation, call the fixate vmethod */
1072 /* caps could be fixed but the subclass may want to add fields */
1073 if (klass->fixate_caps) {
1074 GST_DEBUG_OBJECT (trans, "calling fixate_caps for %" GST_PTR_FORMAT
1075 " using caps %" GST_PTR_FORMAT " on pad %s:%s", othercaps, caps,
1076 GST_DEBUG_PAD_NAME (otherpad));
1077 /* note that we pass the complete array of structures to the fixate
1078 * function, it needs to truncate itself */
1080 klass->fixate_caps (trans, GST_PAD_DIRECTION (pad), caps, othercaps);
1081 is_fixed = gst_caps_is_fixed (othercaps);
1082 GST_DEBUG_OBJECT (trans, "after fixating %" GST_PTR_FORMAT, othercaps);
1085 /* caps should be fixed now, if not we have to fail. */
1087 goto could_not_fixate;
1089 /* and peer should accept */
1090 if (otherpeer && !gst_pad_query_accept_caps (otherpeer, othercaps))
1091 goto peer_no_accept;
1093 GST_DEBUG_OBJECT (trans, "Input caps were %" GST_PTR_FORMAT
1094 ", and got final caps %" GST_PTR_FORMAT, caps, othercaps);
1097 gst_object_unref (otherpeer);
1104 GST_DEBUG_OBJECT (trans,
1105 "transform returned useless %" GST_PTR_FORMAT, othercaps);
1108 no_transform_possible:
1110 GST_DEBUG_OBJECT (trans,
1111 "transform could not transform %" GST_PTR_FORMAT
1112 " in anything we support", caps);
1117 GST_DEBUG_OBJECT (trans, "FAILED to fixate %" GST_PTR_FORMAT, othercaps);
1122 GST_DEBUG_OBJECT (trans, "FAILED to get peer of %" GST_PTR_FORMAT
1123 " to accept %" GST_PTR_FORMAT, otherpad, othercaps);
1129 gst_object_unref (otherpeer);
1131 gst_caps_unref (othercaps);
1137 gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
1138 GstPadDirection direction, GstCaps * caps)
1142 GstCaps *othercaps = NULL;
1144 gboolean ret = TRUE;
1147 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
1149 /* we need fixed caps for the check, fall back to the default implementation
1151 if (!gst_caps_is_fixed (caps))
1156 GST_DEBUG_OBJECT (trans, "non fixed accept caps %" GST_PTR_FORMAT, caps);
1158 /* get all the formats we can handle on this pad */
1159 if (direction == GST_PAD_SRC)
1160 allowed = gst_pad_query_caps (trans->srcpad, NULL);
1162 allowed = gst_pad_query_caps (trans->sinkpad, NULL);
1165 GST_DEBUG_OBJECT (trans, "gst_pad_query_caps() failed");
1166 goto no_transform_possible;
1169 GST_DEBUG_OBJECT (trans, "allowed caps %" GST_PTR_FORMAT, allowed);
1171 /* intersect with the requested format */
1172 ret = gst_caps_is_subset (caps, allowed);
1173 gst_caps_unref (allowed);
1176 goto no_transform_possible;
1180 GST_DEBUG_OBJECT (pad, "accept caps %" GST_PTR_FORMAT, caps);
1182 /* find best possible caps for the other pad as a way to see if we can
1183 * transform this caps. */
1184 othercaps = gst_base_transform_find_transform (trans, pad, caps, FALSE);
1185 if (!othercaps || gst_caps_is_empty (othercaps))
1186 goto no_transform_possible;
1188 GST_DEBUG_OBJECT (pad, "we can transform to %" GST_PTR_FORMAT, othercaps);
1194 /* We know it's always NULL since we never use it */
1196 gst_caps_unref (othercaps);
1202 no_transform_possible:
1204 GST_DEBUG_OBJECT (trans,
1205 "transform could not transform %" GST_PTR_FORMAT
1206 " in anything we support", caps);
1212 /* called when new caps arrive on the sink or source pad,
1213 * We try to find the best caps for the other side using our _find_transform()
1214 * function. If there are caps, we configure the transform for this new
1217 * FIXME, this function is currently commutative but this should not really be
1218 * because we never set caps starting from the srcpad.
1221 gst_base_transform_setcaps (GstBaseTransform * trans, GstPad * pad,
1224 GstPad *otherpad, *otherpeer;
1225 GstCaps *othercaps = NULL;
1226 gboolean ret = TRUE;
1227 GstCaps *incaps, *outcaps;
1229 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
1230 otherpeer = gst_pad_get_peer (otherpad);
1232 GST_DEBUG_OBJECT (pad, "have new caps %p %" GST_PTR_FORMAT, caps, caps);
1234 /* find best possible caps for the other pad */
1235 othercaps = gst_base_transform_find_transform (trans, pad, caps);
1236 if (!othercaps || gst_caps_is_empty (othercaps))
1237 goto no_transform_possible;
1239 /* configure the element now */
1240 /* make sure in and out caps are correct */
1241 if (pad == trans->sinkpad) {
1243 outcaps = othercaps;
1249 /* if we have the same caps, we can optimize and reuse the input caps */
1250 if (gst_caps_is_equal (incaps, outcaps)) {
1251 GST_INFO_OBJECT (trans, "reuse caps");
1252 gst_caps_unref (othercaps);
1253 outcaps = othercaps = gst_caps_ref (incaps);
1256 /* call configure now */
1257 if (!(ret = gst_base_transform_configure_caps (trans, incaps, outcaps)))
1258 goto failed_configure;
1260 GST_OBJECT_LOCK (trans->sinkpad);
1261 GST_OBJECT_FLAG_UNSET (trans->srcpad, GST_PAD_FLAG_NEED_RECONFIGURE);
1262 trans->priv->reconfigure = FALSE;
1263 GST_OBJECT_UNLOCK (trans->sinkpad);
1265 /* we know this will work, we implement the setcaps */
1266 gst_pad_push_event (otherpad, gst_event_new_caps (othercaps));
1268 if (pad == trans->srcpad && trans->priv->pad_mode == GST_PAD_MODE_PULL) {
1270 ret &= gst_pad_push_event (otherpeer, gst_event_new_caps (othercaps));
1272 GST_INFO_OBJECT (trans, "otherpeer setcaps(%" GST_PTR_FORMAT ") failed",
1278 /* try to get a pool when needed */
1279 ret = gst_base_transform_do_bufferpool (trans, othercaps);
1284 gst_object_unref (otherpeer);
1286 gst_caps_unref (othercaps);
1288 trans->negotiated = ret;
1293 no_transform_possible:
1295 GST_WARNING_OBJECT (trans,
1296 "transform could not transform %" GST_PTR_FORMAT
1297 " in anything we support", caps);
1303 GST_WARNING_OBJECT (trans, "FAILED to configure caps %" GST_PTR_FORMAT
1304 " to accept %" GST_PTR_FORMAT, otherpad, othercaps);
1311 gst_base_transform_default_propose_allocation (GstBaseTransform * trans,
1312 gboolean passthrough, GstQuery * query)
1317 GST_DEBUG_OBJECT (trans, "doing passthrough query");
1318 ret = gst_pad_peer_query (trans->srcpad, query);
1326 gst_base_transform_default_query (GstBaseTransform * trans,
1327 GstPadDirection direction, GstQuery * query)
1329 gboolean ret = FALSE;
1330 GstPad *pad, *otherpad;
1331 GstBaseTransformClass *klass;
1333 if (direction == GST_PAD_SRC) {
1334 pad = trans->srcpad;
1335 otherpad = trans->sinkpad;
1337 pad = trans->sinkpad;
1338 otherpad = trans->srcpad;
1341 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1343 switch (GST_QUERY_TYPE (query)) {
1344 case GST_QUERY_ALLOCATION:
1346 gboolean passthrough;
1348 /* can only be done on the sinkpad */
1349 if (direction != GST_PAD_SINK)
1352 GST_BASE_TRANSFORM_LOCK (trans);
1353 passthrough = trans->passthrough;
1354 GST_BASE_TRANSFORM_UNLOCK (trans);
1356 GST_DEBUG_OBJECT (trans, "propose %spassthrough allocation values",
1357 (passthrough ? "" : "non-"));
1359 /* pass the query to the propose_allocation vmethod if any */
1360 if (G_LIKELY (klass->propose_allocation))
1361 ret = klass->propose_allocation (trans, passthrough, query);
1365 GST_DEBUG_OBJECT (trans, "ALLOCATION ret %d, %" GST_PTR_FORMAT, ret,
1369 case GST_QUERY_POSITION:
1373 gst_query_parse_position (query, &format, NULL);
1374 if (format == GST_FORMAT_TIME && trans->segment.format == GST_FORMAT_TIME) {
1378 if ((direction == GST_PAD_SINK)
1379 || (trans->priv->position_out == GST_CLOCK_TIME_NONE)) {
1381 gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1382 trans->segment.position);
1384 pos = gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1385 trans->priv->position_out);
1387 gst_query_set_position (query, format, pos);
1389 ret = gst_pad_peer_query (otherpad, query);
1393 case GST_QUERY_ACCEPT_CAPS:
1397 gst_query_parse_accept_caps (query, &caps);
1398 if (klass->accept_caps) {
1399 ret = klass->accept_caps (trans, direction, caps);
1400 gst_query_set_accept_caps_result (query, ret);
1401 /* return TRUE, we answered the query */
1406 case GST_QUERY_CAPS:
1408 GstCaps *filter, *caps;
1410 gst_query_parse_caps (query, &filter);
1411 caps = gst_base_transform_query_caps (trans, pad, filter);
1412 gst_query_set_caps_result (query, caps);
1413 gst_caps_unref (caps);
1418 ret = gst_pad_peer_query (otherpad, query);
1427 gst_base_transform_query (GstPad * pad, GstObject * parent, GstQuery * query)
1429 GstBaseTransform *trans;
1430 GstBaseTransformClass *bclass;
1431 gboolean ret = FALSE;
1433 trans = GST_BASE_TRANSFORM (parent);
1434 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1437 ret = bclass->query (trans, GST_PAD_DIRECTION (pad), query);
1442 /* this function either returns the input buffer without incrementing the
1443 * refcount or it allocates a new (writable) buffer */
1444 static GstFlowReturn
1445 default_prepare_output_buffer (GstBaseTransform * trans,
1446 GstBuffer * inbuf, GstBuffer ** outbuf)
1448 GstBaseTransformPrivate *priv;
1449 GstFlowReturn ret = GST_FLOW_OK;
1450 GstBaseTransformClass *bclass;
1451 GstCaps *incaps, *outcaps;
1452 gsize insize, outsize;
1456 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1458 /* figure out how to allocate an output buffer */
1459 if (trans->passthrough) {
1460 /* passthrough, we will not modify the incomming buffer so we can just
1462 GST_DEBUG_OBJECT (trans, "passthrough: reusing input buffer");
1467 /* we can't reuse the input buffer */
1469 GST_DEBUG_OBJECT (trans, "using pool alloc");
1470 ret = gst_buffer_pool_acquire_buffer (priv->pool, outbuf, NULL);
1474 /* no pool, we need to figure out the size of the output buffer first */
1475 if ((bclass->transform_ip != NULL) && trans->always_in_place) {
1476 /* we want to do an in-place alloc */
1477 if (gst_buffer_is_writable (inbuf)) {
1478 GST_DEBUG_OBJECT (trans, "inplace reuse writable input buffer");
1481 GST_DEBUG_OBJECT (trans, "making writable buffer copy");
1482 /* we make a copy of the input buffer */
1483 *outbuf = gst_buffer_copy (inbuf);
1488 /* else use the transform function to get the size */
1489 incaps = gst_pad_get_current_caps (trans->sinkpad);
1490 outcaps = gst_pad_get_current_caps (trans->srcpad);
1492 GST_DEBUG_OBJECT (trans, "getting output size for alloc");
1493 /* copy transform, figure out the output size */
1494 insize = gst_buffer_get_size (inbuf);
1495 res = gst_base_transform_transform_size (trans,
1496 GST_PAD_SINK, incaps, insize, outcaps, &outsize);
1498 gst_caps_unref (incaps);
1499 gst_caps_unref (outcaps);
1504 GST_DEBUG_OBJECT (trans, "doing alloc of size %" G_GSIZE_FORMAT, outsize);
1505 *outbuf = gst_buffer_new_allocate (priv->allocator, outsize, priv->alignment);
1508 /* copy the metadata */
1509 if (bclass->copy_metadata)
1510 if (!bclass->copy_metadata (trans, inbuf, *outbuf)) {
1511 /* something failed, post a warning */
1512 GST_ELEMENT_WARNING (trans, STREAM, NOT_IMPLEMENTED,
1513 ("could not copy metadata"), (NULL));
1522 GST_ERROR_OBJECT (trans, "unknown output size");
1523 return GST_FLOW_ERROR;
1528 default_copy_metadata (GstBaseTransform * trans,
1529 GstBuffer * inbuf, GstBuffer * outbuf)
1531 GstBaseTransformPrivate *priv = trans->priv;
1533 /* now copy the metadata */
1534 GST_DEBUG_OBJECT (trans, "copying metadata");
1536 /* this should not happen, buffers allocated from a pool or with
1537 * new_allocate should always be writable. */
1538 if (!gst_buffer_is_writable (outbuf))
1541 /* when we get here, the metadata should be writable */
1542 gst_buffer_copy_into (outbuf, inbuf,
1543 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1545 /* clear the GAP flag when the subclass does not understand it */
1546 if (!priv->gap_aware)
1547 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_GAP);
1554 GST_WARNING_OBJECT (trans, "buffer %p not writable", outbuf);
1559 /* Given @caps calcultate the size of one unit.
1561 * For video caps, this is the size of one frame (and thus one buffer).
1562 * For audio caps, this is the size of one sample.
1564 * These values are cached since they do not change and the calculation
1565 * potentially involves parsing caps and other expensive stuff.
1567 * We have two cache locations to store the size, one for the source caps
1568 * and one for the sink caps.
1570 * this function returns FALSE if no size could be calculated.
1573 gst_base_transform_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
1576 gboolean res = FALSE;
1577 GstBaseTransformClass *bclass;
1579 /* see if we have the result cached */
1580 if (trans->cache_caps1 == caps) {
1581 *size = trans->cache_caps1_size;
1582 GST_DEBUG_OBJECT (trans,
1583 "returned %" G_GSIZE_FORMAT " from first cache", *size);
1586 if (trans->cache_caps2 == caps) {
1587 *size = trans->cache_caps2_size;
1588 GST_DEBUG_OBJECT (trans,
1589 "returned %" G_GSIZE_FORMAT " from second cached", *size);
1593 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1594 res = bclass->get_unit_size (trans, caps, size);
1595 GST_DEBUG_OBJECT (trans,
1596 "caps %" GST_PTR_FORMAT ") has unit size %" G_GSIZE_FORMAT ", res %s",
1597 caps, *size, res ? "TRUE" : "FALSE");
1600 /* and cache the values */
1601 if (trans->cache_caps1 == NULL) {
1602 gst_caps_replace (&trans->cache_caps1, caps);
1603 trans->cache_caps1_size = *size;
1604 GST_DEBUG_OBJECT (trans,
1605 "caching %" G_GSIZE_FORMAT " in first cache", *size);
1606 } else if (trans->cache_caps2 == NULL) {
1607 gst_caps_replace (&trans->cache_caps2, caps);
1608 trans->cache_caps2_size = *size;
1609 GST_DEBUG_OBJECT (trans,
1610 "caching %" G_GSIZE_FORMAT " in second cache", *size);
1612 GST_DEBUG_OBJECT (trans, "no free spot to cache unit_size");
1619 gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
1622 GstBaseTransform *trans;
1623 GstBaseTransformClass *bclass;
1624 gboolean ret = TRUE;
1626 trans = GST_BASE_TRANSFORM (parent);
1627 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1629 if (bclass->sink_event)
1630 ret = bclass->sink_event (trans, event);
1632 gst_event_unref (event);
1638 gst_base_transform_sink_eventfunc (GstBaseTransform * trans, GstEvent * event)
1640 gboolean ret = TRUE, forward = TRUE;
1642 switch (GST_EVENT_TYPE (event)) {
1643 case GST_EVENT_FLUSH_START:
1645 case GST_EVENT_FLUSH_STOP:
1646 GST_OBJECT_LOCK (trans);
1647 /* reset QoS parameters */
1648 trans->priv->proportion = 1.0;
1649 trans->priv->earliest_time = -1;
1650 trans->priv->discont = FALSE;
1651 trans->priv->processed = 0;
1652 trans->priv->dropped = 0;
1653 GST_OBJECT_UNLOCK (trans);
1654 /* we need new segment info after the flush. */
1655 trans->have_segment = FALSE;
1656 gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
1657 trans->priv->position_out = GST_CLOCK_TIME_NONE;
1663 case GST_EVENT_CAPS:
1667 gst_event_parse_caps (event, &caps);
1668 ret = gst_base_transform_setcaps (trans, trans->sinkpad, caps);
1673 case GST_EVENT_SEGMENT:
1675 gst_event_copy_segment (event, &trans->segment);
1676 trans->have_segment = TRUE;
1678 GST_DEBUG_OBJECT (trans, "received SEGMENT %" GST_SEGMENT_FORMAT,
1687 ret = gst_pad_push_event (trans->srcpad, event);
1689 gst_event_unref (event);
1695 gst_base_transform_src_event (GstPad * pad, GstObject * parent,
1698 GstBaseTransform *trans;
1699 GstBaseTransformClass *bclass;
1700 gboolean ret = TRUE;
1702 trans = GST_BASE_TRANSFORM (parent);
1703 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1705 if (bclass->src_event)
1706 ret = bclass->src_event (trans, event);
1708 gst_event_unref (event);
1714 gst_base_transform_src_eventfunc (GstBaseTransform * trans, GstEvent * event)
1718 GST_DEBUG_OBJECT (trans, "handling event %p %" GST_PTR_FORMAT, event, event);
1720 switch (GST_EVENT_TYPE (event)) {
1721 case GST_EVENT_SEEK:
1723 case GST_EVENT_NAVIGATION:
1728 GstClockTimeDiff diff;
1729 GstClockTime timestamp;
1731 gst_event_parse_qos (event, NULL, &proportion, &diff, ×tamp);
1732 gst_base_transform_update_qos (trans, proportion, diff, timestamp);
1739 ret = gst_pad_push_event (trans->sinkpad, event);
1744 /* perform a transform on @inbuf and put the result in @outbuf.
1746 * This function is common to the push and pull-based operations.
1748 * This function takes ownership of @inbuf */
1749 static GstFlowReturn
1750 gst_base_transform_handle_buffer (GstBaseTransform * trans, GstBuffer * inbuf,
1751 GstBuffer ** outbuf)
1753 GstBaseTransformClass *bclass;
1754 GstFlowReturn ret = GST_FLOW_OK;
1755 gboolean want_in_place;
1756 GstClockTime running_time;
1757 GstClockTime timestamp;
1758 gboolean reconfigure;
1760 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1762 GST_OBJECT_LOCK (trans->sinkpad);
1763 reconfigure = GST_PAD_NEEDS_RECONFIGURE (trans->srcpad)
1764 || trans->priv->reconfigure;
1765 GST_OBJECT_FLAG_UNSET (trans->srcpad, GST_PAD_FLAG_NEED_RECONFIGURE);
1766 trans->priv->reconfigure = FALSE;
1767 GST_OBJECT_UNLOCK (trans->sinkpad);
1769 if (G_UNLIKELY (reconfigure)) {
1772 GST_DEBUG_OBJECT (trans, "we had a pending reconfigure");
1774 incaps = gst_pad_get_current_caps (trans->sinkpad);
1776 goto no_reconfigure;
1778 /* if we need to reconfigure we pretend a buffer with new caps arrived. This
1779 * will reconfigure the transform with the new output format. We can only
1780 * do this if the buffer actually has caps. */
1781 if (!gst_base_transform_setcaps (trans, trans->sinkpad, incaps)) {
1782 gst_caps_unref (incaps);
1783 goto not_negotiated;
1785 gst_caps_unref (incaps);
1789 if (GST_BUFFER_OFFSET_IS_VALID (inbuf))
1790 GST_DEBUG_OBJECT (trans,
1791 "handling buffer %p of size %" G_GSIZE_FORMAT " and offset %"
1792 G_GUINT64_FORMAT, inbuf, gst_buffer_get_size (inbuf),
1793 GST_BUFFER_OFFSET (inbuf));
1795 GST_DEBUG_OBJECT (trans,
1796 "handling buffer %p of size %" G_GSIZE_FORMAT " and offset NONE", inbuf,
1797 gst_buffer_get_size (inbuf));
1799 /* Don't allow buffer handling before negotiation, except in passthrough mode
1800 * or if the class doesn't implement a set_caps function (in which case it doesn't
1803 if (!trans->negotiated && !trans->passthrough && (bclass->set_caps != NULL))
1804 goto not_negotiated;
1806 /* Set discont flag so we can mark the outgoing buffer */
1807 if (GST_BUFFER_IS_DISCONT (inbuf)) {
1808 GST_DEBUG_OBJECT (trans, "got DISCONT buffer %p", inbuf);
1809 trans->priv->discont = TRUE;
1812 /* can only do QoS if the segment is in TIME */
1813 if (trans->segment.format != GST_FORMAT_TIME)
1816 /* QOS is done on the running time of the buffer, get it now */
1817 timestamp = GST_BUFFER_TIMESTAMP (inbuf);
1818 running_time = gst_segment_to_running_time (&trans->segment, GST_FORMAT_TIME,
1821 if (running_time != -1) {
1823 GstClockTime earliest_time;
1826 /* lock for getting the QoS parameters that are set (in a different thread)
1827 * with the QOS events */
1828 GST_OBJECT_LOCK (trans);
1829 earliest_time = trans->priv->earliest_time;
1830 proportion = trans->priv->proportion;
1831 /* check for QoS, don't perform conversion for buffers
1832 * that are known to be late. */
1833 need_skip = trans->priv->qos_enabled &&
1834 earliest_time != -1 && running_time <= earliest_time;
1835 GST_OBJECT_UNLOCK (trans);
1838 GstMessage *qos_msg;
1839 GstClockTime duration;
1840 guint64 stream_time;
1843 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "skipping transform: qostime %"
1844 GST_TIME_FORMAT " <= %" GST_TIME_FORMAT,
1845 GST_TIME_ARGS (running_time), GST_TIME_ARGS (earliest_time));
1847 trans->priv->dropped++;
1849 duration = GST_BUFFER_DURATION (inbuf);
1851 gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1853 jitter = GST_CLOCK_DIFF (running_time, earliest_time);
1856 gst_message_new_qos (GST_OBJECT_CAST (trans), FALSE, running_time,
1857 stream_time, timestamp, duration);
1858 gst_message_set_qos_values (qos_msg, jitter, proportion, 1000000);
1859 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS,
1860 trans->priv->processed, trans->priv->dropped);
1861 gst_element_post_message (GST_ELEMENT_CAST (trans), qos_msg);
1863 /* mark discont for next buffer */
1864 trans->priv->discont = TRUE;
1871 /* first try to allocate an output buffer based on the currently negotiated
1872 * format. outbuf will contain a buffer suitable for doing the configured
1873 * transform after this function. */
1874 if (bclass->prepare_output_buffer == NULL)
1877 GST_DEBUG_OBJECT (trans, "calling prepare buffer");
1878 ret = bclass->prepare_output_buffer (trans, inbuf, outbuf);
1880 if (ret != GST_FLOW_OK || *outbuf == NULL)
1883 GST_DEBUG_OBJECT (trans, "using allocated buffer in %p, out %p", inbuf,
1886 /* now perform the needed transform */
1887 if (trans->passthrough) {
1888 /* In passthrough mode, give transform_ip a look at the
1889 * buffer, without making it writable, or just push the
1891 if (bclass->transform_ip) {
1892 GST_DEBUG_OBJECT (trans, "doing passthrough transform");
1893 ret = bclass->transform_ip (trans, *outbuf);
1895 GST_DEBUG_OBJECT (trans, "element is in passthrough");
1898 want_in_place = (bclass->transform_ip != NULL) && trans->always_in_place;
1900 if (want_in_place) {
1901 GST_DEBUG_OBJECT (trans, "doing inplace transform");
1902 ret = bclass->transform_ip (trans, *outbuf);
1904 GST_DEBUG_OBJECT (trans, "doing non-inplace transform");
1906 if (bclass->transform)
1907 ret = bclass->transform (trans, inbuf, *outbuf);
1909 ret = GST_FLOW_NOT_SUPPORTED;
1914 /* only unref input buffer if we allocated a new outbuf buffer. If we reused
1915 * the input buffer, no refcount is changed to keep the input buffer writable
1917 if (*outbuf != inbuf)
1918 gst_buffer_unref (inbuf);
1925 gst_buffer_unref (inbuf);
1927 GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED,
1928 ("not negotiated"), ("not negotiated"));
1929 return GST_FLOW_NOT_NEGOTIATED;
1933 gst_buffer_unref (inbuf);
1934 GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED,
1935 ("Sub-class has no prepare_output_buffer implementation"), (NULL));
1936 return GST_FLOW_NOT_SUPPORTED;
1940 gst_buffer_unref (inbuf);
1942 GST_WARNING_OBJECT (trans, "could not get buffer from pool: %s",
1943 gst_flow_get_name (ret));
1948 /* FIXME, getrange is broken, need to pull range from the other
1949 * end based on the transform_size result.
1951 static GstFlowReturn
1952 gst_base_transform_getrange (GstPad * pad, GstObject * parent, guint64 offset,
1953 guint length, GstBuffer ** buffer)
1955 GstBaseTransform *trans;
1956 GstBaseTransformClass *klass;
1960 trans = GST_BASE_TRANSFORM (parent);
1962 ret = gst_pad_pull_range (trans->sinkpad, offset, length, &inbuf);
1963 if (G_UNLIKELY (ret != GST_FLOW_OK))
1966 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1967 if (klass->before_transform)
1968 klass->before_transform (trans, inbuf);
1970 GST_BASE_TRANSFORM_LOCK (trans);
1971 ret = gst_base_transform_handle_buffer (trans, inbuf, buffer);
1972 GST_BASE_TRANSFORM_UNLOCK (trans);
1980 GST_DEBUG_OBJECT (trans, "failed to pull a buffer: %s",
1981 gst_flow_get_name (ret));
1986 static GstFlowReturn
1987 gst_base_transform_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
1989 GstBaseTransform *trans;
1990 GstBaseTransformClass *klass;
1992 GstClockTime position = GST_CLOCK_TIME_NONE;
1993 GstClockTime timestamp, duration;
1994 GstBuffer *outbuf = NULL;
1996 trans = GST_BASE_TRANSFORM (parent);
1998 timestamp = GST_BUFFER_TIMESTAMP (buffer);
1999 duration = GST_BUFFER_DURATION (buffer);
2001 /* calculate end position of the incoming buffer */
2002 if (timestamp != GST_CLOCK_TIME_NONE) {
2003 if (duration != GST_CLOCK_TIME_NONE)
2004 position = timestamp + duration;
2006 position = timestamp;
2009 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2010 if (klass->before_transform)
2011 klass->before_transform (trans, buffer);
2013 /* protect transform method and concurrent buffer alloc */
2014 GST_BASE_TRANSFORM_LOCK (trans);
2015 ret = gst_base_transform_handle_buffer (trans, buffer, &outbuf);
2016 GST_BASE_TRANSFORM_UNLOCK (trans);
2018 /* outbuf can be NULL, this means a dropped buffer, if we have a buffer but
2019 * GST_BASE_TRANSFORM_FLOW_DROPPED we will not push either. */
2020 if (outbuf != NULL) {
2021 if (ret == GST_FLOW_OK) {
2022 GstClockTime position_out = GST_CLOCK_TIME_NONE;
2024 /* Remember last stop position */
2025 if (position != GST_CLOCK_TIME_NONE &&
2026 trans->segment.format == GST_FORMAT_TIME)
2027 trans->segment.position = position;
2029 if (GST_BUFFER_TIMESTAMP_IS_VALID (outbuf)) {
2030 position_out = GST_BUFFER_TIMESTAMP (outbuf);
2031 if (GST_BUFFER_DURATION_IS_VALID (outbuf))
2032 position_out += GST_BUFFER_DURATION (outbuf);
2033 } else if (position != GST_CLOCK_TIME_NONE) {
2034 position_out = position;
2036 if (position_out != GST_CLOCK_TIME_NONE
2037 && trans->segment.format == GST_FORMAT_TIME)
2038 trans->priv->position_out = position_out;
2040 /* apply DISCONT flag if the buffer is not yet marked as such */
2041 if (trans->priv->discont) {
2042 GST_DEBUG_OBJECT (trans, "we have a pending DISCONT");
2043 if (!GST_BUFFER_IS_DISCONT (outbuf)) {
2044 GST_DEBUG_OBJECT (trans, "marking DISCONT on output buffer");
2045 outbuf = gst_buffer_make_writable (outbuf);
2046 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
2048 trans->priv->discont = FALSE;
2050 trans->priv->processed++;
2052 ret = gst_pad_push (trans->srcpad, outbuf);
2054 GST_DEBUG_OBJECT (trans, "we got return %s", gst_flow_get_name (ret));
2055 gst_buffer_unref (outbuf);
2059 /* convert internal flow to OK and mark discont for the next buffer. */
2060 if (ret == GST_BASE_TRANSFORM_FLOW_DROPPED) {
2061 GST_DEBUG_OBJECT (trans, "dropped a buffer, marking DISCONT");
2062 trans->priv->discont = TRUE;
2070 gst_base_transform_set_property (GObject * object, guint prop_id,
2071 const GValue * value, GParamSpec * pspec)
2073 GstBaseTransform *trans;
2075 trans = GST_BASE_TRANSFORM (object);
2079 gst_base_transform_set_qos_enabled (trans, g_value_get_boolean (value));
2082 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2088 gst_base_transform_get_property (GObject * object, guint prop_id,
2089 GValue * value, GParamSpec * pspec)
2091 GstBaseTransform *trans;
2093 trans = GST_BASE_TRANSFORM (object);
2097 g_value_set_boolean (value, gst_base_transform_is_qos_enabled (trans));
2100 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2105 /* not a vmethod of anything, just an internal method */
2107 gst_base_transform_activate (GstBaseTransform * trans, gboolean active)
2109 GstBaseTransformClass *bclass;
2110 gboolean result = TRUE;
2112 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2115 GstCaps *incaps, *outcaps;
2117 if (trans->priv->pad_mode == GST_PAD_MODE_NONE && bclass->start)
2118 result &= bclass->start (trans);
2120 incaps = gst_pad_get_current_caps (trans->sinkpad);
2121 outcaps = gst_pad_get_current_caps (trans->srcpad);
2123 GST_OBJECT_LOCK (trans);
2124 if (incaps && outcaps)
2125 trans->have_same_caps =
2126 gst_caps_is_equal (incaps, outcaps) || trans->passthrough;
2128 trans->have_same_caps = trans->passthrough;
2129 GST_DEBUG_OBJECT (trans, "have_same_caps %d", trans->have_same_caps);
2130 trans->negotiated = FALSE;
2131 trans->have_segment = FALSE;
2132 gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
2133 trans->priv->position_out = GST_CLOCK_TIME_NONE;
2134 trans->priv->proportion = 1.0;
2135 trans->priv->earliest_time = -1;
2136 trans->priv->discont = FALSE;
2137 trans->priv->processed = 0;
2138 trans->priv->dropped = 0;
2139 GST_OBJECT_UNLOCK (trans);
2142 gst_caps_unref (incaps);
2144 gst_caps_unref (outcaps);
2146 /* We must make sure streaming has finished before resetting things
2147 * and calling the ::stop vfunc */
2148 GST_PAD_STREAM_LOCK (trans->sinkpad);
2149 GST_PAD_STREAM_UNLOCK (trans->sinkpad);
2151 trans->have_same_caps = FALSE;
2152 /* We can only reset the passthrough mode if the instance told us to
2153 handle it in configure_caps */
2154 if (bclass->passthrough_on_same_caps) {
2155 gst_base_transform_set_passthrough (trans, FALSE);
2157 gst_caps_replace (&trans->cache_caps1, NULL);
2158 gst_caps_replace (&trans->cache_caps2, NULL);
2160 if (trans->priv->pad_mode != GST_PAD_MODE_NONE && bclass->stop)
2161 result &= bclass->stop (trans);
2163 gst_base_transform_set_allocation (trans, NULL, NULL, 0, 0);
2170 gst_base_transform_sink_activate_mode (GstPad * pad, GstObject * parent,
2171 GstPadMode mode, gboolean active)
2173 gboolean result = FALSE;
2174 GstBaseTransform *trans;
2176 trans = GST_BASE_TRANSFORM (parent);
2179 case GST_PAD_MODE_PUSH:
2181 result = gst_base_transform_activate (trans, active);
2184 trans->priv->pad_mode = active ? GST_PAD_MODE_PUSH : GST_PAD_MODE_NONE;
2196 gst_base_transform_src_activate_mode (GstPad * pad, GstObject * parent,
2197 GstPadMode mode, gboolean active)
2199 gboolean result = FALSE;
2200 GstBaseTransform *trans;
2202 trans = GST_BASE_TRANSFORM (parent);
2205 case GST_PAD_MODE_PULL:
2208 gst_pad_activate_mode (trans->sinkpad, GST_PAD_MODE_PULL, active);
2211 result &= gst_base_transform_activate (trans, active);
2214 trans->priv->pad_mode = active ? mode : GST_PAD_MODE_NONE;
2226 * gst_base_transform_set_passthrough:
2227 * @trans: the #GstBaseTransform to set
2228 * @passthrough: boolean indicating passthrough mode.
2230 * Set passthrough mode for this filter by default. This is mostly
2231 * useful for filters that do not care about negotiation.
2233 * Always TRUE for filters which don't implement either a transform
2234 * or transform_ip method.
2239 gst_base_transform_set_passthrough (GstBaseTransform * trans,
2240 gboolean passthrough)
2242 GstBaseTransformClass *bclass;
2244 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2246 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2248 GST_OBJECT_LOCK (trans);
2249 if (passthrough == FALSE) {
2250 if (bclass->transform_ip || bclass->transform)
2251 trans->passthrough = FALSE;
2253 trans->passthrough = TRUE;
2256 GST_DEBUG_OBJECT (trans, "set passthrough %d", trans->passthrough);
2257 GST_OBJECT_UNLOCK (trans);
2261 * gst_base_transform_is_passthrough:
2262 * @trans: the #GstBaseTransform to query
2264 * See if @trans is configured as a passthrough transform.
2266 * Returns: TRUE is the transform is configured in passthrough mode.
2271 gst_base_transform_is_passthrough (GstBaseTransform * trans)
2275 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2277 GST_OBJECT_LOCK (trans);
2278 result = trans->passthrough;
2279 GST_OBJECT_UNLOCK (trans);
2285 * gst_base_transform_set_in_place:
2286 * @trans: the #GstBaseTransform to modify
2287 * @in_place: Boolean value indicating that we would like to operate
2288 * on in_place buffers.
2290 * Determines whether a non-writable buffer will be copied before passing
2291 * to the transform_ip function.
2293 * <listitem>Always TRUE if no transform function is implemented.</listitem>
2294 * <listitem>Always FALSE if ONLY transform function is implemented.</listitem>
2300 gst_base_transform_set_in_place (GstBaseTransform * trans, gboolean in_place)
2302 GstBaseTransformClass *bclass;
2304 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2306 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2308 GST_OBJECT_LOCK (trans);
2311 if (bclass->transform_ip) {
2312 GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
2313 trans->always_in_place = TRUE;
2316 if (bclass->transform) {
2317 GST_DEBUG_OBJECT (trans, "setting in_place FALSE");
2318 trans->always_in_place = FALSE;
2322 GST_OBJECT_UNLOCK (trans);
2326 * gst_base_transform_is_in_place:
2327 * @trans: the #GstBaseTransform to query
2329 * See if @trans is configured as a in_place transform.
2331 * Returns: TRUE is the transform is configured in in_place mode.
2336 gst_base_transform_is_in_place (GstBaseTransform * trans)
2340 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2342 GST_OBJECT_LOCK (trans);
2343 result = trans->always_in_place;
2344 GST_OBJECT_UNLOCK (trans);
2350 * gst_base_transform_update_qos:
2351 * @trans: a #GstBaseTransform
2352 * @proportion: the proportion
2353 * @diff: the diff against the clock
2354 * @timestamp: the timestamp of the buffer generating the QoS expressed in
2357 * Set the QoS parameters in the transform. This function is called internally
2358 * when a QOS event is received but subclasses can provide custom information
2366 gst_base_transform_update_qos (GstBaseTransform * trans,
2367 gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp)
2370 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2372 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans,
2373 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2374 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (timestamp));
2376 GST_OBJECT_LOCK (trans);
2377 trans->priv->proportion = proportion;
2378 trans->priv->earliest_time = timestamp + diff;
2379 GST_OBJECT_UNLOCK (trans);
2383 * gst_base_transform_set_qos_enabled:
2384 * @trans: a #GstBaseTransform
2385 * @enabled: new state
2387 * Enable or disable QoS handling in the transform.
2394 gst_base_transform_set_qos_enabled (GstBaseTransform * trans, gboolean enabled)
2396 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2398 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "enabled: %d", enabled);
2400 GST_OBJECT_LOCK (trans);
2401 trans->priv->qos_enabled = enabled;
2402 GST_OBJECT_UNLOCK (trans);
2406 * gst_base_transform_is_qos_enabled:
2407 * @trans: a #GstBaseTransform
2409 * Queries if the transform will handle QoS.
2411 * Returns: TRUE if QoS is enabled.
2418 gst_base_transform_is_qos_enabled (GstBaseTransform * trans)
2422 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2424 GST_OBJECT_LOCK (trans);
2425 result = trans->priv->qos_enabled;
2426 GST_OBJECT_UNLOCK (trans);
2432 * gst_base_transform_set_gap_aware:
2433 * @trans: a #GstBaseTransform
2434 * @gap_aware: New state
2436 * If @gap_aware is %FALSE (the default), output buffers will have the
2437 * %GST_BUFFER_FLAG_GAP flag unset.
2439 * If set to %TRUE, the element must handle output buffers with this flag set
2440 * correctly, i.e. it can assume that the buffer contains neutral data but must
2441 * unset the flag if the output is no neutral data.
2448 gst_base_transform_set_gap_aware (GstBaseTransform * trans, gboolean gap_aware)
2450 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2452 GST_OBJECT_LOCK (trans);
2453 trans->priv->gap_aware = gap_aware;
2454 GST_DEBUG_OBJECT (trans, "set gap aware %d", trans->priv->gap_aware);
2455 GST_OBJECT_UNLOCK (trans);
2459 * gst_base_transform_suggest:
2460 * @trans: a #GstBaseTransform
2461 * @caps: (transfer none): caps to suggest
2462 * @size: buffer size to suggest
2464 * Instructs @trans to suggest new @caps upstream. A copy of @caps will be
2470 gst_base_transform_suggest (GstBaseTransform * trans, GstCaps * caps,
2473 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2475 /* push the renegotiate event */
2476 if (!gst_pad_push_event (GST_BASE_TRANSFORM_SINK_PAD (trans),
2477 gst_event_new_reconfigure ()))
2478 GST_DEBUG_OBJECT (trans, "Renegotiate event wasn't handled");
2482 * gst_base_transform_reconfigure:
2483 * @trans: a #GstBaseTransform
2485 * Instructs @trans to renegotiate a new downstream transform on the next
2486 * buffer. This function is typically called after properties on the transform
2487 * were set that influence the output format.
2492 gst_base_transform_reconfigure (GstBaseTransform * trans)
2494 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2496 GST_OBJECT_LOCK (trans);
2497 GST_DEBUG_OBJECT (trans, "marking reconfigure");
2498 trans->priv->reconfigure = TRUE;
2499 GST_OBJECT_UNLOCK (trans);