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