gst/rtpmanager/gstrtpptdemux.c

   1 /*
   2  * RTP Demux element
   3  *
   4  * Copyright (C) 2005 Nokia Corporation.
   5  * @author Kai Vehmanen <kai.vehmanen@nokia.com>
   6  *
   7  * Loosely based on GStreamer gstdecodebin
   8  * Copyright (C) <2004> Wim Taymans <wim.taymans@gmail.com>
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Library General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 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  * Library General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Library General Public
  21  * License along with this library; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 02111-1307, USA.
  24  */
  25
  26 /**
  27  * SECTION:element-gstrtpptdemux
  28  *
  29  * <refsect2>
  30  * <para>
  31  * gstrtpptdemux acts as a demuxer for RTP packets based on the payload type of the
  32  * packets. Its main purpose is to allow an application to easily receive and
  33  * decode an RTP stream with multiple payload types.
  34  * </para>
  35  * <para>
  36  * For each payload type that is detected, a new pad will be created and the
  37  * ::new-payload-type signal will be emitted. When the payload for the RTP
  38  * stream changes, the ::payload-type-change signal will be emitted.
  39  * </para>
  40  * <para>
  41  * The element will try to set complete and unique application/x-rtp caps on the
  42  * outgoing buffers and pads based on the result of the ::request-pt-map signal.
  43  * </para>
  44  * <title>Example pipelines</title>
  45  * <para>
  46  * <programlisting>
  47  * gst-launch udpsrc caps="application/x-rtp" ! gstrtpptdemux ! fakesink
  48  * </programlisting>
  49  * Takes an RTP stream and send the RTP packets with the first detected payload
  50  * type to fakesink, discarding the other payload types.
  51  * </para>
  52  * </refsect2>
  53  *
  54  * Last reviewed on 2007-05-28 (0.10.5)
  55  */
  56
  57 /*
  58  * Contributors:
  59  * Andre Moreira Magalhaes <andre.magalhaes@indt.org.br>
  60  */
  61 /*
  62  * Status:
  63  *  - works with the test_rtpdemux.c tool
  64  *
  65  * Check:
  66  *  - is emitting a signal enough, or should we
  67  *    use GstEvent to notify downstream elements
  68  *    of the new packet... no?
  69  *
  70  * Notes:
  71  *  - emits event both for new PTs, and whenever
  72  *    a PT is changed
  73  */
  74
  75 #ifdef HAVE_CONFIG_H
  76 #include "config.h"
  77 #endif
  78
  79 #include <string.h>
  80 #include <gst/gst.h>
  81 #include <gst/rtp/gstrtpbuffer.h>
  82
  83 #include "gstrtpbin-marshal.h"
  84 #include "gstrtpptdemux.h"
  85
  86 /* generic templates */
  87 static GstStaticPadTemplate rtp_pt_demux_sink_template =
  88 GST_STATIC_PAD_TEMPLATE ("sink",
  89     GST_PAD_SINK,
  90     GST_PAD_ALWAYS,
  91     GST_STATIC_CAPS ("application/x-rtp")
  92     );
  93
  94 static GstStaticPadTemplate rtp_pt_demux_src_template =
  95 GST_STATIC_PAD_TEMPLATE ("src_%d",
  96     GST_PAD_SRC,
  97     GST_PAD_SOMETIMES,
  98     GST_STATIC_CAPS ("application/x-rtp, " "payload = (int) [ 0, 255 ]")
  99     );
 100
 101 GST_DEBUG_CATEGORY_STATIC (gst_rtp_pt_demux_debug);
 102 #define GST_CAT_DEFAULT gst_rtp_pt_demux_debug
 103
 104 /**
 105  * Item for storing GstPad<->pt pairs.
 106  */
 107 struct _GstRtpPtDemuxPad
 108 {
 109   GstPad *pad;        /**< pointer to the actual pad */
 110   gint pt;             /**< RTP payload-type attached to pad */
 111   gboolean newcaps;
 112 };
 113
 114 /* signals */
 115 enum
 116 {
 117   SIGNAL_REQUEST_PT_MAP,
 118   SIGNAL_NEW_PAYLOAD_TYPE,
 119   SIGNAL_PAYLOAD_TYPE_CHANGE,
 120   SIGNAL_CLEAR_PT_MAP,
 121   LAST_SIGNAL
 122 };
 123
 124 GST_BOILERPLATE (GstRtpPtDemux, gst_rtp_pt_demux, GstElement, GST_TYPE_ELEMENT);
 125
 126 static void gst_rtp_pt_demux_finalize (GObject * object);
 127
 128 static void gst_rtp_pt_demux_release (GstRtpPtDemux * ptdemux);
 129 static gboolean gst_rtp_pt_demux_setup (GstRtpPtDemux * ptdemux);
 130
 131 static GstFlowReturn gst_rtp_pt_demux_chain (GstPad * pad, GstBuffer * buf);
 132 static GstStateChangeReturn gst_rtp_pt_demux_change_state (GstElement * element,
 133     GstStateChange transition);
 134 static void gst_rtp_pt_demux_clear_pt_map (GstRtpPtDemux * rtpdemux);
 135
 136 static GstRtpPtDemuxPad *find_pad_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt);
 137
 138 static guint gst_rtp_pt_demux_signals[LAST_SIGNAL] = { 0 };
 139
 140 static GstElementDetails gst_rtp_pt_demux_details = {
 141   "RTP Demux",
 142   "Demux/Network/RTP",
 143   "Parses codec streams transmitted in the same RTP session",
 144   "Kai Vehmanen <kai.vehmanen@nokia.com>"
 145 };
 146
 147 static void
 148 gst_rtp_pt_demux_base_init (gpointer g_class)
 149 {
 150   GstElementClass *gstelement_klass = GST_ELEMENT_CLASS (g_class);
 151
 152   gst_element_class_add_pad_template (gstelement_klass,
 153       gst_static_pad_template_get (&rtp_pt_demux_sink_template));
 154   gst_element_class_add_pad_template (gstelement_klass,
 155       gst_static_pad_template_get (&rtp_pt_demux_src_template));
 156
 157   gst_element_class_set_details (gstelement_klass, &gst_rtp_pt_demux_details);
 158 }
 159
 160 static void
 161 gst_rtp_pt_demux_class_init (GstRtpPtDemuxClass * klass)
 162 {
 163   GObjectClass *gobject_klass;
 164   GstElementClass *gstelement_klass;
 165
 166   gobject_klass = (GObjectClass *) klass;
 167   gstelement_klass = (GstElementClass *) klass;
 168
 169   /**
 170    * GstRtpPtDemux::request-pt-map:
 171    * @demux: the object which received the signal
 172    * @pt: the payload type
 173    *
 174    * Request the payload type as #GstCaps for @pt.
 175    */
 176   gst_rtp_pt_demux_signals[SIGNAL_REQUEST_PT_MAP] =
 177       g_signal_new ("request-pt-map", G_TYPE_FROM_CLASS (klass),
 178       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass, request_pt_map),
 179       NULL, NULL, gst_rtp_bin_marshal_BOXED__UINT, GST_TYPE_CAPS, 1,
 180       G_TYPE_UINT);
 181
 182   /**
 183    * GstRtpPtDemux::new-payload-type:
 184    * @demux: the object which received the signal
 185    * @pt: the payload type
 186    * @pad: the pad with the new payload
 187    *
 188    * Emited when a new payload type pad has been created in @demux.
 189    */
 190   gst_rtp_pt_demux_signals[SIGNAL_NEW_PAYLOAD_TYPE] =
 191       g_signal_new ("new-payload-type", G_TYPE_FROM_CLASS (klass),
 192       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass, new_payload_type),
 193       NULL, NULL, gst_rtp_bin_marshal_VOID__UINT_OBJECT, G_TYPE_NONE, 2,
 194       G_TYPE_UINT, GST_TYPE_PAD);
 195
 196   /**
 197    * GstRtpPtDemux::payload-type-change:
 198    * @demux: the object which received the signal
 199    * @pt: the new payload type
 200    *
 201    * Emited when the payload type changed.
 202    */
 203   gst_rtp_pt_demux_signals[SIGNAL_PAYLOAD_TYPE_CHANGE] =
 204       g_signal_new ("payload-type-change", G_TYPE_FROM_CLASS (klass),
 205       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass,
 206           payload_type_change), NULL, NULL, g_cclosure_marshal_VOID__UINT,
 207       G_TYPE_NONE, 1, G_TYPE_UINT);
 208
 209   /**
 210    * GstRtpPtDemux::clear-pt-map:
 211    * @demux: the object which received the signal
 212    *
 213    * The application can call this signal to instruct the element to discard the
 214    * currently cached payload type map.
 215    */
 216   gst_rtp_pt_demux_signals[SIGNAL_CLEAR_PT_MAP] =
 217       g_signal_new ("clear-pt-map", G_TYPE_FROM_CLASS (klass),
 218       G_SIGNAL_ACTION | G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass,
 219           clear_pt_map), NULL, NULL, g_cclosure_marshal_VOID__VOID,
 220       G_TYPE_NONE, 0, G_TYPE_NONE);
 221
 222   gobject_klass->finalize = GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_finalize);
 223
 224   gstelement_klass->change_state =
 225       GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_change_state);
 226
 227   klass->clear_pt_map = GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_clear_pt_map);
 228
 229   GST_DEBUG_CATEGORY_INIT (gst_rtp_pt_demux_debug,
 230       "rtpptdemux", 0, "RTP codec demuxer");
 231 }
 232
 233 static void
 234 gst_rtp_pt_demux_init (GstRtpPtDemux * ptdemux, GstRtpPtDemuxClass * g_class)
 235 {
 236   GstElementClass *klass = GST_ELEMENT_GET_CLASS (ptdemux);
 237
 238   ptdemux->sink =
 239       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 240           "sink"), "sink");
 241   g_assert (ptdemux->sink != NULL);
 242
 243   gst_pad_set_chain_function (ptdemux->sink, gst_rtp_pt_demux_chain);
 244
 245   gst_element_add_pad (GST_ELEMENT (ptdemux), ptdemux->sink);
 246 }
 247
 248 static void
 249 gst_rtp_pt_demux_finalize (GObject * object)
 250 {
 251   gst_rtp_pt_demux_release (GST_RTP_PT_DEMUX (object));
 252
 253   G_OBJECT_CLASS (parent_class)->finalize (object);
 254 }
 255
 256 static GstCaps *
 257 gst_rtp_pt_demux_get_caps (GstRtpPtDemux * rtpdemux, guint pt)
 258 {
 259   GstCaps *caps;
 260   GValue ret = { 0 };
 261   GValue args[2] = { {0}, {0} };
 262
 263   /* figure out the caps */
 264   g_value_init (&args[0], GST_TYPE_ELEMENT);
 265   g_value_set_object (&args[0], rtpdemux);
 266   g_value_init (&args[1], G_TYPE_UINT);
 267   g_value_set_uint (&args[1], pt);
 268
 269   g_value_init (&ret, GST_TYPE_CAPS);
 270   g_value_set_boxed (&ret, NULL);
 271
 272   g_signal_emitv (args, gst_rtp_pt_demux_signals[SIGNAL_REQUEST_PT_MAP], 0,
 273       &ret);
 274
 275   g_value_unset (&args[0]);
 276   g_value_unset (&args[1]);
 277   caps = g_value_dup_boxed (&ret);
 278   g_value_unset (&ret);
 279   if (caps == NULL) {
 280     caps = GST_PAD_CAPS (rtpdemux->sink);
 281     if (caps)
 282       gst_caps_ref (caps);
 283   }
 284
 285   GST_DEBUG ("pt %d, got caps %" GST_PTR_FORMAT, pt, caps);
 286
 287   return caps;
 288 }
 289
 290 static void
 291 gst_rtp_pt_demux_clear_pt_map (GstRtpPtDemux * rtpdemux)
 292 {
 293   GSList *walk;
 294
 295   GST_OBJECT_LOCK (rtpdemux);
 296   GST_DEBUG ("clearing pt map");
 297   for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
 298     GstRtpPtDemuxPad *pad = walk->data;
 299
 300     pad->newcaps = TRUE;
 301   }
 302   GST_OBJECT_UNLOCK (rtpdemux);
 303 }
 304
 305 static GstFlowReturn
 306 gst_rtp_pt_demux_chain (GstPad * pad, GstBuffer * buf)
 307 {
 308   GstFlowReturn ret = GST_FLOW_OK;
 309   GstRtpPtDemux *rtpdemux;
 310   GstElement *element = GST_ELEMENT (GST_OBJECT_PARENT (pad));
 311   guint8 pt;
 312   GstPad *srcpad;
 313   GstRtpPtDemuxPad *rtpdemuxpad;
 314   GstCaps *caps;
 315
 316   rtpdemux = GST_RTP_PT_DEMUX (GST_OBJECT_PARENT (pad));
 317
 318   if (!gst_rtp_buffer_validate (buf))
 319     goto invalid_buffer;
 320
 321   pt = gst_rtp_buffer_get_payload_type (buf);
 322
 323   GST_DEBUG_OBJECT (rtpdemux, "received buffer for pt %d", pt);
 324
 325   rtpdemuxpad = find_pad_for_pt (rtpdemux, pt);
 326   if (rtpdemuxpad == NULL) {
 327     /* new PT, create a src pad */
 328     GstElementClass *klass;
 329     GstPadTemplate *templ;
 330     gchar *padname;
 331
 332     klass = GST_ELEMENT_GET_CLASS (rtpdemux);
 333     templ = gst_element_class_get_pad_template (klass, "src_%d");
 334     padname = g_strdup_printf ("src_%d", pt);
 335     srcpad = gst_pad_new_from_template (templ, padname);
 336     gst_pad_use_fixed_caps (srcpad);
 337     g_free (padname);
 338
 339     caps = gst_rtp_pt_demux_get_caps (rtpdemux, pt);
 340     if (!caps)
 341       goto no_caps;
 342
 343     caps = gst_caps_make_writable (caps);
 344     gst_caps_set_simple (caps, "payload", G_TYPE_INT, pt, NULL);
 345     gst_pad_set_caps (srcpad, caps);
 346     gst_caps_unref (caps);
 347
 348     GST_DEBUG ("Adding pt=%d to the list.", pt);
 349     rtpdemuxpad = g_new0 (GstRtpPtDemuxPad, 1);
 350     rtpdemuxpad->pt = pt;
 351     rtpdemuxpad->newcaps = FALSE;
 352     rtpdemuxpad->pad = srcpad;
 353     GST_OBJECT_LOCK (rtpdemux);
 354     rtpdemux->srcpads = g_slist_append (rtpdemux->srcpads, rtpdemuxpad);
 355     GST_OBJECT_UNLOCK (rtpdemux);
 356
 357     gst_pad_set_active (srcpad, TRUE);
 358     gst_element_add_pad (element, srcpad);
 359
 360     GST_DEBUG ("emitting new-payload_type for pt %d", pt);
 361     g_signal_emit (G_OBJECT (rtpdemux),
 362         gst_rtp_pt_demux_signals[SIGNAL_NEW_PAYLOAD_TYPE], 0, pt, srcpad);
 363   }
 364
 365   srcpad = rtpdemuxpad->pad;
 366
 367   if (pt != rtpdemux->last_pt) {
 368     gint emit_pt = pt;
 369
 370     /* our own signal with an extra flag that this is the only pad */
 371     rtpdemux->last_pt = pt;
 372     GST_DEBUG ("emitting payload-type-changed for pt %d", emit_pt);
 373     g_signal_emit (G_OBJECT (rtpdemux),
 374         gst_rtp_pt_demux_signals[SIGNAL_PAYLOAD_TYPE_CHANGE], 0, emit_pt);
 375   }
 376
 377   if (rtpdemuxpad->newcaps) {
 378     GST_DEBUG ("need new caps");
 379     caps = gst_rtp_pt_demux_get_caps (rtpdemux, pt);
 380     if (!caps)
 381       goto no_caps;
 382
 383     caps = gst_caps_make_writable (caps);
 384     gst_caps_set_simple (caps, "payload", G_TYPE_INT, pt, NULL);
 385     gst_pad_set_caps (srcpad, caps);
 386     gst_caps_unref (caps);
 387     rtpdemuxpad->newcaps = FALSE;
 388   }
 389
 390   gst_buffer_set_caps (buf, GST_PAD_CAPS (srcpad));
 391
 392   /* push to srcpad */
 393   ret = gst_pad_push (srcpad, buf);
 394
 395   return ret;
 396
 397   /* ERRORS */
 398 invalid_buffer:
 399   {
 400     /* this is fatal and should be filtered earlier */
 401     GST_ELEMENT_ERROR (rtpdemux, STREAM, DECODE, (NULL),
 402         ("Dropping invalid RTP payload"));
 403     gst_buffer_unref (buf);
 404     return GST_FLOW_ERROR;
 405   }
 406 no_caps:
 407   {
 408     GST_ELEMENT_ERROR (rtpdemux, STREAM, DECODE, (NULL),
 409         ("Could not get caps for payload"));
 410     gst_buffer_unref (buf);
 411     return GST_FLOW_ERROR;
 412   }
 413 }
 414
 415 static GstRtpPtDemuxPad *
 416 find_pad_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt)
 417 {
 418   GstRtpPtDemuxPad *respad = NULL;
 419   GSList *walk;
 420
 421   for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
 422     GstRtpPtDemuxPad *pad = walk->data;
 423
 424     if (pad->pt == pt) {
 425       respad = pad;
 426       break;
 427     }
 428   }
 429   return respad;
 430 }
 431
 432 /**
 433  * Reserves resources for the object.
 434  */
 435 static gboolean
 436 gst_rtp_pt_demux_setup (GstRtpPtDemux * ptdemux)
 437 {
 438   ptdemux->srcpads = NULL;
 439   ptdemux->last_pt = 0xFFFF;
 440
 441   return TRUE;
 442 }
 443
 444 /**
 445  * Free resources for the object.
 446  */
 447 static void
 448 gst_rtp_pt_demux_release (GstRtpPtDemux * ptdemux)
 449 {
 450   GSList *walk;
 451
 452   for (walk = ptdemux->srcpads; walk; walk = g_slist_next (walk)) {
 453     GstRtpPtDemuxPad *pad = walk->data;
 454
 455     gst_pad_set_active (pad->pad, FALSE);
 456     gst_element_remove_pad (GST_ELEMENT_CAST (ptdemux), pad->pad);
 457     g_free (pad);
 458   }
 459   g_slist_free (ptdemux->srcpads);
 460   ptdemux->srcpads = NULL;
 461 }
 462
 463 static GstStateChangeReturn
 464 gst_rtp_pt_demux_change_state (GstElement * element, GstStateChange transition)
 465 {
 466   GstStateChangeReturn ret;
 467   GstRtpPtDemux *ptdemux;
 468
 469   ptdemux = GST_RTP_PT_DEMUX (element);
 470
 471   switch (transition) {
 472     case GST_STATE_CHANGE_NULL_TO_READY:
 473       if (gst_rtp_pt_demux_setup (ptdemux) != TRUE)
 474         ret = GST_STATE_CHANGE_FAILURE;
 475       break;
 476     case GST_STATE_CHANGE_READY_TO_PAUSED:
 477     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 478     default:
 479       break;
 480   }
 481
 482   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 483
 484   switch (transition) {
 485     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 486     case GST_STATE_CHANGE_PAUSED_TO_READY:
 487       break;
 488     case GST_STATE_CHANGE_READY_TO_NULL:
 489       gst_rtp_pt_demux_release (ptdemux);
 490       break;
 491     default:
 492       break;
 493   }
 494
 495   return ret;
 496 }