4 * Copyright (C) 2005 Nokia Corporation.
5 * @author Kai Vehmanen <kai.vehmanen@nokia.com>
7 * Loosely based on GStreamer gstdecodebin
8 * Copyright (C) <2004> Wim Taymans <wim.taymans@gmail.com>
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.
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.
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., 51 Franklin St, Fifth Floor,
23 * Boston, MA 02110-1301, USA.
27 * SECTION:element-rtpptdemux
29 * rtpptdemux 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.
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
38 * The element will try to set complete and unique application/x-rtp caps
39 * on the output pads based on the result of the #GstRtpPtDemux::request-pt-map
43 * <title>Example pipelines</title>
45 * gst-launch-1.0 udpsrc caps="application/x-rtp" ! rtpptdemux ! 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.
53 * Andre Moreira Magalhaes <andre.magalhaes@indt.org.br>
57 * - works with the test_rtpdemux.c tool
60 * - is emitting a signal enough, or should we
61 * use GstEvent to notify downstream elements
62 * of the new packet... no?
65 * - emits event both for new PTs, and whenever
75 #include <gst/rtp/gstrtpbuffer.h>
77 #include "gstrtpptdemux.h"
79 /* generic templates */
80 static GstStaticPadTemplate rtp_pt_demux_sink_template =
81 GST_STATIC_PAD_TEMPLATE ("sink",
84 GST_STATIC_CAPS ("application/x-rtp")
87 static GstStaticPadTemplate rtp_pt_demux_src_template =
88 GST_STATIC_PAD_TEMPLATE ("src_%u",
91 GST_STATIC_CAPS ("application/x-rtp, " "payload = (int) [ 0, 255 ]")
94 GST_DEBUG_CATEGORY_STATIC (gst_rtp_pt_demux_debug);
95 #define GST_CAT_DEFAULT gst_rtp_pt_demux_debug
98 * Item for storing GstPad<->pt pairs.
100 struct _GstRtpPtDemuxPad
102 GstPad *pad; /**< pointer to the actual pad */
103 gint pt; /**< RTP payload-type attached to pad */
110 SIGNAL_REQUEST_PT_MAP,
111 SIGNAL_NEW_PAYLOAD_TYPE,
112 SIGNAL_PAYLOAD_TYPE_CHANGE,
123 #define gst_rtp_pt_demux_parent_class parent_class
124 G_DEFINE_TYPE (GstRtpPtDemux, gst_rtp_pt_demux, GST_TYPE_ELEMENT);
126 static void gst_rtp_pt_demux_finalize (GObject * object);
128 static void gst_rtp_pt_demux_release (GstRtpPtDemux * ptdemux);
129 static gboolean gst_rtp_pt_demux_setup (GstRtpPtDemux * ptdemux);
131 static gboolean gst_rtp_pt_demux_sink_event (GstPad * pad, GstObject * parent,
133 static GstFlowReturn gst_rtp_pt_demux_chain (GstPad * pad, GstObject * parent,
135 static GstStateChangeReturn gst_rtp_pt_demux_change_state (GstElement * element,
136 GstStateChange transition);
137 static void gst_rtp_pt_demux_clear_pt_map (GstRtpPtDemux * rtpdemux);
139 static GstPad *find_pad_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt);
141 static gboolean gst_rtp_pt_demux_src_event (GstPad * pad, GstObject * parent,
145 static guint gst_rtp_pt_demux_signals[LAST_SIGNAL] = { 0 };
148 gst_rtp_pt_demux_set_property (GObject * object, guint prop_id,
149 const GValue * value, GParamSpec * pspec)
151 GstRtpPtDemux *rtpptdemux = GST_RTP_PT_DEMUX (object);
154 case PROP_IGNORED_PTS:
155 g_value_copy (value, &rtpptdemux->ignored_pts);
158 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
164 gst_rtp_pt_demux_get_property (GObject * object, guint prop_id,
165 GValue * value, GParamSpec * pspec)
167 GstRtpPtDemux *rtpptdemux = GST_RTP_PT_DEMUX (object);
170 case PROP_IGNORED_PTS:
171 g_value_copy (&rtpptdemux->ignored_pts, value);
174 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
180 gst_rtp_pt_demux_class_init (GstRtpPtDemuxClass * klass)
182 GObjectClass *gobject_klass;
183 GstElementClass *gstelement_klass;
185 gobject_klass = (GObjectClass *) klass;
186 gstelement_klass = (GstElementClass *) klass;
189 * GstRtpPtDemux::request-pt-map:
190 * @demux: the object which received the signal
191 * @pt: the payload type
193 * Request the payload type as #GstCaps for @pt.
195 gst_rtp_pt_demux_signals[SIGNAL_REQUEST_PT_MAP] =
196 g_signal_new ("request-pt-map", G_TYPE_FROM_CLASS (klass),
197 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass, request_pt_map),
198 NULL, NULL, g_cclosure_marshal_generic, GST_TYPE_CAPS, 1, G_TYPE_UINT);
201 * GstRtpPtDemux::new-payload-type:
202 * @demux: the object which received the signal
203 * @pt: the payload type
204 * @pad: the pad with the new payload
206 * Emited when a new payload type pad has been created in @demux.
208 gst_rtp_pt_demux_signals[SIGNAL_NEW_PAYLOAD_TYPE] =
209 g_signal_new ("new-payload-type", G_TYPE_FROM_CLASS (klass),
210 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass, new_payload_type),
211 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2, G_TYPE_UINT,
215 * GstRtpPtDemux::payload-type-change:
216 * @demux: the object which received the signal
217 * @pt: the new payload type
219 * Emited when the payload type changed.
221 gst_rtp_pt_demux_signals[SIGNAL_PAYLOAD_TYPE_CHANGE] =
222 g_signal_new ("payload-type-change", G_TYPE_FROM_CLASS (klass),
223 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass,
224 payload_type_change), NULL, NULL, g_cclosure_marshal_VOID__UINT,
225 G_TYPE_NONE, 1, G_TYPE_UINT);
228 * GstRtpPtDemux::clear-pt-map:
229 * @demux: the object which received the signal
231 * The application can call this signal to instruct the element to discard the
232 * currently cached payload type map.
234 gst_rtp_pt_demux_signals[SIGNAL_CLEAR_PT_MAP] =
235 g_signal_new ("clear-pt-map", G_TYPE_FROM_CLASS (klass),
236 G_SIGNAL_ACTION | G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass,
237 clear_pt_map), NULL, NULL, g_cclosure_marshal_VOID__VOID,
238 G_TYPE_NONE, 0, G_TYPE_NONE);
240 gobject_klass->set_property = gst_rtp_pt_demux_set_property;
241 gobject_klass->get_property = gst_rtp_pt_demux_get_property;
244 * GstRtpPtDemux:ignored-payload-types:
246 * If specified, packets with an ignored payload type will be dropped,
247 * instead of causing a new pad to be exposed for these to be pushed on.
249 * This is for example useful to drop FEC protection packets, as they
250 * need to go through the #GstRtpJitterBuffer, but cease to be useful
251 * past that point, #GstRtpBin will make use of this property for that
256 g_object_class_install_property (gobject_klass, PROP_IGNORED_PTS,
257 gst_param_spec_array ("ignored-payload-types",
258 "Ignored payload types",
259 "Packets with these payload types will be dropped",
260 g_param_spec_int ("payload-types", "payload-types", "Payload types",
262 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS),
263 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
265 gobject_klass->finalize = gst_rtp_pt_demux_finalize;
267 gstelement_klass->change_state =
268 GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_change_state);
270 klass->clear_pt_map = GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_clear_pt_map);
272 gst_element_class_add_static_pad_template (gstelement_klass,
273 &rtp_pt_demux_sink_template);
274 gst_element_class_add_static_pad_template (gstelement_klass,
275 &rtp_pt_demux_src_template);
277 gst_element_class_set_static_metadata (gstelement_klass, "RTP Demux",
279 "Parses codec streams transmitted in the same RTP session",
280 "Kai Vehmanen <kai.vehmanen@nokia.com>");
282 GST_DEBUG_CATEGORY_INIT (gst_rtp_pt_demux_debug,
283 "rtpptdemux", 0, "RTP codec demuxer");
285 GST_DEBUG_REGISTER_FUNCPTR (gst_rtp_pt_demux_chain);
289 gst_rtp_pt_demux_init (GstRtpPtDemux * ptdemux)
291 GstElementClass *klass = GST_ELEMENT_GET_CLASS (ptdemux);
294 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
296 g_assert (ptdemux->sink != NULL);
298 gst_pad_set_chain_function (ptdemux->sink, gst_rtp_pt_demux_chain);
299 gst_pad_set_event_function (ptdemux->sink, gst_rtp_pt_demux_sink_event);
301 gst_element_add_pad (GST_ELEMENT (ptdemux), ptdemux->sink);
303 g_value_init (&ptdemux->ignored_pts, GST_TYPE_ARRAY);
307 gst_rtp_pt_demux_finalize (GObject * object)
309 gst_rtp_pt_demux_release (GST_RTP_PT_DEMUX (object));
311 g_value_unset (&GST_RTP_PT_DEMUX (object)->ignored_pts);
313 G_OBJECT_CLASS (parent_class)->finalize (object);
317 gst_rtp_pt_demux_get_caps (GstRtpPtDemux * rtpdemux, guint pt)
321 GValue args[2] = { {0}, {0} };
324 /* figure out the caps */
325 g_value_init (&args[0], GST_TYPE_ELEMENT);
326 g_value_set_object (&args[0], rtpdemux);
327 g_value_init (&args[1], G_TYPE_UINT);
328 g_value_set_uint (&args[1], pt);
330 g_value_init (&ret, GST_TYPE_CAPS);
331 g_value_set_boxed (&ret, NULL);
333 g_signal_emitv (args, gst_rtp_pt_demux_signals[SIGNAL_REQUEST_PT_MAP], 0,
336 g_value_unset (&args[0]);
337 g_value_unset (&args[1]);
338 caps = g_value_dup_boxed (&ret);
339 g_value_unset (&ret);
341 sink_caps = gst_pad_get_current_caps (rtpdemux->sink);
345 caps = gst_caps_ref (sink_caps);
351 caps = gst_caps_make_writable (caps);
352 s1 = gst_caps_get_structure (sink_caps, 0);
353 s2 = gst_caps_get_structure (caps, 0);
355 gst_structure_get_uint (s1, "ssrc", &ssrc);
356 gst_structure_set (s2, "ssrc", G_TYPE_UINT, ssrc, NULL);
359 gst_caps_unref (sink_caps);
362 GST_DEBUG ("pt %d, got caps %" GST_PTR_FORMAT, pt, caps);
368 gst_rtp_pt_demux_clear_pt_map (GstRtpPtDemux * rtpdemux)
372 GST_OBJECT_LOCK (rtpdemux);
373 GST_DEBUG ("clearing pt map");
374 for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
375 GstRtpPtDemuxPad *pad = walk->data;
379 GST_OBJECT_UNLOCK (rtpdemux);
383 need_caps_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt)
386 gboolean ret = FALSE;
388 GST_OBJECT_LOCK (rtpdemux);
389 for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
390 GstRtpPtDemuxPad *pad = walk->data;
396 GST_OBJECT_UNLOCK (rtpdemux);
403 clear_newcaps_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt)
407 GST_OBJECT_LOCK (rtpdemux);
408 for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
409 GstRtpPtDemuxPad *pad = walk->data;
412 pad->newcaps = FALSE;
416 GST_OBJECT_UNLOCK (rtpdemux);
420 forward_sticky_events (GstPad * pad, GstEvent ** event, gpointer user_data)
422 GstPad *srcpad = GST_PAD_CAST (user_data);
424 /* Stream start and caps have already been pushed */
425 if (GST_EVENT_TYPE (*event) >= GST_EVENT_SEGMENT)
426 gst_pad_push_event (srcpad, gst_event_ref (*event));
432 gst_rtp_pt_demux_pt_is_ignored (GstRtpPtDemux * ptdemux, guint8 pt)
434 gboolean ret = FALSE;
437 for (i = 0; i < gst_value_array_get_size (&ptdemux->ignored_pts); i++) {
438 const GValue *tmp = gst_value_array_get_value (&ptdemux->ignored_pts, i);
440 if (g_value_get_int (tmp) == pt) {
450 gst_rtp_pt_demux_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
452 GstFlowReturn ret = GST_FLOW_OK;
453 GstRtpPtDemux *rtpdemux;
457 GstRTPBuffer rtp = { NULL };
459 rtpdemux = GST_RTP_PT_DEMUX (parent);
461 if (!gst_rtp_buffer_map (buf, GST_MAP_READ, &rtp))
464 pt = gst_rtp_buffer_get_payload_type (&rtp);
465 gst_rtp_buffer_unmap (&rtp);
467 if (gst_rtp_pt_demux_pt_is_ignored (rtpdemux, pt))
470 GST_DEBUG_OBJECT (rtpdemux, "received buffer for pt %d", pt);
472 srcpad = find_pad_for_pt (rtpdemux, pt);
473 if (srcpad == NULL) {
474 /* new PT, create a src pad */
475 GstRtpPtDemuxPad *rtpdemuxpad;
476 GstElementClass *klass;
477 GstPadTemplate *templ;
480 caps = gst_rtp_pt_demux_get_caps (rtpdemux, pt);
484 if (gst_rtp_pt_demux_pt_is_ignored (rtpdemux, pt))
487 klass = GST_ELEMENT_GET_CLASS (rtpdemux);
488 templ = gst_element_class_get_pad_template (klass, "src_%u");
489 padname = g_strdup_printf ("src_%u", pt);
490 srcpad = gst_pad_new_from_template (templ, padname);
491 gst_pad_use_fixed_caps (srcpad);
493 gst_pad_set_event_function (srcpad, gst_rtp_pt_demux_src_event);
495 GST_DEBUG ("Adding pt=%d to the list.", pt);
496 rtpdemuxpad = g_slice_new0 (GstRtpPtDemuxPad);
497 rtpdemuxpad->pt = pt;
498 rtpdemuxpad->newcaps = FALSE;
499 rtpdemuxpad->pad = srcpad;
500 gst_object_ref (srcpad);
501 GST_OBJECT_LOCK (rtpdemux);
502 rtpdemux->srcpads = g_slist_append (rtpdemux->srcpads, rtpdemuxpad);
503 GST_OBJECT_UNLOCK (rtpdemux);
505 gst_pad_set_active (srcpad, TRUE);
508 /* First push the stream-start event, it must always come first */
509 gst_pad_push_event (srcpad,
510 gst_pad_get_sticky_event (rtpdemux->sink, GST_EVENT_STREAM_START, 0));
512 /* Then caps event is sent */
513 caps = gst_caps_make_writable (caps);
514 gst_caps_set_simple (caps, "payload", G_TYPE_INT, pt, NULL);
515 gst_pad_set_caps (srcpad, caps);
516 gst_caps_unref (caps);
518 /* First sticky events on sink pad are forwarded to the new src pad */
519 gst_pad_sticky_events_foreach (rtpdemux->sink, forward_sticky_events,
522 gst_element_add_pad (GST_ELEMENT_CAST (rtpdemux), srcpad);
524 GST_DEBUG ("emitting new-payload-type for pt %d", pt);
525 g_signal_emit (G_OBJECT (rtpdemux),
526 gst_rtp_pt_demux_signals[SIGNAL_NEW_PAYLOAD_TYPE], 0, pt, srcpad);
529 if (pt != rtpdemux->last_pt) {
532 /* our own signal with an extra flag that this is the only pad */
533 rtpdemux->last_pt = pt;
534 GST_DEBUG ("emitting payload-type-changed for pt %d", emit_pt);
535 g_signal_emit (G_OBJECT (rtpdemux),
536 gst_rtp_pt_demux_signals[SIGNAL_PAYLOAD_TYPE_CHANGE], 0, emit_pt);
539 while (need_caps_for_pt (rtpdemux, pt)) {
540 GST_DEBUG ("need new caps for %d", pt);
541 caps = gst_rtp_pt_demux_get_caps (rtpdemux, pt);
545 clear_newcaps_for_pt (rtpdemux, pt);
547 caps = gst_caps_make_writable (caps);
548 gst_caps_set_simple (caps, "payload", G_TYPE_INT, pt, NULL);
549 gst_pad_set_caps (srcpad, caps);
550 gst_caps_unref (caps);
554 ret = gst_pad_push (srcpad, buf);
556 gst_object_unref (srcpad);
562 GST_DEBUG_OBJECT (rtpdemux, "Dropped buffer for pt %d", pt);
563 gst_buffer_unref (buf);
570 /* this should not be fatal */
571 GST_ELEMENT_WARNING (rtpdemux, STREAM, DEMUX, (NULL),
572 ("Dropping invalid RTP payload"));
573 gst_buffer_unref (buf);
574 return GST_FLOW_ERROR;
578 GST_ELEMENT_ERROR (rtpdemux, STREAM, DECODE, (NULL),
579 ("Could not get caps for payload"));
580 gst_buffer_unref (buf);
582 gst_object_unref (srcpad);
583 return GST_FLOW_ERROR;
588 find_pad_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt)
590 GstPad *respad = NULL;
593 GST_OBJECT_LOCK (rtpdemux);
594 for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
595 GstRtpPtDemuxPad *pad = walk->data;
598 respad = gst_object_ref (pad->pad);
602 GST_OBJECT_UNLOCK (rtpdemux);
608 gst_rtp_pt_demux_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
610 GstRtpPtDemux *rtpdemux;
611 gboolean res = FALSE;
613 rtpdemux = GST_RTP_PT_DEMUX (parent);
615 switch (GST_EVENT_TYPE (event)) {
618 gst_rtp_pt_demux_clear_pt_map (rtpdemux);
619 /* don't forward the event, we cleared the ptmap and on the next buffer we
620 * will add the pt to the caps and push a new caps event */
621 gst_event_unref (event);
625 case GST_EVENT_CUSTOM_DOWNSTREAM:
627 const GstStructure *s;
629 s = gst_event_get_structure (event);
631 if (gst_structure_has_name (s, "GstRTPPacketLost")) {
632 GstPad *srcpad = find_pad_for_pt (rtpdemux, rtpdemux->last_pt);
635 res = gst_pad_push_event (srcpad, event);
636 gst_object_unref (srcpad);
638 gst_event_unref (event);
642 res = gst_pad_event_default (pad, parent, event);
647 res = gst_pad_event_default (pad, parent, event);
656 gst_rtp_pt_demux_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
658 GstRtpPtDemux *demux;
659 const GstStructure *s;
661 demux = GST_RTP_PT_DEMUX (parent);
663 switch (GST_EVENT_TYPE (event)) {
664 case GST_EVENT_CUSTOM_UPSTREAM:
665 case GST_EVENT_CUSTOM_BOTH:
666 case GST_EVENT_CUSTOM_BOTH_OOB:
667 s = gst_event_get_structure (event);
668 if (s && !gst_structure_has_field (s, "payload")) {
671 GST_OBJECT_LOCK (demux);
672 for (walk = demux->srcpads; walk; walk = g_slist_next (walk)) {
673 GstRtpPtDemuxPad *dpad = (GstRtpPtDemuxPad *) walk->data;
675 if (dpad->pad == pad) {
679 GST_EVENT_CAST (gst_mini_object_make_writable
680 (GST_MINI_OBJECT_CAST (event)));
681 ws = gst_event_writable_structure (event);
682 gst_structure_set (ws, "payload", G_TYPE_UINT, dpad->pt, NULL);
686 GST_OBJECT_UNLOCK (demux);
693 return gst_pad_event_default (pad, parent, event);
697 * Reserves resources for the object.
700 gst_rtp_pt_demux_setup (GstRtpPtDemux * ptdemux)
702 ptdemux->srcpads = NULL;
703 ptdemux->last_pt = 0xFFFF;
709 * Free resources for the object.
712 gst_rtp_pt_demux_release (GstRtpPtDemux * ptdemux)
717 GST_OBJECT_LOCK (ptdemux);
718 tmppads = ptdemux->srcpads;
719 ptdemux->srcpads = NULL;
720 GST_OBJECT_UNLOCK (ptdemux);
722 for (walk = tmppads; walk; walk = g_slist_next (walk)) {
723 GstRtpPtDemuxPad *pad = walk->data;
725 gst_pad_set_active (pad->pad, FALSE);
726 gst_element_remove_pad (GST_ELEMENT_CAST (ptdemux), pad->pad);
727 g_slice_free (GstRtpPtDemuxPad, pad);
729 g_slist_free (tmppads);
732 static GstStateChangeReturn
733 gst_rtp_pt_demux_change_state (GstElement * element, GstStateChange transition)
735 GstStateChangeReturn ret;
736 GstRtpPtDemux *ptdemux;
738 ptdemux = GST_RTP_PT_DEMUX (element);
740 switch (transition) {
741 case GST_STATE_CHANGE_NULL_TO_READY:
742 if (gst_rtp_pt_demux_setup (ptdemux) != TRUE)
743 ret = GST_STATE_CHANGE_FAILURE;
745 case GST_STATE_CHANGE_READY_TO_PAUSED:
746 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
751 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
753 switch (transition) {
754 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
755 case GST_STATE_CHANGE_PAUSED_TO_READY:
757 case GST_STATE_CHANGE_READY_TO_NULL:
758 gst_rtp_pt_demux_release (ptdemux);