Update and add documentation for mplex.

Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* docs/plugins/gst-plugins-bad-plugins.hierarchy:
* docs/plugins/inspect/plugin-mplex.xml:
* ext/mplex/gstmplex.cc:
Update and add documentation for mplex.
* ext/mpeg2enc/gstmpeg2enc.cc:
Documentation update.
This commit is contained in:
Mark Nauwelaerts 2008-08-12 14:31:57 +00:00
parent edf32882a0
commit 6e98f36a65
8 changed files with 84 additions and 5 deletions

View file

@ -1,3 +1,15 @@
2008-08-12 Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* docs/plugins/gst-plugins-bad-plugins.hierarchy:
* docs/plugins/inspect/plugin-mplex.xml:
* ext/mplex/gstmplex.cc:
Update and add documentation for mplex.
* ext/mpeg2enc/gstmpeg2enc.cc:
Documentation update.
2008-08-12 Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>
* docs/plugins/Makefile.am:

View file

@ -109,6 +109,7 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/metadata/gstmetadatademux.h \
$(top_srcdir)/ext/metadata/gstmetadatamux.h \
$(top_srcdir)/ext/mpeg2enc/gstmpeg2enc.hh \
$(top_srcdir)/ext/mplex/gstmplex.hh \
$(top_srcdir)/ext/mythtv/gstmythtvsrc.h \
$(top_srcdir)/ext/sdl/sdlaudiosink.h \
$(top_srcdir)/ext/sdl/sdlvideosink.h \

View file

@ -37,6 +37,7 @@
<xi:include href="xml/element-metadatamux.xml" />
<xi:include href="xml/element-modplug.xml" />
<xi:include href="xml/element-mpeg2enc.xml" />
<xi:include href="xml/element-mplex.xml" />
<xi:include href="xml/element-mythtvsrc.xml" />
<xi:include href="xml/element-nuvdemux.xml" />
<xi:include href="xml/element-output-selector.xml" />
@ -91,6 +92,7 @@
<xi:include href="xml/plugin-mms.xml" />
<xi:include href="xml/plugin-modplug.xml" />
<xi:include href="xml/plugin-mpeg2enc.xml" />
<xi:include href="xml/plugin-mplex.xml" />
<xi:include href="xml/plugin-mpeg4videoparse.xml" />
<xi:include href="xml/plugin-mpegtsparse.xml" />
<xi:include href="xml/plugin-mpegvideoparse.xml" />

View file

@ -347,6 +347,25 @@ GST_MPEG2ENC_WAIT
gst_mpeg2enc_get_type
</SECTION>
<SECTION>
<FILE>element-mplex</FILE>
<TITLE>mplex</TITLE>
GstMplex
<SUBSECTION Standard>
GstMplexClass
GST_MPLEX
GST_MPLEX_CLASS
GST_IS_MPLEX
GST_IS_MPLEX_CLASS
GST_TYPE_MPLEX
GST_MPLEX_MUTEX_LOCK
GST_MPLEX_MUTEX_UNLOCK
GST_MPLEX_SIGNAL
GST_MPLEX_SIGNAL_ALL
GST_MPLEX_WAIT
gst_mplex_get_type
</SECTION>
<SECTION>
<FILE>element-mythtvsrc</FILE>
<TITLE>mythtvsrc</TITLE>
@ -723,5 +742,7 @@ GST_Y4M_ENCODE
GST_Y4M_ENCODE_CLASS
GST_IS_Y4M_ENCODE
GST_IS_Y4M_ENCODE_CLASS
GST_Y4M_ENCODE_GET_CLASS
GST_TYPE_Y4M_ENCODE
gst_y4m_encode_get_type
</SECTION>

View file

@ -107,6 +107,7 @@ GObject
GstGSMEnc
GstGSMDec
GstMpeg2enc
GstMplex
GstMusepackDec
GstTRM
GstPitch

View file

@ -0,0 +1,42 @@
<plugin>
<name>mplex</name>
<description>High-quality MPEG/DVD/SVCD/VCD video/audio multiplexer</description>
<filename>../../ext/mplex/.libs/libgstmplex.so</filename>
<basename>libgstmplex.so</basename>
<version>0.10.8</version>
<license>GPL</license>
<source>gst-plugins-bad</source>
<package>GStreamer Bad Plug-ins source release</package>
<origin>Unknown package origin</origin>
<elements>
<element>
<name>mplex</name>
<longname>mplex video multiplexer</longname>
<class>Codec/Muxer</class>
<description>High-quality MPEG/DVD/SVCD/VCD video/audio multiplexer</description>
<author>Andrew Stevens &lt;andrew.stevens@nexgo.de&gt;
Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;
Mark Nauwelaerts &lt;mnauw@users.sourceforge.net</author>
<pads>
<caps>
<name>audio_%d</name>
<direction>sink</direction>
<presence>request</presence>
<details>audio/mpeg, mpegversion=(int)1, layer=(int)[ 1, 3 ], channels=(int)[ 1, 8 ], rate=(int)[ 8000, 96000 ]; audio/x-ac3, channels=(int)[ 1, 8 ], rate=(int)[ 8000, 96000 ]; audio/x-dts; audio/x-raw-int, endianness=(int)4321, signed=(boolean)true, width=(int){ 16, 20, 24 }, depth=(int){ 16, 20, 24 }, rate=(int){ 48000, 96000 }, channels=(int)[ 1, 6 ]</details>
</caps>
<caps>
<name>video_%d</name>
<direction>sink</direction>
<presence>request</presence>
<details>video/mpeg, mpegversion=(int){ 1, 2 }, systemstream=(boolean)false, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</details>
</caps>
<caps>
<name>src</name>
<direction>source</direction>
<presence>always</presence>
<details>video/mpeg, systemstream=(boolean)true</details>
</caps>
</pads>
</element>
</elements>
</plugin>

View file

@ -24,13 +24,13 @@
* SECTION:element-mpeg2enc
* @see_also: mpeg2dec
*
* This element encodes raw video into an MPEG ?? stream using the
* This element encodes raw video into an MPEG-1/2 elementary stream using the
* <ulink url="http://mjpeg.sourceforge.net/">mjpegtools</ulink> library.
* Documentation on MPEG encoding in general can be found in the
* <ulink url="https://sourceforge.net/docman/display_doc.php?docid=3456&group_id=5776#s7">MJPEG Howto</ulink>
* <ulink url="https://sourceforge.net/docman/display_doc.php?docid=3456&group_id=5776">MJPEG Howto</ulink>
* and on the various available parameters in the documentation
* of the mpeg2enc tool in particular, which shares options with this element.
*
*
* <refsect2>
* <title>Example pipeline</title>
* |[

View file

@ -28,10 +28,10 @@
* and (un)compressed audio streams such as AC3, MPEG layer I/II/III.
* It is based on the <ulink url="http://mjpeg.sourceforge.net/">mjpegtools</ulink> library.
* Documentation on creating MPEG videos in general can be found in the
* <ulink url="https://sourceforge.net/docman/display_doc.php?docid=3456&group_id=5776#s7">MJPEG Howto</ulink>
* <ulink url="https://sourceforge.net/docman/display_doc.php?docid=3456&group_id=5776">MJPEG Howto</ulink>
* and the man-page of the mplex tool documents the properties of this element,
* which are shared with the mplex tool.
*
*
* <refsect2>
* <title>Example pipeline</title>
* |[