gst/adder/gstadder.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2001 Thomas <thomas@apestaart.org>
   4  *               2005,2006 Wim Taymans <wim@fluendo.com>
   5  *
   6  * adder.c: Adder element, N in, one out, samples are added
   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  * SECTION:element-adder
  25  *
  26  * The adder allows to mix several streams into one by adding the data.
  27  * Mixed data is clamped to the min/max values of the data format.
  28  *
  29  * The adder currently mixes all data received on the sinkpads as soon as
  30  * possible without trying to synchronize the streams.
  31  *
  32  * <refsect2>
  33  * <title>Example launch line</title>
  34  * |[
  35  * gst-launch audiotestsrc freq=100 ! adder name=mix ! audioconvert ! alsasink audiotestsrc freq=500 ! mix.
  36  * ]| This pipeline produces two sine waves mixed together.
  37  * </refsect2>
  38  *
  39  * Last reviewed on 2006-05-09 (0.10.7)
  40  */
  41 /* Element-Checklist-Version: 5 */
  42
  43 #ifdef HAVE_CONFIG_H
  44 #include "config.h"
  45 #endif
  46 #include "gstadder.h"
  47 #include <gst/audio/audio.h>
  48 #include <string.h>             /* strcmp */
  49 /*#include <liboil/liboil.h>*/
  50
  51 /* highest positive/lowest negative x-bit value we can use for clamping */
  52 #define MAX_INT_32  ((gint32) (0x7fffffff))
  53 #define MAX_INT_16  ((gint16) (0x7fff))
  54 #define MAX_INT_8   ((gint8)  (0x7f))
  55 #define MAX_UINT_32 ((guint32)(0xffffffff))
  56 #define MAX_UINT_16 ((guint16)(0xffff))
  57 #define MAX_UINT_8  ((guint8) (0xff))
  58
  59 #define MIN_INT_32  ((gint32) (0x80000000))
  60 #define MIN_INT_16  ((gint16) (0x8000))
  61 #define MIN_INT_8   ((gint8)  (0x80))
  62 #define MIN_UINT_32 ((guint32)(0x00000000))
  63 #define MIN_UINT_16 ((guint16)(0x0000))
  64 #define MIN_UINT_8  ((guint8) (0x00))
  65
  66 #define GST_CAT_DEFAULT gst_adder_debug
  67 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  68
  69 /* elementfactory information */
  70
  71 #define CAPS \
  72   "audio/x-raw-int, " \
  73   "rate = (int) [ 1, MAX ], " \
  74   "channels = (int) [ 1, MAX ], " \
  75   "endianness = (int) BYTE_ORDER, " \
  76   "width = (int) 32, " \
  77   "depth = (int) 32, " \
  78   "signed = (boolean) { true, false } ;" \
  79   "audio/x-raw-int, " \
  80   "rate = (int) [ 1, MAX ], " \
  81   "channels = (int) [ 1, MAX ], " \
  82   "endianness = (int) BYTE_ORDER, " \
  83   "width = (int) 16, " \
  84   "depth = (int) 16, " \
  85   "signed = (boolean) { true, false } ;" \
  86   "audio/x-raw-int, " \
  87   "rate = (int) [ 1, MAX ], " \
  88   "channels = (int) [ 1, MAX ], " \
  89   "endianness = (int) BYTE_ORDER, " \
  90   "width = (int) 8, " \
  91   "depth = (int) 8, " \
  92   "signed = (boolean) { true, false } ;" \
  93   "audio/x-raw-float, " \
  94   "rate = (int) [ 1, MAX ], " \
  95   "channels = (int) [ 1, MAX ], " \
  96   "endianness = (int) BYTE_ORDER, " \
  97   "width = (int) { 32, 64 }"
  98
  99 static GstStaticPadTemplate gst_adder_src_template =
 100 GST_STATIC_PAD_TEMPLATE ("src",
 101     GST_PAD_SRC,
 102     GST_PAD_ALWAYS,
 103     GST_STATIC_CAPS (CAPS)
 104     );
 105
 106 static GstStaticPadTemplate gst_adder_sink_template =
 107 GST_STATIC_PAD_TEMPLATE ("sink%d",
 108     GST_PAD_SINK,
 109     GST_PAD_REQUEST,
 110     GST_STATIC_CAPS (CAPS)
 111     );
 112
 113 static void gst_adder_class_init (GstAdderClass * klass);
 114 static void gst_adder_init (GstAdder * adder);
 115 static void gst_adder_finalize (GObject * object);
 116
 117 static gboolean gst_adder_setcaps (GstPad * pad, GstCaps * caps);
 118 static gboolean gst_adder_query (GstPad * pad, GstQuery * query);
 119 static gboolean gst_adder_src_event (GstPad * pad, GstEvent * event);
 120 static gboolean gst_adder_sink_event (GstPad * pad, GstEvent * event);
 121
 122 static GstPad *gst_adder_request_new_pad (GstElement * element,
 123     GstPadTemplate * temp, const gchar * unused);
 124 static void gst_adder_release_pad (GstElement * element, GstPad * pad);
 125
 126 static GstStateChangeReturn gst_adder_change_state (GstElement * element,
 127     GstStateChange transition);
 128
 129 static GstFlowReturn gst_adder_collected (GstCollectPads * pads,
 130     gpointer user_data);
 131
 132 static GstElementClass *parent_class = NULL;
 133
 134 GType
 135 gst_adder_get_type (void)
 136 {
 137   static GType adder_type = 0;
 138
 139   if (G_UNLIKELY (adder_type == 0)) {
 140     static const GTypeInfo adder_info = {
 141       sizeof (GstAdderClass), NULL, NULL,
 142       (GClassInitFunc) gst_adder_class_init, NULL, NULL,
 143       sizeof (GstAdder), 0,
 144       (GInstanceInitFunc) gst_adder_init,
 145     };
 146
 147     adder_type = g_type_register_static (GST_TYPE_ELEMENT, "GstAdder",
 148         &adder_info, 0);
 149     GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "adder", 0,
 150         "audio channel mixing element");
 151   }
 152   return adder_type;
 153 }
 154
 155 /* clipping versions (for int)
 156  * FIXME: what about: oil_add_s16 (out, out, in, bytes / sizeof (type))
 157  */
 158 #define MAKE_FUNC(name,type,ttype,min,max)                      \
 159 static void name (type *out, type *in, gint bytes) {            \
 160   gint i;                                                       \
 161   ttype add;                                                    \
 162   for (i = 0; i < bytes / sizeof (type); i++) {                 \
 163     add = (ttype)out[i] + (ttype)in[i];                         \
 164     out[i] = CLAMP (add, min, max);                             \
 165   }                                                             \
 166 }
 167
 168 /* unsigned versions (for int) */
 169 #define MAKE_FUNC_US(name,type,ttype,max)                       \
 170 static void name (type *out, type *in, gint bytes) {            \
 171   gint i;                                                       \
 172   ttype add;                                                    \
 173   for (i = 0; i < bytes / sizeof (type); i++) {                 \
 174     add = (ttype)out[i] + (ttype)in[i];                         \
 175     out[i] = ((add <= max) ? add : max);                        \
 176   }                                                             \
 177 }
 178
 179 /* non-clipping versions (for float) */
 180 #define MAKE_FUNC_NC(name,type)                                 \
 181 static void name (type *out, type *in, gint bytes) {            \
 182   gint i;                                                       \
 183   for (i = 0; i < bytes / sizeof (type); i++)                   \
 184     out[i] += in[i];                                            \
 185 }
 186
 187 #if 0
 188 /* right now, the liboil function don't seems to be faster on x86
 189  * time gst-launch audiotestsrc num-buffers=50000 ! audio/x-raw-float ! adder name=m ! fakesink audiotestsrc num-buffers=50000 ! audio/x-raw-float ! m.
 190  * time gst-launch audiotestsrc num-buffers=50000 ! audio/x-raw-float,width=32 ! adder name=m ! fakesink audiotestsrc num-buffers=50000 ! audio/x-raw-float,width=32 ! m.
 191  */
 192 static void
 193 add_float32 (gfloat * out, gfloat * in, gint bytes)
 194 {
 195   oil_add_f32 (out, out, in, bytes / sizeof (gfloat));
 196 }
 197
 198 static void
 199 add_float64 (gdouble * out, gdouble * in, gint bytes)
 200 {
 201   oil_add_f64 (out, out, in, bytes / sizeof (gdouble));
 202 }
 203 #endif
 204
 205 /* *INDENT-OFF* */
 206 MAKE_FUNC (add_int32, gint32, gint64, MIN_INT_32, MAX_INT_32)
 207 MAKE_FUNC (add_int16, gint16, gint32, MIN_INT_16, MAX_INT_16)
 208 MAKE_FUNC (add_int8, gint8, gint16, MIN_INT_8, MAX_INT_8)
 209 MAKE_FUNC_US (add_uint32, guint32, guint64, MAX_UINT_32)
 210 MAKE_FUNC_US (add_uint16, guint16, guint32, MAX_UINT_16)
 211 MAKE_FUNC_US (add_uint8, guint8, guint16, MAX_UINT_8)
 212 MAKE_FUNC_NC (add_float64, gdouble)
 213 MAKE_FUNC_NC (add_float32, gfloat)
 214 /* *INDENT-ON* */
 215
 216 /* we can only accept caps that we and downstream can handle. */
 217 static GstCaps *
 218 gst_adder_sink_getcaps (GstPad * pad)
 219 {
 220   GstAdder *adder;
 221   GstCaps *result, *peercaps, *sinkcaps;
 222
 223   adder = GST_ADDER (GST_PAD_PARENT (pad));
 224
 225   GST_OBJECT_LOCK (adder);
 226   /* get the downstream possible caps */
 227   peercaps = gst_pad_peer_get_caps (adder->srcpad);
 228   /* get the allowed caps on this sinkpad, we use the fixed caps function so
 229    * that it does not call recursively in this function. */
 230   sinkcaps = gst_pad_get_fixed_caps_func (pad);
 231   if (peercaps) {
 232     /* if the peer has caps, intersect */
 233     GST_DEBUG_OBJECT (adder, "intersecting peer and template caps");
 234     result = gst_caps_intersect (peercaps, sinkcaps);
 235     gst_caps_unref (peercaps);
 236     gst_caps_unref (sinkcaps);
 237   } else {
 238     /* the peer has no caps (or there is no peer), just use the allowed caps
 239      * of this sinkpad. */
 240     GST_DEBUG_OBJECT (adder, "no peer caps, using sinkcaps");
 241     result = sinkcaps;
 242   }
 243   GST_OBJECT_UNLOCK (adder);
 244
 245   GST_LOG_OBJECT (adder, "getting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
 246       GST_PAD_NAME (pad), result);
 247
 248   return result;
 249 }
 250
 251 /* the first caps we receive on any of the sinkpads will define the caps for all
 252  * the other sinkpads because we can only mix streams with the same caps.
 253  * */
 254 static gboolean
 255 gst_adder_setcaps (GstPad * pad, GstCaps * caps)
 256 {
 257   GstAdder *adder;
 258   GList *pads;
 259   GstStructure *structure;
 260   const char *media_type;
 261
 262   adder = GST_ADDER (GST_PAD_PARENT (pad));
 263
 264   GST_LOG_OBJECT (adder, "setting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
 265       GST_PAD_NAME (pad), caps);
 266
 267   /* FIXME, see if the other pads can accept the format. Also lock the
 268    * format on the other pads to this new format. */
 269   GST_OBJECT_LOCK (adder);
 270   pads = GST_ELEMENT (adder)->pads;
 271   while (pads) {
 272     GstPad *otherpad = GST_PAD (pads->data);
 273
 274     if (otherpad != pad) {
 275       gst_caps_replace (&GST_PAD_CAPS (otherpad), caps);
 276     }
 277     pads = g_list_next (pads);
 278   }
 279   GST_OBJECT_UNLOCK (adder);
 280
 281   /* parse caps now */
 282   structure = gst_caps_get_structure (caps, 0);
 283   media_type = gst_structure_get_name (structure);
 284   if (strcmp (media_type, "audio/x-raw-int") == 0) {
 285     adder->format = GST_ADDER_FORMAT_INT;
 286     gst_structure_get_int (structure, "width", &adder->width);
 287     gst_structure_get_int (structure, "depth", &adder->depth);
 288     gst_structure_get_int (structure, "endianness", &adder->endianness);
 289     gst_structure_get_boolean (structure, "signed", &adder->is_signed);
 290
 291     GST_INFO_OBJECT (pad, "parse_caps sets adder to format int, %d bit",
 292         adder->width);
 293
 294     if (adder->endianness != G_BYTE_ORDER)
 295       goto not_supported;
 296
 297     switch (adder->width) {
 298       case 8:
 299         adder->func = (adder->is_signed ?
 300             (GstAdderFunction) add_int8 : (GstAdderFunction) add_uint8);
 301         break;
 302       case 16:
 303         adder->func = (adder->is_signed ?
 304             (GstAdderFunction) add_int16 : (GstAdderFunction) add_uint16);
 305         break;
 306       case 32:
 307         adder->func = (adder->is_signed ?
 308             (GstAdderFunction) add_int32 : (GstAdderFunction) add_uint32);
 309         break;
 310       default:
 311         goto not_supported;
 312     }
 313   } else if (strcmp (media_type, "audio/x-raw-float") == 0) {
 314     adder->format = GST_ADDER_FORMAT_FLOAT;
 315     gst_structure_get_int (structure, "width", &adder->width);
 316     gst_structure_get_int (structure, "endianness", &adder->endianness);
 317
 318     GST_INFO_OBJECT (pad, "parse_caps sets adder to format float, %d bit",
 319         adder->width);
 320
 321     if (adder->endianness != G_BYTE_ORDER)
 322       goto not_supported;
 323
 324     switch (adder->width) {
 325       case 32:
 326         adder->func = (GstAdderFunction) add_float32;
 327         break;
 328       case 64:
 329         adder->func = (GstAdderFunction) add_float64;
 330         break;
 331       default:
 332         goto not_supported;
 333     }
 334   } else {
 335     goto not_supported;
 336   }
 337
 338   gst_structure_get_int (structure, "channels", &adder->channels);
 339   gst_structure_get_int (structure, "rate", &adder->rate);
 340   /* precalc bps */
 341   adder->bps = (adder->width / 8) * adder->channels;
 342
 343   return TRUE;
 344
 345   /* ERRORS */
 346 not_supported:
 347   {
 348     GST_DEBUG_OBJECT (adder, "unsupported format set as caps");
 349     return FALSE;
 350   }
 351 }
 352
 353 /* FIXME, the duration query should reflect how long you will produce
 354  * data, that is the amount of stream time until you will emit EOS.
 355  *
 356  * For synchronized mixing this is always the max of all the durations
 357  * of upstream since we emit EOS when all of them finished.
 358  *
 359  * We don't do synchronized mixing so this really depends on where the
 360  * streams where punched in and what their relative offsets are against
 361  * eachother which we can get from the first timestamps we see.
 362  *
 363  * When we add a new stream (or remove a stream) the duration might
 364  * also become invalid again and we need to post a new DURATION
 365  * message to notify this fact to the parent.
 366  * For now we take the max of all the upstream elements so the simple
 367  * cases work at least somewhat.
 368  */
 369 static gboolean
 370 gst_adder_query_duration (GstAdder * adder, GstQuery * query)
 371 {
 372   gint64 max;
 373   gboolean res;
 374   GstFormat format;
 375   GstIterator *it;
 376   gboolean done;
 377
 378   /* parse format */
 379   gst_query_parse_duration (query, &format, NULL);
 380
 381   max = -1;
 382   res = TRUE;
 383   done = FALSE;
 384
 385   it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
 386   while (!done) {
 387     GstIteratorResult ires;
 388
 389     gpointer item;
 390
 391     ires = gst_iterator_next (it, &item);
 392     switch (ires) {
 393       case GST_ITERATOR_DONE:
 394         done = TRUE;
 395         break;
 396       case GST_ITERATOR_OK:
 397       {
 398         GstPad *pad = GST_PAD_CAST (item);
 399
 400         gint64 duration;
 401
 402         /* ask sink peer for duration */
 403         res &= gst_pad_query_peer_duration (pad, &format, &duration);
 404         /* take max from all valid return values */
 405         if (res) {
 406           /* valid unknown length, stop searching */
 407           if (duration == -1) {
 408             max = duration;
 409             done = TRUE;
 410           }
 411           /* else see if bigger than current max */
 412           else if (duration > max)
 413             max = duration;
 414         }
 415         gst_object_unref (pad);
 416         break;
 417       }
 418       case GST_ITERATOR_RESYNC:
 419         max = -1;
 420         res = TRUE;
 421         gst_iterator_resync (it);
 422         break;
 423       default:
 424         res = FALSE;
 425         done = TRUE;
 426         break;
 427     }
 428   }
 429   gst_iterator_free (it);
 430
 431   if (res) {
 432     /* and store the max */
 433     GST_DEBUG_OBJECT (adder, "Total duration in format %s: %"
 434         GST_TIME_FORMAT, gst_format_get_name (format), GST_TIME_ARGS (max));
 435     gst_query_set_duration (query, format, max);
 436   }
 437
 438   return res;
 439 }
 440
 441 static gboolean
 442 gst_adder_query_latency (GstAdder * adder, GstQuery * query)
 443 {
 444   GstClockTime min, max;
 445   gboolean live;
 446   gboolean res;
 447   GstIterator *it;
 448   gboolean done;
 449
 450   res = TRUE;
 451   done = FALSE;
 452
 453   live = FALSE;
 454   min = 0;
 455   max = GST_CLOCK_TIME_NONE;
 456
 457   /* Take maximum of all latency values */
 458   it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
 459   while (!done) {
 460     GstIteratorResult ires;
 461
 462     gpointer item;
 463
 464     ires = gst_iterator_next (it, &item);
 465     switch (ires) {
 466       case GST_ITERATOR_DONE:
 467         done = TRUE;
 468         break;
 469       case GST_ITERATOR_OK:
 470       {
 471         GstPad *pad = GST_PAD_CAST (item);
 472         GstQuery *peerquery;
 473         GstClockTime min_cur, max_cur;
 474         gboolean live_cur;
 475
 476         peerquery = gst_query_new_latency ();
 477
 478         /* Ask peer for latency */
 479         res &= gst_pad_peer_query (pad, peerquery);
 480
 481         /* take max from all valid return values */
 482         if (res) {
 483           gst_query_parse_latency (peerquery, &live_cur, &min_cur, &max_cur);
 484
 485           if (min_cur > min)
 486             min = min_cur;
 487
 488           if (max_cur != GST_CLOCK_TIME_NONE &&
 489               ((max != GST_CLOCK_TIME_NONE && max_cur > max) ||
 490                   (max == GST_CLOCK_TIME_NONE)))
 491             max = max_cur;
 492
 493           live = live || live_cur;
 494         }
 495
 496         gst_query_unref (peerquery);
 497         gst_object_unref (pad);
 498         break;
 499       }
 500       case GST_ITERATOR_RESYNC:
 501         live = FALSE;
 502         min = 0;
 503         max = GST_CLOCK_TIME_NONE;
 504         res = TRUE;
 505         gst_iterator_resync (it);
 506         break;
 507       default:
 508         res = FALSE;
 509         done = TRUE;
 510         break;
 511     }
 512   }
 513   gst_iterator_free (it);
 514
 515   if (res) {
 516     /* store the results */
 517     GST_DEBUG_OBJECT (adder, "Calculated total latency: live %s, min %"
 518         GST_TIME_FORMAT ", max %" GST_TIME_FORMAT,
 519         (live ? "yes" : "no"), GST_TIME_ARGS (min), GST_TIME_ARGS (max));
 520     gst_query_set_latency (query, live, min, max);
 521   }
 522
 523   return res;
 524 }
 525
 526 static gboolean
 527 gst_adder_query (GstPad * pad, GstQuery * query)
 528 {
 529   GstAdder *adder = GST_ADDER (gst_pad_get_parent (pad));
 530   gboolean res = FALSE;
 531
 532   switch (GST_QUERY_TYPE (query)) {
 533     case GST_QUERY_POSITION:
 534     {
 535       GstFormat format;
 536
 537       gst_query_parse_position (query, &format, NULL);
 538
 539       switch (format) {
 540         case GST_FORMAT_TIME:
 541           /* FIXME, bring to stream time, might be tricky */
 542           gst_query_set_position (query, format, adder->timestamp);
 543           res = TRUE;
 544           break;
 545         case GST_FORMAT_DEFAULT:
 546           gst_query_set_position (query, format, adder->offset);
 547           res = TRUE;
 548           break;
 549         default:
 550           break;
 551       }
 552       break;
 553     }
 554     case GST_QUERY_DURATION:
 555       res = gst_adder_query_duration (adder, query);
 556       break;
 557     case GST_QUERY_LATENCY:
 558       res = gst_adder_query_latency (adder, query);
 559       break;
 560     default:
 561       /* FIXME, needs a custom query handler because we have multiple
 562        * sinkpads */
 563       res = gst_pad_query_default (pad, query);
 564       break;
 565   }
 566
 567   gst_object_unref (adder);
 568   return res;
 569 }
 570
 571 static gboolean
 572 forward_event_func (GstPad * pad, GValue * ret, GstEvent * event)
 573 {
 574   gst_event_ref (event);
 575   GST_LOG_OBJECT (pad, "About to send event %s", GST_EVENT_TYPE_NAME (event));
 576   if (!gst_pad_push_event (pad, event)) {
 577     g_value_set_boolean (ret, FALSE);
 578     GST_WARNING_OBJECT (pad, "Sending event  %p (%s) failed.",
 579         event, GST_EVENT_TYPE_NAME (event));
 580   } else {
 581     GST_LOG_OBJECT (pad, "Sent event  %p (%s).",
 582         event, GST_EVENT_TYPE_NAME (event));
 583   }
 584   gst_object_unref (pad);
 585   /* continue on other pads, even if one failed */
 586   return TRUE;
 587 }
 588
 589 /* forwards the event to all sinkpads, takes ownership of the
 590  * event
 591  *
 592  * Returns: TRUE if the event could be forwarded on all
 593  * sinkpads.
 594  */
 595 static gboolean
 596 forward_event (GstAdder * adder, GstEvent * event)
 597 {
 598   gboolean ret;
 599   GstIterator *it;
 600   GstIteratorResult ires;
 601   GValue vret = { 0 };
 602
 603   GST_LOG_OBJECT (adder, "Forwarding event %p (%s)", event,
 604       GST_EVENT_TYPE_NAME (event));
 605
 606   ret = TRUE;
 607
 608   g_value_init (&vret, G_TYPE_BOOLEAN);
 609   g_value_set_boolean (&vret, TRUE);
 610   it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
 611   while (TRUE) {
 612     ires = gst_iterator_fold (it, (GstIteratorFoldFunction) forward_event_func,
 613         &vret, event);
 614     switch (ires) {
 615       case GST_ITERATOR_RESYNC:
 616         GST_WARNING ("resync");
 617         gst_iterator_resync (it);
 618         g_value_set_boolean (&vret, TRUE);
 619         break;
 620       case GST_ITERATOR_OK:
 621       case GST_ITERATOR_DONE:
 622         ret = g_value_get_boolean (&vret);
 623         goto done;
 624       default:
 625         ret = FALSE;
 626         goto done;
 627     }
 628   }
 629 done:
 630   gst_iterator_free (it);
 631   GST_LOG_OBJECT (adder, "Forwarded event %p (%s), ret=%d", event,
 632       GST_EVENT_TYPE_NAME (event), ret);
 633   gst_event_unref (event);
 634
 635   return ret;
 636 }
 637
 638 static gboolean
 639 gst_adder_src_event (GstPad * pad, GstEvent * event)
 640 {
 641   GstAdder *adder;
 642   gboolean result;
 643
 644   adder = GST_ADDER (gst_pad_get_parent (pad));
 645
 646   switch (GST_EVENT_TYPE (event)) {
 647     case GST_EVENT_SEEK:
 648     {
 649       GstSeekFlags flags;
 650       GstSeekType curtype;
 651       gint64 cur;
 652
 653       /* parse the seek parameters */
 654       gst_event_parse_seek (event, &adder->segment_rate, NULL, &flags, &curtype,
 655           &cur, NULL, NULL);
 656
 657       /* check if we are flushing */
 658       if (flags & GST_SEEK_FLAG_FLUSH) {
 659         /* make sure we accept nothing anymore and return WRONG_STATE */
 660         gst_collect_pads_set_flushing (adder->collect, TRUE);
 661
 662         /* flushing seek, start flush downstream, the flush will be done
 663          * when all pads received a FLUSH_STOP. */
 664         gst_pad_push_event (adder->srcpad, gst_event_new_flush_start ());
 665       }
 666       GST_DEBUG_OBJECT (adder, "handling seek event: %" GST_PTR_FORMAT, event);
 667       /* now wait for the collected to be finished and mark a new
 668        * segment */
 669       GST_OBJECT_LOCK (adder->collect);
 670       if (curtype == GST_SEEK_TYPE_SET)
 671         adder->segment_position = cur;
 672       else
 673         adder->segment_position = 0;
 674       adder->segment_pending = TRUE;
 675       GST_OBJECT_UNLOCK (adder->collect);
 676       GST_DEBUG_OBJECT (adder, "forwarding seek event: %" GST_PTR_FORMAT,
 677           event);
 678
 679       result = forward_event (adder, event);
 680       if (result) {
 681         /* seek failed. maybe source is a live source. send a flush_stop
 682          * FIXME: ideally we just forward flush event, but live sources don't
 683          * send anything and we need a flush events to unlock the collect
 684          * function
 685          */
 686         adder->flush_stop_pending =
 687             ((flags & GST_SEEK_FLAG_FLUSH) == GST_SEEK_FLAG_FLUSH);
 688       }
 689       break;
 690     }
 691     case GST_EVENT_QOS:
 692       /* QoS might be tricky */
 693       result = FALSE;
 694       break;
 695     case GST_EVENT_NAVIGATION:
 696       /* navigation is rather pointless. */
 697       result = FALSE;
 698       break;
 699     default:
 700       /* just forward the rest for now */
 701       GST_DEBUG_OBJECT (adder, "forward unhandled event: %s",
 702           GST_EVENT_TYPE_NAME (event));
 703       result = forward_event (adder, event);
 704       break;
 705   }
 706   gst_object_unref (adder);
 707
 708   return result;
 709 }
 710
 711 static gboolean
 712 gst_adder_sink_event (GstPad * pad, GstEvent * event)
 713 {
 714   GstAdder *adder;
 715   gboolean ret;
 716
 717   adder = GST_ADDER (gst_pad_get_parent (pad));
 718
 719   GST_DEBUG ("Got %s event on pad %s:%s", GST_EVENT_TYPE_NAME (event),
 720       GST_DEBUG_PAD_NAME (pad));
 721
 722   switch (GST_EVENT_TYPE (event)) {
 723     case GST_EVENT_FLUSH_STOP:
 724       /* mark a pending new segment. This event is synchronized
 725        * with the streaming thread so we can safely update the
 726        * variable without races. It's somewhat weird because we
 727        * assume the collectpads forwarded the FLUSH_STOP past us
 728        * and downstream (using our source pad, the bastard!).
 729        */
 730       adder->segment_pending = TRUE;
 731       adder->flush_stop_pending = FALSE;
 732       break;
 733     default:
 734       break;
 735   }
 736
 737   /* now GstCollectPads can take care of the rest, e.g. EOS */
 738   ret = adder->collect_event (pad, event);
 739
 740   gst_object_unref (adder);
 741   return ret;
 742 }
 743
 744 static void
 745 gst_adder_class_init (GstAdderClass * klass)
 746 {
 747   GObjectClass *gobject_class = (GObjectClass *) klass;
 748   GstElementClass *gstelement_class = (GstElementClass *) klass;
 749
 750   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_adder_finalize);
 751
 752   gst_element_class_add_pad_template (gstelement_class,
 753       gst_static_pad_template_get (&gst_adder_src_template));
 754   gst_element_class_add_pad_template (gstelement_class,
 755       gst_static_pad_template_get (&gst_adder_sink_template));
 756   gst_element_class_set_details_simple (gstelement_class, "Adder",
 757       "Generic/Audio",
 758       "Add N audio channels together",
 759       "Thomas Vander Stichele <thomas at apestaart dot org>");
 760
 761   parent_class = g_type_class_peek_parent (klass);
 762
 763   gstelement_class->request_new_pad =
 764       GST_DEBUG_FUNCPTR (gst_adder_request_new_pad);
 765   gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_adder_release_pad);
 766   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_adder_change_state);
 767 }
 768
 769 static void
 770 gst_adder_init (GstAdder * adder)
 771 {
 772   GstPadTemplate *template;
 773
 774   template = gst_static_pad_template_get (&gst_adder_src_template);
 775   adder->srcpad = gst_pad_new_from_template (template, "src");
 776   gst_object_unref (template);
 777
 778   gst_pad_set_getcaps_function (adder->srcpad,
 779       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 780   gst_pad_set_setcaps_function (adder->srcpad,
 781       GST_DEBUG_FUNCPTR (gst_adder_setcaps));
 782   gst_pad_set_query_function (adder->srcpad,
 783       GST_DEBUG_FUNCPTR (gst_adder_query));
 784   gst_pad_set_event_function (adder->srcpad,
 785       GST_DEBUG_FUNCPTR (gst_adder_src_event));
 786   gst_element_add_pad (GST_ELEMENT (adder), adder->srcpad);
 787
 788   adder->format = GST_ADDER_FORMAT_UNSET;
 789   adder->padcount = 0;
 790   adder->func = NULL;
 791
 792   /* keep track of the sinkpads requested */
 793   adder->collect = gst_collect_pads_new ();
 794   gst_collect_pads_set_function (adder->collect,
 795       GST_DEBUG_FUNCPTR (gst_adder_collected), adder);
 796 }
 797
 798 static void
 799 gst_adder_finalize (GObject * object)
 800 {
 801   GstAdder *adder = GST_ADDER (object);
 802
 803   gst_object_unref (adder->collect);
 804   adder->collect = NULL;
 805
 806   G_OBJECT_CLASS (parent_class)->finalize (object);
 807 }
 808
 809 static GstPad *
 810 gst_adder_request_new_pad (GstElement * element, GstPadTemplate * templ,
 811     const gchar * unused)
 812 {
 813   gchar *name;
 814   GstAdder *adder;
 815   GstPad *newpad;
 816   gint padcount;
 817
 818   if (templ->direction != GST_PAD_SINK)
 819     goto not_sink;
 820
 821   adder = GST_ADDER (element);
 822
 823   /* increment pad counter */
 824   padcount = g_atomic_int_exchange_and_add (&adder->padcount, 1);
 825
 826   name = g_strdup_printf ("sink%d", padcount);
 827   newpad = gst_pad_new_from_template (templ, name);
 828   GST_DEBUG_OBJECT (adder, "request new pad %s", name);
 829   g_free (name);
 830
 831   gst_pad_set_getcaps_function (newpad,
 832       GST_DEBUG_FUNCPTR (gst_adder_sink_getcaps));
 833   gst_pad_set_setcaps_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_setcaps));
 834   gst_collect_pads_add_pad (adder->collect, newpad, sizeof (GstCollectData));
 835
 836   /* FIXME: hacked way to override/extend the event function of
 837    * GstCollectPads; because it sets its own event function giving the
 838    * element no access to events */
 839   adder->collect_event = (GstPadEventFunction) GST_PAD_EVENTFUNC (newpad);
 840   gst_pad_set_event_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_event));
 841
 842   /* takes ownership of the pad */
 843   if (!gst_element_add_pad (GST_ELEMENT (adder), newpad))
 844     goto could_not_add;
 845
 846   return newpad;
 847
 848   /* errors */
 849 not_sink:
 850   {
 851     g_warning ("gstadder: request new pad that is not a SINK pad\n");
 852     return NULL;
 853   }
 854 could_not_add:
 855   {
 856     GST_DEBUG_OBJECT (adder, "could not add pad");
 857     gst_collect_pads_remove_pad (adder->collect, newpad);
 858     gst_object_unref (newpad);
 859     return NULL;
 860   }
 861 }
 862
 863 static void
 864 gst_adder_release_pad (GstElement * element, GstPad * pad)
 865 {
 866   GstAdder *adder;
 867
 868   adder = GST_ADDER (element);
 869
 870   GST_DEBUG_OBJECT (adder, "release pad %s:%s", GST_DEBUG_PAD_NAME (pad));
 871
 872   gst_collect_pads_remove_pad (adder->collect, pad);
 873   gst_element_remove_pad (element, pad);
 874 }
 875
 876 static GstFlowReturn
 877 gst_adder_collected (GstCollectPads * pads, gpointer user_data)
 878 {
 879   /*
 880    * combine streams by adding data values
 881    * basic algorithm :
 882    * - this function is called when all pads have a buffer
 883    * - get available bytes on all pads.
 884    * - repeat for each input pad :
 885    *   - read available bytes, copy or add to target buffer
 886    *   - if there's an EOS event, remove the input channel
 887    * - push out the output buffer
 888    *
 889    * todo:
 890    * - would be nice to have a mixing mode, where instead of adding we mix
 891    *   - for float we could downscale after collect loop
 892    *   - for int we need to downscale each input to avoid clipping or
 893    *     mix into a temp (float) buffer and scale afterwards as well
 894    */
 895   GstAdder *adder;
 896   GSList *collected;
 897   GstFlowReturn ret;
 898   GstBuffer *outbuf = NULL;
 899   gpointer outdata = NULL;
 900   guint outsize;
 901   gboolean empty = TRUE;
 902
 903   adder = GST_ADDER (user_data);
 904
 905   /* this is fatal */
 906   if (G_UNLIKELY (adder->func == NULL))
 907     goto not_negotiated;
 908
 909   /* get available bytes for reading, this can be 0 which could mean empty
 910    * buffers or EOS, which we will catch when we loop over the pads. */
 911   outsize = gst_collect_pads_available (pads);
 912
 913   GST_LOG_OBJECT (adder,
 914       "starting to cycle through channels, %d bytes available (bps = %d)",
 915       outsize, adder->bps);
 916
 917   for (collected = pads->data; collected; collected = g_slist_next (collected)) {
 918     GstCollectData *collect_data;
 919     GstBuffer *inbuf;
 920     guint8 *indata;
 921     guint insize;
 922
 923     collect_data = (GstCollectData *) collected->data;
 924
 925     /* get a subbuffer of size bytes */
 926     inbuf = gst_collect_pads_take_buffer (pads, collect_data, outsize);
 927     /* NULL means EOS or an empty buffer so we still need to flush in
 928      * case of an empty buffer. */
 929     if (inbuf == NULL) {
 930       GST_LOG_OBJECT (adder, "channel %p: no bytes available", collect_data);
 931       continue;
 932     }
 933
 934     indata = GST_BUFFER_DATA (inbuf);
 935     insize = GST_BUFFER_SIZE (inbuf);
 936
 937     if (outbuf == NULL) {
 938       GST_LOG_OBJECT (adder, "channel %p: making output buffer of %d bytes",
 939           collect_data, outsize);
 940
 941       /* first buffer, alloc outsize.
 942        * FIXME: we can easily subbuffer and _make_writable.
 943        * FIXME: only create empty buffer for first non-gap buffer, so that we
 944        * only use adder function when really adding
 945        */
 946       outbuf = gst_buffer_new_and_alloc (outsize);
 947       outdata = GST_BUFFER_DATA (outbuf);
 948       gst_buffer_set_caps (outbuf, GST_PAD_CAPS (adder->srcpad));
 949
 950       if (!GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP)) {
 951         GST_LOG_OBJECT (adder, "channel %p: copying %d bytes from data %p",
 952             collect_data, insize, indata);
 953         /* clear if we are only going to fill a partial buffer */
 954         if (G_UNLIKELY (outsize > insize))
 955           memset ((guint8 *) outdata + insize, 0, outsize - insize);
 956         /* and copy the data into it */
 957         memcpy (outdata, indata, insize);
 958         empty = FALSE;
 959       } else {
 960         /* clear whole buffer */
 961         GST_LOG_OBJECT (adder, "channel %p: zeroing %d bytes from data %p",
 962             collect_data, insize, indata);
 963         memset (outdata, 0, outsize);
 964       }
 965     } else {
 966       if (!GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP)) {
 967         GST_LOG_OBJECT (adder, "channel %p: mixing %d bytes from data %p",
 968             collect_data, insize, indata);
 969         /* further buffers, need to add them */
 970         adder->func ((gpointer) outdata, (gpointer) indata, insize);
 971         empty = FALSE;
 972       } else {
 973         GST_LOG_OBJECT (adder, "channel %p: skipping %d bytes from data %p",
 974             collect_data, insize, indata);
 975       }
 976     }
 977     gst_buffer_unref (inbuf);
 978   }
 979
 980   /* can only happen when no pads to collect or all EOS */
 981   if (outbuf == NULL)
 982     goto eos;
 983
 984   /* our timestamping is very simple, just an ever incrementing
 985    * counter, the new segment time will take care of their respective
 986    * stream time. */
 987   if (adder->segment_pending) {
 988     GstEvent *event;
 989
 990     /* FIXME, use rate/applied_rate as set on all sinkpads.
 991      * - currently we just set rate as received from last seek-event
 992      * We could potentially figure out the duration as well using
 993      * the current segment positions and the stated stop positions.
 994      * Also we just start from stream time 0 which is rather
 995      * weird. For non-synchronized mixing, the time should be
 996      * the min of the stream times of all received segments,
 997      * rationale being that the duration is at least going to
 998      * be as long as the earliest stream we start mixing. This
 999      * would also be correct for synchronized mixing but then
1000      * the later streams would be delayed until the stream times
1001      * match.
1002      */
1003     event = gst_event_new_new_segment_full (FALSE, adder->segment_rate,
1004         1.0, GST_FORMAT_TIME, adder->timestamp, -1, adder->segment_position);
1005
1006     if (event) {
1007       if (!gst_pad_push_event (adder->srcpad, event)) {
1008         GST_WARNING_OBJECT (adder->srcpad, "Sending event  %p (%s) failed.",
1009             event, GST_EVENT_TYPE_NAME (event));
1010       }
1011       adder->segment_pending = FALSE;
1012       adder->segment_position = 0;
1013     } else {
1014       GST_WARNING_OBJECT (adder->srcpad, "Creating new segment event for "
1015           "start:%" G_GINT64_FORMAT "  pos:%" G_GINT64_FORMAT " failed",
1016           adder->timestamp, adder->segment_position);
1017     }
1018   }
1019   if (adder->flush_stop_pending) {
1020     gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop ());
1021     adder->flush_stop_pending = FALSE;
1022   }
1023
1024   /* set timestamps on the output buffer */
1025   GST_BUFFER_TIMESTAMP (outbuf) = adder->timestamp;
1026   GST_BUFFER_OFFSET (outbuf) = adder->offset;
1027
1028   /* for the next timestamp, use the sample counter, which will
1029    * never accumulate rounding errors */
1030   adder->offset += outsize / adder->bps;
1031   adder->timestamp = gst_util_uint64_scale_int (adder->offset,
1032       GST_SECOND, adder->rate);
1033
1034   /* now we can set the duration of the buffer */
1035   GST_BUFFER_DURATION (outbuf) = adder->timestamp -
1036       GST_BUFFER_TIMESTAMP (outbuf);
1037
1038   /* if we only processed silence, mark output again as silence */
1039   if (empty)
1040     GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_GAP);
1041
1042   /* send it out */
1043   GST_LOG_OBJECT (adder, "pushing outbuf, timestamp %" GST_TIME_FORMAT,
1044       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)));
1045   ret = gst_pad_push (adder->srcpad, outbuf);
1046
1047   GST_LOG_OBJECT (adder, "pushed outbuf, result = %s", gst_flow_get_name (ret));
1048
1049   return ret;
1050
1051   /* ERRORS */
1052 not_negotiated:
1053   {
1054     GST_ELEMENT_ERROR (adder, STREAM, FORMAT, (NULL),
1055         ("Unknown data received, not negotiated"));
1056     return GST_FLOW_NOT_NEGOTIATED;
1057   }
1058 eos:
1059   {
1060     GST_DEBUG_OBJECT (adder, "no data available, must be EOS");
1061     gst_pad_push_event (adder->srcpad, gst_event_new_eos ());
1062     return GST_FLOW_UNEXPECTED;
1063   }
1064 }
1065
1066 static GstStateChangeReturn
1067 gst_adder_change_state (GstElement * element, GstStateChange transition)
1068 {
1069   GstAdder *adder;
1070   GstStateChangeReturn ret;
1071
1072   adder = GST_ADDER (element);
1073
1074   switch (transition) {
1075     case GST_STATE_CHANGE_NULL_TO_READY:
1076       break;
1077     case GST_STATE_CHANGE_READY_TO_PAUSED:
1078       adder->timestamp = 0;
1079       adder->offset = 0;
1080       adder->segment_pending = TRUE;
1081       adder->segment_position = 0;
1082       adder->segment_rate = 1.0;
1083       gst_segment_init (&adder->segment, GST_FORMAT_UNDEFINED);
1084       gst_collect_pads_start (adder->collect);
1085       break;
1086     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1087       break;
1088     case GST_STATE_CHANGE_PAUSED_TO_READY:
1089       /* need to unblock the collectpads before calling the
1090        * parent change_state so that streaming can finish */
1091       gst_collect_pads_stop (adder->collect);
1092       break;
1093     default:
1094       break;
1095   }
1096
1097   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1098
1099   switch (transition) {
1100     default:
1101       break;
1102   }
1103
1104   return ret;
1105 }
1106
1107
1108 static gboolean
1109 plugin_init (GstPlugin * plugin)
1110 {
1111   /*oil_init (); */
1112
1113   if (!gst_element_register (plugin, "adder", GST_RANK_NONE, GST_TYPE_ADDER)) {
1114     return FALSE;
1115   }
1116
1117   return TRUE;
1118 }
1119
1120 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1121     GST_VERSION_MINOR,
1122     "adder",
1123     "Adds multiple streams",
1124     plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)