docs/plugins/: Add cdio plugin to docs.

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/inspect/plugin-cdio.xml:
Add cdio plugin to docs.
* ext/cdio/gstcdiocddasrc.c:
Add gtk-doc blurb.
* ext/cdio/gstcdio.c:
The plugin is called 'cdio' not 'cddio'.

diff --git a/ChangeLog b/ChangeLog
index 781ac98..9e257e5 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,19 @@
 2006-02-06  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/inspect/plugin-cdio.xml:
+         Add cdio plugin to docs.
+
+       * ext/cdio/gstcdiocddasrc.c:
+         Add gtk-doc blurb.
+
+       * ext/cdio/gstcdio.c:
+         The plugin is called 'cdio' not 'cddio'.
+
+2006-02-06  Tim-Philipp Müller  <tim at centricular dot net>
+
        * configure.ac:
        * docs/plugins/Makefile.am:
        * docs/plugins/gst-plugins-good-plugins-docs.sgml:

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 958fb04..0114b8f 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -81,6 +81,7 @@ EXTRA_HFILES = \
        $(top_srcdir)/gst/goom/gstgoom.h \
        $(top_srcdir)/gst/id3demux/gstid3demux.h \
        $(top_srcdir)/ext/cairo/gsttimeoverlay.h \
+       $(top_srcdir)/ext/cdio/gstcdiocddasrc.h \
        $(top_srcdir)/ext/flac/gstflacdec.h \
        $(top_srcdir)/gst/multipart/multipartmux.c \
        $(top_srcdir)/gst/multipart/multipartdemux.c \

diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index f5fa764..464f52a 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -16,6 +16,7 @@
     <xi:include href="xml/element-autoaudiosink.xml" />
     <xi:include href="xml/element-autovideosink.xml" />
     <xi:include href="xml/element-cairotimeoverlay.xml" />
+    <xi:include href="xml/element-cdiocddasrc.xml" />
     <xi:include href="xml/element-flacdec.xml" />
     <xi:include href="xml/element-goom.xml" />
     <xi:include href="xml/element-id3demux.xml" />
@@ -40,6 +41,7 @@
     <xi:include href="xml/plugin-avi.xml" />
     <xi:include href="xml/plugin-cacasink.xml" />
     <xi:include href="xml/plugin-cairo.xml" />
+    <xi:include href="xml/plugin-cdio.xml" />
     <xi:include href="xml/plugin-cutter.xml" />
     <xi:include href="xml/plugin-debug.xml" />
     <xi:include href="xml/plugin-dv.xml" />

diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 7a0524d..2601eb4 100644 (file)
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -31,6 +31,14 @@ GstCairoTimeOverlayClass
 </SECTION>
 
 <SECTION>
+<FILE>element-cdiocddasrc</FILE>
+GstCdioCddaSrc
+<TITLE>cdiocddasrc</TITLE>
+<SUBSECTION Standard>
+GstCdioCddaSrcClass
+</SECTION>
+
+<SECTION>
 <FILE>element-flacdec</FILE>
 GstFlacDec
 <TITLE>flacdec</TITLE>

diff --git a/docs/plugins/inspect/plugin-cdio.xml b/docs/plugins/inspect/plugin-cdio.xml
new file mode 100644 (file)
index 0000000..8701292
--- /dev/null
+++ b/docs/plugins/inspect/plugin-cdio.xml
@@ -0,0 +1,20 @@
+<plugin>
+  <name>cdio</name>
+  <description>Read audio from audio CDs</description>
+  <filename>../../ext/cdio/.libs/libgstcdio.so</filename>
+  <basename>libgstcdio.so</basename>
+  <version>0.10.1.1</version>
+  <license>GPL</license>
+  <source>gst-plugins-good</source>
+  <package>GStreamer Good Plug-ins CVS/prerelease</package>
+  <origin>Unknown package origin</origin>
+  <elements>
+    <element>
+      <name>cdiocddasrc</name>
+      <longname>CD Audio (cdda) Source</longname>
+      <class>Source/File</class>
+      <description>Read audio from CD using libcdio</description>
+      <author>Tim-Philipp Müller &lt;tim centricular net&gt;</author>
+    </element>
+  </elements>
+</plugin>
\ No newline at end of file

diff --git a/ext/cdio/gstcdio.c b/ext/cdio/gstcdio.c
index 869e789..33547ae 100644 (file)
--- a/ext/cdio/gstcdio.c
+++ b/ext/cdio/gstcdio.c
@@ -85,6 +85,6 @@ plugin_init (GstPlugin * plugin)
 
 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
-    "cddio",
+    "cdio",
     "Read audio from audio CDs",
     plugin_init, VERSION, "GPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)

diff --git a/ext/cdio/gstcdiocddasrc.c b/ext/cdio/gstcdiocddasrc.c
index 0229732..ed0fef6 100644 (file)
--- a/ext/cdio/gstcdiocddasrc.c
+++ b/ext/cdio/gstcdiocddasrc.c
@@ -17,6 +17,60 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-cdiocddasrc
+ * @short_description: Reads raw audio from an Audio CD
+ * @see_also: GstCdParanoiaSrc, GstCddaBaseSrc
+ *
+ * <refsect2>
+ * <para>
+ * cdiocddasrc reads and extracts raw audio from Audio CDs. It can operate
+ * in one of two modes:
+ * <itemizedlist>
+ *  <listitem><para>
+ *    treat each track as a separate stream, counting time from the start
+ *    of the track to the end of the track and posting EOS at the end of
+ *    a track, or
+ *  </para></listitem>
+ *  <listitem><para>
+ *    treat the entire disc as one stream, counting time from the start of
+ *    the first track to the end of the last track, posting EOS only at
+ *    the end of the last track.
+ *  </para></listitem>
+ * </itemizedlist>
+ * </para>
+ * <para>
+ * With a recent-enough version of libcdio, the element will extract
+ * CD-TEXT if this is supported by the CD-drive and CD-TEXT information
+ * is available on the CD. The information will be posted on the bus in
+ * form of a tag message.
+ * </para>
+ * <para>
+ * When opened, the element will also calculate a CDDB disc ID and a
+ * MusicBrainz disc ID, which applications can use to query online
+ * databases for artist/title information. These disc IDs will also be
+ * posted on the bus as part of the tag messages.
+ * </para>
+ * <para>
+ * cdiocddasrc supports the GstUriHandler interface, so applications can use
+ * playbin with cdda://&lt;track-number&gt; URIs for playback (they will have
+ * to connect to playbin's notify::source signal and set the device on the
+ * cd source in the notify callback if they want to set the device property).
+ * Applications should use seeks in "track" format to switch between different
+ * tracks of the same CD (passing a new cdda:// URI to playbin involves opening
+ * and closing the CD device, which is much slower).
+ * </para>
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch cdiocddasrc track=5 device=/dev/cdrom ! audioconvert ! vorbisenc ! oggmux ! filesink location=track5.ogg
+ * </programlisting>
+ * This pipeline extracts track 5 of the audio CD and encodes it into an
+ * Ogg/Vorbis file.
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif