gst/rtpmanager/gstrtpmux.c

   1 /* RTP muxer element for GStreamer
   2  *
   3  * gstrtpmux.c:
   4  *
   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>
   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-rtpmux
  28  * @short_description: Muxer that takes one or several RTP streams
  29  * and muxes them to a single rtp stream.
  30  *
  31  * <refsect2>
  32  * </refsect2>
  33  */
  34
  35 #ifdef HAVE_CONFIG_H
  36 #include "config.h"
  37 #endif
  38
  39 #include <gst/gst.h>
  40 #include <gst/rtp/gstrtpbuffer.h>
  41 #include <gstrtpmux.h>
  42 #include <string.h>
  43
  44 GST_DEBUG_CATEGORY_STATIC (gst_rtp_mux_debug);
  45 #define GST_CAT_DEFAULT gst_rtp_mux_debug
  46
  47 /* elementfactory information */
  48 static const GstElementDetails gst_rtp_mux_details =
  49 GST_ELEMENT_DETAILS ("RTP muxer",
  50     "Codec/Muxer",
  51     "multiplex N rtp streams into one",
  52     "Zeeshan Ali <first.last@nokia.com>");
  53
  54 enum
  55 {
  56   ARG_0,
  57   PROP_CLOCK_RATE,
  58   PROP_TIMESTAMP_OFFSET,
  59   PROP_SEQNUM_OFFSET,
  60   PROP_SEQNUM,
  61   PROP_SSRC
  62 };
  63
  64 #define DEFAULT_TIMESTAMP_OFFSET -1
  65 #define DEFAULT_SEQNUM_OFFSET    -1
  66 #define DEFAULT_SSRC             -1
  67 #define DEFAULT_CLOCK_RATE        0
  68
  69 typedef struct {
  70   gboolean have_base;
  71   guint clock_base;
  72 } GstRTPMuxPadPrivate;
  73
  74 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  75     GST_PAD_SRC,
  76     GST_PAD_ALWAYS,
  77     GST_STATIC_CAPS ("application/x-rtp")
  78     );
  79
  80 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink_%d",
  81     GST_PAD_SINK,
  82     GST_PAD_REQUEST,
  83     GST_STATIC_CAPS ("application/x-rtp")
  84     );
  85
  86 static void gst_rtp_mux_base_init (gpointer g_class);
  87 static void gst_rtp_mux_class_init (GstRTPMuxClass * klass);
  88 static void gst_rtp_mux_init (GstRTPMux * rtp_mux);
  89
  90 static void gst_rtp_mux_finalize (GObject * object);
  91
  92 static GstPad *gst_rtp_mux_request_new_pad (GstElement * element,
  93     GstPadTemplate * templ, const gchar * name);
  94 static void gst_rtp_mux_release_pad (GstElement * element, GstPad *pad);
  95 static GstFlowReturn gst_rtp_mux_chain (GstPad * pad,
  96     GstBuffer * buffer);
  97 static gboolean gst_rtp_mux_setcaps (GstPad *pad, GstCaps *caps);
  98
  99 static GstStateChangeReturn gst_rtp_mux_change_state (GstElement *
 100     element, GstStateChange transition);
 101
 102 static void gst_rtp_mux_set_property (GObject * object, guint prop_id,
 103     const GValue * value, GParamSpec * pspec);
 104 static void gst_rtp_mux_get_property (GObject * object, guint prop_id,
 105     GValue * value, GParamSpec * pspec);
 106
 107 static GstElementClass *parent_class = NULL;
 108
 109 GType
 110 gst_rtp_mux_get_type (void)
 111 {
 112   static GType rtp_mux_type = 0;
 113
 114   if (!rtp_mux_type) {
 115     static const GTypeInfo rtp_mux_info = {
 116       sizeof (GstRTPMuxClass),
 117       gst_rtp_mux_base_init,
 118       NULL,
 119       (GClassInitFunc) gst_rtp_mux_class_init,
 120       NULL,
 121       NULL,
 122       sizeof (GstRTPMux),
 123       0,
 124       (GInstanceInitFunc) gst_rtp_mux_init,
 125     };
 126
 127     rtp_mux_type =
 128         g_type_register_static (GST_TYPE_ELEMENT, "GstRTPMux",
 129         &rtp_mux_info, 0);
 130   }
 131   return rtp_mux_type;
 132 }
 133
 134 static void
 135 gst_rtp_mux_base_init (gpointer g_class)
 136 {
 137   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 138
 139   gst_element_class_add_pad_template (element_class,
 140       gst_static_pad_template_get (&src_factory));
 141   gst_element_class_add_pad_template (element_class,
 142       gst_static_pad_template_get (&sink_factory));
 143
 144   gst_element_class_set_details (element_class, &gst_rtp_mux_details);
 145 }
 146
 147 static void
 148 gst_rtp_mux_class_init (GstRTPMuxClass * klass)
 149 {
 150   GObjectClass *gobject_class;
 151   GstElementClass *gstelement_class;
 152
 153   gobject_class = (GObjectClass *) klass;
 154   gstelement_class = (GstElementClass *) klass;
 155
 156   parent_class = g_type_class_peek_parent (klass);
 157
 158   gobject_class->finalize = gst_rtp_mux_finalize;
 159   gobject_class->get_property = gst_rtp_mux_get_property;
 160   gobject_class->set_property = gst_rtp_mux_set_property;
 161
 162   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLOCK_RATE,
 163       g_param_spec_uint ("clock-rate", "clockrate",
 164           "The clock-rate of the RTP streams",
 165           0, G_MAXUINT, DEFAULT_CLOCK_RATE, G_PARAM_READWRITE));
 166   g_object_class_install_property (G_OBJECT_CLASS (klass),
 167       PROP_TIMESTAMP_OFFSET, g_param_spec_int ("timestamp-offset",
 168           "Timestamp Offset",
 169           "Offset to add to all outgoing timestamps (-1 = random)", -1,
 170           G_MAXINT, DEFAULT_TIMESTAMP_OFFSET, G_PARAM_READWRITE));
 171   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM_OFFSET,
 172       g_param_spec_int ("seqnum-offset", "Sequence number Offset",
 173           "Offset to add to all outgoing seqnum (-1 = random)", -1, G_MAXINT,
 174           DEFAULT_SEQNUM_OFFSET, G_PARAM_READWRITE));
 175   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM,
 176       g_param_spec_uint ("seqnum", "Sequence number",
 177           "The RTP sequence number of the last processed packet",
 178           0, G_MAXUINT, 0, G_PARAM_READABLE));
 179   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SSRC,
 180       g_param_spec_uint ("ssrc", "SSRC",
 181           "The SSRC of the packets (-1 == random)",
 182           0, G_MAXUINT, DEFAULT_SSRC, G_PARAM_READWRITE));
 183
 184   gstelement_class->request_new_pad = gst_rtp_mux_request_new_pad;
 185   gstelement_class->release_pad = gst_rtp_mux_release_pad;
 186   gstelement_class->change_state = gst_rtp_mux_change_state;
 187
 188   klass->chain_func = gst_rtp_mux_chain;
 189 }
 190
 191 static gboolean gst_rtp_mux_src_event (GstPad * pad,
 192     GstEvent * event)
 193 {
 194   GstElement *rtp_mux;
 195   GstIterator *iter;
 196   GstPad *sinkpad;
 197   gboolean result = FALSE;
 198   gboolean done = FALSE;
 199
 200   rtp_mux = gst_pad_get_parent_element (pad);
 201   g_return_val_if_fail (rtp_mux != NULL, FALSE);
 202
 203   iter = gst_element_iterate_sink_pads (rtp_mux);
 204
 205   while (!done) {
 206     switch (gst_iterator_next (iter, (gpointer) &sinkpad)) {
 207       case GST_ITERATOR_OK:
 208         gst_event_ref (event);
 209         result |= gst_pad_push_event (sinkpad, event);
 210         gst_object_unref (sinkpad);
 211         break;
 212       case GST_ITERATOR_RESYNC:
 213         gst_iterator_resync (iter);
 214         break;
 215       case GST_ITERATOR_ERROR:
 216         GST_WARNING_OBJECT (rtp_mux, "Error iterating sinkpads");
 217       case GST_ITERATOR_DONE:
 218         done = TRUE;
 219         break;
 220     }
 221   }
 222
 223   gst_event_unref (event);
 224
 225   return result;
 226 }
 227
 228 static void
 229 gst_rtp_mux_init (GstRTPMux * rtp_mux)
 230 {
 231   GstElementClass *klass = GST_ELEMENT_GET_CLASS (rtp_mux);
 232
 233   rtp_mux->srcpad =
 234       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 235           "src"), "src");
 236   gst_pad_set_event_function (rtp_mux->srcpad, gst_rtp_mux_src_event);
 237   gst_element_add_pad (GST_ELEMENT (rtp_mux), rtp_mux->srcpad);
 238
 239   rtp_mux->ssrc = DEFAULT_SSRC;
 240   rtp_mux->ts_offset = DEFAULT_TIMESTAMP_OFFSET;
 241   rtp_mux->seqnum_offset = DEFAULT_SEQNUM_OFFSET;
 242   rtp_mux->clock_rate = DEFAULT_CLOCK_RATE;
 243 }
 244
 245 static void
 246 gst_rtp_mux_finalize (GObject * object)
 247 {
 248   GstRTPMux *rtp_mux;
 249
 250   rtp_mux = GST_RTP_MUX (object);
 251
 252   G_OBJECT_CLASS (parent_class)->finalize (object);
 253 }
 254
 255 static GstPad *
 256 gst_rtp_mux_create_sinkpad (GstRTPMux * rtp_mux, GstPadTemplate * templ)
 257 {
 258   GstPad *newpad = NULL;
 259   GstPadTemplate * class_templ;
 260
 261   class_templ = gst_element_class_get_pad_template (
 262           GST_ELEMENT_GET_CLASS (rtp_mux), "sink_%d");
 263
 264   if (templ == class_templ) {
 265     gchar *name;
 266
 267     /* create new pad with the name */
 268     name = g_strdup_printf ("sink_%02d", rtp_mux->numpads);
 269     newpad = gst_pad_new_from_template (templ, name);
 270     g_free (name);
 271
 272     rtp_mux->numpads++;
 273   } else {
 274     GST_WARNING_OBJECT (rtp_mux, "this is not our template!\n");
 275   }
 276
 277   return newpad;
 278 }
 279
 280 static void
 281 gst_rtp_mux_setup_sinkpad (GstRTPMux * rtp_mux, GstPad * sinkpad)
 282 {
 283   GstRTPMuxClass *klass;
 284   GstRTPMuxPadPrivate *padpriv = g_slice_new0 (GstRTPMuxPadPrivate);
 285
 286   klass = GST_RTP_MUX_GET_CLASS (rtp_mux);
 287
 288   /* setup some pad functions */
 289   gst_pad_set_setcaps_function (sinkpad, gst_rtp_mux_setcaps);
 290   if (klass->chain_func)
 291     gst_pad_set_chain_function (sinkpad, klass->chain_func);
 292   if (klass->sink_event_func)
 293     gst_pad_set_event_function (sinkpad, klass->sink_event_func);
 294
 295   /* This could break with gstreamer 0.10.9 */
 296   gst_pad_set_active (sinkpad, TRUE);
 297
 298   gst_pad_set_element_private (sinkpad, padpriv);
 299
 300   /* dd the pad to the element */
 301   gst_element_add_pad (GST_ELEMENT (rtp_mux), sinkpad);
 302 }
 303
 304 static GstPad *
 305 gst_rtp_mux_request_new_pad (GstElement * element,
 306     GstPadTemplate * templ, const gchar * req_name)
 307 {
 308   GstRTPMux *rtp_mux;
 309   GstPad *newpad;
 310
 311   g_return_val_if_fail (templ != NULL, NULL);
 312   g_return_val_if_fail (GST_IS_RTP_MUX (element), NULL);
 313
 314   rtp_mux = GST_RTP_MUX (element);
 315
 316   if (templ->direction != GST_PAD_SINK) {
 317     GST_WARNING_OBJECT (rtp_mux, "request pad that is not a SINK pad");
 318     return NULL;
 319   }
 320
 321   newpad = gst_rtp_mux_create_sinkpad (rtp_mux, templ);
 322   if (newpad)
 323     gst_rtp_mux_setup_sinkpad (rtp_mux, newpad);
 324   else
 325     GST_WARNING_OBJECT (rtp_mux, "failed to create request pad");
 326
 327   return newpad;
 328 }
 329
 330 static void
 331 gst_rtp_mux_release_pad (GstElement * element, GstPad *pad)
 332 {
 333   GstRTPMuxPadPrivate *padpriv = gst_pad_get_element_private (pad);
 334
 335   if (padpriv)
 336     g_slice_free (GstRTPMuxPadPrivate, padpriv);
 337   gst_pad_set_element_private (pad, NULL);
 338
 339   gst_element_remove_pad (element, pad);
 340 }
 341
 342 /* Put our own clock-base on the buffer */
 343 static void
 344 gst_rtp_mux_readjust_rtp_timestamp (GstRTPMux * rtp_mux, GstPad * pad,
 345     GstBuffer * buffer)
 346 {
 347   guint32 ts;
 348   guint32 sink_ts_base = 0;
 349   GstRTPMuxPadPrivate *padpriv = gst_pad_get_element_private (pad);
 350
 351   if (padpriv->have_base)
 352     sink_ts_base = padpriv->clock_base;
 353
 354   ts = gst_rtp_buffer_get_timestamp (buffer) - sink_ts_base + rtp_mux->ts_base;
 355   GST_LOG_OBJECT (rtp_mux, "Re-adjusting RTP ts %u to %u",
 356       gst_rtp_buffer_get_timestamp (buffer), ts);
 357   gst_rtp_buffer_set_timestamp (buffer, ts);
 358 }
 359
 360 static GstFlowReturn
 361 gst_rtp_mux_chain (GstPad * pad, GstBuffer * buffer)
 362 {
 363   GstRTPMux *rtp_mux;
 364   GstFlowReturn ret;
 365
 366   rtp_mux = GST_RTP_MUX (gst_pad_get_parent (pad));
 367
 368   buffer = gst_buffer_make_writable(buffer);
 369
 370   rtp_mux->seqnum++;
 371   gst_rtp_buffer_set_seq (buffer, rtp_mux->seqnum);
 372   gst_rtp_buffer_set_ssrc (buffer, rtp_mux->current_ssrc);
 373   gst_rtp_mux_readjust_rtp_timestamp (rtp_mux, pad, buffer);
 374   GST_LOG_OBJECT (rtp_mux, "Pushing packet size %d, seq=%d, ts=%u",
 375       GST_BUFFER_SIZE (buffer), rtp_mux->seqnum);
 376
 377   gst_buffer_set_caps (buffer, GST_PAD_CAPS (rtp_mux->srcpad));
 378
 379   ret = gst_pad_push (rtp_mux->srcpad, buffer);
 380
 381   gst_object_unref (rtp_mux);
 382   return ret;
 383 }
 384
 385 static gboolean
 386 gst_rtp_mux_set_clock_rate (GstRTPMux *rtp_mux, gint clock_rate)
 387 {
 388   gint ret = TRUE;
 389
 390   if (rtp_mux->clock_rate == 0) {
 391     rtp_mux->clock_rate = clock_rate;
 392     ret = TRUE;
 393   }
 394
 395   else if (rtp_mux->clock_rate != clock_rate) {
 396     GST_WARNING_OBJECT (rtp_mux, "Clock-rate already set to: %u",
 397             rtp_mux->clock_rate);
 398     ret = FALSE;
 399   }
 400
 401   return ret;
 402 }
 403
 404 static gboolean
 405 gst_rtp_mux_setcaps (GstPad *pad, GstCaps *caps)
 406 {
 407   GstRTPMux *rtp_mux;
 408   GstStructure *structure;
 409   gboolean ret = TRUE;
 410   gint clock_rate;
 411   GstRTPMuxPadPrivate *padpriv = gst_pad_get_element_private (pad);
 412
 413   rtp_mux = GST_RTP_MUX (gst_pad_get_parent (pad));
 414
 415   structure = gst_caps_get_structure (caps, 0);
 416   if (gst_structure_get_int (structure, "clock-rate", &clock_rate)) {
 417     ret = gst_rtp_mux_set_clock_rate (rtp_mux, clock_rate);
 418   }
 419
 420   if (!ret)
 421     goto out;
 422
 423   if (gst_structure_get_uint (structure, "clock-base", &padpriv->clock_base)) {
 424     padpriv->have_base = TRUE;
 425   }
 426
 427   caps = gst_caps_copy (caps);
 428
 429   gst_caps_set_simple (caps,
 430       "clock-base", G_TYPE_UINT, rtp_mux->ts_base,
 431       "seqnum-base", G_TYPE_UINT, rtp_mux->seqnum_base,
 432       NULL);
 433
 434   GST_DEBUG_OBJECT (rtp_mux,
 435       "setting caps %" GST_PTR_FORMAT " on src pad..", caps);
 436   ret = gst_pad_set_caps (rtp_mux->srcpad, caps);
 437   gst_caps_unref (caps);
 438
 439  out:
 440   gst_object_unref (rtp_mux);
 441
 442   return ret;
 443 }
 444
 445 static void
 446 gst_rtp_mux_get_property (GObject * object,
 447     guint prop_id, GValue * value, GParamSpec * pspec)
 448 {
 449   GstRTPMux *rtp_mux;
 450
 451   rtp_mux = GST_RTP_MUX (object);
 452
 453   switch (prop_id) {
 454     case PROP_CLOCK_RATE:
 455       g_value_set_uint (value, rtp_mux->clock_rate);
 456       break;
 457     case PROP_TIMESTAMP_OFFSET:
 458       g_value_set_int (value, rtp_mux->ts_offset);
 459       break;
 460     case PROP_SEQNUM_OFFSET:
 461       g_value_set_int (value, rtp_mux->seqnum_offset);
 462       break;
 463     case PROP_SEQNUM:
 464       g_value_set_uint (value, rtp_mux->seqnum);
 465       break;
 466     case PROP_SSRC:
 467       g_value_set_uint (value, rtp_mux->ssrc);
 468       break;
 469     default:
 470       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 471       break;
 472   }
 473 }
 474
 475 static void
 476 gst_rtp_mux_set_property (GObject * object,
 477     guint prop_id, const GValue * value, GParamSpec * pspec)
 478 {
 479   GstRTPMux *rtp_mux;
 480
 481   rtp_mux = GST_RTP_MUX (object);
 482
 483   switch (prop_id) {
 484     case PROP_CLOCK_RATE:
 485       rtp_mux->clock_rate = g_value_get_uint (value);
 486       break;
 487     case PROP_TIMESTAMP_OFFSET:
 488       rtp_mux->ts_offset = g_value_get_int (value);
 489       break;
 490     case PROP_SEQNUM_OFFSET:
 491       rtp_mux->seqnum_offset = g_value_get_int (value);
 492       break;
 493     case PROP_SSRC:
 494       rtp_mux->ssrc = g_value_get_uint (value);
 495       break;
 496     default:
 497       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 498       break;
 499   }
 500 }
 501
 502 static void
 503 gst_rtp_mux_ready_to_paused (GstRTPMux * rtp_mux)
 504 {
 505   if (rtp_mux->ssrc == -1)
 506     rtp_mux->current_ssrc = g_random_int ();
 507   else
 508     rtp_mux->current_ssrc = rtp_mux->ssrc;
 509
 510   if (rtp_mux->seqnum_offset == -1)
 511     rtp_mux->seqnum_base = g_random_int_range (0, G_MAXUINT16);
 512   else
 513     rtp_mux->seqnum_base = rtp_mux->seqnum_offset;
 514   rtp_mux->seqnum = rtp_mux->seqnum_base;
 515
 516   if (rtp_mux->ts_offset == -1)
 517     rtp_mux->ts_base = g_random_int ();
 518   else
 519     rtp_mux->ts_base = rtp_mux->ts_offset;
 520     GST_DEBUG_OBJECT (rtp_mux, "set clock-base to %u", rtp_mux->ts_base);
 521 }
 522
 523 static GstStateChangeReturn
 524 gst_rtp_mux_change_state (GstElement * element, GstStateChange transition)
 525 {
 526   GstRTPMux *rtp_mux;
 527
 528   rtp_mux = GST_RTP_MUX (element);
 529
 530   switch (transition) {
 531     case GST_STATE_CHANGE_NULL_TO_READY:
 532       break;
 533     case GST_STATE_CHANGE_READY_TO_PAUSED:
 534       gst_rtp_mux_ready_to_paused (rtp_mux);
 535       break;
 536     case GST_STATE_CHANGE_PAUSED_TO_READY:
 537       break;
 538     default:
 539       break;
 540   }
 541
 542   return GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 543 }
 544
 545 gboolean
 546 gst_rtp_mux_plugin_init (GstPlugin * plugin)
 547 {
 548   GST_DEBUG_CATEGORY_INIT (gst_rtp_mux_debug, "rtpmux", 0,
 549       "rtp muxer");
 550
 551   return gst_element_register (plugin, "rtpmux", GST_RANK_NONE,
 552       GST_TYPE_RTP_MUX);
 553 }
 554