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"
213 GST_DEBUG_CATEGORY_STATIC (gst_base_transform_debug);
214 #define GST_CAT_DEFAULT gst_base_transform_debug
216 /* BaseTransform signals and args */
223 #define DEFAULT_PROP_QOS FALSE
231 #define GST_BASE_TRANSFORM_GET_PRIVATE(obj) \
232 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_TRANSFORM, GstBaseTransformPrivate))
234 struct _GstBaseTransformPrivate
236 /* Set by sub-class */
237 gboolean passthrough;
238 gboolean always_in_place;
240 GstCaps *cache_caps1;
241 gsize cache_caps1_size;
242 GstCaps *cache_caps2;
243 gsize cache_caps2_size;
244 gboolean have_same_caps;
248 /* QoS *//* with LOCK */
249 gboolean qos_enabled;
251 GstClockTime earliest_time;
252 /* previous buffer had a discont */
263 GstClockTime position_out;
266 gboolean pool_active;
267 GstAllocator *allocator;
268 GstAllocationParams params;
273 static GstElementClass *parent_class = NULL;
275 static void gst_base_transform_class_init (GstBaseTransformClass * klass);
276 static void gst_base_transform_init (GstBaseTransform * trans,
277 GstBaseTransformClass * klass);
279 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
280 * method to get to the padtemplates */
282 gst_base_transform_get_type (void)
284 static volatile gsize base_transform_type = 0;
286 if (g_once_init_enter (&base_transform_type)) {
288 static const GTypeInfo base_transform_info = {
289 sizeof (GstBaseTransformClass),
292 (GClassInitFunc) gst_base_transform_class_init,
295 sizeof (GstBaseTransform),
297 (GInstanceInitFunc) gst_base_transform_init,
300 _type = g_type_register_static (GST_TYPE_ELEMENT,
301 "GstBaseTransform", &base_transform_info, G_TYPE_FLAG_ABSTRACT);
302 g_once_init_leave (&base_transform_type, _type);
304 return base_transform_type;
307 static void gst_base_transform_finalize (GObject * object);
308 static void gst_base_transform_set_property (GObject * object, guint prop_id,
309 const GValue * value, GParamSpec * pspec);
310 static void gst_base_transform_get_property (GObject * object, guint prop_id,
311 GValue * value, GParamSpec * pspec);
312 static gboolean gst_base_transform_src_activate_mode (GstPad * pad,
313 GstObject * parent, GstPadMode mode, gboolean active);
314 static gboolean gst_base_transform_sink_activate_mode (GstPad * pad,
315 GstObject * parent, GstPadMode mode, gboolean active);
316 static gboolean gst_base_transform_activate (GstBaseTransform * trans,
318 static gboolean gst_base_transform_get_unit_size (GstBaseTransform * trans,
319 GstCaps * caps, gsize * size);
321 static gboolean gst_base_transform_src_event (GstPad * pad, GstObject * parent,
323 static gboolean gst_base_transform_src_eventfunc (GstBaseTransform * trans,
325 static gboolean gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
327 static gboolean gst_base_transform_sink_eventfunc (GstBaseTransform * trans,
329 static GstFlowReturn gst_base_transform_getrange (GstPad * pad,
330 GstObject * parent, guint64 offset, guint length, GstBuffer ** buffer);
331 static GstFlowReturn gst_base_transform_chain (GstPad * pad, GstObject * parent,
333 static GstCaps *gst_base_transform_default_transform_caps (GstBaseTransform *
334 trans, GstPadDirection direction, GstCaps * caps, GstCaps * filter);
335 static GstCaps *gst_base_transform_default_fixate_caps (GstBaseTransform *
336 trans, GstPadDirection direction, GstCaps * caps, GstCaps * othercaps);
337 static GstCaps *gst_base_transform_query_caps (GstBaseTransform * trans,
338 GstPad * pad, GstCaps * filter);
339 static gboolean gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
340 GstPadDirection direction, GstCaps * caps);
341 static gboolean gst_base_transform_setcaps (GstBaseTransform * trans,
342 GstPad * pad, GstCaps * caps);
343 static gboolean gst_base_transform_default_decide_allocation (GstBaseTransform
344 * trans, GstQuery * query);
345 static gboolean gst_base_transform_default_propose_allocation (GstBaseTransform
346 * trans, GstQuery * decide_query, GstQuery * query);
347 static gboolean gst_base_transform_query (GstPad * pad, GstObject * parent,
349 static gboolean gst_base_transform_default_query (GstBaseTransform * trans,
350 GstPadDirection direction, GstQuery * query);
351 static gboolean gst_base_transform_default_transform_size (GstBaseTransform *
352 trans, GstPadDirection direction, GstCaps * caps, gsize size,
353 GstCaps * othercaps, gsize * othersize);
355 static GstFlowReturn default_prepare_output_buffer (GstBaseTransform * trans,
356 GstBuffer * inbuf, GstBuffer ** outbuf);
357 static gboolean default_copy_metadata (GstBaseTransform * trans,
358 GstBuffer * inbuf, GstBuffer * outbuf);
360 /* static guint gst_base_transform_signals[LAST_SIGNAL] = { 0 }; */
364 gst_base_transform_finalize (GObject * object)
366 G_OBJECT_CLASS (parent_class)->finalize (object);
370 gst_base_transform_class_init (GstBaseTransformClass * klass)
372 GObjectClass *gobject_class;
374 gobject_class = G_OBJECT_CLASS (klass);
376 GST_DEBUG_CATEGORY_INIT (gst_base_transform_debug, "basetransform", 0,
377 "basetransform element");
379 GST_DEBUG ("gst_base_transform_class_init");
381 g_type_class_add_private (klass, sizeof (GstBaseTransformPrivate));
383 parent_class = g_type_class_peek_parent (klass);
385 gobject_class->set_property = gst_base_transform_set_property;
386 gobject_class->get_property = gst_base_transform_get_property;
388 g_object_class_install_property (gobject_class, PROP_QOS,
389 g_param_spec_boolean ("qos", "QoS", "Handle Quality-of-Service events",
390 DEFAULT_PROP_QOS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
392 gobject_class->finalize = gst_base_transform_finalize;
394 klass->passthrough_on_same_caps = FALSE;
395 klass->transform_ip_on_passthrough = TRUE;
397 klass->transform_caps =
398 GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_caps);
400 GST_DEBUG_FUNCPTR (gst_base_transform_default_fixate_caps);
402 GST_DEBUG_FUNCPTR (gst_base_transform_acceptcaps_default);
403 klass->query = GST_DEBUG_FUNCPTR (gst_base_transform_default_query);
404 klass->decide_allocation =
405 GST_DEBUG_FUNCPTR (gst_base_transform_default_decide_allocation);
406 klass->propose_allocation =
407 GST_DEBUG_FUNCPTR (gst_base_transform_default_propose_allocation);
408 klass->transform_size =
409 GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_size);
411 klass->sink_event = GST_DEBUG_FUNCPTR (gst_base_transform_sink_eventfunc);
412 klass->src_event = GST_DEBUG_FUNCPTR (gst_base_transform_src_eventfunc);
413 klass->prepare_output_buffer =
414 GST_DEBUG_FUNCPTR (default_prepare_output_buffer);
415 klass->copy_metadata = GST_DEBUG_FUNCPTR (default_copy_metadata);
419 gst_base_transform_init (GstBaseTransform * trans,
420 GstBaseTransformClass * bclass)
422 GstPadTemplate *pad_template;
423 GstBaseTransformPrivate *priv;
425 GST_DEBUG ("gst_base_transform_init");
427 priv = trans->priv = GST_BASE_TRANSFORM_GET_PRIVATE (trans);
430 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
431 g_return_if_fail (pad_template != NULL);
432 trans->sinkpad = gst_pad_new_from_template (pad_template, "sink");
433 gst_pad_set_event_function (trans->sinkpad,
434 GST_DEBUG_FUNCPTR (gst_base_transform_sink_event));
435 gst_pad_set_chain_function (trans->sinkpad,
436 GST_DEBUG_FUNCPTR (gst_base_transform_chain));
437 gst_pad_set_activatemode_function (trans->sinkpad,
438 GST_DEBUG_FUNCPTR (gst_base_transform_sink_activate_mode));
439 gst_pad_set_query_function (trans->sinkpad,
440 GST_DEBUG_FUNCPTR (gst_base_transform_query));
441 gst_element_add_pad (GST_ELEMENT (trans), trans->sinkpad);
444 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
445 g_return_if_fail (pad_template != NULL);
446 trans->srcpad = gst_pad_new_from_template (pad_template, "src");
447 gst_pad_set_event_function (trans->srcpad,
448 GST_DEBUG_FUNCPTR (gst_base_transform_src_event));
449 gst_pad_set_getrange_function (trans->srcpad,
450 GST_DEBUG_FUNCPTR (gst_base_transform_getrange));
451 gst_pad_set_activatemode_function (trans->srcpad,
452 GST_DEBUG_FUNCPTR (gst_base_transform_src_activate_mode));
453 gst_pad_set_query_function (trans->srcpad,
454 GST_DEBUG_FUNCPTR (gst_base_transform_query));
455 gst_element_add_pad (GST_ELEMENT (trans), trans->srcpad);
457 priv->qos_enabled = DEFAULT_PROP_QOS;
458 priv->cache_caps1 = NULL;
459 priv->cache_caps2 = NULL;
460 priv->pad_mode = GST_PAD_MODE_NONE;
461 priv->gap_aware = FALSE;
463 priv->passthrough = FALSE;
464 if (bclass->transform == NULL) {
465 /* If no transform function, always_in_place is TRUE */
466 GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
467 priv->always_in_place = TRUE;
469 if (bclass->transform_ip == NULL) {
470 GST_DEBUG_OBJECT (trans, "setting passthrough TRUE");
471 priv->passthrough = TRUE;
480 gst_base_transform_default_transform_caps (GstBaseTransform * trans,
481 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
485 GST_DEBUG_OBJECT (trans, "identity from: %" GST_PTR_FORMAT, caps);
486 /* no transform function, use the identity transform */
488 ret = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
490 ret = gst_caps_ref (caps);
495 /* given @caps on the src or sink pad (given by @direction)
496 * calculate the possible caps on the other pad.
498 * Returns new caps, unref after usage.
501 gst_base_transform_transform_caps (GstBaseTransform * trans,
502 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
505 GstBaseTransformClass *klass;
510 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
512 /* if there is a custom transform function, use this */
513 if (klass->transform_caps) {
514 GST_DEBUG_OBJECT (trans, "transform caps (direction = %d)", direction);
516 GST_LOG_OBJECT (trans, "from: %" GST_PTR_FORMAT, caps);
517 ret = klass->transform_caps (trans, direction, caps, filter);
518 GST_LOG_OBJECT (trans, " to: %" GST_PTR_FORMAT, ret);
520 #ifndef G_DISABLE_ASSERT
522 if (!gst_caps_is_subset (ret, filter)) {
523 GstCaps *intersection;
525 GST_ERROR_OBJECT (trans,
526 "transform_caps returned caps %" GST_PTR_FORMAT
527 " which are not a real subset of the filter caps %"
528 GST_PTR_FORMAT, ret, filter);
529 g_warning ("%s: transform_caps returned caps which are not a real "
530 "subset of the filter caps", GST_ELEMENT_NAME (trans));
533 gst_caps_intersect_full (filter, ret, GST_CAPS_INTERSECT_FIRST);
534 gst_caps_unref (ret);
541 GST_DEBUG_OBJECT (trans, "to: %" GST_PTR_FORMAT, ret);
547 gst_base_transform_default_transform_size (GstBaseTransform * trans,
548 GstPadDirection direction, GstCaps * caps, gsize size,
549 GstCaps * othercaps, gsize * othersize)
551 gsize inunitsize, outunitsize, units;
552 GstBaseTransformClass *klass;
554 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
556 if (klass->get_unit_size == NULL) {
557 /* if there is no transform_size and no unit_size, it means the
558 * element does not modify the size of a buffer */
561 /* there is no transform_size function, we have to use the unit_size
562 * functions. This method assumes there is a fixed unit_size associated with
563 * each caps. We provide the same amount of units on both sides. */
564 if (!gst_base_transform_get_unit_size (trans, caps, &inunitsize))
567 GST_DEBUG_OBJECT (trans,
568 "input size %" G_GSIZE_FORMAT ", input unit size %" G_GSIZE_FORMAT,
571 /* input size must be a multiple of the unit_size of the input caps */
572 if (inunitsize == 0 || (size % inunitsize != 0))
575 /* get the amount of units */
576 units = size / inunitsize;
578 /* now get the unit size of the output */
579 if (!gst_base_transform_get_unit_size (trans, othercaps, &outunitsize))
582 /* the output size is the unit_size times the amount of units on the
584 *othersize = units * outunitsize;
585 GST_DEBUG_OBJECT (trans, "transformed size to %" G_GSIZE_FORMAT,
593 GST_DEBUG_OBJECT (trans, "could not get in_size");
594 g_warning ("%s: could not get in_size", GST_ELEMENT_NAME (trans));
599 GST_DEBUG_OBJECT (trans, "Size %" G_GSIZE_FORMAT " is not a multiple of"
600 "unit size %" G_GSIZE_FORMAT, size, inunitsize);
601 g_warning ("%s: size %" G_GSIZE_FORMAT " is not a multiple of unit size %"
602 G_GSIZE_FORMAT, GST_ELEMENT_NAME (trans), size, inunitsize);
607 GST_DEBUG_OBJECT (trans, "could not get out_size");
608 g_warning ("%s: could not get out_size", GST_ELEMENT_NAME (trans));
613 /* transform a buffer of @size with @caps on the pad with @direction to
614 * the size of a buffer with @othercaps and store the result in @othersize
616 * We have two ways of doing this:
617 * 1) use a custom transform size function, this is for complicated custom
618 * cases with no fixed unit_size.
619 * 2) use the unit_size functions where there is a relationship between the
620 * caps and the size of a buffer.
623 gst_base_transform_transform_size (GstBaseTransform * trans,
624 GstPadDirection direction, GstCaps * caps,
625 gsize size, GstCaps * othercaps, gsize * othersize)
627 GstBaseTransformClass *klass;
628 gboolean ret = FALSE;
630 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
632 GST_DEBUG_OBJECT (trans,
633 "asked to transform size %" G_GSIZE_FORMAT " for caps %"
634 GST_PTR_FORMAT " to size for caps %" GST_PTR_FORMAT " in direction %s",
635 size, caps, othercaps, direction == GST_PAD_SRC ? "SRC" : "SINK");
637 if (klass->transform_size) {
638 /* if there is a custom transform function, use this */
639 ret = klass->transform_size (trans, direction, caps, size, othercaps,
645 /* get the caps that can be handled by @pad. We perform:
647 * - take the caps of peer of otherpad,
648 * - filter against the padtemplate of otherpad,
649 * - calculate all transforms of remaining caps
650 * - filter against template of @pad
652 * If there is no peer, we simply return the caps of the padtemplate of pad.
655 gst_base_transform_query_caps (GstBaseTransform * trans, GstPad * pad,
659 GstCaps *peercaps, *caps, *temp, *peerfilter = NULL;
660 GstCaps *templ, *otempl;
662 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
664 templ = gst_pad_get_pad_template_caps (pad);
665 otempl = gst_pad_get_pad_template_caps (otherpad);
667 /* we can do what the peer can */
669 GST_DEBUG_OBJECT (pad, "filter caps %" GST_PTR_FORMAT, filter);
671 /* filtered against our padtemplate on the other side */
672 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
673 temp = gst_caps_intersect_full (filter, templ, GST_CAPS_INTERSECT_FIRST);
674 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
676 /* then see what we can transform this to */
677 peerfilter = gst_base_transform_transform_caps (trans,
678 GST_PAD_DIRECTION (pad), temp, NULL);
679 GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, peerfilter);
680 gst_caps_unref (temp);
682 /* and filter against the template of this pad */
683 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, otempl);
684 /* We keep the caps sorted like the returned caps */
686 gst_caps_intersect_full (peerfilter, otempl, GST_CAPS_INTERSECT_FIRST);
687 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
688 gst_caps_unref (peerfilter);
692 peercaps = gst_pad_peer_query_caps (otherpad, peerfilter);
695 gst_caps_unref (peerfilter);
698 GST_DEBUG_OBJECT (pad, "peer caps %" GST_PTR_FORMAT, peercaps);
700 /* filtered against our padtemplate on the other side */
701 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, otempl);
702 temp = gst_caps_intersect_full (peercaps, otempl, GST_CAPS_INTERSECT_FIRST);
703 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
705 temp = gst_caps_ref (otempl);
708 /* then see what we can transform this to */
709 caps = gst_base_transform_transform_caps (trans,
710 GST_PAD_DIRECTION (otherpad), temp, filter);
711 GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, caps);
712 gst_caps_unref (temp);
717 /* and filter against the template of this pad */
718 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
719 /* We keep the caps sorted like the returned caps */
720 temp = gst_caps_intersect_full (caps, templ, GST_CAPS_INTERSECT_FIRST);
721 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
722 gst_caps_unref (caps);
725 /* Now try if we can put the untransformed downstream caps first */
726 temp = gst_caps_intersect_full (peercaps, caps, GST_CAPS_INTERSECT_FIRST);
727 if (!gst_caps_is_empty (temp)) {
728 caps = gst_caps_merge (temp, caps);
730 gst_caps_unref (temp);
733 gst_caps_unref (caps);
734 /* no peer or the peer can do anything, our padtemplate is enough then */
736 caps = gst_caps_intersect_full (filter, templ, GST_CAPS_INTERSECT_FIRST);
738 caps = gst_caps_ref (templ);
743 GST_DEBUG_OBJECT (trans, "returning %" GST_PTR_FORMAT, caps);
746 gst_caps_unref (peercaps);
748 gst_caps_unref (templ);
749 gst_caps_unref (otempl);
754 /* takes ownership of the pool, allocator and query */
756 gst_base_transform_set_allocation (GstBaseTransform * trans,
757 GstBufferPool * pool, GstAllocator * allocator,
758 GstAllocationParams * params, GstQuery * query)
760 GstAllocator *oldalloc;
761 GstBufferPool *oldpool;
763 GstBaseTransformPrivate *priv = trans->priv;
765 GST_OBJECT_LOCK (trans);
766 oldpool = priv->pool;
768 priv->pool_active = FALSE;
770 oldalloc = priv->allocator;
771 priv->allocator = allocator;
773 oldquery = priv->query;
777 priv->params = *params;
779 gst_allocation_params_init (&priv->params);
780 GST_OBJECT_UNLOCK (trans);
783 GST_DEBUG_OBJECT (trans, "deactivating old pool %p", oldpool);
784 gst_buffer_pool_set_active (oldpool, FALSE);
785 gst_object_unref (oldpool);
788 gst_object_unref (oldalloc);
791 gst_query_unref (oldquery);
798 gst_base_transform_default_decide_allocation (GstBaseTransform * trans,
802 GstBaseTransformClass *klass;
805 guint size, min, max;
806 GstAllocator *allocator;
807 GstAllocationParams params;
808 GstStructure *config;
809 gboolean update_allocator;
811 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
813 n_metas = gst_query_get_n_allocation_metas (query);
814 for (i = 0; i < n_metas; i++) {
816 const GstStructure *params;
819 api = gst_query_parse_nth_allocation_meta (query, i, ¶ms);
821 /* by default we remove all metadata, subclasses should implement a
822 * filter_meta function */
823 if (gst_meta_api_type_has_tag (api, GST_META_TAG_MEMORY)) {
824 /* remove all memory dependent metadata because we are going to have to
825 * allocate different memory for input and output. */
826 GST_LOG_OBJECT (trans, "removing memory specific metadata %s",
829 } else if (G_LIKELY (klass->filter_meta)) {
830 /* remove if the subclass said so */
831 remove = !klass->filter_meta (trans, query, api, params);
832 GST_LOG_OBJECT (trans, "filter_meta for api %s returned: %s",
833 g_type_name (api), (remove ? "remove" : "keep"));
835 GST_LOG_OBJECT (trans, "removing metadata %s", g_type_name (api));
840 gst_query_remove_nth_allocation_meta (query, i);
846 gst_query_parse_allocation (query, &outcaps, NULL);
848 /* we got configuration from our peer or the decide_allocation method,
850 if (gst_query_get_n_allocation_params (query) > 0) {
851 /* try the allocator */
852 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
853 update_allocator = TRUE;
856 gst_allocation_params_init (¶ms);
857 update_allocator = FALSE;
860 if (gst_query_get_n_allocation_pools (query) > 0) {
861 gst_query_parse_nth_allocation_pool (query, 0, &pool, &size, &min, &max);
864 /* no pool, we can make our own */
865 GST_DEBUG_OBJECT (trans, "no pool, making new pool");
866 pool = gst_buffer_pool_new ();
870 size = min = max = 0;
875 config = gst_buffer_pool_get_config (pool);
876 gst_buffer_pool_config_set_params (config, outcaps, size, min, max);
877 gst_buffer_pool_config_set_allocator (config, allocator, ¶ms);
878 gst_buffer_pool_set_config (pool, config);
881 if (update_allocator)
882 gst_query_set_nth_allocation_param (query, 0, allocator, ¶ms);
884 gst_query_add_allocation_param (query, allocator, ¶ms);
886 gst_object_unref (allocator);
889 gst_query_set_nth_allocation_pool (query, 0, pool, size, min, max);
890 gst_object_unref (pool);
897 gst_base_transform_do_bufferpool (GstBaseTransform * trans, GstCaps * outcaps)
900 gboolean result = TRUE;
901 GstBufferPool *pool = NULL;
902 GstBaseTransformClass *klass;
903 GstBaseTransformPrivate *priv = trans->priv;
904 GstAllocator *allocator;
905 GstAllocationParams params;
907 /* there are these possibilities:
909 * 1) we negotiated passthrough, we can proxy the bufferpool directly and we
910 * will do that whenever some upstream does an allocation query.
911 * 2) we need to do a transform, we need to get a bufferpool from downstream
912 * and configure it. When upstream does the ALLOCATION query, the
913 * propose_allocation vmethod will be called and we will configure the
914 * upstream allocator with our proposed values then.
916 if (priv->passthrough || priv->always_in_place) {
917 /* we are in passthrough, the input buffer is never copied and always passed
918 * along. We never allocate an output buffer on the srcpad. What we do is
919 * let the upstream element decide if it wants to use a bufferpool and
920 * then we will proxy the downstream pool */
921 GST_DEBUG_OBJECT (trans, "we're passthough, delay bufferpool");
922 gst_base_transform_set_allocation (trans, NULL, NULL, NULL, NULL);
926 /* not passthrough, we need to allocate */
927 /* find a pool for the negotiated caps now */
928 GST_DEBUG_OBJECT (trans, "doing allocation query");
929 query = gst_query_new_allocation (outcaps, TRUE);
930 if (!gst_pad_peer_query (trans->srcpad, query)) {
931 /* not a problem, just debug a little */
932 GST_DEBUG_OBJECT (trans, "peer ALLOCATION query failed");
935 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
937 GST_DEBUG_OBJECT (trans, "calling decide_allocation");
938 g_assert (klass->decide_allocation != NULL);
939 result = klass->decide_allocation (trans, query);
941 GST_DEBUG_OBJECT (trans, "ALLOCATION (%d) params: %" GST_PTR_FORMAT, result,
945 goto no_decide_allocation;
947 /* we got configuration from our peer or the decide_allocation method,
949 if (gst_query_get_n_allocation_params (query) > 0) {
950 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
953 gst_allocation_params_init (¶ms);
956 if (gst_query_get_n_allocation_pools (query) > 0)
957 gst_query_parse_nth_allocation_pool (query, 0, &pool, NULL, NULL, NULL);
961 gst_base_transform_set_allocation (trans, pool, allocator, ¶ms,
967 no_decide_allocation:
969 GST_WARNING_OBJECT (trans, "Subclass failed to decide allocation");
970 gst_query_unref (query);
976 /* function triggered when the in and out caps are negotiated and need
977 * to be configured in the subclass. */
979 gst_base_transform_configure_caps (GstBaseTransform * trans, GstCaps * in,
983 GstBaseTransformClass *klass;
984 GstBaseTransformPrivate *priv = trans->priv;
986 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
988 GST_DEBUG_OBJECT (trans, "in caps: %" GST_PTR_FORMAT, in);
989 GST_DEBUG_OBJECT (trans, "out caps: %" GST_PTR_FORMAT, out);
991 /* clear the cache */
992 gst_caps_replace (&priv->cache_caps1, NULL);
993 gst_caps_replace (&priv->cache_caps2, NULL);
995 /* figure out same caps state */
996 priv->have_same_caps = gst_caps_is_equal (in, out);
997 GST_DEBUG_OBJECT (trans, "have_same_caps: %d", priv->have_same_caps);
999 /* Set the passthrough if the class wants passthrough_on_same_caps
1000 * and we have the same caps on each pad */
1001 if (klass->passthrough_on_same_caps)
1002 gst_base_transform_set_passthrough (trans, priv->have_same_caps);
1004 /* now configure the element with the caps */
1005 if (klass->set_caps) {
1006 GST_DEBUG_OBJECT (trans, "Calling set_caps method to setup caps");
1007 ret = klass->set_caps (trans, in, out);
1014 gst_base_transform_default_fixate_caps (GstBaseTransform * trans,
1015 GstPadDirection direction, GstCaps * caps, GstCaps * othercaps)
1017 othercaps = gst_caps_fixate (othercaps);
1018 GST_DEBUG_OBJECT (trans, "fixated to %" GST_PTR_FORMAT, othercaps);
1023 /* given a fixed @caps on @pad, create the best possible caps for the
1025 * @caps must be fixed when calling this function.
1027 * This function calls the transform caps vmethod of the basetransform to figure
1028 * out the possible target formats. It then tries to select the best format from
1031 * - attempt passthrough if the target caps is a superset of the input caps
1032 * - fixating by using peer caps
1033 * - fixating with transform fixate function
1034 * - fixating with pad fixate functions.
1036 * this function returns a caps that can be transformed into and is accepted by
1040 gst_base_transform_find_transform (GstBaseTransform * trans, GstPad * pad,
1043 GstBaseTransformClass *klass;
1044 GstPad *otherpad, *otherpeer;
1048 /* caps must be fixed here, this is a programming error if it's not */
1049 g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
1051 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1053 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
1054 otherpeer = gst_pad_get_peer (otherpad);
1056 /* see how we can transform the input caps. We need to do this even for
1057 * passthrough because it might be possible that this element cannot support
1058 * passthrough at all. */
1059 othercaps = gst_base_transform_transform_caps (trans,
1060 GST_PAD_DIRECTION (pad), caps, NULL);
1062 /* The caps we can actually output is the intersection of the transformed
1063 * caps with the pad template for the pad */
1065 GstCaps *intersect, *templ_caps;
1067 templ_caps = gst_pad_get_pad_template_caps (otherpad);
1068 GST_DEBUG_OBJECT (trans,
1069 "intersecting against padtemplate %" GST_PTR_FORMAT, templ_caps);
1072 gst_caps_intersect_full (othercaps, templ_caps,
1073 GST_CAPS_INTERSECT_FIRST);
1075 gst_caps_unref (othercaps);
1076 gst_caps_unref (templ_caps);
1077 othercaps = intersect;
1080 /* check if transform is empty */
1081 if (!othercaps || gst_caps_is_empty (othercaps))
1084 /* if the othercaps are not fixed, we need to fixate them, first attempt
1085 * is by attempting passthrough if the othercaps are a superset of caps. */
1086 /* FIXME. maybe the caps is not fixed because it has multiple structures of
1088 is_fixed = gst_caps_is_fixed (othercaps);
1090 GST_DEBUG_OBJECT (trans,
1091 "transform returned non fixed %" GST_PTR_FORMAT, othercaps);
1093 /* Now let's see what the peer suggests based on our transformed caps */
1095 GstCaps *peercaps, *intersection, *templ_caps;
1097 GST_DEBUG_OBJECT (trans,
1098 "Checking peer caps with filter %" GST_PTR_FORMAT, othercaps);
1100 peercaps = gst_pad_query_caps (otherpeer, othercaps);
1101 GST_DEBUG_OBJECT (trans, "Resulted in %" GST_PTR_FORMAT, peercaps);
1102 if (!gst_caps_is_empty (peercaps)) {
1103 templ_caps = gst_pad_get_pad_template_caps (otherpad);
1105 GST_DEBUG_OBJECT (trans,
1106 "Intersecting with template caps %" GST_PTR_FORMAT, templ_caps);
1109 gst_caps_intersect_full (peercaps, templ_caps,
1110 GST_CAPS_INTERSECT_FIRST);
1111 GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1113 gst_caps_unref (peercaps);
1114 gst_caps_unref (templ_caps);
1115 peercaps = intersection;
1117 GST_DEBUG_OBJECT (trans,
1118 "Intersecting with transformed caps %" GST_PTR_FORMAT, othercaps);
1120 gst_caps_intersect_full (peercaps, othercaps,
1121 GST_CAPS_INTERSECT_FIRST);
1122 GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1124 gst_caps_unref (peercaps);
1125 gst_caps_unref (othercaps);
1126 othercaps = intersection;
1128 gst_caps_unref (othercaps);
1129 othercaps = peercaps;
1132 is_fixed = gst_caps_is_fixed (othercaps);
1134 GST_DEBUG_OBJECT (trans, "no peer, doing passthrough");
1135 gst_caps_unref (othercaps);
1136 othercaps = gst_caps_ref (caps);
1140 if (gst_caps_is_empty (othercaps))
1141 goto no_transform_possible;
1143 GST_DEBUG ("have %sfixed caps %" GST_PTR_FORMAT, (is_fixed ? "" : "non-"),
1146 /* second attempt at fixation, call the fixate vmethod */
1147 /* caps could be fixed but the subclass may want to add fields */
1148 if (klass->fixate_caps) {
1149 GST_DEBUG_OBJECT (trans, "calling fixate_caps for %" GST_PTR_FORMAT
1150 " using caps %" GST_PTR_FORMAT " on pad %s:%s", othercaps, caps,
1151 GST_DEBUG_PAD_NAME (otherpad));
1152 /* note that we pass the complete array of structures to the fixate
1153 * function, it needs to truncate itself */
1155 klass->fixate_caps (trans, GST_PAD_DIRECTION (pad), caps, othercaps);
1156 is_fixed = gst_caps_is_fixed (othercaps);
1157 GST_DEBUG_OBJECT (trans, "after fixating %" GST_PTR_FORMAT, othercaps);
1160 /* caps should be fixed now, if not we have to fail. */
1162 goto could_not_fixate;
1164 /* and peer should accept */
1165 if (otherpeer && !gst_pad_query_accept_caps (otherpeer, othercaps))
1166 goto peer_no_accept;
1168 GST_DEBUG_OBJECT (trans, "Input caps were %" GST_PTR_FORMAT
1169 ", and got final caps %" GST_PTR_FORMAT, caps, othercaps);
1172 gst_object_unref (otherpeer);
1179 GST_DEBUG_OBJECT (trans,
1180 "transform returned useless %" GST_PTR_FORMAT, othercaps);
1183 no_transform_possible:
1185 GST_DEBUG_OBJECT (trans,
1186 "transform could not transform %" GST_PTR_FORMAT
1187 " in anything we support", caps);
1192 GST_DEBUG_OBJECT (trans, "FAILED to fixate %" GST_PTR_FORMAT, othercaps);
1197 GST_DEBUG_OBJECT (trans, "FAILED to get peer of %" GST_PTR_FORMAT
1198 " to accept %" GST_PTR_FORMAT, otherpad, othercaps);
1204 gst_object_unref (otherpeer);
1206 gst_caps_unref (othercaps);
1212 gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
1213 GstPadDirection direction, GstCaps * caps)
1217 GstCaps *othercaps = NULL;
1219 gboolean ret = TRUE;
1222 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
1224 /* we need fixed caps for the check, fall back to the default implementation
1226 if (!gst_caps_is_fixed (caps))
1231 GST_DEBUG_OBJECT (trans, "accept caps %" GST_PTR_FORMAT, caps);
1233 /* get all the formats we can handle on this pad */
1234 if (direction == GST_PAD_SRC)
1235 allowed = gst_pad_query_caps (trans->srcpad, NULL);
1237 allowed = gst_pad_query_caps (trans->sinkpad, NULL);
1240 GST_DEBUG_OBJECT (trans, "gst_pad_query_caps() failed");
1241 goto no_transform_possible;
1244 GST_DEBUG_OBJECT (trans, "allowed caps %" GST_PTR_FORMAT, allowed);
1246 /* intersect with the requested format */
1247 ret = gst_caps_is_subset (caps, allowed);
1248 gst_caps_unref (allowed);
1251 goto no_transform_possible;
1255 GST_DEBUG_OBJECT (pad, "accept caps %" GST_PTR_FORMAT, caps);
1257 /* find best possible caps for the other pad as a way to see if we can
1258 * transform this caps. */
1259 othercaps = gst_base_transform_find_transform (trans, pad, caps, FALSE);
1260 if (!othercaps || gst_caps_is_empty (othercaps))
1261 goto no_transform_possible;
1263 GST_DEBUG_OBJECT (pad, "we can transform to %" GST_PTR_FORMAT, othercaps);
1269 /* We know it's always NULL since we never use it */
1271 gst_caps_unref (othercaps);
1277 no_transform_possible:
1279 GST_DEBUG_OBJECT (trans,
1280 "transform could not transform %" GST_PTR_FORMAT
1281 " in anything we support", caps);
1287 /* called when new caps arrive on the sink pad,
1288 * We try to find the best caps for the other side using our _find_transform()
1289 * function. If there are caps, we configure the transform for this new
1293 gst_base_transform_setcaps (GstBaseTransform * trans, GstPad * pad,
1296 GstBaseTransformPrivate *priv = trans->priv;
1298 gboolean ret = TRUE;
1300 GST_DEBUG_OBJECT (pad, "have new caps %p %" GST_PTR_FORMAT, incaps, incaps);
1302 /* find best possible caps for the other pad */
1303 outcaps = gst_base_transform_find_transform (trans, pad, incaps);
1304 if (!outcaps || gst_caps_is_empty (outcaps))
1305 goto no_transform_possible;
1307 /* configure the element now */
1309 /* if we have the same caps, we can optimize and reuse the input caps */
1310 if (gst_caps_is_equal (incaps, outcaps)) {
1311 GST_INFO_OBJECT (trans, "reuse caps");
1312 gst_caps_unref (outcaps);
1313 outcaps = gst_caps_ref (incaps);
1316 /* call configure now */
1317 if (!(ret = gst_base_transform_configure_caps (trans, incaps, outcaps)))
1318 goto failed_configure;
1320 /* let downstream know about our caps */
1321 ret = gst_pad_set_caps (trans->srcpad, outcaps);
1324 /* try to get a pool when needed */
1325 ret = gst_base_transform_do_bufferpool (trans, outcaps);
1330 gst_caps_unref (outcaps);
1332 GST_OBJECT_LOCK (trans);
1333 priv->negotiated = ret;
1334 GST_OBJECT_UNLOCK (trans);
1339 no_transform_possible:
1341 GST_WARNING_OBJECT (trans,
1342 "transform could not transform %" GST_PTR_FORMAT
1343 " in anything we support", incaps);
1349 GST_WARNING_OBJECT (trans, "FAILED to configure incaps %" GST_PTR_FORMAT
1350 " and outcaps %" GST_PTR_FORMAT, incaps, outcaps);
1357 gst_base_transform_default_propose_allocation (GstBaseTransform * trans,
1358 GstQuery * decide_query, GstQuery * query)
1362 if (decide_query == NULL) {
1363 GST_DEBUG_OBJECT (trans, "doing passthrough query");
1364 ret = gst_pad_peer_query (trans->srcpad, query);
1367 /* non-passthrough, copy all metadata, decide_query does not contain the
1368 * metadata anymore that depends on the buffer memory */
1369 n_metas = gst_query_get_n_allocation_metas (decide_query);
1370 for (i = 0; i < n_metas; i++) {
1372 const GstStructure *params;
1374 api = gst_query_parse_nth_allocation_meta (decide_query, i, ¶ms);
1375 GST_DEBUG_OBJECT (trans, "proposing metadata %s", g_type_name (api));
1376 gst_query_add_allocation_meta (query, api, gst_structure_copy (params));
1384 gst_base_transform_default_query (GstBaseTransform * trans,
1385 GstPadDirection direction, GstQuery * query)
1387 gboolean ret = FALSE;
1388 GstPad *pad, *otherpad;
1389 GstBaseTransformClass *klass;
1390 GstBaseTransformPrivate *priv = trans->priv;
1392 if (direction == GST_PAD_SRC) {
1393 pad = trans->srcpad;
1394 otherpad = trans->sinkpad;
1396 pad = trans->sinkpad;
1397 otherpad = trans->srcpad;
1400 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1402 switch (GST_QUERY_TYPE (query)) {
1403 case GST_QUERY_ALLOCATION:
1405 GstQuery *decide_query = NULL;
1406 gboolean negotiated;
1408 /* can only be done on the sinkpad */
1409 if (direction != GST_PAD_SINK)
1412 GST_OBJECT_LOCK (trans);
1413 if (G_UNLIKELY (!(negotiated = priv->negotiated))) {
1414 GST_DEBUG_OBJECT (trans,
1415 "not negotiated yet, can't answer ALLOCATION query");
1416 GST_OBJECT_UNLOCK (trans);
1419 if ((decide_query = trans->priv->query))
1420 gst_query_ref (decide_query);
1421 GST_OBJECT_UNLOCK (trans);
1423 GST_DEBUG_OBJECT (trans,
1424 "calling propose allocation with query %" GST_PTR_FORMAT,
1427 /* pass the query to the propose_allocation vmethod if any */
1428 if (G_LIKELY (klass->propose_allocation))
1429 ret = klass->propose_allocation (trans, decide_query, query);
1434 gst_query_unref (decide_query);
1436 GST_DEBUG_OBJECT (trans, "ALLOCATION ret %d, %" GST_PTR_FORMAT, ret,
1440 case GST_QUERY_POSITION:
1444 gst_query_parse_position (query, &format, NULL);
1445 if (format == GST_FORMAT_TIME && trans->segment.format == GST_FORMAT_TIME) {
1449 if ((direction == GST_PAD_SINK)
1450 || (trans->priv->position_out == GST_CLOCK_TIME_NONE)) {
1452 gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1453 trans->segment.position);
1455 pos = gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1456 trans->priv->position_out);
1458 gst_query_set_position (query, format, pos);
1460 ret = gst_pad_peer_query (otherpad, query);
1464 case GST_QUERY_ACCEPT_CAPS:
1468 gst_query_parse_accept_caps (query, &caps);
1469 if (klass->accept_caps) {
1470 ret = klass->accept_caps (trans, direction, caps);
1471 gst_query_set_accept_caps_result (query, ret);
1472 /* return TRUE, we answered the query */
1477 case GST_QUERY_CAPS:
1479 GstCaps *filter, *caps;
1481 gst_query_parse_caps (query, &filter);
1482 caps = gst_base_transform_query_caps (trans, pad, filter);
1483 gst_query_set_caps_result (query, caps);
1484 gst_caps_unref (caps);
1489 ret = gst_pad_peer_query (otherpad, query);
1498 gst_base_transform_query (GstPad * pad, GstObject * parent, GstQuery * query)
1500 GstBaseTransform *trans;
1501 GstBaseTransformClass *bclass;
1502 gboolean ret = FALSE;
1504 trans = GST_BASE_TRANSFORM (parent);
1505 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1508 ret = bclass->query (trans, GST_PAD_DIRECTION (pad), query);
1513 /* this function either returns the input buffer without incrementing the
1514 * refcount or it allocates a new (writable) buffer */
1515 static GstFlowReturn
1516 default_prepare_output_buffer (GstBaseTransform * trans,
1517 GstBuffer * inbuf, GstBuffer ** outbuf)
1519 GstBaseTransformPrivate *priv;
1520 GstFlowReturn ret = GST_FLOW_OK;
1521 GstBaseTransformClass *bclass;
1522 GstCaps *incaps, *outcaps;
1523 gsize insize, outsize;
1527 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1529 /* figure out how to allocate an output buffer */
1530 if (priv->passthrough) {
1531 /* passthrough, we will not modify the incomming buffer so we can just
1533 GST_DEBUG_OBJECT (trans, "passthrough: reusing input buffer");
1538 /* we can't reuse the input buffer */
1540 if (!priv->pool_active) {
1541 GST_DEBUG_OBJECT (trans, "setting pool %p active", priv->pool);
1542 if (!gst_buffer_pool_set_active (priv->pool, TRUE))
1543 goto activate_failed;
1544 priv->pool_active = TRUE;
1546 GST_DEBUG_OBJECT (trans, "using pool alloc");
1547 ret = gst_buffer_pool_acquire_buffer (priv->pool, outbuf, NULL);
1551 /* no pool, we need to figure out the size of the output buffer first */
1552 if ((bclass->transform_ip != NULL) && priv->always_in_place) {
1553 /* we want to do an in-place alloc */
1554 if (gst_buffer_is_writable (inbuf)) {
1555 GST_DEBUG_OBJECT (trans, "inplace reuse writable input buffer");
1558 GST_DEBUG_OBJECT (trans, "making writable buffer copy");
1559 /* we make a copy of the input buffer */
1560 *outbuf = gst_buffer_copy (inbuf);
1565 /* else use the transform function to get the size */
1566 incaps = gst_pad_get_current_caps (trans->sinkpad);
1567 outcaps = gst_pad_get_current_caps (trans->srcpad);
1569 GST_DEBUG_OBJECT (trans, "getting output size for alloc");
1570 /* copy transform, figure out the output size */
1571 insize = gst_buffer_get_size (inbuf);
1572 res = gst_base_transform_transform_size (trans,
1573 GST_PAD_SINK, incaps, insize, outcaps, &outsize);
1575 gst_caps_unref (incaps);
1576 gst_caps_unref (outcaps);
1581 GST_DEBUG_OBJECT (trans, "doing alloc of size %" G_GSIZE_FORMAT, outsize);
1582 *outbuf = gst_buffer_new_allocate (priv->allocator, outsize, &priv->params);
1585 /* copy the metadata */
1586 if (bclass->copy_metadata)
1587 if (!bclass->copy_metadata (trans, inbuf, *outbuf)) {
1588 /* something failed, post a warning */
1589 GST_ELEMENT_WARNING (trans, STREAM, NOT_IMPLEMENTED,
1590 ("could not copy metadata"), (NULL));
1600 GST_ELEMENT_ERROR (trans, RESOURCE, SETTINGS,
1601 ("failed to activate bufferpool"), ("failed to activate bufferpool"));
1602 return GST_FLOW_ERROR;
1606 GST_ERROR_OBJECT (trans, "unknown output size");
1607 return GST_FLOW_ERROR;
1613 GstBaseTransform *trans;
1618 foreach_metadata (GstBuffer * inbuf, GstMeta ** meta, gpointer user_data)
1620 CopyMetaData *data = user_data;
1621 GstBaseTransform *trans = data->trans;
1622 GstBaseTransformClass *klass;
1623 const GstMetaInfo *info = (*meta)->info;
1624 GstBuffer *outbuf = data->outbuf;
1627 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1629 if (GST_META_FLAG_IS_SET (*meta, GST_META_FLAG_POOLED)) {
1630 /* never call the transform_meta with pool private metadata */
1631 GST_DEBUG_OBJECT (trans, "not copying pooled metadata %s",
1632 g_type_name (info->api));
1634 } else if (gst_meta_api_type_has_tag (info->api, GST_META_TAG_MEMORY)) {
1635 /* never call the transform_meta with memory specific metadata */
1636 GST_DEBUG_OBJECT (trans, "not copying memory specific metadata %s",
1637 g_type_name (info->api));
1639 } else if (klass->transform_meta) {
1640 do_copy = klass->transform_meta (trans, outbuf, *meta, inbuf);
1641 GST_DEBUG_OBJECT (trans, "transformed metadata %s: copy: %d",
1642 g_type_name (info->api), do_copy);
1645 GST_DEBUG_OBJECT (trans, "not copying metadata %s",
1646 g_type_name (info->api));
1649 /* we only copy metadata when the subclass implemented a transform_meta
1650 * function and when it returns TRUE */
1652 GstMetaTransformCopy copy_data = { FALSE, 0, -1 };
1653 GST_DEBUG_OBJECT (trans, "copy metadata %s", g_type_name (info->api));
1654 /* simply copy then */
1655 info->transform_func (outbuf, *meta, inbuf,
1656 _gst_meta_transform_copy, ©_data);
1662 default_copy_metadata (GstBaseTransform * trans,
1663 GstBuffer * inbuf, GstBuffer * outbuf)
1665 GstBaseTransformPrivate *priv = trans->priv;
1668 /* now copy the metadata */
1669 GST_DEBUG_OBJECT (trans, "copying metadata");
1671 /* this should not happen, buffers allocated from a pool or with
1672 * new_allocate should always be writable. */
1673 if (!gst_buffer_is_writable (outbuf))
1676 /* when we get here, the metadata should be writable */
1677 gst_buffer_copy_into (outbuf, inbuf,
1678 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1680 /* clear the GAP flag when the subclass does not understand it */
1681 if (!priv->gap_aware)
1682 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_GAP);
1686 data.outbuf = outbuf;
1688 gst_buffer_foreach_meta (inbuf, foreach_metadata, &data);
1695 GST_WARNING_OBJECT (trans, "buffer %p not writable", outbuf);
1700 /* Given @caps calcultate the size of one unit.
1702 * For video caps, this is the size of one frame (and thus one buffer).
1703 * For audio caps, this is the size of one sample.
1705 * These values are cached since they do not change and the calculation
1706 * potentially involves parsing caps and other expensive stuff.
1708 * We have two cache locations to store the size, one for the source caps
1709 * and one for the sink caps.
1711 * this function returns FALSE if no size could be calculated.
1714 gst_base_transform_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
1717 gboolean res = FALSE;
1718 GstBaseTransformClass *bclass;
1719 GstBaseTransformPrivate *priv = trans->priv;
1721 /* see if we have the result cached */
1722 if (priv->cache_caps1 == caps) {
1723 *size = priv->cache_caps1_size;
1724 GST_DEBUG_OBJECT (trans,
1725 "returned %" G_GSIZE_FORMAT " from first cache", *size);
1728 if (priv->cache_caps2 == caps) {
1729 *size = priv->cache_caps2_size;
1730 GST_DEBUG_OBJECT (trans,
1731 "returned %" G_GSIZE_FORMAT " from second cached", *size);
1735 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1736 res = bclass->get_unit_size (trans, caps, size);
1737 GST_DEBUG_OBJECT (trans,
1738 "caps %" GST_PTR_FORMAT ") has unit size %" G_GSIZE_FORMAT ", res %s",
1739 caps, *size, res ? "TRUE" : "FALSE");
1742 /* and cache the values */
1743 if (priv->cache_caps1 == NULL) {
1744 gst_caps_replace (&priv->cache_caps1, caps);
1745 priv->cache_caps1_size = *size;
1746 GST_DEBUG_OBJECT (trans,
1747 "caching %" G_GSIZE_FORMAT " in first cache", *size);
1748 } else if (priv->cache_caps2 == NULL) {
1749 gst_caps_replace (&priv->cache_caps2, caps);
1750 priv->cache_caps2_size = *size;
1751 GST_DEBUG_OBJECT (trans,
1752 "caching %" G_GSIZE_FORMAT " in second cache", *size);
1754 GST_DEBUG_OBJECT (trans, "no free spot to cache unit_size");
1761 gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
1764 GstBaseTransform *trans;
1765 GstBaseTransformClass *bclass;
1766 gboolean ret = TRUE;
1768 trans = GST_BASE_TRANSFORM (parent);
1769 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1771 if (bclass->sink_event)
1772 ret = bclass->sink_event (trans, event);
1774 gst_event_unref (event);
1780 gst_base_transform_sink_eventfunc (GstBaseTransform * trans, GstEvent * event)
1782 gboolean ret = TRUE, forward = TRUE;
1783 GstBaseTransformPrivate *priv = trans->priv;
1785 switch (GST_EVENT_TYPE (event)) {
1786 case GST_EVENT_FLUSH_START:
1788 case GST_EVENT_FLUSH_STOP:
1789 GST_OBJECT_LOCK (trans);
1790 /* reset QoS parameters */
1791 priv->proportion = 1.0;
1792 priv->earliest_time = -1;
1793 priv->discont = FALSE;
1794 priv->processed = 0;
1796 GST_OBJECT_UNLOCK (trans);
1797 /* we need new segment info after the flush. */
1798 trans->have_segment = FALSE;
1799 gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
1800 priv->position_out = GST_CLOCK_TIME_NONE;
1806 case GST_EVENT_CAPS:
1810 gst_event_parse_caps (event, &caps);
1811 /* clear any pending reconfigure flag */
1812 gst_pad_check_reconfigure (trans->srcpad);
1813 ret = gst_base_transform_setcaps (trans, trans->sinkpad, caps);
1818 case GST_EVENT_SEGMENT:
1820 gst_event_copy_segment (event, &trans->segment);
1821 trans->have_segment = TRUE;
1823 GST_DEBUG_OBJECT (trans, "received SEGMENT %" GST_SEGMENT_FORMAT,
1832 ret = gst_pad_push_event (trans->srcpad, event);
1834 gst_event_unref (event);
1840 gst_base_transform_src_event (GstPad * pad, GstObject * parent,
1843 GstBaseTransform *trans;
1844 GstBaseTransformClass *bclass;
1845 gboolean ret = TRUE;
1847 trans = GST_BASE_TRANSFORM (parent);
1848 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1850 if (bclass->src_event)
1851 ret = bclass->src_event (trans, event);
1853 gst_event_unref (event);
1859 gst_base_transform_src_eventfunc (GstBaseTransform * trans, GstEvent * event)
1863 GST_DEBUG_OBJECT (trans, "handling event %p %" GST_PTR_FORMAT, event, event);
1865 switch (GST_EVENT_TYPE (event)) {
1866 case GST_EVENT_SEEK:
1868 case GST_EVENT_NAVIGATION:
1873 GstClockTimeDiff diff;
1874 GstClockTime timestamp;
1876 gst_event_parse_qos (event, NULL, &proportion, &diff, ×tamp);
1877 gst_base_transform_update_qos (trans, proportion, diff, timestamp);
1884 ret = gst_pad_push_event (trans->sinkpad, event);
1889 /* perform a transform on @inbuf and put the result in @outbuf.
1891 * This function is common to the push and pull-based operations.
1893 * This function takes ownership of @inbuf */
1894 static GstFlowReturn
1895 gst_base_transform_handle_buffer (GstBaseTransform * trans, GstBuffer * inbuf,
1896 GstBuffer ** outbuf)
1898 GstBaseTransformClass *bclass;
1899 GstBaseTransformPrivate *priv = trans->priv;
1900 GstFlowReturn ret = GST_FLOW_OK;
1901 gboolean want_in_place;
1902 GstClockTime running_time;
1903 GstClockTime timestamp;
1904 gboolean reconfigure;
1906 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1908 reconfigure = gst_pad_check_reconfigure (trans->srcpad);
1910 if (G_UNLIKELY (reconfigure)) {
1913 GST_DEBUG_OBJECT (trans, "we had a pending reconfigure");
1915 incaps = gst_pad_get_current_caps (trans->sinkpad);
1917 goto no_reconfigure;
1919 /* if we need to reconfigure we pretend new caps arrived. This
1920 * will reconfigure the transform with the new output format. */
1921 if (!gst_base_transform_setcaps (trans, trans->sinkpad, incaps)) {
1922 gst_caps_unref (incaps);
1923 goto not_negotiated;
1925 gst_caps_unref (incaps);
1929 if (GST_BUFFER_OFFSET_IS_VALID (inbuf))
1930 GST_DEBUG_OBJECT (trans,
1931 "handling buffer %p of size %" G_GSIZE_FORMAT " and offset %"
1932 G_GUINT64_FORMAT, inbuf, gst_buffer_get_size (inbuf),
1933 GST_BUFFER_OFFSET (inbuf));
1935 GST_DEBUG_OBJECT (trans,
1936 "handling buffer %p of size %" G_GSIZE_FORMAT " and offset NONE", inbuf,
1937 gst_buffer_get_size (inbuf));
1939 /* Don't allow buffer handling before negotiation, except in passthrough mode
1940 * or if the class doesn't implement a set_caps function (in which case it doesn't
1943 if (!priv->negotiated && !priv->passthrough && (bclass->set_caps != NULL))
1944 goto not_negotiated;
1946 /* Set discont flag so we can mark the outgoing buffer */
1947 if (GST_BUFFER_IS_DISCONT (inbuf)) {
1948 GST_DEBUG_OBJECT (trans, "got DISCONT buffer %p", inbuf);
1949 priv->discont = TRUE;
1952 /* can only do QoS if the segment is in TIME */
1953 if (trans->segment.format != GST_FORMAT_TIME)
1956 /* QOS is done on the running time of the buffer, get it now */
1957 timestamp = GST_BUFFER_TIMESTAMP (inbuf);
1958 running_time = gst_segment_to_running_time (&trans->segment, GST_FORMAT_TIME,
1961 if (running_time != -1) {
1963 GstClockTime earliest_time;
1966 /* lock for getting the QoS parameters that are set (in a different thread)
1967 * with the QOS events */
1968 GST_OBJECT_LOCK (trans);
1969 earliest_time = priv->earliest_time;
1970 proportion = priv->proportion;
1971 /* check for QoS, don't perform conversion for buffers
1972 * that are known to be late. */
1973 need_skip = priv->qos_enabled &&
1974 earliest_time != -1 && running_time <= earliest_time;
1975 GST_OBJECT_UNLOCK (trans);
1978 GstMessage *qos_msg;
1979 GstClockTime duration;
1980 guint64 stream_time;
1983 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "skipping transform: qostime %"
1984 GST_TIME_FORMAT " <= %" GST_TIME_FORMAT,
1985 GST_TIME_ARGS (running_time), GST_TIME_ARGS (earliest_time));
1989 duration = GST_BUFFER_DURATION (inbuf);
1991 gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1993 jitter = GST_CLOCK_DIFF (running_time, earliest_time);
1996 gst_message_new_qos (GST_OBJECT_CAST (trans), FALSE, running_time,
1997 stream_time, timestamp, duration);
1998 gst_message_set_qos_values (qos_msg, jitter, proportion, 1000000);
1999 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS,
2000 priv->processed, priv->dropped);
2001 gst_element_post_message (GST_ELEMENT_CAST (trans), qos_msg);
2003 /* mark discont for next buffer */
2004 priv->discont = TRUE;
2011 /* first try to allocate an output buffer based on the currently negotiated
2012 * format. outbuf will contain a buffer suitable for doing the configured
2013 * transform after this function. */
2014 if (bclass->prepare_output_buffer == NULL)
2017 GST_DEBUG_OBJECT (trans, "calling prepare buffer");
2018 ret = bclass->prepare_output_buffer (trans, inbuf, outbuf);
2020 if (ret != GST_FLOW_OK || *outbuf == NULL)
2023 GST_DEBUG_OBJECT (trans, "using allocated buffer in %p, out %p", inbuf,
2026 /* now perform the needed transform */
2027 if (priv->passthrough) {
2028 /* In passthrough mode, give transform_ip a look at the
2029 * buffer, without making it writable, or just push the
2031 if (bclass->transform_ip_on_passthrough && bclass->transform_ip) {
2032 GST_DEBUG_OBJECT (trans, "doing passthrough transform_ip");
2033 ret = bclass->transform_ip (trans, *outbuf);
2035 GST_DEBUG_OBJECT (trans, "element is in passthrough");
2038 want_in_place = (bclass->transform_ip != NULL) && priv->always_in_place;
2040 if (want_in_place) {
2041 GST_DEBUG_OBJECT (trans, "doing inplace transform");
2042 ret = bclass->transform_ip (trans, *outbuf);
2044 GST_DEBUG_OBJECT (trans, "doing non-inplace transform");
2046 if (bclass->transform)
2047 ret = bclass->transform (trans, inbuf, *outbuf);
2049 ret = GST_FLOW_NOT_SUPPORTED;
2054 /* only unref input buffer if we allocated a new outbuf buffer. If we reused
2055 * the input buffer, no refcount is changed to keep the input buffer writable
2057 if (*outbuf != inbuf)
2058 gst_buffer_unref (inbuf);
2065 gst_buffer_unref (inbuf);
2067 GST_ELEMENT_ERROR (trans, STREAM, FORMAT,
2068 ("not negotiated"), ("not negotiated"));
2069 return GST_FLOW_NOT_NEGOTIATED;
2073 gst_buffer_unref (inbuf);
2074 GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED,
2075 ("Sub-class has no prepare_output_buffer implementation"), (NULL));
2076 return GST_FLOW_NOT_SUPPORTED;
2080 gst_buffer_unref (inbuf);
2082 GST_WARNING_OBJECT (trans, "could not get buffer from pool: %s",
2083 gst_flow_get_name (ret));
2088 /* FIXME, getrange is broken, need to pull range from the other
2089 * end based on the transform_size result.
2091 static GstFlowReturn
2092 gst_base_transform_getrange (GstPad * pad, GstObject * parent, guint64 offset,
2093 guint length, GstBuffer ** buffer)
2095 GstBaseTransform *trans;
2096 GstBaseTransformClass *klass;
2098 GstBuffer *inbuf = NULL;
2100 trans = GST_BASE_TRANSFORM (parent);
2102 ret = gst_pad_pull_range (trans->sinkpad, offset, length, &inbuf);
2103 if (G_UNLIKELY (ret != GST_FLOW_OK))
2106 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2107 if (klass->before_transform)
2108 klass->before_transform (trans, inbuf);
2110 ret = gst_base_transform_handle_buffer (trans, inbuf, buffer);
2118 GST_DEBUG_OBJECT (trans, "failed to pull a buffer: %s",
2119 gst_flow_get_name (ret));
2124 static GstFlowReturn
2125 gst_base_transform_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
2127 GstBaseTransform *trans;
2128 GstBaseTransformClass *klass;
2129 GstBaseTransformPrivate *priv;
2131 GstClockTime position = GST_CLOCK_TIME_NONE;
2132 GstClockTime timestamp, duration;
2133 GstBuffer *outbuf = NULL;
2135 trans = GST_BASE_TRANSFORM (parent);
2138 timestamp = GST_BUFFER_TIMESTAMP (buffer);
2139 duration = GST_BUFFER_DURATION (buffer);
2141 /* calculate end position of the incoming buffer */
2142 if (timestamp != GST_CLOCK_TIME_NONE) {
2143 if (duration != GST_CLOCK_TIME_NONE)
2144 position = timestamp + duration;
2146 position = timestamp;
2149 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2150 if (klass->before_transform)
2151 klass->before_transform (trans, buffer);
2153 /* protect transform method and concurrent buffer alloc */
2154 ret = gst_base_transform_handle_buffer (trans, buffer, &outbuf);
2156 /* outbuf can be NULL, this means a dropped buffer, if we have a buffer but
2157 * GST_BASE_TRANSFORM_FLOW_DROPPED we will not push either. */
2158 if (outbuf != NULL) {
2159 if (ret == GST_FLOW_OK) {
2160 GstClockTime position_out = GST_CLOCK_TIME_NONE;
2162 /* Remember last stop position */
2163 if (position != GST_CLOCK_TIME_NONE &&
2164 trans->segment.format == GST_FORMAT_TIME)
2165 trans->segment.position = position;
2167 if (GST_BUFFER_TIMESTAMP_IS_VALID (outbuf)) {
2168 position_out = GST_BUFFER_TIMESTAMP (outbuf);
2169 if (GST_BUFFER_DURATION_IS_VALID (outbuf))
2170 position_out += GST_BUFFER_DURATION (outbuf);
2171 } else if (position != GST_CLOCK_TIME_NONE) {
2172 position_out = position;
2174 if (position_out != GST_CLOCK_TIME_NONE
2175 && trans->segment.format == GST_FORMAT_TIME)
2176 priv->position_out = position_out;
2178 /* apply DISCONT flag if the buffer is not yet marked as such */
2179 if (trans->priv->discont) {
2180 GST_DEBUG_OBJECT (trans, "we have a pending DISCONT");
2181 if (!GST_BUFFER_IS_DISCONT (outbuf)) {
2182 GST_DEBUG_OBJECT (trans, "marking DISCONT on output buffer");
2183 outbuf = gst_buffer_make_writable (outbuf);
2184 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
2186 priv->discont = FALSE;
2190 ret = gst_pad_push (trans->srcpad, outbuf);
2192 GST_DEBUG_OBJECT (trans, "we got return %s", gst_flow_get_name (ret));
2193 gst_buffer_unref (outbuf);
2197 /* convert internal flow to OK and mark discont for the next buffer. */
2198 if (ret == GST_BASE_TRANSFORM_FLOW_DROPPED) {
2199 GST_DEBUG_OBJECT (trans, "dropped a buffer, marking DISCONT");
2200 priv->discont = TRUE;
2208 gst_base_transform_set_property (GObject * object, guint prop_id,
2209 const GValue * value, GParamSpec * pspec)
2211 GstBaseTransform *trans;
2213 trans = GST_BASE_TRANSFORM (object);
2217 gst_base_transform_set_qos_enabled (trans, g_value_get_boolean (value));
2220 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2226 gst_base_transform_get_property (GObject * object, guint prop_id,
2227 GValue * value, GParamSpec * pspec)
2229 GstBaseTransform *trans;
2231 trans = GST_BASE_TRANSFORM (object);
2235 g_value_set_boolean (value, gst_base_transform_is_qos_enabled (trans));
2238 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2243 /* not a vmethod of anything, just an internal method */
2245 gst_base_transform_activate (GstBaseTransform * trans, gboolean active)
2247 GstBaseTransformClass *bclass;
2248 GstBaseTransformPrivate *priv = trans->priv;
2249 gboolean result = TRUE;
2251 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2254 GstCaps *incaps, *outcaps;
2256 if (priv->pad_mode == GST_PAD_MODE_NONE && bclass->start)
2257 result &= bclass->start (trans);
2259 incaps = gst_pad_get_current_caps (trans->sinkpad);
2260 outcaps = gst_pad_get_current_caps (trans->srcpad);
2262 GST_OBJECT_LOCK (trans);
2263 if (incaps && outcaps)
2264 priv->have_same_caps =
2265 gst_caps_is_equal (incaps, outcaps) || priv->passthrough;
2267 priv->have_same_caps = priv->passthrough;
2268 GST_DEBUG_OBJECT (trans, "have_same_caps %d", priv->have_same_caps);
2269 priv->negotiated = FALSE;
2270 trans->have_segment = FALSE;
2271 gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
2272 priv->position_out = GST_CLOCK_TIME_NONE;
2273 priv->proportion = 1.0;
2274 priv->earliest_time = -1;
2275 priv->discont = FALSE;
2276 priv->processed = 0;
2278 GST_OBJECT_UNLOCK (trans);
2281 gst_caps_unref (incaps);
2283 gst_caps_unref (outcaps);
2285 /* We must make sure streaming has finished before resetting things
2286 * and calling the ::stop vfunc */
2287 GST_PAD_STREAM_LOCK (trans->sinkpad);
2288 GST_PAD_STREAM_UNLOCK (trans->sinkpad);
2290 priv->have_same_caps = FALSE;
2291 /* We can only reset the passthrough mode if the instance told us to
2292 handle it in configure_caps */
2293 if (bclass->passthrough_on_same_caps) {
2294 gst_base_transform_set_passthrough (trans, FALSE);
2296 gst_caps_replace (&priv->cache_caps1, NULL);
2297 gst_caps_replace (&priv->cache_caps2, NULL);
2299 if (priv->pad_mode != GST_PAD_MODE_NONE && bclass->stop)
2300 result &= bclass->stop (trans);
2302 gst_base_transform_set_allocation (trans, NULL, NULL, NULL, NULL);
2309 gst_base_transform_sink_activate_mode (GstPad * pad, GstObject * parent,
2310 GstPadMode mode, gboolean active)
2312 gboolean result = FALSE;
2313 GstBaseTransform *trans;
2315 trans = GST_BASE_TRANSFORM (parent);
2318 case GST_PAD_MODE_PUSH:
2320 result = gst_base_transform_activate (trans, active);
2323 trans->priv->pad_mode = active ? GST_PAD_MODE_PUSH : GST_PAD_MODE_NONE;
2335 gst_base_transform_src_activate_mode (GstPad * pad, GstObject * parent,
2336 GstPadMode mode, gboolean active)
2338 gboolean result = FALSE;
2339 GstBaseTransform *trans;
2341 trans = GST_BASE_TRANSFORM (parent);
2344 case GST_PAD_MODE_PULL:
2347 gst_pad_activate_mode (trans->sinkpad, GST_PAD_MODE_PULL, active);
2350 result &= gst_base_transform_activate (trans, active);
2353 trans->priv->pad_mode = active ? mode : GST_PAD_MODE_NONE;
2365 * gst_base_transform_set_passthrough:
2366 * @trans: the #GstBaseTransform to set
2367 * @passthrough: boolean indicating passthrough mode.
2369 * Set passthrough mode for this filter by default. This is mostly
2370 * useful for filters that do not care about negotiation.
2372 * Always TRUE for filters which don't implement either a transform
2373 * or transform_ip method.
2378 gst_base_transform_set_passthrough (GstBaseTransform * trans,
2379 gboolean passthrough)
2381 GstBaseTransformClass *bclass;
2383 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2385 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2387 GST_OBJECT_LOCK (trans);
2388 if (passthrough == FALSE) {
2389 if (bclass->transform_ip || bclass->transform)
2390 trans->priv->passthrough = FALSE;
2392 trans->priv->passthrough = TRUE;
2395 GST_DEBUG_OBJECT (trans, "set passthrough %d", trans->priv->passthrough);
2396 GST_OBJECT_UNLOCK (trans);
2400 * gst_base_transform_is_passthrough:
2401 * @trans: the #GstBaseTransform to query
2403 * See if @trans is configured as a passthrough transform.
2405 * Returns: TRUE is the transform is configured in passthrough mode.
2410 gst_base_transform_is_passthrough (GstBaseTransform * trans)
2414 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2416 GST_OBJECT_LOCK (trans);
2417 result = trans->priv->passthrough;
2418 GST_OBJECT_UNLOCK (trans);
2424 * gst_base_transform_set_in_place:
2425 * @trans: the #GstBaseTransform to modify
2426 * @in_place: Boolean value indicating that we would like to operate
2427 * on in_place buffers.
2429 * Determines whether a non-writable buffer will be copied before passing
2430 * to the transform_ip function.
2432 * <listitem>Always TRUE if no transform function is implemented.</listitem>
2433 * <listitem>Always FALSE if ONLY transform function is implemented.</listitem>
2439 gst_base_transform_set_in_place (GstBaseTransform * trans, gboolean in_place)
2441 GstBaseTransformClass *bclass;
2443 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2445 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2447 GST_OBJECT_LOCK (trans);
2450 if (bclass->transform_ip) {
2451 GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
2452 trans->priv->always_in_place = TRUE;
2455 if (bclass->transform) {
2456 GST_DEBUG_OBJECT (trans, "setting in_place FALSE");
2457 trans->priv->always_in_place = FALSE;
2461 GST_OBJECT_UNLOCK (trans);
2465 * gst_base_transform_is_in_place:
2466 * @trans: the #GstBaseTransform to query
2468 * See if @trans is configured as a in_place transform.
2470 * Returns: TRUE is the transform is configured in in_place mode.
2475 gst_base_transform_is_in_place (GstBaseTransform * trans)
2479 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2481 GST_OBJECT_LOCK (trans);
2482 result = trans->priv->always_in_place;
2483 GST_OBJECT_UNLOCK (trans);
2489 * gst_base_transform_update_qos:
2490 * @trans: a #GstBaseTransform
2491 * @proportion: the proportion
2492 * @diff: the diff against the clock
2493 * @timestamp: the timestamp of the buffer generating the QoS expressed in
2496 * Set the QoS parameters in the transform. This function is called internally
2497 * when a QOS event is received but subclasses can provide custom information
2505 gst_base_transform_update_qos (GstBaseTransform * trans,
2506 gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp)
2508 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2510 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans,
2511 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2512 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (timestamp));
2514 GST_OBJECT_LOCK (trans);
2515 trans->priv->proportion = proportion;
2516 trans->priv->earliest_time = timestamp + diff;
2517 GST_OBJECT_UNLOCK (trans);
2521 * gst_base_transform_set_qos_enabled:
2522 * @trans: a #GstBaseTransform
2523 * @enabled: new state
2525 * Enable or disable QoS handling in the transform.
2532 gst_base_transform_set_qos_enabled (GstBaseTransform * trans, gboolean enabled)
2534 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2536 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "enabled: %d", enabled);
2538 GST_OBJECT_LOCK (trans);
2539 trans->priv->qos_enabled = enabled;
2540 GST_OBJECT_UNLOCK (trans);
2544 * gst_base_transform_is_qos_enabled:
2545 * @trans: a #GstBaseTransform
2547 * Queries if the transform will handle QoS.
2549 * Returns: TRUE if QoS is enabled.
2556 gst_base_transform_is_qos_enabled (GstBaseTransform * trans)
2560 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2562 GST_OBJECT_LOCK (trans);
2563 result = trans->priv->qos_enabled;
2564 GST_OBJECT_UNLOCK (trans);
2570 * gst_base_transform_set_gap_aware:
2571 * @trans: a #GstBaseTransform
2572 * @gap_aware: New state
2574 * If @gap_aware is %FALSE (the default), output buffers will have the
2575 * %GST_BUFFER_FLAG_GAP flag unset.
2577 * If set to %TRUE, the element must handle output buffers with this flag set
2578 * correctly, i.e. it can assume that the buffer contains neutral data but must
2579 * unset the flag if the output is no neutral data.
2586 gst_base_transform_set_gap_aware (GstBaseTransform * trans, gboolean gap_aware)
2588 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2590 GST_OBJECT_LOCK (trans);
2591 trans->priv->gap_aware = gap_aware;
2592 GST_DEBUG_OBJECT (trans, "set gap aware %d", trans->priv->gap_aware);
2593 GST_OBJECT_UNLOCK (trans);
2597 * gst_base_transform_reconfigure_sink:
2598 * @trans: a #GstBaseTransform
2600 * Instructs @trans to request renegotiation upstream. This function is
2601 * typically called after properties on the transform were set that
2602 * influence the input format.
2605 gst_base_transform_reconfigure_sink (GstBaseTransform * trans)
2607 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2609 /* push the renegotiate event */
2610 if (!gst_pad_push_event (GST_BASE_TRANSFORM_SINK_PAD (trans),
2611 gst_event_new_reconfigure ()))
2612 GST_DEBUG_OBJECT (trans, "Renegotiate event wasn't handled");
2616 * gst_base_transform_reconfigure_src:
2617 * @trans: a #GstBaseTransform
2619 * Instructs @trans to renegotiate a new downstream transform on the next
2620 * buffer. This function is typically called after properties on the transform
2621 * were set that influence the output format.
2626 gst_base_transform_reconfigure_src (GstBaseTransform * trans)
2628 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2630 gst_pad_mark_reconfigure (trans->srcpad);