diff options
Diffstat (limited to 'ext/cdio/gstcdiocddasrc.c')
| -rw-r--r-- | ext/cdio/gstcdiocddasrc.c | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/ext/cdio/gstcdiocddasrc.c b/ext/cdio/gstcdiocddasrc.c index 0229732e..ed0fef67 100644 --- 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://<track-number> 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 |