diff options
| -rw-r--r-- | ChangeLog | 12 | ||||
| -rw-r--r-- | docs/plugins/Makefile.am | 1 | ||||
| -rw-r--r-- | docs/plugins/gst-plugins-good-plugins-docs.sgml | 1 | ||||
| -rw-r--r-- | docs/plugins/gst-plugins-good-plugins-sections.txt | 25 | ||||
| -rw-r--r-- | docs/plugins/gst-plugins-good-plugins.args | 6 | ||||
| -rw-r--r-- | docs/plugins/inspect/plugin-udp.xml | 4 | ||||
| -rw-r--r-- | gst/udp/gstudpsrc.c | 66 |
7 files changed, 104 insertions, 11 deletions
@@ -1,3 +1,15 @@ +2006-02-16 Wim Taymans <wim@fluendo.com> + + * docs/plugins/Makefile.am: + * docs/plugins/gst-plugins-good-plugins-docs.sgml: + * docs/plugins/gst-plugins-good-plugins-sections.txt: + * docs/plugins/gst-plugins-good-plugins.args: + * docs/plugins/inspect/plugin-udp.xml: + * gst/udp/gstudpsrc.c: (gst_udpsrc_class_init), (gst_udpsrc_init), + (gst_udpsrc_start): + Update documentation. + Fix args. + 2006-02-16 Jan Schmidt <thaytan@mad.scientist.com> * gst/id3demux/id3tags.c: (id3demux_id3v2_frames_to_tag_list): diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index d25bee1a..8605656b 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -87,6 +87,7 @@ EXTRA_HFILES = \ $(top_srcdir)/ext/hal/gsthalaudiosrc.h \ $(top_srcdir)/gst/multipart/multipartmux.c \ $(top_srcdir)/gst/multipart/multipartdemux.c \ + $(top_srcdir)/gst/udp/gstudpsrc.h \ $(top_srcdir)/gst/udp/gstmultiudpsink.h \ $(top_srcdir)/gst/videomixer/videomixer.c diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml index f12d2eea..d3a971c2 100644 --- a/docs/plugins/gst-plugins-good-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml @@ -23,6 +23,7 @@ <xi:include href="xml/element-halaudiosrc.xml" /> <xi:include href="xml/element-id3demux.xml" /> <xi:include href="xml/element-level.xml" /> + <xi:include href="xml/element-udpsrc.xml" /> <xi:include href="xml/element-multiudpsink.xml" /> <xi:include href="xml/element-multipartmux.xml" /> <xi:include href="xml/element-multipartdemux.xml" /> diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt index e7807c49..73c89800 100644 --- a/docs/plugins/gst-plugins-good-plugins-sections.txt +++ b/docs/plugins/gst-plugins-good-plugins-sections.txt @@ -104,10 +104,35 @@ GstMultipartDemuxClass <SECTION> <FILE>element-multiudpsink</FILE> +GstUDPClient GstMultiUDPSink <TITLE>multiudpsink</TITLE> <SUBSECTION Standard> GstMultiUDPSinkClass +gst_multiudpsink_add +gst_multiudpsink_remove +gst_multiudpsink_clear +gst_multiudpsink_get_stats +GST_MULTIUDPSINK +GST_IS_MULTIUDPSINK +GST_TYPE_MULTIUDPSINK +gst_multiudpsink_get_type +GST_MULTIUDPSINK_CLASS +GST_IS_MULTIUDPSINK_CLASS +</SECTION> + +<SECTION> +<FILE>element-udpsrc</FILE> +GstUDPSrc +<TITLE>udpsrc</TITLE> +<SUBSECTION Standard> +GstUDPSrcClass +GST_UDPSRC +GST_IS_UDPSRC +GST_TYPE_UDPSRC +gst_udpsrc_get_type +GST_UDPSRC_CLASS +GST_IS_UDPSRC_CLASS </SECTION> <SECTION> diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args index ca271028..4feedf97 100644 --- a/docs/plugins/gst-plugins-good-plugins.args +++ b/docs/plugins/gst-plugins-good-plugins.args @@ -141,7 +141,7 @@ <ARG> <NAME>GstUDPSrc::port</NAME> <TYPE>gint</TYPE> -<RANGE>[0,32768]</RANGE> +<RANGE>[0,65535]</RANGE> <FLAGS>rw</FLAGS> <NICK>port</NICK> <BLURB>The port to receive the packets from, 0=allocate.</BLURB> @@ -161,11 +161,11 @@ <ARG> <NAME>GstUDPSrc::sockfd</NAME> <TYPE>gint</TYPE> -<RANGE>[0,32767]</RANGE> +<RANGE>[-1,2147483647]</RANGE> <FLAGS>rw</FLAGS> <NICK>socket handle</NICK> <BLURB>Socket to use for UDP reception.</BLURB> -<DEFAULT>0</DEFAULT> +<DEFAULT>-1</DEFAULT> </ARG> <ARG> diff --git a/docs/plugins/inspect/plugin-udp.xml b/docs/plugins/inspect/plugin-udp.xml index ef9020d2..a6c7ab19 100644 --- a/docs/plugins/inspect/plugin-udp.xml +++ b/docs/plugins/inspect/plugin-udp.xml @@ -3,10 +3,10 @@ <description>transfer data via UDP</description> <filename>../../gst/udp/.libs/libgstudp.so</filename> <basename>libgstudp.so</basename> - <version>0.10.2</version> + <version>0.10.2.1</version> <license>LGPL</license> <source>gst-plugins-good</source> - <package>GStreamer Good Plug-ins source release</package> + <package>GStreamer Good Plug-ins CVS/prerelease</package> <origin>Unknown package origin</origin> <elements> <element> diff --git a/gst/udp/gstudpsrc.c b/gst/udp/gstudpsrc.c index c9fbadb1..2aa17582 100644 --- a/gst/udp/gstudpsrc.c +++ b/gst/udp/gstudpsrc.c @@ -18,6 +18,60 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-udpsrc + * @see_also: udpsink, multifdsink + * + * <refsect2> + * <para> + * udpsrc is a network source that reads UDP packets from the network. + * It can be combined with RTP depayloaders to implement RTP streaming. + * </para> + * <title>Examples</title> + * <para> + * Here is a simple pipeline to read from the default port and dump the udp packets. + * <programlisting> + * gst-launch -v udpsrc ! fakesink dump=1 + * </programlisting> + * To actually generate udp packets on the default port one can use the + * udpsink element. When running the following pipeline in another terminal, the + * above mentioned pipeline should dump data packets to the console. + * <programlisting> + * gst-launch -v audiotestsrc ! udpsink + * </programlisting> + * </para> + * <para> + * The udpsrc element supports automatic port allocation by setting the + * "port" property to 0. the following pipeline reads UDP from a free port. + * <programlisting> + * gst-launch -v udpsrc port=0 ! fakesink + * </programlisting> + * </para> + * <para> + * udpsrc can read from multicast groups by setting the multicast_group property + * to the IP address of the multicast group. + * </para> + * <para> + * Alternatively one can provide a custom socket to udpsrc with the "sockfd" property, + * udpsrc will then not allocate a socket itself but use the provided one. + * </para> + * <para> + * The "caps" property is mainly used to give a type to the UDP packet so that they + * can be autoplugged in GStreamer pipelines. This is very usefull for RTP + * implementations where the contents of the UDP packets is transfered out-of-bounds + * using SDP or other means. + * </para> + * <para> + * The udpsrc is always a live source. It does however not provide a GstClock, this + * is left for upstream elements such as an RTP session manager or demuxer (such + * as an MPEG demuxer). + * </para> + * <para> + * udpsrc implements a GstURIHandler interface that handles udp://host:port type + * URIs. + * </para> + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" @@ -67,8 +121,9 @@ GST_ELEMENT_DETAILS ("UDP packet receiver", #define UDP_DEFAULT_PORT 4951 #define UDP_DEFAULT_MULTICAST_GROUP "0.0.0.0" -#define UDP_DEFAULT_URI "udp://0.0.0.0:4951" +#define UDP_DEFAULT_URI "udp://"UDP_DEFAULT_MULTICAST_GROUP":"G_STRINGIFY(UDP_DEFAULT_PORT) #define UDP_DEFAULT_CAPS NULL +#define UDP_DEFAULT_SOCKFD -1 enum { @@ -138,7 +193,7 @@ gst_udpsrc_class_init (GstUDPSrcClass * klass) g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PORT, g_param_spec_int ("port", "port", - "The port to receive the packets from, 0=allocate", 0, 32768, + "The port to receive the packets from, 0=allocate", 0, G_MAXUINT16, UDP_DEFAULT_PORT, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_MULTICAST_GROUP, g_param_spec_string ("multicast_group", "multicast_group", @@ -153,8 +208,8 @@ gst_udpsrc_class_init (GstUDPSrcClass * klass) "The caps of the source pad", GST_TYPE_CAPS, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_SOCKFD, g_param_spec_int ("sockfd", "socket handle", - "Socket to use for UDP reception.", - 0, G_MAXINT16, 0, G_PARAM_READWRITE)); + "Socket to use for UDP reception. (-1 == allocate)", + -1, G_MAXINT, UDP_DEFAULT_SOCKFD, G_PARAM_READWRITE)); gstbasesrc_class->start = gst_udpsrc_start; gstbasesrc_class->stop = gst_udpsrc_stop; @@ -169,7 +224,7 @@ gst_udpsrc_init (GstUDPSrc * udpsrc, GstUDPSrcClass * g_class) { gst_base_src_set_live (GST_BASE_SRC (udpsrc), TRUE); udpsrc->port = UDP_DEFAULT_PORT; - udpsrc->sock = -1; + udpsrc->sock = UDP_DEFAULT_SOCKFD; udpsrc->multi_group = g_strdup (UDP_DEFAULT_MULTICAST_GROUP); udpsrc->uri = g_strdup (UDP_DEFAULT_URI); } @@ -479,7 +534,6 @@ gst_udpsrc_start (GstBaseSrc * bsrc) sizeof (reuse))) < 0) goto setsockopt_error; - /* XXX-kvehmanen: add ability to select a random, free port */ memset (&src->myaddr, 0, sizeof (src->myaddr)); src->myaddr.sin_family = AF_INET; /* host byte order */ src->myaddr.sin_port = htons (src->port); /* short, network byte order */ |