summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJan Schmidt <thaytan@mad.scientist.com>2008-02-08 03:28:57 +0000
committerJan Schmidt <thaytan@mad.scientist.com>2008-02-08 03:28:57 +0000
commit1d5d8e1397535425815eeeb252e9213b77b57ef4 (patch)
tree0e65e932fa2a8d76fbf926abdbbc036ad73747f4 /docs
parenta5a50d13fb5412f63e7dcca95a427a45d05c164b (diff)
Move spectrum plugin from -bad.
Original commit message from CVS: * configure.ac: * 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.args: * docs/plugins/gst-plugins-good-plugins.hierarchy: * docs/plugins/inspect/plugin-spectrum.xml: * gst/spectrum/Makefile.am: * tests/check/Makefile.am: * tests/check/elements/.cvsignore: * tests/examples/Makefile.am: Move spectrum plugin from -bad. Move examples into tests/examples/spectrum.
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/Makefile.am1
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml2
-rw-r--r--docs/plugins/gst-plugins-good-plugins-sections.txt16
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args60
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy1
-rw-r--r--docs/plugins/inspect/plugin-spectrum.xml34
6 files changed, 114 insertions, 0 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 8384b765..81cd8ebf 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -124,6 +124,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/qtdemux/qtdemux.h \
$(top_srcdir)/gst/rtsp/gstrtpdec.h \
$(top_srcdir)/gst/rtsp/gstrtspsrc.h \
+ $(top_srcdir)/gst/spectrum/gstspectrum.h \
$(top_srcdir)/gst/udp/gstmultiudpsink.h \
$(top_srcdir)/gst/udp/gstudpsrc.h \
$(top_srcdir)/gst/videocrop/gstvideocrop.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index b711d34c..11aefca4 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -69,6 +69,7 @@
<xi:include href="xml/element-rtspsrc.xml" />
<xi:include href="xml/element-smokedec.xml" />
<xi:include href="xml/element-smokeenc.xml" />
+ <xi:include href="xml/element-spectrum.xml" />
<xi:include href="xml/element-udpsrc.xml" />
<xi:include href="xml/element-v4l2src.xml" />
<xi:include href="xml/element-videobalance.xml" />
@@ -134,6 +135,7 @@
<xi:include href="xml/plugin-rtsp.xml" />
<xi:include href="xml/plugin-shout2send.xml" />
<xi:include href="xml/plugin-smpte.xml" />
+ <xi:include href="xml/plugin-spectrum.xml" />
<xi:include href="xml/plugin-speex.xml" />
<xi:include href="xml/plugin-taglib.xml" />
<xi:include href="xml/plugin-udp.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index db844a8b..b6d32003 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -881,6 +881,22 @@ GST_IS_SMOKEENC_CLASS
</SECTION>
<SECTION>
+<FILE>element-spectrum</FILE>
+<TITLE>spectrum</TITLE>
+GstSpectrum
+<SUBSECTION Standard>
+GstSpectrumClass
+GstSpectrumFFTFreeFunc
+GstSpectrumProcessFunc
+GST_SPECTRUM
+GST_SPECTRUM_CLASS
+GST_IS_SPECTRUM
+GST_IS_SPECTRUM_CLASS
+GST_TYPE_SPECTRUM
+gst_spectrum_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-taglibmux</FILE>
<TITLE>taglibmux</TITLE>
GstTagLibMux
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index f67e7379..38c959ee 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -159,6 +159,66 @@
</ARG>
<ARG>
+<NAME>GstSpectrum::bands</NAME>
+<TYPE>guint</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Bands</NICK>
+<BLURB>number of frequency bands.</BLURB>
+<DEFAULT>128</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSpectrum::interval</NAME>
+<TYPE>guint64</TYPE>
+<RANGE>>= 1</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Interval</NICK>
+<BLURB>Interval of time between message posts (in nanoseconds).</BLURB>
+<DEFAULT>100000000</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSpectrum::message</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Message</NICK>
+<BLURB>Post a level message for each passed interval.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSpectrum::threshold</NAME>
+<TYPE>gint</TYPE>
+<RANGE><= 0</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Threshold</NICK>
+<BLURB>dB threshold for result. All lower values will be set to this.</BLURB>
+<DEFAULT>-60</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSpectrum::message-magnitude</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Magnitude</NICK>
+<BLURB>Post the magnitude of the spectrum.</BLURB>
+<DEFAULT>TRUE</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstSpectrum::message-phase</NAME>
+<TYPE>gboolean</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Phase</NICK>
+<BLURB>Post the phase of the spectrum.</BLURB>
+<DEFAULT>FALSE</DEFAULT>
+</ARG>
+
+<ARG>
<NAME>GstVideoflip::method</NAME>
<TYPE>GstVideoflipMethod</TYPE>
<RANGE></RANGE>
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index 5a72aa53..a25fee68 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -54,6 +54,7 @@ GObject
GstIirEqualizerNBands
GstIirEqualizer3Bands
GstIirEqualizer10Bands
+ GstSpectrum
GstAudioPanorama
GstCairoTimeOverlay
GstVideoFilter
diff --git a/docs/plugins/inspect/plugin-spectrum.xml b/docs/plugins/inspect/plugin-spectrum.xml
new file mode 100644
index 00000000..92f9e79d
--- /dev/null
+++ b/docs/plugins/inspect/plugin-spectrum.xml
@@ -0,0 +1,34 @@
+<plugin>
+ <name>spectrum</name>
+ <description>Run an FFT on the audio signal, output spectrum data</description>
+ <filename>../../gst/spectrum/.libs/libgstspectrum.so</filename>
+ <basename>libgstspectrum.so</basename>
+ <version>0.10.6.1</version>
+ <license>LGPL</license>
+ <source>gst-plugins-good</source>
+ <package>GStreamer Good Plug-ins CVS/prerelease</package>
+ <origin>Unknown package origin</origin>
+ <elements>
+ <element>
+ <name>spectrum</name>
+ <longname>Spectrum analyzer</longname>
+ <class>Filter/Analyzer/Audio</class>
+ <description>Run an FFT on the audio signal, output spectrum data</description>
+ <author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;, Stefan Kost &lt;ensonic@users.sf.net&gt;, Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</author>
+ <pads>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-int, width=(int)32, depth=(int)32, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, width=(int)16, depth=(int)16, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-int, width=(int)32, depth=(int)32, signed=(boolean)true, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
+ </elements>
+</plugin> \ No newline at end of file