summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJan Schmidt <thaytan@mad.scientist.com>2008-02-08 02:49:20 +0000
committerJan Schmidt <thaytan@mad.scientist.com>2008-02-08 02:49:20 +0000
commit5aa6c44ee8048d9c156137e7d906093b6afd6953 (patch)
tree1e0676e2b2002e0b03cd298df0b641ba75457eaa /docs
parentc54301aabe94fb5eef6b25e98d469787a5189ee6 (diff)
Move the equalizer plugin across 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/gst-plugins-good-plugins.interfaces: * docs/plugins/inspect/plugin-equalizer.xml: * gst/equalizer/Makefile.am: * tests/check/Makefile.am: * tests/examples/Makefile.am: Move the equalizer plugin across from -bad * tests/check/elements/.cvsignore: Add equalizer, audiosincwband and audiosincwlimit * tests/check/elements/equalizer.c: Fix compiler warnings
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/Makefile.am4
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml4
-rw-r--r--docs/plugins/gst-plugins-good-plugins-sections.txt62
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args140
-rw-r--r--docs/plugins/gst-plugins-good-plugins.hierarchy5
-rw-r--r--docs/plugins/gst-plugins-good-plugins.interfaces4
-rw-r--r--docs/plugins/inspect/plugin-equalizer.xml76
7 files changed, 295 insertions, 0 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index b54d2873..8384b765 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -81,6 +81,10 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/cdio/gstcdiocddasrc.h \
$(top_srcdir)/ext/dv/gstdvdec.h \
$(top_srcdir)/ext/dv/gstdvdemux.h \
+ $(top_srcdir)/gst/equalizer/gstiirequalizer.h \
+ $(top_srcdir)/gst/equalizer/gstiirequalizer3bands.h \
+ $(top_srcdir)/gst/equalizer/gstiirequalizer10bands.h \
+ $(top_srcdir)/gst/equalizer/gstiirequalizernbands.h \
$(top_srcdir)/ext/esd/esdsink.h \
$(top_srcdir)/ext/flac/gstflacdec.h \
$(top_srcdir)/ext/hal/gsthalaudiosink.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 9a99842c..b711d34c 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -36,6 +36,9 @@
<xi:include href="xml/element-directsoundsink.xml" />
<xi:include href="xml/element-dvdec.xml" />
<xi:include href="xml/element-dvdemux.xml" />
+ <xi:include href="xml/element-equalizer-10bands.xml" />
+ <xi:include href="xml/element-equalizer-3bands.xml" />
+ <xi:include href="xml/element-equalizer-nbands.xml" />
<xi:include href="xml/element-esdsink.xml" />
<xi:include href="xml/element-flacdec.xml" />
<xi:include href="xml/element-gamma.xml" />
@@ -102,6 +105,7 @@
<xi:include href="xml/plugin-directsound.xml" />
<xi:include href="xml/plugin-dv.xml" />
<xi:include href="xml/plugin-efence.xml" />
+ <xi:include href="xml/plugin-equalizer.xml" />
<xi:include href="xml/plugin-effectv.xml" />
<xi:include href="xml/plugin-esdsink.xml" />
<xi:include href="xml/plugin-flac.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index b4ee20b9..db844a8b 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -376,6 +376,68 @@ gst_dvdemux_get_type
</SECTION>
<SECTION>
+<FILE>gstiirequalizer</FILE>
+<TITLE>GstIirEqualize</TITLE>
+GstIirEqualizer
+<SUBSECTION Standard>
+GstIirEqualizerBand
+GstIirEqualizerClass
+GST_IIR_EQUALIZER
+GST_IIR_EQUALIZER_CLASS
+GST_IS_IIR_EQUALIZER
+GST_IS_IIR_EQUALIZER_CLASS
+GST_TYPE_IIR_EQUALIZER
+gst_iir_equalizer_get_type
+gst_iir_equalizer_compute_frequencies
+</SECTION>
+
+<SECTION>
+<FILE>element-equalizer-3bands</FILE>
+<TITLE>equalizer-3bands</TITLE>
+GstIirEqualizer3Bands
+<SUBSECTION Standard>
+GstIirEqualizer3BandsClass
+GST_IIR_EQUALIZER_3BANDS
+GST_IIR_EQUALIZER_3BANDS_CLASS
+GST_IS_IIR_EQUALIZER_3BANDS
+GST_IS_IIR_EQUALIZER_3BANDS_CLASS
+GST_TYPE_IIR_EQUALIZER_3BANDS
+gst_iir_equalizer_3bands_get_type
+</SECTION>
+
+<SECTION>
+<FILE>element-equalizer-10bands</FILE>
+<TITLE>equalizer-10bands</TITLE>
+GstIirEqualizer10Bands
+<SUBSECTION Standard>
+GstIirEqualizer10BandsClass
+GST_IIR_EQUALIZER_10BANDS
+GST_IIR_EQUALIZER_10BANDS_CLASS
+GST_IS_IIR_EQUALIZER_10BANDS
+GST_IS_IIR_EQUALIZER_10BANDS_CLASS
+GST_TYPE_IIR_EQUALIZER_10BANDS
+gst_iir_equalizer_10bands_get_type
+</SECTION>
+
+<SECTION>
+<FILE>element-equalizer-nbands</FILE>
+<TITLE>equalizer-nbands</TITLE>
+GstIirEqualizerNBands
+<SUBSECTION Standard>
+GstIirEqualizerNBandsClass
+GST_IIR_EQUALIZER_NBANDS
+GST_IIR_EQUALIZER_NBANDS_CLASS
+GST_IS_IIR_EQUALIZER_NBANDS
+GST_IS_IIR_EQUALIZER_NBANDS_CLASS
+GST_TYPE_IIR_EQUALIZER_NBANDS
+gst_iir_equalizer_nbands_get_type
+<SUBSECTION Private>
+HIGHEST_FREQ
+LOWEST_FREQ
+ProcessFunc
+</SECTION>
+
+<SECTION>
<FILE>element-esdsink</FILE>
<TITLE>esdsink</TITLE>
GstEsdSink
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index 9d6d8b69..f67e7379 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -1,4 +1,144 @@
<ARG>
+<NAME>GstIirEqualizer10Bands::band0</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>29 Hz</NICK>
+<BLURB>gain for the frequency band 29 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band1</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>59 Hz</NICK>
+<BLURB>gain for the frequency band 59 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band2</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>119 Hz</NICK>
+<BLURB>gain for the frequency band 119 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band3</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>227 Hz</NICK>
+<BLURB>gain for the frequency band 227 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band4</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>474 Hz</NICK>
+<BLURB>gain for the frequency band 474 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band5</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>947 Hz</NICK>
+<BLURB>gain for the frequency band 947 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band6</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>1889 Hz</NICK>
+<BLURB>gain for the frequency band 1889 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band7</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>3770 Hz</NICK>
+<BLURB>gain for the frequency band 3770 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band8</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>7523 Hz</NICK>
+<BLURB>gain for the frequency band 7523 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer10Bands::band9</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>15011 Hz</NICK>
+<BLURB>gain for the frequency band 15011 Hz, ranging from -24 dB to +12 dB.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer3Bands::band0</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>110 Hz</NICK>
+<BLURB>gain for the frequency band 100 Hz, ranging from -24.0 to +12.0.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer3Bands::band1</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>1100 Hz</NICK>
+<BLURB>gain for the frequency band 1100 Hz, ranging from -24.0 to +12.0.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizer3Bands::band2</NAME>
+<TYPE>gdouble</TYPE>
+<RANGE>[-24,12]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>11 kHz</NICK>
+<BLURB>gain for the frequency band 11 kHz, ranging from -24.0 to +12.0.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstIirEqualizerNBands::num-bands</NAME>
+<TYPE>guint</TYPE>
+<RANGE>[1,64]</RANGE>
+<FLAGS>rwx</FLAGS>
+<NICK>num-bands</NICK>
+<BLURB>number of different bands to use.</BLURB>
+<DEFAULT>10</DEFAULT>
+</ARG>
+
+<ARG>
<NAME>GstOssSrc::device</NAME>
<TYPE>gchararray</TYPE>
<RANGE></RANGE>
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index 2926ee44..5a72aa53 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -49,6 +49,11 @@ GObject
GstDVDec
GstCairoTextOverlay
GstBaseTransform
+ GstAudioFilter
+ GstIirEqualizer
+ GstIirEqualizerNBands
+ GstIirEqualizer3Bands
+ GstIirEqualizer10Bands
GstAudioPanorama
GstCairoTimeOverlay
GstVideoFilter
diff --git a/docs/plugins/gst-plugins-good-plugins.interfaces b/docs/plugins/gst-plugins-good-plugins.interfaces
index 7e2e2814..a85d9aa4 100644
--- a/docs/plugins/gst-plugins-good-plugins.interfaces
+++ b/docs/plugins/gst-plugins-good-plugins.interfaces
@@ -9,6 +9,10 @@ GstGConfAudioSink GstChildProxy
GstDecodeBin GstChildProxy
GstID3Mux GstTagSetter
GstID3Tag GstTagSetter
+GstIirEqualizer GstChildProxy
+GstIirEqualizerNBands GstChildProxy
+GstIirEqualizer3Bands GstChildProxy
+GstIirEqualizer10Bands GstChildProxy
GstLame GstTagSetter
GstOssMixerElement GstImplementsInterface GstMixer
GstOssSrc GstImplementsInterface GstMixer
diff --git a/docs/plugins/inspect/plugin-equalizer.xml b/docs/plugins/inspect/plugin-equalizer.xml
new file mode 100644
index 00000000..4db8562e
--- /dev/null
+++ b/docs/plugins/inspect/plugin-equalizer.xml
@@ -0,0 +1,76 @@
+<plugin>
+ <name>equalizer</name>
+ <description>GStreamer audio equalizers</description>
+ <filename>../../gst/equalizer/.libs/libgstequalizer.so</filename>
+ <basename>libgstequalizer.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>equalizer-10bands</name>
+ <longname>10 Band Equalizer</longname>
+ <class>Filter/Effect/Audio</class>
+ <description>Direct Form 10 band IIR equalizer</description>
+ <author>Stefan Kost &lt;ensonic@users.sf.net&gt;</author>
+ <pads>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
+ <name>equalizer-3bands</name>
+ <longname>3 Band Equalizer</longname>
+ <class>Filter/Effect/Audio</class>
+ <description>Direct Form 3 band IIR equalizer</description>
+ <author>Stefan Kost &lt;ensonic@users.sf.net&gt;</author>
+ <pads>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
+ <name>equalizer-nbands</name>
+ <longname>N Band Equalizer</longname>
+ <class>Filter/Effect/Audio</class>
+ <description>Direct Form IIR equalizer</description>
+ <author>Benjamin Otte &lt;otte@gnome.org&gt;, Stefan Kost &lt;ensonic@users.sf.net&gt;</author>
+ <pads>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-int, depth=(int)16, width=(int)16, endianness=(int)1234, signed=(boolean)true, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]; audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1000, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
+ </elements>
+</plugin> \ No newline at end of file