docs/plugins/: Add the real and rtsp elements and update the lists.

Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-ugly-plugins-docs.sgml:
* docs/plugins/gst-plugins-ugly-plugins-sections.txt:
Add the real and rtsp elements and update the lists.
* docs/plugins/inspect/plugin-amrnb.xml:
* docs/plugins/inspect/plugin-asf.xml:
* docs/plugins/inspect/plugin-dvdlpcmdec.xml:
* docs/plugins/inspect/plugin-dvdsub.xml:
* docs/plugins/inspect/plugin-mpegaudioparse.xml:
* docs/plugins/inspect/plugin-mpegstream.xml:
* docs/plugins/inspect/plugin-realmedia.xml:
* docs/plugins/inspect/plugin-siddec.xml:
* docs/plugins/inspect/plugin-synaesthesia.xml:
Regenerate docs.
* gst/iec958/ac3_padder.c:
* gst/iec958/ac3_padder.h:
Do not use gtk-doc style comments for non gtk-doc comments. Note -
there are functions defined using extern in the .c file - does that
make sense?
This commit is contained in:
Stefan Kost 2008-01-21 13:35:02 +00:00
parent c41fa79420
commit 4231e2f7c2
15 changed files with 230 additions and 46 deletions

View file

@ -1,3 +1,27 @@
2008-01-21 Stefan Kost <ensonic@users.sf.net>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-ugly-plugins-docs.sgml:
* docs/plugins/gst-plugins-ugly-plugins-sections.txt:
Add the real and rtsp elements and update the lists.
* docs/plugins/inspect/plugin-amrnb.xml:
* docs/plugins/inspect/plugin-asf.xml:
* docs/plugins/inspect/plugin-dvdlpcmdec.xml:
* docs/plugins/inspect/plugin-dvdsub.xml:
* docs/plugins/inspect/plugin-mpegaudioparse.xml:
* docs/plugins/inspect/plugin-mpegstream.xml:
* docs/plugins/inspect/plugin-realmedia.xml:
* docs/plugins/inspect/plugin-siddec.xml:
* docs/plugins/inspect/plugin-synaesthesia.xml:
Regenerate docs.
* gst/iec958/ac3_padder.c:
* gst/iec958/ac3_padder.h:
Do not use gtk-doc style comments for non gtk-doc comments. Note -
there are functions defined using extern in the .c file - does that
make sense?
2008-01-21 Stefan Kost <ensonic@users.sf.net>
* ext/mad/gstmad.c:

View file

@ -89,6 +89,10 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/lame/gstlame.h \
$(top_srcdir)/ext/mad/gstmad.h \
$(top_srcdir)/ext/sidplay/gstsiddec.h \
$(top_srcdir)/gst/asfdemux/gstrtspwms.h \
$(top_srcdir)/gst/realmedia/rademux.h \
$(top_srcdir)/gst/realmedia/rdtmanager.h \
$(top_srcdir)/gst/realmedia/rtspreal.h \
$(top_srcdir)/gst/synaesthesia/gstsynaesthesia.h
# Images to copy into HTML directory.

View file

@ -23,15 +23,22 @@
<chapter>
<title>gst-plugins-ugly Plugins</title>
<xi:include href="xml/plugin-a52dec.xml" />
<xi:include href="xml/plugin-amrnb.xml" />
<xi:include href="xml/plugin-asf.xml" />
<xi:include href="xml/plugin-dvdlpcmdec.xml" />
<xi:include href="xml/plugin-dvdnav.xml" />
<xi:include href="xml/plugin-dvdread.xml" />
<xi:include href="xml/plugin-dvdsub.xml" />
<xi:include href="xml/plugin-iec958.xml" />
<xi:include href="xml/plugin-lame.xml" />
<xi:include href="xml/plugin-mad.xml" />
<xi:include href="xml/plugin-mpeg2dec.xml" />
<xi:include href="xml/plugin-mpegaudioparse.xml" />
<xi:include href="xml/plugin-mpegstream.xml" />
<xi:include href="xml/plugin-realmedia.xml" />
<xi:include href="xml/plugin-rmdemux.xml" />
<xi:include href="xml/plugin-siddec.xml" />
<xi:include href="xml/plugin-synaesthesia.xml" />
</chapter>
</book>

View file

@ -54,6 +54,7 @@ GST_TYPE_MAD
gst_mad_get_type
gst_id3_tag_get_type
gst_mad_id3_to_tag_list
gst_mad_tag_list_to_id3_tag
</SECTION>
<SECTION>
@ -70,6 +71,67 @@ GST_TYPE_LAME
gst_lame_get_type
</SECTION>
<SECTION>
<FILE>element-rdtmanager</FILE>
<TITLE>rdtmanager</TITLE>
GstRDTManager
<SUBSECTION Standard>
GstRDTManagerClass
GstRDTManagerSession
GST_RDT_MANAGER
GST_RDT_MANAGER_CLASS
GST_IS_RDT_MANAGER
GST_IS_RDT_MANAGER_CLASS
GST_TYPE_RDT_MANAGER
gst_rdt_manager_get_type
gst_rdt_manager_plugin_init
</SECTION>
<SECTION>
<FILE>element-rademux</FILE>
<TITLE>rademux</TITLE>
GstRealAudioDemux
<SUBSECTION Standard>
GstRealAudioDemuxClass
GstRealAudioDemuxState
GST_REAL_AUDIO_DEMUX
GST_REAL_AUDIO_DEMUX_CLASS
GST_IS_REAL_AUDIO_DEMUX
GST_IS_REAL_AUDIO_DEMUX_CLASS
GST_TYPE_REAL_AUDIO_DEMUX
gst_real_audio_demux_get_type
</SECTION>
<SECTION>
<FILE>element-rtspreal</FILE>
<TITLE>rtspreal</TITLE>
GstRTSPReal
<SUBSECTION Standard>
GstRTSPRealClass
GstRTSPRealStream
GST_RTSP_REAL
GST_RTSP_REAL_CLASS
GST_IS_RTSP_REAL
GST_IS_RTSP_REAL_CLASS
GST_TYPE_RTSP_REAL
gst_rtsp_real_get_type
gst_rtsp_real_plugin_init
</SECTION>
<SECTION>
<FILE>element-rtspwms</FILE>
<TITLE>rtspwms</TITLE>
GstRTSPWMS
<SUBSECTION Standard>
GstRTSPWMSClass
GST_RTSP_WMS
GST_RTSP_WMS_CLASS
GST_IS_RTSP_WMS
GST_IS_RTSP_WMS_CLASS
GST_TYPE_RTSP_WMS
gst_rtsp_wms_get_type
</SECTION>
<SECTION>
<FILE>element-siddec</FILE>
<TITLE>siddec</TITLE>
@ -96,5 +158,8 @@ GST_IS_SYNAESTHESIA
GST_IS_SYNAESTHESIA_CLASS
GST_TYPE_SYNAESTHESIA
gst_synaesthesia_get_type
SYNAES_HEIGHT
SYNAES_SAMPLES
SYNAES_WIDTH
</SECTION>

View file

@ -35,7 +35,7 @@
<longname>AMR-NB audio encoder</longname>
<class>Codec/Encoder/Audio</class>
<description>Adaptive Multi-Rate Narrow-Band audio encoder</description>
<author>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;, Wim Taymans &lt;wim@fluendo.com&gt;</author>
<author>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;, Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads>
<caps>
<name>src</name>

View file

@ -36,5 +36,15 @@
</caps>
</pads>
</element>
<element>
<name>rtspwms</name>
<longname>WMS RTSP Extension</longname>
<class>Network/Extension/Protocol</class>
<description>Extends RTSP so that it can handle WMS setup</description>
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads>
</pads>
</element>
</elements>
</plugin>

View file

@ -14,20 +14,19 @@
<longname>DVD LPCM Audio decoder</longname>
<class>Codec/Demuxer/Audio</class>
<description>Decode DVD LPCM frames into standard PCM audio</description>
<author>Jan Schmidt &lt;jan@noraisin.net&gt;
Michael Smith &lt;msmith@fluendo.com&gt;</author>
<author>Jan Schmidt &lt;jan@noraisin.net&gt;012Michael Smith &lt;msmith@fluendo.com&gt;</author>
<pads>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-int, width=(int){ 16, 24 }, rate=(int){ 48000, 96000 }, channels=(int)[ 1, 8 ], endianness=(int){ 4321 }, depth=(int){ 16, 24 }, signed=(boolean){ true }</details>
<details>audio/x-raw-int, width=(int){ 16, 24 }, rate=(int){ 32000, 44100, 48000, 96000 }, channels=(int)[ 1, 8 ], endianness=(int){ 4321 }, depth=(int){ 16, 24 }, signed=(boolean){ true }</details>
</caps>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-private1-lpcm; audio/x-lpcm, width=(int){ 16, 20, 24 }, rate=(int){ 48000, 96000 }, channels=(int)[ 1, 8 ], dynamic_range=(int)[ 0, 255 ], emphasis=(boolean){ true, false }, mute=(boolean){ true, false }</details>
<details>audio/x-private1-lpcm; audio/x-lpcm, width=(int){ 16, 20, 24 }, rate=(int){ 32000, 44100, 48000, 96000 }, channels=(int)[ 1, 8 ], dynamic_range=(int)[ 0, 255 ], emphasis=(boolean){ true, false }, mute=(boolean){ true, false }</details>
</caps>
</pads>
</element>

View file

@ -1,6 +1,6 @@
<plugin>
<name>dvdsub</name>
<description>Decode DVD subtitles to AYUV video frames</description>
<description>DVD subtitle parser and decoder</description>
<filename>../../gst/dvdsub/.libs/libgstdvdsub.so</filename>
<basename>libgstdvdsub.so</basename>
<version>0.10.6.1</version>
@ -11,10 +11,10 @@
<elements>
<element>
<name>dvdsubdec</name>
<longname>DVD subtitle Decoder</longname>
<longname>DVD subtitle decoder</longname>
<class>Codec/Decoder/Video</class>
<description>Decodes DVD subtitles into AYUV video frames</description>
<author>Wim Taymans &lt;wim.taymans@chello.be&gt;, Jan Schmidt &lt;thaytan@mad.scientist.com&gt;</author>
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;, Jan Schmidt &lt;thaytan@mad.scientist.com&gt;</author>
<pads>
<caps>
<name>sink</name>
@ -30,5 +30,26 @@
</caps>
</pads>
</element>
<element>
<name>dvdsubparse</name>
<longname>DVD subtitle parser</longname>
<class>Codec/Parser/Subtitle</class>
<description>Parses and packetizes DVD subtitle streams</description>
<author>Mark Nauwelaerts &lt;mnauw@users.sourceforge.net&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>video/x-dvd-subpicture</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-dvd-subpicture, parsed=(boolean)true</details>
</caps>
</pads>
</element>
</elements>
</plugin>

View file

@ -14,8 +14,7 @@
<longname>MPEG1 Audio Parser</longname>
<class>Codec/Parser/Audio</class>
<description>Parses and frames mpeg1 audio streams (levels 1-3), provides seek</description>
<author>Jan Schmidt &lt;thaytan@mad.scientist.com&gt;
Erik Walthinsen &lt;omega@cse.ogi.edu&gt;</author>
<author>Jan Schmidt &lt;thaytan@mad.scientist.com&gt;012Erik Walthinsen &lt;omega@cse.ogi.edu&gt;</author>
<pads>
<caps>
<name>src</name>

View file

@ -77,8 +77,7 @@
<longname>MPEG Demuxer</longname>
<class>Codec/Demuxer</class>
<description>Demultiplexes MPEG1 and MPEG2 System Streams</description>
<author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;
Wim Taymans &lt;wim.taymans@chello.be&gt;</author>
<author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;012Wim Taymans &lt;wim.taymans@chello.be&gt;</author>
<pads>
<caps>
<name>sink</name>
@ -111,8 +110,7 @@
<longname>MPEG System Parser</longname>
<class>Codec/Parser</class>
<description>Parses MPEG1 and MPEG2 System Streams</description>
<author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;
Wim Taymans &lt;wim.taymans@chello.be&gt;</author>
<author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;012Wim Taymans &lt;wim.taymans@chello.be&gt;</author>
<pads>
<caps>
<name>sink</name>

View file

@ -14,20 +14,20 @@
<longname>RealAudio Demuxer</longname>
<class>Codec/Demuxer</class>
<description>Demultiplex a RealAudio file</description>
<author>Tim-Philipp Müller &lt;tim centricular net&gt;</author>
<author>Tim-Philipp M303274ller &lt;tim centricular net&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>application/x-pn-realaudio</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
</caps>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>application/x-pn-realaudio</details>
</caps>
</pads>
</element>
<element>
@ -37,17 +37,50 @@
<description>Extracts RealMedia from RDT packets</description>
<author>Lutz Mueller &lt;lutz at topfrose dot de&gt;, Wim Taymans &lt;wim@fluendo.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>application/x-rdt, media=(string)application, clock-rate=(int)[ 1, 2147483647 ], encoding-name=(string)X-REAL-RDT</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>application/vnd.rn-realmedia</details>
</caps>
</pads>
</element>
<element>
<name>rdtmanager</name>
<longname>RTP Decoder</longname>
<class>Codec/Parser/Network</class>
<description>Accepts raw RTP and RTCP packets and sends them forward</description>
<author>Wim Taymans &lt;wim@fluendo.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<name>rtcp_src_%d</name>
<direction>source</direction>
<presence>request</presence>
<details>application/x-rtcp</details>
</caps>
<caps>
<name>recv_rtp_src_%d_%d_%d</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>application/x-rdt</details>
</caps>
<caps>
<name>recv_rtcp_sink_%d</name>
<direction>sink</direction>
<presence>always</presence>
<details>application/x-rdt, media=(string)application, clock-rate=(int)[ 1, 2147483647 ], encoding-name=(string)x-real-rdt</details>
<presence>request</presence>
<details>application/x-rtcp</details>
</caps>
<caps>
<name>recv_rtp_sink_%d</name>
<direction>sink</direction>
<presence>request</presence>
<details>application/x-rdt</details>
</caps>
</pads>
</element>
@ -59,10 +92,10 @@
<author>David Schleef &lt;ds@schleef.org&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>application/vnd.rn-realmedia</details>
<name>audio_%02d</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
</caps>
<caps>
<name>video_%02d</name>
@ -71,12 +104,22 @@
<details>ANY</details>
</caps>
<caps>
<name>audio_%02d</name>
<direction>source</direction>
<presence>sometimes</presence>
<details>ANY</details>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>application/vnd.rn-realmedia</details>
</caps>
</pads>
</element>
<element>
<name>rtspreal</name>
<longname>RealMedia RTSP Extension</longname>
<class>Network/Extension/Protocol</class>
<description>Extends RTSP so that it can handle RealMedia setup</description>
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads>
</pads>
</element>
</elements>
</plugin>

View file

@ -3,10 +3,10 @@
<description>Uses libsidplay to decode .sid files</description>
<filename>../../ext/sidplay/.libs/libgstsid.so</filename>
<basename>libgstsid.so</basename>
<version>0.10.6</version>
<version>0.10.6.1</version>
<license>GPL</license>
<source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package>
<package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin>
<elements>
<element>
@ -14,7 +14,21 @@
<longname>Sid decoder</longname>
<class>Codec/Decoder/Audio</class>
<description>Use libsidplay to decode SID audio tunes</description>
<author>Wim Taymans &lt;wim@fluendo.com&gt; </author>
<author>Wim Taymans &lt;wim.taymans@gmail.com&gt;</author>
<pads>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-sid</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>audio/x-raw-int, endianness=(int)1234, signed=(boolean){ true, false }, width=(int){ 8, 16 }, depth=(int){ 8, 16 }, rate=(int)[ 8000, 48000 ], channels=(int)[ 1, 2 ]</details>
</caps>
</pads>
</element>
</elements>
</plugin>

View file

@ -16,18 +16,18 @@
<description>Creates video visualizations of audio input, using stereo and pitch information</description>
<author>Richard Boulton &lt;richard@tartarus.org&gt;</author>
<pads>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
<caps>
<name>sink</name>
<direction>sink</direction>
<presence>always</presence>
<details>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)2, endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
</pads>
</element>
</elements>

View file

@ -183,7 +183,7 @@ resync (ac3_padder * padder, int offset, int skipped)
}
/**
* ac3_push_data
* ac3_push_data:
* @padder: The padder structure.
* @data: A pointer to a buffer with new data to parse. This should
* correspond to a new piece of a stream containing raw AC3 data.
@ -208,7 +208,7 @@ ac3p_push_data (ac3_padder * padder, guchar * data, guint size)
}
/**
* ac3p_parse
* ac3p_parse:
* @padder: The padder structure.
*
* Parses the bytes already pushed into the padder structure (see

View file

@ -124,7 +124,7 @@ ac3p_parse(ac3_padder *padder);
* ac3p_frame
* @padder: The padder structure.
*
* Returns a pointer to the padded frame contained in the padder.
* Returns: a pointer to the padded frame contained in the padder.
*/
#define ac3p_frame(padder) ((guint8 *) &((padder)->frame))
@ -132,7 +132,7 @@ ac3p_parse(ac3_padder *padder);
* ac3p_frame_size
* @padder: The padder structure.
*
* Returns the length in bytes of the last read raw AC3 frame.
* Returns: the length in bytes of the last read raw AC3 frame.
*/
#define ac3p_frame_size(padder) ((padder)->ac3_frame_size * 2)