Commit b88dedde authored by Tim-Philipp Müller's avatar Tim-Philipp Müller 🐠

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.
parent d1cdfa6d
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>
......
......@@ -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 \
......
......@@ -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" />
......
......@@ -22,6 +22,22 @@ GstAutoVideoSink
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
......
......@@ -106,6 +106,7 @@ GObject
GstEFence
GstCutter
GstAviDemux
GstAviMux
GstAuParse
GstAlpha
GstTagDemux
......
......@@ -18,5 +18,12 @@
Wim Taymans &lt;wim.taymans@chello.be&gt;
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
......@@ -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
......
......@@ -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"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment