diff --git a/ChangeLog b/ChangeLog index b8135e5e52..d04066ab37 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,14 @@ +2006-04-27 Tim-Philipp Müller + + * 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 Patch by: Mark Nauwelaerts diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index ee73136467..dd73972f25 100644 --- 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 b4b85e185b..912f627fbf 100644 --- a/docs/plugins/gst-plugins-good-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml @@ -15,6 +15,8 @@ + + diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt index 8c7032a421..c30e49118d 100644 --- a/docs/plugins/gst-plugins-good-plugins-sections.txt +++ b/docs/plugins/gst-plugins-good-plugins-sections.txt @@ -22,6 +22,22 @@ GstAutoVideoSink GstAutoVideoSinkClass +
+element-avidemux +GstAviDemux +avidemux + +GstAviDemuxClass +
+ +
+element-avimux +GstAviMux +avimux + +GstAviMuxClass +
+
element-cairotimeoverlay GstCairoTimeOverlay diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy index 6210a5ecb2..c4566f7fbc 100644 --- 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 e08b08f48a..a83288450c 100644 --- 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 <rbultje@ronald.bitfreak.net> + + avimux + Avi muxer + Codec/Muxer + Muxes audio and video into an avi stream + Ronald Bultje <rbultje@ronald.bitfreak.net> + \ No newline at end of file diff --git a/gst/avi/gstavidemux.c b/gst/avi/gstavidemux.c index cfbb4d2cfe..aa800145b7 100644 --- a/gst/avi/gstavidemux.c +++ b/gst/avi/gstavidemux.c @@ -18,6 +18,30 @@ */ /* Element-Checklist-Version: 5 */ +/** + * SECTION:element-avidemux + * + * + * + * Demuxes an .avi file into raw or compressed audio and/or video streams. + * + * + * This element currently only supports pull-based scheduling. + * + * Example launch line + * + * + * gst-launch filesrc test.avi ! avidemux name=demux demux.audio_00 ! decodebin ! audioconvert ! audioresample ! autoaudiosink demux.video_00 ! queue ! decodebin ! ffmpegcolorspace ! videoscale ! autovideosink + * + * 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. + * + * + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/avi/gstavimux.c b/gst/avi/gstavimux.c index ce8c4ab091..de070772f1 100644 --- a/gst/avi/gstavimux.c +++ b/gst/avi/gstavimux.c @@ -25,6 +25,46 @@ * - openDML large-AVI docs */ +/** + * SECTION:element-avimux + * + * + * + * Muxes raw or compressed audio and/or video streams into an AVI file. + * + * Example launch line + * + * (write everything in one line, without the backslash characters) + * + * 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 + * + * This will create an .AVI file containing an uncompressed video stream + * with a test picture and an uncompressed audio stream containing a + * test sound. + * + * Another example launch line + * + * (write everything in one line, without the backslash characters) + * + * 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 + * + * 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. + * + * + * + */ #ifdef HAVE_CONFIG_H #include "config.h"