Document siddec.

Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-ugly-plugins-docs.sgml:
* docs/plugins/gst-plugins-ugly-plugins-sections.txt:
* docs/plugins/inspect/plugin-siddec.xml:
* ext/sidplay/gstsiddec.cc:
* ext/sidplay/gstsiddec.h:
Document siddec.
This commit is contained in:
Wim Taymans 2007-02-28 15:49:35 +00:00
parent 151206dec5
commit 549ec77758
7 changed files with 54 additions and 6 deletions

View file

@ -1,3 +1,13 @@
2007-02-28 Wim Taymans <wim@fluendo.com>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-ugly-plugins-docs.sgml:
* docs/plugins/gst-plugins-ugly-plugins-sections.txt:
* docs/plugins/inspect/plugin-siddec.xml:
* ext/sidplay/gstsiddec.cc:
* ext/sidplay/gstsiddec.h:
Document siddec.
2007-02-21 Thomas Vander Stichele <thomas at apestaart dot org> 2007-02-21 Thomas Vander Stichele <thomas at apestaart dot org>
* ext/lame/gstlame.c: (gst_lame_sink_setcaps), * ext/lame/gstlame.c: (gst_lame_sink_setcaps),

View file

@ -86,7 +86,8 @@ IGNORE_CFILES =
EXTRA_HFILES = \ EXTRA_HFILES = \
$(top_srcdir)/ext/lame/gstlame.h \ $(top_srcdir)/ext/lame/gstlame.h \
$(top_srcdir)/ext/mad/gstmad.h $(top_srcdir)/ext/mad/gstmad.h \
$(top_srcdir)/ext/sidplay/gstsiddec.h
# Images to copy into HTML directory. # Images to copy into HTML directory.
HTML_IMAGES = HTML_IMAGES =

View file

@ -14,6 +14,7 @@
<title>gst-plugins-ugly Elements</title> <title>gst-plugins-ugly Elements</title>
<xi:include href="xml/element-lame.xml" /> <xi:include href="xml/element-lame.xml" />
<xi:include href="xml/element-mad.xml" /> <xi:include href="xml/element-mad.xml" />
<xi:include href="xml/element-siddec.xml" />
</chapter> </chapter>
<chapter> <chapter>

View file

@ -14,3 +14,11 @@ GstLame
GstLameClass GstLameClass
</SECTION> </SECTION>
<SECTION>
<FILE>element-siddec</FILE>
GstSidDec
<TITLE>siddec</TITLE>
<SUBSECTION Standard>
GstSidDecClass
</SECTION>

View file

@ -3,10 +3,10 @@
<description>Uses libsidplay to decode .sid files</description> <description>Uses libsidplay to decode .sid files</description>
<filename>../../ext/sidplay/.libs/libgstsid.so</filename> <filename>../../ext/sidplay/.libs/libgstsid.so</filename>
<basename>libgstsid.so</basename> <basename>libgstsid.so</basename>
<version>0.10.5</version> <version>0.10.5.1</version>
<license>GPL</license> <license>GPL</license>
<source>gst-plugins-ugly</source> <source>gst-plugins-ugly</source>
<package>GStreamer Ugly Plug-ins source release</package> <package>GStreamer Ugly Plug-ins CVS/prerelease</package>
<origin>Unknown package origin</origin> <origin>Unknown package origin</origin>
<elements> <elements>
<element> <element>

View file

@ -18,6 +18,35 @@
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/**
* SECTION:element-siddec
* @short_description: a decoder for sid files
*
* <refsect2>
* <para>
* This element decodes .sid files to raw audio. .sid files are in fact
* small Commodore 64 programs that are executed on an emulated 6502 CPU and a
* MOS 6581 sound chip.
* </para>
* <para>
* This plugin will first load the complete program into memory before starting
* the emulator and producing output.
* </para>
* <para>
* Seeking is not (and cannot be) implemented.
* </para>
* <title>Example pipelines</title>
* <para>
* <programlisting>
* gst-launch -v filesrc location=Hawkeye.sid ! siddec ! audioconvert ! alsasink
* </programlisting>
* Decode a sid file and play back the audio using alsasink.
* </para>
* </refsect2>
*
* Last reviewed on 2006-12-30 (0.10.5)
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"
#endif #endif
@ -274,7 +303,6 @@ gst_siddec_finalize (GObject * object)
delete (siddec->engine); delete (siddec->engine);
G_OBJECT_CLASS (parent_class)->finalize (object); G_OBJECT_CLASS (parent_class)->finalize (object);
} }
static void static void
@ -356,6 +384,7 @@ siddec_negotiate (GstSidDec * siddec)
return TRUE; return TRUE;
/* ERRORS */
nothing_allowed: nothing_allowed:
{ {
GST_DEBUG_OBJECT (siddec, "could not get allowed caps"); GST_DEBUG_OBJECT (siddec, "could not get allowed caps");
@ -539,7 +568,7 @@ gst_siddec_chain (GstPad * pad, GstBuffer * buffer)
overflow: overflow:
{ {
GST_ELEMENT_ERROR (siddec, STREAM, DECODE, GST_ELEMENT_ERROR (siddec, STREAM, DECODE,
(NULL), ("Input data bigger than allowd buffer size")); (NULL), ("Input data bigger than allowed buffer size"));
gst_object_unref (siddec); gst_object_unref (siddec);
return GST_FLOW_ERROR; return GST_FLOW_ERROR;
} }

View file

@ -21,7 +21,6 @@
#ifndef __GST_SIDDEC_H__ #ifndef __GST_SIDDEC_H__
#define __GST_SIDDEC_H__ #define __GST_SIDDEC_H__
#include <stdlib.h> #include <stdlib.h>
#include <sidplay/player.h> #include <sidplay/player.h>