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., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
27 * SECTION:element-gstrtpptdemux
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.
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 on the
39 * outgoing buffers and pads based on the result of the
40 * #GstRtpPtDemux::request-pt-map signal.
43 * <title>Example pipelines</title>
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.
50 * Last reviewed on 2007-05-28 (0.10.5)
55 * Andre Moreira Magalhaes <andre.magalhaes@indt.org.br>
59 * - works with the test_rtpdemux.c tool
62 * - is emitting a signal enough, or should we
63 * use GstEvent to notify downstream elements
64 * of the new packet... no?
67 * - emits event both for new PTs, and whenever
77 #include <gst/rtp/gstrtpbuffer.h>
79 #include "gstrtpbin-marshal.h"
80 #include "gstrtpptdemux.h"
82 /* generic templates */
83 static GstStaticPadTemplate rtp_pt_demux_sink_template =
84 GST_STATIC_PAD_TEMPLATE ("sink",
87 GST_STATIC_CAPS ("application/x-rtp")
90 static GstStaticPadTemplate rtp_pt_demux_src_template =
91 GST_STATIC_PAD_TEMPLATE ("src_%d",
94 GST_STATIC_CAPS ("application/x-rtp, " "payload = (int) [ 0, 255 ]")
97 GST_DEBUG_CATEGORY_STATIC (gst_rtp_pt_demux_debug);
98 #define GST_CAT_DEFAULT gst_rtp_pt_demux_debug
101 * Item for storing GstPad<->pt pairs.
103 struct _GstRtpPtDemuxPad
105 GstPad *pad; /**< pointer to the actual pad */
106 gint pt; /**< RTP payload-type attached to pad */
113 SIGNAL_REQUEST_PT_MAP,
114 SIGNAL_NEW_PAYLOAD_TYPE,
115 SIGNAL_PAYLOAD_TYPE_CHANGE,
120 GST_BOILERPLATE (GstRtpPtDemux, gst_rtp_pt_demux, GstElement, GST_TYPE_ELEMENT);
122 static void gst_rtp_pt_demux_finalize (GObject * object);
124 static void gst_rtp_pt_demux_release (GstRtpPtDemux * ptdemux);
125 static gboolean gst_rtp_pt_demux_setup (GstRtpPtDemux * ptdemux);
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);
133 static GstRtpPtDemuxPad *find_pad_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt);
135 static guint gst_rtp_pt_demux_signals[LAST_SIGNAL] = { 0 };
137 static GstElementDetails gst_rtp_pt_demux_details = {
140 "Parses codec streams transmitted in the same RTP session",
141 "Kai Vehmanen <kai.vehmanen@nokia.com>"
145 gst_rtp_pt_demux_base_init (gpointer g_class)
147 GstElementClass *gstelement_klass = GST_ELEMENT_CLASS (g_class);
149 gst_element_class_add_pad_template (gstelement_klass,
150 gst_static_pad_template_get (&rtp_pt_demux_sink_template));
151 gst_element_class_add_pad_template (gstelement_klass,
152 gst_static_pad_template_get (&rtp_pt_demux_src_template));
154 gst_element_class_set_details (gstelement_klass, &gst_rtp_pt_demux_details);
158 gst_rtp_pt_demux_class_init (GstRtpPtDemuxClass * klass)
160 GObjectClass *gobject_klass;
161 GstElementClass *gstelement_klass;
163 gobject_klass = (GObjectClass *) klass;
164 gstelement_klass = (GstElementClass *) klass;
167 * GstRtpPtDemux::request-pt-map:
168 * @demux: the object which received the signal
169 * @pt: the payload type
171 * Request the payload type as #GstCaps for @pt.
173 gst_rtp_pt_demux_signals[SIGNAL_REQUEST_PT_MAP] =
174 g_signal_new ("request-pt-map", G_TYPE_FROM_CLASS (klass),
175 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass, request_pt_map),
176 NULL, NULL, gst_rtp_bin_marshal_BOXED__UINT, GST_TYPE_CAPS, 1,
180 * GstRtpPtDemux::new-payload-type:
181 * @demux: the object which received the signal
182 * @pt: the payload type
183 * @pad: the pad with the new payload
185 * Emited when a new payload type pad has been created in @demux.
187 gst_rtp_pt_demux_signals[SIGNAL_NEW_PAYLOAD_TYPE] =
188 g_signal_new ("new-payload-type", G_TYPE_FROM_CLASS (klass),
189 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass, new_payload_type),
190 NULL, NULL, gst_rtp_bin_marshal_VOID__UINT_OBJECT, G_TYPE_NONE, 2,
191 G_TYPE_UINT, GST_TYPE_PAD);
194 * GstRtpPtDemux::payload-type-change:
195 * @demux: the object which received the signal
196 * @pt: the new payload type
198 * Emited when the payload type changed.
200 gst_rtp_pt_demux_signals[SIGNAL_PAYLOAD_TYPE_CHANGE] =
201 g_signal_new ("payload-type-change", G_TYPE_FROM_CLASS (klass),
202 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass,
203 payload_type_change), NULL, NULL, g_cclosure_marshal_VOID__UINT,
204 G_TYPE_NONE, 1, G_TYPE_UINT);
207 * GstRtpPtDemux::clear-pt-map:
208 * @demux: the object which received the signal
210 * The application can call this signal to instruct the element to discard the
211 * currently cached payload type map.
213 gst_rtp_pt_demux_signals[SIGNAL_CLEAR_PT_MAP] =
214 g_signal_new ("clear-pt-map", G_TYPE_FROM_CLASS (klass),
215 G_SIGNAL_ACTION | G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRtpPtDemuxClass,
216 clear_pt_map), NULL, NULL, g_cclosure_marshal_VOID__VOID,
217 G_TYPE_NONE, 0, G_TYPE_NONE);
219 gobject_klass->finalize = GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_finalize);
221 gstelement_klass->change_state =
222 GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_change_state);
224 klass->clear_pt_map = GST_DEBUG_FUNCPTR (gst_rtp_pt_demux_clear_pt_map);
226 GST_DEBUG_CATEGORY_INIT (gst_rtp_pt_demux_debug,
227 "rtpptdemux", 0, "RTP codec demuxer");
231 gst_rtp_pt_demux_init (GstRtpPtDemux * ptdemux, GstRtpPtDemuxClass * g_class)
233 GstElementClass *klass = GST_ELEMENT_GET_CLASS (ptdemux);
236 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
238 g_assert (ptdemux->sink != NULL);
240 gst_pad_set_chain_function (ptdemux->sink, gst_rtp_pt_demux_chain);
241 gst_pad_set_event_function (ptdemux->sink, gst_rtp_pt_demux_sink_event);
243 gst_element_add_pad (GST_ELEMENT (ptdemux), ptdemux->sink);
247 gst_rtp_pt_demux_finalize (GObject * object)
249 gst_rtp_pt_demux_release (GST_RTP_PT_DEMUX (object));
251 G_OBJECT_CLASS (parent_class)->finalize (object);
255 gst_rtp_pt_demux_get_caps (GstRtpPtDemux * rtpdemux, guint pt)
259 GValue args[2] = { {0}, {0} };
261 /* figure out the caps */
262 g_value_init (&args[0], GST_TYPE_ELEMENT);
263 g_value_set_object (&args[0], rtpdemux);
264 g_value_init (&args[1], G_TYPE_UINT);
265 g_value_set_uint (&args[1], pt);
267 g_value_init (&ret, GST_TYPE_CAPS);
268 g_value_set_boxed (&ret, NULL);
270 g_signal_emitv (args, gst_rtp_pt_demux_signals[SIGNAL_REQUEST_PT_MAP], 0,
273 g_value_unset (&args[0]);
274 g_value_unset (&args[1]);
275 caps = g_value_dup_boxed (&ret);
276 g_value_unset (&ret);
278 caps = GST_PAD_CAPS (rtpdemux->sink);
283 GST_DEBUG ("pt %d, got caps %" GST_PTR_FORMAT, pt, caps);
289 gst_rtp_pt_demux_clear_pt_map (GstRtpPtDemux * rtpdemux)
293 GST_OBJECT_LOCK (rtpdemux);
294 GST_DEBUG ("clearing pt map");
295 for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
296 GstRtpPtDemuxPad *pad = walk->data;
300 GST_OBJECT_UNLOCK (rtpdemux);
304 gst_rtp_pt_demux_chain (GstPad * pad, GstBuffer * buf)
306 GstFlowReturn ret = GST_FLOW_OK;
307 GstRtpPtDemux *rtpdemux;
308 GstElement *element = GST_ELEMENT (GST_OBJECT_PARENT (pad));
311 GstRtpPtDemuxPad *rtpdemuxpad;
314 rtpdemux = GST_RTP_PT_DEMUX (GST_OBJECT_PARENT (pad));
316 if (!gst_rtp_buffer_validate (buf))
319 pt = gst_rtp_buffer_get_payload_type (buf);
321 GST_DEBUG_OBJECT (rtpdemux, "received buffer for pt %d", pt);
323 rtpdemuxpad = find_pad_for_pt (rtpdemux, pt);
324 if (rtpdemuxpad == NULL) {
325 /* new PT, create a src pad */
326 GstElementClass *klass;
327 GstPadTemplate *templ;
330 klass = GST_ELEMENT_GET_CLASS (rtpdemux);
331 templ = gst_element_class_get_pad_template (klass, "src_%d");
332 padname = g_strdup_printf ("src_%d", pt);
333 srcpad = gst_pad_new_from_template (templ, padname);
334 gst_pad_use_fixed_caps (srcpad);
337 caps = gst_rtp_pt_demux_get_caps (rtpdemux, pt);
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);
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);
355 gst_pad_set_active (srcpad, TRUE);
356 gst_element_add_pad (element, srcpad);
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);
363 srcpad = rtpdemuxpad->pad;
365 if (pt != rtpdemux->last_pt) {
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);
375 if (rtpdemuxpad->newcaps) {
376 GST_DEBUG ("need new caps");
377 caps = gst_rtp_pt_demux_get_caps (rtpdemux, pt);
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;
388 gst_buffer_set_caps (buf, GST_PAD_CAPS (srcpad));
391 ret = gst_pad_push (srcpad, buf);
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;
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;
413 static GstRtpPtDemuxPad *
414 find_pad_for_pt (GstRtpPtDemux * rtpdemux, guint8 pt)
416 GstRtpPtDemuxPad *respad = NULL;
419 for (walk = rtpdemux->srcpads; walk; walk = g_slist_next (walk)) {
420 GstRtpPtDemuxPad *pad = walk->data;
431 gst_rtp_pt_demux_sink_event (GstPad * pad, GstEvent * event)
433 GstRtpPtDemux *rtpdemux;
434 gboolean res = FALSE;
436 rtpdemux = GST_RTP_PT_DEMUX (GST_PAD_PARENT (pad));
438 switch (GST_EVENT_TYPE (event)) {
439 case GST_EVENT_CUSTOM_DOWNSTREAM:
441 const GstStructure *s;
443 s = gst_event_get_structure (event);
445 if (gst_structure_has_name (s, "GstRTPPacketLost")) {
446 GstRtpPtDemuxPad *rtpdemuxpad =
447 find_pad_for_pt (rtpdemux, rtpdemux->last_pt);
450 res = gst_pad_push_event (rtpdemuxpad->pad, event);
453 res = gst_pad_event_default (pad, event);
457 res = gst_pad_event_default (pad, event);
465 * Reserves resources for the object.
468 gst_rtp_pt_demux_setup (GstRtpPtDemux * ptdemux)
470 ptdemux->srcpads = NULL;
471 ptdemux->last_pt = 0xFFFF;
477 * Free resources for the object.
480 gst_rtp_pt_demux_release (GstRtpPtDemux * ptdemux)
484 for (walk = ptdemux->srcpads; walk; walk = g_slist_next (walk)) {
485 GstRtpPtDemuxPad *pad = walk->data;
487 gst_pad_set_active (pad->pad, FALSE);
488 gst_element_remove_pad (GST_ELEMENT_CAST (ptdemux), pad->pad);
491 g_slist_free (ptdemux->srcpads);
492 ptdemux->srcpads = NULL;
495 static GstStateChangeReturn
496 gst_rtp_pt_demux_change_state (GstElement * element, GstStateChange transition)
498 GstStateChangeReturn ret;
499 GstRtpPtDemux *ptdemux;
501 ptdemux = GST_RTP_PT_DEMUX (element);
503 switch (transition) {
504 case GST_STATE_CHANGE_NULL_TO_READY:
505 if (gst_rtp_pt_demux_setup (ptdemux) != TRUE)
506 ret = GST_STATE_CHANGE_FAILURE;
508 case GST_STATE_CHANGE_READY_TO_PAUSED:
509 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
514 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
516 switch (transition) {
517 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
518 case GST_STATE_CHANGE_PAUSED_TO_READY:
520 case GST_STATE_CHANGE_READY_TO_NULL:
521 gst_rtp_pt_demux_release (ptdemux);