rtxqueue: add retransmission queue element

2024-07-03 13:16:04 +00:00 · 2013-08-12 16:15:54 +02:00 · 2013-08-12 16:15:54 +02:00 · ff825a2919
parent 5fe18ee432
commit ff825a2919
4 changed files with 343 additions and 0 deletions
--- a/gst/rtpmanager/Makefile.am
+++ b/gst/rtpmanager/Makefile.am
@ -9,6 +9,7 @@ libgstrtpmanager_la_SOURCES = gstrtpmanager.c \
 			      gstrtpjitterbuffer.c \
 			      gstrtpmux.c \
 			      gstrtpptdemux.c \
+			      gstrtprtxqueue.c \
 			      gstrtpssrcdemux.c \
 			      rtpjitterbuffer.c      \
 			      rtpsession.c      \
@ -22,6 +23,7 @@ noinst_HEADERS = gstrtpbin.h \
 		 gstrtpmux.h \
                 gstrtpptdemux.h \
                 gstrtpssrcdemux.h \
+                 gstrtprtxqueue.h \
                 rtpjitterbuffer.h \
 		 rtpsession.h  \
 		 rtpsource.h  \
--- a/gst/rtpmanager/gstrtpmanager.c
+++ b/gst/rtpmanager/gstrtpmanager.c
@ -25,6 +25,7 @@
 #include "gstrtpjitterbuffer.h"
 #include "gstrtpptdemux.h"
 #include "gstrtpsession.h"
+#include "gstrtprtxqueue.h"
 #include "gstrtpssrcdemux.h"
 #include "gstrtpdtmfmux.h"
 #include "gstrtpmux.h"
@ -47,6 +48,10 @@ plugin_init (GstPlugin * plugin)
          GST_TYPE_RTP_SESSION))
    return FALSE;

+  if (!gst_element_register (plugin, "rtprtxqueue", GST_RANK_NONE,
+          GST_TYPE_RTP_RTX_QUEUE))
+    return FALSE;
+
  if (!gst_element_register (plugin, "rtpssrcdemux", GST_RANK_NONE,
          GST_TYPE_RTP_SSRC_DEMUX))
    return FALSE;
--- a/gst/rtpmanager/gstrtprtxqueue.c
+++ b/gst/rtpmanager/gstrtprtxqueue.c
@ -0,0 +1,268 @@
+/* RTP Retransmission queue element for GStreamer
+ *
+ * gstrtprtxqueue.c:
+ *
+ * Copyright (C) 2013 Wim Taymans <wim.taymans@gmail.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+/**
+ * SECTION:element-rtprtxqueue
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <gst/gst.h>
+#include <gst/rtp/gstrtpbuffer.h>
+#include <string.h>
+
+#include "gstrtprtxqueue.h"
+
+GST_DEBUG_CATEGORY_STATIC (gst_rtp_rtx_queue_debug);
+#define GST_CAT_DEFAULT gst_rtp_rtx_queue_debug
+
+enum
+{
+  PROP_0,
+  PROP_LAST
+};
+
+static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
+    GST_PAD_SRC,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS ("application/x-rtp")
+    );
+
+static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
+    GST_PAD_SINK,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS ("application/x-rtp")
+    );
+
+static gboolean gst_rtp_rtx_queue_src_event (GstPad * pad, GstObject * parent,
+    GstEvent * event);
+static GstFlowReturn gst_rtp_rtx_queue_chain (GstPad * pad, GstObject * parent,
+    GstBuffer * buffer);
+
+static GstStateChangeReturn gst_rtp_rtx_queue_change_state (GstElement *
+    element, GstStateChange transition);
+
+static void gst_rtp_rtx_queue_set_property (GObject * object, guint prop_id,
+    const GValue * value, GParamSpec * pspec);
+static void gst_rtp_rtx_queue_get_property (GObject * object, guint prop_id,
+    GValue * value, GParamSpec * pspec);
+static void gst_rtp_rtx_queue_finalize (GObject * object);
+
+G_DEFINE_TYPE (GstRTPRtxQueue, gst_rtp_rtx_queue, GST_TYPE_ELEMENT);
+
+static void
+gst_rtp_rtx_queue_class_init (GstRTPRtxQueueClass * klass)
+{
+  GObjectClass *gobject_class;
+  GstElementClass *gstelement_class;
+
+  gobject_class = (GObjectClass *) klass;
+  gstelement_class = (GstElementClass *) klass;
+
+  gst_element_class_add_pad_template (gstelement_class,
+      gst_static_pad_template_get (&src_factory));
+  gst_element_class_add_pad_template (gstelement_class,
+      gst_static_pad_template_get (&sink_factory));
+
+  gst_element_class_set_static_metadata (gstelement_class,
+      "RTP Retransmission Queue", "Codec",
+      "Keep RTP packets in a queue for retransmission",
+      "Wim Taymans <wim.taymans@gmail.com>");
+
+  gobject_class->get_property = gst_rtp_rtx_queue_get_property;
+  gobject_class->set_property = gst_rtp_rtx_queue_set_property;
+  gobject_class->finalize = gst_rtp_rtx_queue_finalize;
+
+  gstelement_class->change_state =
+      GST_DEBUG_FUNCPTR (gst_rtp_rtx_queue_change_state);
+}
+
+static void
+gst_rtp_rtx_queue_finalize (GObject * object)
+{
+  GstRTPRtxQueue *rtx = GST_RTP_RTX_QUEUE (object);
+
+  g_queue_free (rtx->queue);
+
+  G_OBJECT_CLASS (gst_rtp_rtx_queue_parent_class)->finalize (object);
+}
+
+static void
+gst_rtp_rtx_queue_init (GstRTPRtxQueue * rtx)
+{
+  GstElementClass *klass = GST_ELEMENT_GET_CLASS (rtx);
+
+  rtx->srcpad =
+      gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
+          "src"), "src");
+  GST_PAD_SET_PROXY_CAPS (rtx->srcpad);
+  GST_PAD_SET_PROXY_ALLOCATION (rtx->srcpad);
+  gst_pad_set_event_function (rtx->srcpad,
+      GST_DEBUG_FUNCPTR (gst_rtp_rtx_queue_src_event));
+  gst_element_add_pad (GST_ELEMENT (rtx), rtx->srcpad);
+
+  rtx->sinkpad =
+      gst_pad_new_from_template (gst_element_class_get_pad_template (klass,
+          "sink"), "sink");
+  GST_PAD_SET_PROXY_CAPS (rtx->sinkpad);
+  GST_PAD_SET_PROXY_ALLOCATION (rtx->sinkpad);
+  gst_pad_set_chain_function (rtx->sinkpad,
+      GST_DEBUG_FUNCPTR (gst_rtp_rtx_queue_chain));
+  gst_element_add_pad (GST_ELEMENT (rtx), rtx->sinkpad);
+
+
+  rtx->queue = g_queue_new ();
+}
+
+typedef struct
+{
+  GstRTPRtxQueue *rtx;
+  guint seqnum;
+} RTXData;
+
+static void
+push_seqnum (GstBuffer * buffer, RTXData * data)
+{
+  GstRTPRtxQueue *rtx = data->rtx;
+  GstRTPBuffer rtpbuffer = GST_RTP_BUFFER_INIT;
+  guint16 seqnum;
+
+  if (!gst_rtp_buffer_map (buffer, GST_MAP_READ, &rtpbuffer))
+    return;
+
+  seqnum = gst_rtp_buffer_get_seq (&rtpbuffer);
+  gst_rtp_buffer_unmap (&rtpbuffer);
+
+  if (seqnum == data->seqnum) {
+    gst_pad_push (rtx->srcpad, gst_buffer_ref (buffer));
+  }
+}
+
+static gboolean
+gst_rtp_rtx_queue_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
+{
+  GstRTPRtxQueue *rtx = GST_RTP_RTX_QUEUE (parent);
+  gboolean res;
+
+  switch (GST_EVENT_TYPE (event)) {
+    case GST_EVENT_CUSTOM_UPSTREAM:
+    {
+      const GstStructure *s;
+
+      s = gst_event_get_structure (event);
+      if (gst_structure_has_name (s, "GstRTPRetransmissionRequest")) {
+        guint seqnum;
+        RTXData data;
+
+        if (!gst_structure_get_uint (s, "seqnum", &seqnum))
+          seqnum = -1;
+
+        data.rtx = rtx;
+        data.seqnum = seqnum;
+        g_queue_foreach (rtx->queue, (GFunc) push_seqnum, &data);
+        gst_event_unref (event);
+        res = TRUE;
+      } else {
+        res = gst_pad_event_default (pad, parent, event);
+      }
+      break;
+    }
+    default:
+      res = gst_pad_event_default (pad, parent, event);
+      break;
+  }
+  return res;
+}
+
+static GstFlowReturn
+gst_rtp_rtx_queue_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
+{
+  GstRTPRtxQueue *rtx;
+  GstFlowReturn ret;
+
+  rtx = GST_RTP_RTX_QUEUE (parent);
+
+  g_queue_push_head (rtx->queue, gst_buffer_ref (buffer));
+  while (g_queue_get_length (rtx->queue) > 100) {
+    gst_buffer_unref (g_queue_pop_tail (rtx->queue));
+  }
+
+  ret = gst_pad_push (rtx->srcpad, buffer);
+
+  return ret;
+}
+
+static void
+gst_rtp_rtx_queue_get_property (GObject * object,
+    guint prop_id, GValue * value, GParamSpec * pspec)
+{
+  switch (prop_id) {
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+  }
+}
+
+static void
+gst_rtp_rtx_queue_set_property (GObject * object,
+    guint prop_id, const GValue * value, GParamSpec * pspec)
+{
+  switch (prop_id) {
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+  }
+}
+
+static GstStateChangeReturn
+gst_rtp_rtx_queue_change_state (GstElement * element, GstStateChange transition)
+{
+  GstStateChangeReturn ret;
+
+  switch (transition) {
+    default:
+      break;
+  }
+
+  ret =
+      GST_ELEMENT_CLASS (gst_rtp_rtx_queue_parent_class)->change_state (element,
+      transition);
+
+  switch (transition) {
+    default:
+      break;
+  }
+
+  return ret;
+}
+
+gboolean
+gst_rtp_rtx_queue_plugin_init (GstPlugin * plugin)
+{
+  GST_DEBUG_CATEGORY_INIT (gst_rtp_rtx_queue_debug, "rtprtxqueue", 0,
+      "rtp retransmission queue");
+
+  return gst_element_register (plugin, "rtprtxqueue", GST_RANK_NONE,
+      GST_TYPE_RTP_RTX_QUEUE);
+}
--- a/gst/rtpmanager/gstrtprtxqueue.h
+++ b/gst/rtpmanager/gstrtprtxqueue.h
@ -0,0 +1,68 @@
+/* RTP muxer element for GStreamer
+ *
+ * gstrtpmux.h:
+ *
+ * Copyright (C) <2007> Nokia Corporation.
+ *   Contact: Zeeshan Ali <zeeshan.ali@nokia.com>
+ * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
+ *               2000,2005 Wim Taymans <wim@fluendo.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef __GST_RTP_RTX_QUEUE_H__
+#define __GST_RTP_RTX_QUEUE_H__
+
+#include <gst/gst.h>
+#include <gst/rtp/gstrtpbuffer.h>
+
+G_BEGIN_DECLS
+#define GST_TYPE_RTP_RTX_QUEUE (gst_rtp_rtx_queue_get_type())
+#define GST_RTP_RTX_QUEUE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_RTP_RTX_QUEUE, GstRTPRtxQueue))
+#define GST_RTP_RTX_QUEUE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_RTP_RTX_QUEUE, GstRTPRtxQueueClass))
+#define GST_RTP_RTX_QUEUE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTP_RTX_QUEUE, GstRTPRtxQueueClass))
+#define GST_IS_RTP_RTX_QUEUE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_RTP_RTX_QUEUE))
+#define GST_IS_RTP_RTX_QUEUE_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_RTP_RTX_QUEUE))
+typedef struct _GstRTPRtxQueue GstRTPRtxQueue;
+typedef struct _GstRTPRtxQueueClass GstRTPRtxQueueClass;
+
+/**
+ * GstRTPRtxQueue:
+ *
+ * The opaque #GstRTPRtxQueue structure.
+ */
+struct _GstRTPRtxQueue
+{
+  GstElement element;
+
+  /* pad */
+  GstPad *sinkpad;
+  GstPad *srcpad;
+
+  GQueue *queue;
+};
+
+struct _GstRTPRtxQueueClass
+{
+  GstElementClass parent_class;
+};
+
+
+GType gst_rtp_rtx_queue_get_type (void);
+gboolean gst_rtp_rtx_queue_plugin_init (GstPlugin * plugin);
+
+G_END_DECLS
+#endif /* __GST_RTP_RTX_QUEUE_H__ */