1 /* RTP muxer element for GStreamer
5 * Copyright (C) <2007> Nokia Corporation.
6 * Contact: Zeeshan Ali <zeeshan.ali@nokia.com>
7 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
8 * 2000,2005 Wim Taymans <wim@fluendo.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-rtpmux
28 * @short_description: Muxer that takes one or several RTP streams
29 * and muxes them to a single rtp stream.
40 #include <gst/rtp/gstrtpbuffer.h>
41 #include <gstrtpmux.h>
44 GST_DEBUG_CATEGORY_STATIC (gst_rtp_mux_debug);
45 #define GST_CAT_DEFAULT gst_rtp_mux_debug
47 /* elementfactory information */
48 static const GstElementDetails gst_rtp_mux_details =
49 GST_ELEMENT_DETAILS ("RTP muxer",
51 "multiplex N rtp streams into one",
52 "Zeeshan Ali <first.last@nokia.com>");
57 PROP_TIMESTAMP_OFFSET,
63 #define DEFAULT_TIMESTAMP_OFFSET -1
64 #define DEFAULT_SEQNUM_OFFSET -1
65 #define DEFAULT_SSRC -1
68 gboolean have_ts_base;
70 } GstRTPMuxPadPrivate;
72 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
75 GST_STATIC_CAPS ("application/x-rtp")
78 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink_%d",
81 GST_STATIC_CAPS ("application/x-rtp")
84 static void gst_rtp_mux_base_init (gpointer g_class);
85 static void gst_rtp_mux_class_init (GstRTPMuxClass * klass);
86 static void gst_rtp_mux_init (GstRTPMux * rtp_mux);
88 static void gst_rtp_mux_finalize (GObject * object);
90 static GstPad *gst_rtp_mux_request_new_pad (GstElement * element,
91 GstPadTemplate * templ, const gchar * name);
92 static void gst_rtp_mux_release_pad (GstElement * element, GstPad *pad);
93 static GstFlowReturn gst_rtp_mux_chain (GstPad * pad,
95 static gboolean gst_rtp_mux_setcaps (GstPad *pad, GstCaps *caps);
96 static GstCaps * gst_rtp_mux_getcaps (GstPad *pad);
98 static GstStateChangeReturn gst_rtp_mux_change_state (GstElement *
99 element, GstStateChange transition);
101 static void gst_rtp_mux_set_property (GObject * object, guint prop_id,
102 const GValue * value, GParamSpec * pspec);
103 static void gst_rtp_mux_get_property (GObject * object, guint prop_id,
104 GValue * value, GParamSpec * pspec);
106 static gboolean gst_rtp_mux_src_event (GstPad * pad, GstEvent * event);
108 static GstElementClass *parent_class = NULL;
111 gst_rtp_mux_get_type (void)
113 static GType rtp_mux_type = 0;
116 static const GTypeInfo rtp_mux_info = {
117 sizeof (GstRTPMuxClass),
118 gst_rtp_mux_base_init,
120 (GClassInitFunc) gst_rtp_mux_class_init,
125 (GInstanceInitFunc) gst_rtp_mux_init,
129 g_type_register_static (GST_TYPE_ELEMENT, "GstRTPMux",
136 gst_rtp_mux_base_init (gpointer g_class)
138 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
140 gst_element_class_add_pad_template (element_class,
141 gst_static_pad_template_get (&src_factory));
142 gst_element_class_add_pad_template (element_class,
143 gst_static_pad_template_get (&sink_factory));
145 gst_element_class_set_details (element_class, &gst_rtp_mux_details);
149 gst_rtp_mux_class_init (GstRTPMuxClass * klass)
151 GObjectClass *gobject_class;
152 GstElementClass *gstelement_class;
154 gobject_class = (GObjectClass *) klass;
155 gstelement_class = (GstElementClass *) klass;
157 parent_class = g_type_class_peek_parent (klass);
159 gobject_class->finalize = gst_rtp_mux_finalize;
160 gobject_class->get_property = gst_rtp_mux_get_property;
161 gobject_class->set_property = gst_rtp_mux_set_property;
163 g_object_class_install_property (G_OBJECT_CLASS (klass),
164 PROP_TIMESTAMP_OFFSET, g_param_spec_int ("timestamp-offset",
166 "Offset to add to all outgoing timestamps (-1 = random)", -1,
167 G_MAXINT, DEFAULT_TIMESTAMP_OFFSET, G_PARAM_READWRITE));
168 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM_OFFSET,
169 g_param_spec_int ("seqnum-offset", "Sequence number Offset",
170 "Offset to add to all outgoing seqnum (-1 = random)", -1, G_MAXINT,
171 DEFAULT_SEQNUM_OFFSET, G_PARAM_READWRITE));
172 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM,
173 g_param_spec_uint ("seqnum", "Sequence number",
174 "The RTP sequence number of the last processed packet",
175 0, G_MAXUINT, 0, G_PARAM_READABLE));
176 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SSRC,
177 g_param_spec_uint ("ssrc", "SSRC",
178 "The SSRC of the packets (-1 == random)",
179 0, G_MAXUINT, DEFAULT_SSRC, G_PARAM_READWRITE));
181 gstelement_class->request_new_pad = gst_rtp_mux_request_new_pad;
182 gstelement_class->release_pad = gst_rtp_mux_release_pad;
183 gstelement_class->change_state = gst_rtp_mux_change_state;
185 klass->chain_func = gst_rtp_mux_chain;
188 static gboolean gst_rtp_mux_src_event (GstPad * pad,
194 gboolean result = FALSE;
195 gboolean done = FALSE;
197 rtp_mux = gst_pad_get_parent_element (pad);
198 g_return_val_if_fail (rtp_mux != NULL, FALSE);
200 iter = gst_element_iterate_sink_pads (rtp_mux);
203 switch (gst_iterator_next (iter, (gpointer) &sinkpad)) {
204 case GST_ITERATOR_OK:
205 gst_event_ref (event);
206 result |= gst_pad_push_event (sinkpad, event);
207 gst_object_unref (sinkpad);
209 case GST_ITERATOR_RESYNC:
210 gst_iterator_resync (iter);
213 case GST_ITERATOR_ERROR:
214 GST_WARNING_OBJECT (rtp_mux, "Error iterating sinkpads");
215 case GST_ITERATOR_DONE:
220 gst_iterator_free (iter);
221 gst_object_unref (rtp_mux);
222 gst_event_unref (event);
228 gst_rtp_mux_init (GstRTPMux * rtp_mux)
230 GstElementClass *klass = GST_ELEMENT_GET_CLASS (rtp_mux);
233 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
235 gst_pad_set_event_function (rtp_mux->srcpad, gst_rtp_mux_src_event);
236 gst_element_add_pad (GST_ELEMENT (rtp_mux), rtp_mux->srcpad);
238 rtp_mux->ssrc = DEFAULT_SSRC;
239 rtp_mux->ts_offset = DEFAULT_TIMESTAMP_OFFSET;
240 rtp_mux->seqnum_offset = DEFAULT_SEQNUM_OFFSET;
244 gst_rtp_mux_finalize (GObject * object)
248 rtp_mux = GST_RTP_MUX (object);
250 G_OBJECT_CLASS (parent_class)->finalize (object);
254 gst_rtp_mux_create_sinkpad (GstRTPMux * rtp_mux, GstPadTemplate * templ)
256 GstPad *newpad = NULL;
257 GstPadTemplate * class_templ;
259 class_templ = gst_element_class_get_pad_template (
260 GST_ELEMENT_GET_CLASS (rtp_mux), "sink_%d");
262 if (templ == class_templ) {
265 /* create new pad with the name */
266 name = g_strdup_printf ("sink_%02d", rtp_mux->numpads);
267 newpad = gst_pad_new_from_template (templ, name);
272 GST_WARNING_OBJECT (rtp_mux, "this is not our template!\n");
279 gst_rtp_mux_setup_sinkpad (GstRTPMux * rtp_mux, GstPad * sinkpad)
281 GstRTPMuxClass *klass;
282 GstRTPMuxPadPrivate *padpriv = g_slice_new0 (GstRTPMuxPadPrivate);
284 klass = GST_RTP_MUX_GET_CLASS (rtp_mux);
286 /* setup some pad functions */
287 gst_pad_set_setcaps_function (sinkpad, gst_rtp_mux_setcaps);
288 gst_pad_set_getcaps_function (sinkpad, gst_rtp_mux_getcaps);
289 if (klass->chain_func)
290 gst_pad_set_chain_function (sinkpad, klass->chain_func);
291 if (klass->sink_event_func)
292 gst_pad_set_event_function (sinkpad, klass->sink_event_func);
294 /* This could break with gstreamer 0.10.9 */
295 gst_pad_set_active (sinkpad, TRUE);
297 gst_pad_set_element_private (sinkpad, padpriv);
299 /* dd the pad to the element */
300 gst_element_add_pad (GST_ELEMENT (rtp_mux), sinkpad);
304 gst_rtp_mux_request_new_pad (GstElement * element,
305 GstPadTemplate * templ, const gchar * req_name)
310 g_return_val_if_fail (templ != NULL, NULL);
311 g_return_val_if_fail (GST_IS_RTP_MUX (element), NULL);
313 rtp_mux = GST_RTP_MUX (element);
315 if (templ->direction != GST_PAD_SINK) {
316 GST_WARNING_OBJECT (rtp_mux, "request pad that is not a SINK pad");
320 newpad = gst_rtp_mux_create_sinkpad (rtp_mux, templ);
322 gst_rtp_mux_setup_sinkpad (rtp_mux, newpad);
324 GST_WARNING_OBJECT (rtp_mux, "failed to create request pad");
330 gst_rtp_mux_release_pad (GstElement * element, GstPad *pad)
332 GstRTPMuxPadPrivate *padpriv = gst_pad_get_element_private (pad);
335 g_slice_free (GstRTPMuxPadPrivate, padpriv);
336 gst_pad_set_element_private (pad, NULL);
338 gst_element_remove_pad (element, pad);
341 /* Put our own clock-base on the buffer */
343 gst_rtp_mux_readjust_rtp_timestamp (GstRTPMux * rtp_mux, GstPad * pad,
347 guint32 sink_ts_base = 0;
348 GstRTPMuxPadPrivate *padpriv = gst_pad_get_element_private (pad);
350 if (padpriv->have_ts_base)
351 sink_ts_base = padpriv->clock_base;
353 ts = gst_rtp_buffer_get_timestamp (buffer) - sink_ts_base + rtp_mux->ts_base;
354 GST_LOG_OBJECT (rtp_mux, "Re-adjusting RTP ts %u to %u",
355 gst_rtp_buffer_get_timestamp (buffer), ts);
356 gst_rtp_buffer_set_timestamp (buffer, ts);
360 gst_rtp_mux_chain (GstPad * pad, GstBuffer * buffer)
363 GstStructure * structure;
366 rtp_mux = GST_RTP_MUX (gst_pad_get_parent (pad));
368 if (!gst_rtp_buffer_validate (buffer)) {
369 GST_ERROR_OBJECT (rtp_mux, "Invalid RTP buffer");
370 gst_object_unref (rtp_mux);
371 return GST_FLOW_ERROR;
374 buffer = gst_buffer_make_writable(buffer);
376 GST_OBJECT_LOCK (rtp_mux);
378 gst_rtp_buffer_set_seq (buffer, rtp_mux->seqnum);
379 GST_OBJECT_UNLOCK (rtp_mux);
380 GST_BUFFER_CAPS (buffer) = gst_caps_make_writable(GST_BUFFER_CAPS (buffer));
381 structure = gst_caps_get_structure (GST_BUFFER_CAPS (buffer), 0U);
382 gst_structure_set (structure, "seqnum-base", G_TYPE_UINT, rtp_mux->seqnum_base, NULL);
383 gst_rtp_buffer_set_ssrc (buffer, rtp_mux->current_ssrc);
384 gst_rtp_mux_readjust_rtp_timestamp (rtp_mux, pad, buffer);
385 GST_LOG_OBJECT (rtp_mux, "Pushing packet size %d, seq=%d, ts=%u",
386 GST_BUFFER_SIZE (buffer), rtp_mux->seqnum,
387 gst_rtp_buffer_get_timestamp (buffer));
389 gst_buffer_set_caps (buffer, GST_PAD_CAPS (rtp_mux->srcpad));
391 ret = gst_pad_push (rtp_mux->srcpad, buffer);
393 gst_object_unref (rtp_mux);
398 gst_rtp_mux_setcaps (GstPad *pad, GstCaps *caps)
401 GstStructure *structure;
403 GstRTPMuxPadPrivate *padpriv = gst_pad_get_element_private (pad);
405 rtp_mux = GST_RTP_MUX (gst_pad_get_parent (pad));
407 structure = gst_caps_get_structure (caps, 0);
412 if (gst_structure_get_uint (structure, "clock-base", &padpriv->clock_base)) {
413 padpriv->have_ts_base = TRUE;
416 caps = gst_caps_copy (caps);
418 gst_caps_set_simple (caps,
419 "clock-base", G_TYPE_UINT, rtp_mux->ts_base,
420 "seqnum-base", G_TYPE_UINT, rtp_mux->seqnum_base,
423 GST_DEBUG_OBJECT (rtp_mux,
424 "setting caps %" GST_PTR_FORMAT " on src pad..", caps);
425 ret = gst_pad_set_caps (rtp_mux->srcpad, caps);
426 gst_caps_unref (caps);
429 gst_object_unref (rtp_mux);
435 clear_caps (GstCaps *caps)
439 /* Lets only match on the clock-rate */
440 for (i = 0; i < gst_caps_get_size (caps); i++) {
441 GstStructure *s = gst_caps_get_structure (caps, i);
443 for (j = 0; j < gst_structure_n_fields (s); j++) {
444 const gchar *name = gst_structure_nth_field_name (s, j);
446 if (strcmp (name, "clock-rate")) {
447 gst_structure_remove_field (s, name);
455 same_clock_rate_fold (gpointer item, GValue *ret, gpointer user_data)
457 GstPad *mypad = user_data;
461 const GstCaps *accumcaps;
467 peercaps = gst_pad_peer_get_caps (pad);
471 othercaps = gst_caps_intersect (peercaps,
472 gst_pad_get_pad_template_caps (pad));
473 gst_caps_unref (peercaps);
475 accumcaps = gst_value_get_caps (ret);
477 clear_caps (othercaps);
479 intersect = gst_caps_intersect (accumcaps, othercaps);
481 g_value_take_boxed (ret, intersect);
483 gst_caps_unref (othercaps);
485 return !gst_caps_is_empty (intersect);
489 gst_rtp_mux_getcaps (GstPad *pad)
491 GstRTPMux *mux = GST_RTP_MUX (gst_pad_get_parent (pad));
492 GstCaps *caps = NULL;
493 GstIterator *iter = NULL;
495 GstIteratorResult res;
496 GstCaps *peercaps = gst_pad_peer_get_caps (mux->srcpad);
497 GstCaps *othercaps = NULL;
500 othercaps = gst_caps_intersect (peercaps,
501 gst_pad_get_pad_template_caps (pad));
502 gst_caps_unref (peercaps);
505 othercaps = gst_caps_copy (gst_pad_get_pad_template_caps (mux->srcpad));
508 clear_caps (othercaps);
510 g_value_init (&v, GST_TYPE_CAPS);
512 iter = gst_element_iterate_sink_pads (GST_ELEMENT (mux));
514 gst_value_set_caps (&v, othercaps);
515 res = gst_iterator_fold (iter, same_clock_rate_fold, &v, pad);
516 } while (res == GST_ITERATOR_RESYNC);
517 gst_iterator_free (iter);
519 caps = (GstCaps*) gst_value_get_caps (&v);
521 if (res == GST_ITERATOR_ERROR) {
522 gst_caps_unref (caps);
523 caps = gst_caps_new_empty ();
527 gst_caps_unref (othercaps);
528 gst_object_unref (mux);
535 gst_rtp_mux_get_property (GObject * object,
536 guint prop_id, GValue * value, GParamSpec * pspec)
540 rtp_mux = GST_RTP_MUX (object);
543 case PROP_TIMESTAMP_OFFSET:
544 g_value_set_int (value, rtp_mux->ts_offset);
546 case PROP_SEQNUM_OFFSET:
547 g_value_set_int (value, rtp_mux->seqnum_offset);
550 GST_OBJECT_LOCK (rtp_mux);
551 g_value_set_uint (value, rtp_mux->seqnum);
552 GST_OBJECT_UNLOCK (rtp_mux);
555 g_value_set_uint (value, rtp_mux->ssrc);
558 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
564 gst_rtp_mux_set_property (GObject * object,
565 guint prop_id, const GValue * value, GParamSpec * pspec)
569 rtp_mux = GST_RTP_MUX (object);
572 case PROP_TIMESTAMP_OFFSET:
573 rtp_mux->ts_offset = g_value_get_int (value);
575 case PROP_SEQNUM_OFFSET:
576 rtp_mux->seqnum_offset = g_value_get_int (value);
579 rtp_mux->ssrc = g_value_get_uint (value);
582 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
588 gst_rtp_mux_ready_to_paused (GstRTPMux * rtp_mux)
590 GST_OBJECT_LOCK (rtp_mux);
592 if (rtp_mux->ssrc == -1)
593 rtp_mux->current_ssrc = g_random_int ();
595 rtp_mux->current_ssrc = rtp_mux->ssrc;
597 if (rtp_mux->seqnum_offset == -1)
598 rtp_mux->seqnum_base = g_random_int_range (0, G_MAXUINT16);
600 rtp_mux->seqnum_base = rtp_mux->seqnum_offset;
601 rtp_mux->seqnum = rtp_mux->seqnum_base;
603 if (rtp_mux->ts_offset == -1)
604 rtp_mux->ts_base = g_random_int ();
606 rtp_mux->ts_base = rtp_mux->ts_offset;
607 GST_DEBUG_OBJECT (rtp_mux, "set clock-base to %u", rtp_mux->ts_base);
609 GST_OBJECT_UNLOCK (rtp_mux);
612 static GstStateChangeReturn
613 gst_rtp_mux_change_state (GstElement * element, GstStateChange transition)
617 rtp_mux = GST_RTP_MUX (element);
619 switch (transition) {
620 case GST_STATE_CHANGE_NULL_TO_READY:
622 case GST_STATE_CHANGE_READY_TO_PAUSED:
623 gst_rtp_mux_ready_to_paused (rtp_mux);
625 case GST_STATE_CHANGE_PAUSED_TO_READY:
631 return GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
635 gst_rtp_mux_plugin_init (GstPlugin * plugin)
637 GST_DEBUG_CATEGORY_INIT (gst_rtp_mux_debug, "rtpmux", 0,
640 return gst_element_register (plugin, "rtpmux", GST_RANK_NONE,