plugins/elements/gstfunnel.c

   1 /*
   2  * GStreamer Funnel element
   3  *
   4  * Copyright 2007 Collabora Ltd.
   5  *  @author: Olivier Crete <olivier.crete@collabora.co.uk>
   6  * Copyright 2007 Nokia Corp.
   7  *
   8  * gstfunnel.c: Simple Funnel element
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  23  */
  24
  25 /**
  26  * SECTION:element-funnel
  27  *
  28  * Takes packets from various input sinks into one output source.
  29  *
  30  * funnel always outputs a single, open ended segment from
  31  * 0 with in %GST_FORMAT_TIME and outputs the buffers of the
  32  * different sinkpads with timestamps that are set to the
  33  * running time for that stream. funnel does not synchronize
  34  * the different input streams but simply forwards all buffers
  35  * immediately when they arrive.
  36  *
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include "config.h"
  41 #endif
  42
  43 #include "gstfunnel.h"
  44
  45 GST_DEBUG_CATEGORY_STATIC (gst_funnel_debug);
  46 #define GST_CAT_DEFAULT gst_funnel_debug
  47
  48 GType gst_funnel_pad_get_type (void);
  49 #define GST_TYPE_FUNNEL_PAD \
  50   (gst_funnel_pad_get_type())
  51 #define GST_FUNNEL_PAD(obj) \
  52   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_FUNNEL_PAD, GstFunnelPad))
  53 #define GST_FUNNEL_PAD_CLASS(klass) \
  54   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_FUNNEL_PAD, GstFunnelPadClass))
  55 #define GST_IS_FUNNEL_PAD(obj) \
  56   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_FUNNEL_PAD))
  57 #define GST_IS_FUNNEL_PAD_CLASS(klass) \
  58   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_FUNNEL_PAD))
  59 #define GST_FUNNEL_PAD_CAST(obj) \
  60   ((GstFunnelPad *)(obj))
  61
  62 typedef struct _GstFunnelPad GstFunnelPad;
  63 typedef struct _GstFunnelPadClass GstFunnelPadClass;
  64
  65 struct _GstFunnelPad
  66 {
  67   GstPad parent;
  68
  69   GstSegment segment;
  70 };
  71
  72 struct _GstFunnelPadClass
  73 {
  74   GstPadClass parent;
  75 };
  76
  77 G_DEFINE_TYPE (GstFunnelPad, gst_funnel_pad, GST_TYPE_PAD);
  78
  79 static void
  80 gst_funnel_pad_class_init (GstFunnelPadClass * klass)
  81 {
  82 }
  83
  84 static void
  85 gst_funnel_pad_reset (GstFunnelPad * pad)
  86 {
  87   gst_segment_init (&pad->segment, GST_FORMAT_UNDEFINED);
  88 }
  89
  90 static void
  91 gst_funnel_pad_init (GstFunnelPad * pad)
  92 {
  93   gst_funnel_pad_reset (pad);
  94 }
  95
  96 static GstStaticPadTemplate funnel_sink_template =
  97 GST_STATIC_PAD_TEMPLATE ("sink_%u",
  98     GST_PAD_SINK,
  99     GST_PAD_REQUEST,
 100     GST_STATIC_CAPS_ANY);
 101
 102 static GstStaticPadTemplate funnel_src_template =
 103 GST_STATIC_PAD_TEMPLATE ("src",
 104     GST_PAD_SRC,
 105     GST_PAD_ALWAYS,
 106     GST_STATIC_CAPS_ANY);
 107
 108 #define _do_init \
 109   GST_DEBUG_CATEGORY_INIT (gst_funnel_debug, "funnel", 0, "funnel element");
 110 #define gst_funnel_parent_class parent_class
 111 G_DEFINE_TYPE_WITH_CODE (GstFunnel, gst_funnel, GST_TYPE_ELEMENT, _do_init);
 112
 113 static GstStateChangeReturn gst_funnel_change_state (GstElement * element,
 114     GstStateChange transition);
 115 static GstPad *gst_funnel_request_new_pad (GstElement * element,
 116     GstPadTemplate * templ, const gchar * name, const GstCaps * caps);
 117 static void gst_funnel_release_pad (GstElement * element, GstPad * pad);
 118
 119 static GstFlowReturn gst_funnel_sink_chain (GstPad * pad, GstBuffer * buffer);
 120 static gboolean gst_funnel_sink_event (GstPad * pad, GstEvent * event);
 121 static gboolean gst_funnel_sink_query (GstPad * pad, GstQuery * query);
 122
 123 static gboolean gst_funnel_src_event (GstPad * pad, GstEvent * event);
 124
 125 static void
 126 gst_funnel_dispose (GObject * object)
 127 {
 128   GList *item;
 129
 130 restart:
 131   for (item = GST_ELEMENT_PADS (object); item; item = g_list_next (item)) {
 132     GstPad *pad = GST_PAD (item->data);
 133
 134     if (GST_PAD_IS_SINK (pad)) {
 135       gst_element_release_request_pad (GST_ELEMENT (object), pad);
 136       goto restart;
 137     }
 138   }
 139
 140   G_OBJECT_CLASS (parent_class)->dispose (object);
 141 }
 142
 143 static void
 144 gst_funnel_class_init (GstFunnelClass * klass)
 145 {
 146   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 147   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 148
 149   gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_funnel_dispose);
 150
 151   gst_element_class_set_details_simple (gstelement_class,
 152       "Funnel pipe fitting", "Generic", "N-to-1 pipe fitting",
 153       "Olivier Crete <olivier.crete@collabora.co.uk>");
 154
 155   gst_element_class_add_pad_template (gstelement_class,
 156       gst_static_pad_template_get (&funnel_sink_template));
 157   gst_element_class_add_pad_template (gstelement_class,
 158       gst_static_pad_template_get (&funnel_src_template));
 159
 160   gstelement_class->request_new_pad =
 161       GST_DEBUG_FUNCPTR (gst_funnel_request_new_pad);
 162   gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_funnel_release_pad);
 163   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_funnel_change_state);
 164 }
 165
 166 static void
 167 gst_funnel_init (GstFunnel * funnel)
 168 {
 169   funnel->srcpad = gst_pad_new_from_static_template (&funnel_src_template,
 170       "src");
 171   gst_pad_set_event_function (funnel->srcpad, gst_funnel_src_event);
 172   gst_pad_use_fixed_caps (funnel->srcpad);
 173   gst_element_add_pad (GST_ELEMENT (funnel), funnel->srcpad);
 174 }
 175
 176 static GstPad *
 177 gst_funnel_request_new_pad (GstElement * element, GstPadTemplate * templ,
 178     const gchar * name, const GstCaps * caps)
 179 {
 180   GstPad *sinkpad;
 181
 182   GST_DEBUG_OBJECT (element, "requesting pad");
 183
 184   sinkpad = GST_PAD_CAST (g_object_new (GST_TYPE_FUNNEL_PAD,
 185           "name", name, "direction", templ->direction, "template", templ,
 186           NULL));
 187
 188   gst_pad_set_chain_function (sinkpad,
 189       GST_DEBUG_FUNCPTR (gst_funnel_sink_chain));
 190   gst_pad_set_event_function (sinkpad,
 191       GST_DEBUG_FUNCPTR (gst_funnel_sink_event));
 192   gst_pad_set_query_function (sinkpad,
 193       GST_DEBUG_FUNCPTR (gst_funnel_sink_query));
 194
 195   gst_pad_set_active (sinkpad, TRUE);
 196
 197   gst_element_add_pad (element, sinkpad);
 198
 199   return sinkpad;
 200 }
 201
 202 static void
 203 gst_funnel_release_pad (GstElement * element, GstPad * pad)
 204 {
 205   GstFunnel *funnel = GST_FUNNEL (element);
 206
 207   GST_DEBUG_OBJECT (funnel, "releasing pad");
 208
 209   gst_pad_set_active (pad, FALSE);
 210
 211   gst_element_remove_pad (GST_ELEMENT_CAST (funnel), pad);
 212 }
 213
 214 static GstFlowReturn
 215 gst_funnel_sink_chain (GstPad * pad, GstBuffer * buffer)
 216 {
 217   GstFlowReturn res;
 218   GstFunnel *funnel = GST_FUNNEL (gst_pad_get_parent (pad));
 219   GstFunnelPad *fpad = GST_FUNNEL_PAD_CAST (pad);
 220   GstEvent *event = NULL;
 221   GstClockTime newts;
 222 #if 0
 223   GstCaps *padcaps;
 224 #endif
 225
 226   GST_DEBUG_OBJECT (funnel, "received buffer %p", buffer);
 227
 228   GST_OBJECT_LOCK (funnel);
 229   if (fpad->segment.format == GST_FORMAT_UNDEFINED) {
 230     GST_WARNING_OBJECT (funnel, "Got buffer without segment,"
 231         " setting segment [0,inf[");
 232     gst_segment_init (&fpad->segment, GST_FORMAT_TIME);
 233   }
 234
 235   if (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
 236     fpad->segment.position = GST_BUFFER_TIMESTAMP (buffer);
 237
 238   newts = gst_segment_to_running_time (&fpad->segment,
 239       fpad->segment.format, GST_BUFFER_TIMESTAMP (buffer));
 240   if (newts != GST_BUFFER_TIMESTAMP (buffer)) {
 241     buffer = gst_buffer_make_writable (buffer);
 242     GST_BUFFER_TIMESTAMP (buffer) = newts;
 243   }
 244
 245   if (!funnel->has_segment) {
 246     GstSegment segment;
 247
 248     gst_segment_init (&segment, GST_FORMAT_TIME);
 249     event = gst_event_new_segment (&segment);
 250     funnel->has_segment = TRUE;
 251   }
 252   GST_OBJECT_UNLOCK (funnel);
 253
 254   if (event) {
 255     if (!gst_pad_push_event (funnel->srcpad, event))
 256       GST_WARNING_OBJECT (funnel, "Could not push out newsegment event");
 257   }
 258 #if 0
 259   GST_OBJECT_LOCK (pad);
 260   padcaps = GST_PAD_CAPS (funnel->srcpad);
 261   GST_OBJECT_UNLOCK (pad);
 262
 263   if (GST_BUFFER_CAPS (buffer) && GST_BUFFER_CAPS (buffer) != padcaps) {
 264     if (!gst_pad_set_caps (funnel->srcpad, GST_BUFFER_CAPS (buffer))) {
 265       res = GST_FLOW_NOT_NEGOTIATED;
 266       goto out;
 267     }
 268   }
 269 #endif
 270
 271   res = gst_pad_push (funnel->srcpad, buffer);
 272
 273   GST_LOG_OBJECT (funnel, "handled buffer %s", gst_flow_get_name (res));
 274
 275 #if 0
 276 out:
 277 #endif
 278   gst_object_unref (funnel);
 279
 280   return res;
 281 }
 282
 283 static gboolean
 284 gst_funnel_sink_event (GstPad * pad, GstEvent * event)
 285 {
 286   GstFunnel *funnel = GST_FUNNEL (gst_pad_get_parent (pad));
 287   GstFunnelPad *fpad = GST_FUNNEL_PAD_CAST (pad);
 288   gboolean forward = TRUE;
 289   gboolean res = TRUE;
 290
 291   if (G_UNLIKELY (funnel == NULL)) {
 292     gst_event_unref (event);
 293     return FALSE;
 294   }
 295
 296   switch (GST_EVENT_TYPE (event)) {
 297     case GST_EVENT_SEGMENT:
 298     {
 299       GST_OBJECT_LOCK (funnel);
 300       gst_event_copy_segment (event, &fpad->segment);
 301       GST_OBJECT_UNLOCK (funnel);
 302
 303       forward = FALSE;
 304       break;
 305     }
 306     case GST_EVENT_FLUSH_STOP:
 307     {
 308       GST_OBJECT_LOCK (funnel);
 309       gst_segment_init (&fpad->segment, GST_FORMAT_UNDEFINED);
 310       funnel->has_segment = FALSE;
 311       GST_OBJECT_UNLOCK (funnel);
 312       break;
 313     }
 314     default:
 315       break;
 316   }
 317
 318   if (forward)
 319     res = gst_pad_push_event (funnel->srcpad, event);
 320   else
 321     gst_event_unref (event);
 322
 323   gst_object_unref (funnel);
 324
 325   return res;
 326 }
 327
 328 static gboolean
 329 gst_funnel_sink_query (GstPad * pad, GstQuery * query)
 330 {
 331   GstFunnel *funnel = GST_FUNNEL (gst_pad_get_parent (pad));
 332   gboolean forward = TRUE;
 333   gboolean res = TRUE;
 334
 335   if (G_UNLIKELY (funnel == NULL)) {
 336     gst_query_unref (query);
 337     return FALSE;
 338   }
 339
 340   if (forward)
 341     res = gst_pad_peer_query (funnel->srcpad, query);
 342
 343   gst_object_unref (funnel);
 344
 345   return res;
 346 }
 347
 348 static gboolean
 349 gst_funnel_src_event (GstPad * pad, GstEvent * event)
 350 {
 351   GstElement *funnel;
 352   GstIterator *iter;
 353   GstPad *sinkpad;
 354   gboolean result = FALSE;
 355   gboolean done = FALSE;
 356   GValue value = { 0, };
 357
 358   funnel = gst_pad_get_parent_element (pad);
 359   if (G_UNLIKELY (funnel == NULL)) {
 360     gst_event_unref (event);
 361     return FALSE;
 362   }
 363
 364   iter = gst_element_iterate_sink_pads (funnel);
 365
 366   while (!done) {
 367     switch (gst_iterator_next (iter, &value)) {
 368       case GST_ITERATOR_OK:
 369         sinkpad = g_value_get_object (&value);
 370         gst_event_ref (event);
 371         result |= gst_pad_push_event (sinkpad, event);
 372         g_value_reset (&value);
 373         break;
 374       case GST_ITERATOR_RESYNC:
 375         gst_iterator_resync (iter);
 376         result = FALSE;
 377         break;
 378       case GST_ITERATOR_ERROR:
 379         GST_WARNING_OBJECT (funnel, "Error iterating sinkpads");
 380       case GST_ITERATOR_DONE:
 381         done = TRUE;
 382         break;
 383     }
 384   }
 385   g_value_unset (&value);
 386   gst_iterator_free (iter);
 387   gst_object_unref (funnel);
 388   gst_event_unref (event);
 389
 390   return result;
 391 }
 392
 393 static void
 394 reset_pad (const GValue * data, gpointer user_data)
 395 {
 396   GstPad *pad = g_value_get_object (data);
 397   GstFunnelPad *fpad = GST_FUNNEL_PAD_CAST (pad);
 398
 399   GST_OBJECT_LOCK (pad);
 400   gst_funnel_pad_reset (fpad);
 401   GST_OBJECT_UNLOCK (pad);
 402 }
 403
 404 static GstStateChangeReturn
 405 gst_funnel_change_state (GstElement * element, GstStateChange transition)
 406 {
 407   GstFunnel *funnel = GST_FUNNEL (element);
 408   GstStateChangeReturn ret;
 409
 410   switch (transition) {
 411     case GST_STATE_CHANGE_READY_TO_PAUSED:
 412     {
 413       GstIterator *iter = gst_element_iterate_sink_pads (element);
 414       GstIteratorResult res;
 415
 416       do {
 417         res = gst_iterator_foreach (iter, reset_pad, NULL);
 418       } while (res == GST_ITERATOR_RESYNC);
 419
 420       gst_iterator_free (iter);
 421
 422       if (res == GST_ITERATOR_ERROR)
 423         return GST_STATE_CHANGE_FAILURE;
 424
 425       GST_OBJECT_LOCK (funnel);
 426       funnel->has_segment = FALSE;
 427       GST_OBJECT_UNLOCK (funnel);
 428     }
 429       break;
 430     default:
 431       break;
 432   }
 433
 434   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 435
 436   return ret;
 437 }