summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSebastian Dröge <slomo@circular-chaos.org>2009-01-19 11:19:08 +0000
committerSebastian Dröge <slomo@circular-chaos.org>2009-01-19 11:19:08 +0000
commit344a9f4229620d90b92e0fffe99069fb9c410d6f (patch)
treeb2e16b5d7c874b91113967c3697cd11759963dd0 /docs
parentd912a42065647cc6baa00b8eab8f6e173286033a (diff)
Add an echo/reverb filter to the audiofx plugin, with configurable echo delay, intensity and feedback. Fixes bug #567...
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/gst-plugins-good-plugins.args: * docs/plugins/gst-plugins-good-plugins.hierarchy: * docs/plugins/inspect/plugin-audiofx.xml: * docs/plugins/inspect/plugin-spectrum.xml: * gst/audiofx/Makefile.am: * gst/audiofx/audiofx.c: (plugin_init): * gst/audiofx/audioreverb.c: (gst_audio_reverb_base_init), (gst_audio_reverb_class_init), (gst_audio_reverb_init), (gst_audio_reverb_finalize), (gst_audio_reverb_set_property), (gst_audio_reverb_get_property), (gst_audio_reverb_setup), (gst_audio_reverb_stop), (gst_audio_reverb_transform_ip): * gst/audiofx/audioreverb.h: * tests/check/Makefile.am: * tests/check/elements/audioreverb.c: (setup_reverb), (cleanup_reverb), (GST_START_TEST), (audioreverb_suite): Add an echo/reverb filter to the audiofx plugin, with configurable echo delay, intensity and feedback. Fixes bug #567874.
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/Makefile.am1
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml1
-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.hierarchy3
-rw-r--r--docs/plugins/inspect/plugin-audiofx.xml21
-rw-r--r--docs/plugins/inspect/plugin-spectrum.xml2
7 files changed, 103 insertions, 1 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 8549ed3e..1c03636b 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -106,6 +106,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/alpha/gstalphacolor.h \
$(top_srcdir)/gst/apetag/gstapedemux.h \
$(top_srcdir)/gst/audiofx/audioamplify.h \
+ $(top_srcdir)/gst/audiofx/audioreverb.h \
$(top_srcdir)/gst/audiofx/audiodynamic.h \
$(top_srcdir)/gst/audiofx/audioinvert.h \
$(top_srcdir)/gst/audiofx/audiokaraoke.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 8fedb7fa..231017d7 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -23,6 +23,7 @@
<xi:include href="xml/element-audiowsincband.xml" />
<xi:include href="xml/element-audiowsinclimit.xml" />
<xi:include href="xml/element-audiofirfilter.xml" />
+ <xi:include href="xml/element-audioreverb.xml" />
<xi:include href="xml/element-audiodynamic.xml" />
<xi:include href="xml/element-audioinvert.xml" />
<xi:include href="xml/element-audiopanorama.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index d2de0b05..03790c5b 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -117,6 +117,22 @@ gst_audio_iir_filter_get_type
</SECTION>
<SECTION>
+<FILE>element-audioreverb</FILE>
+<TITLE>audioreverb</TITLE>
+GstAudioReverb
+<SUBSECTION Standard>
+GstAudioReverbClass
+GstAudioReverbProcessFunc
+GST_AUDIO_REVERB
+GST_AUDIO_REVERB_CLASS
+GST_AUDIO_REVERB_GET_CLASS
+GST_IS_AUDIO_REVERB
+GST_IS_AUDIO_REVERB_CLASS
+GST_TYPE_AUDIO_REVERB
+gst_audio_reverb_get_type
+</SECTION>
+
+<SECTION>
<FILE>element-audiodynamic</FILE>
<TITLE>audiodynamic</TITLE>
GstAudioDynamic
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index 0064b660..7a2603d5 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -19708,3 +19708,63 @@
<DEFAULT></DEFAULT>
</ARG>
+<ARG>
+<NAME>GstAudioDelay::delay</NAME>
+<TYPE>guint64</TYPE>
+<RANGE>>= 1</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Delay</NICK>
+<BLURB>Delay in nanoseconds.</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioDelay::feedback</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Feedback</NICK>
+<BLURB>Amount of feedback.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioDelay::intensity</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Intensity</NICK>
+<BLURB>Intensity of the echo.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioReverb::delay</NAME>
+<TYPE>guint64</TYPE>
+<RANGE>>= 1</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Delay</NICK>
+<BLURB>Delay of the echo in nanoseconds.</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioReverb::feedback</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Feedback</NICK>
+<BLURB>Amount of feedback.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioReverb::intensity</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Intensity</NICK>
+<BLURB>Intensity of the echo.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy
index 55e1cdc2..e02a501e 100644
--- a/docs/plugins/gst-plugins-good-plugins.hierarchy
+++ b/docs/plugins/gst-plugins-good-plugins.hierarchy
@@ -64,6 +64,7 @@ GObject
GstAudioWSincLimit
GstAudioWSincBand
GstAudioFIRFilter
+ GstAudioReverb
GstIirEqualizer
GstIirEqualizerNBands
GstIirEqualizer3Bands
@@ -221,6 +222,8 @@ GObject
GstRegistry
GstRingBuffer
GstSignalObject
+ GstMixerTrack
+ GstMixerOptions
GstCmmlTagStream
GstCmmlTagHead
GstCmmlTagClip
diff --git a/docs/plugins/inspect/plugin-audiofx.xml b/docs/plugins/inspect/plugin-audiofx.xml
index 7ca2add6..171d8b43 100644
--- a/docs/plugins/inspect/plugin-audiofx.xml
+++ b/docs/plugins/inspect/plugin-audiofx.xml
@@ -199,6 +199,27 @@
</pads>
</element>
<element>
+ <name>audioreverb</name>
+ <longname>Audio reverb</longname>
+ <class>Filter/Effect/Audio</class>
+ <description>Adds an echo or reverb effect to an audio stream</description>
+ <author>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author>
+ <pads>
+ <caps>
+ <name>sink</name>
+ <direction>sink</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ <caps>
+ <name>src</name>
+ <direction>source</direction>
+ <presence>always</presence>
+ <details>audio/x-raw-float, width=(int){ 32, 64 }, endianness=(int)1234, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</details>
+ </caps>
+ </pads>
+ </element>
+ <element>
<name>audiowsincband</name>
<longname>Band pass &amp; band reject filter</longname>
<class>Filter/Effect/Audio</class>
diff --git a/docs/plugins/inspect/plugin-spectrum.xml b/docs/plugins/inspect/plugin-spectrum.xml
index deae6a44..e88d9901 100644
--- a/docs/plugins/inspect/plugin-spectrum.xml
+++ b/docs/plugins/inspect/plugin-spectrum.xml
@@ -14,7 +14,7 @@
<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>
+ <author>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;, Stefan Kost &lt;ensonic@users.sf.net&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</author>
<pads>
<caps>
<name>sink</name>