gst/rtpmanager/gstrtprtxreceive.c

   1 /* RTP Retransmission receiver element for GStreamer
   2  *
   3  * gstrtprtxreceive.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-rtprtxreceive
  26  * @see_also: rtprtxsend, rtpsession, rtpjitterbuffer
  27  *
  28  * The receiver will listen to the custom retransmission events from the
  29  * downstream jitterbuffer and will remember the SSRC1 of the stream and
  30  * seqnum that was requested. When it sees a packet with one of the stored
  31  * seqnum, it associates the SSRC2 of the stream with the SSRC1 of the
  32  * master stream. From then it knows that SSRC2 is the retransmission
  33  * stream of SSRC1. This algorithm is stated in RFC 4588. For this
  34  * algorithm to work, RFC4588 also states that no two pending retransmission
  35  * requests can exist for the same seqnum and different SSRCs or else it
  36  * would be impossible to associate the retransmission with the original
  37  * requester SSRC.
  38  * When the RTX receiver has associated the retransmission packets,
  39  * it can depayload and forward them to the source pad of the element.
  40  * RTX is SSRC-multiplexed. See #GstRtpRtxSend
  41  *
  42  * <refsect2>
  43  * <title>Example pipelines</title>
  44  * |[
  45  * gst-launch-1.0 rtpsession name=rtpsession \
  46  *         audiotestsrc ! speexenc ! rtpspeexpay pt=97 ! rtprtxsend rtx-payload-type=99 ! \
  47  *             identity drop-probability=0.1 ! rtpsession.send_rtp_sink \
  48  *             rtpsession.send_rtp_src ! udpsink host="127.0.0.1" port=5000 \
  49  *         udpsrc port=5001 ! rtpsession.recv_rtcp_sink \
  50  *         rtpsession.send_rtcp_src ! udpsink host="127.0.0.1" port=5002 sync=false async=false
  51  * ]| Send audio stream through port 5000. (5001 and 5002 are just the rtcp link with the receiver)
  52  * |[
  53  * gst-launch-1.0 rtpsession name=rtpsession \
  54  *         udpsrc port=5000 caps="application/x-rtp,media=(string)audio,clock-rate=(int)44100,encoding-name=(string)SPEEX,encoding-params=(string)1,octet-align=(string)1" ! \
  55  *             rtpsession.recv_rtp_sink \
  56  *             rtpsession.recv_rtp_src ! rtprtxreceive rtx-payload-types="99" ! rtpjitterbuffer do-retransmission=true ! rtpspeexdepay ! \
  57  *             speexdec ! audioconvert ! autoaudiosink \
  58  *         rtpsession.send_rtcp_src ! udpsink host="127.0.0.1" port=5001 \
  59  *         udpsrc port=5002 ! rtpsession.recv_rtcp_sink sync=fakse async=false
  60  * ]| Receive audio stream from port 5000. (5001 and 5002 are just the rtcp link with the sender)
  61  * On sender side make sure to use a different payload type for the stream and
  62  * its associated retransmission stream (see #GstRtpRtxSend). Note that several retransmission streams can
  63  * have the same payload type so this is not deterministic. Actually the
  64  * rtprtxreceiver element does the association using seqnum values.
  65  * On receiver side set all the retransmission payload types (Those informations are retrieve
  66  * through SDP).
  67  * You should still hear a clear sound when setting drop-probability to something greater than 0.
  68  * The rtpjitterbuffer will generate a custom upstream event GstRTPRetransmissionRequest when
  69  * it assumes that one packet is missing. Then this request is translated to a FB NACK in the rtcp link
  70  * Finally the rtpsession of the sender side re-convert it in a GstRTPRetransmissionRequest that will
  71  * be handle by rtprtxsend.
  72  * When increasing this value it may be possible that even the retransmission stream would be dropped
  73  * so the receiver will ask to resend the packets again and again until it actually receive them.
  74  * If the value is too high the rtprtxsend will not be able to retrieve the packet in its list of
  75  * stored packets. For learning purpose you could try to increase the max-size-packets or max-size-time
  76  * rtprtxsender's properties.
  77  * Also note that you should use rtprtxsend through rtpbin and its set-aux-send property. See #GstRtpBin.
  78  * |[
  79  * gst-launch-1.0 rtpsession name=rtpsession0 \
  80  *         audiotestsrc wave=0 ! speexenc ! rtpspeexpay pt=97 ! rtprtxsend rtx-payload-type=99 seqnum-offset=1 ! \
  81  *             identity drop-probability=0.1 ! rtpsession0.send_rtp_sink \
  82  *             rtpsession0.send_rtp_src ! udpsink host="127.0.0.1" port=5000 \
  83  *         udpsrc port=5001 ! rtpsession0.recv_rtcp_sink \
  84  *         rtpsession0.send_rtcp_src ! udpsink host="127.0.0.1" port=5002 sync=false async=false \
  85  *                rtpsession name=rtpsession1 \
  86  *         audiotestsrc wave=0 ! speexenc ! rtpspeexpay pt=97 ! rtprtxsend rtx-payload-type=99 seqnum-offset=10 ! \
  87  *             identity drop-probability=0.1 ! rtpsession1.send_rtp_sink \
  88  *             rtpsession1.send_rtp_src ! udpsink host="127.0.0.1" port=5000 \
  89  *         udpsrc port=5004 ! rtpsession1.recv_rtcp_sink \
  90  *         rtpsession1.send_rtcp_src ! udpsink host="127.0.0.1" port=5002 sync=false async=false
  91  * ]| Send two audio streams to port 5000.
  92  * |[
  93  * gst-launch-1.0 rtpsession name=rtpsession
  94  *         udpsrc port=5000 caps="application/x-rtp,media=(string)audio,clock-rate=(int)44100,encoding-name=(string)SPEEX,encoding-params=(string)1,octet-align=(string)1" ! \
  95  *             rtpsession.recv_rtp_sink \
  96  *             rtpsession.recv_rtp_src ! rtprtxreceive rtx-payload-types="99" ! rtpssrcdemux name=demux \
  97  *             demux. ! queue ! rtpjitterbuffer do-retransmission=true ! rtpspeexdepay ! speexdec ! audioconvert ! autoaudiosink \
  98  *             demux. ! queue ! rtpjitterbuffer do-retransmission=true ! rtpspeexdepay ! speexdec ! audioconvert ! autoaudiosink \
  99  *         rtpsession.send_rtcp_src ! ! tee name=t ! queue ! udpsink host="127.0.0.1" port=5001 t. ! queue ! udpsink host="127.0.0.1" port=5004 \
 100  *         udpsrc port=5002 ! rtpsession.recv_rtcp_sink sync=fakse async=false
 101  * ]| Receive audio stream from port 5000.
 102  * On sender side the two streams have the same payload type for master streams, Same about retransmission streams.
 103  * The streams are sent to the network through two distincts sessions.
 104  * But we need to set a different seqnum-offset to make sure their seqnum navigate at a different rate like in concrete cases.
 105  * We could also choose the same seqnum offset but we would require to set a different initial seqnum value.
 106  * This is also why the rtprtxreceive can succeed to do the association between master and retransmission stream.
 107  * On receiver side the same session is used to receive the two streams. So the rtpssrcdemux is here to demultiplex
 108  * those two streams. The rtprtxreceive is responsible for reconstructing the original packets from the two retransmission streams.
 109  * You can play with the drop-probability value for one or both streams.
 110  * You should hear a clear sound. (after a few seconds the two streams wave feel synchronized)
 111  * </refsect2>
 112  */
 113
 114 #ifdef HAVE_CONFIG_H
 115 #include "config.h"
 116 #endif
 117
 118 #include <gst/gst.h>
 119 #include <gst/rtp/gstrtpbuffer.h>
 120 #include <string.h>
 121 #include <stdlib.h>
 122
 123 #include "gstrtprtxreceive.h"
 124
 125 #define ASSOC_TIMEOUT (GST_SECOND)
 126
 127 GST_DEBUG_CATEGORY_STATIC (gst_rtp_rtx_receive_debug);
 128 #define GST_CAT_DEFAULT gst_rtp_rtx_receive_debug
 129
 130 enum
 131 {
 132   PROP_0,
 133   PROP_PAYLOAD_TYPE_MAP,
 134   PROP_NUM_RTX_REQUESTS,
 135   PROP_NUM_RTX_PACKETS,
 136   PROP_NUM_RTX_ASSOC_PACKETS
 137 };
 138
 139 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
 140     GST_PAD_SRC,
 141     GST_PAD_ALWAYS,
 142     GST_STATIC_CAPS ("application/x-rtp")
 143     );
 144
 145 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
 146     GST_PAD_SINK,
 147     GST_PAD_ALWAYS,
 148     GST_STATIC_CAPS ("application/x-rtp")
 149     );
 150
 151 static gboolean gst_rtp_rtx_receive_src_event (GstPad * pad, GstObject * parent,
 152     GstEvent * event);
 153 static GstFlowReturn gst_rtp_rtx_receive_chain (GstPad * pad,
 154     GstObject * parent, GstBuffer * buffer);
 155
 156 static GstStateChangeReturn gst_rtp_rtx_receive_change_state (GstElement *
 157     element, GstStateChange transition);
 158
 159 static void gst_rtp_rtx_receive_set_property (GObject * object, guint prop_id,
 160     const GValue * value, GParamSpec * pspec);
 161 static void gst_rtp_rtx_receive_get_property (GObject * object, guint prop_id,
 162     GValue * value, GParamSpec * pspec);
 163 static void gst_rtp_rtx_receive_finalize (GObject * object);
 164
 165 G_DEFINE_TYPE (GstRtpRtxReceive, gst_rtp_rtx_receive, GST_TYPE_ELEMENT);
 166
 167 static void
 168 gst_rtp_rtx_receive_class_init (GstRtpRtxReceiveClass * klass)
 169 {
 170   GObjectClass *gobject_class;
 171   GstElementClass *gstelement_class;
 172
 173   gobject_class = (GObjectClass *) klass;
 174   gstelement_class = (GstElementClass *) klass;
 175
 176   gobject_class->get_property = gst_rtp_rtx_receive_get_property;
 177   gobject_class->set_property = gst_rtp_rtx_receive_set_property;
 178   gobject_class->finalize = gst_rtp_rtx_receive_finalize;
 179
 180   g_object_class_install_property (gobject_class, PROP_PAYLOAD_TYPE_MAP,
 181       g_param_spec_boxed ("payload-type-map", "Payload Type Map",
 182           "Map of original payload types to their retransmission payload types",
 183           GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 184
 185   g_object_class_install_property (gobject_class, PROP_NUM_RTX_REQUESTS,
 186       g_param_spec_uint ("num-rtx-requests", "Num RTX Requests",
 187           "Number of retransmission events received", 0, G_MAXUINT,
 188           0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 189
 190   g_object_class_install_property (gobject_class, PROP_NUM_RTX_PACKETS,
 191       g_param_spec_uint ("num-rtx-packets", "Num RTX Packets",
 192           " Number of retransmission packets received", 0, G_MAXUINT,
 193           0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 194
 195   g_object_class_install_property (gobject_class, PROP_NUM_RTX_ASSOC_PACKETS,
 196       g_param_spec_uint ("num-rtx-assoc-packets",
 197           "Num RTX Associated Packets", "Number of retransmission packets "
 198           "correctly associated with retransmission requests", 0, G_MAXUINT,
 199           0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 200
 201   gst_element_class_add_static_pad_template (gstelement_class, &src_factory);
 202   gst_element_class_add_static_pad_template (gstelement_class, &sink_factory);
 203
 204   gst_element_class_set_static_metadata (gstelement_class,
 205       "RTP Retransmission receiver", "Codec",
 206       "Receive retransmitted RTP packets according to RFC4588",
 207       "Julien Isorce <julien.isorce@collabora.co.uk>");
 208
 209   gstelement_class->change_state =
 210       GST_DEBUG_FUNCPTR (gst_rtp_rtx_receive_change_state);
 211 }
 212
 213 static void
 214 gst_rtp_rtx_receive_reset (GstRtpRtxReceive * rtx)
 215 {
 216   GST_OBJECT_LOCK (rtx);
 217   g_hash_table_remove_all (rtx->ssrc2_ssrc1_map);
 218   g_hash_table_remove_all (rtx->seqnum_ssrc1_map);
 219   rtx->num_rtx_requests = 0;
 220   rtx->num_rtx_packets = 0;
 221   rtx->num_rtx_assoc_packets = 0;
 222   GST_OBJECT_UNLOCK (rtx);
 223 }
 224
 225 static void
 226 gst_rtp_rtx_receive_finalize (GObject * object)
 227 {
 228   GstRtpRtxReceive *rtx = GST_RTP_RTX_RECEIVE (object);
 229
 230   g_hash_table_unref (rtx->ssrc2_ssrc1_map);
 231   g_hash_table_unref (rtx->seqnum_ssrc1_map);
 232   g_hash_table_unref (rtx->rtx_pt_map);
 233   if (rtx->rtx_pt_map_structure)
 234     gst_structure_free (rtx->rtx_pt_map_structure);
 235
 236   G_OBJECT_CLASS (gst_rtp_rtx_receive_parent_class)->finalize (object);
 237 }
 238
 239 typedef struct
 240 {
 241   guint32 ssrc;
 242   GstClockTime time;
 243 } SsrcAssoc;
 244
 245 static SsrcAssoc *
 246 ssrc_assoc_new (guint32 ssrc, GstClockTime time)
 247 {
 248   SsrcAssoc *assoc = g_slice_new (SsrcAssoc);
 249
 250   assoc->ssrc = ssrc;
 251   assoc->time = time;
 252
 253   return assoc;
 254 }
 255
 256 static void
 257 ssrc_assoc_free (SsrcAssoc * assoc)
 258 {
 259   g_slice_free (SsrcAssoc, assoc);
 260 }
 261
 262 static void
 263 gst_rtp_rtx_receive_init (GstRtpRtxReceive * rtx)
 264 {
 265   GstElementClass *klass = GST_ELEMENT_GET_CLASS (rtx);
 266
 267   rtx->srcpad =
 268       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 269           "src"), "src");
 270   GST_PAD_SET_PROXY_CAPS (rtx->srcpad);
 271   GST_PAD_SET_PROXY_ALLOCATION (rtx->srcpad);
 272   gst_pad_set_event_function (rtx->srcpad,
 273       GST_DEBUG_FUNCPTR (gst_rtp_rtx_receive_src_event));
 274   gst_element_add_pad (GST_ELEMENT (rtx), rtx->srcpad);
 275
 276   rtx->sinkpad =
 277       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 278           "sink"), "sink");
 279   GST_PAD_SET_PROXY_CAPS (rtx->sinkpad);
 280   GST_PAD_SET_PROXY_ALLOCATION (rtx->sinkpad);
 281   gst_pad_set_chain_function (rtx->sinkpad,
 282       GST_DEBUG_FUNCPTR (gst_rtp_rtx_receive_chain));
 283   gst_element_add_pad (GST_ELEMENT (rtx), rtx->sinkpad);
 284
 285   rtx->ssrc2_ssrc1_map = g_hash_table_new (g_direct_hash, g_direct_equal);
 286   rtx->seqnum_ssrc1_map = g_hash_table_new_full (g_direct_hash, g_direct_equal,
 287       NULL, (GDestroyNotify) ssrc_assoc_free);
 288
 289   rtx->rtx_pt_map = g_hash_table_new (g_direct_hash, g_direct_equal);
 290 }
 291
 292 static gboolean
 293 gst_rtp_rtx_receive_src_event (GstPad * pad, GstObject * parent,
 294     GstEvent * event)
 295 {
 296   GstRtpRtxReceive *rtx = GST_RTP_RTX_RECEIVE (parent);
 297   gboolean res;
 298
 299   switch (GST_EVENT_TYPE (event)) {
 300     case GST_EVENT_CUSTOM_UPSTREAM:
 301     {
 302       const GstStructure *s = gst_event_get_structure (event);
 303
 304       /* This event usually comes from the downstream gstrtpjitterbuffer */
 305       if (gst_structure_has_name (s, "GstRTPRetransmissionRequest")) {
 306         guint seqnum = 0;
 307         guint ssrc = 0;
 308         gpointer ssrc2 = 0;
 309
 310         /* retrieve seqnum of the packet that need to be retransmitted */
 311         if (!gst_structure_get_uint (s, "seqnum", &seqnum))
 312           seqnum = -1;
 313
 314         /* retrieve ssrc of the packet that need to be retransmitted
 315          * it's useful when reconstructing the original packet from the rtx packet */
 316         if (!gst_structure_get_uint (s, "ssrc", &ssrc))
 317           ssrc = -1;
 318
 319         GST_DEBUG_OBJECT (rtx,
 320             "request seqnum: %" G_GUINT32_FORMAT ", ssrc: %" G_GUINT32_FORMAT,
 321             seqnum, ssrc);
 322
 323         GST_OBJECT_LOCK (rtx);
 324
 325         /* increase number of seen requests for our statistics */
 326         ++rtx->num_rtx_requests;
 327
 328         /* First, we lookup in our map to see if we have already associate this
 329          * master stream ssrc with its retransmitted stream.
 330          * Every ssrc are unique so we can use the same hash table
 331          * for both retrieving the ssrc1 from ssrc2 and also ssrc2 from ssrc1
 332          */
 333         if (g_hash_table_lookup_extended (rtx->ssrc2_ssrc1_map,
 334                 GUINT_TO_POINTER (ssrc), NULL, &ssrc2)
 335             && GPOINTER_TO_UINT (ssrc2) != GPOINTER_TO_UINT (ssrc)) {
 336           GST_DEBUG_OBJECT (rtx, "Retransmited stream %" G_GUINT32_FORMAT
 337               " already associated to its master", GPOINTER_TO_UINT (ssrc2));
 338         } else {
 339           SsrcAssoc *assoc;
 340
 341           /* not already associated but also we have to check that we have not
 342            * already considered this request.
 343            */
 344           if (g_hash_table_lookup_extended (rtx->seqnum_ssrc1_map,
 345                   GUINT_TO_POINTER (seqnum), NULL, (gpointer *) & assoc)) {
 346             if (assoc->ssrc == ssrc) {
 347               /* do nothing because we have already considered this request
 348                * The jitter may be too impatient of the rtx packet has been
 349                * lost too.
 350                * It does not mean we reject the event, we still want to forward
 351                * the request to the gstrtpsession to be translater into a FB NACK
 352                */
 353               GST_DEBUG_OBJECT (rtx, "Duplicated request seqnum: %"
 354                   G_GUINT32_FORMAT ", ssrc1: %" G_GUINT32_FORMAT, seqnum, ssrc);
 355             } else {
 356
 357               /* If the association attempt is larger than ASSOC_TIMEOUT,
 358                * then we give up on it, and try this one.
 359                */
 360               if (!GST_CLOCK_TIME_IS_VALID (rtx->last_time) ||
 361                   !GST_CLOCK_TIME_IS_VALID (assoc->time) ||
 362                   assoc->time + ASSOC_TIMEOUT < rtx->last_time) {
 363                 /* From RFC 4588:
 364                  * the receiver MUST NOT have two outstanding requests for the
 365                  * same packet sequence number in two different original streams
 366                  * before the association is resolved. Otherwise it's impossible
 367                  * to associate a rtx stream and its master stream
 368                  */
 369
 370                 /* remove seqnum in order to reuse the spot */
 371                 g_hash_table_remove (rtx->seqnum_ssrc1_map,
 372                     GUINT_TO_POINTER (seqnum));
 373                 goto retransmit;
 374               } else {
 375                 GST_DEBUG_OBJECT (rtx,
 376                     "reject request for seqnum %" G_GUINT32_FORMAT
 377                     " of master stream %" G_GUINT32_FORMAT, seqnum, ssrc);
 378
 379                 /* do not forward the event as we are rejecting this request */
 380                 GST_OBJECT_UNLOCK (rtx);
 381                 gst_event_unref (event);
 382                 return TRUE;
 383               }
 384             }
 385           } else {
 386           retransmit:
 387             /* the request has not been already considered
 388              * insert it for the first time */
 389             g_hash_table_insert (rtx->seqnum_ssrc1_map,
 390                 GUINT_TO_POINTER (seqnum),
 391                 ssrc_assoc_new (ssrc, rtx->last_time));
 392           }
 393         }
 394
 395         GST_DEBUG_OBJECT (rtx,
 396             "packet number %" G_GUINT32_FORMAT " of master stream %"
 397             G_GUINT32_FORMAT " needs to be retransmitted", seqnum, ssrc);
 398
 399         GST_OBJECT_UNLOCK (rtx);
 400       }
 401
 402       /* Transfer event upstream so that the request can acutally by translated
 403        * through gstrtpsession through the network */
 404       res = gst_pad_event_default (pad, parent, event);
 405       break;
 406     }
 407     default:
 408       res = gst_pad_event_default (pad, parent, event);
 409       break;
 410   }
 411   return res;
 412 }
 413
 414 /* Copy fixed header and extension. Replace current ssrc by ssrc1,
 415  * remove OSN and replace current seq num by OSN.
 416  * Copy memory to avoid to manually copy each rtp buffer field.
 417  */
 418 static GstBuffer *
 419 _gst_rtp_buffer_new_from_rtx (GstRTPBuffer * rtp, guint32 ssrc1,
 420     guint16 orign_seqnum, guint8 origin_payload_type)
 421 {
 422   GstMemory *mem = NULL;
 423   GstRTPBuffer new_rtp = GST_RTP_BUFFER_INIT;
 424   GstBuffer *new_buffer = gst_buffer_new ();
 425   GstMapInfo map;
 426   guint payload_len = 0;
 427
 428   /* copy fixed header */
 429   mem = gst_memory_copy (rtp->map[0].memory,
 430       (guint8 *) rtp->data[0] - rtp->map[0].data, rtp->size[0]);
 431   gst_buffer_append_memory (new_buffer, mem);
 432
 433   /* copy extension if any */
 434   if (rtp->size[1]) {
 435     mem = gst_memory_copy (rtp->map[1].memory,
 436         (guint8 *) rtp->data[1] - rtp->map[1].data, rtp->size[1]);
 437     gst_buffer_append_memory (new_buffer, mem);
 438   }
 439
 440   /* copy payload and remove OSN */
 441   payload_len = rtp->size[2] - 2;
 442   mem = gst_allocator_alloc (NULL, payload_len, NULL);
 443
 444   gst_memory_map (mem, &map, GST_MAP_WRITE);
 445   if (rtp->size[2])
 446     memcpy (map.data, (guint8 *) rtp->data[2] + 2, payload_len);
 447   gst_memory_unmap (mem, &map);
 448   gst_buffer_append_memory (new_buffer, mem);
 449
 450   /* the sender always constructs rtx packets without padding,
 451    * But the receiver can still receive rtx packets with padding.
 452    * So just copy it.
 453    */
 454   if (rtp->size[3]) {
 455     guint pad_len = rtp->size[3];
 456
 457     mem = gst_allocator_alloc (NULL, pad_len, NULL);
 458
 459     gst_memory_map (mem, &map, GST_MAP_WRITE);
 460     map.data[pad_len - 1] = pad_len;
 461     gst_memory_unmap (mem, &map);
 462
 463     gst_buffer_append_memory (new_buffer, mem);
 464   }
 465
 466   /* set ssrc and seq num */
 467   gst_rtp_buffer_map (new_buffer, GST_MAP_WRITE, &new_rtp);
 468   gst_rtp_buffer_set_ssrc (&new_rtp, ssrc1);
 469   gst_rtp_buffer_set_seq (&new_rtp, orign_seqnum);
 470   gst_rtp_buffer_set_payload_type (&new_rtp, origin_payload_type);
 471   gst_rtp_buffer_unmap (&new_rtp);
 472
 473   gst_buffer_copy_into (new_buffer, rtp->buffer,
 474       GST_BUFFER_COPY_FLAGS | GST_BUFFER_COPY_TIMESTAMPS, 0, -1);
 475
 476   return new_buffer;
 477 }
 478
 479 static GstFlowReturn
 480 gst_rtp_rtx_receive_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 481 {
 482   GstRtpRtxReceive *rtx = GST_RTP_RTX_RECEIVE (parent);
 483   GstRTPBuffer rtp = GST_RTP_BUFFER_INIT;
 484   GstFlowReturn ret = GST_FLOW_OK;
 485   GstBuffer *new_buffer = NULL;
 486   guint32 ssrc = 0;
 487   gpointer ssrc1 = 0;
 488   guint32 ssrc2 = 0;
 489   guint16 seqnum = 0;
 490   guint16 orign_seqnum = 0;
 491   guint8 payload_type = 0;
 492   guint8 origin_payload_type = 0;
 493   gboolean is_rtx;
 494   gboolean drop = FALSE;
 495
 496   /* map current rtp packet to parse its header */
 497   gst_rtp_buffer_map (buffer, GST_MAP_READ, &rtp);
 498   ssrc = gst_rtp_buffer_get_ssrc (&rtp);
 499   seqnum = gst_rtp_buffer_get_seq (&rtp);
 500   payload_type = gst_rtp_buffer_get_payload_type (&rtp);
 501
 502   /* check if we have a retransmission packet (this information comes from SDP) */
 503   GST_OBJECT_LOCK (rtx);
 504
 505   rtx->last_time = GST_BUFFER_PTS (buffer);
 506
 507   is_rtx =
 508       g_hash_table_lookup_extended (rtx->rtx_pt_map,
 509       GUINT_TO_POINTER (payload_type), NULL, NULL);
 510
 511   /* if the current packet is from a retransmission stream */
 512   if (is_rtx) {
 513     /* increase our statistic */
 514     ++rtx->num_rtx_packets;
 515
 516     /* read OSN in the rtx payload */
 517     orign_seqnum = GST_READ_UINT16_BE (gst_rtp_buffer_get_payload (&rtp));
 518     origin_payload_type =
 519         GPOINTER_TO_UINT (g_hash_table_lookup (rtx->rtx_pt_map,
 520             GUINT_TO_POINTER (payload_type)));
 521
 522     /* first we check if we already have associated this retransmission stream
 523      * to a master stream */
 524     if (g_hash_table_lookup_extended (rtx->ssrc2_ssrc1_map,
 525             GUINT_TO_POINTER (ssrc), NULL, &ssrc1)) {
 526       GST_DEBUG_OBJECT (rtx,
 527           "packet is from retransmission stream %" G_GUINT32_FORMAT
 528           " already associated to master stream %" G_GUINT32_FORMAT, ssrc,
 529           GPOINTER_TO_UINT (ssrc1));
 530       ssrc2 = ssrc;
 531     } else {
 532       SsrcAssoc *assoc;
 533
 534       /* the current retransmitted packet has its rtx stream not already
 535        * associated to a master stream, so retrieve it from our request
 536        * history */
 537       if (g_hash_table_lookup_extended (rtx->seqnum_ssrc1_map,
 538               GUINT_TO_POINTER (orign_seqnum), NULL, (gpointer *) & assoc)) {
 539         GST_DEBUG_OBJECT (rtx,
 540             "associate retransmitted stream %" G_GUINT32_FORMAT
 541             " to master stream %" G_GUINT32_FORMAT " thanks to packet %"
 542             G_GUINT16_FORMAT "", ssrc, assoc->ssrc, orign_seqnum);
 543         ssrc1 = GUINT_TO_POINTER (assoc->ssrc);
 544         ssrc2 = ssrc;
 545
 546         /* just put a guard */
 547         if (GPOINTER_TO_UINT (ssrc1) == ssrc2)
 548           GST_WARNING_OBJECT (rtx, "RTX receiver ssrc2_ssrc1_map bad state, "
 549               "ssrc %" G_GUINT32_FORMAT " are the same\n", ssrc);
 550
 551         /* free the spot so that this seqnum can be used to do another
 552          * association */
 553         g_hash_table_remove (rtx->seqnum_ssrc1_map,
 554             GUINT_TO_POINTER (orign_seqnum));
 555
 556         /* actually do the association between rtx stream and master stream */
 557         g_hash_table_insert (rtx->ssrc2_ssrc1_map, GUINT_TO_POINTER (ssrc2),
 558             ssrc1);
 559
 560         /* also do the association between master stream and rtx stream
 561          * every ssrc are unique so we can use the same hash table
 562          * for both retrieving the ssrc1 from ssrc2 and also ssrc2 from ssrc1
 563          */
 564         g_hash_table_insert (rtx->ssrc2_ssrc1_map, ssrc1,
 565             GUINT_TO_POINTER (ssrc2));
 566
 567       } else {
 568         /* we are not able to associate this rtx packet with a master stream */
 569         GST_DEBUG_OBJECT (rtx,
 570             "drop rtx packet because its orign_seqnum %" G_GUINT16_FORMAT
 571             " is not in pending retransmission requests", orign_seqnum);
 572         drop = TRUE;
 573       }
 574     }
 575   }
 576
 577   /* if not dropped the packet was successfully associated */
 578   if (is_rtx && !drop)
 579     ++rtx->num_rtx_assoc_packets;
 580
 581   GST_OBJECT_UNLOCK (rtx);
 582
 583   /* just drop the packet if the association could not have been made */
 584   if (drop) {
 585     gst_rtp_buffer_unmap (&rtp);
 586     gst_buffer_unref (buffer);
 587     return GST_FLOW_OK;
 588   }
 589
 590   /* create the retransmission packet */
 591   if (is_rtx)
 592     new_buffer =
 593         _gst_rtp_buffer_new_from_rtx (&rtp, GPOINTER_TO_UINT (ssrc1),
 594         orign_seqnum, origin_payload_type);
 595
 596   gst_rtp_buffer_unmap (&rtp);
 597
 598   /* push the packet */
 599   if (is_rtx) {
 600     gst_buffer_unref (buffer);
 601     GST_LOG_OBJECT (rtx, "push packet seqnum:%" G_GUINT16_FORMAT
 602         " from a restransmission stream ssrc2:%" G_GUINT32_FORMAT " (src %"
 603         G_GUINT32_FORMAT ")", orign_seqnum, ssrc2, GPOINTER_TO_UINT (ssrc1));
 604     ret = gst_pad_push (rtx->srcpad, new_buffer);
 605   } else {
 606     GST_LOG_OBJECT (rtx, "push packet seqnum:%" G_GUINT16_FORMAT
 607         " from a master stream ssrc: %" G_GUINT32_FORMAT, seqnum, ssrc);
 608     ret = gst_pad_push (rtx->srcpad, buffer);
 609   }
 610
 611   return ret;
 612 }
 613
 614 static void
 615 gst_rtp_rtx_receive_get_property (GObject * object,
 616     guint prop_id, GValue * value, GParamSpec * pspec)
 617 {
 618   GstRtpRtxReceive *rtx = GST_RTP_RTX_RECEIVE (object);
 619
 620   switch (prop_id) {
 621     case PROP_PAYLOAD_TYPE_MAP:
 622       GST_OBJECT_LOCK (rtx);
 623       g_value_set_boxed (value, rtx->rtx_pt_map_structure);
 624       GST_OBJECT_UNLOCK (rtx);
 625       break;
 626     case PROP_NUM_RTX_REQUESTS:
 627       GST_OBJECT_LOCK (rtx);
 628       g_value_set_uint (value, rtx->num_rtx_requests);
 629       GST_OBJECT_UNLOCK (rtx);
 630       break;
 631     case PROP_NUM_RTX_PACKETS:
 632       GST_OBJECT_LOCK (rtx);
 633       g_value_set_uint (value, rtx->num_rtx_packets);
 634       GST_OBJECT_UNLOCK (rtx);
 635       break;
 636     case PROP_NUM_RTX_ASSOC_PACKETS:
 637       GST_OBJECT_LOCK (rtx);
 638       g_value_set_uint (value, rtx->num_rtx_assoc_packets);
 639       GST_OBJECT_UNLOCK (rtx);
 640       break;
 641     default:
 642       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 643       break;
 644   }
 645 }
 646
 647 static gboolean
 648 structure_to_hash_table_inv (GQuark field_id, const GValue * value,
 649     gpointer hash)
 650 {
 651   const gchar *field_str;
 652   guint field_uint;
 653   guint value_uint;
 654
 655   field_str = g_quark_to_string (field_id);
 656   field_uint = atoi (field_str);
 657   value_uint = g_value_get_uint (value);
 658   g_hash_table_insert ((GHashTable *) hash, GUINT_TO_POINTER (value_uint),
 659       GUINT_TO_POINTER (field_uint));
 660
 661   return TRUE;
 662 }
 663
 664 static void
 665 gst_rtp_rtx_receive_set_property (GObject * object,
 666     guint prop_id, const GValue * value, GParamSpec * pspec)
 667 {
 668   GstRtpRtxReceive *rtx = GST_RTP_RTX_RECEIVE (object);
 669
 670   switch (prop_id) {
 671     case PROP_PAYLOAD_TYPE_MAP:
 672       GST_OBJECT_LOCK (rtx);
 673       if (rtx->rtx_pt_map_structure)
 674         gst_structure_free (rtx->rtx_pt_map_structure);
 675       rtx->rtx_pt_map_structure = g_value_dup_boxed (value);
 676       g_hash_table_remove_all (rtx->rtx_pt_map);
 677       gst_structure_foreach (rtx->rtx_pt_map_structure,
 678           structure_to_hash_table_inv, rtx->rtx_pt_map);
 679       GST_OBJECT_UNLOCK (rtx);
 680       break;
 681     default:
 682       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 683       break;
 684   }
 685 }
 686
 687 static GstStateChangeReturn
 688 gst_rtp_rtx_receive_change_state (GstElement * element,
 689     GstStateChange transition)
 690 {
 691   GstStateChangeReturn ret;
 692   GstRtpRtxReceive *rtx;
 693
 694   rtx = GST_RTP_RTX_RECEIVE (element);
 695
 696   switch (transition) {
 697     default:
 698       break;
 699   }
 700
 701   ret =
 702       GST_ELEMENT_CLASS (gst_rtp_rtx_receive_parent_class)->change_state
 703       (element, transition);
 704
 705   switch (transition) {
 706     case GST_STATE_CHANGE_PAUSED_TO_READY:
 707       gst_rtp_rtx_receive_reset (rtx);
 708       break;
 709     default:
 710       break;
 711   }
 712
 713   return ret;
 714 }
 715
 716 gboolean
 717 gst_rtp_rtx_receive_plugin_init (GstPlugin * plugin)
 718 {
 719   GST_DEBUG_CATEGORY_INIT (gst_rtp_rtx_receive_debug, "rtprtxreceive", 0,
 720       "rtp retransmission receiver");
 721
 722   return gst_element_register (plugin, "rtprtxreceive", GST_RANK_NONE,
 723       GST_TYPE_RTP_RTX_RECEIVE);
 724 }