gst/rtpmanager/gstrtprtxsend.c

   1 /* RTP Retransmission sender element for GStreamer
   2  *
   3  * gstrtprtxsend.c:
   4  *
   5  * Copyright (C) 2013 Collabora Ltd.
   6  *   @author Julien Isorce <julien.isorce@collabora.co.uk>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 /**
  25  * SECTION:element-rtprtxsend
  26  *
  27  * See #GstRtpRtxReceive for examples
  28  *
  29  * The purpose of the sender RTX object is to keep a history of RTP packets up
  30  * to a configurable limit (max-size-time or max-size-packets). It will listen
  31  * for upstream custom retransmission events (GstRTPRetransmissionRequest) that
  32  * comes from downstream (#GstRtpSession). When receiving a request it will
  33  * look up the requested seqnum in its list of stored packets. If the packet
  34  * is available, it will create a RTX packet according to RFC 4588 and send
  35  * this as an auxiliary stream. RTX is SSRC-multiplexed
  36  */
  37
  38 #ifdef HAVE_CONFIG_H
  39 #include "config.h"
  40 #endif
  41
  42 #include <gst/gst.h>
  43 #include <gst/rtp/gstrtpbuffer.h>
  44 #include <string.h>
  45 #include <stdlib.h>
  46
  47 #include "gstrtprtxsend.h"
  48
  49 GST_DEBUG_CATEGORY_STATIC (gst_rtp_rtx_send_debug);
  50 #define GST_CAT_DEFAULT gst_rtp_rtx_send_debug
  51
  52 #define DEFAULT_RTX_PAYLOAD_TYPE 0
  53 #define DEFAULT_MAX_SIZE_TIME    0
  54 #define DEFAULT_MAX_SIZE_PACKETS 100
  55
  56 enum
  57 {
  58   PROP_0,
  59   PROP_SSRC_MAP,
  60   PROP_PAYLOAD_TYPE_MAP,
  61   PROP_MAX_SIZE_TIME,
  62   PROP_MAX_SIZE_PACKETS,
  63   PROP_NUM_RTX_REQUESTS,
  64   PROP_NUM_RTX_PACKETS
  65 };
  66
  67 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  68     GST_PAD_SRC,
  69     GST_PAD_ALWAYS,
  70     GST_STATIC_CAPS ("application/x-rtp")
  71     );
  72
  73 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
  74     GST_PAD_SINK,
  75     GST_PAD_ALWAYS,
  76     GST_STATIC_CAPS ("application/x-rtp, " "clock-rate = (int) [1, MAX]")
  77     );
  78
  79 static gboolean gst_rtp_rtx_send_queue_check_full (GstDataQueue * queue,
  80     guint visible, guint bytes, guint64 time, gpointer checkdata);
  81
  82 static gboolean gst_rtp_rtx_send_src_event (GstPad * pad, GstObject * parent,
  83     GstEvent * event);
  84 static gboolean gst_rtp_rtx_send_sink_event (GstPad * pad, GstObject * parent,
  85     GstEvent * event);
  86 static GstFlowReturn gst_rtp_rtx_send_chain (GstPad * pad, GstObject * parent,
  87     GstBuffer * buffer);
  88 static GstFlowReturn gst_rtp_rtx_send_chain_list (GstPad * pad,
  89     GstObject * parent, GstBufferList * list);
  90
  91 static void gst_rtp_rtx_send_src_loop (GstRtpRtxSend * rtx);
  92 static gboolean gst_rtp_rtx_send_activate_mode (GstPad * pad,
  93     GstObject * parent, GstPadMode mode, gboolean active);
  94
  95 static GstStateChangeReturn gst_rtp_rtx_send_change_state (GstElement *
  96     element, GstStateChange transition);
  97
  98 static void gst_rtp_rtx_send_set_property (GObject * object, guint prop_id,
  99     const GValue * value, GParamSpec * pspec);
 100 static void gst_rtp_rtx_send_get_property (GObject * object, guint prop_id,
 101     GValue * value, GParamSpec * pspec);
 102 static void gst_rtp_rtx_send_finalize (GObject * object);
 103
 104 G_DEFINE_TYPE (GstRtpRtxSend, gst_rtp_rtx_send, GST_TYPE_ELEMENT);
 105
 106 typedef struct
 107 {
 108   guint16 seqnum;
 109   guint32 timestamp;
 110   GstBuffer *buffer;
 111 } BufferQueueItem;
 112
 113 static void
 114 buffer_queue_item_free (BufferQueueItem * item)
 115 {
 116   gst_buffer_unref (item->buffer);
 117   g_slice_free (BufferQueueItem, item);
 118 }
 119
 120 typedef struct
 121 {
 122   guint32 rtx_ssrc;
 123   guint16 seqnum_base, next_seqnum;
 124   gint clock_rate;
 125
 126   /* history of rtp packets */
 127   GSequence *queue;
 128 } SSRCRtxData;
 129
 130 static SSRCRtxData *
 131 ssrc_rtx_data_new (guint32 rtx_ssrc)
 132 {
 133   SSRCRtxData *data = g_slice_new0 (SSRCRtxData);
 134
 135   data->rtx_ssrc = rtx_ssrc;
 136   data->next_seqnum = data->seqnum_base = g_random_int_range (0, G_MAXUINT16);
 137   data->queue = g_sequence_new ((GDestroyNotify) buffer_queue_item_free);
 138
 139   return data;
 140 }
 141
 142 static void
 143 ssrc_rtx_data_free (SSRCRtxData * data)
 144 {
 145   g_sequence_free (data->queue);
 146   g_slice_free (SSRCRtxData, data);
 147 }
 148
 149 static void
 150 gst_rtp_rtx_send_class_init (GstRtpRtxSendClass * klass)
 151 {
 152   GObjectClass *gobject_class;
 153   GstElementClass *gstelement_class;
 154
 155   gobject_class = (GObjectClass *) klass;
 156   gstelement_class = (GstElementClass *) klass;
 157
 158   gobject_class->get_property = gst_rtp_rtx_send_get_property;
 159   gobject_class->set_property = gst_rtp_rtx_send_set_property;
 160   gobject_class->finalize = gst_rtp_rtx_send_finalize;
 161
 162   g_object_class_install_property (gobject_class, PROP_SSRC_MAP,
 163       g_param_spec_boxed ("ssrc-map", "SSRC Map",
 164           "Map of SSRCs to their retransmission SSRCs for SSRC-multiplexed mode"
 165           " (default = random)", GST_TYPE_STRUCTURE,
 166           G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
 167
 168   g_object_class_install_property (gobject_class, PROP_PAYLOAD_TYPE_MAP,
 169       g_param_spec_boxed ("payload-type-map", "Payload Type Map",
 170           "Map of original payload types to their retransmission payload types",
 171           GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 172
 173   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_TIME,
 174       g_param_spec_uint ("max-size-time", "Max Size Time",
 175           "Amount of ms to queue (0 = unlimited)", 0, G_MAXUINT,
 176           DEFAULT_MAX_SIZE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 177
 178   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_PACKETS,
 179       g_param_spec_uint ("max-size-packets", "Max Size Packets",
 180           "Amount of packets to queue (0 = unlimited)", 0, G_MAXINT16,
 181           DEFAULT_MAX_SIZE_PACKETS,
 182           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 183
 184   g_object_class_install_property (gobject_class, PROP_NUM_RTX_REQUESTS,
 185       g_param_spec_uint ("num-rtx-requests", "Num RTX Requests",
 186           "Number of retransmission events received", 0, G_MAXUINT,
 187           0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 188
 189   g_object_class_install_property (gobject_class, PROP_NUM_RTX_PACKETS,
 190       g_param_spec_uint ("num-rtx-packets", "Num RTX Packets",
 191           " Number of retransmission packets sent", 0, G_MAXUINT,
 192           0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 193
 194   gst_element_class_add_static_pad_template (gstelement_class, &src_factory);
 195   gst_element_class_add_static_pad_template (gstelement_class, &sink_factory);
 196
 197   gst_element_class_set_static_metadata (gstelement_class,
 198       "RTP Retransmission Sender", "Codec",
 199       "Retransmit RTP packets when needed, according to RFC4588",
 200       "Julien Isorce <julien.isorce@collabora.co.uk>");
 201
 202   gstelement_class->change_state =
 203       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_change_state);
 204 }
 205
 206 static void
 207 gst_rtp_rtx_send_reset (GstRtpRtxSend * rtx)
 208 {
 209   GST_OBJECT_LOCK (rtx);
 210   gst_data_queue_flush (rtx->queue);
 211   g_hash_table_remove_all (rtx->ssrc_data);
 212   g_hash_table_remove_all (rtx->rtx_ssrcs);
 213   rtx->num_rtx_requests = 0;
 214   rtx->num_rtx_packets = 0;
 215   GST_OBJECT_UNLOCK (rtx);
 216 }
 217
 218 static void
 219 gst_rtp_rtx_send_finalize (GObject * object)
 220 {
 221   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (object);
 222
 223   g_hash_table_unref (rtx->ssrc_data);
 224   g_hash_table_unref (rtx->rtx_ssrcs);
 225   if (rtx->external_ssrc_map)
 226     gst_structure_free (rtx->external_ssrc_map);
 227   g_hash_table_unref (rtx->rtx_pt_map);
 228   if (rtx->rtx_pt_map_structure)
 229     gst_structure_free (rtx->rtx_pt_map_structure);
 230   g_object_unref (rtx->queue);
 231
 232   G_OBJECT_CLASS (gst_rtp_rtx_send_parent_class)->finalize (object);
 233 }
 234
 235 static void
 236 gst_rtp_rtx_send_init (GstRtpRtxSend * rtx)
 237 {
 238   GstElementClass *klass = GST_ELEMENT_GET_CLASS (rtx);
 239
 240   rtx->srcpad =
 241       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 242           "src"), "src");
 243   GST_PAD_SET_PROXY_CAPS (rtx->srcpad);
 244   GST_PAD_SET_PROXY_ALLOCATION (rtx->srcpad);
 245   gst_pad_set_event_function (rtx->srcpad,
 246       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_src_event));
 247   gst_pad_set_activatemode_function (rtx->srcpad,
 248       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_activate_mode));
 249   gst_element_add_pad (GST_ELEMENT (rtx), rtx->srcpad);
 250
 251   rtx->sinkpad =
 252       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 253           "sink"), "sink");
 254   GST_PAD_SET_PROXY_CAPS (rtx->sinkpad);
 255   GST_PAD_SET_PROXY_ALLOCATION (rtx->sinkpad);
 256   gst_pad_set_event_function (rtx->sinkpad,
 257       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_sink_event));
 258   gst_pad_set_chain_function (rtx->sinkpad,
 259       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_chain));
 260   gst_pad_set_chain_list_function (rtx->sinkpad,
 261       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_chain_list));
 262   gst_element_add_pad (GST_ELEMENT (rtx), rtx->sinkpad);
 263
 264   rtx->queue = gst_data_queue_new (gst_rtp_rtx_send_queue_check_full, NULL,
 265       NULL, rtx);
 266   rtx->ssrc_data = g_hash_table_new_full (g_direct_hash, g_direct_equal,
 267       NULL, (GDestroyNotify) ssrc_rtx_data_free);
 268   rtx->rtx_ssrcs = g_hash_table_new (g_direct_hash, g_direct_equal);
 269   rtx->rtx_pt_map = g_hash_table_new (g_direct_hash, g_direct_equal);
 270
 271   rtx->max_size_time = DEFAULT_MAX_SIZE_TIME;
 272   rtx->max_size_packets = DEFAULT_MAX_SIZE_PACKETS;
 273 }
 274
 275 static void
 276 gst_rtp_rtx_send_set_flushing (GstRtpRtxSend * rtx, gboolean flush)
 277 {
 278   GST_OBJECT_LOCK (rtx);
 279   gst_data_queue_set_flushing (rtx->queue, flush);
 280   gst_data_queue_flush (rtx->queue);
 281   GST_OBJECT_UNLOCK (rtx);
 282 }
 283
 284 static gboolean
 285 gst_rtp_rtx_send_queue_check_full (GstDataQueue * queue,
 286     guint visible, guint bytes, guint64 time, gpointer checkdata)
 287 {
 288   return FALSE;
 289 }
 290
 291 static void
 292 gst_rtp_rtx_data_queue_item_free (gpointer item)
 293 {
 294   GstDataQueueItem *data = item;
 295   if (data->object)
 296     gst_mini_object_unref (data->object);
 297   g_slice_free (GstDataQueueItem, data);
 298 }
 299
 300 static gboolean
 301 gst_rtp_rtx_send_push_out (GstRtpRtxSend * rtx, gpointer object)
 302 {
 303   GstDataQueueItem *data;
 304   gboolean success;
 305
 306   data = g_slice_new0 (GstDataQueueItem);
 307   data->object = GST_MINI_OBJECT (object);
 308   data->size = 1;
 309   data->duration = 1;
 310   data->visible = TRUE;
 311   data->destroy = gst_rtp_rtx_data_queue_item_free;
 312
 313   success = gst_data_queue_push (rtx->queue, data);
 314
 315   if (!success)
 316     data->destroy (data);
 317
 318   return success;
 319 }
 320
 321 static guint32
 322 gst_rtp_rtx_send_choose_ssrc (GstRtpRtxSend * rtx, guint32 choice,
 323     gboolean consider_choice)
 324 {
 325   guint32 ssrc = consider_choice ? choice : g_random_int ();
 326
 327   /* make sure to be different than any other */
 328   while (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc)) ||
 329       g_hash_table_contains (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc))) {
 330     ssrc = g_random_int ();
 331   }
 332
 333   return ssrc;
 334 }
 335
 336 static SSRCRtxData *
 337 gst_rtp_rtx_send_get_ssrc_data (GstRtpRtxSend * rtx, guint32 ssrc)
 338 {
 339   SSRCRtxData *data;
 340   guint32 rtx_ssrc = 0;
 341   gboolean consider = FALSE;
 342
 343   if (G_UNLIKELY (!g_hash_table_contains (rtx->ssrc_data,
 344               GUINT_TO_POINTER (ssrc)))) {
 345     if (rtx->external_ssrc_map) {
 346       gchar *ssrc_str;
 347       ssrc_str = g_strdup_printf ("%" G_GUINT32_FORMAT, ssrc);
 348       consider = gst_structure_get_uint (rtx->external_ssrc_map, ssrc_str,
 349           &rtx_ssrc);
 350       g_free (ssrc_str);
 351     }
 352     rtx_ssrc = gst_rtp_rtx_send_choose_ssrc (rtx, rtx_ssrc, consider);
 353     data = ssrc_rtx_data_new (rtx_ssrc);
 354     g_hash_table_insert (rtx->ssrc_data, GUINT_TO_POINTER (ssrc), data);
 355     g_hash_table_insert (rtx->rtx_ssrcs, GUINT_TO_POINTER (rtx_ssrc),
 356         GUINT_TO_POINTER (ssrc));
 357   } else {
 358     data = g_hash_table_lookup (rtx->ssrc_data, GUINT_TO_POINTER (ssrc));
 359   }
 360   return data;
 361 }
 362
 363 /* Copy fixed header and extension. Add OSN before to copy payload
 364  * Copy memory to avoid to manually copy each rtp buffer field.
 365  */
 366 static GstBuffer *
 367 gst_rtp_rtx_buffer_new (GstRtpRtxSend * rtx, GstBuffer * buffer)
 368 {
 369   GstMemory *mem = NULL;
 370   GstRTPBuffer rtp = GST_RTP_BUFFER_INIT;
 371   GstRTPBuffer new_rtp = GST_RTP_BUFFER_INIT;
 372   GstBuffer *new_buffer = gst_buffer_new ();
 373   GstMapInfo map;
 374   guint payload_len = 0;
 375   SSRCRtxData *data;
 376   guint32 ssrc;
 377   guint16 seqnum;
 378   guint8 fmtp;
 379
 380   gst_rtp_buffer_map (buffer, GST_MAP_READ, &rtp);
 381
 382   /* get needed data from GstRtpRtxSend */
 383   ssrc = gst_rtp_buffer_get_ssrc (&rtp);
 384   data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 385   ssrc = data->rtx_ssrc;
 386   seqnum = data->next_seqnum++;
 387   fmtp = GPOINTER_TO_UINT (g_hash_table_lookup (rtx->rtx_pt_map,
 388           GUINT_TO_POINTER (gst_rtp_buffer_get_payload_type (&rtp))));
 389
 390   GST_DEBUG_OBJECT (rtx, "creating rtx buffer, orig seqnum: %u, "
 391       "rtx seqnum: %u, rtx ssrc: %X", gst_rtp_buffer_get_seq (&rtp),
 392       seqnum, ssrc);
 393
 394   /* gst_rtp_buffer_map does not map the payload so do it now */
 395   gst_rtp_buffer_get_payload (&rtp);
 396
 397   /* copy fixed header */
 398   mem = gst_memory_copy (rtp.map[0].memory, 0, rtp.size[0]);
 399   gst_buffer_append_memory (new_buffer, mem);
 400
 401   /* copy extension if any */
 402   if (rtp.size[1]) {
 403     mem = gst_memory_copy (rtp.map[1].memory, 0, rtp.size[1]);
 404     gst_buffer_append_memory (new_buffer, mem);
 405   }
 406
 407   /* copy payload and add OSN just before */
 408   payload_len = 2 + rtp.size[2];
 409   mem = gst_allocator_alloc (NULL, payload_len, NULL);
 410
 411   gst_memory_map (mem, &map, GST_MAP_WRITE);
 412   GST_WRITE_UINT16_BE (map.data, gst_rtp_buffer_get_seq (&rtp));
 413   if (rtp.size[2])
 414     memcpy (map.data + 2, rtp.data[2], rtp.size[2]);
 415   gst_memory_unmap (mem, &map);
 416   gst_buffer_append_memory (new_buffer, mem);
 417
 418   /* everything needed is copied */
 419   gst_rtp_buffer_unmap (&rtp);
 420
 421   /* set ssrc, seqnum and fmtp */
 422   gst_rtp_buffer_map (new_buffer, GST_MAP_WRITE, &new_rtp);
 423   gst_rtp_buffer_set_ssrc (&new_rtp, ssrc);
 424   gst_rtp_buffer_set_seq (&new_rtp, seqnum);
 425   gst_rtp_buffer_set_payload_type (&new_rtp, fmtp);
 426   /* RFC 4588: let other elements do the padding, as normal */
 427   gst_rtp_buffer_set_padding (&new_rtp, FALSE);
 428   gst_rtp_buffer_unmap (&new_rtp);
 429
 430   /* Copy over timestamps */
 431   gst_buffer_copy_into (new_buffer, buffer, GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
 432
 433   return new_buffer;
 434 }
 435
 436 static gint
 437 buffer_queue_items_cmp (BufferQueueItem * a, BufferQueueItem * b,
 438     gpointer user_data)
 439 {
 440   /* gst_rtp_buffer_compare_seqnum returns the opposite of what we want,
 441    * it returns negative when seqnum1 > seqnum2 and we want negative
 442    * when b > a, i.e. a is smaller, so it comes first in the sequence */
 443   return gst_rtp_buffer_compare_seqnum (b->seqnum, a->seqnum);
 444 }
 445
 446 static gboolean
 447 gst_rtp_rtx_send_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
 448 {
 449   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
 450   gboolean res;
 451
 452   switch (GST_EVENT_TYPE (event)) {
 453     case GST_EVENT_CUSTOM_UPSTREAM:
 454     {
 455       const GstStructure *s = gst_event_get_structure (event);
 456
 457       /* This event usually comes from the downstream gstrtpsession */
 458       if (gst_structure_has_name (s, "GstRTPRetransmissionRequest")) {
 459         guint seqnum = 0;
 460         guint ssrc = 0;
 461         GstBuffer *rtx_buf = NULL;
 462
 463         /* retrieve seqnum of the packet that need to be retransmitted */
 464         if (!gst_structure_get_uint (s, "seqnum", &seqnum))
 465           seqnum = -1;
 466
 467         /* retrieve ssrc of the packet that need to be retransmitted */
 468         if (!gst_structure_get_uint (s, "ssrc", &ssrc))
 469           ssrc = -1;
 470
 471         GST_DEBUG_OBJECT (rtx, "got rtx request for seqnum: %u, ssrc: %X",
 472             seqnum, ssrc);
 473
 474         GST_OBJECT_LOCK (rtx);
 475         /* check if request is for us */
 476         if (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc))) {
 477           SSRCRtxData *data;
 478           GSequenceIter *iter;
 479           BufferQueueItem search_item;
 480
 481           /* update statistics */
 482           ++rtx->num_rtx_requests;
 483
 484           data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 485
 486           search_item.seqnum = seqnum;
 487           iter = g_sequence_lookup (data->queue, &search_item,
 488               (GCompareDataFunc) buffer_queue_items_cmp, NULL);
 489           if (iter) {
 490             BufferQueueItem *item = g_sequence_get (iter);
 491             GST_LOG_OBJECT (rtx, "found %u", item->seqnum);
 492             rtx_buf = gst_rtp_rtx_buffer_new (rtx, item->buffer);
 493           }
 494         }
 495         GST_OBJECT_UNLOCK (rtx);
 496
 497         if (rtx_buf)
 498           gst_rtp_rtx_send_push_out (rtx, rtx_buf);
 499
 500         gst_event_unref (event);
 501         res = TRUE;
 502
 503         /* This event usually comes from the downstream gstrtpsession */
 504       } else if (gst_structure_has_name (s, "GstRTPCollision")) {
 505         guint ssrc = 0;
 506
 507         if (!gst_structure_get_uint (s, "ssrc", &ssrc))
 508           ssrc = -1;
 509
 510         GST_DEBUG_OBJECT (rtx, "got ssrc collision, ssrc: %X", ssrc);
 511
 512         GST_OBJECT_LOCK (rtx);
 513
 514         /* choose another ssrc for our retransmited stream */
 515         if (g_hash_table_contains (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc))) {
 516           guint master_ssrc;
 517           SSRCRtxData *data;
 518
 519           master_ssrc = GPOINTER_TO_UINT (g_hash_table_lookup (rtx->rtx_ssrcs,
 520                   GUINT_TO_POINTER (ssrc)));
 521           data = gst_rtp_rtx_send_get_ssrc_data (rtx, master_ssrc);
 522
 523           /* change rtx_ssrc and update the reverse map */
 524           data->rtx_ssrc = gst_rtp_rtx_send_choose_ssrc (rtx, 0, FALSE);
 525           g_hash_table_remove (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc));
 526           g_hash_table_insert (rtx->rtx_ssrcs,
 527               GUINT_TO_POINTER (data->rtx_ssrc),
 528               GUINT_TO_POINTER (master_ssrc));
 529
 530           GST_OBJECT_UNLOCK (rtx);
 531
 532           /* no need to forward to payloader because we make sure to have
 533            * a different ssrc
 534            */
 535           gst_event_unref (event);
 536           res = TRUE;
 537         } else {
 538           /* if master ssrc has collided, remove it from our data, as it
 539            * is not going to be used any longer */
 540           if (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc))) {
 541             SSRCRtxData *data;
 542             data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 543             g_hash_table_remove (rtx->rtx_ssrcs,
 544                 GUINT_TO_POINTER (data->rtx_ssrc));
 545             g_hash_table_remove (rtx->ssrc_data, GUINT_TO_POINTER (ssrc));
 546           }
 547
 548           GST_OBJECT_UNLOCK (rtx);
 549
 550           /* forward event to payloader in case collided ssrc is
 551            * master stream */
 552           res = gst_pad_event_default (pad, parent, event);
 553         }
 554       } else {
 555         res = gst_pad_event_default (pad, parent, event);
 556       }
 557       break;
 558     }
 559     default:
 560       res = gst_pad_event_default (pad, parent, event);
 561       break;
 562   }
 563   return res;
 564 }
 565
 566 static gboolean
 567 gst_rtp_rtx_send_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 568 {
 569   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
 570
 571   switch (GST_EVENT_TYPE (event)) {
 572     case GST_EVENT_FLUSH_START:
 573       gst_pad_push_event (rtx->srcpad, event);
 574       gst_rtp_rtx_send_set_flushing (rtx, TRUE);
 575       gst_pad_pause_task (rtx->srcpad);
 576       return TRUE;
 577     case GST_EVENT_FLUSH_STOP:
 578       gst_pad_push_event (rtx->srcpad, event);
 579       gst_rtp_rtx_send_set_flushing (rtx, FALSE);
 580       gst_pad_start_task (rtx->srcpad,
 581           (GstTaskFunction) gst_rtp_rtx_send_src_loop, rtx, NULL);
 582       return TRUE;
 583     case GST_EVENT_EOS:
 584       GST_INFO_OBJECT (rtx, "Got EOS - enqueueing it");
 585       gst_rtp_rtx_send_push_out (rtx, event);
 586       return TRUE;
 587     case GST_EVENT_CAPS:
 588     {
 589       GstCaps *caps;
 590       GstStructure *s;
 591       guint ssrc;
 592       gint payload;
 593       gpointer rtx_payload;
 594       SSRCRtxData *data;
 595
 596       gst_event_parse_caps (event, &caps);
 597
 598       s = gst_caps_get_structure (caps, 0);
 599       if (!gst_structure_get_uint (s, "ssrc", &ssrc))
 600         ssrc = -1;
 601       if (!gst_structure_get_int (s, "payload", &payload))
 602         payload = -1;
 603
 604       if (payload == -1)
 605         GST_WARNING_OBJECT (rtx, "No payload in caps");
 606
 607       GST_OBJECT_LOCK (rtx);
 608       data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 609       if (!g_hash_table_lookup_extended (rtx->rtx_pt_map,
 610               GUINT_TO_POINTER (payload), NULL, &rtx_payload))
 611         rtx_payload = GINT_TO_POINTER (-1);
 612
 613       if (GPOINTER_TO_INT (rtx_payload) == -1 && payload != -1)
 614         GST_WARNING_OBJECT (rtx, "Payload %d not in rtx-pt-map", payload);
 615
 616       GST_DEBUG_OBJECT (rtx,
 617           "got caps for payload: %d->%d, ssrc: %u->%u : %" GST_PTR_FORMAT,
 618           payload, GPOINTER_TO_INT (rtx_payload), ssrc, data->rtx_ssrc, caps);
 619
 620       gst_structure_get_int (s, "clock-rate", &data->clock_rate);
 621
 622       /* The session might need to know the RTX ssrc */
 623       caps = gst_caps_copy (caps);
 624       gst_caps_set_simple (caps, "rtx-ssrc", G_TYPE_UINT, data->rtx_ssrc,
 625           "rtx-seqnum-offset", G_TYPE_UINT, data->seqnum_base, NULL);
 626
 627       if (GPOINTER_TO_INT (rtx_payload) != -1)
 628         gst_caps_set_simple (caps, "rtx-payload", G_TYPE_INT,
 629             GPOINTER_TO_INT (rtx_payload), NULL);
 630
 631       GST_DEBUG_OBJECT (rtx, "got clock-rate from caps: %d for ssrc: %u",
 632           data->clock_rate, ssrc);
 633       GST_OBJECT_UNLOCK (rtx);
 634
 635       gst_event_unref (event);
 636       event = gst_event_new_caps (caps);
 637       gst_caps_unref (caps);
 638       break;
 639     }
 640     default:
 641       break;
 642   }
 643   return gst_pad_event_default (pad, parent, event);
 644 }
 645
 646 /* like rtp_jitter_buffer_get_ts_diff() */
 647 static guint32
 648 gst_rtp_rtx_send_get_ts_diff (SSRCRtxData * data)
 649 {
 650   guint64 high_ts, low_ts;
 651   BufferQueueItem *high_buf, *low_buf;
 652   guint32 result;
 653
 654   high_buf =
 655       g_sequence_get (g_sequence_iter_prev (g_sequence_get_end_iter
 656           (data->queue)));
 657   low_buf = g_sequence_get (g_sequence_get_begin_iter (data->queue));
 658
 659   if (!high_buf || !low_buf || high_buf == low_buf)
 660     return 0;
 661
 662   high_ts = high_buf->timestamp;
 663   low_ts = low_buf->timestamp;
 664
 665   /* it needs to work if ts wraps */
 666   if (high_ts >= low_ts) {
 667     result = (guint32) (high_ts - low_ts);
 668   } else {
 669     result = (guint32) (high_ts + G_MAXUINT32 + 1 - low_ts);
 670   }
 671
 672   /* return value in ms instead of clock ticks */
 673   return (guint32) gst_util_uint64_scale_int (result, 1000, data->clock_rate);
 674 }
 675
 676 /* Must be called with lock */
 677 static void
 678 process_buffer (GstRtpRtxSend * rtx, GstBuffer * buffer)
 679 {
 680   GstRTPBuffer rtp = GST_RTP_BUFFER_INIT;
 681   BufferQueueItem *item;
 682   SSRCRtxData *data;
 683   guint16 seqnum;
 684   guint8 payload_type;
 685   guint32 ssrc, rtptime;
 686
 687   /* read the information we want from the buffer */
 688   gst_rtp_buffer_map (buffer, GST_MAP_READ, &rtp);
 689   seqnum = gst_rtp_buffer_get_seq (&rtp);
 690   payload_type = gst_rtp_buffer_get_payload_type (&rtp);
 691   ssrc = gst_rtp_buffer_get_ssrc (&rtp);
 692   rtptime = gst_rtp_buffer_get_timestamp (&rtp);
 693   gst_rtp_buffer_unmap (&rtp);
 694
 695   GST_TRACE_OBJECT (rtx, "Processing buffer seqnum: %u, ssrc: %X", seqnum,
 696       ssrc);
 697
 698   /* do not store the buffer if it's payload type is unknown */
 699   if (g_hash_table_contains (rtx->rtx_pt_map, GUINT_TO_POINTER (payload_type))) {
 700     data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 701
 702     /* add current rtp buffer to queue history */
 703     item = g_slice_new0 (BufferQueueItem);
 704     item->seqnum = seqnum;
 705     item->timestamp = rtptime;
 706     item->buffer = gst_buffer_ref (buffer);
 707     g_sequence_append (data->queue, item);
 708
 709     /* remove oldest packets from history if they are too many */
 710     if (rtx->max_size_packets) {
 711       while (g_sequence_get_length (data->queue) > rtx->max_size_packets)
 712         g_sequence_remove (g_sequence_get_begin_iter (data->queue));
 713     }
 714     if (rtx->max_size_time) {
 715       while (gst_rtp_rtx_send_get_ts_diff (data) > rtx->max_size_time)
 716         g_sequence_remove (g_sequence_get_begin_iter (data->queue));
 717     }
 718   }
 719 }
 720
 721 static GstFlowReturn
 722 gst_rtp_rtx_send_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 723 {
 724   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
 725   GstFlowReturn ret;
 726
 727   GST_OBJECT_LOCK (rtx);
 728   process_buffer (rtx, buffer);
 729   GST_OBJECT_UNLOCK (rtx);
 730   ret = gst_pad_push (rtx->srcpad, buffer);
 731
 732   return ret;
 733 }
 734
 735 static gboolean
 736 process_buffer_from_list (GstBuffer ** buffer, guint idx, gpointer user_data)
 737 {
 738   process_buffer (user_data, *buffer);
 739   return TRUE;
 740 }
 741
 742 static GstFlowReturn
 743 gst_rtp_rtx_send_chain_list (GstPad * pad, GstObject * parent,
 744     GstBufferList * list)
 745 {
 746   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
 747   GstFlowReturn ret;
 748
 749   GST_OBJECT_LOCK (rtx);
 750   gst_buffer_list_foreach (list, process_buffer_from_list, rtx);
 751   GST_OBJECT_UNLOCK (rtx);
 752
 753   ret = gst_pad_push_list (rtx->srcpad, list);
 754
 755   return ret;
 756 }
 757
 758 static void
 759 gst_rtp_rtx_send_src_loop (GstRtpRtxSend * rtx)
 760 {
 761   GstDataQueueItem *data;
 762
 763   if (gst_data_queue_pop (rtx->queue, &data)) {
 764     GST_LOG_OBJECT (rtx, "pushing rtx buffer %p", data->object);
 765
 766     if (G_LIKELY (GST_IS_BUFFER (data->object))) {
 767       GST_OBJECT_LOCK (rtx);
 768       /* Update statistics just before pushing. */
 769       rtx->num_rtx_packets++;
 770       GST_OBJECT_UNLOCK (rtx);
 771
 772       gst_pad_push (rtx->srcpad, GST_BUFFER (data->object));
 773     } else if (GST_IS_EVENT (data->object)) {
 774       gst_pad_push_event (rtx->srcpad, GST_EVENT (data->object));
 775
 776       /* after EOS, we should not send any more buffers,
 777        * even if there are more requests coming in */
 778       if (GST_EVENT_TYPE (data->object) == GST_EVENT_EOS) {
 779         gst_rtp_rtx_send_set_flushing (rtx, TRUE);
 780       }
 781     } else {
 782       g_assert_not_reached ();
 783     }
 784
 785     data->object = NULL;        /* we no longer own that object */
 786     data->destroy (data);
 787   } else {
 788     GST_LOG_OBJECT (rtx, "flushing");
 789     gst_pad_pause_task (rtx->srcpad);
 790   }
 791 }
 792
 793 static gboolean
 794 gst_rtp_rtx_send_activate_mode (GstPad * pad, GstObject * parent,
 795     GstPadMode mode, gboolean active)
 796 {
 797   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
 798   gboolean ret = FALSE;
 799
 800   switch (mode) {
 801     case GST_PAD_MODE_PUSH:
 802       if (active) {
 803         gst_rtp_rtx_send_set_flushing (rtx, FALSE);
 804         ret = gst_pad_start_task (rtx->srcpad,
 805             (GstTaskFunction) gst_rtp_rtx_send_src_loop, rtx, NULL);
 806       } else {
 807         gst_rtp_rtx_send_set_flushing (rtx, TRUE);
 808         ret = gst_pad_stop_task (rtx->srcpad);
 809       }
 810       GST_INFO_OBJECT (rtx, "activate_mode: active %d, ret %d", active, ret);
 811       break;
 812     default:
 813       break;
 814   }
 815   return ret;
 816 }
 817
 818 static void
 819 gst_rtp_rtx_send_get_property (GObject * object,
 820     guint prop_id, GValue * value, GParamSpec * pspec)
 821 {
 822   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (object);
 823
 824   switch (prop_id) {
 825     case PROP_PAYLOAD_TYPE_MAP:
 826       GST_OBJECT_LOCK (rtx);
 827       g_value_set_boxed (value, rtx->rtx_pt_map_structure);
 828       GST_OBJECT_UNLOCK (rtx);
 829       break;
 830     case PROP_MAX_SIZE_TIME:
 831       GST_OBJECT_LOCK (rtx);
 832       g_value_set_uint (value, rtx->max_size_time);
 833       GST_OBJECT_UNLOCK (rtx);
 834       break;
 835     case PROP_MAX_SIZE_PACKETS:
 836       GST_OBJECT_LOCK (rtx);
 837       g_value_set_uint (value, rtx->max_size_packets);
 838       GST_OBJECT_UNLOCK (rtx);
 839       break;
 840     case PROP_NUM_RTX_REQUESTS:
 841       GST_OBJECT_LOCK (rtx);
 842       g_value_set_uint (value, rtx->num_rtx_requests);
 843       GST_OBJECT_UNLOCK (rtx);
 844       break;
 845     case PROP_NUM_RTX_PACKETS:
 846       GST_OBJECT_LOCK (rtx);
 847       g_value_set_uint (value, rtx->num_rtx_packets);
 848       GST_OBJECT_UNLOCK (rtx);
 849       break;
 850     default:
 851       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 852       break;
 853   }
 854 }
 855
 856 static gboolean
 857 structure_to_hash_table (GQuark field_id, const GValue * value, gpointer hash)
 858 {
 859   const gchar *field_str;
 860   guint field_uint;
 861   guint value_uint;
 862
 863   field_str = g_quark_to_string (field_id);
 864   field_uint = atoi (field_str);
 865   value_uint = g_value_get_uint (value);
 866   g_hash_table_insert ((GHashTable *) hash, GUINT_TO_POINTER (field_uint),
 867       GUINT_TO_POINTER (value_uint));
 868
 869   return TRUE;
 870 }
 871
 872 static void
 873 gst_rtp_rtx_send_set_property (GObject * object,
 874     guint prop_id, const GValue * value, GParamSpec * pspec)
 875 {
 876   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (object);
 877
 878   switch (prop_id) {
 879     case PROP_SSRC_MAP:
 880       GST_OBJECT_LOCK (rtx);
 881       if (rtx->external_ssrc_map)
 882         gst_structure_free (rtx->external_ssrc_map);
 883       rtx->external_ssrc_map = g_value_dup_boxed (value);
 884       GST_OBJECT_UNLOCK (rtx);
 885       break;
 886     case PROP_PAYLOAD_TYPE_MAP:
 887       GST_OBJECT_LOCK (rtx);
 888       if (rtx->rtx_pt_map_structure)
 889         gst_structure_free (rtx->rtx_pt_map_structure);
 890       rtx->rtx_pt_map_structure = g_value_dup_boxed (value);
 891       g_hash_table_remove_all (rtx->rtx_pt_map);
 892       gst_structure_foreach (rtx->rtx_pt_map_structure, structure_to_hash_table,
 893           rtx->rtx_pt_map);
 894       GST_OBJECT_UNLOCK (rtx);
 895       break;
 896     case PROP_MAX_SIZE_TIME:
 897       GST_OBJECT_LOCK (rtx);
 898       rtx->max_size_time = g_value_get_uint (value);
 899       GST_OBJECT_UNLOCK (rtx);
 900       break;
 901     case PROP_MAX_SIZE_PACKETS:
 902       GST_OBJECT_LOCK (rtx);
 903       rtx->max_size_packets = g_value_get_uint (value);
 904       GST_OBJECT_UNLOCK (rtx);
 905       break;
 906     default:
 907       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 908       break;
 909   }
 910 }
 911
 912 static GstStateChangeReturn
 913 gst_rtp_rtx_send_change_state (GstElement * element, GstStateChange transition)
 914 {
 915   GstStateChangeReturn ret;
 916   GstRtpRtxSend *rtx;
 917
 918   rtx = GST_RTP_RTX_SEND (element);
 919
 920   switch (transition) {
 921     default:
 922       break;
 923   }
 924
 925   ret =
 926       GST_ELEMENT_CLASS (gst_rtp_rtx_send_parent_class)->change_state (element,
 927       transition);
 928
 929   switch (transition) {
 930     case GST_STATE_CHANGE_PAUSED_TO_READY:
 931       gst_rtp_rtx_send_reset (rtx);
 932       break;
 933     default:
 934       break;
 935   }
 936
 937   return ret;
 938 }
 939
 940 gboolean
 941 gst_rtp_rtx_send_plugin_init (GstPlugin * plugin)
 942 {
 943   GST_DEBUG_CATEGORY_INIT (gst_rtp_rtx_send_debug, "rtprtxsend", 0,
 944       "rtp retransmission sender");
 945
 946   return gst_element_register (plugin, "rtprtxsend", GST_RANK_NONE,
 947       GST_TYPE_RTP_RTX_SEND);
 948 }