From a10619da658aa327c5dd200d5c3456d90ee81124 Mon Sep 17 00:00:00 2001 From: Nicolas Dufresne Date: Fri, 5 Apr 2019 17:01:08 -0400 Subject: [PATCH] rist: Enable plugin doc creation --- docs/plugins/Makefile.am | 1 + .../plugins/gst-plugins-bad-plugins-docs.sgml | 5 + .../gst-plugins-bad-plugins-sections.txt | 40 +++ docs/plugins/gst-plugins-bad-plugins.args | 300 ++++++++++++++++++ .../plugins/gst-plugins-bad-plugins.hierarchy | 2 + .../gst-plugins-bad-plugins.interfaces | 2 + docs/plugins/inspect/plugin-rist.xml | 85 +++++ 7 files changed, 435 insertions(+) create mode 100644 docs/plugins/inspect/plugin-rist.xml diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index ab659a559d..f866146e5b 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -152,6 +152,7 @@ EXTRA_HFILES = \ $(top_srcdir)/gst/pcapparse/gstpcapparse.h \ $(top_srcdir)/gst/rawparse/gstaudioparse.h \ $(top_srcdir)/gst/rawparse/gstvideoparse.h \ + $(top_srcdir)/gst/rist/gstrist.h \ $(top_srcdir)/gst/sdp/gstsdpdemux.h \ $(top_srcdir)/gst/speed/gstspeed.h \ $(top_srcdir)/gst/videosignal/gstvideoanalyse.h \ diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml index a83aa0e87c..b94f4c1a81 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -196,6 +196,10 @@ + + + + @@ -371,6 +375,7 @@ + diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index 5b45ec401d..2e0128253a 100644 --- a/docs/plugins/gst-plugins-bad-plugins-sections.txt +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -2893,6 +2893,46 @@ GST_TYPE_RFB_SRC gst_rfb_src_get_type +
+element-ristsink +ristsink +GstRistSink + +GstRistSinkClass + +gst_rist_sink_get_type +
+ +
+element-ristsrc +ristsrc +GstRistSrc + +GstRistSrcClass + +gst_rist_src_get_type +
+ +
+element-ristrtxreceive +ristrtxreceive +GstRistRtxReceive + +GstRistRtxReceiveClass + +gst_rist_rtx_receive_get_type +
+ +
+element-ristrtxsend +ristrtxsend +GstRistRtxSend + +GstRistRtxSendClass + +gst_rist_rtx_send_get_type +
+
element-rotate rotate diff --git a/docs/plugins/gst-plugins-bad-plugins.args b/docs/plugins/gst-plugins-bad-plugins.args index bebec988d6..f3c52ff21f 100644 --- a/docs/plugins/gst-plugins-bad-plugins.args +++ b/docs/plugins/gst-plugins-bad-plugins.args @@ -73842,3 +73842,303 @@ this will override closed caption stream specified font style/pen size. 1 + +GstRistSrc::address +gchar* + +rw +Address +Address to receive packets from (can be IPv4 or IPv6). +"0.0.0.0" + + + +GstRistSrc::cname +gchar* + +rw +CName +Set the CNAME in the SDES block of the receiver report. +NULL + + + +GstRistSrc::max-rtcp-bandwidth +gdouble +[0,0.05] +rwx +Maximum RTCP Bandwidth +The maximum bandwidth used for RTCP in fraction of RTP bandwdith. +0.05 + + + +GstRistSrc::max-rtx-retries +guint + +rwx +Maximum Retransmission Retries +The maximum number of retransmission requests for a lost packet. +7 + + + +GstRistSrc::min-rtcp-interval +guint +<= 100 +rwx +Minimum RTCP Intercal +The minimum interval in ms between two successive RTCP packets. +100 + + + +GstRistSrc::multicast-iface +gchar* + +rw +multicast-iface +The multicast interface to use to send packets. +NULL + + + +GstRistSrc::multicast-loopback +gboolean + +rwx +Multicast Loopback +When enabled, the packet will be received locally. +FALSE + + + +GstRistSrc::multicast-ttl +gint +[0,255] +rwx +Multicast TTL +The multicast time-to-live parameter. +1 + + + +GstRistSrc::port +guint +[2,65534] +rwx +Port +The port to listen for RTP packets, RTCP port is derived from it, this port must be an even number. +5004 + + + +GstRistSrc::receiver-buffer +guint + +rwx +Receiver Buffer +Buffering duration in ms. +1000 + + + +GstRistSrc::reorder-section +guint + +rwx +Recorder Section +Time to wait before sending retransmission request in ms. +70 + + + +GstRistSrc::stats +GstStructure* + +r +Statistics +Statistic in a GstStructure named 'rist/x-receiver-stats'. + + + + +GstRistSrc::stats-update-interval +guint + +rwx +Statistics Update Interval +The interval between 'stats' update notification (0 disabled). +0 + + + +GstRistSink::address +gchar* + +rw +Address +Address to send packets to (can be IPv4 or IPv6). +"0.0.0.0" + + + +GstRistSink::cname +gchar* + +rw +CName +Set the CNAME in the SDES block of the sender report. +NULL + + + +GstRistSink::max-rtcp-bandwidth +gdouble +[0,0.05] +rwx +Maximum RTCP Bandwidth +The maximum bandwidth used for RTCP in fraction of RTP bandwdith. +0.05 + + + +GstRistSink::min-rtcp-interval +guint +<= 100 +rwx +Minimum RTCP Intercal +The minimum interval in ms between two regular successive RTCP packets. +100 + + + +GstRistSink::multicast-iface +gchar* + +rw +multicast-iface +The multicast interface to use to send packets. +NULL + + + +GstRistSink::multicast-loopback +gboolean + +rwx +Multicast Loopback +When enabled, the packet will be received locally. +FALSE + + + +GstRistSink::multicast-ttl +gint +[0,255] +rwx +Multicast TTL +The multicast time-to-live parameter. +1 + + + +GstRistSink::port +guint +[2,65534] +rwx +Port +The port RTP packets will be sent, RTCP port is derived from it, this port must be an even number. +5004 + + + +GstRistSink::sender-buffer +guint + +rwx +Sender Buffer +Size of the retransmission queue in ms. +1200 + + + +GstRistSink::stats +GstStructure* + +r +Statistics +Statistic in a GstStructure named 'rist/x-sender-stats'. + + + + +GstRistSink::stats-update-interval +guint + +rwx +Statistics Update Interval +The interval between 'stats' update notification (0 disabled). +0 + + + +GstRistRtxSend::max-size-packets +guint +<= 32767 +rw +Max Size Packets +Amount of packets to queue (0 = unlimited). +100 + + + +GstRistRtxSend::max-size-time +guint + +rw +Max Size Time +Amount of ms to queue (0 = unlimited). +0 + + + +GstRistRtxSend::num-rtx-packets +guint + +r +Num RTX Packets + Number of retransmission packets sent. +0 + + + +GstRistRtxSend::num-rtx-requests +guint + +r +Num RTX Requests +Number of retransmission events received. +0 + + + +GstRistRtxReceive::num-rtx-packets +guint + +r +Num RTX Packets + Number of retransmission packets received. +0 + + + +GstRistRtxReceive::num-rtx-requests +guint + +r +Num RTX Requests +Number of retransmission events received. +0 + + diff --git a/docs/plugins/gst-plugins-bad-plugins.hierarchy b/docs/plugins/gst-plugins-bad-plugins.hierarchy index 56caed7094..352d0cdab8 100644 --- a/docs/plugins/gst-plugins-bad-plugins.hierarchy +++ b/docs/plugins/gst-plugins-bad-plugins.hierarchy @@ -235,6 +235,8 @@ GObject GstCameraBin GstIpcSlavePipeline GstProxySrc + GstRistSink + GstRistSrc GstSDPDemux GstSdpSrc GstTestSrcBin diff --git a/docs/plugins/gst-plugins-bad-plugins.interfaces b/docs/plugins/gst-plugins-bad-plugins.interfaces index 87db208791..1d54590c04 100644 --- a/docs/plugins/gst-plugins-bad-plugins.interfaces +++ b/docs/plugins/gst-plugins-bad-plugins.interfaces @@ -81,6 +81,8 @@ GstPnmenc GstPreset GstProxySrc GstChildProxy GstRTMPSink GstURIHandler GstRTMPSrc GstURIHandler +GstRistSink GstChildProxy +GstRistSrc GstChildProxy GstURIHandler GstSDLVideoSink GstImplementsInterface GstXOverlay GstNavigation GstSDPDemux GstChildProxy GstSRTSink GstURIHandler diff --git a/docs/plugins/inspect/plugin-rist.xml b/docs/plugins/inspect/plugin-rist.xml new file mode 100644 index 0000000000..3a3168d26d --- /dev/null +++ b/docs/plugins/inspect/plugin-rist.xml @@ -0,0 +1,85 @@ + + rist + Source and Sink for RIST TR-06-1 streaming specification + ../../gst/rist/.libs/libgstrist.so + libgstrist.so + 1.15.2.1 + LGPL + gst-plugins-bad + GStreamer Bad Plug-ins git + Unknown package origin + + + ristrtxreceive + RIST Retransmission receiver + Codec + Receive retransmitted RIST packets according to VSF TR-06-1 + Nicolas Dufresne <nicolas.dufresne@collabora.com> + + + sink + sink + always +
application/x-rtp
+ + + src + source + always +
application/x-rtp
+ + + + + ristrtxsend + RIST Retransmission Sender + Codec + Retransmit RTP packets when needed, according to VSF TR-06-1 + Nicolas Dufresne <nicolas.dufresne@collabora.com> + + + sink + sink + always +
application/x-rtp, clock-rate=(int)[ 1, 2147483647 ]
+ + + src + source + always +
application/x-rtp
+ + + + + ristsink + RIST Sink + Source/Network + Sink that implements RIST TR-06-1 streaming specification + Nicolas Dufresne <nicolas.dufresne@collabora.com + + + sink + sink + always +
application/x-rtp
+ + + + + ristsrc + RIST Source + Source/Network + Source that implements RIST TR-06-1 streaming specification + Nicolas Dufresne <nicolas.dufresne@collabora.com + + + src + source + always +
application/x-rtp
+ + + + + \ No newline at end of file