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