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