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   PROP_LAST
  66 };
  67
  68 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
  69     GST_PAD_SRC,
  70     GST_PAD_ALWAYS,
  71     GST_STATIC_CAPS ("application/x-rtp")
  72     );
  73
  74 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
  75     GST_PAD_SINK,
  76     GST_PAD_ALWAYS,
  77     GST_STATIC_CAPS ("application/x-rtp")
  78     );
  79
  80 static gboolean gst_rtp_rtx_send_src_event (GstPad * pad, GstObject * parent,
  81     GstEvent * event);
  82 static gboolean gst_rtp_rtx_send_sink_event (GstPad * pad, GstObject * parent,
  83     GstEvent * event);
  84 static GstFlowReturn gst_rtp_rtx_send_chain (GstPad * pad, GstObject * parent,
  85     GstBuffer * buffer);
  86
  87 static GstStateChangeReturn gst_rtp_rtx_send_change_state (GstElement *
  88     element, GstStateChange transition);
  89
  90 static void gst_rtp_rtx_send_set_property (GObject * object, guint prop_id,
  91     const GValue * value, GParamSpec * pspec);
  92 static void gst_rtp_rtx_send_get_property (GObject * object, guint prop_id,
  93     GValue * value, GParamSpec * pspec);
  94 static void gst_rtp_rtx_send_finalize (GObject * object);
  95
  96 G_DEFINE_TYPE (GstRtpRtxSend, gst_rtp_rtx_send, GST_TYPE_ELEMENT);
  97
  98 typedef struct
  99 {
 100   guint16 seqnum;
 101   guint32 timestamp;
 102   GstBuffer *buffer;
 103 } BufferQueueItem;
 104
 105 static void
 106 buffer_queue_item_free (BufferQueueItem * item)
 107 {
 108   gst_buffer_unref (item->buffer);
 109   g_free (item);
 110 }
 111
 112 typedef struct
 113 {
 114   guint32 rtx_ssrc;
 115   guint16 next_seqnum;
 116   gint clock_rate;
 117
 118   /* history of rtp packets */
 119   GSequence *queue;
 120 } SSRCRtxData;
 121
 122 static SSRCRtxData *
 123 ssrc_rtx_data_new (guint32 rtx_ssrc)
 124 {
 125   SSRCRtxData *data = g_new0 (SSRCRtxData, 1);
 126
 127   data->rtx_ssrc = rtx_ssrc;
 128   data->next_seqnum = g_random_int_range (0, G_MAXUINT16);
 129   data->queue = g_sequence_new ((GDestroyNotify) buffer_queue_item_free);
 130
 131   return data;
 132 }
 133
 134 static void
 135 ssrc_rtx_data_free (SSRCRtxData * data)
 136 {
 137   g_sequence_free (data->queue);
 138   g_free (data);
 139 }
 140
 141 static void
 142 gst_rtp_rtx_send_class_init (GstRtpRtxSendClass * klass)
 143 {
 144   GObjectClass *gobject_class;
 145   GstElementClass *gstelement_class;
 146
 147   gobject_class = (GObjectClass *) klass;
 148   gstelement_class = (GstElementClass *) klass;
 149
 150   gobject_class->get_property = gst_rtp_rtx_send_get_property;
 151   gobject_class->set_property = gst_rtp_rtx_send_set_property;
 152   gobject_class->finalize = gst_rtp_rtx_send_finalize;
 153
 154   g_object_class_install_property (gobject_class, PROP_SSRC_MAP,
 155       g_param_spec_boxed ("ssrc-map", "SSRC Map",
 156           "Map of SSRCs to their retransmission SSRCs for SSRC-multiplexed mode"
 157           " (default = random)", GST_TYPE_STRUCTURE,
 158           G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
 159
 160   g_object_class_install_property (gobject_class, PROP_PAYLOAD_TYPE_MAP,
 161       g_param_spec_boxed ("payload-type-map", "Payload Type Map",
 162           "Map of original payload types to their retransmission payload types",
 163           GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 164
 165   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_TIME,
 166       g_param_spec_uint ("max-size-time", "Max Size Time",
 167           "Amount of ms to queue (0 = unlimited)", 0, G_MAXUINT,
 168           DEFAULT_MAX_SIZE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 169
 170   g_object_class_install_property (gobject_class, PROP_MAX_SIZE_PACKETS,
 171       g_param_spec_uint ("max-size-packets", "Max Size Packets",
 172           "Amount of packets to queue (0 = unlimited)", 0, G_MAXINT16,
 173           DEFAULT_MAX_SIZE_PACKETS,
 174           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 175
 176   g_object_class_install_property (gobject_class, PROP_NUM_RTX_REQUESTS,
 177       g_param_spec_uint ("num-rtx-requests", "Num RTX Requests",
 178           "Number of retransmission events received", 0, G_MAXUINT,
 179           0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 180
 181   g_object_class_install_property (gobject_class, PROP_NUM_RTX_PACKETS,
 182       g_param_spec_uint ("num-rtx-packets", "Num RTX Packets",
 183           " Number of retransmission packets sent", 0, G_MAXUINT,
 184           0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 185
 186   gst_element_class_add_pad_template (gstelement_class,
 187       gst_static_pad_template_get (&src_factory));
 188   gst_element_class_add_pad_template (gstelement_class,
 189       gst_static_pad_template_get (&sink_factory));
 190
 191   gst_element_class_set_static_metadata (gstelement_class,
 192       "RTP Retransmission Sender", "Codec",
 193       "Retransmit RTP packets when needed, according to RFC4588",
 194       "Julien Isorce <julien.isorce@collabora.co.uk>");
 195
 196   gstelement_class->change_state =
 197       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_change_state);
 198 }
 199
 200 static void
 201 gst_rtp_rtx_send_reset (GstRtpRtxSend * rtx, gboolean full)
 202 {
 203   GST_OBJECT_LOCK (rtx);
 204   g_queue_foreach (rtx->pending, (GFunc) gst_buffer_unref, NULL);
 205   g_queue_clear (rtx->pending);
 206   g_hash_table_remove_all (rtx->ssrc_data);
 207   g_hash_table_remove_all (rtx->rtx_ssrcs);
 208   rtx->num_rtx_requests = 0;
 209   rtx->num_rtx_packets = 0;
 210   GST_OBJECT_UNLOCK (rtx);
 211 }
 212
 213 static void
 214 gst_rtp_rtx_send_finalize (GObject * object)
 215 {
 216   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (object);
 217
 218   gst_rtp_rtx_send_reset (rtx, TRUE);
 219
 220   g_hash_table_unref (rtx->ssrc_data);
 221   g_hash_table_unref (rtx->rtx_ssrcs);
 222   if (rtx->external_ssrc_map)
 223     gst_structure_free (rtx->external_ssrc_map);
 224   g_hash_table_unref (rtx->rtx_pt_map);
 225   if (rtx->pending_rtx_pt_map)
 226     gst_structure_free (rtx->pending_rtx_pt_map);
 227   g_queue_free (rtx->pending);
 228
 229   G_OBJECT_CLASS (gst_rtp_rtx_send_parent_class)->finalize (object);
 230 }
 231
 232 static void
 233 gst_rtp_rtx_send_init (GstRtpRtxSend * rtx)
 234 {
 235   GstElementClass *klass = GST_ELEMENT_GET_CLASS (rtx);
 236
 237   rtx->srcpad =
 238       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 239           "src"), "src");
 240   GST_PAD_SET_PROXY_CAPS (rtx->srcpad);
 241   GST_PAD_SET_PROXY_ALLOCATION (rtx->srcpad);
 242   gst_pad_set_event_function (rtx->srcpad,
 243       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_src_event));
 244   gst_element_add_pad (GST_ELEMENT (rtx), rtx->srcpad);
 245
 246   rtx->sinkpad =
 247       gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
 248           "sink"), "sink");
 249   GST_PAD_SET_PROXY_CAPS (rtx->sinkpad);
 250   GST_PAD_SET_PROXY_ALLOCATION (rtx->sinkpad);
 251   gst_pad_set_event_function (rtx->sinkpad,
 252       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_sink_event));
 253   gst_pad_set_chain_function (rtx->sinkpad,
 254       GST_DEBUG_FUNCPTR (gst_rtp_rtx_send_chain));
 255   gst_element_add_pad (GST_ELEMENT (rtx), rtx->sinkpad);
 256
 257   rtx->pending = g_queue_new ();
 258   rtx->ssrc_data = g_hash_table_new_full (g_direct_hash, g_direct_equal,
 259       NULL, (GDestroyNotify) ssrc_rtx_data_free);
 260   rtx->rtx_ssrcs = g_hash_table_new (g_direct_hash, g_direct_equal);
 261   rtx->rtx_pt_map = g_hash_table_new (g_direct_hash, g_direct_equal);
 262   rtx->rtx_pt_map_changed = FALSE;
 263
 264   rtx->max_size_time = DEFAULT_MAX_SIZE_TIME;
 265   rtx->max_size_packets = DEFAULT_MAX_SIZE_PACKETS;
 266 }
 267
 268 static guint32
 269 gst_rtp_rtx_send_choose_ssrc (GstRtpRtxSend * rtx, guint32 choice,
 270     gboolean consider_choice)
 271 {
 272   guint32 ssrc = consider_choice ? choice : g_random_int ();
 273
 274   /* make sure to be different than any other */
 275   while (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc)) ||
 276       g_hash_table_contains (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc))) {
 277     ssrc = g_random_int ();
 278   }
 279
 280   return ssrc;
 281 }
 282
 283 static SSRCRtxData *
 284 gst_rtp_rtx_send_get_ssrc_data (GstRtpRtxSend * rtx, guint32 ssrc)
 285 {
 286   SSRCRtxData *data;
 287   guint32 rtx_ssrc;
 288   gboolean consider = FALSE;
 289
 290   if (G_UNLIKELY (!g_hash_table_contains (rtx->ssrc_data,
 291               GUINT_TO_POINTER (ssrc)))) {
 292     if (rtx->external_ssrc_map) {
 293       gchar *ssrc_str;
 294       ssrc_str = g_strdup_printf ("%" G_GUINT32_FORMAT, ssrc);
 295       consider = gst_structure_get_uint (rtx->external_ssrc_map, ssrc_str,
 296           &rtx_ssrc);
 297       g_free (ssrc_str);
 298     }
 299     rtx_ssrc = gst_rtp_rtx_send_choose_ssrc (rtx, rtx_ssrc, consider);
 300     data = ssrc_rtx_data_new (rtx_ssrc);
 301     g_hash_table_insert (rtx->ssrc_data, GUINT_TO_POINTER (ssrc), data);
 302     g_hash_table_insert (rtx->rtx_ssrcs, GUINT_TO_POINTER (rtx_ssrc),
 303         GUINT_TO_POINTER (ssrc));
 304   } else {
 305     data = g_hash_table_lookup (rtx->ssrc_data, GUINT_TO_POINTER (ssrc));
 306   }
 307   return data;
 308 }
 309
 310 static gint
 311 buffer_queue_items_cmp (BufferQueueItem * a, BufferQueueItem * b,
 312     gpointer user_data)
 313 {
 314   /* gst_rtp_buffer_compare_seqnum returns the opposite of what we want,
 315    * it returns negative when seqnum1 > seqnum2 and we want negative
 316    * when b > a, i.e. a is smaller, so it comes first in the sequence */
 317   return gst_rtp_buffer_compare_seqnum (b->seqnum, a->seqnum);
 318 }
 319
 320 static gboolean
 321 gst_rtp_rtx_send_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
 322 {
 323   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
 324   gboolean res;
 325
 326   switch (GST_EVENT_TYPE (event)) {
 327     case GST_EVENT_CUSTOM_UPSTREAM:
 328     {
 329       const GstStructure *s = gst_event_get_structure (event);
 330
 331       /* This event usually comes from the downstream gstrtpsession */
 332       if (gst_structure_has_name (s, "GstRTPRetransmissionRequest")) {
 333         guint seqnum = 0;
 334         guint ssrc = 0;
 335
 336         /* retrieve seqnum of the packet that need to be restransmisted */
 337         if (!gst_structure_get_uint (s, "seqnum", &seqnum))
 338           seqnum = -1;
 339
 340         /* retrieve ssrc of the packet that need to be restransmisted */
 341         if (!gst_structure_get_uint (s, "ssrc", &ssrc))
 342           ssrc = -1;
 343
 344         GST_DEBUG_OBJECT (rtx,
 345             "request seqnum: %" G_GUINT32_FORMAT ", ssrc: %" G_GUINT32_FORMAT,
 346             seqnum, ssrc);
 347
 348         GST_OBJECT_LOCK (rtx);
 349         /* check if request is for us */
 350         if (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc))) {
 351           SSRCRtxData *data;
 352           GSequenceIter *iter;
 353           BufferQueueItem search_item;
 354
 355           /* update statistics */
 356           ++rtx->num_rtx_requests;
 357
 358           data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 359
 360           search_item.seqnum = seqnum;
 361           iter = g_sequence_lookup (data->queue, &search_item,
 362               (GCompareDataFunc) buffer_queue_items_cmp, NULL);
 363           if (iter) {
 364             BufferQueueItem *item = g_sequence_get (iter);
 365             GST_DEBUG_OBJECT (rtx, "found %" G_GUINT16_FORMAT, item->seqnum);
 366             g_queue_push_tail (rtx->pending, gst_buffer_ref (item->buffer));
 367           }
 368         }
 369         GST_OBJECT_UNLOCK (rtx);
 370
 371         gst_event_unref (event);
 372         res = TRUE;
 373
 374         /* This event usually comes from the downstream gstrtpsession */
 375       } else if (gst_structure_has_name (s, "GstRTPCollision")) {
 376         guint ssrc = 0;
 377
 378         if (!gst_structure_get_uint (s, "ssrc", &ssrc))
 379           ssrc = -1;
 380
 381         GST_DEBUG_OBJECT (rtx, "collision ssrc: %" G_GUINT32_FORMAT, ssrc);
 382
 383         GST_OBJECT_LOCK (rtx);
 384
 385         /* choose another ssrc for our retransmited stream */
 386         if (g_hash_table_contains (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc))) {
 387           guint master_ssrc;
 388           SSRCRtxData *data;
 389
 390           master_ssrc = GPOINTER_TO_UINT (g_hash_table_lookup (rtx->rtx_ssrcs,
 391                   GUINT_TO_POINTER (ssrc)));
 392           data = gst_rtp_rtx_send_get_ssrc_data (rtx, master_ssrc);
 393
 394           /* change rtx_ssrc and update the reverse map */
 395           data->rtx_ssrc = gst_rtp_rtx_send_choose_ssrc (rtx, 0, FALSE);
 396           g_hash_table_remove (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc));
 397           g_hash_table_insert (rtx->rtx_ssrcs,
 398               GUINT_TO_POINTER (data->rtx_ssrc),
 399               GUINT_TO_POINTER (master_ssrc));
 400
 401           GST_OBJECT_UNLOCK (rtx);
 402
 403           /* no need to forward to payloader because we make sure to have
 404            * a different ssrc
 405            */
 406           gst_event_unref (event);
 407           res = TRUE;
 408         } else {
 409           /* if master ssrc has collided, remove it from our data, as it
 410            * is not going to be used any longer */
 411           if (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc))) {
 412             SSRCRtxData *data;
 413             data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 414             g_hash_table_remove (rtx->rtx_ssrcs,
 415                 GUINT_TO_POINTER (data->rtx_ssrc));
 416             g_hash_table_remove (rtx->ssrc_data, GUINT_TO_POINTER (ssrc));
 417           }
 418
 419           GST_OBJECT_UNLOCK (rtx);
 420
 421           /* forward event to payloader in case collided ssrc is
 422            * master stream */
 423           res = gst_pad_event_default (pad, parent, event);
 424         }
 425       } else {
 426         res = gst_pad_event_default (pad, parent, event);
 427       }
 428       break;
 429     }
 430     default:
 431       res = gst_pad_event_default (pad, parent, event);
 432       break;
 433   }
 434   return res;
 435 }
 436
 437 static gboolean
 438 gst_rtp_rtx_send_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 439 {
 440   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
 441
 442   switch (GST_EVENT_TYPE (event)) {
 443     case GST_EVENT_CAPS:
 444     {
 445       GstCaps *caps;
 446       GstStructure *s;
 447       guint ssrc;
 448       SSRCRtxData *data;
 449
 450       gst_event_parse_caps (event, &caps);
 451       g_assert (gst_caps_is_fixed (caps));
 452
 453       s = gst_caps_get_structure (caps, 0);
 454       gst_structure_get_uint (s, "ssrc", &ssrc);
 455       data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 456       gst_structure_get_int (s, "clock-rate", &data->clock_rate);
 457
 458       GST_DEBUG_OBJECT (rtx, "got clock-rate from caps: %d for ssrc: %u",
 459           data->clock_rate, ssrc);
 460
 461       break;
 462     }
 463     default:
 464       break;
 465   }
 466   return gst_pad_event_default (pad, parent, event);
 467 }
 468
 469 static gboolean
 470 structure_to_hash_table (GQuark field_id, const GValue * value, gpointer hash)
 471 {
 472   const gchar *field_str;
 473   guint field_uint;
 474   guint value_uint;
 475
 476   field_str = g_quark_to_string (field_id);
 477   field_uint = atoi (field_str);
 478   value_uint = g_value_get_uint (value);
 479   g_hash_table_insert ((GHashTable *) hash, GUINT_TO_POINTER (field_uint),
 480       GUINT_TO_POINTER (value_uint));
 481
 482   return TRUE;
 483 }
 484
 485 /* like rtp_jitter_buffer_get_ts_diff() */
 486 static guint32
 487 gst_rtp_rtx_send_get_ts_diff (SSRCRtxData * data)
 488 {
 489   guint64 high_ts, low_ts;
 490   BufferQueueItem *high_buf, *low_buf;
 491   guint32 result;
 492
 493   high_buf =
 494       g_sequence_get (g_sequence_iter_prev (g_sequence_get_end_iter
 495           (data->queue)));
 496   low_buf = g_sequence_get (g_sequence_get_begin_iter (data->queue));
 497
 498   if (!high_buf || !low_buf || high_buf == low_buf)
 499     return 0;
 500
 501   high_ts = high_buf->timestamp;
 502   low_ts = low_buf->timestamp;
 503
 504   /* it needs to work if ts wraps */
 505   if (high_ts >= low_ts) {
 506     result = (guint32) (high_ts - low_ts);
 507   } else {
 508     result = (guint32) (high_ts + G_MAXUINT32 + 1 - low_ts);
 509   }
 510
 511   /* return value in ms instead of clock ticks */
 512   return (guint32) gst_util_uint64_scale_int (result, 1000, data->clock_rate);
 513 }
 514
 515 /* Copy fixed header and extension. Add OSN before to copy payload
 516  * Copy memory to avoid to manually copy each rtp buffer field.
 517  */
 518 static GstBuffer *
 519 _gst_rtp_rtx_buffer_new (GstRtpRtxSend * rtx, GstBuffer * buffer)
 520 {
 521   GstMemory *mem = NULL;
 522   GstRTPBuffer rtp = GST_RTP_BUFFER_INIT;
 523   GstRTPBuffer new_rtp = GST_RTP_BUFFER_INIT;
 524   GstBuffer *new_buffer = gst_buffer_new ();
 525   GstMapInfo map;
 526   guint payload_len = 0;
 527   SSRCRtxData *data;
 528   guint32 ssrc;
 529   guint16 seqnum;
 530   guint8 fmtp;
 531
 532   gst_rtp_buffer_map (buffer, GST_MAP_READ, &rtp);
 533
 534   /* get needed data from GstRtpRtxSend */
 535   ssrc = gst_rtp_buffer_get_ssrc (&rtp);
 536   data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 537   ssrc = data->rtx_ssrc;
 538   seqnum = data->next_seqnum++;
 539   fmtp = GPOINTER_TO_UINT (g_hash_table_lookup (rtx->rtx_pt_map,
 540           GUINT_TO_POINTER (gst_rtp_buffer_get_payload_type (&rtp))));
 541
 542   GST_DEBUG_OBJECT (rtx,
 543       "retransmit seqnum: %" G_GUINT16_FORMAT ", ssrc: %" G_GUINT32_FORMAT,
 544       seqnum, ssrc);
 545
 546   /* gst_rtp_buffer_map does not map the payload so do it now */
 547   gst_rtp_buffer_get_payload (&rtp);
 548
 549   /* If payload type is not set through SDP/property then
 550    * just bump the value */
 551   if (fmtp < 96)
 552     fmtp = gst_rtp_buffer_get_payload_type (&rtp) + 1;
 553
 554   /* copy fixed header */
 555   mem = gst_memory_copy (rtp.map[0].memory, 0, rtp.size[0]);
 556   gst_buffer_append_memory (new_buffer, mem);
 557
 558   /* copy extension if any */
 559   if (rtp.size[1]) {
 560     mem = gst_memory_copy (rtp.map[1].memory, 0, rtp.size[1]);
 561     gst_buffer_append_memory (new_buffer, mem);
 562   }
 563
 564   /* copy payload and add OSN just before */
 565   payload_len = 2 + rtp.size[2];
 566   mem = gst_allocator_alloc (NULL, payload_len, NULL);
 567
 568   gst_memory_map (mem, &map, GST_MAP_WRITE);
 569   GST_WRITE_UINT16_BE (map.data, gst_rtp_buffer_get_seq (&rtp));
 570   if (rtp.size[2])
 571     memcpy (map.data + 2, rtp.data[2], rtp.size[2]);
 572   gst_memory_unmap (mem, &map);
 573   gst_buffer_append_memory (new_buffer, mem);
 574
 575   /* everything needed is copied */
 576   gst_rtp_buffer_unmap (&rtp);
 577
 578   /* set ssrc, seqnum and fmtp */
 579   gst_rtp_buffer_map (new_buffer, GST_MAP_WRITE, &new_rtp);
 580   gst_rtp_buffer_set_ssrc (&new_rtp, ssrc);
 581   gst_rtp_buffer_set_seq (&new_rtp, seqnum);
 582   gst_rtp_buffer_set_payload_type (&new_rtp, fmtp);
 583   /* RFC 4588: let other elements do the padding, as normal */
 584   gst_rtp_buffer_set_padding (&new_rtp, FALSE);
 585   gst_rtp_buffer_unmap (&new_rtp);
 586
 587   return new_buffer;
 588 }
 589
 590 /* push pending retransmission packet.
 591  * it constructs rtx packet from original packets */
 592 static void
 593 do_push (GstBuffer * buffer, GstRtpRtxSend * rtx)
 594 {
 595   gst_pad_push (rtx->srcpad, _gst_rtp_rtx_buffer_new (rtx, buffer));
 596 }
 597
 598 static GstFlowReturn
 599 gst_rtp_rtx_send_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 600 {
 601   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
 602   GstFlowReturn ret = GST_FLOW_ERROR;
 603   GQueue *pending = NULL;
 604   GstRTPBuffer rtp = GST_RTP_BUFFER_INIT;
 605   BufferQueueItem *item;
 606   SSRCRtxData *data;
 607   guint16 seqnum;
 608   guint8 payload_type;
 609   guint32 ssrc, rtptime;
 610
 611   /* read the information we want from the buffer */
 612   gst_rtp_buffer_map (buffer, GST_MAP_READ, &rtp);
 613   seqnum = gst_rtp_buffer_get_seq (&rtp);
 614   payload_type = gst_rtp_buffer_get_payload_type (&rtp);
 615   ssrc = gst_rtp_buffer_get_ssrc (&rtp);
 616   rtptime = gst_rtp_buffer_get_timestamp (&rtp);
 617   gst_rtp_buffer_unmap (&rtp);
 618
 619   GST_OBJECT_LOCK (rtx);
 620
 621   /* transfer payload type while holding the lock */
 622   if (rtx->rtx_pt_map_changed) {
 623     g_hash_table_remove_all (rtx->rtx_pt_map);
 624     gst_structure_foreach (rtx->pending_rtx_pt_map, structure_to_hash_table,
 625         rtx->rtx_pt_map);
 626     rtx->rtx_pt_map_changed = FALSE;
 627   }
 628
 629   /* do not store the buffer if it's payload type is unknown */
 630   if (g_hash_table_contains (rtx->rtx_pt_map, GUINT_TO_POINTER (payload_type))) {
 631     data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
 632
 633     /* add current rtp buffer to queue history */
 634     item = g_new0 (BufferQueueItem, 1);
 635     item->seqnum = seqnum;
 636     item->timestamp = rtptime;
 637     item->buffer = gst_buffer_ref (buffer);
 638     g_sequence_append (data->queue, item);
 639
 640     /* remove oldest packets from history if they are too many */
 641     if (rtx->max_size_packets) {
 642       while (g_sequence_get_length (data->queue) > rtx->max_size_packets)
 643         g_sequence_remove (g_sequence_get_begin_iter (data->queue));
 644     }
 645     if (rtx->max_size_time) {
 646       while (gst_rtp_rtx_send_get_ts_diff (data) > rtx->max_size_time)
 647         g_sequence_remove (g_sequence_get_begin_iter (data->queue));
 648     }
 649   }
 650
 651   /* within lock, get packets that have to be retransmited */
 652   if (g_queue_get_length (rtx->pending) > 0) {
 653     pending = rtx->pending;
 654     rtx->pending = g_queue_new ();
 655
 656     /* update statistics - assume we will succeed to retransmit those packets */
 657     rtx->num_rtx_packets += g_queue_get_length (pending);
 658   }
 659
 660   /* no need to hold the lock to push rtx packets */
 661   GST_OBJECT_UNLOCK (rtx);
 662
 663   /* retransmit requested packets */
 664   if (pending) {
 665     g_queue_foreach (pending, (GFunc) do_push, rtx);
 666     g_queue_free_full (pending, (GDestroyNotify) gst_buffer_unref);
 667   }
 668
 669   GST_LOG_OBJECT (rtx,
 670       "push seqnum: %" G_GUINT16_FORMAT ", ssrc: %" G_GUINT32_FORMAT, seqnum,
 671       ssrc);
 672
 673   /* push current rtp packet */
 674   ret = gst_pad_push (rtx->srcpad, buffer);
 675
 676   return ret;
 677 }
 678
 679 static void
 680 gst_rtp_rtx_send_get_property (GObject * object,
 681     guint prop_id, GValue * value, GParamSpec * pspec)
 682 {
 683   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (object);
 684
 685   switch (prop_id) {
 686     case PROP_PAYLOAD_TYPE_MAP:
 687       GST_OBJECT_LOCK (rtx);
 688       g_value_set_boxed (value, rtx->pending_rtx_pt_map);
 689       GST_OBJECT_UNLOCK (rtx);
 690       break;
 691     case PROP_MAX_SIZE_TIME:
 692       GST_OBJECT_LOCK (rtx);
 693       g_value_set_uint (value, rtx->max_size_time);
 694       GST_OBJECT_UNLOCK (rtx);
 695       break;
 696     case PROP_MAX_SIZE_PACKETS:
 697       GST_OBJECT_LOCK (rtx);
 698       g_value_set_uint (value, rtx->max_size_packets);
 699       GST_OBJECT_UNLOCK (rtx);
 700       break;
 701     case PROP_NUM_RTX_REQUESTS:
 702       GST_OBJECT_LOCK (rtx);
 703       g_value_set_uint (value, rtx->num_rtx_requests);
 704       GST_OBJECT_UNLOCK (rtx);
 705       break;
 706     case PROP_NUM_RTX_PACKETS:
 707       GST_OBJECT_LOCK (rtx);
 708       g_value_set_uint (value, rtx->num_rtx_packets);
 709       GST_OBJECT_UNLOCK (rtx);
 710       break;
 711     default:
 712       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 713       break;
 714   }
 715 }
 716
 717 static void
 718 gst_rtp_rtx_send_set_property (GObject * object,
 719     guint prop_id, const GValue * value, GParamSpec * pspec)
 720 {
 721   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (object);
 722
 723   switch (prop_id) {
 724     case PROP_SSRC_MAP:
 725       GST_OBJECT_LOCK (rtx);
 726       if (rtx->external_ssrc_map)
 727         gst_structure_free (rtx->external_ssrc_map);
 728       rtx->external_ssrc_map = g_value_dup_boxed (value);
 729       GST_OBJECT_UNLOCK (rtx);
 730       break;
 731     case PROP_PAYLOAD_TYPE_MAP:
 732       GST_OBJECT_LOCK (rtx);
 733       if (rtx->pending_rtx_pt_map)
 734         gst_structure_free (rtx->pending_rtx_pt_map);
 735       rtx->pending_rtx_pt_map = g_value_dup_boxed (value);
 736       rtx->rtx_pt_map_changed = TRUE;
 737       GST_OBJECT_UNLOCK (rtx);
 738       break;
 739     case PROP_MAX_SIZE_TIME:
 740       GST_OBJECT_LOCK (rtx);
 741       rtx->max_size_time = g_value_get_uint (value);
 742       GST_OBJECT_UNLOCK (rtx);
 743       break;
 744     case PROP_MAX_SIZE_PACKETS:
 745       GST_OBJECT_LOCK (rtx);
 746       rtx->max_size_packets = g_value_get_uint (value);
 747       GST_OBJECT_UNLOCK (rtx);
 748       break;
 749     default:
 750       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 751       break;
 752   }
 753 }
 754
 755 static GstStateChangeReturn
 756 gst_rtp_rtx_send_change_state (GstElement * element, GstStateChange transition)
 757 {
 758   GstStateChangeReturn ret;
 759   GstRtpRtxSend *rtx;
 760
 761   rtx = GST_RTP_RTX_SEND (element);
 762
 763   switch (transition) {
 764     default:
 765       break;
 766   }
 767
 768   ret =
 769       GST_ELEMENT_CLASS (gst_rtp_rtx_send_parent_class)->change_state (element,
 770       transition);
 771
 772   switch (transition) {
 773     case GST_STATE_CHANGE_PAUSED_TO_READY:
 774       gst_rtp_rtx_send_reset (rtx, TRUE);
 775       break;
 776     default:
 777       break;
 778   }
 779
 780   return ret;
 781 }
 782
 783 gboolean
 784 gst_rtp_rtx_send_plugin_init (GstPlugin * plugin)
 785 {
 786   GST_DEBUG_CATEGORY_INIT (gst_rtp_rtx_send_debug, "rtprtxsend", 0,
 787       "rtp retransmission sender");
 788
 789   return gst_element_register (plugin, "rtprtxsend", GST_RANK_NONE,
 790       GST_TYPE_RTP_RTX_SEND);
 791 }