Add docs for both avidemux and avimux.

Original commit message from CVS:
* 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.hierarchy:
* docs/plugins/inspect/plugin-avi.xml:
* gst/avi/gstavidemux.c:
* gst/avi/gstavimux.c:
Add docs for both avidemux and avimux.

diff --git a/ChangeLog b/ChangeLog
index b8135e5..d04066a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,16 @@
 2006-04-27  Tim-Philipp Müller  <tim at centricular dot net>
 
+       * 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.hierarchy:
+       * docs/plugins/inspect/plugin-avi.xml:
+       * gst/avi/gstavidemux.c:
+       * gst/avi/gstavimux.c:
+         Add docs for both avidemux and avimux.
+
+2006-04-27  Tim-Philipp Müller  <tim at centricular dot net>
+
        Patch by: Mark Nauwelaerts  <manauw at skynet dot be>
 
        * gst/avi/Makefile.am:

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index ee73136..dd73972 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -77,6 +77,8 @@ EXTRA_HFILES = \
        $(top_srcdir)/gst/apetag/gstapedemux.h \
        $(top_srcdir)/gst/autodetect/gstautoaudiosink.h \
        $(top_srcdir)/gst/autodetect/gstautovideosink.h \
+       $(top_srcdir)/gst/avi/gstavidemux.h \
+       $(top_srcdir)/gst/avi/gstavimux.h \
        $(top_srcdir)/gst/level/gstlevel.h \
        $(top_srcdir)/gst/goom/gstgoom.h \
        $(top_srcdir)/gst/id3demux/gstid3demux.h \

diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index b4b85e1..912f627 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -15,6 +15,8 @@
     <xi:include href="xml/element-apedemux.xml" />
     <xi:include href="xml/element-autoaudiosink.xml" />
     <xi:include href="xml/element-autovideosink.xml" />
+    <xi:include href="xml/element-avidemux.xml" />
+    <xi:include href="xml/element-avimux.xml" />
     <xi:include href="xml/element-cairotimeoverlay.xml" />
     <xi:include href="xml/element-cdiocddasrc.xml" />
     <xi:include href="xml/element-dvdec.xml" />

diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 8c7032a..c30e491 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -23,6 +23,22 @@ GstAutoVideoSinkClass
 </SECTION>
 
 <SECTION>
+<FILE>element-avidemux</FILE>
+GstAviDemux
+<TITLE>avidemux</TITLE>
+<SUBSECTION Standard>
+GstAviDemuxClass
+</SECTION>
+
+<SECTION>
+<FILE>element-avimux</FILE>
+GstAviMux
+<TITLE>avimux</TITLE>
+<SUBSECTION Standard>
+GstAviMuxClass
+</SECTION>
+
+<SECTION>
 <FILE>element-cairotimeoverlay</FILE>
 GstCairoTimeOverlay
 <TITLE>cairotimeoverlay</TITLE>

diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index 6210a5e..c4566f7 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -106,6 +106,7 @@ GObject
       GstEFence
       GstCutter
       GstAviDemux
+      GstAviMux
       GstAuParse
       GstAlpha
       GstTagDemux

diff --git a/docs/plugins/inspect/plugin-avi.xml b/docs/plugins/inspect/plugin-avi.xml
index e08b08f..a832884 100644 (file)
--- a/docs/plugins/inspect/plugin-avi.xml
+++ b/docs/plugins/inspect/plugin-avi.xml
@@ -18,5 +18,12 @@
     Wim Taymans <wim.taymans@chello.be>
     Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;</author>
     </element>
+    <element>
+      <name>avimux</name>
+      <longname>Avi muxer</longname>
+      <class>Codec/Muxer</class>
+      <description>Muxes audio and video into an avi stream</description>
+      <author>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;</author>
+    </element>
   </elements>
 </plugin>
\ No newline at end of file

diff --git a/gst/avi/gstavidemux.c b/gst/avi/gstavidemux.c
index cfbb4d2..aa80014 100644 (file)
--- a/gst/avi/gstavidemux.c
+++ b/gst/avi/gstavidemux.c
@@ -18,6 +18,30 @@
  */
 /* Element-Checklist-Version: 5 */
 
+/**
+ * SECTION:element-avidemux
+ *
+ * <refsect2>
+ * <para>
+ * Demuxes an .avi file into raw or compressed audio and/or video streams.
+ * </para>
+ * <para>
+ * This element currently only supports pull-based scheduling. 
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch filesrc test.avi ! avidemux name=demux  demux.audio_00 ! decodebin ! audioconvert ! audioresample ! autoaudiosink   demux.video_00 ! queue ! decodebin ! ffmpegcolorspace ! videoscale ! autovideosink
+ * </programlisting>
+ * Play (parse and decode) an .avi file and try to output it to
+ * an automatically detected soundcard and videosink. If the AVI file contains
+ * compressed audio or video data, this will only work if you have the
+ * right decoder elements/plugins installed.
+ * </para>
+ * </refsect2>
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif

diff --git a/gst/avi/gstavimux.c b/gst/avi/gstavimux.c
index ce8c4ab..de07077 100644 (file)
--- a/gst/avi/gstavimux.c
+++ b/gst/avi/gstavimux.c
@@ -25,6 +25,46 @@
  * - openDML large-AVI docs
  */
 
+/**
+ * SECTION:element-avimux
+ *
+ * <refsect2>
+ * <para>
+ * Muxes raw or compressed audio and/or video streams into an AVI file.
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * (write everything in one line, without the backslash characters)
+ * <programlisting>
+ * gst-launch-0.10 videotestsrc num-buffers=250 \
+ * ! 'video/x-raw-yuv,format=(fourcc)I420,width=320,height=240,framerate=(fraction)25/1' \
+ * ! queue ! mux. \
+ * audiotestsrc num-buffers=440 ! audioconvert \
+ * ! 'audio/x-raw-int,rate=44100,channels=2' ! queue ! mux. \
+ * avimux name=mux ! filesink location=test.avi
+ * </programlisting>
+ * This will create an .AVI file containing an uncompressed video stream
+ * with a test picture and an uncompressed audio stream containing a 
+ * test sound.
+ * </para>
+ * <title>Another example launch line</title>
+ * <para>
+ * (write everything in one line, without the backslash characters)
+ * <programlisting>
+ * gst-launch-0.10 videotestsrc num-buffers=250 \
+ * ! 'video/x-raw-yuv,format=(fourcc)I420,width=320,height=240,framerate=(fraction)25/1' \
+ * ! xvidenc ! queue ! mux. \
+ * audiotestsrc num-buffers=440 ! audioconvert ! 'audio/x-raw-int,rate=44100,channels=2' \
+ * ! lame ! queue ! mux. \
+ * avimux name=mux ! filesink location=test.avi
+ * </programlisting>
+ * This will create an .AVI file containing the same test video and sound
+ * as above, only that both streams will be compressed this time. This will
+ * only work if you have the necessary encoder elements installed of course.
+ * </para>
+ * </refsect2>
+ *
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"