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
29 * The rtp muxer takes multiple RTP streams having the same clock-rate and
30 * muxes into a single stream with a single SSRC.
38 #include <gst/rtp/gstrtpbuffer.h>
41 #include "gstrtpmux.h"
43 GST_DEBUG_CATEGORY_STATIC (gst_rtp_mux_debug);
44 #define GST_CAT_DEFAULT gst_rtp_mux_debug
49 PROP_TIMESTAMP_OFFSET,
55 #define DEFAULT_TIMESTAMP_OFFSET -1
56 #define DEFAULT_SEQNUM_OFFSET -1
57 #define DEFAULT_SSRC -1
61 gboolean have_clock_base;
65 } GstRTPMuxPadPrivate;
67 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
70 GST_STATIC_CAPS ("application/x-rtp")
73 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink_%d",
76 GST_STATIC_CAPS ("application/x-rtp")
79 static GstPad *gst_rtp_mux_request_new_pad (GstElement * element,
80 GstPadTemplate * templ, const gchar * name);
81 static void gst_rtp_mux_release_pad (GstElement * element, GstPad * pad);
82 static GstFlowReturn gst_rtp_mux_chain (GstPad * pad, GstBuffer * buffer);
83 static gboolean gst_rtp_mux_setcaps (GstPad * pad, GstCaps * caps);
84 static GstCaps *gst_rtp_mux_getcaps (GstPad * pad);
86 static GstStateChangeReturn gst_rtp_mux_change_state (GstElement *
87 element, GstStateChange transition);
89 static void gst_rtp_mux_set_property (GObject * object, guint prop_id,
90 const GValue * value, GParamSpec * pspec);
91 static void gst_rtp_mux_get_property (GObject * object, guint prop_id,
92 GValue * value, GParamSpec * pspec);
93 static void gst_rtp_mux_dispose (GObject * object);
95 GST_BOILERPLATE (GstRTPMux, gst_rtp_mux, GstElement, GST_TYPE_ELEMENT);
98 gst_rtp_mux_base_init (gpointer g_class)
100 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
102 gst_element_class_add_pad_template (element_class,
103 gst_static_pad_template_get (&src_factory));
104 gst_element_class_add_pad_template (element_class,
105 gst_static_pad_template_get (&sink_factory));
107 gst_element_class_set_details_simple (element_class, "RTP muxer",
109 "multiplex N rtp streams into one", "Zeeshan Ali <first.last@nokia.com>");
113 gst_rtp_mux_class_init (GstRTPMuxClass * klass)
115 GObjectClass *gobject_class;
116 GstElementClass *gstelement_class;
118 gobject_class = (GObjectClass *) klass;
119 gstelement_class = (GstElementClass *) klass;
121 gobject_class->get_property = gst_rtp_mux_get_property;
122 gobject_class->set_property = gst_rtp_mux_set_property;
123 gobject_class->dispose = gst_rtp_mux_dispose;
125 g_object_class_install_property (G_OBJECT_CLASS (klass),
126 PROP_TIMESTAMP_OFFSET, g_param_spec_int ("timestamp-offset",
128 "Offset to add to all outgoing timestamps (-1 = random)", -1,
129 G_MAXINT, DEFAULT_TIMESTAMP_OFFSET, G_PARAM_READWRITE));
130 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM_OFFSET,
131 g_param_spec_int ("seqnum-offset", "Sequence number Offset",
132 "Offset to add to all outgoing seqnum (-1 = random)", -1, G_MAXINT,
133 DEFAULT_SEQNUM_OFFSET, G_PARAM_READWRITE));
134 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM,
135 g_param_spec_uint ("seqnum", "Sequence number",
136 "The RTP sequence number of the last processed packet",
137 0, G_MAXUINT, 0, G_PARAM_READABLE));
138 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SSRC,
139 g_param_spec_uint ("ssrc", "SSRC",
140 "The SSRC of the packets (-1 == random)",
141 0, G_MAXUINT, DEFAULT_SSRC, G_PARAM_READWRITE));
143 gstelement_class->request_new_pad =
144 GST_DEBUG_FUNCPTR (gst_rtp_mux_request_new_pad);
145 gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_rtp_mux_release_pad);
146 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_rtp_mux_change_state);
148 klass->chain_func = gst_rtp_mux_chain;
152 gst_rtp_mux_dispose (GObject * object)
157 for (item = GST_ELEMENT_PADS (object); item; item = g_list_next (item)) {
158 GstPad *pad = GST_PAD (item->data);
159 if (GST_PAD_IS_SINK (pad)) {
160 gst_element_release_request_pad (GST_ELEMENT (object), pad);
165 G_OBJECT_CLASS (parent_class)->dispose (object);
169 gst_rtp_mux_src_event (GstPad * pad, GstEvent * event)
174 gboolean result = FALSE;
175 gboolean done = FALSE;
177 rtp_mux = gst_pad_get_parent_element (pad);
178 g_return_val_if_fail (rtp_mux != NULL, FALSE);
180 iter = gst_element_iterate_sink_pads (rtp_mux);
183 switch (gst_iterator_next (iter, (gpointer) & sinkpad)) {
184 case GST_ITERATOR_OK:
185 gst_event_ref (event);
186 result |= gst_pad_push_event (sinkpad, event);
187 gst_object_unref (sinkpad);
189 case GST_ITERATOR_RESYNC:
190 gst_iterator_resync (iter);
193 case GST_ITERATOR_ERROR:
194 GST_WARNING_OBJECT (rtp_mux, "Error iterating sinkpads");
195 case GST_ITERATOR_DONE:
200 gst_iterator_free (iter);
201 gst_object_unref (rtp_mux);
202 gst_event_unref (event);
208 gst_rtp_mux_init (GstRTPMux * object, GstRTPMuxClass * g_class)
210 GstElementClass *klass = GST_ELEMENT_GET_CLASS (object);
213 gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
215 gst_pad_set_event_function (object->srcpad,
216 GST_DEBUG_FUNCPTR (gst_rtp_mux_src_event));
217 gst_element_add_pad (GST_ELEMENT (object), object->srcpad);
219 object->ssrc = DEFAULT_SSRC;
220 object->ts_offset = DEFAULT_TIMESTAMP_OFFSET;
221 object->seqnum_offset = DEFAULT_SEQNUM_OFFSET;
225 gst_rtp_mux_create_sinkpad (GstRTPMux * rtp_mux, GstPadTemplate * templ,
226 const gchar * req_name)
228 GstPad *newpad = NULL;
229 GstPadTemplate *class_templ;
232 gst_element_class_get_pad_template (GST_ELEMENT_GET_CLASS (rtp_mux),
235 if (templ == class_templ) {
236 gchar *tmpname = NULL;
237 const gchar *name = NULL;
239 /* create new pad with the name */
243 name = tmpname = g_strdup_printf ("sink_%02d", rtp_mux->numpads);
244 newpad = gst_pad_new_from_template (templ, name);
249 GST_WARNING_OBJECT (rtp_mux, "this is not our template!\n");
256 gst_rtp_mux_setup_sinkpad (GstRTPMux * rtp_mux, GstPad * sinkpad)
258 GstRTPMuxClass *klass;
259 GstRTPMuxPadPrivate *padpriv = g_slice_new0 (GstRTPMuxPadPrivate);
261 klass = GST_RTP_MUX_GET_CLASS (rtp_mux);
263 /* setup some pad functions */
264 gst_pad_set_setcaps_function (sinkpad, gst_rtp_mux_setcaps);
265 gst_pad_set_getcaps_function (sinkpad, gst_rtp_mux_getcaps);
266 if (klass->chain_func)
267 gst_pad_set_chain_function (sinkpad, klass->chain_func);
268 if (klass->sink_event_func)
269 gst_pad_set_event_function (sinkpad, klass->sink_event_func);
271 /* This could break with gstreamer 0.10.9 */
272 gst_pad_set_active (sinkpad, TRUE);
274 gst_pad_set_element_private (sinkpad, padpriv);
276 /* dd the pad to the element */
277 gst_element_add_pad (GST_ELEMENT (rtp_mux), sinkpad);
281 gst_rtp_mux_request_new_pad (GstElement * element,
282 GstPadTemplate * templ, const gchar * req_name)
287 g_return_val_if_fail (templ != NULL, NULL);
288 g_return_val_if_fail (GST_IS_RTP_MUX (element), NULL);
290 rtp_mux = GST_RTP_MUX (element);
292 if (templ->direction != GST_PAD_SINK) {
293 GST_WARNING_OBJECT (rtp_mux, "request pad that is not a SINK pad");
297 newpad = gst_rtp_mux_create_sinkpad (rtp_mux, templ, req_name);
299 gst_rtp_mux_setup_sinkpad (rtp_mux, newpad);
301 GST_WARNING_OBJECT (rtp_mux, "failed to create request pad");
307 gst_rtp_mux_release_pad (GstElement * element, GstPad * pad)
309 GstRTPMuxPadPrivate *padpriv;
311 GST_OBJECT_LOCK (element);
312 padpriv = gst_pad_get_element_private (pad);
313 gst_pad_set_element_private (pad, NULL);
314 GST_OBJECT_UNLOCK (element);
316 gst_element_remove_pad (element, pad);
319 gst_caps_replace (&padpriv->out_caps, NULL);
320 g_slice_free (GstRTPMuxPadPrivate, padpriv);
324 /* Put our own clock-base on the buffer */
326 gst_rtp_mux_readjust_rtp_timestamp (GstRTPMux * rtp_mux, GstPad * pad,
330 guint32 sink_ts_base = 0;
331 GstRTPMuxPadPrivate *padpriv;
334 GST_OBJECT_LOCK (rtp_mux);
335 padpriv = gst_pad_get_element_private (pad);
336 if (padpriv && padpriv->have_clock_base)
337 sink_ts_base = padpriv->clock_base;
338 GST_OBJECT_UNLOCK (rtp_mux);
340 ts = gst_rtp_buffer_get_timestamp (buffer) - sink_ts_base + rtp_mux->ts_base;
341 GST_LOG_OBJECT (rtp_mux, "Re-adjusting RTP ts %u to %u",
342 gst_rtp_buffer_get_timestamp (buffer), ts);
343 gst_rtp_buffer_set_timestamp (buffer, ts);
347 gst_rtp_mux_chain (GstPad * pad, GstBuffer * buffer)
351 GstRTPMuxPadPrivate *padpriv;
353 rtp_mux = GST_RTP_MUX (gst_pad_get_parent (pad));
355 if (!gst_rtp_buffer_validate (buffer)) {
356 GST_ERROR_OBJECT (rtp_mux, "Invalid RTP buffer");
357 gst_object_unref (rtp_mux);
358 return GST_FLOW_ERROR;
361 buffer = gst_buffer_make_writable (buffer);
363 GST_OBJECT_LOCK (rtp_mux);
365 gst_rtp_buffer_set_seq (buffer, rtp_mux->seqnum);
366 padpriv = gst_pad_get_element_private (pad);
368 gst_buffer_set_caps (buffer, padpriv->out_caps);
369 GST_OBJECT_UNLOCK (rtp_mux);
370 gst_rtp_buffer_set_ssrc (buffer, rtp_mux->current_ssrc);
371 gst_rtp_mux_readjust_rtp_timestamp (rtp_mux, pad, buffer);
372 GST_LOG_OBJECT (rtp_mux, "Pushing packet size %d, seq=%d, ts=%u",
373 GST_BUFFER_SIZE (buffer), rtp_mux->seqnum,
374 gst_rtp_buffer_get_timestamp (buffer));
377 ret = GST_FLOW_NOT_LINKED;
378 gst_buffer_unref (buffer);
382 ret = gst_pad_push (rtp_mux->srcpad, buffer);
386 gst_object_unref (rtp_mux);
391 gst_rtp_mux_setcaps (GstPad * pad, GstCaps * caps)
394 GstStructure *structure;
395 gboolean ret = FALSE;
396 GstRTPMuxPadPrivate *padpriv;
398 rtp_mux = GST_RTP_MUX (gst_pad_get_parent (pad));
400 structure = gst_caps_get_structure (caps, 0);
405 GST_OBJECT_LOCK (rtp_mux);
406 padpriv = gst_pad_get_element_private (pad);
408 gst_structure_get_uint (structure, "clock-base", &padpriv->clock_base)) {
409 padpriv->have_clock_base = TRUE;
411 GST_OBJECT_UNLOCK (rtp_mux);
413 caps = gst_caps_copy (caps);
415 gst_caps_set_simple (caps,
416 "clock-base", G_TYPE_UINT, rtp_mux->ts_base,
417 "seqnum-base", G_TYPE_UINT, rtp_mux->seqnum_base, NULL);
419 GST_DEBUG_OBJECT (rtp_mux,
420 "setting caps %" GST_PTR_FORMAT " on src pad..", caps);
421 ret = gst_pad_set_caps (rtp_mux->srcpad, caps);
423 if (rtp_mux->ssrc == -1) {
424 if (gst_structure_has_field_typed (structure, "ssrc", G_TYPE_UINT)) {
425 rtp_mux->current_ssrc = g_value_get_uint
426 (gst_structure_get_value (structure, "ssrc"));
431 GST_OBJECT_LOCK (rtp_mux);
432 padpriv = gst_pad_get_element_private (pad);
434 gst_caps_replace (&padpriv->out_caps, caps);
435 GST_OBJECT_UNLOCK (rtp_mux);
437 gst_caps_unref (caps);
440 gst_object_unref (rtp_mux);
446 clear_caps (GstCaps * caps, gboolean only_clock_rate)
450 /* Lets only match on the clock-rate */
451 for (i = 0; i < gst_caps_get_size (caps); i++) {
452 GstStructure *s = gst_caps_get_structure (caps, i);
454 for (j = 0; j < gst_structure_n_fields (s); j++) {
455 const gchar *name = gst_structure_nth_field_name (s, j);
457 if (strcmp (name, "clock-rate") && (only_clock_rate ||
458 (strcmp (name, "ssrc")))) {
459 gst_structure_remove_field (s, name);
467 same_clock_rate_fold (gpointer item, GValue * ret, gpointer user_data)
469 GstPad *mypad = user_data;
473 const GstCaps *accumcaps;
477 gst_object_unref (pad);
481 peercaps = gst_pad_peer_get_caps (pad);
483 gst_object_unref (pad);
487 othercaps = gst_caps_intersect (peercaps,
488 gst_pad_get_pad_template_caps (pad));
489 gst_caps_unref (peercaps);
491 accumcaps = gst_value_get_caps (ret);
493 clear_caps (othercaps, TRUE);
495 intersect = gst_caps_intersect (accumcaps, othercaps);
497 g_value_take_boxed (ret, intersect);
499 gst_caps_unref (othercaps);
500 gst_object_unref (pad);
502 return !gst_caps_is_empty (intersect);
506 gst_rtp_mux_getcaps (GstPad * pad)
508 GstRTPMux *mux = GST_RTP_MUX (gst_pad_get_parent (pad));
509 GstCaps *caps = NULL;
510 GstIterator *iter = NULL;
512 GstIteratorResult res;
513 GstCaps *peercaps = gst_pad_peer_get_caps (mux->srcpad);
514 GstCaps *othercaps = NULL;
517 othercaps = gst_caps_intersect (peercaps,
518 gst_pad_get_pad_template_caps (pad));
519 gst_caps_unref (peercaps);
521 othercaps = gst_caps_copy (gst_pad_get_pad_template_caps (mux->srcpad));
524 clear_caps (othercaps, FALSE);
526 g_value_init (&v, GST_TYPE_CAPS);
528 iter = gst_element_iterate_sink_pads (GST_ELEMENT (mux));
530 gst_value_set_caps (&v, othercaps);
531 res = gst_iterator_fold (iter, same_clock_rate_fold, &v, pad);
532 } while (res == GST_ITERATOR_RESYNC);
533 gst_iterator_free (iter);
535 caps = (GstCaps *) gst_value_get_caps (&v);
537 if (res == GST_ITERATOR_ERROR) {
538 gst_caps_unref (caps);
539 caps = gst_caps_new_empty ();
543 gst_caps_unref (othercaps);
544 gst_object_unref (mux);
551 gst_rtp_mux_get_property (GObject * object,
552 guint prop_id, GValue * value, GParamSpec * pspec)
556 rtp_mux = GST_RTP_MUX (object);
559 case PROP_TIMESTAMP_OFFSET:
560 g_value_set_int (value, rtp_mux->ts_offset);
562 case PROP_SEQNUM_OFFSET:
563 g_value_set_int (value, rtp_mux->seqnum_offset);
566 GST_OBJECT_LOCK (rtp_mux);
567 g_value_set_uint (value, rtp_mux->seqnum);
568 GST_OBJECT_UNLOCK (rtp_mux);
571 g_value_set_uint (value, rtp_mux->ssrc);
574 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
580 gst_rtp_mux_set_property (GObject * object,
581 guint prop_id, const GValue * value, GParamSpec * pspec)
585 rtp_mux = GST_RTP_MUX (object);
588 case PROP_TIMESTAMP_OFFSET:
589 rtp_mux->ts_offset = g_value_get_int (value);
591 case PROP_SEQNUM_OFFSET:
592 rtp_mux->seqnum_offset = g_value_get_int (value);
595 rtp_mux->ssrc = g_value_get_uint (value);
598 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
604 gst_rtp_mux_ready_to_paused (GstRTPMux * rtp_mux)
606 GST_OBJECT_LOCK (rtp_mux);
608 if (rtp_mux->ssrc == -1)
609 rtp_mux->current_ssrc = g_random_int ();
611 rtp_mux->current_ssrc = rtp_mux->ssrc;
613 if (rtp_mux->seqnum_offset == -1)
614 rtp_mux->seqnum_base = g_random_int_range (0, G_MAXUINT16);
616 rtp_mux->seqnum_base = rtp_mux->seqnum_offset;
617 rtp_mux->seqnum = rtp_mux->seqnum_base;
619 if (rtp_mux->ts_offset == -1)
620 rtp_mux->ts_base = g_random_int ();
622 rtp_mux->ts_base = rtp_mux->ts_offset;
623 GST_DEBUG_OBJECT (rtp_mux, "set clock-base to %u", rtp_mux->ts_base);
625 GST_OBJECT_UNLOCK (rtp_mux);
628 static GstStateChangeReturn
629 gst_rtp_mux_change_state (GstElement * element, GstStateChange transition)
633 rtp_mux = GST_RTP_MUX (element);
635 switch (transition) {
636 case GST_STATE_CHANGE_NULL_TO_READY:
638 case GST_STATE_CHANGE_READY_TO_PAUSED:
639 gst_rtp_mux_ready_to_paused (rtp_mux);
641 case GST_STATE_CHANGE_PAUSED_TO_READY:
647 return GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
651 gst_rtp_mux_plugin_init (GstPlugin * plugin)
653 GST_DEBUG_CATEGORY_INIT (gst_rtp_mux_debug, "rtpmux", 0, "rtp muxer");
655 return gst_element_register (plugin, "rtpmux", GST_RANK_NONE,