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;
264 static GstElementClass *parent_class = NULL;
266 static void gst_base_transform_class_init (GstBaseTransformClass * klass);
267 static void gst_base_transform_init (GstBaseTransform * trans,
268 GstBaseTransformClass * klass);
270 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
271 * method to get to the padtemplates */
273 gst_base_transform_get_type (void)
275 static volatile gsize base_transform_type = 0;
277 if (g_once_init_enter (&base_transform_type)) {
279 static const GTypeInfo base_transform_info = {
280 sizeof (GstBaseTransformClass),
283 (GClassInitFunc) gst_base_transform_class_init,
286 sizeof (GstBaseTransform),
288 (GInstanceInitFunc) gst_base_transform_init,
291 _type = g_type_register_static (GST_TYPE_ELEMENT,
292 "GstBaseTransform", &base_transform_info, G_TYPE_FLAG_ABSTRACT);
293 g_once_init_leave (&base_transform_type, _type);
295 return base_transform_type;
298 static void gst_base_transform_finalize (GObject * object);
299 static void gst_base_transform_set_property (GObject * object, guint prop_id,
300 const GValue * value, GParamSpec * pspec);
301 static void gst_base_transform_get_property (GObject * object, guint prop_id,
302 GValue * value, GParamSpec * pspec);
303 static gboolean gst_base_transform_src_activate_mode (GstPad * pad,
304 GstObject * parent, GstPadMode mode, gboolean active);
305 static gboolean gst_base_transform_sink_activate_mode (GstPad * pad,
306 GstObject * parent, GstPadMode mode, gboolean active);
307 static gboolean gst_base_transform_activate (GstBaseTransform * trans,
309 static gboolean gst_base_transform_get_unit_size (GstBaseTransform * trans,
310 GstCaps * caps, gsize * size);
312 static gboolean gst_base_transform_src_event (GstPad * pad, GstObject * parent,
314 static gboolean gst_base_transform_src_eventfunc (GstBaseTransform * trans,
316 static gboolean gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
318 static gboolean gst_base_transform_sink_eventfunc (GstBaseTransform * trans,
320 static GstFlowReturn gst_base_transform_getrange (GstPad * pad,
321 GstObject * parent, guint64 offset, guint length, GstBuffer ** buffer);
322 static GstFlowReturn gst_base_transform_chain (GstPad * pad, GstObject * parent,
324 static GstCaps *gst_base_transform_default_transform_caps (GstBaseTransform *
325 trans, GstPadDirection direction, GstCaps * caps, GstCaps * filter);
326 static GstCaps *gst_base_transform_default_fixate_caps (GstBaseTransform *
327 trans, GstPadDirection direction, GstCaps * caps, GstCaps * othercaps);
328 static GstCaps *gst_base_transform_query_caps (GstBaseTransform * trans,
329 GstPad * pad, GstCaps * filter);
330 static gboolean gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
331 GstPadDirection direction, GstCaps * caps);
332 static gboolean gst_base_transform_setcaps (GstBaseTransform * trans,
333 GstPad * pad, GstCaps * caps);
334 static gboolean gst_base_transform_default_decide_allocation (GstBaseTransform
335 * trans, GstQuery * query);
336 static gboolean gst_base_transform_default_propose_allocation (GstBaseTransform
337 * trans, GstQuery * decide_query, GstQuery * query);
338 static gboolean gst_base_transform_query (GstPad * pad, GstObject * parent,
340 static gboolean gst_base_transform_default_query (GstBaseTransform * trans,
341 GstPadDirection direction, GstQuery * query);
342 static gboolean gst_base_transform_default_transform_size (GstBaseTransform *
343 trans, GstPadDirection direction, GstCaps * caps, gsize size,
344 GstCaps * othercaps, gsize * othersize);
346 static GstFlowReturn default_prepare_output_buffer (GstBaseTransform * trans,
347 GstBuffer * inbuf, GstBuffer ** outbuf);
348 static gboolean default_copy_metadata (GstBaseTransform * trans,
349 GstBuffer * inbuf, GstBuffer * outbuf);
351 /* static guint gst_base_transform_signals[LAST_SIGNAL] = { 0 }; */
355 gst_base_transform_finalize (GObject * object)
357 G_OBJECT_CLASS (parent_class)->finalize (object);
361 gst_base_transform_class_init (GstBaseTransformClass * klass)
363 GObjectClass *gobject_class;
365 gobject_class = G_OBJECT_CLASS (klass);
367 GST_DEBUG_CATEGORY_INIT (gst_base_transform_debug, "basetransform", 0,
368 "basetransform element");
370 GST_DEBUG ("gst_base_transform_class_init");
372 g_type_class_add_private (klass, sizeof (GstBaseTransformPrivate));
374 parent_class = g_type_class_peek_parent (klass);
376 gobject_class->set_property = gst_base_transform_set_property;
377 gobject_class->get_property = gst_base_transform_get_property;
379 g_object_class_install_property (gobject_class, PROP_QOS,
380 g_param_spec_boolean ("qos", "QoS", "Handle Quality-of-Service events",
381 DEFAULT_PROP_QOS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
383 gobject_class->finalize = gst_base_transform_finalize;
385 klass->passthrough_on_same_caps = FALSE;
387 klass->transform_caps =
388 GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_caps);
390 GST_DEBUG_FUNCPTR (gst_base_transform_default_fixate_caps);
392 GST_DEBUG_FUNCPTR (gst_base_transform_acceptcaps_default);
393 klass->query = GST_DEBUG_FUNCPTR (gst_base_transform_default_query);
394 klass->decide_allocation =
395 GST_DEBUG_FUNCPTR (gst_base_transform_default_decide_allocation);
396 klass->propose_allocation =
397 GST_DEBUG_FUNCPTR (gst_base_transform_default_propose_allocation);
398 klass->transform_size =
399 GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_size);
401 klass->sink_event = GST_DEBUG_FUNCPTR (gst_base_transform_sink_eventfunc);
402 klass->src_event = GST_DEBUG_FUNCPTR (gst_base_transform_src_eventfunc);
403 klass->prepare_output_buffer =
404 GST_DEBUG_FUNCPTR (default_prepare_output_buffer);
405 klass->copy_metadata = GST_DEBUG_FUNCPTR (default_copy_metadata);
409 gst_base_transform_init (GstBaseTransform * trans,
410 GstBaseTransformClass * bclass)
412 GstPadTemplate *pad_template;
414 GST_DEBUG ("gst_base_transform_init");
416 trans->priv = GST_BASE_TRANSFORM_GET_PRIVATE (trans);
419 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
420 g_return_if_fail (pad_template != NULL);
421 trans->sinkpad = gst_pad_new_from_template (pad_template, "sink");
422 gst_pad_set_event_function (trans->sinkpad,
423 GST_DEBUG_FUNCPTR (gst_base_transform_sink_event));
424 gst_pad_set_chain_function (trans->sinkpad,
425 GST_DEBUG_FUNCPTR (gst_base_transform_chain));
426 gst_pad_set_activatemode_function (trans->sinkpad,
427 GST_DEBUG_FUNCPTR (gst_base_transform_sink_activate_mode));
428 gst_pad_set_query_function (trans->sinkpad,
429 GST_DEBUG_FUNCPTR (gst_base_transform_query));
430 gst_element_add_pad (GST_ELEMENT (trans), trans->sinkpad);
433 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
434 g_return_if_fail (pad_template != NULL);
435 trans->srcpad = gst_pad_new_from_template (pad_template, "src");
436 gst_pad_set_event_function (trans->srcpad,
437 GST_DEBUG_FUNCPTR (gst_base_transform_src_event));
438 gst_pad_set_getrange_function (trans->srcpad,
439 GST_DEBUG_FUNCPTR (gst_base_transform_getrange));
440 gst_pad_set_activatemode_function (trans->srcpad,
441 GST_DEBUG_FUNCPTR (gst_base_transform_src_activate_mode));
442 gst_pad_set_query_function (trans->srcpad,
443 GST_DEBUG_FUNCPTR (gst_base_transform_query));
444 gst_element_add_pad (GST_ELEMENT (trans), trans->srcpad);
446 trans->priv->qos_enabled = DEFAULT_PROP_QOS;
447 trans->cache_caps1 = NULL;
448 trans->cache_caps2 = NULL;
449 trans->priv->pad_mode = GST_PAD_MODE_NONE;
450 trans->priv->gap_aware = FALSE;
452 trans->passthrough = FALSE;
453 if (bclass->transform == NULL) {
454 /* If no transform function, always_in_place is TRUE */
455 GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
456 trans->always_in_place = TRUE;
458 if (bclass->transform_ip == NULL) {
459 GST_DEBUG_OBJECT (trans, "setting passthrough TRUE");
460 trans->passthrough = TRUE;
464 trans->priv->processed = 0;
465 trans->priv->dropped = 0;
469 gst_base_transform_default_transform_caps (GstBaseTransform * trans,
470 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
474 GST_DEBUG_OBJECT (trans, "identity from: %" GST_PTR_FORMAT, caps);
475 /* no transform function, use the identity transform */
477 ret = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
479 ret = gst_caps_ref (caps);
484 /* given @caps on the src or sink pad (given by @direction)
485 * calculate the possible caps on the other pad.
487 * Returns new caps, unref after usage.
490 gst_base_transform_transform_caps (GstBaseTransform * trans,
491 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
494 GstBaseTransformClass *klass;
499 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
501 /* if there is a custom transform function, use this */
502 if (klass->transform_caps) {
503 GST_DEBUG_OBJECT (trans, "transform caps (direction = %d)", direction);
505 GST_LOG_OBJECT (trans, "from: %" GST_PTR_FORMAT, caps);
506 ret = klass->transform_caps (trans, direction, caps, filter);
507 GST_LOG_OBJECT (trans, " to: %" GST_PTR_FORMAT, ret);
509 #ifndef G_DISABLE_ASSERT
511 if (!gst_caps_is_subset (ret, filter)) {
512 GstCaps *intersection;
514 GST_ERROR_OBJECT (trans,
515 "transform_caps returned caps %" GST_PTR_FORMAT
516 " which are not a real subset of the filter caps %"
517 GST_PTR_FORMAT, ret, filter);
518 g_warning ("%s: transform_caps returned caps which are not a real "
519 "subset of the filter caps", GST_ELEMENT_NAME (trans));
522 gst_caps_intersect_full (filter, ret, GST_CAPS_INTERSECT_FIRST);
523 gst_caps_unref (ret);
530 GST_DEBUG_OBJECT (trans, "to: %" GST_PTR_FORMAT, ret);
536 gst_base_transform_default_transform_size (GstBaseTransform * trans,
537 GstPadDirection direction, GstCaps * caps, gsize size,
538 GstCaps * othercaps, gsize * othersize)
540 gsize inunitsize, outunitsize, units;
541 GstBaseTransformClass *klass;
543 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
545 if (klass->get_unit_size == NULL) {
546 /* if there is no transform_size and no unit_size, it means the
547 * element does not modify the size of a buffer */
550 /* there is no transform_size function, we have to use the unit_size
551 * functions. This method assumes there is a fixed unit_size associated with
552 * each caps. We provide the same amount of units on both sides. */
553 if (!gst_base_transform_get_unit_size (trans, caps, &inunitsize))
556 GST_DEBUG_OBJECT (trans,
557 "input size %" G_GSIZE_FORMAT ", input unit size %" G_GSIZE_FORMAT,
560 /* input size must be a multiple of the unit_size of the input caps */
561 if (inunitsize == 0 || (size % inunitsize != 0))
564 /* get the amount of units */
565 units = size / inunitsize;
567 /* now get the unit size of the output */
568 if (!gst_base_transform_get_unit_size (trans, othercaps, &outunitsize))
571 /* the output size is the unit_size times the amount of units on the
573 *othersize = units * outunitsize;
574 GST_DEBUG_OBJECT (trans, "transformed size to %" G_GSIZE_FORMAT,
582 GST_DEBUG_OBJECT (trans, "could not get in_size");
583 g_warning ("%s: could not get in_size", GST_ELEMENT_NAME (trans));
588 GST_DEBUG_OBJECT (trans, "Size %" G_GSIZE_FORMAT " is not a multiple of"
589 "unit size %" G_GSIZE_FORMAT, size, inunitsize);
590 g_warning ("%s: size %" G_GSIZE_FORMAT " is not a multiple of unit size %"
591 G_GSIZE_FORMAT, GST_ELEMENT_NAME (trans), size, inunitsize);
596 GST_DEBUG_OBJECT (trans, "could not get out_size");
597 g_warning ("%s: could not get out_size", GST_ELEMENT_NAME (trans));
602 /* transform a buffer of @size with @caps on the pad with @direction to
603 * the size of a buffer with @othercaps and store the result in @othersize
605 * We have two ways of doing this:
606 * 1) use a custom transform size function, this is for complicated custom
607 * cases with no fixed unit_size.
608 * 2) use the unit_size functions where there is a relationship between the
609 * caps and the size of a buffer.
612 gst_base_transform_transform_size (GstBaseTransform * trans,
613 GstPadDirection direction, GstCaps * caps,
614 gsize size, GstCaps * othercaps, gsize * othersize)
616 GstBaseTransformClass *klass;
617 gboolean ret = FALSE;
619 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
621 GST_DEBUG_OBJECT (trans,
622 "asked to transform size %" G_GSIZE_FORMAT " for caps %"
623 GST_PTR_FORMAT " to size for caps %" GST_PTR_FORMAT " in direction %s",
624 size, caps, othercaps, direction == GST_PAD_SRC ? "SRC" : "SINK");
626 if (klass->transform_size) {
627 /* if there is a custom transform function, use this */
628 ret = klass->transform_size (trans, direction, caps, size, othercaps,
634 /* get the caps that can be handled by @pad. We perform:
636 * - take the caps of peer of otherpad,
637 * - filter against the padtemplate of otherpad,
638 * - calculate all transforms of remaining caps
639 * - filter against template of @pad
641 * If there is no peer, we simply return the caps of the padtemplate of pad.
644 gst_base_transform_query_caps (GstBaseTransform * trans, GstPad * pad,
648 GstCaps *peercaps, *caps, *temp, *peerfilter = NULL;
651 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
653 /* we can do what the peer can */
656 GST_DEBUG_OBJECT (pad, "filter caps %" GST_PTR_FORMAT, filter);
658 /* filtered against our padtemplate on the other side */
659 templ = gst_pad_get_pad_template_caps (pad);
660 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
661 temp = gst_caps_intersect_full (filter, templ, GST_CAPS_INTERSECT_FIRST);
662 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
663 gst_caps_unref (templ);
665 /* then see what we can transform this to */
666 peerfilter = gst_base_transform_transform_caps (trans,
667 GST_PAD_DIRECTION (pad), temp, NULL);
668 GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, peerfilter);
669 gst_caps_unref (temp);
671 /* and filter against the template of this pad */
672 templ = gst_pad_get_pad_template_caps (otherpad);
673 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
674 /* We keep the caps sorted like the returned caps */
676 gst_caps_intersect_full (peerfilter, templ, GST_CAPS_INTERSECT_FIRST);
677 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
678 gst_caps_unref (peerfilter);
679 gst_caps_unref (templ);
683 peercaps = gst_pad_peer_query_caps (otherpad, peerfilter);
686 gst_caps_unref (peerfilter);
689 GST_DEBUG_OBJECT (pad, "peer caps %" GST_PTR_FORMAT, peercaps);
691 /* filtered against our padtemplate on the other side */
692 templ = gst_pad_get_pad_template_caps (otherpad);
693 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
694 temp = gst_caps_intersect_full (peercaps, templ, GST_CAPS_INTERSECT_FIRST);
695 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
696 gst_caps_unref (templ);
698 temp = gst_pad_get_pad_template_caps (otherpad);
701 /* then see what we can transform this to */
702 caps = gst_base_transform_transform_caps (trans,
703 GST_PAD_DIRECTION (otherpad), temp, filter);
704 GST_DEBUG_OBJECT (pad, "transformed %" GST_PTR_FORMAT, caps);
705 gst_caps_unref (temp);
710 /* and filter against the template of this pad */
711 templ = gst_pad_get_pad_template_caps (pad);
712 GST_DEBUG_OBJECT (pad, "our template %" GST_PTR_FORMAT, templ);
713 /* We keep the caps sorted like the returned caps */
714 temp = gst_caps_intersect_full (caps, templ, GST_CAPS_INTERSECT_FIRST);
715 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
716 gst_caps_unref (caps);
717 gst_caps_unref (templ);
720 /* Now try if we can put the untransformed downstream caps first */
721 temp = gst_caps_intersect_full (peercaps, caps, GST_CAPS_INTERSECT_FIRST);
722 if (!gst_caps_is_empty (temp)) {
723 gst_caps_merge (temp, caps);
726 gst_caps_unref (temp);
729 gst_caps_unref (caps);
730 /* no peer or the peer can do anything, our padtemplate is enough then */
731 caps = gst_pad_get_pad_template_caps (pad);
736 temp = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
737 gst_caps_unref (caps);
743 GST_DEBUG_OBJECT (trans, "returning %" GST_PTR_FORMAT, caps);
746 gst_caps_unref (peercaps);
751 /* takes ownership of the pool, allocator and query */
753 gst_base_transform_set_allocation (GstBaseTransform * trans,
754 GstBufferPool * pool, GstAllocator * allocator, guint prefix,
755 guint alignment, GstQuery * query)
757 GstAllocator *oldalloc;
758 GstBufferPool *oldpool;
760 GstBaseTransformPrivate *priv = trans->priv;
764 GST_DEBUG_OBJECT (trans, "setting pool %p active", pool);
765 if (!gst_buffer_pool_set_active (pool, TRUE))
766 goto activate_failed;
769 GST_OBJECT_LOCK (trans);
770 oldpool = priv->pool;
772 oldalloc = priv->allocator;
773 priv->allocator = allocator;
774 oldquery = priv->query;
776 priv->prefix = prefix;
777 priv->alignment = alignment;
778 GST_OBJECT_UNLOCK (trans);
781 GST_DEBUG_OBJECT (trans, "deactivating old pool %p", oldpool);
782 gst_buffer_pool_set_active (oldpool, FALSE);
783 gst_object_unref (oldpool);
786 gst_allocator_unref (oldalloc);
789 gst_query_unref (oldquery);
796 GST_ERROR_OBJECT (trans, "failed to activate bufferpool.");
802 gst_base_transform_default_decide_allocation (GstBaseTransform * trans,
807 n_metas = gst_query_get_n_allocation_metas (query);
808 for (i = 0; i < n_metas; i++) {
811 api = gst_query_parse_nth_allocation_meta (query, i);
812 /* remove all memory dependent metadata because we are going to have to
813 * allocate different memory for input and output. */
814 if (gst_meta_api_type_has_tag (api, GST_META_TAG_MEMORY)) {
815 GST_LOG_OBJECT (trans, "removing memory metadata %s", g_type_name (api));
816 gst_query_remove_nth_allocation_meta (query, i);
826 gst_base_transform_do_bufferpool (GstBaseTransform * trans, GstCaps * outcaps)
829 gboolean result = TRUE;
830 GstBufferPool *pool = NULL;
831 guint size, min, max, prefix, alignment;
832 GstBaseTransformClass *klass;
833 GstAllocator *allocator = NULL;
835 /* there are these possibilities:
837 * 1) we negotiated passthrough, we can proxy the bufferpool directly and we
838 * will do that whenever some upstream does an allocation query.
839 * 2) we need to do a transform, we need to get a bufferpool from downstream
840 * and configure it. When upstream does the ALLOCATION query, the
841 * propose_allocation vmethod will be called and we will configure the
842 * upstream allocator with our proposed values then.
844 if (trans->passthrough || trans->always_in_place) {
845 /* we are in passthrough, the input buffer is never copied and always passed
846 * along. We never allocate an output buffer on the srcpad. What we do is
847 * let the upstream element decide if it wants to use a bufferpool and
848 * then we will proxy the downstream pool */
849 GST_DEBUG_OBJECT (trans, "we're passthough, delay bufferpool");
850 gst_base_transform_set_allocation (trans, NULL, NULL, 0, 0, NULL);
854 /* not passthrough, we need to allocate */
855 /* find a pool for the negotiated caps now */
856 GST_DEBUG_OBJECT (trans, "doing allocation query");
857 query = gst_query_new_allocation (outcaps, TRUE);
858 if (!gst_pad_peer_query (trans->srcpad, query)) {
859 /* not a problem, just debug a little */
860 GST_DEBUG_OBJECT (trans, "peer ALLOCATION query failed");
863 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
865 GST_DEBUG_OBJECT (trans, "calling decide_allocation");
866 if (G_LIKELY (klass->decide_allocation))
867 if ((result = klass->decide_allocation (trans, query)) == FALSE)
868 goto no_decide_allocation;
870 /* we got configuration from our peer, parse them */
871 gst_query_parse_allocation_params (query, &size, &min, &max, &prefix,
875 /* no size, we have variable size buffers */
876 if (gst_query_get_n_allocation_memories (query) > 0) {
877 if ((allocator = gst_query_parse_nth_allocation_memory (query, 0)))
878 gst_allocator_ref (allocator);
880 GST_DEBUG_OBJECT (trans, "no size, using allocator %p", allocator);
881 } else if (pool == NULL) {
882 GstStructure *config;
884 /* we did not get a pool, make one ourselves then */
885 pool = gst_buffer_pool_new ();
887 GST_DEBUG_OBJECT (trans, "no pool, making one");
888 config = gst_buffer_pool_get_config (pool);
889 gst_buffer_pool_config_set (config, outcaps, size, min, max, prefix,
891 gst_buffer_pool_set_config (pool, config);
896 gst_base_transform_set_allocation (trans, pool, allocator, prefix,
902 no_decide_allocation:
904 GST_WARNING_OBJECT (trans, "Subclass failed to decide allocation");
905 gst_query_unref (query);
911 /* function triggered when the in and out caps are negotiated and need
912 * to be configured in the subclass. */
914 gst_base_transform_configure_caps (GstBaseTransform * trans, GstCaps * in,
918 GstBaseTransformClass *klass;
920 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
922 GST_DEBUG_OBJECT (trans, "in caps: %" GST_PTR_FORMAT, in);
923 GST_DEBUG_OBJECT (trans, "out caps: %" GST_PTR_FORMAT, out);
925 /* clear the cache */
926 gst_caps_replace (&trans->cache_caps1, NULL);
927 gst_caps_replace (&trans->cache_caps2, NULL);
929 /* figure out same caps state */
930 trans->have_same_caps = gst_caps_is_equal (in, out);
931 GST_DEBUG_OBJECT (trans, "have_same_caps: %d", trans->have_same_caps);
933 /* If we've a transform_ip method and same input/output caps, set in_place
934 * by default. If for some reason the sub-class prefers using a transform
935 * function, it can clear the in place flag in the set_caps */
936 gst_base_transform_set_in_place (trans,
937 klass->transform_ip && trans->have_same_caps);
939 /* Set the passthrough if the class wants passthrough_on_same_caps
940 * and we have the same caps on each pad */
941 if (klass->passthrough_on_same_caps)
942 gst_base_transform_set_passthrough (trans, trans->have_same_caps);
944 /* now configure the element with the caps */
945 if (klass->set_caps) {
946 GST_DEBUG_OBJECT (trans, "Calling set_caps method to setup caps");
947 ret = klass->set_caps (trans, in, out);
950 trans->negotiated = ret;
956 gst_base_transform_default_fixate_caps (GstBaseTransform * trans,
957 GstPadDirection direction, GstCaps * caps, GstCaps * othercaps)
959 othercaps = gst_caps_make_writable (othercaps);
960 gst_caps_fixate (othercaps);
961 GST_DEBUG_OBJECT (trans, "fixated to %" GST_PTR_FORMAT, othercaps);
966 /* given a fixed @caps on @pad, create the best possible caps for the
968 * @caps must be fixed when calling this function.
970 * This function calls the transform caps vmethod of the basetransform to figure
971 * out the possible target formats. It then tries to select the best format from
974 * - attempt passthrough if the target caps is a superset of the input caps
975 * - fixating by using peer caps
976 * - fixating with transform fixate function
977 * - fixating with pad fixate functions.
979 * this function returns a caps that can be transformed into and is accepted by
983 gst_base_transform_find_transform (GstBaseTransform * trans, GstPad * pad,
986 GstBaseTransformClass *klass;
987 GstPad *otherpad, *otherpeer;
991 /* caps must be fixed here, this is a programming error if it's not */
992 g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
994 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
996 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
997 otherpeer = gst_pad_get_peer (otherpad);
999 /* see how we can transform the input caps. We need to do this even for
1000 * passthrough because it might be possible that this element cannot support
1001 * passthrough at all. */
1002 othercaps = gst_base_transform_transform_caps (trans,
1003 GST_PAD_DIRECTION (pad), caps, NULL);
1005 /* The caps we can actually output is the intersection of the transformed
1006 * caps with the pad template for the pad */
1008 GstCaps *intersect, *templ_caps;
1010 templ_caps = gst_pad_get_pad_template_caps (otherpad);
1011 GST_DEBUG_OBJECT (trans,
1012 "intersecting against padtemplate %" GST_PTR_FORMAT, templ_caps);
1015 gst_caps_intersect_full (othercaps, templ_caps,
1016 GST_CAPS_INTERSECT_FIRST);
1018 gst_caps_unref (othercaps);
1019 gst_caps_unref (templ_caps);
1020 othercaps = intersect;
1023 /* check if transform is empty */
1024 if (!othercaps || gst_caps_is_empty (othercaps))
1027 /* if the othercaps are not fixed, we need to fixate them, first attempt
1028 * is by attempting passthrough if the othercaps are a superset of caps. */
1029 /* FIXME. maybe the caps is not fixed because it has multiple structures of
1031 is_fixed = gst_caps_is_fixed (othercaps);
1033 GST_DEBUG_OBJECT (trans,
1034 "transform returned non fixed %" GST_PTR_FORMAT, othercaps);
1036 /* Now let's see what the peer suggests based on our transformed caps */
1038 GstCaps *peercaps, *intersection, *templ_caps;
1040 GST_DEBUG_OBJECT (trans,
1041 "Checking peer caps with filter %" GST_PTR_FORMAT, othercaps);
1043 peercaps = gst_pad_query_caps (otherpeer, othercaps);
1044 GST_DEBUG_OBJECT (trans, "Resulted in %" GST_PTR_FORMAT, peercaps);
1045 if (!gst_caps_is_empty (peercaps)) {
1046 templ_caps = gst_pad_get_pad_template_caps (otherpad);
1048 GST_DEBUG_OBJECT (trans,
1049 "Intersecting with template caps %" GST_PTR_FORMAT, templ_caps);
1052 gst_caps_intersect_full (peercaps, templ_caps,
1053 GST_CAPS_INTERSECT_FIRST);
1054 GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1056 gst_caps_unref (peercaps);
1057 gst_caps_unref (templ_caps);
1058 peercaps = intersection;
1060 GST_DEBUG_OBJECT (trans,
1061 "Intersecting with transformed caps %" GST_PTR_FORMAT, othercaps);
1063 gst_caps_intersect_full (peercaps, othercaps,
1064 GST_CAPS_INTERSECT_FIRST);
1065 GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1067 gst_caps_unref (peercaps);
1068 gst_caps_unref (othercaps);
1069 othercaps = intersection;
1071 othercaps = peercaps;
1074 is_fixed = gst_caps_is_fixed (othercaps);
1076 GST_DEBUG_OBJECT (trans, "no peer, doing passthrough");
1077 gst_caps_unref (othercaps);
1078 othercaps = gst_caps_ref (caps);
1082 if (gst_caps_is_empty (othercaps))
1083 goto no_transform_possible;
1085 GST_DEBUG ("have %sfixed caps %" GST_PTR_FORMAT, (is_fixed ? "" : "non-"),
1088 /* second attempt at fixation, call the fixate vmethod */
1089 /* caps could be fixed but the subclass may want to add fields */
1090 if (klass->fixate_caps) {
1091 GST_DEBUG_OBJECT (trans, "calling fixate_caps for %" GST_PTR_FORMAT
1092 " using caps %" GST_PTR_FORMAT " on pad %s:%s", othercaps, caps,
1093 GST_DEBUG_PAD_NAME (otherpad));
1094 /* note that we pass the complete array of structures to the fixate
1095 * function, it needs to truncate itself */
1097 klass->fixate_caps (trans, GST_PAD_DIRECTION (pad), caps, othercaps);
1098 is_fixed = gst_caps_is_fixed (othercaps);
1099 GST_DEBUG_OBJECT (trans, "after fixating %" GST_PTR_FORMAT, othercaps);
1102 /* caps should be fixed now, if not we have to fail. */
1104 goto could_not_fixate;
1106 /* and peer should accept */
1107 if (otherpeer && !gst_pad_query_accept_caps (otherpeer, othercaps))
1108 goto peer_no_accept;
1110 GST_DEBUG_OBJECT (trans, "Input caps were %" GST_PTR_FORMAT
1111 ", and got final caps %" GST_PTR_FORMAT, caps, othercaps);
1114 gst_object_unref (otherpeer);
1121 GST_DEBUG_OBJECT (trans,
1122 "transform returned useless %" GST_PTR_FORMAT, othercaps);
1125 no_transform_possible:
1127 GST_DEBUG_OBJECT (trans,
1128 "transform could not transform %" GST_PTR_FORMAT
1129 " in anything we support", caps);
1134 GST_DEBUG_OBJECT (trans, "FAILED to fixate %" GST_PTR_FORMAT, othercaps);
1139 GST_DEBUG_OBJECT (trans, "FAILED to get peer of %" GST_PTR_FORMAT
1140 " to accept %" GST_PTR_FORMAT, otherpad, othercaps);
1146 gst_object_unref (otherpeer);
1148 gst_caps_unref (othercaps);
1154 gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
1155 GstPadDirection direction, GstCaps * caps)
1159 GstCaps *othercaps = NULL;
1161 gboolean ret = TRUE;
1164 otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
1166 /* we need fixed caps for the check, fall back to the default implementation
1168 if (!gst_caps_is_fixed (caps))
1173 GST_DEBUG_OBJECT (trans, "non fixed accept caps %" GST_PTR_FORMAT, caps);
1175 /* get all the formats we can handle on this pad */
1176 if (direction == GST_PAD_SRC)
1177 allowed = gst_pad_query_caps (trans->srcpad, NULL);
1179 allowed = gst_pad_query_caps (trans->sinkpad, NULL);
1182 GST_DEBUG_OBJECT (trans, "gst_pad_query_caps() failed");
1183 goto no_transform_possible;
1186 GST_DEBUG_OBJECT (trans, "allowed caps %" GST_PTR_FORMAT, allowed);
1188 /* intersect with the requested format */
1189 ret = gst_caps_is_subset (caps, allowed);
1190 gst_caps_unref (allowed);
1193 goto no_transform_possible;
1197 GST_DEBUG_OBJECT (pad, "accept caps %" GST_PTR_FORMAT, caps);
1199 /* find best possible caps for the other pad as a way to see if we can
1200 * transform this caps. */
1201 othercaps = gst_base_transform_find_transform (trans, pad, caps, FALSE);
1202 if (!othercaps || gst_caps_is_empty (othercaps))
1203 goto no_transform_possible;
1205 GST_DEBUG_OBJECT (pad, "we can transform to %" GST_PTR_FORMAT, othercaps);
1211 /* We know it's always NULL since we never use it */
1213 gst_caps_unref (othercaps);
1219 no_transform_possible:
1221 GST_DEBUG_OBJECT (trans,
1222 "transform could not transform %" GST_PTR_FORMAT
1223 " in anything we support", caps);
1229 /* called when new caps arrive on the sink pad,
1230 * We try to find the best caps for the other side using our _find_transform()
1231 * function. If there are caps, we configure the transform for this new
1235 gst_base_transform_setcaps (GstBaseTransform * trans, GstPad * pad,
1239 gboolean ret = TRUE;
1241 GST_DEBUG_OBJECT (pad, "have new caps %p %" GST_PTR_FORMAT, incaps, incaps);
1243 /* find best possible caps for the other pad */
1244 outcaps = gst_base_transform_find_transform (trans, pad, incaps);
1245 if (!outcaps || gst_caps_is_empty (outcaps))
1246 goto no_transform_possible;
1248 /* configure the element now */
1250 /* if we have the same caps, we can optimize and reuse the input caps */
1251 if (gst_caps_is_equal (incaps, outcaps)) {
1252 GST_INFO_OBJECT (trans, "reuse caps");
1253 gst_caps_unref (outcaps);
1254 outcaps = gst_caps_ref (incaps);
1257 /* call configure now */
1258 if (!(ret = gst_base_transform_configure_caps (trans, incaps, outcaps)))
1259 goto failed_configure;
1261 GST_OBJECT_LOCK (trans->sinkpad);
1262 GST_OBJECT_FLAG_UNSET (trans->srcpad, GST_PAD_FLAG_NEED_RECONFIGURE);
1263 trans->priv->reconfigure = FALSE;
1264 GST_OBJECT_UNLOCK (trans->sinkpad);
1266 /* we know this will work, we implement the setcaps */
1267 gst_pad_push_event (trans->srcpad, gst_event_new_caps (outcaps));
1270 /* try to get a pool when needed */
1271 ret = gst_base_transform_do_bufferpool (trans, outcaps);
1276 gst_caps_unref (outcaps);
1278 trans->negotiated = ret;
1283 no_transform_possible:
1285 GST_WARNING_OBJECT (trans,
1286 "transform could not transform %" GST_PTR_FORMAT
1287 " in anything we support", incaps);
1293 GST_WARNING_OBJECT (trans, "FAILED to configure incaps %" GST_PTR_FORMAT
1294 " and outcaps %" GST_PTR_FORMAT, incaps, outcaps);
1301 gst_base_transform_default_propose_allocation (GstBaseTransform * trans,
1302 GstQuery * decide_query, GstQuery * query)
1306 if (decide_query == NULL) {
1307 GST_DEBUG_OBJECT (trans, "doing passthrough query");
1308 ret = gst_pad_peer_query (trans->srcpad, query);
1316 gst_base_transform_default_query (GstBaseTransform * trans,
1317 GstPadDirection direction, GstQuery * query)
1319 gboolean ret = FALSE;
1320 GstPad *pad, *otherpad;
1321 GstBaseTransformClass *klass;
1323 if (direction == GST_PAD_SRC) {
1324 pad = trans->srcpad;
1325 otherpad = trans->sinkpad;
1327 pad = trans->sinkpad;
1328 otherpad = trans->srcpad;
1331 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1333 switch (GST_QUERY_TYPE (query)) {
1334 case GST_QUERY_ALLOCATION:
1336 GstQuery *decide_query;
1338 /* can only be done on the sinkpad */
1339 if (direction != GST_PAD_SINK)
1342 GST_OBJECT_LOCK (trans);
1343 if ((decide_query = trans->priv->query))
1344 gst_query_ref (decide_query);
1345 GST_OBJECT_UNLOCK (trans);
1347 GST_DEBUG_OBJECT (trans,
1348 "calling propose allocation with query %" GST_PTR_FORMAT,
1351 /* pass the query to the propose_allocation vmethod if any */
1352 if (G_LIKELY (klass->propose_allocation))
1353 ret = klass->propose_allocation (trans, decide_query, query);
1358 gst_query_unref (decide_query);
1360 GST_DEBUG_OBJECT (trans, "ALLOCATION ret %d, %" GST_PTR_FORMAT, ret,
1364 case GST_QUERY_POSITION:
1368 gst_query_parse_position (query, &format, NULL);
1369 if (format == GST_FORMAT_TIME && trans->segment.format == GST_FORMAT_TIME) {
1373 if ((direction == GST_PAD_SINK)
1374 || (trans->priv->position_out == GST_CLOCK_TIME_NONE)) {
1376 gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1377 trans->segment.position);
1379 pos = gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1380 trans->priv->position_out);
1382 gst_query_set_position (query, format, pos);
1384 ret = gst_pad_peer_query (otherpad, query);
1388 case GST_QUERY_ACCEPT_CAPS:
1392 gst_query_parse_accept_caps (query, &caps);
1393 if (klass->accept_caps) {
1394 ret = klass->accept_caps (trans, direction, caps);
1395 gst_query_set_accept_caps_result (query, ret);
1396 /* return TRUE, we answered the query */
1401 case GST_QUERY_CAPS:
1403 GstCaps *filter, *caps;
1405 gst_query_parse_caps (query, &filter);
1406 caps = gst_base_transform_query_caps (trans, pad, filter);
1407 gst_query_set_caps_result (query, caps);
1408 gst_caps_unref (caps);
1413 ret = gst_pad_peer_query (otherpad, query);
1422 gst_base_transform_query (GstPad * pad, GstObject * parent, GstQuery * query)
1424 GstBaseTransform *trans;
1425 GstBaseTransformClass *bclass;
1426 gboolean ret = FALSE;
1428 trans = GST_BASE_TRANSFORM (parent);
1429 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1432 ret = bclass->query (trans, GST_PAD_DIRECTION (pad), query);
1437 /* this function either returns the input buffer without incrementing the
1438 * refcount or it allocates a new (writable) buffer */
1439 static GstFlowReturn
1440 default_prepare_output_buffer (GstBaseTransform * trans,
1441 GstBuffer * inbuf, GstBuffer ** outbuf)
1443 GstBaseTransformPrivate *priv;
1444 GstFlowReturn ret = GST_FLOW_OK;
1445 GstBaseTransformClass *bclass;
1446 GstCaps *incaps, *outcaps;
1447 gsize insize, outsize;
1451 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1453 /* figure out how to allocate an output buffer */
1454 if (trans->passthrough) {
1455 /* passthrough, we will not modify the incomming buffer so we can just
1457 GST_DEBUG_OBJECT (trans, "passthrough: reusing input buffer");
1462 /* we can't reuse the input buffer */
1464 GST_DEBUG_OBJECT (trans, "using pool alloc");
1465 ret = gst_buffer_pool_acquire_buffer (priv->pool, outbuf, NULL);
1469 /* no pool, we need to figure out the size of the output buffer first */
1470 if ((bclass->transform_ip != NULL) && trans->always_in_place) {
1471 /* we want to do an in-place alloc */
1472 if (gst_buffer_is_writable (inbuf)) {
1473 GST_DEBUG_OBJECT (trans, "inplace reuse writable input buffer");
1476 GST_DEBUG_OBJECT (trans, "making writable buffer copy");
1477 /* we make a copy of the input buffer */
1478 *outbuf = gst_buffer_copy (inbuf);
1483 /* else use the transform function to get the size */
1484 incaps = gst_pad_get_current_caps (trans->sinkpad);
1485 outcaps = gst_pad_get_current_caps (trans->srcpad);
1487 GST_DEBUG_OBJECT (trans, "getting output size for alloc");
1488 /* copy transform, figure out the output size */
1489 insize = gst_buffer_get_size (inbuf);
1490 res = gst_base_transform_transform_size (trans,
1491 GST_PAD_SINK, incaps, insize, outcaps, &outsize);
1493 gst_caps_unref (incaps);
1494 gst_caps_unref (outcaps);
1499 GST_DEBUG_OBJECT (trans, "doing alloc of size %" G_GSIZE_FORMAT, outsize);
1500 *outbuf = gst_buffer_new_allocate (priv->allocator, outsize, priv->alignment);
1503 /* copy the metadata */
1504 if (bclass->copy_metadata)
1505 if (!bclass->copy_metadata (trans, inbuf, *outbuf)) {
1506 /* something failed, post a warning */
1507 GST_ELEMENT_WARNING (trans, STREAM, NOT_IMPLEMENTED,
1508 ("could not copy metadata"), (NULL));
1517 GST_ERROR_OBJECT (trans, "unknown output size");
1518 return GST_FLOW_ERROR;
1523 default_copy_metadata (GstBaseTransform * trans,
1524 GstBuffer * inbuf, GstBuffer * outbuf)
1526 GstBaseTransformPrivate *priv = trans->priv;
1528 /* now copy the metadata */
1529 GST_DEBUG_OBJECT (trans, "copying metadata");
1531 /* this should not happen, buffers allocated from a pool or with
1532 * new_allocate should always be writable. */
1533 if (!gst_buffer_is_writable (outbuf))
1536 /* when we get here, the metadata should be writable */
1537 gst_buffer_copy_into (outbuf, inbuf,
1538 GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1540 /* clear the GAP flag when the subclass does not understand it */
1541 if (!priv->gap_aware)
1542 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_GAP);
1549 GST_WARNING_OBJECT (trans, "buffer %p not writable", outbuf);
1554 /* Given @caps calcultate the size of one unit.
1556 * For video caps, this is the size of one frame (and thus one buffer).
1557 * For audio caps, this is the size of one sample.
1559 * These values are cached since they do not change and the calculation
1560 * potentially involves parsing caps and other expensive stuff.
1562 * We have two cache locations to store the size, one for the source caps
1563 * and one for the sink caps.
1565 * this function returns FALSE if no size could be calculated.
1568 gst_base_transform_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
1571 gboolean res = FALSE;
1572 GstBaseTransformClass *bclass;
1574 /* see if we have the result cached */
1575 if (trans->cache_caps1 == caps) {
1576 *size = trans->cache_caps1_size;
1577 GST_DEBUG_OBJECT (trans,
1578 "returned %" G_GSIZE_FORMAT " from first cache", *size);
1581 if (trans->cache_caps2 == caps) {
1582 *size = trans->cache_caps2_size;
1583 GST_DEBUG_OBJECT (trans,
1584 "returned %" G_GSIZE_FORMAT " from second cached", *size);
1588 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1589 res = bclass->get_unit_size (trans, caps, size);
1590 GST_DEBUG_OBJECT (trans,
1591 "caps %" GST_PTR_FORMAT ") has unit size %" G_GSIZE_FORMAT ", res %s",
1592 caps, *size, res ? "TRUE" : "FALSE");
1595 /* and cache the values */
1596 if (trans->cache_caps1 == NULL) {
1597 gst_caps_replace (&trans->cache_caps1, caps);
1598 trans->cache_caps1_size = *size;
1599 GST_DEBUG_OBJECT (trans,
1600 "caching %" G_GSIZE_FORMAT " in first cache", *size);
1601 } else if (trans->cache_caps2 == NULL) {
1602 gst_caps_replace (&trans->cache_caps2, caps);
1603 trans->cache_caps2_size = *size;
1604 GST_DEBUG_OBJECT (trans,
1605 "caching %" G_GSIZE_FORMAT " in second cache", *size);
1607 GST_DEBUG_OBJECT (trans, "no free spot to cache unit_size");
1614 gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
1617 GstBaseTransform *trans;
1618 GstBaseTransformClass *bclass;
1619 gboolean ret = TRUE;
1621 trans = GST_BASE_TRANSFORM (parent);
1622 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1624 if (bclass->sink_event)
1625 ret = bclass->sink_event (trans, event);
1627 gst_event_unref (event);
1633 gst_base_transform_sink_eventfunc (GstBaseTransform * trans, GstEvent * event)
1635 gboolean ret = TRUE, forward = TRUE;
1637 switch (GST_EVENT_TYPE (event)) {
1638 case GST_EVENT_FLUSH_START:
1640 case GST_EVENT_FLUSH_STOP:
1641 GST_OBJECT_LOCK (trans);
1642 /* reset QoS parameters */
1643 trans->priv->proportion = 1.0;
1644 trans->priv->earliest_time = -1;
1645 trans->priv->discont = FALSE;
1646 trans->priv->processed = 0;
1647 trans->priv->dropped = 0;
1648 GST_OBJECT_UNLOCK (trans);
1649 /* we need new segment info after the flush. */
1650 trans->have_segment = FALSE;
1651 gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
1652 trans->priv->position_out = GST_CLOCK_TIME_NONE;
1658 case GST_EVENT_CAPS:
1662 gst_event_parse_caps (event, &caps);
1663 ret = gst_base_transform_setcaps (trans, trans->sinkpad, caps);
1668 case GST_EVENT_SEGMENT:
1670 gst_event_copy_segment (event, &trans->segment);
1671 trans->have_segment = TRUE;
1673 GST_DEBUG_OBJECT (trans, "received SEGMENT %" GST_SEGMENT_FORMAT,
1682 ret = gst_pad_push_event (trans->srcpad, event);
1684 gst_event_unref (event);
1690 gst_base_transform_src_event (GstPad * pad, GstObject * parent,
1693 GstBaseTransform *trans;
1694 GstBaseTransformClass *bclass;
1695 gboolean ret = TRUE;
1697 trans = GST_BASE_TRANSFORM (parent);
1698 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1700 if (bclass->src_event)
1701 ret = bclass->src_event (trans, event);
1703 gst_event_unref (event);
1709 gst_base_transform_src_eventfunc (GstBaseTransform * trans, GstEvent * event)
1713 GST_DEBUG_OBJECT (trans, "handling event %p %" GST_PTR_FORMAT, event, event);
1715 switch (GST_EVENT_TYPE (event)) {
1716 case GST_EVENT_SEEK:
1718 case GST_EVENT_NAVIGATION:
1723 GstClockTimeDiff diff;
1724 GstClockTime timestamp;
1726 gst_event_parse_qos (event, NULL, &proportion, &diff, ×tamp);
1727 gst_base_transform_update_qos (trans, proportion, diff, timestamp);
1734 ret = gst_pad_push_event (trans->sinkpad, event);
1739 /* perform a transform on @inbuf and put the result in @outbuf.
1741 * This function is common to the push and pull-based operations.
1743 * This function takes ownership of @inbuf */
1744 static GstFlowReturn
1745 gst_base_transform_handle_buffer (GstBaseTransform * trans, GstBuffer * inbuf,
1746 GstBuffer ** outbuf)
1748 GstBaseTransformClass *bclass;
1749 GstFlowReturn ret = GST_FLOW_OK;
1750 gboolean want_in_place;
1751 GstClockTime running_time;
1752 GstClockTime timestamp;
1753 gboolean reconfigure;
1755 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1757 GST_OBJECT_LOCK (trans->sinkpad);
1758 reconfigure = GST_PAD_NEEDS_RECONFIGURE (trans->srcpad)
1759 || trans->priv->reconfigure;
1760 GST_OBJECT_FLAG_UNSET (trans->srcpad, GST_PAD_FLAG_NEED_RECONFIGURE);
1761 trans->priv->reconfigure = FALSE;
1762 GST_OBJECT_UNLOCK (trans->sinkpad);
1764 if (G_UNLIKELY (reconfigure)) {
1767 GST_DEBUG_OBJECT (trans, "we had a pending reconfigure");
1769 incaps = gst_pad_get_current_caps (trans->sinkpad);
1771 goto no_reconfigure;
1773 /* if we need to reconfigure we pretend new caps arrived. This
1774 * will reconfigure the transform with the new output format. */
1775 if (!gst_base_transform_setcaps (trans, trans->sinkpad, incaps)) {
1776 gst_caps_unref (incaps);
1777 goto not_negotiated;
1779 gst_caps_unref (incaps);
1783 if (GST_BUFFER_OFFSET_IS_VALID (inbuf))
1784 GST_DEBUG_OBJECT (trans,
1785 "handling buffer %p of size %" G_GSIZE_FORMAT " and offset %"
1786 G_GUINT64_FORMAT, inbuf, gst_buffer_get_size (inbuf),
1787 GST_BUFFER_OFFSET (inbuf));
1789 GST_DEBUG_OBJECT (trans,
1790 "handling buffer %p of size %" G_GSIZE_FORMAT " and offset NONE", inbuf,
1791 gst_buffer_get_size (inbuf));
1793 /* Don't allow buffer handling before negotiation, except in passthrough mode
1794 * or if the class doesn't implement a set_caps function (in which case it doesn't
1797 if (!trans->negotiated && !trans->passthrough && (bclass->set_caps != NULL))
1798 goto not_negotiated;
1800 /* Set discont flag so we can mark the outgoing buffer */
1801 if (GST_BUFFER_IS_DISCONT (inbuf)) {
1802 GST_DEBUG_OBJECT (trans, "got DISCONT buffer %p", inbuf);
1803 trans->priv->discont = TRUE;
1806 /* can only do QoS if the segment is in TIME */
1807 if (trans->segment.format != GST_FORMAT_TIME)
1810 /* QOS is done on the running time of the buffer, get it now */
1811 timestamp = GST_BUFFER_TIMESTAMP (inbuf);
1812 running_time = gst_segment_to_running_time (&trans->segment, GST_FORMAT_TIME,
1815 if (running_time != -1) {
1817 GstClockTime earliest_time;
1820 /* lock for getting the QoS parameters that are set (in a different thread)
1821 * with the QOS events */
1822 GST_OBJECT_LOCK (trans);
1823 earliest_time = trans->priv->earliest_time;
1824 proportion = trans->priv->proportion;
1825 /* check for QoS, don't perform conversion for buffers
1826 * that are known to be late. */
1827 need_skip = trans->priv->qos_enabled &&
1828 earliest_time != -1 && running_time <= earliest_time;
1829 GST_OBJECT_UNLOCK (trans);
1832 GstMessage *qos_msg;
1833 GstClockTime duration;
1834 guint64 stream_time;
1837 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "skipping transform: qostime %"
1838 GST_TIME_FORMAT " <= %" GST_TIME_FORMAT,
1839 GST_TIME_ARGS (running_time), GST_TIME_ARGS (earliest_time));
1841 trans->priv->dropped++;
1843 duration = GST_BUFFER_DURATION (inbuf);
1845 gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1847 jitter = GST_CLOCK_DIFF (running_time, earliest_time);
1850 gst_message_new_qos (GST_OBJECT_CAST (trans), FALSE, running_time,
1851 stream_time, timestamp, duration);
1852 gst_message_set_qos_values (qos_msg, jitter, proportion, 1000000);
1853 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS,
1854 trans->priv->processed, trans->priv->dropped);
1855 gst_element_post_message (GST_ELEMENT_CAST (trans), qos_msg);
1857 /* mark discont for next buffer */
1858 trans->priv->discont = TRUE;
1865 /* first try to allocate an output buffer based on the currently negotiated
1866 * format. outbuf will contain a buffer suitable for doing the configured
1867 * transform after this function. */
1868 if (bclass->prepare_output_buffer == NULL)
1871 GST_DEBUG_OBJECT (trans, "calling prepare buffer");
1872 ret = bclass->prepare_output_buffer (trans, inbuf, outbuf);
1874 if (ret != GST_FLOW_OK || *outbuf == NULL)
1877 GST_DEBUG_OBJECT (trans, "using allocated buffer in %p, out %p", inbuf,
1880 /* now perform the needed transform */
1881 if (trans->passthrough) {
1882 /* In passthrough mode, give transform_ip a look at the
1883 * buffer, without making it writable, or just push the
1885 if (bclass->transform_ip) {
1886 GST_DEBUG_OBJECT (trans, "doing passthrough transform");
1887 ret = bclass->transform_ip (trans, *outbuf);
1889 GST_DEBUG_OBJECT (trans, "element is in passthrough");
1892 want_in_place = (bclass->transform_ip != NULL) && trans->always_in_place;
1894 if (want_in_place) {
1895 GST_DEBUG_OBJECT (trans, "doing inplace transform");
1896 ret = bclass->transform_ip (trans, *outbuf);
1898 GST_DEBUG_OBJECT (trans, "doing non-inplace transform");
1900 if (bclass->transform)
1901 ret = bclass->transform (trans, inbuf, *outbuf);
1903 ret = GST_FLOW_NOT_SUPPORTED;
1908 /* only unref input buffer if we allocated a new outbuf buffer. If we reused
1909 * the input buffer, no refcount is changed to keep the input buffer writable
1911 if (*outbuf != inbuf)
1912 gst_buffer_unref (inbuf);
1919 gst_buffer_unref (inbuf);
1921 GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED,
1922 ("not negotiated"), ("not negotiated"));
1923 return GST_FLOW_NOT_NEGOTIATED;
1927 gst_buffer_unref (inbuf);
1928 GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED,
1929 ("Sub-class has no prepare_output_buffer implementation"), (NULL));
1930 return GST_FLOW_NOT_SUPPORTED;
1934 gst_buffer_unref (inbuf);
1936 GST_WARNING_OBJECT (trans, "could not get buffer from pool: %s",
1937 gst_flow_get_name (ret));
1942 /* FIXME, getrange is broken, need to pull range from the other
1943 * end based on the transform_size result.
1945 static GstFlowReturn
1946 gst_base_transform_getrange (GstPad * pad, GstObject * parent, guint64 offset,
1947 guint length, GstBuffer ** buffer)
1949 GstBaseTransform *trans;
1950 GstBaseTransformClass *klass;
1954 trans = GST_BASE_TRANSFORM (parent);
1956 ret = gst_pad_pull_range (trans->sinkpad, offset, length, &inbuf);
1957 if (G_UNLIKELY (ret != GST_FLOW_OK))
1960 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1961 if (klass->before_transform)
1962 klass->before_transform (trans, inbuf);
1964 ret = gst_base_transform_handle_buffer (trans, inbuf, buffer);
1972 GST_DEBUG_OBJECT (trans, "failed to pull a buffer: %s",
1973 gst_flow_get_name (ret));
1978 static GstFlowReturn
1979 gst_base_transform_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
1981 GstBaseTransform *trans;
1982 GstBaseTransformClass *klass;
1984 GstClockTime position = GST_CLOCK_TIME_NONE;
1985 GstClockTime timestamp, duration;
1986 GstBuffer *outbuf = NULL;
1988 trans = GST_BASE_TRANSFORM (parent);
1990 timestamp = GST_BUFFER_TIMESTAMP (buffer);
1991 duration = GST_BUFFER_DURATION (buffer);
1993 /* calculate end position of the incoming buffer */
1994 if (timestamp != GST_CLOCK_TIME_NONE) {
1995 if (duration != GST_CLOCK_TIME_NONE)
1996 position = timestamp + duration;
1998 position = timestamp;
2001 klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2002 if (klass->before_transform)
2003 klass->before_transform (trans, buffer);
2005 /* protect transform method and concurrent buffer alloc */
2006 ret = gst_base_transform_handle_buffer (trans, buffer, &outbuf);
2008 /* outbuf can be NULL, this means a dropped buffer, if we have a buffer but
2009 * GST_BASE_TRANSFORM_FLOW_DROPPED we will not push either. */
2010 if (outbuf != NULL) {
2011 if (ret == GST_FLOW_OK) {
2012 GstClockTime position_out = GST_CLOCK_TIME_NONE;
2014 /* Remember last stop position */
2015 if (position != GST_CLOCK_TIME_NONE &&
2016 trans->segment.format == GST_FORMAT_TIME)
2017 trans->segment.position = position;
2019 if (GST_BUFFER_TIMESTAMP_IS_VALID (outbuf)) {
2020 position_out = GST_BUFFER_TIMESTAMP (outbuf);
2021 if (GST_BUFFER_DURATION_IS_VALID (outbuf))
2022 position_out += GST_BUFFER_DURATION (outbuf);
2023 } else if (position != GST_CLOCK_TIME_NONE) {
2024 position_out = position;
2026 if (position_out != GST_CLOCK_TIME_NONE
2027 && trans->segment.format == GST_FORMAT_TIME)
2028 trans->priv->position_out = position_out;
2030 /* apply DISCONT flag if the buffer is not yet marked as such */
2031 if (trans->priv->discont) {
2032 GST_DEBUG_OBJECT (trans, "we have a pending DISCONT");
2033 if (!GST_BUFFER_IS_DISCONT (outbuf)) {
2034 GST_DEBUG_OBJECT (trans, "marking DISCONT on output buffer");
2035 outbuf = gst_buffer_make_writable (outbuf);
2036 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
2038 trans->priv->discont = FALSE;
2040 trans->priv->processed++;
2042 ret = gst_pad_push (trans->srcpad, outbuf);
2044 GST_DEBUG_OBJECT (trans, "we got return %s", gst_flow_get_name (ret));
2045 gst_buffer_unref (outbuf);
2049 /* convert internal flow to OK and mark discont for the next buffer. */
2050 if (ret == GST_BASE_TRANSFORM_FLOW_DROPPED) {
2051 GST_DEBUG_OBJECT (trans, "dropped a buffer, marking DISCONT");
2052 trans->priv->discont = TRUE;
2060 gst_base_transform_set_property (GObject * object, guint prop_id,
2061 const GValue * value, GParamSpec * pspec)
2063 GstBaseTransform *trans;
2065 trans = GST_BASE_TRANSFORM (object);
2069 gst_base_transform_set_qos_enabled (trans, g_value_get_boolean (value));
2072 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2078 gst_base_transform_get_property (GObject * object, guint prop_id,
2079 GValue * value, GParamSpec * pspec)
2081 GstBaseTransform *trans;
2083 trans = GST_BASE_TRANSFORM (object);
2087 g_value_set_boolean (value, gst_base_transform_is_qos_enabled (trans));
2090 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2095 /* not a vmethod of anything, just an internal method */
2097 gst_base_transform_activate (GstBaseTransform * trans, gboolean active)
2099 GstBaseTransformClass *bclass;
2100 gboolean result = TRUE;
2102 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2105 GstCaps *incaps, *outcaps;
2107 if (trans->priv->pad_mode == GST_PAD_MODE_NONE && bclass->start)
2108 result &= bclass->start (trans);
2110 incaps = gst_pad_get_current_caps (trans->sinkpad);
2111 outcaps = gst_pad_get_current_caps (trans->srcpad);
2113 GST_OBJECT_LOCK (trans);
2114 if (incaps && outcaps)
2115 trans->have_same_caps =
2116 gst_caps_is_equal (incaps, outcaps) || trans->passthrough;
2118 trans->have_same_caps = trans->passthrough;
2119 GST_DEBUG_OBJECT (trans, "have_same_caps %d", trans->have_same_caps);
2120 trans->negotiated = FALSE;
2121 trans->have_segment = FALSE;
2122 gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
2123 trans->priv->position_out = GST_CLOCK_TIME_NONE;
2124 trans->priv->proportion = 1.0;
2125 trans->priv->earliest_time = -1;
2126 trans->priv->discont = FALSE;
2127 trans->priv->processed = 0;
2128 trans->priv->dropped = 0;
2129 GST_OBJECT_UNLOCK (trans);
2132 gst_caps_unref (incaps);
2134 gst_caps_unref (outcaps);
2136 /* We must make sure streaming has finished before resetting things
2137 * and calling the ::stop vfunc */
2138 GST_PAD_STREAM_LOCK (trans->sinkpad);
2139 GST_PAD_STREAM_UNLOCK (trans->sinkpad);
2141 trans->have_same_caps = FALSE;
2142 /* We can only reset the passthrough mode if the instance told us to
2143 handle it in configure_caps */
2144 if (bclass->passthrough_on_same_caps) {
2145 gst_base_transform_set_passthrough (trans, FALSE);
2147 gst_caps_replace (&trans->cache_caps1, NULL);
2148 gst_caps_replace (&trans->cache_caps2, NULL);
2150 if (trans->priv->pad_mode != GST_PAD_MODE_NONE && bclass->stop)
2151 result &= bclass->stop (trans);
2153 gst_base_transform_set_allocation (trans, NULL, NULL, 0, 0, NULL);
2160 gst_base_transform_sink_activate_mode (GstPad * pad, GstObject * parent,
2161 GstPadMode mode, gboolean active)
2163 gboolean result = FALSE;
2164 GstBaseTransform *trans;
2166 trans = GST_BASE_TRANSFORM (parent);
2169 case GST_PAD_MODE_PUSH:
2171 result = gst_base_transform_activate (trans, active);
2174 trans->priv->pad_mode = active ? GST_PAD_MODE_PUSH : GST_PAD_MODE_NONE;
2186 gst_base_transform_src_activate_mode (GstPad * pad, GstObject * parent,
2187 GstPadMode mode, gboolean active)
2189 gboolean result = FALSE;
2190 GstBaseTransform *trans;
2192 trans = GST_BASE_TRANSFORM (parent);
2195 case GST_PAD_MODE_PULL:
2198 gst_pad_activate_mode (trans->sinkpad, GST_PAD_MODE_PULL, active);
2201 result &= gst_base_transform_activate (trans, active);
2204 trans->priv->pad_mode = active ? mode : GST_PAD_MODE_NONE;
2216 * gst_base_transform_set_passthrough:
2217 * @trans: the #GstBaseTransform to set
2218 * @passthrough: boolean indicating passthrough mode.
2220 * Set passthrough mode for this filter by default. This is mostly
2221 * useful for filters that do not care about negotiation.
2223 * Always TRUE for filters which don't implement either a transform
2224 * or transform_ip method.
2229 gst_base_transform_set_passthrough (GstBaseTransform * trans,
2230 gboolean passthrough)
2232 GstBaseTransformClass *bclass;
2234 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2236 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2238 GST_OBJECT_LOCK (trans);
2239 if (passthrough == FALSE) {
2240 if (bclass->transform_ip || bclass->transform)
2241 trans->passthrough = FALSE;
2243 trans->passthrough = TRUE;
2246 GST_DEBUG_OBJECT (trans, "set passthrough %d", trans->passthrough);
2247 GST_OBJECT_UNLOCK (trans);
2251 * gst_base_transform_is_passthrough:
2252 * @trans: the #GstBaseTransform to query
2254 * See if @trans is configured as a passthrough transform.
2256 * Returns: TRUE is the transform is configured in passthrough mode.
2261 gst_base_transform_is_passthrough (GstBaseTransform * trans)
2265 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2267 GST_OBJECT_LOCK (trans);
2268 result = trans->passthrough;
2269 GST_OBJECT_UNLOCK (trans);
2275 * gst_base_transform_set_in_place:
2276 * @trans: the #GstBaseTransform to modify
2277 * @in_place: Boolean value indicating that we would like to operate
2278 * on in_place buffers.
2280 * Determines whether a non-writable buffer will be copied before passing
2281 * to the transform_ip function.
2283 * <listitem>Always TRUE if no transform function is implemented.</listitem>
2284 * <listitem>Always FALSE if ONLY transform function is implemented.</listitem>
2290 gst_base_transform_set_in_place (GstBaseTransform * trans, gboolean in_place)
2292 GstBaseTransformClass *bclass;
2294 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2296 bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2298 GST_OBJECT_LOCK (trans);
2301 if (bclass->transform_ip) {
2302 GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
2303 trans->always_in_place = TRUE;
2306 if (bclass->transform) {
2307 GST_DEBUG_OBJECT (trans, "setting in_place FALSE");
2308 trans->always_in_place = FALSE;
2312 GST_OBJECT_UNLOCK (trans);
2316 * gst_base_transform_is_in_place:
2317 * @trans: the #GstBaseTransform to query
2319 * See if @trans is configured as a in_place transform.
2321 * Returns: TRUE is the transform is configured in in_place mode.
2326 gst_base_transform_is_in_place (GstBaseTransform * trans)
2330 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2332 GST_OBJECT_LOCK (trans);
2333 result = trans->always_in_place;
2334 GST_OBJECT_UNLOCK (trans);
2340 * gst_base_transform_update_qos:
2341 * @trans: a #GstBaseTransform
2342 * @proportion: the proportion
2343 * @diff: the diff against the clock
2344 * @timestamp: the timestamp of the buffer generating the QoS expressed in
2347 * Set the QoS parameters in the transform. This function is called internally
2348 * when a QOS event is received but subclasses can provide custom information
2356 gst_base_transform_update_qos (GstBaseTransform * trans,
2357 gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp)
2360 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2362 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans,
2363 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2364 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (timestamp));
2366 GST_OBJECT_LOCK (trans);
2367 trans->priv->proportion = proportion;
2368 trans->priv->earliest_time = timestamp + diff;
2369 GST_OBJECT_UNLOCK (trans);
2373 * gst_base_transform_set_qos_enabled:
2374 * @trans: a #GstBaseTransform
2375 * @enabled: new state
2377 * Enable or disable QoS handling in the transform.
2384 gst_base_transform_set_qos_enabled (GstBaseTransform * trans, gboolean enabled)
2386 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2388 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "enabled: %d", enabled);
2390 GST_OBJECT_LOCK (trans);
2391 trans->priv->qos_enabled = enabled;
2392 GST_OBJECT_UNLOCK (trans);
2396 * gst_base_transform_is_qos_enabled:
2397 * @trans: a #GstBaseTransform
2399 * Queries if the transform will handle QoS.
2401 * Returns: TRUE if QoS is enabled.
2408 gst_base_transform_is_qos_enabled (GstBaseTransform * trans)
2412 g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2414 GST_OBJECT_LOCK (trans);
2415 result = trans->priv->qos_enabled;
2416 GST_OBJECT_UNLOCK (trans);
2422 * gst_base_transform_set_gap_aware:
2423 * @trans: a #GstBaseTransform
2424 * @gap_aware: New state
2426 * If @gap_aware is %FALSE (the default), output buffers will have the
2427 * %GST_BUFFER_FLAG_GAP flag unset.
2429 * If set to %TRUE, the element must handle output buffers with this flag set
2430 * correctly, i.e. it can assume that the buffer contains neutral data but must
2431 * unset the flag if the output is no neutral data.
2438 gst_base_transform_set_gap_aware (GstBaseTransform * trans, gboolean gap_aware)
2440 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2442 GST_OBJECT_LOCK (trans);
2443 trans->priv->gap_aware = gap_aware;
2444 GST_DEBUG_OBJECT (trans, "set gap aware %d", trans->priv->gap_aware);
2445 GST_OBJECT_UNLOCK (trans);
2449 * gst_base_transform_reconfigure_sink:
2450 * @trans: a #GstBaseTransform
2452 * Instructs @trans to request renegotiation upstream. This function is
2453 * typically called after properties on the transform were set that
2454 * influence the input format.
2457 gst_base_transform_reconfigure_sink (GstBaseTransform * trans)
2459 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2461 /* push the renegotiate event */
2462 if (!gst_pad_push_event (GST_BASE_TRANSFORM_SINK_PAD (trans),
2463 gst_event_new_reconfigure ()))
2464 GST_DEBUG_OBJECT (trans, "Renegotiate event wasn't handled");
2468 * gst_base_transform_reconfigure_src:
2469 * @trans: a #GstBaseTransform
2471 * Instructs @trans to renegotiate a new downstream transform on the next
2472 * buffer. This function is typically called after properties on the transform
2473 * were set that influence the output format.
2478 gst_base_transform_reconfigure_src (GstBaseTransform * trans)
2480 g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2482 GST_OBJECT_LOCK (trans);
2483 GST_DEBUG_OBJECT (trans, "marking reconfigure");
2484 trans->priv->reconfigure = TRUE;
2485 GST_OBJECT_UNLOCK (trans);