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_%u",
  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 #define gst_rtp_pt_demux_parent_class parent_class
 121 G_DEFINE_TYPE (GstRtpPtDemux, gst_rtp_pt_demux, GST_TYPE_ELEMENT);
 122
 123 static void gst_rtp_pt_demux_finalize (GObject * object);
 124
 125 static void gst_rtp_pt_demux_release (GstRtpPtDemux * ptdemux);
 126 static gboolean gst_rtp_pt_demux_setup (GstRtpPtDemux * ptdemux);
 127
 128 static gboolean gst_rtp_pt_demux_sink_event (GstPad * pad, GstObject * parent,
 129     GstEvent * event);
 130 static GstFlowReturn gst_rtp_pt_demux_chain (GstPad * pad, GstObject * parent,
 131     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 gboolean gst_rtp_pt_demux_src_event (GstPad * pad, GstObject * parent,
 139     GstEvent * event);
 140
 141
 142 static guint gst_rtp_pt_demux_signals[LAST_SIGNAL] = { 0 };
 143
 144 static void
 145 gst_rtp_pt_demux_class_init (GstRtpPtDemuxClass * klass)
 146 {
 147   GObjectClass *gobject_klass;
 148   GstElementClass *gstelement_klass;
 149
 150   gobject_klass = (GObjectClass *) klass;
 151   gstelement_klass = (GstElementClass *) klass;
 152
 153   /**
 154    * GstRtpPtDemux::request-pt-map:
 155    * @demux: the object which received the signal
 156    * @pt: the payload type
 157    *
 158    * Request the payload type as #GstCaps for @pt.
 159    */
 160   gst_rtp_pt_demux_signals[SIGNAL_REQUEST_PT_MAP] =
 161       g_signal_new ("request-pt-map", G_TYPE_FROM_CLASS (klass),
 162       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass, request_pt_map),
 163       NULL, NULL, gst_rtp_bin_marshal_BOXED__UINT, GST_TYPE_CAPS, 1,
 164       G_TYPE_UINT);
 165
 166   /**
 167    * GstRtpPtDemux::new-payload-type:
 168    * @demux: the object which received the signal
 169    * @pt: the payload type
 170    * @pad: the pad with the new payload
 171    *
 172    * Emited when a new payload type pad has been created in @demux.
 173    */
 174   gst_rtp_pt_demux_signals[SIGNAL_NEW_PAYLOAD_TYPE] =
 175       g_signal_new ("new-payload-type", G_TYPE_FROM_CLASS (klass),
 176       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass, new_payload_type),
 177       NULL, NULL, gst_rtp_bin_marshal_VOID__UINT_OBJECT, G_TYPE_NONE, 2,
 178       G_TYPE_UINT, GST_TYPE_PAD);
 179
 180   /**
 181    * GstRtpPtDemux::payload-type-change:
 182    * @demux: the object which received the signal
 183    * @pt: the new payload type
 184    *
 185    * Emited when the payload type changed.
 186    */
 187   gst_rtp_pt_demux_signals[SIGNAL_PAYLOAD_TYPE_CHANGE] =
 188       g_signal_new ("payload-type-change", G_TYPE_FROM_CLASS (klass),
 189       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass,
 190           payload_type_change), NULL, NULL, g_cclosure_marshal_VOID__UINT,
 191       G_TYPE_NONE, 1, G_TYPE_UINT);
 192
 193   /**
 194    * GstRtpPtDemux::clear-pt-map:
 195    * @demux: the object which received the signal
 196    *
 197    * The application can call this signal to instruct the element to discard the
 198    * currently cached payload type map.
 199    */
 200   gst_rtp_pt_demux_signals[SIGNAL_CLEAR_PT_MAP] =
 201       g_signal_new ("clear-pt-map", G_TYPE_FROM_CLASS (klass),
 202       G_SIGNAL_ACTION | G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass,
 203           clear_pt_map), NULL, NULL, g_cclosure_marshal_VOID__VOID,
 204       G_TYPE_NONE, 0, G_TYPE_NONE);
 205
 206   gobject_klass->finalize = gst_rtp_pt_demux_finalize;
 207
 208   gstelement_klass->change_state =
 209       GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_change_state);
 210
 211   klass->clear_pt_map = GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_clear_pt_map);
 212
 213   gst_element_class_add_pad_template (gstelement_klass,
 214       gst_static_pad_template_get (&rtp_pt_demux_sink_template));
 215   gst_element_class_add_pad_template (gstelement_klass,
 216       gst_static_pad_template_get (&rtp_pt_demux_src_template));
 217
 218   gst_element_class_set_details_simple (gstelement_klass, "RTP Demux",
 219       "Demux/Network/RTP",
 220       "Parses codec streams transmitted in the same RTP session",
 221       "Kai Vehmanen <kai.vehmanen@nokia.com>");
 222
 223   GST_DEBUG_CATEGORY_INIT (gst_rtp_pt_demux_debug,
 224       "rtpptdemux", 0, "RTP codec demuxer");
 225 }
 226
 227 static void
 228 gst_rtp_pt_demux_init (GstRtpPtDemux * ptdemux)
 229 {
 230   GstElementClass *klass = GST_ELEMENT_GET_CLASS (ptdemux);
 231
 232   ptdemux->sink =
 233       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 234           "sink"), "sink");
 235   g_assert (ptdemux->sink != NULL);
 236
 237   gst_pad_set_chain_function (ptdemux->sink, gst_rtp_pt_demux_chain);
 238   gst_pad_set_event_function (ptdemux->sink, gst_rtp_pt_demux_sink_event);
 239
 240   gst_element_add_pad (GST_ELEMENT (ptdemux), ptdemux->sink);
 241 }
 242
 243 static void
 244 gst_rtp_pt_demux_finalize (GObject * object)
 245 {
 246   gst_rtp_pt_demux_release (GST_RTP_PT_DEMUX (object));
 247
 248   G_OBJECT_CLASS (parent_class)->finalize (object);
 249 }
 250
 251 static GstCaps *
 252 gst_rtp_pt_demux_get_caps (GstRtpPtDemux * rtpdemux, guint pt)
 253 {
 254   GstCaps *caps;
 255   GValue ret = { 0 };
 256   GValue args[2] = { {0}, {0} };
 257
 258   /* figure out the caps */
 259   g_value_init (&args[0], GST_TYPE_ELEMENT);
 260   g_value_set_object (&args[0], rtpdemux);
 261   g_value_init (&args[1], G_TYPE_UINT);
 262   g_value_set_uint (&args[1], pt);
 263
 264   g_value_init (&ret, GST_TYPE_CAPS);
 265   g_value_set_boxed (&ret, NULL);
 266
 267   g_signal_emitv (args, gst_rtp_pt_demux_signals[SIGNAL_REQUEST_PT_MAP], 0,
 268       &ret);
 269
 270   g_value_unset (&args[0]);
 271   g_value_unset (&args[1]);
 272   caps = g_value_dup_boxed (&ret);
 273   g_value_unset (&ret);
 274   if (caps == NULL) {
 275     caps = gst_pad_get_current_caps (rtpdemux->sink);
 276   }
 277
 278   GST_DEBUG ("pt %d, got caps %" GST_PTR_FORMAT, pt, caps);
 279
 280   return caps;
 281 }
 282
 283 static void
 284 gst_rtp_pt_demux_clear_pt_map (GstRtpPtDemux * rtpdemux)
 285 {
 286   GSList *walk;
 287
 288   GST_OBJECT_LOCK (rtpdemux);
 289   GST_DEBUG ("clearing pt map");
 290   for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
 291     GstRtpPtDemuxPad *pad = walk->data;
 292
 293     pad->newcaps = TRUE;
 294   }
 295   GST_OBJECT_UNLOCK (rtpdemux);
 296 }
 297
 298 static GstFlowReturn
 299 gst_rtp_pt_demux_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
 300 {
 301   GstFlowReturn ret = GST_FLOW_OK;
 302   GstRtpPtDemux *rtpdemux;
 303   guint8 pt;
 304   GstPad *srcpad;
 305   GstRtpPtDemuxPad *rtpdemuxpad;
 306   GstCaps *caps;
 307   GstRTPBuffer rtp = { NULL };
 308
 309   rtpdemux = GST_RTP_PT_DEMUX (parent);
 310
 311   if (!gst_rtp_buffer_validate (buf))
 312     goto invalid_buffer;
 313
 314   gst_rtp_buffer_map (buf, GST_MAP_READ, &rtp);
 315   pt = gst_rtp_buffer_get_payload_type (&rtp);
 316   gst_rtp_buffer_unmap (&rtp);
 317
 318   GST_DEBUG_OBJECT (rtpdemux, "received buffer for pt %d", pt);
 319
 320   rtpdemuxpad = find_pad_for_pt (rtpdemux, pt);
 321   if (rtpdemuxpad == NULL) {
 322     /* new PT, create a src pad */
 323     GstElementClass *klass;
 324     GstPadTemplate *templ;
 325     gchar *padname;
 326
 327     caps = gst_rtp_pt_demux_get_caps (rtpdemux, pt);
 328     if (!caps)
 329       goto no_caps;
 330
 331     klass = GST_ELEMENT_GET_CLASS (rtpdemux);
 332     templ = gst_element_class_get_pad_template (klass, "src_%u");
 333     padname = g_strdup_printf ("src_%u", pt);
 334     srcpad = gst_pad_new_from_template (templ, padname);
 335     gst_pad_use_fixed_caps (srcpad);
 336     g_free (padname);
 337     gst_pad_set_event_function (srcpad, gst_rtp_pt_demux_src_event);
 338
 339     caps = gst_caps_make_writable (caps);
 340     gst_caps_set_simple (caps, "payload", G_TYPE_INT, pt, NULL);
 341     gst_pad_set_caps (srcpad, caps);
 342     gst_caps_unref (caps);
 343
 344     GST_DEBUG ("Adding pt=%d to the list.", pt);
 345     rtpdemuxpad = g_new0 (GstRtpPtDemuxPad, 1);
 346     rtpdemuxpad->pt = pt;
 347     rtpdemuxpad->newcaps = FALSE;
 348     rtpdemuxpad->pad = srcpad;
 349     GST_OBJECT_LOCK (rtpdemux);
 350     rtpdemux->srcpads = g_slist_append (rtpdemux->srcpads, rtpdemuxpad);
 351     GST_OBJECT_UNLOCK (rtpdemux);
 352
 353     gst_pad_set_active (srcpad, TRUE);
 354     gst_element_add_pad (GST_ELEMENT_CAST (rtpdemux), srcpad);
 355
 356     GST_DEBUG ("emitting new-payload-type for pt %d", pt);
 357     g_signal_emit (G_OBJECT (rtpdemux),
 358         gst_rtp_pt_demux_signals[SIGNAL_NEW_PAYLOAD_TYPE], 0, pt, srcpad);
 359   }
 360
 361   srcpad = rtpdemuxpad->pad;
 362
 363   if (pt != rtpdemux->last_pt) {
 364     gint emit_pt = pt;
 365
 366     /* our own signal with an extra flag that this is the only pad */
 367     rtpdemux->last_pt = pt;
 368     GST_DEBUG ("emitting payload-type-changed for pt %d", emit_pt);
 369     g_signal_emit (G_OBJECT (rtpdemux),
 370         gst_rtp_pt_demux_signals[SIGNAL_PAYLOAD_TYPE_CHANGE], 0, emit_pt);
 371   }
 372
 373   if (rtpdemuxpad->newcaps) {
 374     GST_DEBUG ("need new caps");
 375     caps = gst_rtp_pt_demux_get_caps (rtpdemux, pt);
 376     if (!caps)
 377       goto no_caps;
 378
 379     caps = gst_caps_make_writable (caps);
 380     gst_caps_set_simple (caps, "payload", G_TYPE_INT, pt, NULL);
 381     gst_pad_set_caps (srcpad, caps);
 382     gst_caps_unref (caps);
 383     rtpdemuxpad->newcaps = FALSE;
 384   }
 385
 386   /* push to srcpad */
 387   ret = gst_pad_push (srcpad, buf);
 388
 389   return ret;
 390
 391   /* ERRORS */
 392 invalid_buffer:
 393   {
 394     /* this is fatal and should be filtered earlier */
 395     GST_ELEMENT_ERROR (rtpdemux, STREAM, DECODE, (NULL),
 396         ("Dropping invalid RTP payload"));
 397     gst_buffer_unref (buf);
 398     return GST_FLOW_ERROR;
 399   }
 400 no_caps:
 401   {
 402     GST_ELEMENT_ERROR (rtpdemux, STREAM, DECODE, (NULL),
 403         ("Could not get caps for payload"));
 404     gst_buffer_unref (buf);
 405     return GST_FLOW_ERROR;
 406   }
 407 }
 408
 409 static GstRtpPtDemuxPad *
 410 find_pad_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt)
 411 {
 412   GstRtpPtDemuxPad *respad = NULL;
 413   GSList *walk;
 414
 415   for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
 416     GstRtpPtDemuxPad *pad = walk->data;
 417
 418     if (pad->pt == pt) {
 419       respad = pad;
 420       break;
 421     }
 422   }
 423   return respad;
 424 }
 425
 426 static gboolean
 427 gst_rtp_pt_demux_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 428 {
 429   GstRtpPtDemux *rtpdemux;
 430   gboolean res = FALSE;
 431
 432   rtpdemux = GST_RTP_PT_DEMUX (parent);
 433
 434   switch (GST_EVENT_TYPE (event)) {
 435     case GST_EVENT_CUSTOM_DOWNSTREAM:
 436     {
 437       const GstStructure *s;
 438
 439       s = gst_event_get_structure (event);
 440
 441       if (gst_structure_has_name (s, "GstRTPPacketLost")) {
 442         GstRtpPtDemuxPad *rtpdemuxpad =
 443             find_pad_for_pt (rtpdemux, rtpdemux->last_pt);
 444
 445         if (rtpdemuxpad)
 446           res = gst_pad_push_event (rtpdemuxpad->pad, event);
 447         else
 448           gst_event_unref (event);
 449
 450       } else {
 451         res = gst_pad_event_default (pad, parent, event);
 452       }
 453       break;
 454     }
 455     default:
 456       res = gst_pad_event_default (pad, parent, event);
 457       break;
 458   }
 459
 460   return res;
 461 }
 462
 463
 464 static gboolean
 465 gst_rtp_pt_demux_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
 466 {
 467   GstRtpPtDemux *demux;
 468   const GstStructure *s;
 469
 470   demux = GST_RTP_PT_DEMUX (parent);
 471
 472   switch (GST_EVENT_TYPE (event)) {
 473     case GST_EVENT_CUSTOM_UPSTREAM:
 474     case GST_EVENT_CUSTOM_BOTH:
 475     case GST_EVENT_CUSTOM_BOTH_OOB:
 476       s = gst_event_get_structure (event);
 477       if (s && !gst_structure_has_field (s, "payload")) {
 478         GSList *walk;
 479
 480         for (walk = demux->srcpads; walk; walk = g_slist_next (walk)) {
 481           GstRtpPtDemuxPad *dpad = (GstRtpPtDemuxPad *) walk->data;
 482
 483           if (dpad->pad == pad) {
 484             GstStructure *ws;
 485
 486             event =
 487                 GST_EVENT_CAST (gst_mini_object_make_writable
 488                 (GST_MINI_OBJECT_CAST (event)));
 489             ws = gst_event_writable_structure (event);
 490             gst_structure_set (ws, "payload", G_TYPE_UINT, dpad->pt, NULL);
 491             break;
 492           }
 493         }
 494       }
 495       break;
 496     default:
 497       break;
 498   }
 499
 500   return gst_pad_event_default (pad, parent, event);
 501 }
 502
 503 /*
 504  * Reserves resources for the object.
 505  */
 506 static gboolean
 507 gst_rtp_pt_demux_setup (GstRtpPtDemux * ptdemux)
 508 {
 509   ptdemux->srcpads = NULL;
 510   ptdemux->last_pt = 0xFFFF;
 511
 512   return TRUE;
 513 }
 514
 515 /*
 516  * Free resources for the object.
 517  */
 518 static void
 519 gst_rtp_pt_demux_release (GstRtpPtDemux * ptdemux)
 520 {
 521   GSList *walk;
 522
 523   for (walk = ptdemux->srcpads; walk; walk = g_slist_next (walk)) {
 524     GstRtpPtDemuxPad *pad = walk->data;
 525
 526     gst_pad_set_active (pad->pad, FALSE);
 527     gst_element_remove_pad (GST_ELEMENT_CAST (ptdemux), pad->pad);
 528     g_free (pad);
 529   }
 530   g_slist_free (ptdemux->srcpads);
 531   ptdemux->srcpads = NULL;
 532 }
 533
 534 static GstStateChangeReturn
 535 gst_rtp_pt_demux_change_state (GstElement * element, GstStateChange transition)
 536 {
 537   GstStateChangeReturn ret;
 538   GstRtpPtDemux *ptdemux;
 539
 540   ptdemux = GST_RTP_PT_DEMUX (element);
 541
 542   switch (transition) {
 543     case GST_STATE_CHANGE_NULL_TO_READY:
 544       if (gst_rtp_pt_demux_setup (ptdemux) != TRUE)
 545         ret = GST_STATE_CHANGE_FAILURE;
 546       break;
 547     case GST_STATE_CHANGE_READY_TO_PAUSED:
 548     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 549     default:
 550       break;
 551   }
 552
 553   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 554
 555   switch (transition) {
 556     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 557     case GST_STATE_CHANGE_PAUSED_TO_READY:
 558       break;
 559     case GST_STATE_CHANGE_READY_TO_NULL:
 560       gst_rtp_pt_demux_release (ptdemux);
 561       break;
 562     default:
 563       break;
 564   }
 565
 566   return ret;
 567 }