1a4ac857fed97b081c110913f5b698506583f630
[platform/upstream/gstreamer.git] / libs / gst / base / gstbasetransform.c
1 /* GStreamer
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>
7  *
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.
12  *
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.
17  *
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., 51 Franklin St, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 /**
25  * SECTION:gstbasetransform
26  * @short_description: Base class for simple transform filters
27  * @see_also: #GstBaseSrc, #GstBaseSink
28  *
29  * This base class is for filter elements that process data. Elements
30  * that are suitable for implementation using #GstBaseTransform are ones
31  * where the size and caps of the output is known entirely from the input
32  * caps and buffer sizes. These include elements that directly transform
33  * one buffer into another, modify the contents of a buffer in-place, as
34  * well as elements that collate multiple input buffers into one output buffer,
35  * or that expand one input buffer into multiple output buffers. See below
36  * for more concrete use cases.
37  *
38  * It provides for:
39  * <itemizedlist>
40  *   <listitem><para>one sinkpad and one srcpad</para></listitem>
41  *   <listitem><para>
42  *      Possible formats on sink and source pad implemented
43  *      with custom transform_caps function. By default uses
44  *      same format on sink and source.
45  *   </para></listitem>
46  *   <listitem><para>Handles state changes</para></listitem>
47  *   <listitem><para>Does flushing</para></listitem>
48  *   <listitem><para>Push mode</para></listitem>
49  *   <listitem><para>
50  *       Pull mode if the sub-class transform can operate on arbitrary data
51  *    </para></listitem>
52  * </itemizedlist>
53  *
54  * <refsect2>
55  * <title>Use Cases</title>
56  * <para>
57  * <orderedlist>
58  * <listitem>
59  *   <itemizedlist><title>Passthrough mode</title>
60  *   <listitem><para>
61  *     Element has no interest in modifying the buffer. It may want to inspect it,
62  *     in which case the element should have a transform_ip function. If there
63  *     is no transform_ip function in passthrough mode, the buffer is pushed
64  *     intact.
65  *   </para></listitem>
66  *   <listitem><para>
67  *     The #GstBaseTransformClass.passthrough_on_same_caps variable
68  *     will automatically set/unset passthrough based on whether the
69  *     element negotiates the same caps on both pads.
70  *   </para></listitem>
71  *   <listitem><para>
72  *     #GstBaseTransformClass.passthrough_on_same_caps on an element that
73  *     doesn't implement a transform_caps function is useful for elements that
74  *     only inspect data (such as level)
75  *   </para></listitem>
76  *   </itemizedlist>
77  *   <itemizedlist>
78  *   <title>Example elements</title>
79  *     <listitem>Level</listitem>
80  *     <listitem>Videoscale, audioconvert, videoconvert, audioresample in
81  *     certain modes.</listitem>
82  *   </itemizedlist>
83  * </listitem>
84  * <listitem>
85  *   <itemizedlist>
86  *     <title>Modifications in-place - input buffer and output buffer are the
87  *     same thing.</title>
88  *   <listitem><para>
89  *     The element must implement a transform_ip function.
90  *   </para></listitem>
91  *   <listitem><para>
92  *     Output buffer size must <= input buffer size
93  *   </para></listitem>
94  *   <listitem><para>
95  *     If the always_in_place flag is set, non-writable buffers will be copied
96  *     and passed to the transform_ip function, otherwise a new buffer will be
97  *     created and the transform function called.
98  *   </para></listitem>
99  *   <listitem><para>
100  *     Incoming writable buffers will be passed to the transform_ip function
101  *     immediately.  </para></listitem>
102  *   <listitem><para>
103  *     only implementing transform_ip and not transform implies always_in_place
104  *     = %TRUE
105  *   </para></listitem>
106  *   </itemizedlist>
107  *   <itemizedlist>
108  *   <title>Example elements</title>
109  *     <listitem>Volume</listitem>
110  *     <listitem>Audioconvert in certain modes (signed/unsigned
111  *     conversion)</listitem>
112  *     <listitem>videoconvert in certain modes (endianness
113  *     swapping)</listitem>
114  *   </itemizedlist>
115  *  </listitem>
116  * <listitem>
117  *   <itemizedlist>
118  *   <title>Modifications only to the caps/metadata of a buffer</title>
119  *   <listitem><para>
120  *     The element does not require writable data, but non-writable buffers
121  *     should be subbuffered so that the meta-information can be replaced.
122  *   </para></listitem>
123  *   <listitem><para>
124  *     Elements wishing to operate in this mode should replace the
125  *     prepare_output_buffer method to create subbuffers of the input buffer
126  *     and set always_in_place to %TRUE
127  *   </para></listitem>
128  *   </itemizedlist>
129  *   <itemizedlist>
130  *   <title>Example elements</title>
131  *     <listitem>Capsfilter when setting caps on outgoing buffers that have
132  *     none.</listitem>
133  *     <listitem>identity when it is going to re-timestamp buffers by
134  *     datarate.</listitem>
135  *   </itemizedlist>
136  * </listitem>
137  * <listitem>
138  *   <itemizedlist><title>Normal mode</title>
139  *   <listitem><para>
140  *     always_in_place flag is not set, or there is no transform_ip function
141  *   </para></listitem>
142  *   <listitem><para>
143  *     Element will receive an input buffer and output buffer to operate on.
144  *   </para></listitem>
145  *   <listitem><para>
146  *     Output buffer is allocated by calling the prepare_output_buffer function.
147  *   </para></listitem>
148  *   </itemizedlist>
149  *   <itemizedlist>
150  *   <title>Example elements</title>
151  *     <listitem>Videoscale, videoconvert, audioconvert when doing
152  *     scaling/conversions</listitem>
153  *   </itemizedlist>
154  * </listitem>
155  * <listitem>
156  *   <itemizedlist><title>Special output buffer allocations</title>
157  *   <listitem><para>
158  *     Elements which need to do special allocation of their output buffers
159  *     beyond allocating output buffers via the negotiated allocator or
160  *     buffer pool should implement the prepare_output_buffer method.
161  *   </para></listitem>
162  *   </itemizedlist>
163  *   <itemizedlist>
164  *   <title>Example elements</title>
165  *     <listitem>efence</listitem>
166  *   </itemizedlist>
167  * </listitem>
168  * </orderedlist>
169  * </para>
170  * </refsect2>
171  * <refsect2>
172  * <title>Sub-class settable flags on GstBaseTransform</title>
173  * <para>
174  * <itemizedlist>
175  * <listitem><para>
176  *   <itemizedlist><title>passthrough</title>
177  *     <listitem><para>
178  *       Implies that in the current configuration, the sub-class is not
179  *       interested in modifying the buffers.
180  *     </para></listitem>
181  *     <listitem><para>
182  *       Elements which are always in passthrough mode whenever the same caps
183  *       has been negotiated on both pads can set the class variable
184  *       passthrough_on_same_caps to have this behaviour automatically.
185  *     </para></listitem>
186  *   </itemizedlist>
187  * </para></listitem>
188  * <listitem><para>
189  *   <itemizedlist><title>always_in_place</title>
190  *     <listitem><para>
191  *       Determines whether a non-writable buffer will be copied before passing
192  *       to the transform_ip function.
193  *     </para></listitem>
194  *     <listitem><para>
195  *       Implied %TRUE if no transform function is implemented.
196  *     </para></listitem>
197  *     <listitem><para>
198  *       Implied %FALSE if ONLY transform function is implemented.
199  *     </para></listitem>
200  *   </itemizedlist>
201  * </para></listitem>
202  * </itemizedlist>
203  * </para>
204  * </refsect2>
205  */
206
207 #ifdef HAVE_CONFIG_H
208 #  include "config.h"
209 #endif
210
211 #include <stdlib.h>
212 #include <string.h>
213
214 #include "../../../gst/gst_private.h"
215 #include "../../../gst/gst-i18n-lib.h"
216 #include "../../../gst/glib-compat-private.h"
217 #include "gstbasetransform.h"
218
219 GST_DEBUG_CATEGORY_STATIC (gst_base_transform_debug);
220 #define GST_CAT_DEFAULT gst_base_transform_debug
221
222 /* BaseTransform signals and args */
223 enum
224 {
225   /* FILL ME */
226   LAST_SIGNAL
227 };
228
229 #define DEFAULT_PROP_QOS        FALSE
230
231 enum
232 {
233   PROP_0,
234   PROP_QOS
235 };
236
237 #define GST_BASE_TRANSFORM_GET_PRIVATE(obj)  \
238     (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_TRANSFORM, GstBaseTransformPrivate))
239
240 struct _GstBaseTransformPrivate
241 {
242   /* Set by sub-class */
243   gboolean passthrough;
244   gboolean always_in_place;
245
246   GstCaps *cache_caps1;
247   gsize cache_caps1_size;
248   GstCaps *cache_caps2;
249   gsize cache_caps2_size;
250   gboolean have_same_caps;
251
252   gboolean negotiated;
253
254   /* QoS *//* with LOCK */
255   gboolean qos_enabled;
256   gdouble proportion;
257   GstClockTime earliest_time;
258   /* previous buffer had a discont */
259   gboolean discont;
260
261   GstPadMode pad_mode;
262
263   gboolean gap_aware;
264   gboolean prefer_passthrough;
265
266   /* QoS stats */
267   guint64 processed;
268   guint64 dropped;
269
270   GstClockTime position_out;
271
272   GstBufferPool *pool;
273   gboolean pool_active;
274   GstAllocator *allocator;
275   GstAllocationParams params;
276   GstQuery *query;
277 };
278
279
280 static GstElementClass *parent_class = NULL;
281
282 static void gst_base_transform_class_init (GstBaseTransformClass * klass);
283 static void gst_base_transform_init (GstBaseTransform * trans,
284     GstBaseTransformClass * klass);
285 static GstFlowReturn default_submit_input_buffer (GstBaseTransform * trans,
286     gboolean is_discont, GstBuffer * input);
287 static GstFlowReturn default_generate_output (GstBaseTransform * trans,
288     GstBuffer ** outbuf);
289
290 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
291  * method to get to the padtemplates */
292 GType
293 gst_base_transform_get_type (void)
294 {
295   static volatile gsize base_transform_type = 0;
296
297   if (g_once_init_enter (&base_transform_type)) {
298     GType _type;
299     static const GTypeInfo base_transform_info = {
300       sizeof (GstBaseTransformClass),
301       NULL,
302       NULL,
303       (GClassInitFunc) gst_base_transform_class_init,
304       NULL,
305       NULL,
306       sizeof (GstBaseTransform),
307       0,
308       (GInstanceInitFunc) gst_base_transform_init,
309     };
310
311     _type = g_type_register_static (GST_TYPE_ELEMENT,
312         "GstBaseTransform", &base_transform_info, G_TYPE_FLAG_ABSTRACT);
313     g_once_init_leave (&base_transform_type, _type);
314   }
315   return base_transform_type;
316 }
317
318 static void gst_base_transform_finalize (GObject * object);
319 static void gst_base_transform_set_property (GObject * object, guint prop_id,
320     const GValue * value, GParamSpec * pspec);
321 static void gst_base_transform_get_property (GObject * object, guint prop_id,
322     GValue * value, GParamSpec * pspec);
323 static gboolean gst_base_transform_src_activate_mode (GstPad * pad,
324     GstObject * parent, GstPadMode mode, gboolean active);
325 static gboolean gst_base_transform_sink_activate_mode (GstPad * pad,
326     GstObject * parent, GstPadMode mode, gboolean active);
327 static gboolean gst_base_transform_activate (GstBaseTransform * trans,
328     gboolean active);
329 static gboolean gst_base_transform_get_unit_size (GstBaseTransform * trans,
330     GstCaps * caps, gsize * size);
331
332 static gboolean gst_base_transform_src_event (GstPad * pad, GstObject * parent,
333     GstEvent * event);
334 static gboolean gst_base_transform_src_eventfunc (GstBaseTransform * trans,
335     GstEvent * event);
336 static gboolean gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
337     GstEvent * event);
338 static gboolean gst_base_transform_sink_eventfunc (GstBaseTransform * trans,
339     GstEvent * event);
340 static GstFlowReturn gst_base_transform_getrange (GstPad * pad,
341     GstObject * parent, guint64 offset, guint length, GstBuffer ** buffer);
342 static GstFlowReturn gst_base_transform_chain (GstPad * pad, GstObject * parent,
343     GstBuffer * buffer);
344 static GstCaps *gst_base_transform_default_transform_caps (GstBaseTransform *
345     trans, GstPadDirection direction, GstCaps * caps, GstCaps * filter);
346 static GstCaps *gst_base_transform_default_fixate_caps (GstBaseTransform *
347     trans, GstPadDirection direction, GstCaps * caps, GstCaps * othercaps);
348 static GstCaps *gst_base_transform_query_caps (GstBaseTransform * trans,
349     GstPad * pad, GstCaps * filter);
350 static gboolean gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
351     GstPadDirection direction, GstCaps * caps);
352 static gboolean gst_base_transform_setcaps (GstBaseTransform * trans,
353     GstPad * pad, GstCaps * caps);
354 static gboolean gst_base_transform_default_decide_allocation (GstBaseTransform
355     * trans, GstQuery * query);
356 static gboolean gst_base_transform_default_propose_allocation (GstBaseTransform
357     * trans, GstQuery * decide_query, GstQuery * query);
358 static gboolean gst_base_transform_query (GstPad * pad, GstObject * parent,
359     GstQuery * query);
360 static gboolean gst_base_transform_default_query (GstBaseTransform * trans,
361     GstPadDirection direction, GstQuery * query);
362 static gboolean gst_base_transform_default_transform_size (GstBaseTransform *
363     trans, GstPadDirection direction, GstCaps * caps, gsize size,
364     GstCaps * othercaps, gsize * othersize);
365
366 static GstFlowReturn default_prepare_output_buffer (GstBaseTransform * trans,
367     GstBuffer * inbuf, GstBuffer ** outbuf);
368 static gboolean default_copy_metadata (GstBaseTransform * trans,
369     GstBuffer * inbuf, GstBuffer * outbuf);
370 static gboolean
371 gst_base_transform_default_transform_meta (GstBaseTransform * trans,
372     GstBuffer * inbuf, GstMeta * meta, GstBuffer * outbuf);
373
374 /* static guint gst_base_transform_signals[LAST_SIGNAL] = { 0 }; */
375
376
377 static void
378 gst_base_transform_finalize (GObject * object)
379 {
380   G_OBJECT_CLASS (parent_class)->finalize (object);
381 }
382
383 static void
384 gst_base_transform_class_init (GstBaseTransformClass * klass)
385 {
386   GObjectClass *gobject_class;
387
388   gobject_class = G_OBJECT_CLASS (klass);
389
390   GST_DEBUG_CATEGORY_INIT (gst_base_transform_debug, "basetransform", 0,
391       "basetransform element");
392
393   GST_DEBUG ("gst_base_transform_class_init");
394
395   g_type_class_add_private (klass, sizeof (GstBaseTransformPrivate));
396
397   parent_class = g_type_class_peek_parent (klass);
398
399   gobject_class->set_property = gst_base_transform_set_property;
400   gobject_class->get_property = gst_base_transform_get_property;
401
402   g_object_class_install_property (gobject_class, PROP_QOS,
403       g_param_spec_boolean ("qos", "QoS", "Handle Quality-of-Service events",
404           DEFAULT_PROP_QOS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
405
406   gobject_class->finalize = gst_base_transform_finalize;
407
408   klass->passthrough_on_same_caps = FALSE;
409   klass->transform_ip_on_passthrough = TRUE;
410
411   klass->transform_caps =
412       GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_caps);
413   klass->fixate_caps =
414       GST_DEBUG_FUNCPTR (gst_base_transform_default_fixate_caps);
415   klass->accept_caps =
416       GST_DEBUG_FUNCPTR (gst_base_transform_acceptcaps_default);
417   klass->query = GST_DEBUG_FUNCPTR (gst_base_transform_default_query);
418   klass->decide_allocation =
419       GST_DEBUG_FUNCPTR (gst_base_transform_default_decide_allocation);
420   klass->propose_allocation =
421       GST_DEBUG_FUNCPTR (gst_base_transform_default_propose_allocation);
422   klass->transform_size =
423       GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_size);
424   klass->transform_meta =
425       GST_DEBUG_FUNCPTR (gst_base_transform_default_transform_meta);
426
427   klass->sink_event = GST_DEBUG_FUNCPTR (gst_base_transform_sink_eventfunc);
428   klass->src_event = GST_DEBUG_FUNCPTR (gst_base_transform_src_eventfunc);
429   klass->prepare_output_buffer =
430       GST_DEBUG_FUNCPTR (default_prepare_output_buffer);
431   klass->copy_metadata = GST_DEBUG_FUNCPTR (default_copy_metadata);
432   klass->submit_input_buffer = GST_DEBUG_FUNCPTR (default_submit_input_buffer);
433   klass->generate_output = GST_DEBUG_FUNCPTR (default_generate_output);
434 }
435
436 static void
437 gst_base_transform_init (GstBaseTransform * trans,
438     GstBaseTransformClass * bclass)
439 {
440   GstPadTemplate *pad_template;
441   GstBaseTransformPrivate *priv;
442
443   GST_DEBUG ("gst_base_transform_init");
444
445   priv = trans->priv = GST_BASE_TRANSFORM_GET_PRIVATE (trans);
446
447   pad_template =
448       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
449   g_return_if_fail (pad_template != NULL);
450   trans->sinkpad = gst_pad_new_from_template (pad_template, "sink");
451   gst_pad_set_event_function (trans->sinkpad,
452       GST_DEBUG_FUNCPTR (gst_base_transform_sink_event));
453   gst_pad_set_chain_function (trans->sinkpad,
454       GST_DEBUG_FUNCPTR (gst_base_transform_chain));
455   gst_pad_set_activatemode_function (trans->sinkpad,
456       GST_DEBUG_FUNCPTR (gst_base_transform_sink_activate_mode));
457   gst_pad_set_query_function (trans->sinkpad,
458       GST_DEBUG_FUNCPTR (gst_base_transform_query));
459   gst_element_add_pad (GST_ELEMENT (trans), trans->sinkpad);
460
461   pad_template =
462       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
463   g_return_if_fail (pad_template != NULL);
464   trans->srcpad = gst_pad_new_from_template (pad_template, "src");
465   gst_pad_set_event_function (trans->srcpad,
466       GST_DEBUG_FUNCPTR (gst_base_transform_src_event));
467   gst_pad_set_getrange_function (trans->srcpad,
468       GST_DEBUG_FUNCPTR (gst_base_transform_getrange));
469   gst_pad_set_activatemode_function (trans->srcpad,
470       GST_DEBUG_FUNCPTR (gst_base_transform_src_activate_mode));
471   gst_pad_set_query_function (trans->srcpad,
472       GST_DEBUG_FUNCPTR (gst_base_transform_query));
473   gst_element_add_pad (GST_ELEMENT (trans), trans->srcpad);
474
475   priv->qos_enabled = DEFAULT_PROP_QOS;
476   priv->cache_caps1 = NULL;
477   priv->cache_caps2 = NULL;
478   priv->pad_mode = GST_PAD_MODE_NONE;
479   priv->gap_aware = FALSE;
480   priv->prefer_passthrough = TRUE;
481
482   priv->passthrough = FALSE;
483   if (bclass->transform == NULL) {
484     /* If no transform function, always_in_place is TRUE */
485     GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
486     priv->always_in_place = TRUE;
487
488     if (bclass->transform_ip == NULL) {
489       GST_DEBUG_OBJECT (trans, "setting passthrough TRUE");
490       priv->passthrough = TRUE;
491     }
492   }
493
494   priv->processed = 0;
495   priv->dropped = 0;
496 }
497
498 static GstCaps *
499 gst_base_transform_default_transform_caps (GstBaseTransform * trans,
500     GstPadDirection direction, GstCaps * caps, GstCaps * filter)
501 {
502   GstCaps *ret;
503
504   GST_DEBUG_OBJECT (trans, "identity from: %" GST_PTR_FORMAT, caps);
505   /* no transform function, use the identity transform */
506   if (filter) {
507     ret = gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
508   } else {
509     ret = gst_caps_ref (caps);
510   }
511   return ret;
512 }
513
514 /* given @caps on the src or sink pad (given by @direction)
515  * calculate the possible caps on the other pad.
516  *
517  * Returns new caps, unref after usage.
518  */
519 static GstCaps *
520 gst_base_transform_transform_caps (GstBaseTransform * trans,
521     GstPadDirection direction, GstCaps * caps, GstCaps * filter)
522 {
523   GstCaps *ret = NULL;
524   GstBaseTransformClass *klass;
525
526   if (caps == NULL)
527     return NULL;
528
529   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
530
531   /* if there is a custom transform function, use this */
532   if (klass->transform_caps) {
533     GST_DEBUG_OBJECT (trans, "transform caps (direction = %d)", direction);
534
535     GST_LOG_OBJECT (trans, "from: %" GST_PTR_FORMAT, caps);
536     ret = klass->transform_caps (trans, direction, caps, filter);
537     GST_LOG_OBJECT (trans, "  to: %" GST_PTR_FORMAT, ret);
538
539 #ifdef GST_ENABLE_EXTRA_CHECKS
540     if (filter) {
541       if (!gst_caps_is_subset (ret, filter)) {
542         GstCaps *intersection;
543
544         GST_ERROR_OBJECT (trans,
545             "transform_caps returned caps %" GST_PTR_FORMAT
546             " which are not a real subset of the filter caps %"
547             GST_PTR_FORMAT, ret, filter);
548         g_warning ("%s: transform_caps returned caps which are not a real "
549             "subset of the filter caps", GST_ELEMENT_NAME (trans));
550
551         intersection =
552             gst_caps_intersect_full (filter, ret, GST_CAPS_INTERSECT_FIRST);
553         gst_caps_unref (ret);
554         ret = intersection;
555       }
556     }
557 #endif
558   }
559
560   GST_DEBUG_OBJECT (trans, "to: %" GST_PTR_FORMAT, ret);
561
562   return ret;
563 }
564
565 static gboolean
566 gst_base_transform_default_transform_meta (GstBaseTransform * trans,
567     GstBuffer * inbuf, GstMeta * meta, GstBuffer * outbuf)
568 {
569   const GstMetaInfo *info = meta->info;
570   const gchar *const *tags;
571
572   tags = gst_meta_api_type_get_tags (info->api);
573
574   if (!tags)
575     return TRUE;
576
577   return FALSE;
578 }
579
580 static gboolean
581 gst_base_transform_default_transform_size (GstBaseTransform * trans,
582     GstPadDirection direction, GstCaps * caps, gsize size,
583     GstCaps * othercaps, gsize * othersize)
584 {
585   gsize inunitsize, outunitsize, units;
586   GstBaseTransformClass *klass;
587
588   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
589
590   if (klass->get_unit_size == NULL) {
591     /* if there is no transform_size and no unit_size, it means the
592      * element does not modify the size of a buffer */
593     *othersize = size;
594   } else {
595     /* there is no transform_size function, we have to use the unit_size
596      * functions. This method assumes there is a fixed unit_size associated with
597      * each caps. We provide the same amount of units on both sides. */
598     if (!gst_base_transform_get_unit_size (trans, caps, &inunitsize))
599       goto no_in_size;
600
601     GST_DEBUG_OBJECT (trans,
602         "input size %" G_GSIZE_FORMAT ", input unit size %" G_GSIZE_FORMAT,
603         size, inunitsize);
604
605     /* input size must be a multiple of the unit_size of the input caps */
606     if (inunitsize == 0 || (size % inunitsize != 0))
607       goto no_multiple;
608
609     /* get the amount of units */
610     units = size / inunitsize;
611
612     /* now get the unit size of the output */
613     if (!gst_base_transform_get_unit_size (trans, othercaps, &outunitsize))
614       goto no_out_size;
615
616     /* the output size is the unit_size times the amount of units on the
617      * input */
618     *othersize = units * outunitsize;
619     GST_DEBUG_OBJECT (trans, "transformed size to %" G_GSIZE_FORMAT,
620         *othersize);
621   }
622   return TRUE;
623
624   /* ERRORS */
625 no_in_size:
626   {
627     GST_DEBUG_OBJECT (trans, "could not get in_size");
628     g_warning ("%s: could not get in_size", GST_ELEMENT_NAME (trans));
629     return FALSE;
630   }
631 no_multiple:
632   {
633     GST_DEBUG_OBJECT (trans, "Size %" G_GSIZE_FORMAT " is not a multiple of"
634         "unit size %" G_GSIZE_FORMAT, size, inunitsize);
635     g_warning ("%s: size %" G_GSIZE_FORMAT " is not a multiple of unit size %"
636         G_GSIZE_FORMAT, GST_ELEMENT_NAME (trans), size, inunitsize);
637     return FALSE;
638   }
639 no_out_size:
640   {
641     GST_DEBUG_OBJECT (trans, "could not get out_size");
642     g_warning ("%s: could not get out_size", GST_ELEMENT_NAME (trans));
643     return FALSE;
644   }
645 }
646
647 /* transform a buffer of @size with @caps on the pad with @direction to
648  * the size of a buffer with @othercaps and store the result in @othersize
649  *
650  * We have two ways of doing this:
651  *  1) use a custom transform size function, this is for complicated custom
652  *     cases with no fixed unit_size.
653  *  2) use the unit_size functions where there is a relationship between the
654  *     caps and the size of a buffer.
655  */
656 static gboolean
657 gst_base_transform_transform_size (GstBaseTransform * trans,
658     GstPadDirection direction, GstCaps * caps,
659     gsize size, GstCaps * othercaps, gsize * othersize)
660 {
661   GstBaseTransformClass *klass;
662   gboolean ret = FALSE;
663
664   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
665
666   GST_DEBUG_OBJECT (trans,
667       "asked to transform size %" G_GSIZE_FORMAT " for caps %"
668       GST_PTR_FORMAT " to size for caps %" GST_PTR_FORMAT " in direction %s",
669       size, caps, othercaps, direction == GST_PAD_SRC ? "SRC" : "SINK");
670
671   if (klass->transform_size) {
672     /* if there is a custom transform function, use this */
673     ret = klass->transform_size (trans, direction, caps, size, othercaps,
674         othersize);
675   }
676   return ret;
677 }
678
679 /* get the caps that can be handled by @pad. We perform:
680  *
681  *  - take the caps of peer of otherpad,
682  *  - filter against the padtemplate of otherpad, 
683  *  - calculate all transforms of remaining caps
684  *  - filter against template of @pad
685  *
686  * If there is no peer, we simply return the caps of the padtemplate of pad.
687  */
688 static GstCaps *
689 gst_base_transform_query_caps (GstBaseTransform * trans, GstPad * pad,
690     GstCaps * filter)
691 {
692   GstPad *otherpad;
693   GstCaps *peercaps = NULL, *caps, *temp, *peerfilter = NULL;
694   GstCaps *templ, *otempl;
695
696   otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
697
698   templ = gst_pad_get_pad_template_caps (pad);
699   otempl = gst_pad_get_pad_template_caps (otherpad);
700
701   /* first prepare the filter to be send onwards. We need to filter and
702    * transform it to valid caps for the otherpad. */
703   if (filter) {
704     GST_DEBUG_OBJECT (pad, "filter caps  %" GST_PTR_FORMAT, filter);
705
706     /* filtered against our padtemplate of this pad */
707     GST_DEBUG_OBJECT (pad, "our template  %" GST_PTR_FORMAT, templ);
708     temp = gst_caps_intersect_full (filter, templ, GST_CAPS_INTERSECT_FIRST);
709     GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
710
711     /* then see what we can transform this to */
712     peerfilter = gst_base_transform_transform_caps (trans,
713         GST_PAD_DIRECTION (pad), temp, NULL);
714     GST_DEBUG_OBJECT (pad, "transformed  %" GST_PTR_FORMAT, peerfilter);
715     gst_caps_unref (temp);
716
717     if (!gst_caps_is_empty (peerfilter)) {
718       /* and filter against the template of the other pad */
719       GST_DEBUG_OBJECT (pad, "our template  %" GST_PTR_FORMAT, otempl);
720       /* We keep the caps sorted like the returned caps */
721       temp =
722           gst_caps_intersect_full (peerfilter, otempl,
723           GST_CAPS_INTERSECT_FIRST);
724       GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
725       gst_caps_unref (peerfilter);
726       peerfilter = temp;
727     }
728   }
729
730   GST_DEBUG_OBJECT (pad, "peer filter caps %" GST_PTR_FORMAT, peerfilter);
731
732   if (peerfilter && gst_caps_is_empty (peerfilter)) {
733     GST_DEBUG_OBJECT (pad, "peer filter caps are empty");
734     caps = peerfilter;
735     peerfilter = NULL;
736     goto done;
737   }
738
739   /* query the peer with the transformed filter */
740   peercaps = gst_pad_peer_query_caps (otherpad, peerfilter);
741
742   if (peerfilter)
743     gst_caps_unref (peerfilter);
744
745   if (peercaps) {
746     GST_DEBUG_OBJECT (pad, "peer caps  %" GST_PTR_FORMAT, peercaps);
747
748     /* filtered against our padtemplate on the other side */
749     GST_DEBUG_OBJECT (pad, "our template  %" GST_PTR_FORMAT, otempl);
750     temp = gst_caps_intersect_full (peercaps, otempl, GST_CAPS_INTERSECT_FIRST);
751     GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
752   } else {
753     temp = gst_caps_ref (otempl);
754   }
755
756   /* then see what we can transform this to */
757   caps = gst_base_transform_transform_caps (trans,
758       GST_PAD_DIRECTION (otherpad), temp, filter);
759   GST_DEBUG_OBJECT (pad, "transformed  %" GST_PTR_FORMAT, caps);
760   gst_caps_unref (temp);
761   if (caps == NULL || gst_caps_is_empty (caps))
762     goto done;
763
764   if (peercaps) {
765     /* and filter against the template of this pad */
766     GST_DEBUG_OBJECT (pad, "our template  %" GST_PTR_FORMAT, templ);
767     /* We keep the caps sorted like the returned caps */
768     temp = gst_caps_intersect_full (caps, templ, GST_CAPS_INTERSECT_FIRST);
769     GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, temp);
770     gst_caps_unref (caps);
771     caps = temp;
772
773     if (trans->priv->prefer_passthrough) {
774       /* Now try if we can put the untransformed downstream caps first */
775       temp = gst_caps_intersect_full (peercaps, caps, GST_CAPS_INTERSECT_FIRST);
776       if (!gst_caps_is_empty (temp)) {
777         caps = gst_caps_merge (temp, caps);
778       } else {
779         gst_caps_unref (temp);
780       }
781     }
782   } else {
783     gst_caps_unref (caps);
784     /* no peer or the peer can do anything, our padtemplate is enough then */
785     if (filter) {
786       caps = gst_caps_intersect_full (filter, templ, GST_CAPS_INTERSECT_FIRST);
787     } else {
788       caps = gst_caps_ref (templ);
789     }
790   }
791
792 done:
793   GST_DEBUG_OBJECT (trans, "returning  %" GST_PTR_FORMAT, caps);
794
795   if (peercaps)
796     gst_caps_unref (peercaps);
797
798   gst_caps_unref (templ);
799   gst_caps_unref (otempl);
800
801   return caps;
802 }
803
804 /* takes ownership of the pool, allocator and query */
805 static gboolean
806 gst_base_transform_set_allocation (GstBaseTransform * trans,
807     GstBufferPool * pool, GstAllocator * allocator,
808     GstAllocationParams * params, GstQuery * query)
809 {
810   GstAllocator *oldalloc;
811   GstBufferPool *oldpool;
812   GstQuery *oldquery;
813   GstBaseTransformPrivate *priv = trans->priv;
814
815   GST_OBJECT_LOCK (trans);
816   oldpool = priv->pool;
817   priv->pool = pool;
818   priv->pool_active = FALSE;
819
820   oldalloc = priv->allocator;
821   priv->allocator = allocator;
822
823   oldquery = priv->query;
824   priv->query = query;
825
826   if (params)
827     priv->params = *params;
828   else
829     gst_allocation_params_init (&priv->params);
830   GST_OBJECT_UNLOCK (trans);
831
832   if (oldpool) {
833     GST_DEBUG_OBJECT (trans, "deactivating old pool %p", oldpool);
834     gst_buffer_pool_set_active (oldpool, FALSE);
835     gst_object_unref (oldpool);
836   }
837   if (oldalloc) {
838     gst_object_unref (oldalloc);
839   }
840   if (oldquery) {
841     gst_query_unref (oldquery);
842   }
843   return TRUE;
844 }
845
846 static gboolean
847 gst_base_transform_default_decide_allocation (GstBaseTransform * trans,
848     GstQuery * query)
849 {
850   guint i, n_metas;
851   GstBaseTransformClass *klass;
852   GstCaps *outcaps;
853   GstBufferPool *pool;
854   guint size, min, max;
855   GstAllocator *allocator;
856   GstAllocationParams params;
857   GstStructure *config;
858   gboolean update_allocator;
859
860   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
861
862   n_metas = gst_query_get_n_allocation_metas (query);
863   for (i = 0; i < n_metas; i++) {
864     GType api;
865     const GstStructure *params;
866     gboolean remove;
867
868     api = gst_query_parse_nth_allocation_meta (query, i, &params);
869
870     /* by default we remove all metadata, subclasses should implement a
871      * filter_meta function */
872     if (gst_meta_api_type_has_tag (api, _gst_meta_tag_memory)) {
873       /* remove all memory dependent metadata because we are going to have to
874        * allocate different memory for input and output. */
875       GST_LOG_OBJECT (trans, "removing memory specific metadata %s",
876           g_type_name (api));
877       remove = TRUE;
878     } else if (G_LIKELY (klass->filter_meta)) {
879       /* remove if the subclass said so */
880       remove = !klass->filter_meta (trans, query, api, params);
881       GST_LOG_OBJECT (trans, "filter_meta for api %s returned: %s",
882           g_type_name (api), (remove ? "remove" : "keep"));
883     } else {
884       GST_LOG_OBJECT (trans, "removing metadata %s", g_type_name (api));
885       remove = TRUE;
886     }
887
888     if (remove) {
889       gst_query_remove_nth_allocation_meta (query, i);
890       i--;
891       n_metas--;
892     }
893   }
894
895   gst_query_parse_allocation (query, &outcaps, NULL);
896
897   /* we got configuration from our peer or the decide_allocation method,
898    * parse them */
899   if (gst_query_get_n_allocation_params (query) > 0) {
900     /* try the allocator */
901     gst_query_parse_nth_allocation_param (query, 0, &allocator, &params);
902     update_allocator = TRUE;
903   } else {
904     allocator = NULL;
905     gst_allocation_params_init (&params);
906     update_allocator = FALSE;
907   }
908
909   if (gst_query_get_n_allocation_pools (query) > 0) {
910     gst_query_parse_nth_allocation_pool (query, 0, &pool, &size, &min, &max);
911
912     if (pool == NULL) {
913       /* no pool, we can make our own */
914       GST_DEBUG_OBJECT (trans, "no pool, making new pool");
915       pool = gst_buffer_pool_new ();
916     }
917   } else {
918     pool = NULL;
919     size = min = max = 0;
920   }
921
922   /* now configure */
923   if (pool) {
924     config = gst_buffer_pool_get_config (pool);
925     gst_buffer_pool_config_set_params (config, outcaps, size, min, max);
926     gst_buffer_pool_config_set_allocator (config, allocator, &params);
927
928     /* buffer pool may have to do some changes */
929     if (!gst_buffer_pool_set_config (pool, config)) {
930       config = gst_buffer_pool_get_config (pool);
931
932       /* If change are not acceptable, fallback to generic pool */
933       if (!gst_buffer_pool_config_validate_params (config, outcaps, size, min,
934               max)) {
935         GST_DEBUG_OBJECT (trans, "unsuported pool, making new pool");
936
937         gst_object_unref (pool);
938         pool = gst_buffer_pool_new ();
939         gst_buffer_pool_config_set_params (config, outcaps, size, min, max);
940         gst_buffer_pool_config_set_allocator (config, allocator, &params);
941       }
942
943       if (!gst_buffer_pool_set_config (pool, config))
944         goto config_failed;
945     }
946   }
947
948   if (update_allocator)
949     gst_query_set_nth_allocation_param (query, 0, allocator, &params);
950   else
951     gst_query_add_allocation_param (query, allocator, &params);
952   if (allocator)
953     gst_object_unref (allocator);
954
955   if (pool) {
956     gst_query_set_nth_allocation_pool (query, 0, pool, size, min, max);
957     gst_object_unref (pool);
958   }
959
960   return TRUE;
961
962 config_failed:
963   if (pool)
964     gst_object_unref (pool);
965
966   GST_ELEMENT_ERROR (trans, RESOURCE, SETTINGS,
967       ("Failed to configure the buffer pool"),
968       ("Configuration is most likely invalid, please report this issue."));
969   return FALSE;
970 }
971
972 static gboolean
973 gst_base_transform_do_bufferpool (GstBaseTransform * trans, GstCaps * outcaps)
974 {
975   GstQuery *query;
976   gboolean result = TRUE;
977   GstBufferPool *pool = NULL;
978   GstBaseTransformClass *klass;
979   GstBaseTransformPrivate *priv = trans->priv;
980   GstAllocator *allocator;
981   GstAllocationParams params;
982
983   /* there are these possibilities:
984    *
985    * 1) we negotiated passthrough, we can proxy the bufferpool directly and we
986    *    will do that whenever some upstream does an allocation query.
987    * 2) we need to do a transform, we need to get a bufferpool from downstream
988    *    and configure it. When upstream does the ALLOCATION query, the
989    *    propose_allocation vmethod will be called and we will configure the
990    *    upstream allocator with our proposed values then.
991    */
992   if (priv->passthrough || priv->always_in_place) {
993     /* we are in passthrough, the input buffer is never copied and always passed
994      * along. We never allocate an output buffer on the srcpad. What we do is
995      * let the upstream element decide if it wants to use a bufferpool and
996      * then we will proxy the downstream pool */
997     GST_DEBUG_OBJECT (trans, "we're passthough, delay bufferpool");
998     gst_base_transform_set_allocation (trans, NULL, NULL, NULL, NULL);
999     return TRUE;
1000   }
1001
1002   /* not passthrough, we need to allocate */
1003   /* find a pool for the negotiated caps now */
1004   GST_DEBUG_OBJECT (trans, "doing allocation query");
1005   query = gst_query_new_allocation (outcaps, TRUE);
1006   if (!gst_pad_peer_query (trans->srcpad, query)) {
1007     /* not a problem, just debug a little */
1008     GST_DEBUG_OBJECT (trans, "peer ALLOCATION query failed");
1009   }
1010
1011   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1012
1013   GST_DEBUG_OBJECT (trans, "calling decide_allocation");
1014   g_assert (klass->decide_allocation != NULL);
1015   result = klass->decide_allocation (trans, query);
1016
1017   GST_DEBUG_OBJECT (trans, "ALLOCATION (%d) params: %" GST_PTR_FORMAT, result,
1018       query);
1019
1020   if (!result)
1021     goto no_decide_allocation;
1022
1023   /* we got configuration from our peer or the decide_allocation method,
1024    * parse them */
1025   if (gst_query_get_n_allocation_params (query) > 0) {
1026     gst_query_parse_nth_allocation_param (query, 0, &allocator, &params);
1027   } else {
1028     allocator = NULL;
1029     gst_allocation_params_init (&params);
1030   }
1031
1032   if (gst_query_get_n_allocation_pools (query) > 0)
1033     gst_query_parse_nth_allocation_pool (query, 0, &pool, NULL, NULL, NULL);
1034
1035   /* now store */
1036   result =
1037       gst_base_transform_set_allocation (trans, pool, allocator, &params,
1038       query);
1039
1040   return result;
1041
1042   /* Errors */
1043 no_decide_allocation:
1044   {
1045     GST_WARNING_OBJECT (trans, "Subclass failed to decide allocation");
1046     gst_query_unref (query);
1047
1048     return result;
1049   }
1050 }
1051
1052 /* function triggered when the in and out caps are negotiated and need
1053  * to be configured in the subclass. */
1054 static gboolean
1055 gst_base_transform_configure_caps (GstBaseTransform * trans, GstCaps * in,
1056     GstCaps * out)
1057 {
1058   gboolean ret = TRUE;
1059   GstBaseTransformClass *klass;
1060   GstBaseTransformPrivate *priv = trans->priv;
1061
1062   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1063
1064   GST_DEBUG_OBJECT (trans, "in caps:  %" GST_PTR_FORMAT, in);
1065   GST_DEBUG_OBJECT (trans, "out caps: %" GST_PTR_FORMAT, out);
1066
1067   /* clear the cache */
1068   gst_caps_replace (&priv->cache_caps1, NULL);
1069   gst_caps_replace (&priv->cache_caps2, NULL);
1070
1071   /* figure out same caps state */
1072   priv->have_same_caps = gst_caps_is_equal (in, out);
1073   GST_DEBUG_OBJECT (trans, "have_same_caps: %d", priv->have_same_caps);
1074
1075   /* Set the passthrough if the class wants passthrough_on_same_caps
1076    * and we have the same caps on each pad */
1077   if (klass->passthrough_on_same_caps)
1078     gst_base_transform_set_passthrough (trans, priv->have_same_caps);
1079
1080   /* now configure the element with the caps */
1081   if (klass->set_caps) {
1082     GST_DEBUG_OBJECT (trans, "Calling set_caps method to setup caps");
1083     ret = klass->set_caps (trans, in, out);
1084   }
1085
1086   return ret;
1087 }
1088
1089 static GstCaps *
1090 gst_base_transform_default_fixate_caps (GstBaseTransform * trans,
1091     GstPadDirection direction, GstCaps * caps, GstCaps * othercaps)
1092 {
1093   othercaps = gst_caps_fixate (othercaps);
1094   GST_DEBUG_OBJECT (trans, "fixated to %" GST_PTR_FORMAT, othercaps);
1095
1096   return othercaps;
1097 }
1098
1099 /* given a fixed @caps on @pad, create the best possible caps for the
1100  * other pad.
1101  * @caps must be fixed when calling this function.
1102  *
1103  * This function calls the transform caps vmethod of the basetransform to figure
1104  * out the possible target formats. It then tries to select the best format from
1105  * this list by:
1106  *
1107  * - attempt passthrough if the target caps is a superset of the input caps
1108  * - fixating by using peer caps
1109  * - fixating with transform fixate function
1110  * - fixating with pad fixate functions.
1111  *
1112  * this function returns a caps that can be transformed into and is accepted by
1113  * the peer element.
1114  */
1115 static GstCaps *
1116 gst_base_transform_find_transform (GstBaseTransform * trans, GstPad * pad,
1117     GstCaps * caps)
1118 {
1119   GstBaseTransformClass *klass;
1120   GstPad *otherpad, *otherpeer;
1121   GstCaps *othercaps;
1122   gboolean is_fixed;
1123
1124   /* caps must be fixed here, this is a programming error if it's not */
1125   g_return_val_if_fail (gst_caps_is_fixed (caps), NULL);
1126
1127   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1128
1129   otherpad = (pad == trans->srcpad) ? trans->sinkpad : trans->srcpad;
1130   otherpeer = gst_pad_get_peer (otherpad);
1131
1132   /* see how we can transform the input caps. We need to do this even for
1133    * passthrough because it might be possible that this element cannot support
1134    * passthrough at all. */
1135   othercaps = gst_base_transform_transform_caps (trans,
1136       GST_PAD_DIRECTION (pad), caps, NULL);
1137
1138   /* The caps we can actually output is the intersection of the transformed
1139    * caps with the pad template for the pad */
1140   if (othercaps && !gst_caps_is_empty (othercaps)) {
1141     GstCaps *intersect, *templ_caps;
1142
1143     templ_caps = gst_pad_get_pad_template_caps (otherpad);
1144     GST_DEBUG_OBJECT (trans,
1145         "intersecting against padtemplate %" GST_PTR_FORMAT, templ_caps);
1146
1147     intersect =
1148         gst_caps_intersect_full (othercaps, templ_caps,
1149         GST_CAPS_INTERSECT_FIRST);
1150
1151     gst_caps_unref (othercaps);
1152     gst_caps_unref (templ_caps);
1153     othercaps = intersect;
1154   }
1155
1156   /* check if transform is empty */
1157   if (!othercaps || gst_caps_is_empty (othercaps))
1158     goto no_transform;
1159
1160   /* if the othercaps are not fixed, we need to fixate them, first attempt
1161    * is by attempting passthrough if the othercaps are a superset of caps. */
1162   /* FIXME. maybe the caps is not fixed because it has multiple structures of
1163    * fixed caps */
1164   is_fixed = gst_caps_is_fixed (othercaps);
1165   if (!is_fixed) {
1166     GST_DEBUG_OBJECT (trans,
1167         "transform returned non fixed  %" GST_PTR_FORMAT, othercaps);
1168
1169     /* Now let's see what the peer suggests based on our transformed caps */
1170     if (otherpeer) {
1171       GstCaps *peercaps, *intersection, *templ_caps;
1172
1173       GST_DEBUG_OBJECT (trans,
1174           "Checking peer caps with filter %" GST_PTR_FORMAT, othercaps);
1175
1176       peercaps = gst_pad_query_caps (otherpeer, othercaps);
1177       GST_DEBUG_OBJECT (trans, "Resulted in %" GST_PTR_FORMAT, peercaps);
1178       if (!gst_caps_is_empty (peercaps)) {
1179         templ_caps = gst_pad_get_pad_template_caps (otherpad);
1180
1181         GST_DEBUG_OBJECT (trans,
1182             "Intersecting with template caps %" GST_PTR_FORMAT, templ_caps);
1183
1184         intersection =
1185             gst_caps_intersect_full (peercaps, templ_caps,
1186             GST_CAPS_INTERSECT_FIRST);
1187         GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1188             intersection);
1189         gst_caps_unref (peercaps);
1190         gst_caps_unref (templ_caps);
1191         peercaps = intersection;
1192
1193         GST_DEBUG_OBJECT (trans,
1194             "Intersecting with transformed caps %" GST_PTR_FORMAT, othercaps);
1195         intersection =
1196             gst_caps_intersect_full (peercaps, othercaps,
1197             GST_CAPS_INTERSECT_FIRST);
1198         GST_DEBUG_OBJECT (trans, "Intersection: %" GST_PTR_FORMAT,
1199             intersection);
1200         gst_caps_unref (peercaps);
1201         gst_caps_unref (othercaps);
1202         othercaps = intersection;
1203       } else {
1204         gst_caps_unref (othercaps);
1205         othercaps = peercaps;
1206       }
1207
1208       is_fixed = gst_caps_is_fixed (othercaps);
1209     } else {
1210       GST_DEBUG_OBJECT (trans, "no peer, doing passthrough");
1211       gst_caps_unref (othercaps);
1212       othercaps = gst_caps_ref (caps);
1213       is_fixed = TRUE;
1214     }
1215   }
1216   if (gst_caps_is_empty (othercaps))
1217     goto no_transform_possible;
1218
1219   GST_DEBUG ("have %sfixed caps %" GST_PTR_FORMAT, (is_fixed ? "" : "non-"),
1220       othercaps);
1221
1222   /* second attempt at fixation, call the fixate vmethod */
1223   /* caps could be fixed but the subclass may want to add fields */
1224   if (klass->fixate_caps) {
1225     GST_DEBUG_OBJECT (trans, "calling fixate_caps for %" GST_PTR_FORMAT
1226         " using caps %" GST_PTR_FORMAT " on pad %s:%s", othercaps, caps,
1227         GST_DEBUG_PAD_NAME (otherpad));
1228     /* note that we pass the complete array of structures to the fixate
1229      * function, it needs to truncate itself */
1230     othercaps =
1231         klass->fixate_caps (trans, GST_PAD_DIRECTION (pad), caps, othercaps);
1232     is_fixed = gst_caps_is_fixed (othercaps);
1233     GST_DEBUG_OBJECT (trans, "after fixating %" GST_PTR_FORMAT, othercaps);
1234   }
1235
1236   /* caps should be fixed now, if not we have to fail. */
1237   if (!is_fixed)
1238     goto could_not_fixate;
1239
1240   /* and peer should accept */
1241   if (otherpeer && !gst_pad_query_accept_caps (otherpeer, othercaps))
1242     goto peer_no_accept;
1243
1244   GST_DEBUG_OBJECT (trans, "Input caps were %" GST_PTR_FORMAT
1245       ", and got final caps %" GST_PTR_FORMAT, caps, othercaps);
1246
1247   if (otherpeer)
1248     gst_object_unref (otherpeer);
1249
1250   return othercaps;
1251
1252   /* ERRORS */
1253 no_transform:
1254   {
1255     GST_DEBUG_OBJECT (trans,
1256         "transform returned useless  %" GST_PTR_FORMAT, othercaps);
1257     goto error_cleanup;
1258   }
1259 no_transform_possible:
1260   {
1261     GST_DEBUG_OBJECT (trans,
1262         "transform could not transform %" GST_PTR_FORMAT
1263         " in anything we support", caps);
1264     goto error_cleanup;
1265   }
1266 could_not_fixate:
1267   {
1268     GST_DEBUG_OBJECT (trans, "FAILED to fixate %" GST_PTR_FORMAT, othercaps);
1269     goto error_cleanup;
1270   }
1271 peer_no_accept:
1272   {
1273     GST_DEBUG_OBJECT (trans, "FAILED to get peer of %" GST_PTR_FORMAT
1274         " to accept %" GST_PTR_FORMAT, otherpad, othercaps);
1275     goto error_cleanup;
1276   }
1277 error_cleanup:
1278   {
1279     if (otherpeer)
1280       gst_object_unref (otherpeer);
1281     if (othercaps)
1282       gst_caps_unref (othercaps);
1283     return NULL;
1284   }
1285 }
1286
1287 static gboolean
1288 gst_base_transform_acceptcaps_default (GstBaseTransform * trans,
1289     GstPadDirection direction, GstCaps * caps)
1290 {
1291   GstPad *pad, *otherpad;
1292   GstCaps *templ, *otempl, *ocaps = NULL;
1293   gboolean ret = TRUE;
1294
1295   pad =
1296       (direction ==
1297       GST_PAD_SINK) ? GST_BASE_TRANSFORM_SINK_PAD (trans) :
1298       GST_BASE_TRANSFORM_SRC_PAD (trans);
1299   otherpad =
1300       (direction ==
1301       GST_PAD_SINK) ? GST_BASE_TRANSFORM_SRC_PAD (trans) :
1302       GST_BASE_TRANSFORM_SINK_PAD (trans);
1303
1304   GST_DEBUG_OBJECT (trans, "accept caps %" GST_PTR_FORMAT, caps);
1305
1306   templ = gst_pad_get_pad_template_caps (pad);
1307   otempl = gst_pad_get_pad_template_caps (otherpad);
1308
1309   /* get all the formats we can handle on this pad */
1310   GST_DEBUG_OBJECT (trans, "intersect with pad template: %" GST_PTR_FORMAT,
1311       templ);
1312   if (!gst_caps_can_intersect (caps, templ))
1313     goto reject_caps;
1314
1315   GST_DEBUG_OBJECT (trans, "trying to transform with filter: %"
1316       GST_PTR_FORMAT " (the other pad template)", otempl);
1317   ocaps = gst_base_transform_transform_caps (trans, direction, caps, otempl);
1318   if (!ocaps || gst_caps_is_empty (ocaps))
1319     goto no_transform_possible;
1320
1321 done:
1322   GST_DEBUG_OBJECT (trans, "accept-caps result: %d", ret);
1323   if (ocaps)
1324     gst_caps_unref (ocaps);
1325   gst_caps_unref (templ);
1326   gst_caps_unref (otempl);
1327   return ret;
1328
1329   /* ERRORS */
1330 reject_caps:
1331   {
1332     GST_DEBUG_OBJECT (trans, "caps can't intersect with the template");
1333     ret = FALSE;
1334     goto done;
1335   }
1336 no_transform_possible:
1337   {
1338     GST_DEBUG_OBJECT (trans,
1339         "transform could not transform %" GST_PTR_FORMAT
1340         " in anything we support", caps);
1341     ret = FALSE;
1342     goto done;
1343   }
1344 }
1345
1346 /* called when new caps arrive on the sink pad,
1347  * We try to find the best caps for the other side using our _find_transform()
1348  * function. If there are caps, we configure the transform for this new
1349  * transformation.
1350  */
1351 static gboolean
1352 gst_base_transform_setcaps (GstBaseTransform * trans, GstPad * pad,
1353     GstCaps * incaps)
1354 {
1355   GstBaseTransformPrivate *priv = trans->priv;
1356   GstCaps *outcaps, *prev_incaps = NULL, *prev_outcaps = NULL;
1357   gboolean ret = TRUE;
1358
1359   GST_DEBUG_OBJECT (pad, "have new caps %p %" GST_PTR_FORMAT, incaps, incaps);
1360
1361   /* find best possible caps for the other pad */
1362   outcaps = gst_base_transform_find_transform (trans, pad, incaps);
1363   if (!outcaps || gst_caps_is_empty (outcaps))
1364     goto no_transform_possible;
1365
1366   /* configure the element now */
1367
1368   /* if we have the same caps, we can optimize and reuse the input caps */
1369   if (gst_caps_is_equal (incaps, outcaps)) {
1370     GST_INFO_OBJECT (trans, "reuse caps");
1371     gst_caps_unref (outcaps);
1372     outcaps = gst_caps_ref (incaps);
1373   }
1374
1375   prev_incaps = gst_pad_get_current_caps (trans->sinkpad);
1376   prev_outcaps = gst_pad_get_current_caps (trans->srcpad);
1377   if (prev_incaps && prev_outcaps && gst_caps_is_equal (prev_incaps, incaps)
1378       && gst_caps_is_equal (prev_outcaps, outcaps)) {
1379     GST_DEBUG_OBJECT (trans,
1380         "New caps equal to old ones: %" GST_PTR_FORMAT " -> %" GST_PTR_FORMAT,
1381         incaps, outcaps);
1382     ret = TRUE;
1383   } else {
1384     /* call configure now */
1385     if (!(ret = gst_base_transform_configure_caps (trans, incaps, outcaps)))
1386       goto failed_configure;
1387
1388     if (!prev_outcaps || !gst_caps_is_equal (outcaps, prev_outcaps))
1389       /* let downstream know about our caps */
1390       ret = gst_pad_set_caps (trans->srcpad, outcaps);
1391   }
1392
1393   if (ret) {
1394     /* try to get a pool when needed */
1395     ret = gst_base_transform_do_bufferpool (trans, outcaps);
1396   }
1397
1398 done:
1399   if (outcaps)
1400     gst_caps_unref (outcaps);
1401   if (prev_incaps)
1402     gst_caps_unref (prev_incaps);
1403   if (prev_outcaps)
1404     gst_caps_unref (prev_outcaps);
1405
1406   GST_OBJECT_LOCK (trans);
1407   priv->negotiated = ret;
1408   GST_OBJECT_UNLOCK (trans);
1409
1410   return ret;
1411
1412   /* ERRORS */
1413 no_transform_possible:
1414   {
1415     GST_WARNING_OBJECT (trans,
1416         "transform could not transform %" GST_PTR_FORMAT
1417         " in anything we support", incaps);
1418     ret = FALSE;
1419     goto done;
1420   }
1421 failed_configure:
1422   {
1423     GST_WARNING_OBJECT (trans, "FAILED to configure incaps %" GST_PTR_FORMAT
1424         " and outcaps %" GST_PTR_FORMAT, incaps, outcaps);
1425     ret = FALSE;
1426     goto done;
1427   }
1428 }
1429
1430 static gboolean
1431 gst_base_transform_default_propose_allocation (GstBaseTransform * trans,
1432     GstQuery * decide_query, GstQuery * query)
1433 {
1434   gboolean ret;
1435
1436   if (decide_query == NULL) {
1437     GST_DEBUG_OBJECT (trans, "doing passthrough query");
1438     ret = gst_pad_peer_query (trans->srcpad, query);
1439   } else {
1440     guint i, n_metas;
1441     /* non-passthrough, copy all metadata, decide_query does not contain the
1442      * metadata anymore that depends on the buffer memory */
1443     n_metas = gst_query_get_n_allocation_metas (decide_query);
1444     for (i = 0; i < n_metas; i++) {
1445       GType api;
1446       const GstStructure *params;
1447
1448       api = gst_query_parse_nth_allocation_meta (decide_query, i, &params);
1449       GST_DEBUG_OBJECT (trans, "proposing metadata %s", g_type_name (api));
1450       gst_query_add_allocation_meta (query, api, params);
1451     }
1452     ret = TRUE;
1453   }
1454   return ret;
1455 }
1456
1457 static gboolean
1458 gst_base_transform_reconfigure (GstBaseTransform * trans)
1459 {
1460   gboolean reconfigure, ret = TRUE;
1461
1462   reconfigure = gst_pad_check_reconfigure (trans->srcpad);
1463
1464   if (G_UNLIKELY (reconfigure)) {
1465     GstCaps *incaps;
1466
1467     GST_DEBUG_OBJECT (trans, "we had a pending reconfigure");
1468
1469     incaps = gst_pad_get_current_caps (trans->sinkpad);
1470     if (incaps == NULL)
1471       goto done;
1472
1473     /* if we need to reconfigure we pretend new caps arrived. This
1474      * will reconfigure the transform with the new output format. */
1475     if (!gst_base_transform_setcaps (trans, trans->sinkpad, incaps)) {
1476       GST_ELEMENT_WARNING (trans, STREAM, FORMAT,
1477           ("not negotiated"), ("not negotiated"));
1478       ret = FALSE;
1479     }
1480
1481     gst_caps_unref (incaps);
1482   }
1483
1484 done:
1485
1486   if (!ret)
1487     gst_pad_mark_reconfigure (trans->srcpad);
1488
1489   return ret;
1490 }
1491
1492 static gboolean
1493 gst_base_transform_default_query (GstBaseTransform * trans,
1494     GstPadDirection direction, GstQuery * query)
1495 {
1496   gboolean ret = FALSE;
1497   GstPad *pad, *otherpad;
1498   GstBaseTransformClass *klass;
1499   GstBaseTransformPrivate *priv = trans->priv;
1500
1501   if (direction == GST_PAD_SRC) {
1502     pad = trans->srcpad;
1503     otherpad = trans->sinkpad;
1504   } else {
1505     pad = trans->sinkpad;
1506     otherpad = trans->srcpad;
1507   }
1508
1509   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1510
1511   switch (GST_QUERY_TYPE (query)) {
1512     case GST_QUERY_ALLOCATION:
1513     {
1514       GstQuery *decide_query = NULL;
1515
1516       /* can only be done on the sinkpad */
1517       if (direction != GST_PAD_SINK)
1518         goto done;
1519
1520       ret = gst_base_transform_reconfigure (trans);
1521       if (G_UNLIKELY (!ret))
1522         goto done;
1523
1524       GST_OBJECT_LOCK (trans);
1525       if (!priv->negotiated && !priv->passthrough && (klass->set_caps != NULL)) {
1526         GST_DEBUG_OBJECT (trans,
1527             "not negotiated yet but need negotiation, can't answer ALLOCATION query");
1528         GST_OBJECT_UNLOCK (trans);
1529         goto done;
1530       }
1531
1532       decide_query = trans->priv->query;
1533       trans->priv->query = NULL;
1534       GST_OBJECT_UNLOCK (trans);
1535
1536       GST_DEBUG_OBJECT (trans,
1537           "calling propose allocation with query %" GST_PTR_FORMAT,
1538           decide_query);
1539
1540       /* pass the query to the propose_allocation vmethod if any */
1541       if (G_LIKELY (klass->propose_allocation))
1542         ret = klass->propose_allocation (trans, decide_query, query);
1543       else
1544         ret = FALSE;
1545
1546       if (decide_query) {
1547         GST_OBJECT_LOCK (trans);
1548
1549         if (trans->priv->query == NULL)
1550           trans->priv->query = decide_query;
1551         else
1552           gst_query_unref (decide_query);
1553
1554         GST_OBJECT_UNLOCK (trans);
1555       }
1556
1557       GST_DEBUG_OBJECT (trans, "ALLOCATION ret %d, %" GST_PTR_FORMAT, ret,
1558           query);
1559       break;
1560     }
1561     case GST_QUERY_POSITION:
1562     {
1563       GstFormat format;
1564
1565       gst_query_parse_position (query, &format, NULL);
1566       if (format == GST_FORMAT_TIME && trans->segment.format == GST_FORMAT_TIME) {
1567         gint64 pos;
1568         ret = TRUE;
1569
1570         if ((direction == GST_PAD_SINK)
1571             || (trans->priv->position_out == GST_CLOCK_TIME_NONE)) {
1572           pos =
1573               gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1574               trans->segment.position);
1575         } else {
1576           pos = gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
1577               trans->priv->position_out);
1578         }
1579         gst_query_set_position (query, format, pos);
1580       } else {
1581         ret = gst_pad_peer_query (otherpad, query);
1582       }
1583       break;
1584     }
1585     case GST_QUERY_ACCEPT_CAPS:
1586     {
1587       GstCaps *caps;
1588
1589       gst_query_parse_accept_caps (query, &caps);
1590       if (klass->accept_caps) {
1591         ret = klass->accept_caps (trans, direction, caps);
1592         gst_query_set_accept_caps_result (query, ret);
1593         /* return TRUE, we answered the query */
1594         ret = TRUE;
1595       }
1596       break;
1597     }
1598     case GST_QUERY_CAPS:
1599     {
1600       GstCaps *filter, *caps;
1601
1602       gst_query_parse_caps (query, &filter);
1603       caps = gst_base_transform_query_caps (trans, pad, filter);
1604       gst_query_set_caps_result (query, caps);
1605       gst_caps_unref (caps);
1606       ret = TRUE;
1607       break;
1608     }
1609     default:
1610       ret = gst_pad_peer_query (otherpad, query);
1611       break;
1612   }
1613
1614 done:
1615   return ret;
1616 }
1617
1618 static gboolean
1619 gst_base_transform_query (GstPad * pad, GstObject * parent, GstQuery * query)
1620 {
1621   GstBaseTransform *trans;
1622   GstBaseTransformClass *bclass;
1623   gboolean ret = FALSE;
1624
1625   trans = GST_BASE_TRANSFORM (parent);
1626   bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1627
1628   if (bclass->query)
1629     ret = bclass->query (trans, GST_PAD_DIRECTION (pad), query);
1630
1631   return ret;
1632 }
1633
1634 /* this function either returns the input buffer without incrementing the
1635  * refcount or it allocates a new (writable) buffer */
1636 static GstFlowReturn
1637 default_prepare_output_buffer (GstBaseTransform * trans,
1638     GstBuffer * inbuf, GstBuffer ** outbuf)
1639 {
1640   GstBaseTransformPrivate *priv;
1641   GstFlowReturn ret;
1642   GstBaseTransformClass *bclass;
1643   GstCaps *incaps, *outcaps;
1644   gsize insize, outsize;
1645   gboolean res;
1646
1647   priv = trans->priv;
1648   bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1649
1650   /* figure out how to allocate an output buffer */
1651   if (priv->passthrough) {
1652     /* passthrough, we will not modify the incoming buffer so we can just
1653      * reuse it */
1654     GST_DEBUG_OBJECT (trans, "passthrough: reusing input buffer");
1655     *outbuf = inbuf;
1656     goto done;
1657   }
1658
1659   /* we can't reuse the input buffer */
1660   if (priv->pool) {
1661     if (!priv->pool_active) {
1662       GST_DEBUG_OBJECT (trans, "setting pool %p active", priv->pool);
1663       if (!gst_buffer_pool_set_active (priv->pool, TRUE))
1664         goto activate_failed;
1665       priv->pool_active = TRUE;
1666     }
1667     GST_DEBUG_OBJECT (trans, "using pool alloc");
1668     ret = gst_buffer_pool_acquire_buffer (priv->pool, outbuf, NULL);
1669     if (ret != GST_FLOW_OK)
1670       goto alloc_failed;
1671
1672     goto copy_meta;
1673   }
1674
1675   /* no pool, we need to figure out the size of the output buffer first */
1676   if ((bclass->transform_ip != NULL) && priv->always_in_place) {
1677     /* we want to do an in-place alloc */
1678     if (gst_buffer_is_writable (inbuf)) {
1679       GST_DEBUG_OBJECT (trans, "inplace reuse writable input buffer");
1680       *outbuf = inbuf;
1681     } else {
1682       GST_DEBUG_OBJECT (trans, "making writable buffer copy");
1683       /* we make a copy of the input buffer */
1684       *outbuf = gst_buffer_copy (inbuf);
1685     }
1686     goto done;
1687   }
1688
1689   /* else use the transform function to get the size */
1690   incaps = gst_pad_get_current_caps (trans->sinkpad);
1691   outcaps = gst_pad_get_current_caps (trans->srcpad);
1692
1693   /* srcpad might be flushing already if we're being shut down */
1694   if (outcaps == NULL)
1695     goto no_outcaps;
1696
1697   GST_DEBUG_OBJECT (trans, "getting output size for alloc");
1698   /* copy transform, figure out the output size */
1699   insize = gst_buffer_get_size (inbuf);
1700   res = gst_base_transform_transform_size (trans,
1701       GST_PAD_SINK, incaps, insize, outcaps, &outsize);
1702
1703   gst_caps_unref (incaps);
1704   gst_caps_unref (outcaps);
1705
1706   if (!res)
1707     goto unknown_size;
1708
1709   GST_DEBUG_OBJECT (trans, "doing alloc of size %" G_GSIZE_FORMAT, outsize);
1710   *outbuf = gst_buffer_new_allocate (priv->allocator, outsize, &priv->params);
1711   if (!*outbuf) {
1712     ret = GST_FLOW_ERROR;
1713     goto alloc_failed;
1714   }
1715
1716 copy_meta:
1717   /* copy the metadata */
1718   if (bclass->copy_metadata)
1719     if (!bclass->copy_metadata (trans, inbuf, *outbuf)) {
1720       /* something failed, post a warning */
1721       GST_ELEMENT_WARNING (trans, STREAM, NOT_IMPLEMENTED,
1722           ("could not copy metadata"), (NULL));
1723     }
1724
1725 done:
1726   return GST_FLOW_OK;
1727
1728   /* ERRORS */
1729 activate_failed:
1730   {
1731     GST_ELEMENT_ERROR (trans, RESOURCE, SETTINGS,
1732         ("failed to activate bufferpool"), ("failed to activate bufferpool"));
1733     return GST_FLOW_ERROR;
1734   }
1735 unknown_size:
1736   {
1737     GST_ERROR_OBJECT (trans, "unknown output size");
1738     return GST_FLOW_ERROR;
1739   }
1740 alloc_failed:
1741   {
1742     GST_DEBUG_OBJECT (trans, "could not allocate buffer from pool");
1743     return ret;
1744   }
1745 no_outcaps:
1746   {
1747     GST_DEBUG_OBJECT (trans, "no output caps, source pad has been deactivated");
1748     gst_caps_unref (incaps);
1749     return GST_FLOW_FLUSHING;
1750   }
1751 }
1752
1753 typedef struct
1754 {
1755   GstBaseTransform *trans;
1756   GstBuffer *outbuf;
1757 } CopyMetaData;
1758
1759 static gboolean
1760 foreach_metadata (GstBuffer * inbuf, GstMeta ** meta, gpointer user_data)
1761 {
1762   CopyMetaData *data = user_data;
1763   GstBaseTransform *trans = data->trans;
1764   GstBaseTransformClass *klass;
1765   const GstMetaInfo *info = (*meta)->info;
1766   GstBuffer *outbuf = data->outbuf;
1767   gboolean do_copy = FALSE;
1768
1769   klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1770
1771   if (gst_meta_api_type_has_tag (info->api, _gst_meta_tag_memory)) {
1772     /* never call the transform_meta with memory specific metadata */
1773     GST_DEBUG_OBJECT (trans, "not copying memory specific metadata %s",
1774         g_type_name (info->api));
1775     do_copy = FALSE;
1776   } else if (klass->transform_meta) {
1777     do_copy = klass->transform_meta (trans, outbuf, *meta, inbuf);
1778     GST_DEBUG_OBJECT (trans, "transformed metadata %s: copy: %d",
1779         g_type_name (info->api), do_copy);
1780   }
1781
1782   /* we only copy metadata when the subclass implemented a transform_meta
1783    * function and when it returns %TRUE */
1784   if (do_copy) {
1785     GstMetaTransformCopy copy_data = { FALSE, 0, -1 };
1786     GST_DEBUG_OBJECT (trans, "copy metadata %s", g_type_name (info->api));
1787     /* simply copy then */
1788     info->transform_func (outbuf, *meta, inbuf,
1789         _gst_meta_transform_copy, &copy_data);
1790   }
1791   return TRUE;
1792 }
1793
1794 static gboolean
1795 default_copy_metadata (GstBaseTransform * trans,
1796     GstBuffer * inbuf, GstBuffer * outbuf)
1797 {
1798   GstBaseTransformPrivate *priv = trans->priv;
1799   CopyMetaData data;
1800
1801   /* now copy the metadata */
1802   GST_DEBUG_OBJECT (trans, "copying metadata");
1803
1804   /* this should not happen, buffers allocated from a pool or with
1805    * new_allocate should always be writable. */
1806   if (!gst_buffer_is_writable (outbuf))
1807     goto not_writable;
1808
1809   /* when we get here, the metadata should be writable */
1810   gst_buffer_copy_into (outbuf, inbuf,
1811       GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
1812
1813   /* clear the GAP flag when the subclass does not understand it */
1814   if (!priv->gap_aware)
1815     GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_GAP);
1816
1817
1818   data.trans = trans;
1819   data.outbuf = outbuf;
1820
1821   gst_buffer_foreach_meta (inbuf, foreach_metadata, &data);
1822
1823   return TRUE;
1824
1825   /* ERRORS */
1826 not_writable:
1827   {
1828     GST_WARNING_OBJECT (trans, "buffer %p not writable", outbuf);
1829     return FALSE;
1830   }
1831 }
1832
1833 /* Given @caps calcultate the size of one unit.
1834  *
1835  * For video caps, this is the size of one frame (and thus one buffer).
1836  * For audio caps, this is the size of one sample.
1837  *
1838  * These values are cached since they do not change and the calculation
1839  * potentially involves parsing caps and other expensive stuff.
1840  *
1841  * We have two cache locations to store the size, one for the source caps
1842  * and one for the sink caps.
1843  *
1844  * this function returns %FALSE if no size could be calculated.
1845  */
1846 static gboolean
1847 gst_base_transform_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
1848     gsize * size)
1849 {
1850   gboolean res = FALSE;
1851   GstBaseTransformClass *bclass;
1852   GstBaseTransformPrivate *priv = trans->priv;
1853
1854   /* see if we have the result cached */
1855   if (priv->cache_caps1 == caps) {
1856     *size = priv->cache_caps1_size;
1857     GST_DEBUG_OBJECT (trans,
1858         "returned %" G_GSIZE_FORMAT " from first cache", *size);
1859     return TRUE;
1860   }
1861   if (priv->cache_caps2 == caps) {
1862     *size = priv->cache_caps2_size;
1863     GST_DEBUG_OBJECT (trans,
1864         "returned %" G_GSIZE_FORMAT " from second cached", *size);
1865     return TRUE;
1866   }
1867
1868   bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1869   res = bclass->get_unit_size (trans, caps, size);
1870   GST_DEBUG_OBJECT (trans,
1871       "caps %" GST_PTR_FORMAT ") has unit size %" G_GSIZE_FORMAT ", res %s",
1872       caps, *size, res ? "TRUE" : "FALSE");
1873
1874   if (res) {
1875     /* and cache the values */
1876     if (priv->cache_caps1 == NULL) {
1877       gst_caps_replace (&priv->cache_caps1, caps);
1878       priv->cache_caps1_size = *size;
1879       GST_DEBUG_OBJECT (trans,
1880           "caching %" G_GSIZE_FORMAT " in first cache", *size);
1881     } else if (priv->cache_caps2 == NULL) {
1882       gst_caps_replace (&priv->cache_caps2, caps);
1883       priv->cache_caps2_size = *size;
1884       GST_DEBUG_OBJECT (trans,
1885           "caching %" G_GSIZE_FORMAT " in second cache", *size);
1886     } else {
1887       GST_DEBUG_OBJECT (trans, "no free spot to cache unit_size");
1888     }
1889   }
1890   return res;
1891 }
1892
1893 static gboolean
1894 gst_base_transform_sink_event (GstPad * pad, GstObject * parent,
1895     GstEvent * event)
1896 {
1897   GstBaseTransform *trans;
1898   GstBaseTransformClass *bclass;
1899   gboolean ret = TRUE;
1900
1901   trans = GST_BASE_TRANSFORM (parent);
1902   bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1903
1904   if (bclass->sink_event)
1905     ret = bclass->sink_event (trans, event);
1906   else
1907     gst_event_unref (event);
1908
1909   return ret;
1910 }
1911
1912 static gboolean
1913 gst_base_transform_sink_eventfunc (GstBaseTransform * trans, GstEvent * event)
1914 {
1915   gboolean ret = TRUE, forward = TRUE;
1916   GstBaseTransformPrivate *priv = trans->priv;
1917
1918   switch (GST_EVENT_TYPE (event)) {
1919     case GST_EVENT_FLUSH_START:
1920       break;
1921     case GST_EVENT_FLUSH_STOP:
1922       GST_OBJECT_LOCK (trans);
1923       /* reset QoS parameters */
1924       priv->proportion = 1.0;
1925       priv->earliest_time = -1;
1926       priv->discont = FALSE;
1927       priv->processed = 0;
1928       priv->dropped = 0;
1929       GST_OBJECT_UNLOCK (trans);
1930       /* we need new segment info after the flush. */
1931       trans->have_segment = FALSE;
1932       gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
1933       priv->position_out = GST_CLOCK_TIME_NONE;
1934       break;
1935     case GST_EVENT_EOS:
1936       break;
1937     case GST_EVENT_TAG:
1938       break;
1939     case GST_EVENT_CAPS:
1940     {
1941       GstCaps *caps;
1942
1943       gst_event_parse_caps (event, &caps);
1944       /* clear any pending reconfigure flag */
1945       gst_pad_check_reconfigure (trans->srcpad);
1946       ret = gst_base_transform_setcaps (trans, trans->sinkpad, caps);
1947       if (!ret)
1948         gst_pad_mark_reconfigure (trans->srcpad);
1949
1950       forward = FALSE;
1951       break;
1952     }
1953     case GST_EVENT_SEGMENT:
1954     {
1955       gst_event_copy_segment (event, &trans->segment);
1956       trans->have_segment = TRUE;
1957
1958       GST_DEBUG_OBJECT (trans, "received SEGMENT %" GST_SEGMENT_FORMAT,
1959           &trans->segment);
1960       break;
1961     }
1962     default:
1963       break;
1964   }
1965
1966   if (ret && forward)
1967     ret = gst_pad_push_event (trans->srcpad, event);
1968   else
1969     gst_event_unref (event);
1970
1971   return ret;
1972 }
1973
1974 static gboolean
1975 gst_base_transform_src_event (GstPad * pad, GstObject * parent,
1976     GstEvent * event)
1977 {
1978   GstBaseTransform *trans;
1979   GstBaseTransformClass *bclass;
1980   gboolean ret = TRUE;
1981
1982   trans = GST_BASE_TRANSFORM (parent);
1983   bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
1984
1985   if (bclass->src_event)
1986     ret = bclass->src_event (trans, event);
1987   else
1988     gst_event_unref (event);
1989
1990   return ret;
1991 }
1992
1993 static gboolean
1994 gst_base_transform_src_eventfunc (GstBaseTransform * trans, GstEvent * event)
1995 {
1996   gboolean ret;
1997
1998   GST_DEBUG_OBJECT (trans, "handling event %p %" GST_PTR_FORMAT, event, event);
1999
2000   switch (GST_EVENT_TYPE (event)) {
2001     case GST_EVENT_SEEK:
2002       break;
2003     case GST_EVENT_NAVIGATION:
2004       break;
2005     case GST_EVENT_QOS:
2006     {
2007       gdouble proportion;
2008       GstClockTimeDiff diff;
2009       GstClockTime timestamp;
2010
2011       gst_event_parse_qos (event, NULL, &proportion, &diff, &timestamp);
2012       gst_base_transform_update_qos (trans, proportion, diff, timestamp);
2013       break;
2014     }
2015     default:
2016       break;
2017   }
2018
2019   ret = gst_pad_push_event (trans->sinkpad, event);
2020
2021   return ret;
2022 }
2023
2024 /* Takes the input buffer */
2025 static GstFlowReturn
2026 default_submit_input_buffer (GstBaseTransform * trans, gboolean is_discont,
2027     GstBuffer * inbuf)
2028 {
2029   GstBaseTransformClass *bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2030   GstBaseTransformPrivate *priv = trans->priv;
2031   GstFlowReturn ret = GST_FLOW_OK;
2032   GstClockTime running_time;
2033   GstClockTime timestamp;
2034
2035   if (G_UNLIKELY (!gst_base_transform_reconfigure (trans)))
2036     goto not_negotiated;
2037
2038   if (GST_BUFFER_OFFSET_IS_VALID (inbuf))
2039     GST_DEBUG_OBJECT (trans,
2040         "handling buffer %p of size %" G_GSIZE_FORMAT ", PTS %" GST_TIME_FORMAT
2041         " and offset %" G_GUINT64_FORMAT, inbuf, gst_buffer_get_size (inbuf),
2042         GST_TIME_ARGS (GST_BUFFER_PTS (inbuf)), GST_BUFFER_OFFSET (inbuf));
2043   else
2044     GST_DEBUG_OBJECT (trans,
2045         "handling buffer %p of size %" G_GSIZE_FORMAT ", PTS %" GST_TIME_FORMAT
2046         " and offset NONE", inbuf, gst_buffer_get_size (inbuf),
2047         GST_TIME_ARGS (GST_BUFFER_PTS (inbuf)));
2048
2049   /* Don't allow buffer handling before negotiation, except in passthrough mode
2050    * or if the class doesn't implement a set_caps function (in which case it doesn't
2051    * care about caps)
2052    */
2053   if (!priv->negotiated && !priv->passthrough && (bclass->set_caps != NULL))
2054     goto not_negotiated;
2055
2056   /* can only do QoS if the segment is in TIME */
2057   if (trans->segment.format != GST_FORMAT_TIME)
2058     goto no_qos;
2059
2060   /* QOS is done on the running time of the buffer, get it now */
2061   timestamp = GST_BUFFER_TIMESTAMP (inbuf);
2062   running_time = gst_segment_to_running_time (&trans->segment, GST_FORMAT_TIME,
2063       timestamp);
2064
2065   if (running_time != -1) {
2066     gboolean need_skip;
2067     GstClockTime earliest_time;
2068     gdouble proportion;
2069
2070     /* lock for getting the QoS parameters that are set (in a different thread)
2071      * with the QOS events */
2072     GST_OBJECT_LOCK (trans);
2073     earliest_time = priv->earliest_time;
2074     proportion = priv->proportion;
2075     /* check for QoS, don't perform conversion for buffers
2076      * that are known to be late. */
2077     need_skip = priv->qos_enabled &&
2078         earliest_time != -1 && running_time <= earliest_time;
2079     GST_OBJECT_UNLOCK (trans);
2080
2081     if (need_skip) {
2082       GstMessage *qos_msg;
2083       GstClockTime duration;
2084       guint64 stream_time;
2085       gint64 jitter;
2086
2087       GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "skipping transform: qostime %"
2088           GST_TIME_FORMAT " <= %" GST_TIME_FORMAT,
2089           GST_TIME_ARGS (running_time), GST_TIME_ARGS (earliest_time));
2090
2091       priv->dropped++;
2092
2093       duration = GST_BUFFER_DURATION (inbuf);
2094       stream_time =
2095           gst_segment_to_stream_time (&trans->segment, GST_FORMAT_TIME,
2096           timestamp);
2097       jitter = GST_CLOCK_DIFF (running_time, earliest_time);
2098
2099       qos_msg =
2100           gst_message_new_qos (GST_OBJECT_CAST (trans), FALSE, running_time,
2101           stream_time, timestamp, duration);
2102       gst_message_set_qos_values (qos_msg, jitter, proportion, 1000000);
2103       gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS,
2104           priv->processed, priv->dropped);
2105       gst_element_post_message (GST_ELEMENT_CAST (trans), qos_msg);
2106
2107       /* mark discont for next buffer */
2108       priv->discont = TRUE;
2109       ret = GST_BASE_TRANSFORM_FLOW_DROPPED;
2110       goto skip;
2111     }
2112   }
2113
2114 no_qos:
2115   /* Stash input buffer where the default generate_output
2116    * function can find it */
2117   if (trans->queued_buf)
2118     gst_buffer_unref (trans->queued_buf);
2119   trans->queued_buf = inbuf;
2120   return ret;
2121 skip:
2122   gst_buffer_unref (inbuf);
2123   return ret;
2124
2125 not_negotiated:
2126   {
2127     gst_buffer_unref (inbuf);
2128     if (GST_PAD_IS_FLUSHING (trans->srcpad))
2129       return GST_FLOW_FLUSHING;
2130     return GST_FLOW_NOT_NEGOTIATED;
2131   }
2132 }
2133
2134 static GstFlowReturn
2135 default_generate_output (GstBaseTransform * trans, GstBuffer ** outbuf)
2136 {
2137   GstBaseTransformClass *bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2138   GstBaseTransformPrivate *priv = trans->priv;
2139   GstFlowReturn ret = GST_FLOW_OK;
2140   GstBuffer *inbuf;
2141   gboolean want_in_place;
2142
2143   /* Retrieve stashed input buffer, if the default submit_input_buffer
2144    * was run. Takes ownership back from there */
2145   inbuf = trans->queued_buf;
2146   trans->queued_buf = NULL;
2147
2148   /* This default processing method needs one input buffer to feed to
2149    * the transform functions, we can't do anything without it */
2150   if (inbuf == NULL)
2151     return GST_FLOW_OK;
2152
2153   /* first try to allocate an output buffer based on the currently negotiated
2154    * format. outbuf will contain a buffer suitable for doing the configured
2155    * transform after this function. */
2156   if (bclass->prepare_output_buffer == NULL)
2157     goto no_prepare;
2158
2159   GST_DEBUG_OBJECT (trans, "calling prepare buffer");
2160   ret = bclass->prepare_output_buffer (trans, inbuf, outbuf);
2161
2162   if (ret != GST_FLOW_OK || *outbuf == NULL)
2163     goto no_buffer;
2164
2165   GST_DEBUG_OBJECT (trans, "using allocated buffer in %p, out %p", inbuf,
2166       *outbuf);
2167
2168   /* now perform the needed transform */
2169   if (priv->passthrough) {
2170     /* In passthrough mode, give transform_ip a look at the
2171      * buffer, without making it writable, or just push the
2172      * data through */
2173     if (bclass->transform_ip_on_passthrough && bclass->transform_ip) {
2174       GST_DEBUG_OBJECT (trans, "doing passthrough transform_ip");
2175       ret = bclass->transform_ip (trans, *outbuf);
2176     } else {
2177       GST_DEBUG_OBJECT (trans, "element is in passthrough");
2178     }
2179   } else {
2180     want_in_place = (bclass->transform_ip != NULL) && priv->always_in_place;
2181
2182     if (want_in_place) {
2183       GST_DEBUG_OBJECT (trans, "doing inplace transform");
2184       ret = bclass->transform_ip (trans, *outbuf);
2185     } else {
2186       GST_DEBUG_OBJECT (trans, "doing non-inplace transform");
2187
2188       if (bclass->transform)
2189         ret = bclass->transform (trans, inbuf, *outbuf);
2190       else
2191         ret = GST_FLOW_NOT_SUPPORTED;
2192     }
2193   }
2194
2195   /* only unref input buffer if we allocated a new outbuf buffer. If we reused
2196    * the input buffer, no refcount is changed to keep the input buffer writable
2197    * when needed. */
2198   if (*outbuf != inbuf)
2199     gst_buffer_unref (inbuf);
2200
2201   return ret;
2202
2203   /* ERRORS */
2204 no_prepare:
2205   {
2206     gst_buffer_unref (inbuf);
2207     GST_ELEMENT_ERROR (trans, STREAM, NOT_IMPLEMENTED,
2208         ("Sub-class has no prepare_output_buffer implementation"), (NULL));
2209     return GST_FLOW_NOT_SUPPORTED;
2210   }
2211 no_buffer:
2212   {
2213     gst_buffer_unref (inbuf);
2214     *outbuf = NULL;
2215     GST_WARNING_OBJECT (trans, "could not get buffer from pool: %s",
2216         gst_flow_get_name (ret));
2217     return ret;
2218   }
2219 }
2220
2221 /* FIXME, getrange is broken, need to pull range from the other
2222  * end based on the transform_size result.
2223  */
2224 static GstFlowReturn
2225 gst_base_transform_getrange (GstPad * pad, GstObject * parent, guint64 offset,
2226     guint length, GstBuffer ** buffer)
2227 {
2228   GstBaseTransformClass *klass = GST_BASE_TRANSFORM_GET_CLASS (parent);
2229   GstBaseTransform *trans = GST_BASE_TRANSFORM (parent);
2230   GstBaseTransformPrivate *priv = trans->priv;
2231   GstFlowReturn ret;
2232   GstBuffer *inbuf = NULL;
2233   GstBuffer *outbuf = NULL;
2234
2235   /* Try and generate a buffer, if the sub-class wants more data,
2236    * pull some and repeat until a buffer (or error) is produced */
2237   do {
2238     ret = klass->generate_output (trans, &outbuf);
2239
2240     /* Consume the DROPPED return value and go get more data */
2241     if (ret == GST_BASE_TRANSFORM_FLOW_DROPPED)
2242       ret = GST_FLOW_OK;
2243
2244     if (ret != GST_FLOW_OK || outbuf != NULL)
2245       break;
2246
2247     /* No buffer generated, try and pull data */
2248     ret = gst_pad_pull_range (trans->sinkpad, offset, length, &inbuf);
2249     if (G_UNLIKELY (ret != GST_FLOW_OK))
2250       goto pull_error;
2251
2252     if (klass->before_transform)
2253       klass->before_transform (trans, inbuf);
2254
2255     /* Set discont flag so we can mark the next outgoing buffer */
2256     if (GST_BUFFER_IS_DISCONT (inbuf)) {
2257       GST_DEBUG_OBJECT (trans, "got DISCONT buffer %p", inbuf);
2258       priv->discont = TRUE;
2259     }
2260
2261     /* FIXME: Input offsets and lengths need to be translated, as per
2262      * the FIXME above. For now, just advance somewhat */
2263     offset += gst_buffer_get_size (inbuf);
2264
2265     ret = klass->submit_input_buffer (trans, priv->discont, inbuf);
2266     if (ret != GST_FLOW_OK) {
2267       if (ret == GST_BASE_TRANSFORM_FLOW_DROPPED)
2268         ret = GST_FLOW_OK;
2269       goto done;
2270     }
2271   } while (ret == GST_FLOW_OK && outbuf == NULL);
2272
2273   *buffer = outbuf;
2274   if (outbuf) {
2275     /* apply DISCONT flag if the buffer is not yet marked as such */
2276     if (priv->discont) {
2277       GST_DEBUG_OBJECT (trans, "we have a pending DISCONT");
2278       if (!GST_BUFFER_IS_DISCONT (outbuf)) {
2279         GST_DEBUG_OBJECT (trans, "marking DISCONT on output buffer");
2280         outbuf = gst_buffer_make_writable (outbuf);
2281         GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
2282       }
2283       priv->discont = FALSE;
2284     }
2285     priv->processed++;
2286   }
2287 done:
2288   return ret;
2289
2290   /* ERRORS */
2291 pull_error:
2292   {
2293     GST_DEBUG_OBJECT (trans, "failed to pull a buffer: %s",
2294         gst_flow_get_name (ret));
2295     goto done;
2296   }
2297 }
2298
2299 /* The flow of the chain function is the reverse of the
2300  * getrange() function - we have data, feed it to the sub-class
2301  * and then iterate, pushing buffers it generates until it either
2302  * wants more data or returns an error */
2303 static GstFlowReturn
2304 gst_base_transform_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
2305 {
2306   GstBaseTransform *trans = GST_BASE_TRANSFORM (parent);
2307   GstBaseTransformClass *klass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2308   GstBaseTransformPrivate *priv = trans->priv;
2309   GstFlowReturn ret;
2310   GstClockTime position = GST_CLOCK_TIME_NONE;
2311   GstClockTime timestamp, duration;
2312   GstBuffer *outbuf = NULL;
2313
2314   timestamp = GST_BUFFER_TIMESTAMP (buffer);
2315   duration = GST_BUFFER_DURATION (buffer);
2316
2317   /* calculate end position of the incoming buffer */
2318   if (timestamp != GST_CLOCK_TIME_NONE) {
2319     if (duration != GST_CLOCK_TIME_NONE)
2320       position = timestamp + duration;
2321     else
2322       position = timestamp;
2323   }
2324
2325   if (klass->before_transform)
2326     klass->before_transform (trans, buffer);
2327
2328   /* Set discont flag so we can mark the outgoing buffer */
2329   if (GST_BUFFER_IS_DISCONT (buffer)) {
2330     GST_DEBUG_OBJECT (trans, "got DISCONT buffer %p", buffer);
2331     priv->discont = TRUE;
2332   }
2333
2334   /* Takes ownership of input buffer */
2335   ret = klass->submit_input_buffer (trans, priv->discont, buffer);
2336   if (ret != GST_FLOW_OK)
2337     goto done;
2338
2339   do {
2340     outbuf = NULL;
2341
2342     ret = klass->generate_output (trans, &outbuf);
2343
2344     /* outbuf can be NULL, this means a dropped buffer, if we have a buffer but
2345      * GST_BASE_TRANSFORM_FLOW_DROPPED we will not push either. */
2346     if (outbuf != NULL) {
2347       if (ret == GST_FLOW_OK) {
2348         GstClockTime position_out = GST_CLOCK_TIME_NONE;
2349
2350         /* Remember last stop position */
2351         if (position != GST_CLOCK_TIME_NONE &&
2352             trans->segment.format == GST_FORMAT_TIME)
2353           trans->segment.position = position;
2354
2355         if (GST_BUFFER_TIMESTAMP_IS_VALID (outbuf)) {
2356           position_out = GST_BUFFER_TIMESTAMP (outbuf);
2357           if (GST_BUFFER_DURATION_IS_VALID (outbuf))
2358             position_out += GST_BUFFER_DURATION (outbuf);
2359         } else if (position != GST_CLOCK_TIME_NONE) {
2360           position_out = position;
2361         }
2362         if (position_out != GST_CLOCK_TIME_NONE
2363             && trans->segment.format == GST_FORMAT_TIME)
2364           priv->position_out = position_out;
2365
2366         /* apply DISCONT flag if the buffer is not yet marked as such */
2367         if (trans->priv->discont) {
2368           GST_DEBUG_OBJECT (trans, "we have a pending DISCONT");
2369           if (!GST_BUFFER_IS_DISCONT (outbuf)) {
2370             GST_DEBUG_OBJECT (trans, "marking DISCONT on output buffer");
2371             outbuf = gst_buffer_make_writable (outbuf);
2372             GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
2373           }
2374           priv->discont = FALSE;
2375         }
2376         priv->processed++;
2377
2378         ret = gst_pad_push (trans->srcpad, outbuf);
2379       } else {
2380         GST_DEBUG_OBJECT (trans, "we got return %s", gst_flow_get_name (ret));
2381         gst_buffer_unref (outbuf);
2382       }
2383     }
2384   } while (ret == GST_FLOW_OK && outbuf != NULL);
2385
2386 done:
2387   /* convert internal flow to OK and mark discont for the next buffer. */
2388   if (ret == GST_BASE_TRANSFORM_FLOW_DROPPED) {
2389     GST_DEBUG_OBJECT (trans, "dropped a buffer, marking DISCONT");
2390     priv->discont = TRUE;
2391     ret = GST_FLOW_OK;
2392   }
2393
2394   return ret;
2395 }
2396
2397 static void
2398 gst_base_transform_set_property (GObject * object, guint prop_id,
2399     const GValue * value, GParamSpec * pspec)
2400 {
2401   GstBaseTransform *trans;
2402
2403   trans = GST_BASE_TRANSFORM (object);
2404
2405   switch (prop_id) {
2406     case PROP_QOS:
2407       gst_base_transform_set_qos_enabled (trans, g_value_get_boolean (value));
2408       break;
2409     default:
2410       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2411       break;
2412   }
2413 }
2414
2415 static void
2416 gst_base_transform_get_property (GObject * object, guint prop_id,
2417     GValue * value, GParamSpec * pspec)
2418 {
2419   GstBaseTransform *trans;
2420
2421   trans = GST_BASE_TRANSFORM (object);
2422
2423   switch (prop_id) {
2424     case PROP_QOS:
2425       g_value_set_boolean (value, gst_base_transform_is_qos_enabled (trans));
2426       break;
2427     default:
2428       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2429       break;
2430   }
2431 }
2432
2433 /* not a vmethod of anything, just an internal method */
2434 static gboolean
2435 gst_base_transform_activate (GstBaseTransform * trans, gboolean active)
2436 {
2437   GstBaseTransformClass *bclass;
2438   GstBaseTransformPrivate *priv = trans->priv;
2439   gboolean result = TRUE;
2440
2441   bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2442
2443   if (active) {
2444     GstCaps *incaps, *outcaps;
2445
2446     if (priv->pad_mode == GST_PAD_MODE_NONE && bclass->start)
2447       result &= bclass->start (trans);
2448
2449     incaps = gst_pad_get_current_caps (trans->sinkpad);
2450     outcaps = gst_pad_get_current_caps (trans->srcpad);
2451
2452     GST_OBJECT_LOCK (trans);
2453     if (incaps && outcaps)
2454       priv->have_same_caps =
2455           gst_caps_is_equal (incaps, outcaps) || priv->passthrough;
2456     else
2457       priv->have_same_caps = priv->passthrough;
2458     GST_DEBUG_OBJECT (trans, "have_same_caps %d", priv->have_same_caps);
2459     priv->negotiated = FALSE;
2460     trans->have_segment = FALSE;
2461     gst_segment_init (&trans->segment, GST_FORMAT_UNDEFINED);
2462     priv->position_out = GST_CLOCK_TIME_NONE;
2463     priv->proportion = 1.0;
2464     priv->earliest_time = -1;
2465     priv->discont = FALSE;
2466     priv->processed = 0;
2467     priv->dropped = 0;
2468     GST_OBJECT_UNLOCK (trans);
2469
2470     if (incaps)
2471       gst_caps_unref (incaps);
2472     if (outcaps)
2473       gst_caps_unref (outcaps);
2474   } else {
2475     /* We must make sure streaming has finished before resetting things
2476      * and calling the ::stop vfunc */
2477     GST_PAD_STREAM_LOCK (trans->sinkpad);
2478     GST_PAD_STREAM_UNLOCK (trans->sinkpad);
2479
2480     priv->have_same_caps = FALSE;
2481     /* We can only reset the passthrough mode if the instance told us to 
2482        handle it in configure_caps */
2483     if (bclass->passthrough_on_same_caps) {
2484       gst_base_transform_set_passthrough (trans, FALSE);
2485     }
2486     gst_caps_replace (&priv->cache_caps1, NULL);
2487     gst_caps_replace (&priv->cache_caps2, NULL);
2488
2489     /* Make sure any left over buffer is freed */
2490     gst_buffer_replace (&trans->queued_buf, NULL);
2491
2492     if (priv->pad_mode != GST_PAD_MODE_NONE && bclass->stop)
2493       result &= bclass->stop (trans);
2494
2495     gst_base_transform_set_allocation (trans, NULL, NULL, NULL, NULL);
2496   }
2497
2498   return result;
2499 }
2500
2501 static gboolean
2502 gst_base_transform_sink_activate_mode (GstPad * pad, GstObject * parent,
2503     GstPadMode mode, gboolean active)
2504 {
2505   gboolean result = FALSE;
2506   GstBaseTransform *trans;
2507
2508   trans = GST_BASE_TRANSFORM (parent);
2509
2510   switch (mode) {
2511     case GST_PAD_MODE_PUSH:
2512     {
2513       result = gst_base_transform_activate (trans, active);
2514
2515       if (result)
2516         trans->priv->pad_mode = active ? GST_PAD_MODE_PUSH : GST_PAD_MODE_NONE;
2517
2518       break;
2519     }
2520     default:
2521       result = TRUE;
2522       break;
2523   }
2524   return result;
2525 }
2526
2527 static gboolean
2528 gst_base_transform_src_activate_mode (GstPad * pad, GstObject * parent,
2529     GstPadMode mode, gboolean active)
2530 {
2531   gboolean result = FALSE;
2532   GstBaseTransform *trans;
2533
2534   trans = GST_BASE_TRANSFORM (parent);
2535
2536   switch (mode) {
2537     case GST_PAD_MODE_PULL:
2538     {
2539       result =
2540           gst_pad_activate_mode (trans->sinkpad, GST_PAD_MODE_PULL, active);
2541
2542       if (result)
2543         result &= gst_base_transform_activate (trans, active);
2544
2545       if (result)
2546         trans->priv->pad_mode = active ? mode : GST_PAD_MODE_NONE;
2547       break;
2548     }
2549     default:
2550       result = TRUE;
2551       break;
2552   }
2553
2554   return result;
2555 }
2556
2557 /**
2558  * gst_base_transform_set_passthrough:
2559  * @trans: the #GstBaseTransform to set
2560  * @passthrough: boolean indicating passthrough mode.
2561  *
2562  * Set passthrough mode for this filter by default. This is mostly
2563  * useful for filters that do not care about negotiation.
2564  *
2565  * Always %TRUE for filters which don't implement either a transform
2566  * or transform_ip method.
2567  *
2568  * MT safe.
2569  */
2570 void
2571 gst_base_transform_set_passthrough (GstBaseTransform * trans,
2572     gboolean passthrough)
2573 {
2574   GstBaseTransformClass *bclass;
2575
2576   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2577
2578   bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2579
2580   GST_OBJECT_LOCK (trans);
2581   if (!passthrough) {
2582     if (bclass->transform_ip || bclass->transform)
2583       trans->priv->passthrough = FALSE;
2584   } else {
2585     trans->priv->passthrough = TRUE;
2586   }
2587
2588   GST_DEBUG_OBJECT (trans, "set passthrough %d", trans->priv->passthrough);
2589   GST_OBJECT_UNLOCK (trans);
2590 }
2591
2592 /**
2593  * gst_base_transform_is_passthrough:
2594  * @trans: the #GstBaseTransform to query
2595  *
2596  * See if @trans is configured as a passthrough transform.
2597  *
2598  * Returns: %TRUE is the transform is configured in passthrough mode.
2599  *
2600  * MT safe.
2601  */
2602 gboolean
2603 gst_base_transform_is_passthrough (GstBaseTransform * trans)
2604 {
2605   gboolean result;
2606
2607   g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2608
2609   GST_OBJECT_LOCK (trans);
2610   result = trans->priv->passthrough;
2611   GST_OBJECT_UNLOCK (trans);
2612
2613   return result;
2614 }
2615
2616 /**
2617  * gst_base_transform_set_in_place:
2618  * @trans: the #GstBaseTransform to modify
2619  * @in_place: Boolean value indicating that we would like to operate
2620  * on in_place buffers.
2621  *
2622  * Determines whether a non-writable buffer will be copied before passing
2623  * to the transform_ip function.
2624  * <itemizedlist>
2625  *   <listitem>Always %TRUE if no transform function is implemented.</listitem>
2626  *   <listitem>Always %FALSE if ONLY transform function is implemented.</listitem>
2627  * </itemizedlist>
2628  *
2629  * MT safe.
2630  */
2631 void
2632 gst_base_transform_set_in_place (GstBaseTransform * trans, gboolean in_place)
2633 {
2634   GstBaseTransformClass *bclass;
2635
2636   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2637
2638   bclass = GST_BASE_TRANSFORM_GET_CLASS (trans);
2639
2640   GST_OBJECT_LOCK (trans);
2641
2642   if (in_place) {
2643     if (bclass->transform_ip) {
2644       GST_DEBUG_OBJECT (trans, "setting in_place TRUE");
2645       trans->priv->always_in_place = TRUE;
2646     }
2647   } else {
2648     if (bclass->transform) {
2649       GST_DEBUG_OBJECT (trans, "setting in_place FALSE");
2650       trans->priv->always_in_place = FALSE;
2651     }
2652   }
2653
2654   GST_OBJECT_UNLOCK (trans);
2655 }
2656
2657 /**
2658  * gst_base_transform_is_in_place:
2659  * @trans: the #GstBaseTransform to query
2660  *
2661  * See if @trans is configured as a in_place transform.
2662  *
2663  * Returns: %TRUE is the transform is configured in in_place mode.
2664  *
2665  * MT safe.
2666  */
2667 gboolean
2668 gst_base_transform_is_in_place (GstBaseTransform * trans)
2669 {
2670   gboolean result;
2671
2672   g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2673
2674   GST_OBJECT_LOCK (trans);
2675   result = trans->priv->always_in_place;
2676   GST_OBJECT_UNLOCK (trans);
2677
2678   return result;
2679 }
2680
2681 /**
2682  * gst_base_transform_update_qos:
2683  * @trans: a #GstBaseTransform
2684  * @proportion: the proportion
2685  * @diff: the diff against the clock
2686  * @timestamp: the timestamp of the buffer generating the QoS expressed in
2687  * running_time.
2688  *
2689  * Set the QoS parameters in the transform. This function is called internally
2690  * when a QOS event is received but subclasses can provide custom information
2691  * when needed.
2692  *
2693  * MT safe.
2694  */
2695 void
2696 gst_base_transform_update_qos (GstBaseTransform * trans,
2697     gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp)
2698 {
2699   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2700
2701   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans,
2702       "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2703       GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (timestamp));
2704
2705   GST_OBJECT_LOCK (trans);
2706   trans->priv->proportion = proportion;
2707   trans->priv->earliest_time = timestamp + diff;
2708   GST_OBJECT_UNLOCK (trans);
2709 }
2710
2711 /**
2712  * gst_base_transform_set_qos_enabled:
2713  * @trans: a #GstBaseTransform
2714  * @enabled: new state
2715  *
2716  * Enable or disable QoS handling in the transform.
2717  *
2718  * MT safe.
2719  */
2720 void
2721 gst_base_transform_set_qos_enabled (GstBaseTransform * trans, gboolean enabled)
2722 {
2723   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2724
2725   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, trans, "enabled: %d", enabled);
2726
2727   GST_OBJECT_LOCK (trans);
2728   trans->priv->qos_enabled = enabled;
2729   GST_OBJECT_UNLOCK (trans);
2730 }
2731
2732 /**
2733  * gst_base_transform_is_qos_enabled:
2734  * @trans: a #GstBaseTransform
2735  *
2736  * Queries if the transform will handle QoS.
2737  *
2738  * Returns: %TRUE if QoS is enabled.
2739  *
2740  * MT safe.
2741  */
2742 gboolean
2743 gst_base_transform_is_qos_enabled (GstBaseTransform * trans)
2744 {
2745   gboolean result;
2746
2747   g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2748
2749   GST_OBJECT_LOCK (trans);
2750   result = trans->priv->qos_enabled;
2751   GST_OBJECT_UNLOCK (trans);
2752
2753   return result;
2754 }
2755
2756 /**
2757  * gst_base_transform_set_gap_aware:
2758  * @trans: a #GstBaseTransform
2759  * @gap_aware: New state
2760  *
2761  * If @gap_aware is %FALSE (the default), output buffers will have the
2762  * %GST_BUFFER_FLAG_GAP flag unset.
2763  *
2764  * If set to %TRUE, the element must handle output buffers with this flag set
2765  * correctly, i.e. it can assume that the buffer contains neutral data but must
2766  * unset the flag if the output is no neutral data.
2767  *
2768  * MT safe.
2769  */
2770 void
2771 gst_base_transform_set_gap_aware (GstBaseTransform * trans, gboolean gap_aware)
2772 {
2773   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2774
2775   GST_OBJECT_LOCK (trans);
2776   trans->priv->gap_aware = gap_aware;
2777   GST_DEBUG_OBJECT (trans, "set gap aware %d", trans->priv->gap_aware);
2778   GST_OBJECT_UNLOCK (trans);
2779 }
2780
2781 /**
2782  * gst_base_transform_set_prefer_passthrough:
2783  * @trans: a #GstBaseTransform
2784  * @prefer_passthrough: New state
2785  *
2786  * If @prefer_passthrough is %TRUE (the default), @trans will check and
2787  * prefer passthrough caps from the list of caps returned by the
2788  * transform_caps vmethod.
2789  *
2790  * If set to %FALSE, the element must order the caps returned from the
2791  * transform_caps function in such a way that the preferred format is
2792  * first in the list. This can be interesting for transforms that can do
2793  * passthrough transforms but prefer to do something else, like a
2794  * capsfilter.
2795  *
2796  * MT safe.
2797  *
2798  * Since: 1.0.1
2799  */
2800 void
2801 gst_base_transform_set_prefer_passthrough (GstBaseTransform * trans,
2802     gboolean prefer_passthrough)
2803 {
2804   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2805
2806   GST_OBJECT_LOCK (trans);
2807   trans->priv->prefer_passthrough = prefer_passthrough;
2808   GST_DEBUG_OBJECT (trans, "prefer passthrough %d", prefer_passthrough);
2809   GST_OBJECT_UNLOCK (trans);
2810 }
2811
2812 /**
2813  * gst_base_transform_reconfigure_sink:
2814  * @trans: a #GstBaseTransform
2815  *
2816  * Instructs @trans to request renegotiation upstream. This function is
2817  * typically called after properties on the transform were set that
2818  * influence the input format.
2819  */
2820 void
2821 gst_base_transform_reconfigure_sink (GstBaseTransform * trans)
2822 {
2823   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2824
2825   /* push the renegotiate event */
2826   if (!gst_pad_push_event (GST_BASE_TRANSFORM_SINK_PAD (trans),
2827           gst_event_new_reconfigure ()))
2828     GST_DEBUG_OBJECT (trans, "Renegotiate event wasn't handled");
2829 }
2830
2831 /**
2832  * gst_base_transform_reconfigure_src:
2833  * @trans: a #GstBaseTransform
2834  *
2835  * Instructs @trans to renegotiate a new downstream transform on the next
2836  * buffer. This function is typically called after properties on the transform
2837  * were set that influence the output format.
2838  */
2839 void
2840 gst_base_transform_reconfigure_src (GstBaseTransform * trans)
2841 {
2842   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2843
2844   gst_pad_mark_reconfigure (trans->srcpad);
2845 }
2846
2847 /**
2848  * gst_base_transform_get_buffer_pool:
2849  * @trans: a #GstBaseTransform
2850  *
2851  * Returns: (transfer full): the instance of the #GstBufferPool used
2852  * by @trans; free it after use it
2853  */
2854 GstBufferPool *
2855 gst_base_transform_get_buffer_pool (GstBaseTransform * trans)
2856 {
2857   g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), NULL);
2858
2859   if (trans->priv->pool)
2860     return gst_object_ref (trans->priv->pool);
2861
2862   return NULL;
2863 }
2864
2865 /**
2866  * gst_base_transform_get_allocator:
2867  * @trans: a #GstBaseTransform
2868  * @allocator: (out) (allow-none) (transfer full): the #GstAllocator
2869  * used
2870  * @params: (out) (allow-none) (transfer full): the
2871  * #GstAllocationParams of @allocator
2872  *
2873  * Lets #GstBaseTransform sub-classes to know the memory @allocator
2874  * used by the base class and its @params.
2875  *
2876  * Unref the @allocator after use it.
2877  */
2878 void
2879 gst_base_transform_get_allocator (GstBaseTransform * trans,
2880     GstAllocator ** allocator, GstAllocationParams * params)
2881 {
2882   g_return_if_fail (GST_IS_BASE_TRANSFORM (trans));
2883
2884   if (allocator)
2885     *allocator = trans->priv->allocator ?
2886         gst_object_ref (trans->priv->allocator) : NULL;
2887
2888   if (params)
2889     *params = trans->priv->params;
2890 }
2891
2892 /**
2893  * gst_base_transform_update_src_caps:
2894  * @trans: a #GstBaseTransform
2895  * @updated_caps: An updated version of the srcpad caps to be pushed
2896  * downstream
2897  *
2898  * Updates the srcpad caps and send the caps downstream. This function
2899  * can be used by subclasses when they have already negotiated their caps
2900  * but found a change in them (or computed new informations). This way,
2901  * they can notify downstream about that change without loosing any
2902  * buffer.
2903  *
2904  * Returns: %TRUE if the caps could be send downstream %FALSE otherwise
2905  *
2906  * Since: 1.6
2907  */
2908 gboolean
2909 gst_base_transform_update_src_caps (GstBaseTransform * trans,
2910     GstCaps * updated_caps)
2911 {
2912   g_return_val_if_fail (GST_IS_BASE_TRANSFORM (trans), FALSE);
2913
2914   if (gst_pad_push_event (GST_BASE_TRANSFORM_SRC_PAD (trans),
2915           gst_event_new_caps (updated_caps))) {
2916     gst_pad_mark_reconfigure (trans->srcpad);
2917
2918     return TRUE;
2919   }
2920
2921   return FALSE;
2922 }