rtprtxsend: change the rtx_pt_map directly in set_property() instead of delaying...
[platform/upstream/gst-plugins-good.git] / 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->rtx_pt_map_structure)
226     gst_structure_free (rtx->rtx_pt_map_structure);
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
263   rtx->max_size_time = DEFAULT_MAX_SIZE_TIME;
264   rtx->max_size_packets = DEFAULT_MAX_SIZE_PACKETS;
265 }
266
267 static guint32
268 gst_rtp_rtx_send_choose_ssrc (GstRtpRtxSend * rtx, guint32 choice,
269     gboolean consider_choice)
270 {
271   guint32 ssrc = consider_choice ? choice : g_random_int ();
272
273   /* make sure to be different than any other */
274   while (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc)) ||
275       g_hash_table_contains (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc))) {
276     ssrc = g_random_int ();
277   }
278
279   return ssrc;
280 }
281
282 static SSRCRtxData *
283 gst_rtp_rtx_send_get_ssrc_data (GstRtpRtxSend * rtx, guint32 ssrc)
284 {
285   SSRCRtxData *data;
286   guint32 rtx_ssrc;
287   gboolean consider = FALSE;
288
289   if (G_UNLIKELY (!g_hash_table_contains (rtx->ssrc_data,
290               GUINT_TO_POINTER (ssrc)))) {
291     if (rtx->external_ssrc_map) {
292       gchar *ssrc_str;
293       ssrc_str = g_strdup_printf ("%" G_GUINT32_FORMAT, ssrc);
294       consider = gst_structure_get_uint (rtx->external_ssrc_map, ssrc_str,
295           &rtx_ssrc);
296       g_free (ssrc_str);
297     }
298     rtx_ssrc = gst_rtp_rtx_send_choose_ssrc (rtx, rtx_ssrc, consider);
299     data = ssrc_rtx_data_new (rtx_ssrc);
300     g_hash_table_insert (rtx->ssrc_data, GUINT_TO_POINTER (ssrc), data);
301     g_hash_table_insert (rtx->rtx_ssrcs, GUINT_TO_POINTER (rtx_ssrc),
302         GUINT_TO_POINTER (ssrc));
303   } else {
304     data = g_hash_table_lookup (rtx->ssrc_data, GUINT_TO_POINTER (ssrc));
305   }
306   return data;
307 }
308
309 static gint
310 buffer_queue_items_cmp (BufferQueueItem * a, BufferQueueItem * b,
311     gpointer user_data)
312 {
313   /* gst_rtp_buffer_compare_seqnum returns the opposite of what we want,
314    * it returns negative when seqnum1 > seqnum2 and we want negative
315    * when b > a, i.e. a is smaller, so it comes first in the sequence */
316   return gst_rtp_buffer_compare_seqnum (b->seqnum, a->seqnum);
317 }
318
319 static gboolean
320 gst_rtp_rtx_send_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
321 {
322   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
323   gboolean res;
324
325   switch (GST_EVENT_TYPE (event)) {
326     case GST_EVENT_CUSTOM_UPSTREAM:
327     {
328       const GstStructure *s = gst_event_get_structure (event);
329
330       /* This event usually comes from the downstream gstrtpsession */
331       if (gst_structure_has_name (s, "GstRTPRetransmissionRequest")) {
332         guint seqnum = 0;
333         guint ssrc = 0;
334
335         /* retrieve seqnum of the packet that need to be restransmisted */
336         if (!gst_structure_get_uint (s, "seqnum", &seqnum))
337           seqnum = -1;
338
339         /* retrieve ssrc of the packet that need to be restransmisted */
340         if (!gst_structure_get_uint (s, "ssrc", &ssrc))
341           ssrc = -1;
342
343         GST_DEBUG_OBJECT (rtx,
344             "request seqnum: %" G_GUINT32_FORMAT ", ssrc: %" G_GUINT32_FORMAT,
345             seqnum, ssrc);
346
347         GST_OBJECT_LOCK (rtx);
348         /* check if request is for us */
349         if (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc))) {
350           SSRCRtxData *data;
351           GSequenceIter *iter;
352           BufferQueueItem search_item;
353
354           /* update statistics */
355           ++rtx->num_rtx_requests;
356
357           data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
358
359           search_item.seqnum = seqnum;
360           iter = g_sequence_lookup (data->queue, &search_item,
361               (GCompareDataFunc) buffer_queue_items_cmp, NULL);
362           if (iter) {
363             BufferQueueItem *item = g_sequence_get (iter);
364             GST_DEBUG_OBJECT (rtx, "found %" G_GUINT16_FORMAT, item->seqnum);
365             g_queue_push_tail (rtx->pending, gst_buffer_ref (item->buffer));
366           }
367         }
368         GST_OBJECT_UNLOCK (rtx);
369
370         gst_event_unref (event);
371         res = TRUE;
372
373         /* This event usually comes from the downstream gstrtpsession */
374       } else if (gst_structure_has_name (s, "GstRTPCollision")) {
375         guint ssrc = 0;
376
377         if (!gst_structure_get_uint (s, "ssrc", &ssrc))
378           ssrc = -1;
379
380         GST_DEBUG_OBJECT (rtx, "collision ssrc: %" G_GUINT32_FORMAT, ssrc);
381
382         GST_OBJECT_LOCK (rtx);
383
384         /* choose another ssrc for our retransmited stream */
385         if (g_hash_table_contains (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc))) {
386           guint master_ssrc;
387           SSRCRtxData *data;
388
389           master_ssrc = GPOINTER_TO_UINT (g_hash_table_lookup (rtx->rtx_ssrcs,
390                   GUINT_TO_POINTER (ssrc)));
391           data = gst_rtp_rtx_send_get_ssrc_data (rtx, master_ssrc);
392
393           /* change rtx_ssrc and update the reverse map */
394           data->rtx_ssrc = gst_rtp_rtx_send_choose_ssrc (rtx, 0, FALSE);
395           g_hash_table_remove (rtx->rtx_ssrcs, GUINT_TO_POINTER (ssrc));
396           g_hash_table_insert (rtx->rtx_ssrcs,
397               GUINT_TO_POINTER (data->rtx_ssrc),
398               GUINT_TO_POINTER (master_ssrc));
399
400           GST_OBJECT_UNLOCK (rtx);
401
402           /* no need to forward to payloader because we make sure to have
403            * a different ssrc
404            */
405           gst_event_unref (event);
406           res = TRUE;
407         } else {
408           /* if master ssrc has collided, remove it from our data, as it
409            * is not going to be used any longer */
410           if (g_hash_table_contains (rtx->ssrc_data, GUINT_TO_POINTER (ssrc))) {
411             SSRCRtxData *data;
412             data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
413             g_hash_table_remove (rtx->rtx_ssrcs,
414                 GUINT_TO_POINTER (data->rtx_ssrc));
415             g_hash_table_remove (rtx->ssrc_data, GUINT_TO_POINTER (ssrc));
416           }
417
418           GST_OBJECT_UNLOCK (rtx);
419
420           /* forward event to payloader in case collided ssrc is
421            * master stream */
422           res = gst_pad_event_default (pad, parent, event);
423         }
424       } else {
425         res = gst_pad_event_default (pad, parent, event);
426       }
427       break;
428     }
429     default:
430       res = gst_pad_event_default (pad, parent, event);
431       break;
432   }
433   return res;
434 }
435
436 static gboolean
437 gst_rtp_rtx_send_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
438 {
439   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
440
441   switch (GST_EVENT_TYPE (event)) {
442     case GST_EVENT_CAPS:
443     {
444       GstCaps *caps;
445       GstStructure *s;
446       guint ssrc;
447       SSRCRtxData *data;
448
449       gst_event_parse_caps (event, &caps);
450       g_assert (gst_caps_is_fixed (caps));
451
452       s = gst_caps_get_structure (caps, 0);
453       gst_structure_get_uint (s, "ssrc", &ssrc);
454       data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
455       gst_structure_get_int (s, "clock-rate", &data->clock_rate);
456
457       GST_DEBUG_OBJECT (rtx, "got clock-rate from caps: %d for ssrc: %u",
458           data->clock_rate, ssrc);
459
460       break;
461     }
462     default:
463       break;
464   }
465   return gst_pad_event_default (pad, parent, event);
466 }
467
468 /* like rtp_jitter_buffer_get_ts_diff() */
469 static guint32
470 gst_rtp_rtx_send_get_ts_diff (SSRCRtxData * data)
471 {
472   guint64 high_ts, low_ts;
473   BufferQueueItem *high_buf, *low_buf;
474   guint32 result;
475
476   high_buf =
477       g_sequence_get (g_sequence_iter_prev (g_sequence_get_end_iter
478           (data->queue)));
479   low_buf = g_sequence_get (g_sequence_get_begin_iter (data->queue));
480
481   if (!high_buf || !low_buf || high_buf == low_buf)
482     return 0;
483
484   high_ts = high_buf->timestamp;
485   low_ts = low_buf->timestamp;
486
487   /* it needs to work if ts wraps */
488   if (high_ts >= low_ts) {
489     result = (guint32) (high_ts - low_ts);
490   } else {
491     result = (guint32) (high_ts + G_MAXUINT32 + 1 - low_ts);
492   }
493
494   /* return value in ms instead of clock ticks */
495   return (guint32) gst_util_uint64_scale_int (result, 1000, data->clock_rate);
496 }
497
498 /* Copy fixed header and extension. Add OSN before to copy payload
499  * Copy memory to avoid to manually copy each rtp buffer field.
500  */
501 static GstBuffer *
502 _gst_rtp_rtx_buffer_new (GstRtpRtxSend * rtx, GstBuffer * buffer)
503 {
504   GstMemory *mem = NULL;
505   GstRTPBuffer rtp = GST_RTP_BUFFER_INIT;
506   GstRTPBuffer new_rtp = GST_RTP_BUFFER_INIT;
507   GstBuffer *new_buffer = gst_buffer_new ();
508   GstMapInfo map;
509   guint payload_len = 0;
510   SSRCRtxData *data;
511   guint32 ssrc;
512   guint16 seqnum;
513   guint8 fmtp;
514
515   gst_rtp_buffer_map (buffer, GST_MAP_READ, &rtp);
516
517   /* get needed data from GstRtpRtxSend */
518   ssrc = gst_rtp_buffer_get_ssrc (&rtp);
519   data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
520   ssrc = data->rtx_ssrc;
521   seqnum = data->next_seqnum++;
522   fmtp = GPOINTER_TO_UINT (g_hash_table_lookup (rtx->rtx_pt_map,
523           GUINT_TO_POINTER (gst_rtp_buffer_get_payload_type (&rtp))));
524
525   GST_DEBUG_OBJECT (rtx,
526       "retransmit seqnum: %" G_GUINT16_FORMAT ", ssrc: %" G_GUINT32_FORMAT,
527       seqnum, ssrc);
528
529   /* gst_rtp_buffer_map does not map the payload so do it now */
530   gst_rtp_buffer_get_payload (&rtp);
531
532   /* If payload type is not set through SDP/property then
533    * just bump the value */
534   if (fmtp < 96)
535     fmtp = gst_rtp_buffer_get_payload_type (&rtp) + 1;
536
537   /* copy fixed header */
538   mem = gst_memory_copy (rtp.map[0].memory, 0, rtp.size[0]);
539   gst_buffer_append_memory (new_buffer, mem);
540
541   /* copy extension if any */
542   if (rtp.size[1]) {
543     mem = gst_memory_copy (rtp.map[1].memory, 0, rtp.size[1]);
544     gst_buffer_append_memory (new_buffer, mem);
545   }
546
547   /* copy payload and add OSN just before */
548   payload_len = 2 + rtp.size[2];
549   mem = gst_allocator_alloc (NULL, payload_len, NULL);
550
551   gst_memory_map (mem, &map, GST_MAP_WRITE);
552   GST_WRITE_UINT16_BE (map.data, gst_rtp_buffer_get_seq (&rtp));
553   if (rtp.size[2])
554     memcpy (map.data + 2, rtp.data[2], rtp.size[2]);
555   gst_memory_unmap (mem, &map);
556   gst_buffer_append_memory (new_buffer, mem);
557
558   /* everything needed is copied */
559   gst_rtp_buffer_unmap (&rtp);
560
561   /* set ssrc, seqnum and fmtp */
562   gst_rtp_buffer_map (new_buffer, GST_MAP_WRITE, &new_rtp);
563   gst_rtp_buffer_set_ssrc (&new_rtp, ssrc);
564   gst_rtp_buffer_set_seq (&new_rtp, seqnum);
565   gst_rtp_buffer_set_payload_type (&new_rtp, fmtp);
566   /* RFC 4588: let other elements do the padding, as normal */
567   gst_rtp_buffer_set_padding (&new_rtp, FALSE);
568   gst_rtp_buffer_unmap (&new_rtp);
569
570   return new_buffer;
571 }
572
573 /* push pending retransmission packet.
574  * it constructs rtx packet from original packets */
575 static void
576 do_push (GstBuffer * buffer, GstRtpRtxSend * rtx)
577 {
578   gst_pad_push (rtx->srcpad, _gst_rtp_rtx_buffer_new (rtx, buffer));
579 }
580
581 static GstFlowReturn
582 gst_rtp_rtx_send_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
583 {
584   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (parent);
585   GstFlowReturn ret = GST_FLOW_ERROR;
586   GQueue *pending = NULL;
587   GstRTPBuffer rtp = GST_RTP_BUFFER_INIT;
588   BufferQueueItem *item;
589   SSRCRtxData *data;
590   guint16 seqnum;
591   guint8 payload_type;
592   guint32 ssrc, rtptime;
593
594   /* read the information we want from the buffer */
595   gst_rtp_buffer_map (buffer, GST_MAP_READ, &rtp);
596   seqnum = gst_rtp_buffer_get_seq (&rtp);
597   payload_type = gst_rtp_buffer_get_payload_type (&rtp);
598   ssrc = gst_rtp_buffer_get_ssrc (&rtp);
599   rtptime = gst_rtp_buffer_get_timestamp (&rtp);
600   gst_rtp_buffer_unmap (&rtp);
601
602   GST_OBJECT_LOCK (rtx);
603
604   /* do not store the buffer if it's payload type is unknown */
605   if (g_hash_table_contains (rtx->rtx_pt_map, GUINT_TO_POINTER (payload_type))) {
606     data = gst_rtp_rtx_send_get_ssrc_data (rtx, ssrc);
607
608     /* add current rtp buffer to queue history */
609     item = g_new0 (BufferQueueItem, 1);
610     item->seqnum = seqnum;
611     item->timestamp = rtptime;
612     item->buffer = gst_buffer_ref (buffer);
613     g_sequence_append (data->queue, item);
614
615     /* remove oldest packets from history if they are too many */
616     if (rtx->max_size_packets) {
617       while (g_sequence_get_length (data->queue) > rtx->max_size_packets)
618         g_sequence_remove (g_sequence_get_begin_iter (data->queue));
619     }
620     if (rtx->max_size_time) {
621       while (gst_rtp_rtx_send_get_ts_diff (data) > rtx->max_size_time)
622         g_sequence_remove (g_sequence_get_begin_iter (data->queue));
623     }
624   }
625
626   /* within lock, get packets that have to be retransmited */
627   if (g_queue_get_length (rtx->pending) > 0) {
628     pending = rtx->pending;
629     rtx->pending = g_queue_new ();
630
631     /* update statistics - assume we will succeed to retransmit those packets */
632     rtx->num_rtx_packets += g_queue_get_length (pending);
633   }
634
635   /* no need to hold the lock to push rtx packets */
636   GST_OBJECT_UNLOCK (rtx);
637
638   /* retransmit requested packets */
639   if (pending) {
640     g_queue_foreach (pending, (GFunc) do_push, rtx);
641     g_queue_free_full (pending, (GDestroyNotify) gst_buffer_unref);
642   }
643
644   GST_LOG_OBJECT (rtx,
645       "push seqnum: %" G_GUINT16_FORMAT ", ssrc: %" G_GUINT32_FORMAT, seqnum,
646       ssrc);
647
648   /* push current rtp packet */
649   ret = gst_pad_push (rtx->srcpad, buffer);
650
651   return ret;
652 }
653
654 static void
655 gst_rtp_rtx_send_get_property (GObject * object,
656     guint prop_id, GValue * value, GParamSpec * pspec)
657 {
658   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (object);
659
660   switch (prop_id) {
661     case PROP_PAYLOAD_TYPE_MAP:
662       GST_OBJECT_LOCK (rtx);
663       g_value_set_boxed (value, rtx->rtx_pt_map_structure);
664       GST_OBJECT_UNLOCK (rtx);
665       break;
666     case PROP_MAX_SIZE_TIME:
667       GST_OBJECT_LOCK (rtx);
668       g_value_set_uint (value, rtx->max_size_time);
669       GST_OBJECT_UNLOCK (rtx);
670       break;
671     case PROP_MAX_SIZE_PACKETS:
672       GST_OBJECT_LOCK (rtx);
673       g_value_set_uint (value, rtx->max_size_packets);
674       GST_OBJECT_UNLOCK (rtx);
675       break;
676     case PROP_NUM_RTX_REQUESTS:
677       GST_OBJECT_LOCK (rtx);
678       g_value_set_uint (value, rtx->num_rtx_requests);
679       GST_OBJECT_UNLOCK (rtx);
680       break;
681     case PROP_NUM_RTX_PACKETS:
682       GST_OBJECT_LOCK (rtx);
683       g_value_set_uint (value, rtx->num_rtx_packets);
684       GST_OBJECT_UNLOCK (rtx);
685       break;
686     default:
687       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
688       break;
689   }
690 }
691
692 static gboolean
693 structure_to_hash_table (GQuark field_id, const GValue * value, gpointer hash)
694 {
695   const gchar *field_str;
696   guint field_uint;
697   guint value_uint;
698
699   field_str = g_quark_to_string (field_id);
700   field_uint = atoi (field_str);
701   value_uint = g_value_get_uint (value);
702   g_hash_table_insert ((GHashTable *) hash, GUINT_TO_POINTER (field_uint),
703       GUINT_TO_POINTER (value_uint));
704
705   return TRUE;
706 }
707
708 static void
709 gst_rtp_rtx_send_set_property (GObject * object,
710     guint prop_id, const GValue * value, GParamSpec * pspec)
711 {
712   GstRtpRtxSend *rtx = GST_RTP_RTX_SEND (object);
713
714   switch (prop_id) {
715     case PROP_SSRC_MAP:
716       GST_OBJECT_LOCK (rtx);
717       if (rtx->external_ssrc_map)
718         gst_structure_free (rtx->external_ssrc_map);
719       rtx->external_ssrc_map = g_value_dup_boxed (value);
720       GST_OBJECT_UNLOCK (rtx);
721       break;
722     case PROP_PAYLOAD_TYPE_MAP:
723       GST_OBJECT_LOCK (rtx);
724       if (rtx->rtx_pt_map_structure)
725         gst_structure_free (rtx->rtx_pt_map_structure);
726       rtx->rtx_pt_map_structure = g_value_dup_boxed (value);
727       g_hash_table_remove_all (rtx->rtx_pt_map);
728       gst_structure_foreach (rtx->rtx_pt_map_structure, structure_to_hash_table,
729           rtx->rtx_pt_map);
730       GST_OBJECT_UNLOCK (rtx);
731       break;
732     case PROP_MAX_SIZE_TIME:
733       GST_OBJECT_LOCK (rtx);
734       rtx->max_size_time = g_value_get_uint (value);
735       GST_OBJECT_UNLOCK (rtx);
736       break;
737     case PROP_MAX_SIZE_PACKETS:
738       GST_OBJECT_LOCK (rtx);
739       rtx->max_size_packets = g_value_get_uint (value);
740       GST_OBJECT_UNLOCK (rtx);
741       break;
742     default:
743       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
744       break;
745   }
746 }
747
748 static GstStateChangeReturn
749 gst_rtp_rtx_send_change_state (GstElement * element, GstStateChange transition)
750 {
751   GstStateChangeReturn ret;
752   GstRtpRtxSend *rtx;
753
754   rtx = GST_RTP_RTX_SEND (element);
755
756   switch (transition) {
757     default:
758       break;
759   }
760
761   ret =
762       GST_ELEMENT_CLASS (gst_rtp_rtx_send_parent_class)->change_state (element,
763       transition);
764
765   switch (transition) {
766     case GST_STATE_CHANGE_PAUSED_TO_READY:
767       gst_rtp_rtx_send_reset (rtx, TRUE);
768       break;
769     default:
770       break;
771   }
772
773   return ret;
774 }
775
776 gboolean
777 gst_rtp_rtx_send_plugin_init (GstPlugin * plugin)
778 {
779   GST_DEBUG_CATEGORY_INIT (gst_rtp_rtx_send_debug, "rtprtxsend", 0,
780       "rtp retransmission sender");
781
782   return gst_element_register (plugin, "rtprtxsend", GST_RANK_NONE,
783       GST_TYPE_RTP_RTX_SEND);
784 }